backend-manager 2.6.0 → 3.0.0

package/CHANGELOG.md

@@ -15,10 +15,62 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - `Security` in case of vulnerabilities.
 
 ---
+## [3.0.0] - 2023-09-05
+### ⚠️ BREAKING
+- Updated `firebase-admin` from `9.12.0` --> `11.10.1`
+- Updated `firebase-functions` from `3.24.1` --> `4.4.1`
+- This project now requires `firebase-tools` from `10.9.2` --> `12.5.2`
+
+- Updated required Node.js version from `12` --> `16`
+
+- Updated `@google-cloud/storage` from `5.20.5` --> `7.0.1`
+- Updated `fs-jetpack` from `4.3.1` --> `5.1.0`
+- Updated `uuid` from `8.3.2` --> `9.0.0`
+
+- Removed `backend-assistant` dependency and moved to custom library within this module at `./src/manager/helpers/assistant.js`
+- Updated geolocation and client data retrieval to new format:
+#### New Way
+```js
+  const assistant = new Assistant();
+
+  // Get geolocation data
+  assistant.request.geolocation.ip;
+  assistant.request.geolocation.continent;
+  assistant.request.geolocation.country;
+  assistant.request.geolocation.region;
+  assistant.request.geolocation.city;
+  assistant.request.geolocation.latitude;
+  assistant.request.geolocation.longitude;
+
+  // Get Client data
+  assistant.request.client.userAgent;
+  assistant.request.client.language;
+  assistant.request.client.platform;
+  assistant.request.client.mobile;
+```
+
+#### Old Way
+```js
+  const assistant = new Assistant();
+
+  // Get geolocation data
+  assistant.request.ip;
+  assistant.request.continent;
+  assistant.request.country;
+  assistant.request.region;
+  assistant.request.city;
+  assistant.request.latitude;
+  assistant.request.longitude;
+
+  // Get Client data
+  assistant.request.userAgent;
+  assistant.request.language;
+  assistant.request.platform;
+  assistant.request.mobile;
+```
 
 ## [2.6.0] - 2023-09-05
 ### Added
 - Identity Platform auth/before-create.js
 - Identity Platform auth/before-signin.js
 - Disable these by passing `options.setupFunctionsIdentity: false`
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "2.6.0",
+  "version": "3.0.0",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -12,6 +12,9 @@
     "test": "./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
     "start": "node src/index.js"
   },
