backend-manager 3.2.172 → 3.2.174

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "3.2.172",
+  "version": "3.2.174",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -36,8 +36,8 @@
   },
   "homepage": "https://itwcreativeworks.com",
   "preparePackage": {
-    "input": "./src",
-    "output": "./dist",
+    "input": "./src_",
+    "output": "./dist_",
     "replace": {}
   },
   "dependencies": {

package/src/cli/cli.js

@@ -269,13 +269,13 @@ Main.prototype.setup = async function () {
   bem_giRegex = new RegExp(jetpack.read(path.resolve(`${__dirname}/../../templates/gitignore.md`)), 'm' )
 
   // tests
-  self.projectName = self.firebaseRC.projects.default;
-  self.projectUrl = `https://console.firebase.google.com/project/${self.projectName}`;
+  self.projectId = self.firebaseRC.projects.default;
+  self.projectUrl = `https://console.firebase.google.com/project/${self.projectId}`;
 
   self.bemApiURL = `https://us-central1-${self?.firebaseRC?.projects?.default}.cloudfunctions.net/bm_api?authenticationToken=${self?.runtimeConfigJSON?.backend_manager?.key}`;
 
   // Log
-  log(`ID: `, chalk.bold(`${self.projectName}`));
+  log(`ID: `, chalk.bold(`${self.projectId}`));
   log(`URL:`, chalk.bold(`${self.projectUrl}`));
 
   if (!self.package || !self.package.engines || !self.package.engines.node) {
@@ -436,7 +436,7 @@ Main.prototype.setup = async function () {
 
   await self.test('has correct ID in backend-manager-config.json', async function () {
     // Check if the project name matches the projectId
-    if (self.projectName !== self.bemConfigJSON?.firebaseConfig?.projectId) {
+    if (self.projectId !== self.bemConfigJSON?.firebaseConfig?.projectId) {
       console.error(chalk.red('Mismatch between project name and firebaseConfig.projectId in backend-manager-config.json'));
       return false;
     }
@@ -445,9 +445,25 @@ Main.prototype.setup = async function () {
     return true;
   }, NOFIX);
 
-  await self.test('has service-account.json', function () {
-    let exists = jetpack.exists(`${self.firebaseProjectPath}/functions/service-account.json`);
-    return !!exists;
+  await self.test('has correct service-account.json', function () {
+    let serviceAccount = jetpack.read(`${self.firebaseProjectPath}/functions/service-account.json`);
+
+    // Make sure the service account exists
+    if (!serviceAccount) {
+      console.error(chalk.red('Missing service-account.json'));
+      return false;
+    }
+
+    // Parse the service account
+    serviceAccount = JSON5.parse(serviceAccount);
+
+    // Check if project_id matches the project's ID
+    if (self.projectId !== serviceAccount.project_id) {
+      console.error(chalk.red('Mismatch between project name and service account project_id'));
+      return false;
+    }
+
+    return true;
   }, fix_serviceAccount);
 
   await self.test('has correct .gitignore', function () {
@@ -824,7 +840,7 @@ async function fix_isFirebase(self) {
 function fix_projpackage(self) {
   return new Promise(function(resolve, reject) {
     self.projectPackage = self.projectPackage || {};
-    self.projectPackage.name = self.projectPackage.name || self.projectName;
+    self.projectPackage.name = self.projectPackage.name || self.projectId;
     self.projectPackage.version = self.projectPackage.version || '0.0.1';
     self.projectPackage.dependencies = self.projectPackage.dependencies || {};
     self.projectPackage.devDependencies = self.projectPackage.devDependencies || {};
@@ -1413,7 +1429,7 @@ async function cmd_iamImportExport(self) {
           --member serviceAccount:{projectId}@appspot.gserviceaccount.com \
           --role roles/datastore.importExportAdmin
     `
-    .replace(/{projectId}/ig, self.projectName)
+    .replace(/{projectId}/ig, self.projectId)
 
     let cmd = exec(command, function (error, stdout, stderr) {
       if (error) {
@@ -1431,10 +1447,10 @@ async function cmd_setStorageLifecycle(self) {
   return new Promise(function(resolve, reject) {
     const command = `gsutil lifecycle set {config} gs://{bucket}`
       .replace(/{config}/ig, path.resolve(`${__dirname}/../../templates/storage-lifecycle-config-1-day.json`))
-      .replace(/{bucket}/ig, `us.artifacts.${self.projectName}.appspot.com`)
+      .replace(/{bucket}/ig, `us.artifacts.${self.projectId}.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.projectId}`)
 
     exec(command, function (error, stdout, stderr) {
       if (error) {

package/src/manager/helpers/assistant.js

@@ -4,6 +4,17 @@ const _ = require('lodash');
 const uuid = require('uuid');
 let JSON5;
 
+const LOG_LEVELS = {
+  error: 'error',
+  warn: 'warn',
+  info: 'info',
+  debug: 'debug',
+  log: 'log',
+  notice: 'NOTICE',
+  critical: 'CRITICAL',
+  emergency: 'EMERGENCY'
+};
+
 function BackendAssistant() {
   const self = this;
 
@@ -12,7 +23,24 @@ function BackendAssistant() {
   self.initialized = false;
 
   // Add log methods
-  addLogMethods();
+  Object.keys(LOG_LEVELS)
+  .forEach((level) => {
+    // Skip log because it is already a method
+    // if (level === 'log') {
+    //   return;
+    // }
+
+    // Add log method
+    BackendAssistant.prototype[level] = function() {
+      const self = this;
+      const args = Array.prototype.slice.call(arguments);
+
+      // Prepend level to args
+      args.unshift(level);
+      // self.log.apply(this, args);
+      self._log.apply(this, args);
+    };
+  });
 
   return self;
 }
@@ -33,12 +61,14 @@ function tryParse(input) {
 BackendAssistant.prototype.init = function (ref, options) {
   const self = this;
 
+  // Set options
   options = options || {};
   options.accept = options.accept || 'json';
   options.showOptionsLog = typeof options.showOptionsLog !== 'undefined' ? options.showOptionsLog : false;
   options.optionsLogString = typeof options.optionsLogString !== 'undefined' ? options.optionsLogString : '\n\n\n\n\n';
   options.fileSavePath = options.fileSavePath || process.env.npm_package_name || '';
 
+  // Set now
   const now = new Date();
 
   // Attached libraries - used in .errorify()
@@ -236,96 +266,41 @@ BackendAssistant.prototype.logProd = function () {
   self._log.apply(self, args);
 };
 
-BackendAssistant.prototype.log = function () {
+BackendAssistant.prototype._log = function () {
   const self = this;
+  const logs = [...arguments];
+  const prefix = self.logPrefix ? ` ${self.logPrefix}:` : ':';
 
-  const args = Array.prototype.slice.call(arguments);
+  // Prepend log prefix log string
+  logs.unshift(`[${self.tag} @ ${new Date().toISOString()}]${prefix}`);
 
-  self._log.apply(self, args);
-};
+  // Get the log level
+  const level = logs[1];
 
-function addLogMethods() {
-  const levels = ['error', 'warn', 'info', 'debug', 'notice', 'critical', 'emergency'];
+  // Pass along arguments to console.log
+  if (LOG_LEVELS[level]) {
+    logs.splice(1, 1);
 
-  // Add log methods
-  levels.forEach((level) => {
-    BackendAssistant.prototype[level] = function() {
-      const self = this;
-      const args = Array.prototype.slice.call(arguments);
-
-      // Prepend level to args
-      args.unshift(level);
-      self.log.apply(this, args);
-    };
-  });
-}
-
-BackendAssistant.prototype._log = function () {
-  const self = this;
-
-  // 1. Convert args to a normal array
-  const logs = [...Array.prototype.slice.call(arguments)];
-
-  // Add log prefix
-  const prefix = self.logPrefix
-    ? ` ${self.logPrefix}:`
-    : ':';
-
-  // 2. Prepend log prefix log string
-  logs.unshift(
-    `[${self.tag} @ ${new Date().toISOString()}]${prefix}`
-  );
-
-  // 3. Pass along arguments to console.log
-  if (logs[1] === 'error') {
-    logs.splice(1,1)
-    console.error.apply(console, logs);
-  } else if (logs[1] === 'warn') {
-    logs.splice(1,1)
-    console.warn.apply(console, logs);
-  } else if (logs[1] === 'info') {
-    logs.splice(1,1)
-    console.info.apply(console, logs);
-  } else if (logs[1] === 'debug') {
-    logs.splice(1,1)
-    console.debug.apply(console, logs);
-  } else if (logs[1] === 'notice') {
-    logs.splice(1,1)
-    if (self.isDevelopment()) {
-      console.log.apply(console, logs);
-    } else {
-      self.ref.functions.logger.write({
-        severity: 'NOTICE',
-        message: logs,
-      });
-    }
-  } else if (logs[1] === 'critical') {
-    logs.splice(1,1)
-    if (isDevelopment) {
+    // Determine how to log
+    if (level in console) {
+      console[level].apply(console, logs);
+    } else if (self.isDevelopment()) {
       console.log.apply(console, logs);
     } else {
       self.ref.functions.logger.write({
-        severity: 'CRITICAL',
+        severity: LOG_LEVELS[level].toUpperCase(),
         message: logs,
       });
     }
-  } else if (logs[1] === 'emergency') {
-    logs.splice(1,1)
-    if (isDevelopment) {
-      console.log.apply(console, logs);
-    } else {
-      self.ref.functions.logger.write({
-        severity: 'EMERGENCY',
-        message: logs,
-      });
+
+    // Write with wonderful-log
+    if (self.Manager?.libraries?.logger?.[level]) {
+      self.Manager?.libraries?.logger?.[level](...logs)
     }
-  } else if (logs[1] === 'log') {
-    logs.splice(1,1)
-    console.log.apply(console, logs);
   } else {
     console.log.apply(console, logs);
   }
-}
+};
 
 BackendAssistant.prototype.setLogPrefix = function (s) {
   const self = this;

package/src/manager/index.js

@@ -70,6 +70,7 @@ Manager.prototype.init = function (exporter, options) {
   options.assistant = options.assistant || {};
   options.cwd = typeof options.cwd === 'undefined' ? process.cwd() : options.cwd;
   options.projectPackageDirectory = typeof options.projectPackageDirectory === 'undefined' ? undefined : options.projectPackageDirectory;
+  options.logSavePath = typeof options.logSavePath === 'undefined' ? false : options.logSavePath;
   // options.assistant.optionsLogString = options.assistant.optionsLogString || undefined;
 
   // Load libraries
@@ -87,6 +88,7 @@ Manager.prototype.init = function (exporter, options) {
     localDatabase: null,
     User: null,
     Analytics: null,
+    logger: null,
   };
 
   // Set properties
@@ -118,8 +120,27 @@ Manager.prototype.init = function (exporter, options) {
   // Get app ID
   const appId = self.config?.app?.id;
 
+  // Set log
+  if (options.logSavePath) {
+    self.libraries.logger = new (require('wonderful-log'))({
+      console: {
+        enabled: false,
+      },
+      file: {
+        enabled: true,
+        path: options.logSavePath,
+      },
+    });
+  }
+
   // Init assistant
-  self.assistant = self.Assistant().init(undefined, options.assistant);
+  self.assistant = self.Assistant().init({
+    req: null,
+    res: null,
+    admin: self.libraries.admin,
+    functions: self.libraries.functions,
+    Manager: self,
+  }, options.assistant);
 
   // Set more properties (need to wait for assistant to determine if DEV)
   self.project.functionsUrl = self.assistant.isDevelopment()