fix(functions): stop-billing - Apply feedback from glasnt #4085 (review)

Author: eapl-gemugami

functions/billing/stop-billing/.eslintrc.json

@@ -1,12 +1,5 @@
 {
-  "rules": {
-    "node/no-missing-import": ["off"],
-    "node/no-missing-require": ["off"],
-    "node/no-unpublished-import": ["off"],
-    "node/no-unpublished-require": ["off"],
-    "node/no-unsupported-features/es-syntax": ["off"]
-  },
   "parserOptions": {
     "ecmaVersion": 2020
   }
-}
+}

functions/billing/stop-billing/.gcloudignore

@@ -19,24 +19,23 @@ const gcpMetadata = require('gcp-metadata');
 
 const billing = new CloudBillingClient();
 
-const projectIdEnv = process.env.GOOGLE_CLOUD_PROJECT;
+let projectId = process.env.GOOGLE_CLOUD_PROJECT;
 
-functions.cloudEvent('StopBillingCloudEvent', async cloudEvent => {
-  // TODO(developer): As stopping billing is a destructive action
-  // for your project, change the following constant to `false`
-  // after you validate with a test budget.
-  const simulateDeactivation = true;
-
-  let projectId = projectIdEnv;
+// TODO(developer): Since stopping billing is a destructive action
+// for your project, first validate a test budget with a dry run enabled.
+const dryRun = true;
 
+functions.cloudEvent('StopBillingCloudEvent', async cloudEvent => {
   if (projectId === undefined) {
-    console.log(
-      'Project ID not found in env variables. Getting GCP metadata...'
-    );
     try {
       projectId = await gcpMetadata.project('project-id');
     } catch (error) {
       console.error('project-id metadata not found:', error);
+
+      console.error(
+        'Project ID could not be found in environment variables ' +
+          'or Cloud Run metadata server. Stopping execution.'
+      );
       return;
     }
   }
@@ -50,6 +49,7 @@ functions.cloudEvent('StopBillingCloudEvent', async cloudEvent => {
     console.error('Invalid CloudEvent: missing data.message.data');
     return;
   }
+
   const eventData = Buffer.from(messageData, 'base64').toString();
 
   let eventObject;
@@ -75,7 +75,7 @@ functions.cloudEvent('StopBillingCloudEvent', async cloudEvent => {
 
   const billingEnabled = await _isBillingEnabled(projectName);
   if (billingEnabled) {
-    await _disableBillingForProject(projectName, simulateDeactivation);
+    await _disableBillingForProject(projectName);
   } else {
     console.log('Billing is already disabled.');
   }
@@ -106,14 +106,12 @@ const _isBillingEnabled = async projectName => {
 /**
  * Disable billing for a project by removing its billing account
  * @param {string} projectName The name of the project to disable billing
- * @param {boolean} simulateDeactivation
- *   If true, it won't actually disable billing.
- *   Useful to validate with test budgets.
  * @returns {void}
  */
-const _disableBillingForProject = async (projectName, simulateDeactivation) => {
-  if (simulateDeactivation) {
-    console.log('Billing disabled. (Simulated)');
+const _disableBillingForProject = async projectName => {
+  if (dryRun) {
+    console.log('** DRY RUN: simulating billing deactivation');
+    console.log('Billing disabled.');
     return;
   }
 
@@ -128,7 +126,7 @@ const _disableBillingForProject = async (projectName, simulateDeactivation) => {
       resource: requestBody,
     });
 
-    console.log(`Billing disabled: ${JSON.stringify(response)}`);
+    console.log(`Billing disabled. Response: ${JSON.stringify(response)}`);
   } catch (e) {
     console.error('Failed to disable billing, check permissions.', e);
   }

functions/billing/stop-billing/index.js

@@ -10,7 +10,7 @@
   "scripts": {
     "test": "c8 mocha -p -j 2 test/index.test.js --timeout=5000 --exit"
   },
-  "author": "Emmanuel Parada <[email protected]>",
+  "author": "Google Inc.",
   "license": "Apache-2.0",
   "dependencies": {
     "@google-cloud/billing": "^5.1.0",
@@ -21,4 +21,4 @@
   "devDependencies": {
     "c8": "^10.1.3"
   }
-}
+}

functions/billing/stop-billing/package.json

@@ -113,7 +113,7 @@ describe('index.test.js', () => {
 
       assert.ok(consoleOutput.includes('Getting billing info'));
       assert.ok(consoleOutput.includes('Disabling billing for project'));
-      assert.ok(consoleOutput.includes('Billing disabled. (Simulated)'));
+      assert.ok(consoleOutput.includes('Billing disabled.'));
     });
   });
 });