backend-manager 3.2.131 → 3.2.133

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "3.2.131",
+  "version": "3.2.133",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {

package/src/cli/cli.js

@@ -49,8 +49,8 @@ let bem_allRulesBackupRegex = /({{\s*?backend-manager\s*?}})/sgm;
 let MOCHA_PKG_SCRIPT = 'mocha ../test/ --recursive --timeout=10000';
 let NPM_CLEAN_SCRIPT = 'rm -fr node_modules && rm -fr package-lock.json && npm cache clean --force && npm install && npm rb';
 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 runtimeconfigTemplate = loadJSON(`${__dirname}/../../templates/runtimeconfig.json`);
+let bemConfigTemplate = loadJSON(`${__dirname}/../../templates/backend-manager-config.json`);
 
 function Main() {
 }
@@ -236,35 +236,32 @@ Main.prototype.getRulesFile = function () {
 Main.prototype.setup = async function () {
   const self = this;
   let cwd = jetpack.cwd();
+
   log(chalk.green(`\n---- RUNNING SETUP v${self.default.version} ----`));
-  self.package = jetpack.read(`${self.firebaseProjectPath}/functions/package.json`) || '{}';
-  self.firebaseJSON = jetpack.read(`${self.firebaseProjectPath}/firebase.json`) || '{}';
-  self.firebaseRC = jetpack.read(`${self.firebaseProjectPath}/.firebaserc`) || '{}';
-  self.runtimeConfigJSON = jetpack.read(`${self.firebaseProjectPath}/functions/.runtimeconfig.json`) || '{}';
-  self.remoteconfigJSON = jetpack.read(`${self.firebaseProjectPath}/remoteconfig.template.json`) || '{}';
-  self.projectPackage = jetpack.read(`${self.firebaseProjectPath}/package.json`) || '{}';
-  self.bemConfigJSON = jetpack.read(`${self.firebaseProjectPath}/functions/backend-manager-config.json`) || '{}';
 
+  // Load files
+  self.package = loadJSON(`${self.firebaseProjectPath}/functions/package.json`);
+  self.firebaseJSON = loadJSON(`${self.firebaseProjectPath}/firebase.json`);
+  self.firebaseRC = loadJSON(`${self.firebaseProjectPath}/.firebaserc`);
+  self.runtimeConfigJSON = loadJSON(`${self.firebaseProjectPath}/functions/.runtimeconfig.json`);
+  self.remoteconfigJSON = loadJSON(`${self.firebaseProjectPath}/remoteconfig.template.json`);
+  self.projectPackage = loadJSON(`${self.firebaseProjectPath}/package.json`);
+  self.bemConfigJSON = loadJSON(`${self.firebaseProjectPath}/functions/backend-manager-config.json`);
   self.gitignore = jetpack.read(`${self.firebaseProjectPath}/functions/.gitignore`) || '';
-  if (!self.package) {
+
+  // Check if package exists
+  if (!hasContent(self.package)) {
     log(chalk.red(`Missing functions/package.json :(`));
     return;
   }
-  // console.log('cwd', cwd, cwd.endsWith('functions'));
+
+  // Check if we're running from the functions folder
   if (!cwd.endsWith('functions') && !cwd.endsWith('functions/')) {
     log(chalk.red(`Please run ${chalk.bold('npx bm setup')} from the ${chalk.bold('functions')} folder. Run ${chalk.bold('cd functions')}.`));
     return;
   }
 
-  self.package = JSON.parse(self.package);
-  self.firebaseJSON = JSON.parse(self.firebaseJSON);
-  self.firebaseRC = JSON.parse(self.firebaseRC);
-  self.runtimeConfigJSON = JSON.parse(self.runtimeConfigJSON);
-  self.remoteconfigJSON = JSON.parse(self.remoteconfigJSON);
-  self.projectPackage = JSON.parse(self.projectPackage);
-
-  self.remoteconfigJSONExists = Object.keys(self.remoteconfigJSON).length > 0;
-
+  // Load the rules files
   self.getRulesFile();
 
   self.default.rulesVersionRegex = new RegExp(`///---version=${self.default.version}---///`)
@@ -275,8 +272,7 @@ Main.prototype.setup = async function () {
   self.projectName = self.firebaseRC.projects.default;
   self.projectUrl = `https://console.firebase.google.com/project/${self.projectName}`;
 
-  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`;
+  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}`));
@@ -403,63 +399,51 @@ Main.prototype.setup = async function () {
   }, fix_distScript);
 
   await self.test('using proper .runtimeconfig', async function () {
-    let runtimeconfig = JSON.parse(jetpack.read(`${self.firebaseProjectPath}/functions/.runtimeconfig.json`) || '{}');
-    let ogPaths = getObjectPaths(runtimeconfigTemplate).split('\n');
+    // Set pass
     let pass = true;
 
-    for (var i = 0, l = ogPaths.length; i < l; i++) {
-      let item = ogPaths[i];
-      if (!item) {continue}
-      pass = _.get(runtimeconfig, item, undefined);
-      if (typeof pass === 'undefined') {
-        break;
+    // Loop through all the keys in the template
+    powertools.getKeys(runtimeconfigTemplate).forEach((key) => {
+      const userValue = _.get(self.runtimeConfigJSON, key, undefined);
+
+      // If the user value is undefined, then we need to set pass to false
+      if (typeof userValue === 'undefined') {
+        pass = false;
       }
-    }
+    });
 
-    return !!pass;
+    // Return result
+    return pass;
   }, fix_runtimeConfig);
 
-  // await self.test('using proper env', async function () {
-  //   let runtimeconfig = JSON.parse(jetpack.read(`${self.firebaseProjectPath}/functions/.runtimeconfig.json`) || '{}');
-  //   let ogPaths = getObjectPaths(runtimeconfigTemplate).split('\n');
-  //   let pass = true;
-
-  //   for (var i = 0, l = ogPaths.length; i < l; i++) {
-  //     let item = ogPaths[i];
-  //     if (!item) {continue}
-  //     pass = _.get(runtimeconfig, item, undefined);
-  //     if (typeof pass === 'undefined') {
-  //       break;
-  //     }
-  //   }
-
-  //   return !!pass;
-  // }, fix_runtimeConfig);
-
   await self.test('using proper backend-manager-config.json', async function () {
-    const bemConfig = JSON.parse(self.bemConfigJSON);
-
-    let ogPaths = getObjectPaths(bemConfigTemplate).split('\n');
+    // Set pass
     let pass = true;
 
-    for (var i = 0, l = ogPaths.length; i < l; i++) {
-      let item = ogPaths[i];
-      if (!item) {continue}
-      pass = (_.get(bemConfig, item, undefined));
-      if (typeof pass === 'undefined' || typeof pass === '') {
-        break;
+    // Loop through all the keys in the template
+    powertools.getKeys(bemConfigTemplate).forEach((key) => {
+      const userValue = _.get(self.bemConfigJSON, key, undefined);
+
+      // If the user value is undefined, then we need to set pass to false
+      if (typeof userValue === 'undefined') {
+        pass = false;
       }
-    }
+    });
 
-    if (self.projectName !== bemConfig.firebaseConfig.projectId) {
+    // Return result
+    return pass;
+  }, fix_bemConfig);
+
+  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) {
       console.error(chalk.red('Mismatch between project name and firebaseConfig.projectId in backend-manager-config.json'));
       return false;
     }
 
-    self.bemConfigJSON = bemConfig;
-
-    return !!pass;
-  }, fix_bemConfig);
+    // Return pass
+    return true;
+  }, NOFIX);
 
   await self.test('has service-account.json', function () {
     let exists = jetpack.exists(`${self.firebaseProjectPath}/functions/service-account.json`);
@@ -478,35 +462,28 @@ Main.prototype.setup = async function () {
     }
   }, fix_gitignore);
 