+  "engines": {
+    "node": "16"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/itw-creative-works/backend-manager.git"
@@ -29,17 +32,16 @@
   "homepage": "https://itwcreativeworks.com",
   "dependencies": {
     "@firebase/rules-unit-testing": "^2.0.7",
-    "@google-cloud/storage": "^5.20.5",
+    "@google-cloud/storage": "^7.0.1",
     "@sendgrid/mail": "^7.7.0",
     "@sentry/node": "^6.19.7",
-    "backend-assistant": "^1.0.11",
     "busboy": "^1.6.0",
     "chalk": "^4.1.2",
     "cors": "^2.8.5",
     "dotenv": "^16.3.1",
-    "firebase-admin": "^9.12.0",
-    "firebase-functions": "^3.24.1",
-    "fs-jetpack": "^4.3.1",
+    "firebase-admin": "^11.10.1",
+    "firebase-functions": "^4.4.1",
+    "fs-jetpack": "^5.1.0",
     "hcaptcha": "^0.1.1",
     "inquirer": "^8.2.5",
     "json5": "^2.2.3",
@@ -51,17 +53,18 @@
     "moment": "^2.29.4",
     "nanoid": "^3.3.6",
     "node-fetch": "^2.7.0",
-    "node-powertools": "^1.0.10",
+    "node-powertools": "^1.1.0",
     "npm-api": "^1.0.1",
     "paypal-server-api": "^1.0.3",
     "pushid": "^1.0.0",
+    "resolve-account": "^1.0.2",
     "semver": "^7.5.4",
     "shortid": "^2.2.16",
-    "sizeitup": "^1.0.3",
+    "sizeitup": "^1.0.7",
     "uid-generator": "^2.0.0",
     "ultimate-jekyll-poster": "^0.0.15",
     "universal-analytics": "^0.5.3",
-    "uuid": "^8.3.2",
+    "uuid": "^9.0.1",
     "wonderful-fetch": "^1.0.0",
     "wonderful-log": "^1.0.5",
     "yargs": "^17.7.2"

package/src/cli/cli.js

@@ -50,7 +50,6 @@ let NPM_CLEAN_SCRIPT = 'rm -fr node_modules && rm -fr package-lock.json && npm c
 let NOFIX_TEXT = chalk.red(`There is no automatic fix for this check.`);
 let runtimeconfigTemplate = JSON.parse((jetpack.read(path.resolve(`${__dirname}/../../templates/runtimeconfig.json`))) || '{}');
 let bemConfigTemplate = JSON.parse((jetpack.read(path.resolve(`${__dirname}/../../templates/backend-manager-config.json`))) || '{}');
-let CLI_CONFIG = JSON5.parse((jetpack.read(path.resolve(`${__dirname}/config.json`))) || '{}');
 
 function Main() {
 }
@@ -98,13 +97,10 @@ Main.prototype.process = async function (args) {
   if ((self.options.i || self.options.install) && (self.options.local || self.options.dev || self.options.development)) {
     await uninstallPkg('backend-manager');
     return await installPkg('file:../../../ITW-Creative-Works/backend-manager');
-    // await uninstallPkg('backend-assistant');
-    // return await installPkg('file:../../backend-assistant');
   }
   if ((self.options.i || self.options.install) && (self.options.live || self.options.prod || self.options.production)) {
     await uninstallPkg('backend-manager');
     return await installPkg('backend-manager');
-    // return await installPkg('backend-assistant');
   }
   if (self.options.serve) {
     if (!self.options.quick && !self.options.q) {
@@ -261,7 +257,7 @@ Main.prototype.setup = async function () {
 
   self.bemApiURL = `https://us-central1-${_.get(self.firebaseRC, 'projects.default')}.cloudfunctions.net/bm_api?authenticationToken=${_.get(self.runtimeConfigJSON, 'backend_manager.key')}`;
   // const prepareStatsURL = `https://us-central1-${_.get(self.firebaseRC, 'projects.default')}.cloudfunctions.net/bm_api?authenticationToken=undefined`;
-  
+
   // Log
   log(`ID: `, chalk.bold(`${self.projectName}`));
   log(`URL:`, chalk.bold(`${self.projectUrl}`));
@@ -273,27 +269,34 @@ Main.prototype.setup = async function () {
   // Tests
   await self.test('is a firebase project', async function () {
     let exists = jetpack.exists(`${self.firebaseProjectPath}/firebase.json`);
-    
+
     return exists;
   }, fix_isFirebase);
 
-  await self.test('.nvmrc file has proper version', async function () {
-    // return !!self.package.dependencies && !!self.package.devDependencies;
-    // let gitignore = jetpack.read(path.resolve(`${__dirname}/../../templates/gitignore.md`));
-    let nvmrc = jetpack.read(`${self.firebaseProjectPath}/functions/.nvmrc`) || '';
-    
-    return nvmrc === `v${CLI_CONFIG.node}/*`
-  }, fix_nvmrc);
+  await self.test(`using node ${self.packageJSON.engines.node}`, function () {
+    const engineReqMajor = parseInt(self.packageJSON.engines.node.split('.')[0]);
+    const engineHasMajor = parseInt(self.package.engines.node.split('.')[0]);
+    const processMajor = parseInt(process.versions.node.split('.')[0]);
+
+    if (processMajor < engineReqMajor) {
+      return new Error(`Please use at least version ${engineReqMajor} of Node.js with this project. You need to update your package.json and your .nvmrc file. Then, make sure to run ${chalk.bold(`nvm use ${engineReqMajor}`)}`)
+    }
 
-  await self.test(`using node ${CLI_CONFIG.node}`, function () {
-    let processMajor = parseInt(process.versions.node.split('.')[0]);
-    let engineMajor = parseInt(self.package.engines.node.split('.')[0]);
-    if (processMajor < engineMajor) {
-      return new Error(`Please use Node.js version ${CLI_CONFIG.node} with this project. You can run: nvm use`)
+    if (engineHasMajor !== engineReqMajor) {
+      console.log(chalk.yellow(`You are using Node.js version ${processMajor} but this project suggests ${engineReqMajor}.`));
     }
-    return self.package.engines.node.toString() === CLI_CONFIG.node && processMajor >= engineMajor;
+
+    return engineHasMajor >= engineReqMajor;
   }, fix_nodeVersion);
 
+  await self.test('.nvmrc file has proper version', async function () {
+    const engineReqMajor = parseInt(self.packageJSON.engines.node.split('.')[0]);
+    const nvmrc = parseInt((jetpack.read(`${self.firebaseProjectPath}/functions/.nvmrc`) || '0').trim().replace(/v|\/|\*/g, ''));
+
+    // return nvmrc === `v${self.packageJSON.engines.node}/*`
+    return nvmrc >= engineReqMajor;
+  }, fix_nvmrc);
+
   // await self.test('project level package.json exists', async function () {
   //   return !!(self.projectPackage && self.projectPackage.version && self.projectPackage.name);
   // }, fix_projpackage);
@@ -351,20 +354,6 @@ Main.prototype.setup = async function () {
     return isLocal(mine) || !(semver.gt(latest, mine)) || majorVersionMismatch;
   }, fix_bem);
 
-  (async function() {
-    let pkg = 'backend-assistant';
-    let latest = semver.clean(await getPkgVersion(pkg));
-    let bemv = cleanPackageVersion(self.packageJSON.dependencies[pkg]);
-    bemPackageVersionWarning(pkg, bemv, latest);
-  }());
-
-  // await self.test('using updated backend-assistant', async function () {
-  //   let pkg = 'backend-assistant';
-  //   let latest = semver.clean(await getPkgVersion(pkg));
-  //   let mine = (self.package.dependencies[pkg] || '0.0.0').replace('^', '').replace('~', '');
-  //   return isLocal(mine) || !(semver.gt(latest, mine));
-  // }, fix_bea);
-
   // await self.test('using updated ultimate-jekyll-poster', async function () {
   //   let pkg = 'ultimate-jekyll-poster';
   //   let latest = semver.clean(await getPkgVersion(pkg));
@@ -756,31 +745,32 @@ async function fix_serviceAccount(self) {
 
 function fix_nodeVersion(self) {
   return new Promise(function(resolve, reject) {
-    _.set(self.package, 'engines.node', CLI_CONFIG.node)
+    if (false) {
+      _.set(self.package, 'engines.node', self.packageJSON.engines.node)
+      jetpack.write(`${self.firebaseProjectPath}/functions/package.json`, JSON.stringify(self.package, null, 2) );
 
-    jetpack.write(`${self.firebaseProjectPath}/functions/package.json`, JSON.stringify(self.package, null, 2) );
-    resolve();
+      resolve();
+    }
+
+    throw new Error('Please manually fix your outdated Node.js version')
   });
 };
 
 function fix_nvmrc(self) {
   return new Promise(function(resolve, reject) {
+    var v = self.packageJSON.engines.node;
 
-    jetpack.write(`${self.firebaseProjectPath}/functions/.nvmrc`, `v${CLI_CONFIG.node}/*`);
-    resolve();
-  });
-};
+    jetpack.write(`${self.firebaseProjectPath}/functions/.nvmrc`, `v${v}/*`);
 
-async function fix_isFirebase(self) {
-  log(chalk.red(`self is not a firebase project. Please use ${chalk.bold('firebase-init')} to set up.`));
-  throw '';
-  return;
+    log(chalk.red(`Please run ${chalk.bold(`nmv use ${v}`)} to use the correct version of Node.js`));
+
+    throw '';
+  });
 };
 
 async function fix_isFirebase(self) {
-  log(chalk.red(`self is not a firebase project. Please use ${chalk.bold('firebase-init')} to set up.`));
+  log(chalk.red(`This is not a firebase project. Please use ${chalk.bold('firebase-init')} to set up.`));
   throw '';
-  return;
 };
 
 function fix_projpackage(self) {
@@ -832,9 +822,7 @@ async function fix_bem(self) {
 
   return;
 };
-// async function fix_bea(self) {
-//   return await installPkg('backend-assistant')
-// };
+
 // async function fix_ujp(self) {
 //   return await installPkg('ultimate-jekyll-poster')
 // };
@@ -920,7 +908,7 @@ function fix_indexesSync(self) {
       } else {
         return reject();
       }
-    })    
+    })
   });
 };
 
@@ -941,7 +929,7 @@ function fix_setStoragePolicy(self) {
     .catch(e => {
       console.error(chalk.red(`There is no automatic fix. Please run: \n${chalk.bold('firebase deploy && npx bm setup')}`));
       return reject();
-    });    
+    });
   });
 };
 
