firebase-functions
Version:
Firebase SDK for Cloud Functions
206 lines (204 loc) • 7.3 kB
JavaScript
import { warn } from "../logger/index.mjs";
import { Expression } from "../params/types.mjs";
import { declaredParams } from "../params/index.mjs";
import { convertIfPresent, copyIfPresent, durationFromSeconds, serviceAccountFromShorthand } from "../common/encoding.mjs";
import { RESET_VALUE, ResetValue } from "../common/options.mjs";
import { assertNever } from "../common/utilities/assertions.mjs";
import { requiresRole } from "./security.mjs";
//#region src/v2/options.ts
/**
* Maximum timeout in seconds for event-handling functions (e.g. Firestore,
* Realtime Database, Pub/Sub, Storage, Eventarc, alerts, scheduler).
* See https://firebase.google.com/docs/functions/manage-functions
* @internal
*/
const MAX_EVENT_TIMEOUT_SECONDS = 540;
/**
* Maximum timeout in seconds for HTTPS and callable functions.
* @internal
*/
const MAX_HTTPS_TIMEOUT_SECONDS = 3600;
/**
* Maximum timeout in seconds for Task Queue functions.
* @internal
*/
const MAX_TASK_TIMEOUT_SECONDS = 1800;
/**
* Maximum timeout in seconds for Identity blocking functions.
* @internal
*/
const MAX_IDENTITY_TIMEOUT_SECONDS = 7;
const MemoryOptionToMB = {
"128MiB": 128,
"256MiB": 256,
"512MiB": 512,
"1GiB": 1024,
"2GiB": 2048,
"4GiB": 4096,
"8GiB": 8192,
"16GiB": 16384,
"32GiB": 32768
};
let globalOptions;
/**
* Sets default options for all functions written using the 2nd gen SDK.
* @param options Options to set as default
*/
function setGlobalOptions(options) {
if (globalOptions) {
warn("Calling setGlobalOptions twice leads to undefined behavior");
}
globalOptions = options;
}
/**
* Get the currently set default options.
* Used only for trigger generation.
* @internal
*/
function getGlobalOptions() {
return globalOptions || {};
}
/**
* Validate that `timeoutSeconds` (resolved with global option fallback) is
* finite and within the accepted range for the given function kind. Throws a
* plain `Error` matching the v1 `assertRuntimeOptionsValid` shape so the
* problem surfaces at function-definition time instead of at deploy time.
* `Expression`, `RESET_VALUE`, and `undefined` are skipped. Literal numbers
* are range checked, and other types are rejected.
* @internal
*/
function assertTimeoutSecondsValid(opts, kind) {
const timeoutSeconds = opts.timeoutSeconds === undefined ? getGlobalOptions().timeoutSeconds : opts.timeoutSeconds;
if (typeof timeoutSeconds !== "number") {
if (timeoutSeconds === undefined || timeoutSeconds instanceof Expression || timeoutSeconds instanceof ResetValue) {
return;
}
throw new Error(`timeoutSeconds must be a number, Expression, or RESET_VALUE. Got ${typeof timeoutSeconds}.`);
}
if (!Number.isFinite(timeoutSeconds)) {
throw new Error(`timeoutSeconds must be a finite number. Got ${timeoutSeconds}.`);
}
let max;
let label;
switch (kind) {
case "event":
max = MAX_EVENT_TIMEOUT_SECONDS;
label = "event-handling";
break;
case "https":
max = MAX_HTTPS_TIMEOUT_SECONDS;
label = "HTTPS and callable";
break;
case "task":
max = MAX_TASK_TIMEOUT_SECONDS;
label = "task queue";
break;
case "identity":
max = MAX_IDENTITY_TIMEOUT_SECONDS;
label = "blocking";
break;
default: assertNever(kind);
}
if (timeoutSeconds < 0 || timeoutSeconds > max) {
throw new Error(`timeoutSeconds must be between 0 and ${max} for ${label} functions. Got ${timeoutSeconds}.`);
}
}
/**
* Apply GlobalOptions to trigger definitions.
* @internal
*/
function optionsToTriggerAnnotations(opts, kind) {
if (kind !== undefined) {
assertTimeoutSecondsValid(opts, kind);
}
const annotation = {};
copyIfPresent(annotation, opts, "concurrency", "minInstances", "maxInstances", "ingressSettings", "labels", "vpcConnector", "secrets");
const vpcEgress = opts.vpcEgress ?? opts.vpcConnectorEgressSettings;
if (vpcEgress !== undefined) {
if (vpcEgress === null || vpcEgress instanceof ResetValue) {
annotation.vpcConnectorEgressSettings = null;
} else {
annotation.vpcConnectorEgressSettings = vpcEgress;
}
}
convertIfPresent(annotation, opts, "availableMemoryMb", "memory", (mem) => {
return MemoryOptionToMB[mem];
});
convertIfPresent(annotation, opts, "regions", "region", (region) => {
if (typeof region === "string") {
return [region];
}
return region;
});
convertIfPresent(annotation, opts, "serviceAccountEmail", "serviceAccount", serviceAccountFromShorthand);
convertIfPresent(annotation, opts, "timeout", "timeoutSeconds", durationFromSeconds);
convertIfPresent(annotation, opts, "failurePolicy", "retry", (retry) => {
return retry ? { retry: true } : null;
});
return annotation;
}
/**
* Apply GlobalOptions to endpoint manifest.
* @internal
*/
function optionsToEndpoint(opts, kind) {
if (kind !== undefined) {
assertTimeoutSecondsValid(opts, kind);
}
const endpoint = {};
copyIfPresent(endpoint, opts, "omit", "concurrency", "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds", "cpu");
convertIfPresent(endpoint, opts, "serviceAccountEmail", "serviceAccount");
if (opts.vpcEgress && opts.vpcConnectorEgressSettings) {
warn("vpcEgress and vpcConnectorEgressSettings are both set. Using vpcEgress");
}
const vpcEgress = opts.vpcEgress ?? opts.vpcConnectorEgressSettings;
const connector = opts.vpcConnector;
const networkInterface = opts.networkInterface;
if (connector !== undefined || vpcEgress !== undefined || networkInterface !== undefined) {
const resetConnector = connector === null || connector instanceof ResetValue;
const hasConnector = !!connector;
const resetNetwork = networkInterface === null || networkInterface instanceof ResetValue;
const hasNetwork = !!networkInterface && !resetNetwork;
if (hasNetwork) {
if (!networkInterface.network && !networkInterface.subnetwork) {
throw new Error("At least one of network or subnetwork must be specified in networkInterface.");
}
}
if (hasNetwork && hasConnector) {
throw new Error("Cannot set both vpcConnector and networkInterface");
} else if (resetConnector && !hasNetwork || resetNetwork && !hasConnector) {
endpoint.vpc = RESET_VALUE;
} else {
const vpc = {};
convertIfPresent(vpc, opts, "connector", "vpcConnector");
if (vpcEgress !== undefined) {
vpc.egressSettings = vpcEgress;
}
convertIfPresent(vpc, opts, "networkInterfaces", "networkInterface", (a) => [a]);
endpoint.vpc = vpc;
}
}
convertIfPresent(endpoint, opts, "availableMemoryMb", "memory", (mem) => {
return typeof mem === "object" ? mem : MemoryOptionToMB[mem];
});
convertIfPresent(endpoint, opts, "region", "region", (region) => {
if (typeof region === "string") {
return [region];
}
return region;
});
convertIfPresent(endpoint, opts, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: typeof secret === "string" ? secret : secret.name })));
return endpoint;
}
/**
* @hidden
* @alpha
*/
function __getSpec() {
return {
globalOptions: getGlobalOptions(),
params: declaredParams.map((p) => p.toSpec())
};
}
//#endregion
export { MAX_EVENT_TIMEOUT_SECONDS, MAX_HTTPS_TIMEOUT_SECONDS, MAX_IDENTITY_TIMEOUT_SECONDS, MAX_TASK_TIMEOUT_SECONDS, RESET_VALUE, __getSpec, assertTimeoutSecondsValid, getGlobalOptions, optionsToEndpoint, optionsToTriggerAnnotations, requiresRole, setGlobalOptions };