firebase-functions/v2/scheduler onSchedule is not supported by the wrapper

[maas-it]

Version info

firebase-functions-test: 3.1.0

firebase-functions: 4.4.1

firebase-admin: 11.10.1

Expected behavior

Call my test function with the v2 ScheduledEvent like it happens in my production environment:

Started CET billing job {
jobName: 'firebase-schedule-billingCET-europe-west1',
scheduleTime: '2023-08-10T04:00:03.442Z'
}

Actual behavior

Error: Options object {"scheduleTime":"2021-01-17T05:00:00.000Z"} has invalid key "scheduleTime".

Because the old job event seems to be expected. If I rename scheduleTime to timestamp it will be called with the old v1 scheduled event:

Started CET reservation statistic job {
     eventId: 'fdnstcb0e6p97erpk53aei',
     resource: undefined,
     eventType: '',
     timestamp: '2021-01-17T05:00:00.000Z',
     params: {}
   }

[alexandercerutti]

I was trying to test onSchedule functions as well.

For what I was able to see, since what is required is that a function follows the protocol and has a run() method and even if v1 path is followed, the function is still called.

The only issue is that event parameter signature with which the function is called is different... which arises only if you want or need to use those parameters.

My specific case doesn't use them at all, so I'm fine like this.

When providing a mocked event, like below, the only accepted parameters are eventId and timestamp.

const { wrap } = firebaseFunctionsTest();
const wrappedScheduledFunction = wrap(myScheduledFunction);

const mockEvent = {
	eventId: 'test-event-id',
	timestamp: new Date().toISOString(),
};

await wrappedScheduledFunction(mockEvent);

Any parameter outside of them, throws an error, because these parameters are hardcoded.

firebase-functions-test/src/v1.ts

Lines 133 to 148 in fb6cd5c

	if (has(cloudFunction, '__endpoint.scheduleTrigger')) {
	const scheduledWrapped: WrappedScheduledFunction = (
	options: ContextOptions
	) => {
	// Although in Typescript we require `options` some of our JS samples do not pass it.
	options = options || {};
	_checkOptionValidity(['eventId', 'timestamp'], options);
	const defaultContext = _makeDefaultContext(cloudFunction, options);
	const context = merge({}, defaultContext, options);
	// @ts-ignore
	return cloudFunction.run(context);
	};
	return scheduledWrapped;
	}

Other than that, the only problem is related to Typescript support (which I ignore, for my specific use case).

In fact, for the example code I provided above, Typescript sets an issue on the second line with this error, that recalls what has been said until now.

No overload matches this call.
  The last overload gave the following error.
    Argument of type 'ScheduleFunction' is not assignable to parameter of type 'CloudFunction<CloudEvent<unknown>>'.
      Types of property 'run' are incompatible.
        Type '(data: ScheduledEvent) => void | Promise<void>' is not assignable to type '(event: CloudEvent<unknown>) => any'.
          Types of parameters 'data' and 'event' are incompatible.
            Property 'scheduleTime' is missing in type 'CloudEvent<unknown>' but required in type 'ScheduledEvent'.

And the the 7th line (awaiting call) returns an error on the format of mockEvent, still related to the second line.

Argument of type '{ eventId: string; timestamp: string; }' is not assignable to parameter of type 'ScheduledEvent'.
  Property 'scheduleTime' is missing in type '{ eventId: string; timestamp: string; }' but required in type 'ScheduledEvent'.

So, if you are willing to use some // @ts-ignore or writing tests in plain Javascript (as I'm doing, with IDE type-checking), I feel there are no other problems.

[cabljac]

Triaging the functions-test FR backlog. Acknowledging, and confirmed the mechanism: a v2 onSchedule function is HTTP-shaped, so wrap misroutes it to the v1 scheduled path whose options allow-list is only eventId/timestamp, hence the invalid key "scheduleTime" error. No v2 ScheduledEvent support in the wrapper yet. Keeping it open.