@@ -1151,7 +1139,7 @@ async function execute(command, cwd) {
     //   } else {
     //     resolve(stdout);
     //   }
-    // });    
+    // });
 
   });
 }
@@ -1173,7 +1161,7 @@ async function execute(command, cwd) {
 //     //   } else {
 //     //     resolve(stdout);
 //     //   }
-//     // });    
+//     // });
 
 //   });
 // }
@@ -1340,7 +1328,7 @@ async function cmd_setStorageLifecycle(self) {
       .replace(/{bucket}/ig, `us.artifacts.${self.projectName}.appspot.com`)
     const command2 = `gsutil lifecycle set {config} gs://{bucket}`
       .replace(/{config}/ig, path.resolve(`${__dirname}/../../templates/storage-lifecycle-config-30-days.json`))
-      .replace(/{bucket}/ig, `bm-backup-firestore-${self.projectName}`)      
+      .replace(/{bucket}/ig, `bm-backup-firestore-${self.projectName}`)
 
     exec(command, function (error, stdout, stderr) {
       if (error) {

package/src/manager/functions/core/actions/api/general/send-email.js

@@ -33,7 +33,7 @@ Module.prototype.main = function () {
       return reject(assistant.errorManager(`Parameter {email} is required.`, {code: 400, sentry: false, send: false, log: false}).error)
     }
 
-    let emailPayload 
+    let emailPayload
     try {
       emailPayload = merge({}, DEFAULT, require(path.join(__dirname, 'emails', `${payload.data.payload.id}.js`))(payload.data.payload, Manager.config));
     } catch (e) {
@@ -41,7 +41,7 @@ Module.prototype.main = function () {
     }
 
     const storage = Manager.storage({temporary: true});
-    const ipPath = ['api:general:send-email', 'ips', assistant.request.ip];
+    const ipPath = ['api:general:send-email', 'ips', assistant.request.geolocation.ip];
     const emailPath = ['api:general:send-email', 'emails', payload.data.payload.email];
 
     const ipData = storage.get(ipPath).value() || {};
@@ -53,7 +53,7 @@ Module.prototype.main = function () {
 
     emailData.count = (emailData.count || 0) + 1;
     emailData.firstRequestTime = emailData.firstRequestTime ? emailData.firstRequestTime : new Date().toISOString();
-    emailData.lastRequestTime = new Date().toISOString();    
+    emailData.lastRequestTime = new Date().toISOString();
 
     storage.set(ipPath, ipData).write();
     storage.set(emailPath, emailData).write();
@@ -63,7 +63,7 @@ Module.prototype.main = function () {
     if (ipData.count >= emailPayload.spamFilter.ip || emailData.count >= emailPayload.spamFilter.email) {
       self.assistant.errorManager(`Spam filter triggered ip=${ipData.count}, email=${emailData.count}`, {code: 429, sentry: false, send: false, log: true})
       return resolve({data: {success: true}});
-    }    
+    }
 
     assistant.log('Email payload:', emailPayload, {environment: 'production'});
 
@@ -94,7 +94,7 @@ Module.prototype.main = function () {
     })
     .catch(e => {
       return reject(assistant.errorManager(`Error sending email: ${e}`, {code: 500, sentry: true, send: false, log: false}).error)
-    })    
+    })
   });
 
 };

package/src/manager/functions/core/actions/api/special/setup-electron-manager-client.js

@@ -85,8 +85,8 @@ Module.prototype.main = function () {
           uuid: uuid,
           signInToken: signInToken,
           timestamp: new Date().toISOString(),
-          ip: assistant.request.ip,
-          country: assistant.request.country,
+          ip: assistant.request.geolocation.ip,
+          country: assistant.request.geolocation.country,
           app: result,
           config: config,
         }

package/src/manager/functions/core/actions/api/user/sign-up.js

@@ -107,22 +107,8 @@ Module.prototype.signUp = function (payload) {
     // Merge the payload and the default user object
     const user = {
       activity: {
-        geolocation: {
-          // Main geolocation
-          ip: assistant.request.ip,
-          continent: assistant.request.continent,
-          region: assistant.request.region,
-          country: assistant.request.country,
-          city: assistant.request.city,
-          latitude: assistant.request.latitude,
-          longitude: assistant.request.longitude,
-
-          // Get User Agent data
-          userAgent: assistant.request.userAgent,
-          language: assistant.request.language,
-          platform: assistant.request.platform,
-          mobile: assistant.request.mobile,
-        },
+        geolocation: assistant.request.geolocation,
+        client: assistant.request.client,
       },
       affiliate: {
         referrer: payload.affiliate.referrer,

package/src/manager/functions/core/events/auth/before-create.js

@@ -71,6 +71,8 @@ Module.prototype.main = function () {
         geolocation: {
           ip: ipAddress,
           language: context.locale,
+        },
+        client: {
           userAgent: context.userAgent,
         },
       },

package/src/manager/functions/core/events/auth/before-signin.js

@@ -39,6 +39,8 @@ Module.prototype.main = function () {
           geolocation: {
             ip: context.ipAddress,
             language: context.locale,
+          },
+          client: {
             userAgent: context.userAgent,
           },
         },

package/src/manager/helpers/analytics.js

@@ -20,10 +20,10 @@ function Analytics(Manager, options) {
   // Set properties
   self._assistant = options.assistant || Manager.Assistant();
   self._request = {
-    ip: get(self._assistant, 'request.ip', '127.0.0.1'),
-    country: get(self._assistant, 'request.country', ''),
+    ip: get(self._assistant, 'request.geolocation.ip', '127.0.0.1'),
+    country: get(self._assistant, 'request.geolocation.country', ''),
     referrer: get(self._assistant, 'request.referrer', ''),
-    userAgent: get(self._assistant, 'request.userAgent', ''),
+    userAgent: get(self._assistant, 'request.client.userAgent', ''),
     name: get(self._assistant, 'meta.name', ''),
   }
 

package/src/manager/helpers/api-manager.js

@@ -187,10 +187,10 @@ ApiManager.prototype.getUser = async function (assistant) {
     // console.log('---authenticatedUser', authenticatedUser);
     const planId = get(authenticatedUser, 'plan.id', 'basic');
     let workingUID = !authenticatedUser.authenticated
-      ? uuidv5(assistant.request.ip, '1b671a64-40d5-491e-99b0-da01ff1f3341')
+      ? uuidv5(assistant.request.geolocation.ip, '1b671a64-40d5-491e-99b0-da01ff1f3341')
       : authenticatedUser.auth.uid
-    authenticatedUser.ip = assistant.request.ip;
-    authenticatedUser.country = assistant.request.country;
+    authenticatedUser.ip = assistant.request.geolocation.ip;
+    authenticatedUser.country = assistant.request.geolocation.country;
     // console.log('---workingUID', workingUID);
     // console.log('----self.userList', self.userList);
     let existingUser = self.userList.find(user => user.auth.uid === workingUID);