Cloud Functions for Firebase V2 の単体テスト型エラー

typescript

firebase

投稿日: 2025/02/26

しばらく前にCloud Functions for Firebase V2 が発表されて移行がおすすめされていたが、テスト環境が整ってなく移行を先延ばしにしていました。

久々にIssueを確認していると完全な解決策ではないが、any型で一部パラメータをキャストするハックが紹介されてました。
その覚書です。

import { describe, it, expect, beforeAll, afterEach } from "vitest";
import firebaseFunctionsTest from "firebase-functions-test";

const tester = firebaseFunctionsTest({
  projectId: "demo-project",
});

describe("myFunction", () => {
  afterEach(() => {
    tester.cleanup();
  });

  it("should return the UID when called with authentication", async () => {
    const auth = {
      uid: "test-user-123",
    };

    const wrapped = tester.wrap(myFunction);

    const result = await wrapped({
      data: {},
      auth,
    } as any);
    expect(result).toBe("test-user-123");
  });
});

ちなみにimportなどを使うためにesModuleInterop: true にしています。

{
  "compilerOptions": {
    "module": "commonjs",
    "esModuleInterop": true,

以下、引用。

v2の完全なサポートはほぼ完了しています。呼び出し可能オブジェクト（）にはまだ問題があります.onCall。@tpiaggio直前に、次のように「キャスト」する必要があります。

const wrapped = wrap(myCallable);
await wrapped({
data: {
'foo': 'bar',
},
} as any); // here
次のコンパイルエラーが発生するためです。
Property rawRequest is missing in type { data: { foo: string; }; } but required in type CallableRequest<any>
確かに、テストライブラリとしては、rawRequest をパラメータとして渡すことは望ましくありません (これは、現時点では型指定では必須です)。

https://github.com/firebase/firebase-functions-test/issues/163#issuecomment-2408687931

引き続き、以下のIssueを確認したい。

https://github.com/firebase/firebase-functions-test/issues/257

yosi

Noh を作ってるエンジニア。

Topへ戻る