Bug（バグ） #3198
完了
opJsonApiActions 内で Content-Type の設定が2度呼び出されている
Youichi Kimura さんが約12年前に追加.
7年以上前に更新.
説明
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件完了)
- ステータス を New（新規） から Pending Review（レビュー待ち） に変更
- 進捗率 を 0 から 50 に変更
- ステータス を Pending Review（レビュー待ち） から Accepted（着手） に変更
- 進捗率 を 50 から 0 に変更
- 3.8 で発生するか を Unknown (未調査) から Yes (はい) に変更
具体的な処理の順番を簡単に書くと
- opJsonApiActions の execute() （ setContentType() が呼び出されている）
- sfActions の execute()
- actions の executeXxx()
- opJsonApiActions の renderJSON() （ setContentType() が呼び出されている）
となるため，直接の原因は setContentType() が二回呼び出されていることではなく， アクションの処理を行ったあとに renderJSON() のなかで setContentType() が書き換わってしまうためだと思います．
上記より，説明が不十分であると思います．「Content-Type の設定が2度呼び出されている」ことが原因である十分な説明か，原因が異なる場合はその説明をチケットに記載してください．
原因について¶
note-6のとおりですが、少しだけ補足します。
apiを使用しているプラグインでは、使用しているjavascriptライブラリとの都合上、content-typeが「text/html」である必要があるものがあります。
(デフォルトでライブラリの中でstringをjsonオブジェクトに変換します。)
そのため、actionsのexecuteXxx()内でcontent-typeの書き換えを行っています。
その変更をopJsonApiActionsのrenderJSON()で「application/json」に再度置き換えられるために不具合発生となります。
上記についてチケット本文にも記載を行いました。
- ステータス を Accepted（着手） から Pending Review（レビュー待ち） に変更
- 進捗率 を 0 から 50 に変更
note-3の内容は不要であるため、レビュー待ちに更新します。
- ステータス を Pending Review（レビュー待ち） から Pending Testing（テスト待ち） に変更
- 進捗率 を 50 から 70 に変更
- ステータス を Pending Testing（テスト待ち） から Won't fix（対応せず） に変更
- 進捗率 を 70 から 0 に変更
OpenPNE 3.8.6 にて対応済みであったため、対応せずとします。
他の形式にエクスポート: Atom
PDF
