プロジェクト

全般

プロフィール

Bug(バグ) #3198

完了

opJsonApiActions 内で Content-Type の設定が2度呼び出されている

Youichi Kimura さんが約12年前に追加. 7年以上前に更新.

ステータス:
Won't fix(対応せず)
優先度:
Normal(通常)
担当者:
対象バージョン:
開始日:
2012-09-11
期日:
進捗率:

0%

予定工数:
3.6 で発生するか:
Unknown (未調査)
3.8 で発生するか:
Yes (はい)

説明

Overview (現象)

opJsonApiActions クラス内で $this->getResponse()->setContentType('application/json') が execute() メソッドと renderJSON() メソッドで 2 度呼び出されている。また、これによって各 API のアクション内で Content-Type の設定を上書きすることが出来ない。

(現象補足)
apiを使用しているプラグインでは、使用しているjavascriptライブラリとの都合上、content-typeが「text/html」である必要があるものがあります。
(デフォルトでライブラリの中でstringをjsonオブジェクトに変換します。)
そのため、actionsのexecuteXxx()内でcontent-typeの書き換えを行っています。
その変更をopJsonApiActionsのrenderJSON()で「application/json」に再度置き換えられるために不具合発生となります。

Way to fix (修正内容)

opJsonApiActions::renderJSON() メソッド内の setContentType の呼び出しが不要なため除去する。


関連するチケット 1 (0件未完了1件完了)

関連している OpenPNE 3 - Backport(バックポート) #3330: opJsonApiActions 内で Content-Type の設定が2度呼び出されているFixed(完了)kaoru n2013-04-15

操作

Youichi Kimura さんが約12年前に更新

  • ステータスNew(新規) から Pending Review(レビュー待ち) に変更
  • 進捗率0 から 50 に変更

更新履歴 942c53165420403f62211ee01f4f2f4000c95457 で適用されました。

Youichi Kimura さんが約12年前に更新

Youichi Kimura さんが約12年前に更新

  • ステータスPending Review(レビュー待ち) から Accepted(着手) に変更
  • 進捗率50 から 0 に変更

opJsonApiActions::execute() 内にある setContentType も不要な可能性があるため再度確認します。

https://redmine.openpne.jp/projects/op3/repository/revisions/942c53165420403f62211ee01f4f2f4000c95457/entry/lib/action/opJsonApiActions.class.php#L30

Mutsumi Imamura さんが11年以上前に更新

  • 3.8 で発生するかUnknown (未調査) から Yes (はい) に変更

kaoru n さんが11年以上前に更新

https://redmine.openpne.jp/projects/op3/repository/revisions/942c53165420403f62211ee01f4f2f4000c95457/entry/lib/action/opJsonApiActions.class.php#L30
の方を削除すると、content-typeが設定されなくなってしまうため、削除しないでください。

Yuya Watanabe さんが11年以上前に更新

具体的な処理の順番を簡単に書くと

  1. opJsonApiActions の execute() ( setContentType() が呼び出されている)
  2. sfActions の execute()
  3. actions の executeXxx()
  4. opJsonApiActions の renderJSON() ( setContentType() が呼び出されている)

となるため,直接の原因は setContentType() が二回呼び出されていることではなく, アクションの処理を行ったあとに renderJSON() のなかで setContentType() が書き換わってしまうためだと思います.

上記より,説明が不十分であると思います.「Content-Type の設定が2度呼び出されている」ことが原因である十分な説明か,原因が異なる場合はその説明をチケットに記載してください.

kaoru n さんが11年以上前に更新

kaoru n さんが11年以上前に更新

原因について

note-6のとおりですが、少しだけ補足します。

apiを使用しているプラグインでは、使用しているjavascriptライブラリとの都合上、content-typeが「text/html」である必要があるものがあります。
(デフォルトでライブラリの中でstringをjsonオブジェクトに変換します。)
そのため、actionsのexecuteXxx()内でcontent-typeの書き換えを行っています。
その変更をopJsonApiActionsのrenderJSON()で「application/json」に再度置き換えられるために不具合発生となります。

上記についてチケット本文にも記載を行いました。

kaoru n さんが11年以上前に更新

  • ステータスAccepted(着手) から Pending Review(レビュー待ち) に変更
  • 進捗率0 から 50 に変更

note-3の内容は不要であるため、レビュー待ちに更新します。

Yuya Watanabe さんが11年以上前に更新

  • ステータスPending Review(レビュー待ち) から Pending Testing(テスト待ち) に変更
  • 進捗率50 から 70 に変更

isao sano さんが7年以上前に更新

  • ステータスPending Testing(テスト待ち) から Won't fix(対応せず) に変更
  • 進捗率70 から 0 に変更

OpenPNE 3.8.6 にて対応済みであったため、対応せずとします。

他の形式にエクスポート: Atom PDF