Backport（バックポート） #3330
opJsonApiActions 内で Content-Type の設定が2度呼び出されている
100%
説明
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 の呼び出しが不要なため除去する。
関連するチケット
履歴
#2
kaoru n がほぼ11年前に更新
- ステータス を Accepted（着手） から Pending Review（レビュー待ち） に変更
- 進捗率 を 0 から 50 に変更
https://github.com/openpne/OpenPNE3/pull/77
プルリクエストしました。
#3
Yuya Watanabe がほぼ11年前に更新
下記と同じ理由でマージはまだしていません．
#4
kaoru n がほぼ11年前に更新
原因について¶
https://redmine.openpne.jp/issues/3198#note-6
のとおりですが、少しだけ補足します。
apiを使用しているプラグインでは、使用しているjavascriptライブラリとの都合上、content-typeが「text/html」である必要があるものがあります。
(デフォルトでライブラリの中でstringをjsonオブジェクトに変換します。)
そのため、actionsのexecuteXxx()内でcontent-typeの書き換えを行っています。
その変更をopJsonApiActionsのrenderJSON()で「application/json」に再度置き換えられるために不具合発生となります。
上記についてチケット本文にも記載を行いました。
#6
Yuya Watanabe がほぼ11年前に更新
- ステータス を Pending Review（レビュー待ち） から Pending Testing（テスト待ち） に変更
- 進捗率 を 50 から 70 に変更
#7
Yuya Watanabe がほぼ11年前に更新
- ステータス を Pending Testing（テスト待ち） から Pending Review（レビュー待ち） に変更
- 進捗率 を 70 から 50 に変更
更新履歴 8579ec654a1df2c5df6683c13c43b6a895f4a5d8 で適用されました。
#8
Yuya Watanabe がほぼ11年前に更新
- ステータス を Pending Review（レビュー待ち） から Pending Testing（テスト待ち） に変更
- 進捗率 を 50 から 70 に変更
ステータスが戻っていたのでテスト待ちに戻します
#9
Chiharu Nakajima がほぼ11年前に更新
- ステータス を Pending Testing（テスト待ち） から Fixed（完了） に変更
- 進捗率 を 70 から 100 に変更
確認しました。問題ありません。
チケットをクローズします。