【Laravel8】Develop環境のときはSaaSサービスにアクセスせず、本番環境のみSaaSサービスにアクセスする方法

Question

実現したいこと

Firebase Authenticationを利用している部分を、
開発環境ではモック（Firebaseに問い合わせない）、
Stage及び本番環境ではFirebaseで実際の動作をさせる

環境

• Laravel8
• PHP8
• Firebase Authentication

質問詳細

認証基盤にFirebase Authenticationを利用しています。
環境はLaravel8系を利用しており、APIを作成しています。

bearer tokenにFirebaseのidTokenを指定し、
LaravelのAPIを叩かれたときに、verifyIdTokenメソッドを利用し都度正しいトークンかを確認する流れを作りました。

しかし、開発環境でAPIを実行する際、idTokenを取得しAPIに含めて送信しなければなりません。
これは開発中はとても手間です。

ですので、このidTokenをチェックする部分を開発環境の場合はMockなどに置き換えたいと思っているのですが、
そのやり方が見つからず困っています。
（PHPUnitを利用した際の、Mockはたくさん出てきますし、実際にそれを利用してテストコードを実行しています。）

この場合はどの様にすればよいのでしょうか？
やはり

if (env('APP_ENV') === 'production') {
    // firebaseにつなぎに行くverifyIdTokenを実行し、ユーザ情報を返す
} else {
    // ダミーのユーザ情報を返す処理
}

// ※ わかりやすくするためelseを書いています。早期リターンについてのツッコミはなしでお願いします。

の様に書かなければいけないのでしょうか？
ご存じの方がいらっしゃいましたら、ご教示いただけますと幸いです。

Comments

[m.ts10806]

開発環境に空振り用のAPI設置するのは難しいですか？

[nnahito]

空振り用のAPIということは、叩くエンドポイントが変わってくるということでしょうか？

本番だと/api/v1/login, 開発だと/api/v1/login2
のように

[m.ts10806]

コード内に分岐書くより環境設定で向き先かえたほうが良いかなと思った次第です。
処理自体分けたいならコードに書くしかないです。
モックなら固定データ返すようなapiにできそうに感じました。

[nnahito]

ご返信ありがとうございます。
やはり、開発と本番でエンドポイントが変わってしまうのは良くないと思います。。

> モックなら固定データ返すようなapiにできそうに感じました。
こちらつまりどう言うことでしょうか？
Dev環境だとMockyなどでMockデータを、本番だと実際にFirebaseに問い合わせを行い本番のデータを返す、
ということでしょうか？

Answer 1

他の方の提示されているように
A.ダミーのAPIリクエストを受け付けるものを作成するか
B.ご自身で提示された

if (env('APP_ENV') === 'production') {
    // firebaseにつなぎに行くverifyIdTokenを実行し、ユーザ情報を返す
} else {
    // ダミーのユーザ情報を返す処理
}

ですね

A.の場合にエンドポイントが変わると困るでしたが、エンドポイントをコード内にハードコーディングではなく
.envで指定するほうが良いかと思います
（私ならデータベース化し、設定画面で変更可能にします）

B.の場合はApp\Utilities\Foo.phpでも作って(名前は適当に）
その中で行うようにして、他のモデルから呼ぶようにすればいいですよね