Skip to content

fix(functions): store CLOUD_TASKS_EMULATOR_HOST at construction time #3167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanedey merged 3 commits into from
Jun 6, 2026
+70 −10
Merged

fix(functions): store CLOUD_TASKS_EMULATOR_HOST at construction time #3167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d7bbdb
fix(functions): store CLOUD_TASKS_EMULATOR_HOST at construction time
jonathanedey Jun 3, 2026
f81c2d2
fix: address gemini review
jonathanedey Jun 3, 2026
57b1b55
Merge branch 'v14' into je-task-em
jonathanedey Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions src/functions/functions-api-client-internal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ const DEFAULT_LOCATION = 'us-central1';
*/
export class FunctionsApiClient {
private readonly httpClient: HttpClient;
private readonly emulatorHost?: string;
private projectId?: string;
private accountId?: string;

Expand All @@ -56,7 +57,9 @@ export class FunctionsApiClient {
message: 'First argument passed to getFunctions() must be a valid Firebase app instance.'
});
}
this.httpClient = new FunctionsHttpClient(app as FirebaseApp);
const emulatorHost = process.env.CLOUD_TASKS_EMULATOR_HOST?.trim();
this.emulatorHost = emulatorHost || undefined;
this.httpClient = new FunctionsHttpClient(app as FirebaseApp, this.emulatorHost);
}
/**
* Deletes a task from a queue.
Expand Down Expand Up @@ -103,7 +106,7 @@ export class FunctionsApiClient {
}

try {
const serviceUrl = tasksEmulatorUrl(resources)?.concat('/', id)
const serviceUrl = tasksEmulatorUrl(resources, this.emulatorHost)?.concat('/', id)
?? await this.getUrl(resources, CLOUD_TASKS_API_URL_FORMAT.concat('/', id));
const request: HttpRequestConfig = {
method: 'DELETE',
Expand Down Expand Up @@ -165,7 +168,7 @@ export class FunctionsApiClient {
const task = this.validateTaskOptions(data, resources, opts);
try {
const serviceUrl =
tasksEmulatorUrl(resources) ??
tasksEmulatorUrl(resources, this.emulatorHost) ??
await this.getUrl(resources, CLOUD_TASKS_API_URL_FORMAT);

const taskPayload = await this.updateTaskPayload(task, resources, extensionId);
Expand Down Expand Up @@ -347,7 +350,7 @@ export class FunctionsApiClient {
}

private async updateTaskPayload(task: Task, resources: utils.ParsedResource, extensionId?: string): Promise<Task> {
const defaultUrl = process.env.CLOUD_TASKS_EMULATOR_HOST ?
const defaultUrl = this.emulatorHost ?
''
: await this.getUrl(resources, FIREBASE_FUNCTION_URL_FORMAT);

Expand All @@ -368,7 +371,7 @@ export class FunctionsApiClient {
const account = await this.getServiceAccount();
task.httpRequest.oidcToken = { serviceAccountEmail: account };
} catch (e) {
if (process.env.CLOUD_TASKS_EMULATOR_HOST) {
if (this.emulatorHost) {
task.httpRequest.oidcToken = { serviceAccountEmail: EMULATED_SERVICE_ACCOUNT_DEFAULT };
} else {
throw e;
Expand Down Expand Up @@ -408,8 +411,12 @@ export class FunctionsApiClient {
* when communicating with the Emulator.
*/
class FunctionsHttpClient extends AuthorizedHttpClient {
constructor(app: FirebaseApp, private readonly emulatorHost?: string) {
super(app);
}

protected getToken(): Promise<string> {
if (process.env.CLOUD_TASKS_EMULATOR_HOST) {
if (this.emulatorHost) {
return Promise.resolve('owner');
}
return super.getToken();
Expand Down Expand Up @@ -448,9 +455,9 @@ export interface Task {
};
}

function tasksEmulatorUrl(resources: utils.ParsedResource): string | undefined {
if (process.env.CLOUD_TASKS_EMULATOR_HOST) {
return `http://${process.env.CLOUD_TASKS_EMULATOR_HOST}/projects/${resources.projectId}/locations/${resources.locationId}/queues/${resources.resourceId}/tasks`;
function tasksEmulatorUrl(resources: utils.ParsedResource, emulatorHost?: string): string | undefined {
if (emulatorHost) {
return `http://${emulatorHost}/projects/${resources.projectId}/locations/${resources.locationId}/queues/${resources.resourceId}/tasks`;
}
return undefined;
}
55 changes: 54 additions & 1 deletion test/unit/functions/functions-api-client-internal.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,56 @@ describe('FunctionsApiClient', () => {
expect(() => new FunctionsApiClient(null as unknown as FirebaseApp))
.to.throw('First argument passed to getFunctions() must be a valid Firebase app instance.');
});

it('should cache CLOUD_TASKS_EMULATOR_HOST at construction time', async () => {
delete process.env.CLOUD_TASKS_EMULATOR_HOST;
const prodClient = new FunctionsApiClient(app);

process.env.CLOUD_TASKS_EMULATOR_HOST = CLOUD_TASKS_EMULATOR_HOST;
const emulatorClient = new FunctionsApiClient(app);

delete process.env.CLOUD_TASKS_EMULATOR_HOST;

const sendStub = sinon
.stub(HttpClient.prototype, 'send')
.resolves(utils.responseFrom({}, 200));
stubs.push(sendStub);

await prodClient.delete('mock-task', FUNCTION_NAME);
await emulatorClient.delete('mock-task', FUNCTION_NAME);

expect(sendStub).to.have.been.calledTwice;
expect(sendStub.firstCall).to.have.been.calledWith({
method: 'DELETE',
url: CLOUD_TASKS_URL.concat('/', 'mock-task'),
headers: EXPECTED_HEADERS,
});
expect(sendStub.secondCall).to.have.been.calledWith({
method: 'DELETE',
url: CLOUD_TASKS_URL_EMULATOR.concat('/', 'mock-task'),
headers: EXPECTED_HEADERS_EMULATOR,
});
});

for (const hostVal of ['', ' ']) {
it(`should ignore CLOUD_TASKS_EMULATOR_HOST when set to "${hostVal}"`, async () => {
process.env.CLOUD_TASKS_EMULATOR_HOST = hostVal;
const emptyHostClient = new FunctionsApiClient(app);
delete process.env.CLOUD_TASKS_EMULATOR_HOST;

const stub = sinon
.stub(HttpClient.prototype, 'send')
.resolves(utils.responseFrom({}, 200));
stubs.push(stub);

await emptyHostClient.delete('mock-task', FUNCTION_NAME);
expect(stub).to.have.been.calledWith({
method: 'DELETE',
url: CLOUD_TASKS_URL.concat('/', 'mock-task'),
headers: EXPECTED_HEADERS,
});
});
}
});

describe('enqueue', () => {
Expand Down Expand Up @@ -529,6 +579,7 @@ describe('FunctionsApiClient', () => {
.resolves(utils.responseFrom({}, 200));
stubs.push(stub);
process.env.CLOUD_TASKS_EMULATOR_HOST = CLOUD_TASKS_EMULATOR_HOST;
apiClient = new FunctionsApiClient(app);
return apiClient.enqueue({}, FUNCTION_NAME, '', { uri: TEST_TASK_PAYLOAD.httpRequest.url })
.then(() => {
expect(stub).to.have.been.calledOnce.and.calledWith({
Expand All @@ -550,6 +601,7 @@ describe('FunctionsApiClient', () => {
.resolves(utils.responseFrom({}, 200));
stubs.push(stub);
process.env.CLOUD_TASKS_EMULATOR_HOST = CLOUD_TASKS_EMULATOR_HOST;
apiClient = new FunctionsApiClient(app);
return apiClient.enqueue({}, FUNCTION_NAME)
.then(() => {
expect(stub).to.have.been.calledOnce.and.calledWith({
Expand All @@ -569,7 +621,6 @@ describe('FunctionsApiClient', () => {
projectId: 'test-project',
serviceAccountId: ''
});
apiClient = new FunctionsApiClient(app);

const expectedPayload = deepCopy(TEST_TASK_PAYLOAD);
expectedPayload.httpRequest.oidcToken = { serviceAccountEmail: EMULATED_SERVICE_ACCOUNT_DEFAULT };
Expand All @@ -578,6 +629,7 @@ describe('FunctionsApiClient', () => {
.resolves(utils.responseFrom({}, 200));
stubs.push(stub);
process.env.CLOUD_TASKS_EMULATOR_HOST = CLOUD_TASKS_EMULATOR_HOST;
apiClient = new FunctionsApiClient(app);
return apiClient.enqueue({}, FUNCTION_NAME, '', { uri: TEST_TASK_PAYLOAD.httpRequest.url })
.then(() => {
expect(stub).to.have.been.calledOnce.and.calledWith({
Expand Down Expand Up @@ -631,6 +683,7 @@ describe('FunctionsApiClient', () => {

it('should redirect to the emulator when CLOUD_TASKS_EMULATOR_HOST is set', async () => {
process.env.CLOUD_TASKS_EMULATOR_HOST = CLOUD_TASKS_EMULATOR_HOST;
apiClient = new FunctionsApiClient(app);
const stub = sinon
.stub(HttpClient.prototype, 'send')
.resolves(utils.responseFrom({}, 200));
Expand Down