Adds newly available GCF regions. (#722)

Author: mbleigh

CHANGELOG.md

@@ -1 +1,3 @@
 - Fixes error when last argument to logger methods is `null`. (#716)
+- Adds newly available locations `us-west3`, `europe-west6`, `northamerica-northeast1`, and `australia-southeast1`.
+- No longer throw errors for unrecognized regions (deploy will error instead).

scripts/fetch-regions

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+if [ -z $1 ]; then
+  echo "Must provide a project id as first argument." && exit 1
+fi;
+
+gcloud functions regions list --project $1 --format=json | jq 'map(.locationId)'

spec/function-builder.spec.ts

@@ -121,14 +121,6 @@ describe('FunctionBuilder', () => {
     expect(fn.__trigger.timeout).to.deep.equal('90s');
   });
 
-  it('should fail if valid runtime options but unsupported region are set (reverse order)', () => {
-    expect(() => {
-      functions
-        .runWith({ timeoutSeconds: 90, memory: '256MB' })
-        .region('unsupported' as any);
-    }).to.throw(Error, 'region');
-  });
-
   it('should fail if supported region but invalid runtime options are set (reverse order)', () => {
     expect(() => {
       functions
@@ -165,28 +157,6 @@ describe('FunctionBuilder', () => {
     }).to.throw(Error, 'TimeoutSeconds');
   });
 
-  it('should throw an error if user chooses an invalid region', () => {
-    expect(() => {
-      return functions.region('unsupported' as any);
-    }).to.throw(Error, 'region');
-
-    expect(() => {
-      return functions.region('unsupported' as any).runWith({
-        timeoutSeconds: 500,
-      } as any);
-    }).to.throw(Error, 'region');
-
-    expect(() => {
-      return functions.region('unsupported' as any, 'us-east1');
-    }).to.throw(Error, 'region');
-
-    expect(() => {
-      return functions.region('unsupported' as any, 'us-east1').runWith({
-        timeoutSeconds: 500,
-      } as any);
-    }).to.throw(Error, 'region');
-  });
-
   it('should throw an error if user chooses no region when using .region()', () => {
     expect(() => {
       return functions.region();

src/function-builder.ts

@@ -78,11 +78,6 @@ function assertRegionsAreValid(regions: string[]): boolean {
   if (!regions.length) {
     throw new Error('You must specify at least one region');
   }
-  if (_.difference(regions, SUPPORTED_REGIONS).length) {
-    throw new Error(
-      `The only valid regions are: ${SUPPORTED_REGIONS.join(', ')}`
-    );
-  }
   return true;
 }
 
@@ -95,7 +90,7 @@ function assertRegionsAreValid(regions: string[]): boolean {
  * functions.region('us-east1', 'us-central1')
  */
 export function region(
-  ...regions: Array<typeof SUPPORTED_REGIONS[number]>
+  ...regions: Array<typeof SUPPORTED_REGIONS[number] | string>
 ): FunctionBuilder {
   if (assertRegionsAreValid(regions)) {
     return new FunctionBuilder({ regions });
@@ -127,7 +122,9 @@ export class FunctionBuilder {
    * @example
    * functions.region('us-east1', 'us-central1')
    */
-  region(...regions: Array<typeof SUPPORTED_REGIONS[number]>): FunctionBuilder {
+  region(
+    ...regions: Array<typeof SUPPORTED_REGIONS[number] | string>
+  ): FunctionBuilder {
     if (assertRegionsAreValid(regions)) {
       this.options.regions = regions;
       return this;

src/function-configuration.ts

@@ -5,11 +5,15 @@ export const SUPPORTED_REGIONS = [
   'us-central1',
   'us-east1',
   'us-east4',
+  'us-west3',
   'europe-west1',
   'europe-west2',
   'europe-west3',
+  'europe-west6',
   'asia-east2',
   'asia-northeast1',
+  'northamerica-northeast1',
+  'australia-southeast1',
 ] as const;
 
 /**
@@ -70,6 +74,6 @@ export interface RuntimeOptions {
 }
 
 export interface DeploymentOptions extends RuntimeOptions {
-  regions?: Array<typeof SUPPORTED_REGIONS[number]>;
+  regions?: Array<typeof SUPPORTED_REGIONS[number] | string>;
   schedule?: Schedule;
 }