function-configuration.ts

/**
 * List of all regions supported by Cloud Functions.
 */
export const SUPPORTED_REGIONS = [
  'us-central1',
  'us-east1',
  'us-east4',
  'us-west2',
  'us-west3',
  'us-west4',
  'europe-central2',
  'europe-west1',
  'europe-west2',
  'europe-west3',
  'europe-west6',
  'asia-east1',
  'asia-east2',
  'asia-northeast1',
  'asia-northeast2',
  'asia-northeast3',
  'asia-south1',
  'asia-southeast1',
  'asia-southeast2',
  'northamerica-northeast1',
  'southamerica-east1',
  'australia-southeast1',
] as const;

/**
 * Cloud Functions min timeout value.
 */
export const MIN_TIMEOUT_SECONDS = 0;

/**
 * Cloud Functions max timeout value.
 */
export const MAX_TIMEOUT_SECONDS = 540;

/**
 * List of available memory options supported by Cloud Functions.
 */
export const VALID_MEMORY_OPTIONS = [
  '128MB',
  '256MB',
  '512MB',
  '1GB',
  '2GB',
  '4GB',
  '8GB',
] as const;

/**
 * List of available options for VpcConnectorEgressSettings.
 */
export const VPC_EGRESS_SETTINGS_OPTIONS = [
  'VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED',
  'PRIVATE_RANGES_ONLY',
  'ALL_TRAFFIC',
] as const;

/**
 * List of available options for IngressSettings.
 */
export const INGRESS_SETTINGS_OPTIONS = [
  'INGRESS_SETTINGS_UNSPECIFIED',
  'ALLOW_ALL',
  'ALLOW_INTERNAL_ONLY',
  'ALLOW_INTERNAL_AND_GCLB',
] as const;

/**
 * Scheduler retry options. Applies only to scheduled functions.
 */
export interface ScheduleRetryConfig {
  retryCount?: number;
  maxRetryDuration?: string;
  minBackoffDuration?: string;
  maxBackoffDuration?: string;
  maxDoublings?: number;
}

/**
 * Configuration options for scheduled functions.
 */
export interface Schedule {
  schedule: string;
  timeZone?: string;
  retryConfig?: ScheduleRetryConfig;
}

export interface FailurePolicy {
  retry: {};
}

export const DEFAULT_FAILURE_POLICY: FailurePolicy = {
  retry: {},
};

export const MAX_NUMBER_USER_LABELS = 58;

export interface RuntimeOptions {
  /**
   * Which platform should host the backend. Valid options are "gcfv1"
   * @hidden
   */
  platform?: 'gcfv1';

  /**
   * Failure policy of the function, with boolean `true` being equivalent to
   * providing an empty retry object.
   */
  failurePolicy?: FailurePolicy | boolean;
  /**
   * Amount of memory to allocate to the function.
   */
  memory?: typeof VALID_MEMORY_OPTIONS[number];
  /**
   * Timeout for the function in seconds, possible values are 0 to 540.
   */
  timeoutSeconds?: number;

  /**
   * Min number of actual instances to be running at a given time.
   * Instances will be billed for memory allocation and 10% of CPU allocation
   * while idle.
   */
  minInstances?: number;

  /**
   * Max number of actual instances allowed to be running in parallel.
   */
  maxInstances?: number;

  /**
   * Connect cloud function to specified VPC connector.
   */
  vpcConnector?: string;

  /**
   * Egress settings for VPC connector.
   */
  vpcConnectorEgressSettings?: typeof VPC_EGRESS_SETTINGS_OPTIONS[number];

  /**
   * Specific service account for the function to run as.
   */
  serviceAccount?: 'default' | string;

  /**
   * Ingress settings which control where this function can be called from.
   */
  ingressSettings?: typeof INGRESS_SETTINGS_OPTIONS[number];

  /**
   * User labels to set on the function.
   */
  labels?: Record<string, string>;

  /**
   * Invoker to set access control on https functions.
   */
  invoker?: 'public' | 'private' | string | string[];
}

export interface DeploymentOptions extends RuntimeOptions {
  regions?: Array<typeof SUPPORTED_REGIONS[number] | string>;
  schedule?: Schedule;
}