-
   // Check firebase.json fields
-  await self.test('firestore rules in JSON', function () {
-    const firestore = _.get(self.firebaseJSON, 'firestore', {});
-    return (firestore.rules === 'firestore.rules')
+  await self.test('firestore rules in JSON', () => {
+    return self.firebaseJSON?.firestore?.rules === 'firestore.rules'
   }, fix_firestoreRules);
 
-  await self.test('firestore indexes in JSON', function () {
-    let firestore = _.get(self.firebaseJSON, 'firestore', {});
-    return (firestore.indexes === 'firestore.indexes.json')
+  await self.test('firestore indexes in JSON', () => {
+    return self.firebaseJSON?.firestore?.indexes === 'firestore.indexes.json';
   }, fix_firestoreIndexes);
 
-  await self.test('realtime rules in JSON', function () {
-    const database = _.get(self.firebaseJSON, 'database', {});
-    return (database.rules === 'database.rules.json')
+  await self.test('realtime rules in JSON', () => {
+    return self.firebaseJSON?.database?.rules === 'database.rules.json';
   }, fix_realtimeRules);
 
-  await self.test('storage rules in JSON', function () {
-    const storage = _.get(self.firebaseJSON, 'storage', {});
-    return (storage.rules === 'storage.rules')
+  await self.test('storage rules in JSON', () => {
+    return self.firebaseJSON?.storage?.rules === 'storage.rules';
   }, fix_storageRules);
 
-  await self.test('remoteconfig template in JSON', function () {
-    const remoteconfig = _.get(self.firebaseJSON, 'remoteconfig', {});
-
-    if (self.remoteconfigJSONExists) {
-      return (remoteconfig.template === 'remoteconfig.template.json')
+  await self.test('remoteconfig template in JSON', () => {
+    if (hasContent(self.remoteconfigJSON)) {
+      return self.firebaseJSON?.remoteconfig?.template === 'remoteconfig.template.json';
     } else {
-      return (remoteconfig.template === '')
+      return self.firebaseJSON?.remoteconfig?.template === '';
     }
   }, fix_remoteconfigTemplate);
 
@@ -676,29 +653,6 @@ Main.prototype.setup = async function () {
 
 };
 
-// https://stackoverflow.com/questions/41802259/javascript-deep-check-objects-have-same-keys
-// function objectsHaveSameKeys(...objects) {
-//   let objectPaths = getObjectPaths()
-//    // const allKeys = objects.reduce((keys, object) => keys.concat(Object.keys(object)), []);
-//    // const union = new Set(allKeys);
-//    // return objects.every(object => union.size === Object.keys(object).length);
-//
-//    // const allKeys = objects.reduce((keys, object) => keys.concat(Object.keys(object)), []);
-//    console.log('allKeys', allKeys);
-//    return false
-// }
-
-function getObjectPaths(object, parent) {
-  let keys = Object.keys(object);
-  let composite = '';
-  parent = parent || '';
-  for (var i = 0, l = keys.length; i < l; i++) {
-    let item = object[keys[i]];
-    composite += typeof item === 'object' ? getObjectPaths(item, keys[i]) : `${parent}.${keys[i]}\n`;
-  }
-  return composite;
-}
-
 Main.prototype.test = async function(name, fn, fix, args) {
   const self = this;
   let status;
@@ -749,47 +703,50 @@ function bemPackageVersionWarning(package, current, latest) {
 
 async function fix_runtimeConfig(self) {
   return new Promise(function(resolve, reject) {
+    // Log
     log(NOFIX_TEXT);
     log(chalk.red(`You need to run ${chalk.bold(`npx bm config:set`)} for each of these keys:`));
-    let objectKeys = getObjectPaths(runtimeconfigTemplate).split('\n');
-    let theirConfig = JSON.parse(jetpack.read(`${self.firebaseProjectPath}/functions/.runtimeconfig.json`) || '{}');
-    for (var i = 0, l = objectKeys.length; i < l; i++) {
-      let item = objectKeys[i];
-      if (!item) {return}
-      let has = _.get(theirConfig, item, '');
-      if (has) {
-        log(chalk.red(`${item} (${has})`));
+
+    // Log what keys are missing
+    powertools.getKeys(runtimeconfigTemplate).forEach((key) => {
+      const userValue = _.get(self.runtimeConfigJSON, key, undefined);
+
+      if (typeof userValue === 'undefined') {
+        log(chalk.red.bold(`${key}`));
       } else {
-        log(chalk.red.bold(`${item}`));
+        log(chalk.red(`${key} (${userValue})`));
       }
-    }
-    // console.log('objectKeys', objectKeys);
-    // log(chalk.red(`You need to run ${chalk.bold(`npx bm config:set`)} for each of these keys: \n${getObjectPaths(runtimeconfigTemplate)}`));
+    });
+
+    // Reject
     reject();
   });
 };
 
 async function fix_bemConfig(self) {
   return new Promise(function(resolve, reject) {
+    // Log
     log(NOFIX_TEXT);
     log(chalk.red(`You need to open backend-manager-config.json and set each of these keys:`));
-    let objectKeys = getObjectPaths(bemConfigTemplate).split('\n');
-    let theirConfig = JSON.parse(jetpack.read(`${self.firebaseProjectPath}/functions/backend-manager-config.json`) || '{}');
-    if (Object.keys(theirConfig).length < 1) {
-      jetpack.write(`${self.firebaseProjectPath}/functions/backend-manager-config.json`, bemConfigTemplate)
+
+    // Write if it doesnt exist
+    if (!hasContent(self.bemConfigJSON)) {
+      // jetpack.write(`${self.firebaseProjectPath}/functions/backend-manager-config.json`, bemConfigTemplate)
+      jetpack.write(`${self.firebaseProjectPath}/functions/backend-manager-config.json`, {})
     }
-    for (var i = 0, l = objectKeys.length; i < l; i++) {
-      let item = objectKeys[i];
-      if (!item) {return}
-      let has = _.get(theirConfig, item, '');
-      if (has) {
-        log(chalk.red(`${item} (${has})`));
+
+    // Log what keys are missing
+    powertools.getKeys(bemConfigTemplate).forEach((key) => {
+      const userValue = _.get(self.bemConfigJSON, key, undefined);
+
+      if (typeof userValue === 'undefined') {
+        log(chalk.red.bold(`${key}`));
       } else {
-        log(chalk.red.bold(`${item}`));
+        log(chalk.red(`${key} (${userValue})`));
       }
-    }
-    // console.log('objectKeys', objectKeys);
-    // log(chalk.red(`You need to run ${chalk.bold(`bm config:set`)} for each of these keys: \n${getObjectPaths(runtimeconfigTemplate)}`));
+    });
+
+    // Reject
     reject();
   });
 };
@@ -974,7 +931,8 @@ function fix_storageRules(self) {
 
 function fix_remoteconfigTemplate(self) {
   return new Promise(function(resolve, reject) {
-    _.set(self.firebaseJSON, 'remoteconfig.template', self.remoteconfigJSONExists ? 'remoteconfig.template.json' : '')
+
+    _.set(self.firebaseJSON, 'remoteconfig.template', hasContent(self.remoteconfigJSON) ? 'remoteconfig.template.json' : '')
     jetpack.write(`${self.firebaseProjectPath}/firebase.json`, JSON.stringify(self.firebaseJSON, null, 2));
     resolve();
   });
@@ -1538,26 +1496,26 @@ function uninstallPkg(name) {
     });
   });
 }
+function loadJSON(path) {
+  const contents = jetpack.read(path);
+  if (!contents) {
+    return {};
+  }
+
+  return JSON5.parse(contents);
+}
+
+function hasContent(object) {
+  return Object.keys(object).length > 0;
+}
 
 function cleanOutput(data) {
   try {
-    // data = (data + '').replace('\n', '')
     data = (data + '').replace(/\n$/, '')
   } catch (e) {
 
   }
+
+  // Return
   return data;
-  // try {
-  //   data = data.replace(/\n/, '');
-  // } catch (e) {
-  //
-  // } finally {
-  //
-  // }
-  // return data;
-  // // if (typeof data !== 'string') {
-  // //   return data;
-  // // } else {
-  // //   return data.replace(/\n/, '');
-  // // }
 }

package/src/manager/functions/core/actions/api/admin/create-post.js

@@ -299,8 +299,11 @@ Module.prototype.uploadPost = function (content) {
     // Log
     assistant.log(`uploadPost(): Existing`, existing);
 
-    // Error
-    if (existing instanceof Error) {
+    // Quit if error and it's not a 404
+    if (
+      existing instanceof Error
+      && existing?.status !== 404
+    ) {
       return reject(existing);
     }
 
@@ -309,7 +312,7 @@ Module.prototype.uploadPost = function (content) {
       owner: owner,
       repo: repo,
       path: filename,
-      sha: existing?.data?.sha,
+      sha: existing?.data?.sha || undefined,
       message: `📦 admin:create-post:upload-post ${filename}`,
       content: Buffer.from(content).toString('base64'),
     })

package/src/manager/helpers/assistant.js

@@ -429,6 +429,9 @@ BackendAssistant.prototype.errorify = function (e, options) {
       sendable = `${sendable} (${newError.tag})`;
     }
 
+    // Clear log prefix before sending
+    self.clearLogPrefix();
+
     // Log
     if (options.log) {
       self.log(`Sending response (${options.code}):`, JSON.stringify(sendable));
@@ -492,12 +495,16 @@ BackendAssistant.prototype.respond = function(response, options) {
   // Send response
   res.status(options.code);
 
+  // Log function
   function _log(text) {
     if (options.log) {
       self.log(`${text} (${options.code}):`, JSON.stringify(response));
     }
   }
 
+  // Clear log prefix before sending
+  self.clearLogPrefix();
+
   // Redirect
   const isRedirect = isBetween(options.code, 300, 399);
   if (isRedirect) {

package/templates/backend-manager-config.json

@@ -1,36 +1,42 @@
 {
-  "app": {
-    "id": "my-app"
-  },
-  "brand": {
-    "name": "My Brand",
-    "url": "https://example.com",
-    "email": "support@example.com",
-    "wordmark": "https://example.com/wordmark.png",
-    "brandmark": "https://example.com/wordmark.png",
-    "combomark": "https://example.com/combomark.png"
-  },
-  "mailchimp": {
-    "list_id": "36774bf825"
-  },
-  "github": {
-    "user": "username",
-    "repo_website": "https://github.com/username/backend-manager"
-  },
-  "sentry": {
-    "dsn": "https://d965557418748jd749d837asf00552f@o777489.ingest.sentry.io/8789941"
-  },
-  "google_analytics": {
-    "id": "UA-123456789-1",
-    "secret": "ABCx1234567890ABCDEFGH"
-  },
-  "firebaseConfig": {
-    "apiKey": "123-456",
-    "authDomain": "PROJECT-ID.firebaseapp.com",
-    "projectId": "PROJECT-ID",
-    "storageBucket": "PROJECT-ID.appspot.com",
-    "messagingSenderId": "123",
-    "appId": "1:123:web:456",
-    "measurementId": "G-0123456789"
-  }
+  app: {
+    id: 'my-app',
+  },
+  brand: {
+    name: 'My Brand',
+    url: 'https://example.com',
+    email: 'support@example.com',
+    wordmark: 'https://example.com/wordmark.png',
+    brandmark: 'https://example.com/wordmark.png',
+    combomark: 'https://example.com/combomark.png',
+  },
+  mailchimp: {
+    list_id: '36774bf825',
+  },
+  github: {
+    user: 'username',
+    repo_website: 'https://github.com/username/backend-manager',
+  },
+  sentry: {
+    dsn: 'https://d965557418748jd749d837asf00552f@o777489.ingest.sentry.io/8789941',
+  },
+  google_analytics: {
+    id: 'UA-123456789-1',
+    secret: 'ABCx1234567890ABCDEFGH',
+  },
+  firebaseConfig: {
+    apiKey: '123-456',
+    authDomain: 'PROJECT-ID.firebaseapp.com',
+    projectId: 'PROJECT-ID',
+    storageBucket: 'PROJECT-ID.appspot.com',
+    messagingSenderId: '123',
+    appId: '1:123:web:456',
+    measurementId: 'G-0123456789',
+  },
+  ghostii: {
+    articles: 1,
+    sources: [
+      '$app',
+    ]
+  },
 }

package/templates/runtimeconfig.json

@@ -1,12 +1,12 @@
 {
-  "mailchimp": {
-    "key": "da69e4758adb4839201bcda8565782d4-us16"
+  mailchimp: {
+    key: 'da69e4758adb4839201bcda8565782d4-us16',
   },
-  "backend_manager": {
-    "key": "api_254448f1-4738-8884-88f7-8884jdd9cc96",
-    "namespace": "e69776e2-9d14-4486-88d0-aa84426d0882"
+  backend_manager: {
+    key: 'api_254448f1-4738-8884-88f7-8884jdd9cc96',
+    namespace: 'e69776e2-9d14-4486-88d0-aa84426d0882',
+  },
+  github: {
+    key: '7f7f80bafc6689895jf86937fg444f6fd5',
   },
-  "github": {
-    "key": "7f7f80bafc6689895jf86937fg444f6fd5"
-  }
 }