How to pass auth in CallableRequest?

[risalfajar]

I'm trying to test authorization in my function, but auth.token object needed lots of properties which I don't need

import { beforeEach, describe, expect, it } from "vitest"
import { updateService as fn } from "./update"
import { WrappedV2CallableFunction, wrapV2 } from "firebase-functions-test/lib/v2"
import { defaultService } from "@features/service/data/service"
import { CallableRequest } from "firebase-functions/lib/common/providers/https"

describe("update service", () => {
	let updateService: WrappedV2CallableFunction<any>

	beforeEach(() => {
		updateService = wrapV2(fn)
	})

	it("should reject unauthorized users", async () => {
		const request: CallableRequest = {
			acceptsStreaming: false,
			rawRequest      : {} as any,
			data            : defaultService(),
			auth            : {
				uid  : "test",
				token: {
					// TOO much properties
				}
			}
		}
		await expect(updateService(request)).rejects.toThrowError("Login")
	})
})

I also don't need acceptsStreaming and rawRequest, but that has been talked about in #257

[CorieW]

Hi @risalfajar,

Thanks for reporting this issue! We’ve received it and are reviewing it. We’ll provide updates as soon as possible.

[CorieW]

You could do something like this:

index.ts

import * as functions from "firebase-functions";
import { info } from "firebase-functions/logger";

export const callable = functions.https.onCall(async (request) => {
  return request.auth?.token.email
});

index.test.ts

import { beforeEach, describe, expect, it } from "vitest"
import { WrappedV2CallableFunction, wrapV2 } from "firebase-functions-test/lib/v2"
import { callable } from "."

describe("auth testing", () => {
  let callableFunc: WrappedV2CallableFunction<any>
  
  beforeEach(() => {
    callableFunc = wrapV2(callable)
  })

  it("should return the email from the request", async () => {
    const email = '[email protected]';

    const request: any = {
      auth: {
        uid: "test",
	token: {
	  email: email,
	}
      }
    }

    expect(await callableFunc(request)).equals(email)
  })
})

However, this isn't ideal, since it may be preferable to not lose typing. For that, I'll make a PR that should make it easier to test callable functions.