Strapi v5リリースに伴うプラグインの改修

先日、Strapiのメジャーバージョンv5がリリースされました。

Strapi v5ではv4向けのプラグインがほぼ動かないため、各プラグインでそれぞれ対応する必要があります。

自分もプラグインを幾つか公開していて、先ほどstrapi-plugin-ssoのv5対応を公開したので手順や気になった点を書いていきます。

一連の対応

といってもv5移行の大部分を自分はやっておらず、素晴らしいコントリビューターがベースとなるPRを送ってくださいました。感謝！

marc0777 (Marco Fincato) · GitHub

v4→v5への変更は下記に記載されていますが、beta版やrc版の頃はもっと情報が少なく、マイナーバージョン毎に異なるエラーが出ていて混沌としていました。公式通りの手順で進めてもプラグインのビルド通らなかったり・・。

docs.strapi.io

strapi-plugin-ssoで行った具体的な対応を箇条書きでまとめます。

・プラグインのuid指定変更（リンク）

・ES Modules化（リンク）

・adminのaxiosInstance（プラグイン生成時のボイラープレート）から@strapi/strapi/adminのuseFetchClientに変更

・各dependenciesのバージョンアップ

・webhookの呼び出し方法変更（リンク）

dependenciesはStrapi v5上でプラグインを生成してpackage.jsonを見れば必要なものが分かるので、意外と大変ではないです。

webhookの呼び出し方法が変わっていたようですが、特に資料もなかったのでコアのコードを追っかけたりstrapiオブジェクトをデバッグして正しい関数呼び出し方法を探し出しました。Strapiで少しニッチな実装をするとこういうケースがよくありますが、頑張れば答えに辿り着くことも多いので調べ甲斐があります笑

ブランチ管理は？🤔

v4とv5で依存バージョンが違うものが多々あるので、mainブランチと別にv5用のブランチを作りました。

ただ、v4の中でもマイナーバージョンを高めにすればv5と共存できるのか？と途中で疑問を抱きましたが、検証する時間がなく二重管理にしました。将来的にv4を非サポートとなった段階でv5ブランチをmainにマージすれば、main = v5ブランチになって正しいコミットの順に戻るので良いかなと判断しました。

この辺りOSS特有のセオリーがありそうですがよく分からず。