Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

【調整中】オプション値を取得できるREST APIのエンドポイントを作成 #1449

Closed
wants to merge 9 commits into from

Conversation

mthaichi
Copy link
Contributor

チケットへのリンク / 変更の理由(元のissueがあればリンクを貼り付ければOK)

#1109 #1056 からの #1319 の準備
カスタムストアに対応するためにオプション値を取得できるREST APIのエンドポイントを作成しました。

どういう変更をしたか?

  • REST APIのエンドポイントを作成しました。
  • REST APIのテストを作成しました。REST APIのテストはPOSTなど他にも考えられますが、とりあえず本件に関するテストのみ定義しました。

実装者の確認事項

実装者はレビュワーに回す前に以下の事を確認してチェックをつけてください。

  • 複数の意図の変更 ( 機能の不具合修正 + 別の機能追加など ) を含んでいないか?
  • Files changed (変更ファイル)の内容は目視で確認したか?
  • readme.txt に変更内容は書いたか?
  • 本当にちゃんと確認をしたか?

プログラムの変更の場合

テストを書かないのは普通ではありません。書けるテストは極力書くようにしてください。

  • 書けそうなテストは書いたか?

変更内容について何を確認したか、どういう方法で確認をしたかなど

  • PHPUnitテストを通して、正常な値を返していることを確認
  • 権限を持っていないユーザーがAPIを叩いた場合は値を返さない(401エラーを返す)ことを確認

レビュワーに回す前の確認事項

  • 実装者はこのテンプレートのチェック項目をちゃんと確認してチェックしたか?

レビュワー確認方法・確認内容など

レビュワーがどういう手順で何を確認して欲しいかを記載してください。

  • PHPUnit テストのコードが適切かどうか、またテストが通ることのご確認をお願いします。
  • その他実装面でよりよい方法があれば教えて下さい。

レビュワー向け

レビュワーが確認して変更が反映されていない場合の確認事項

レビューしてみて意図した動作をしない場合は再度ビルドするなど以下の項目を確認してください。

  • プルしたか?
  • ビルドしたか?
  • ビルドしたディレクトリは正しいか(別の開発環境のディレクトリを見ていないか)?
  • npm install したか?
  • composer install したか?
  • キャッシュをクリアして確認したか?

Copy link
Contributor

@shimotmk shimotmk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

良いと思います!

メモ コアはbase URL に / を入れているがregister_rest_routeの関数内でtrimして/を付け直しているので/は無くても良い
https://github.com/WordPress/wordpress-develop/search?q=register_rest_route
https://developer.wordpress.org/reference/functions/register_rest_route/

@shimotmk shimotmk changed the title 【確認待ち】オプション値を取得できるREST APIのエンドポイントを作成 【2人目確認待ち】オプション値を取得できるREST APIのエンドポイントを作成 Oct 13, 2022
@drill-lancer drill-lancer changed the title 【2人目確認待ち】オプション値を取得できるREST APIのエンドポイントを作成 【マージ待ち】オプション値を取得できるREST APIのエンドポイントを作成 Oct 25, 2022
@drill-lancer
Copy link
Member

@mthaichi
良いと思いますが、下記と同時にマージして OK かどうかが不明だったので「マージ待ち」とさせていただきました。
#1434

@shimotmk
Copy link
Contributor

@mthaichi
すみません
ふと気が付いてしまったのですが管理画面とブロックエディタを編集できる権限は違うのでライセンスキー値のGETは除外した方が良いのかなと思ったのですが、どうでしょうか。

管理画面 edit_theme_options
ブロックエディタ edit_posts
https://ja.wordpress.org/support/article/roles-and-capabilities/

@shimotmk shimotmk mentioned this pull request Oct 28, 2022
6 tasks
@mthaichi mthaichi changed the title 【マージ待ち】オプション値を取得できるREST APIのエンドポイントを作成 【調整中】オプション値を取得できるREST APIのエンドポイントを作成 Oct 31, 2022
@mthaichi
Copy link
Contributor Author

mthaichi commented Nov 2, 2022

@shimotmk 上記の件ありがとうございます。このことで少し相談です。REST API側でライセンスキーだけ抜いて出力しようと思ったのですが、
ここで、エディタ周りのオプション値なのか、サイト全体のオプション値なのか、VK_Blocks_Optionsクラスあたりで情報をもたせて、REST API側ではエディタ周りのオプション値のみ出力するとしたほうがいいでしょうか。
どうするのがよいと思われますか。

@shimotmk
Copy link
Contributor

shimotmk commented Nov 2, 2022

@mthaichi

ここで、エディタ周りのオプション値なのか、サイト全体のオプション値なのか、VK_Blocks_Optionsクラスあたりで情報をもたせて、REST API側ではエディタ周りのオプション値のみ出力するとしたほうがいいでしょうか。

そうですね。ブロックエディタではブロックエディタで必要な情報のみ読み書きが出来たらベストかなと思います。
(多分、update_option周りのAPIも必要ですよね😱)

@mthaichi
Copy link
Contributor Author

@shimotmk @drill-lancer

ふと気が付いてしまったのですが管理画面とブロックエディタを編集できる権限は違うのでライセンスキー値のGETは除外した方が良いのかなと思ったのですが、どうでしょうか。

上記の件の対応をしてみましたので、再度ご確認をお願いします。
間がかなり空いてしまって、申し訳ございません。
プルリクの説明通り

  • PHPUnitが通るかどうか(動作チェック)
  • 実装が適切かどうか(コードチェック)

を改めてチェック頂ければと思います。よろしくお願いいたします。

@mthaichi
Copy link
Contributor Author

そうですね。ブロックエディタではブロックエディタで必要な情報のみ読み書きが出来たらベストかなと思います。 (多分、update_option周りのAPIも必要ですよね😱)

@shimotmk そうですよね。update側は別ブランチで対応で良いですかねー。

@mthaichi mthaichi changed the title 【調整中】オプション値を取得できるREST APIのエンドポイントを作成 【確認待ち】オプション値を取得できるREST APIのエンドポイントを作成 Nov 25, 2022
@mthaichi mthaichi removed the request for review from osmdik November 25, 2022 07:24
@shimotmk
Copy link
Contributor

@mthaichi
別ブランチでも良いとは思いますが、除外するオプション値と補うオプション値は一対一の関係にあると思うのでAPIを作るこのブランチで行った方がやり易いのでは?と思いました。

@drill-lancer
Copy link
Member

@mthaichi
僕のが見た限りでは問題ないと思います。

@mthaichi mthaichi changed the title 【確認待ち】オプション値を取得できるREST APIのエンドポイントを作成 【調整中】オプション値を取得できるREST APIのエンドポイントを作成 Nov 30, 2022
@mthaichi mthaichi closed this Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants