feat: Switch from CloudFunctions v1 beta to v1 (#206)

BREAKING CHANGE:
Services deployed with v1 Beta cannot be updated with v1.

Co-authored-by: Jeremy Minhua Bao (US - ADVS) <jeremy.bao@pwc.com>
Co-authored-by: zxhaaa <zxhaaa@hotmail.com>
Co-authored-by: Peachey_Chen <mr_robot2015@foxmail.com>

Author: 4 people

.gitignore

@@ -4,3 +4,4 @@
 /node_modules
 npm-debug.log
 /package-lock.json
+yarn.lock

MIGRATION_GUIDE.md

@@ -0,0 +1,66 @@
+# Migration Reference from v2 to v3
+
+## Background
+
+> Google Cloud Functions v1beta2 API version will be shut down on April 15, 2020
+
+When you are using serverless to deploy google cloud functions with serverless google plugin v3 (Support google api v1),
+It may face a error like
+
+```
+Deployment failed: TYPE_MISMATCH
+     Resource types cannot be changed, previous (cloudfunctions.v1beta2.function) -> updated (gcp-types/cloudfunctions-v1:projects.locations.functions)
+```
+
+Which means the former ones deployed used serverless-google-cloudfunctions v2, thus it failed to deploy.
+First please be careful that
+
+## Solutions
+
+If you choose to upgrade to v1 function , and make sure the _package.json_ using the latest plugin in nodejs project
+
+```json
+  "devDependencies": {
+    "serverless-google-cloudfunctions": "*"
+  },
+```
+
+There are two options to upgrade the exising cloud functions that deploy via _serverless-google-cloudfunctions v2_ (google api v1beta).
+
+### Option 1
+
+The first is from the devops point of view ,you don't need to change the code at all.
+
+you need to open the [deployment manager](https://cloud.google.com/deployment-manager) in GCP.
+
+- _Delete all the functions_
+
+  You have to delete all the functions and related bucket first ,and then delete the all the related resources from deployment manager
+
+- _Delete all the related buckets with cloud functions_
+
+  By default, each time you you use `serverless deploy` , it would create a bucket for you to store the zip package for the function. pls delete this bucket first.
+
+- _Delete all the function resources in deployment manager_
+
+- _Redeploy the functions_
+
+### Option 2
+
+The second is from the developers' point of view , which means you need to make some changes to the `serverless.yml`.
+
+- Change the service name or change the function name to make sure this function is different from the older one.
+
+- Redeploy the functions.
+
+- Once it's done，you may consider delete the old ones.
+
+### Notices
+
+Both the methods have some pros and cons, see the details from here:
+
+1. If your functions are called by bucket or pubsub, the modification of the function name may not impact your business.
+
+2. If your functions are called by http, the function name would be changed, which means the http url that need to be called may also be changed
+
+3. If you use cloud function to store some important data, pls export these data first and then import them to a new bucket.

README.md

@@ -27,3 +27,9 @@ You can spin up a Docker container which mounts this code with the following com
 ```bash
 docker-compose run node bash
 ```
+
+## Migration
+
+> Google Cloud Functions v1beta2 API version will be shut down on April 15, 2020
+
+You can follow this [document](./MIGRATION_GUIDE.md) to upgrade your serverless-google-cloudfunctions v2 to v3

info/lib/displayServiceInfo.js

@@ -37,7 +37,7 @@ module.exports = {
     };
 
     _.forEach(resources.resources, resource => {
-      if (resource.type === 'cloudfunctions.v1beta2.function') {
+      if (resource.type === 'gcp-types/cloudfunctions-v1:projects.locations.functions') {
         const serviceFuncName = getFunctionNameInService(
           resource.name,
           this.serverless.service.service,
@@ -53,7 +53,7 @@ module.exports = {
           const region = this.options.region;
           const project = this.serverless.service.provider.project;
           const baseUrl = `https://${region}-${project}.cloudfunctions.net`;
-          const path = serviceFunc.handler; // NOTE this might change
+          const path = serviceFunc.name; // NOTE this might change
           funcResource = `${baseUrl}/${path}`;
         }
 

info/lib/displayServiceInfo.test.js

@@ -96,8 +96,14 @@ describe('DisplayServiceInfo', () => {
       const resources = {
         resources: [
           { type: 'resource.which.should.be.filterered', name: 'someResource' },
-          { type: 'cloudfunctions.v1beta2.function', name: 'my-service-dev-func1' },
-          { type: 'cloudfunctions.v1beta2.function', name: 'my-service-dev-func2' },
+          {
+            type: 'gcp-types/cloudfunctions-v1:projects.locations.functions',
+            name: 'my-service-dev-func1',
+          },
+          {
+            type: 'gcp-types/cloudfunctions-v1:projects.locations.functions',
+            name: 'my-service-dev-func2',
+          },
         ],
       };
 
@@ -110,7 +116,7 @@ describe('DisplayServiceInfo', () => {
           functions: [
             {
               name: 'func1',
-              resource: 'https://us-central1-my-project.cloudfunctions.net/handler',
+              resource: 'https://us-central1-my-project.cloudfunctions.net/my-service-dev-func1',
             },
             {
               name: 'func2',
@@ -167,7 +173,7 @@ describe('DisplayServiceInfo', () => {
           functions: [
             {
               name: 'func1',
-              resource: 'https://us-central1-my-project.cloudfunctions.net/handler',
+              resource: 'https://us-central1-my-project.cloudfunctions.net/my-service-dev-func1',
             },
             {
               name: 'func2',
@@ -188,7 +194,8 @@ describe('DisplayServiceInfo', () => {
 
       expectedOutput += `${chalk.yellow.underline('Deployed functions')}\n`;
       expectedOutput += `${chalk.yellow('func1')}\n`;
-      expectedOutput += '  https://us-central1-my-project.cloudfunctions.net/handler\n';
+      expectedOutput +=
+        '  https://us-central1-my-project.cloudfunctions.net/my-service-dev-func1\n';
       expectedOutput += `${chalk.yellow('func2')}\n`;
       expectedOutput += '  projects/*/topics/my-test-topic\n';
 

package/lib/compileFunctions.js

@@ -11,7 +11,9 @@ module.exports = {
   compileFunctions() {
     const artifactFilePath = this.serverless.service.package.artifact;
     const fileName = artifactFilePath.split(path.sep).pop();
-
+    const projectName = _.get(this, 'serverless.service.provider.project');
+    this.serverless.service.provider.region =
+      this.serverless.service.provider.region || 'us-central1';
     this.serverless.service.package.artifactFilePath = `${this.serverless.service.package.artifactDirectoryName}/${fileName}`;
 
     this.serverless.service.getAllFunctions().forEach(functionName => {
@@ -25,6 +27,7 @@ module.exports = {
 
       const funcTemplate = getFunctionTemplate(
         funcObject,
+        projectName,
         this.serverless.service.provider.region,
         `gs://${this.serverless.service.provider.deploymentBucketName}/${this.serverless.service.package.artifactFilePath}`
       );
@@ -33,10 +36,6 @@ module.exports = {
         _.get(funcObject, 'memorySize') ||
         _.get(this, 'serverless.service.provider.memorySize') ||
         256;
-      funcTemplate.properties.location =
-        _.get(funcObject, 'location') ||
-        _.get(this, 'serverless.service.provider.region') ||
-        'us-central1';
       funcTemplate.properties.runtime =
         _.get(funcObject, 'runtime') ||
         _.get(this, 'serverless.service.provider.runtime') ||
@@ -150,17 +149,18 @@ const validateVpcConnectorProperty = (funcObject, functionName) => {
   }
 };
 
-const getFunctionTemplate = (funcObject, region, sourceArchiveUrl) => {
+const getFunctionTemplate = (funcObject, projectName, region, sourceArchiveUrl) => {
   //eslint-disable-line
   return {
-    type: 'cloudfunctions.v1beta2.function',
+    type: 'gcp-types/cloudfunctions-v1:projects.locations.functions',
     name: funcObject.name,
     properties: {
-      location: region,
+      parent: `projects/${projectName}/locations/${region}`,
       availableMemoryMb: 256,
       runtime: 'nodejs8',
       timeout: '60s',
-      function: funcObject.handler,
+      entryPoint: funcObject.handler,
+      function: funcObject.name,
       sourceArchiveUrl,
     },
   };