backend-manager 3.2.113 → 3.2.115

package/package.json

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

package/src/manager/functions/core/cron/daily/reset-usage.js

@@ -1,31 +1,20 @@
-const _ = require('lodash');
+// Libraries
 const fetch = require('wonderful-fetch');
 
 function Module() {
 
 }
 
-Module.prototype.init = function (Manager, data) {
+Module.prototype.main = function (assistant, context) {
   const self = this;
-  self.Manager = Manager;
 
-  self.libraries = Manager.libraries;
-  self.assistant = Manager.Assistant();
-
-  self.storage = Manager.storage({name: 'usage', temporary: true, clear: false, log: false});
-
-  self.context = data.context;
-  return self;
-}
-
-Module.prototype.main = function() {
-  const self = this;
-  const Manager = self.Manager;
-  const libraries = self.libraries;
-  const assistant = self.assistant;
-  const context = self.context;
+  // Shortcuts
+  const Manager = assistant.Manager;
+  const libraries = Manager.libraries;
 
   return new Promise(async function(resolve, reject) {
+    self.storage = Manager.storage({name: 'usage', temporary: true, clear: false, log: false});
+
     assistant.log(`cron/daily/reset-usage(): Starting main...`);
 
     // Clear local
@@ -40,6 +29,8 @@ Module.prototype.main = function() {
 
 Module.prototype.clearLocal = function() {
   const self = this;
+
+  // Shortcuts
   const Manager = self.Manager;
   const libraries = self.libraries;
   const assistant = self.assistant;
@@ -127,7 +118,7 @@ Module.prototype.clearFirestore = function() {
             data.usage[metric].total = data.usage[metric].total || 0;
             data.usage[metric].last = data.usage[metric].last || {};
 
-            // Bail if its 0
+            // Yeet if its 0
             if (data.usage[metric].period <= 0) {
               continue;
             }

package/src/manager/functions/core/cron/daily.js

@@ -8,6 +8,7 @@ function Module() {
 Module.prototype.init = function (Manager, data) {
   const self = this;
 
+  // Shortcuts
   self.Manager = Manager;
   self.libraries = Manager.libraries;
   self.assistant = Manager.Assistant();
@@ -19,42 +20,88 @@ Module.prototype.init = function (Manager, data) {
 
 Module.prototype.main = function() {
   const self = this;
+
+  // Shortcuts
   const Manager = self.Manager;
   const libraries = self.libraries;
   const assistant = self.assistant;
   const context = self.context;
 
   return new Promise(async function(resolve, reject) {
-    assistant.log(`cron/daily(): Starting...`);
+    // Set log prefix
+    assistant.setLogPrefix('cron/daily()');
+
+    // Log
+    assistant.log(`Starting...`);
+
+    // Setup error
+    let error;
+
+    // Load BEM jobs
+    await loadAndExecuteJobs(`${__dirname}/daily`, Manager, context).catch((e) => error = e);
+
+    // Load custom jobs
+    await loadAndExecuteJobs(`${process.cwd()}/hooks/cron/daily`, Manager, context).catch((e) => error = e);
+
+    // If there was an error, reject
+    if (error) {
+      return reject(error);
+    }
+
+    // Return
+    return resolve();
+  });
+}
 
-    const jobsPath = `${__dirname}/daily`;
-    const jobs = jetpack.list(jobsPath);
+function loadAndExecuteJobs(jobsPath, Manager, context) {
+  const assistant = Manager.assistant;
+
+  return new Promise(async function(resolve, reject) {
+    const jobs = jetpack.list(jobsPath) || [];
     let caught;
 
-    // For of loop for jobs, load the job, execute it, and log the result
+    // Log
+    assistant.log(`Located ${jobs.length} jobs @ ${jobsPath}...`);
+
     for (let i = 0; i < jobs.length; i++) {
+      // Create new assistant for each job
+      const assistant = Manager.Assistant();
+
+      // Load job
       const job = jobs[i];
       const jobName = job.replace('.js', '');
 
+      // Set log prefix
+      assistant.setLogPrefix(`cron/daily/${jobName}()`);
+
       // Log
-      assistant.log(`cron/daily(): Job ${jobName} starting...`);
+      assistant.log(`Starting...`);
 
-      // Load the job
+      // Load job
       const Job = require(`${jobsPath}/${job}`);
       const jobInstance = new Job();
-      jobInstance.init(Manager, { context: context, });
-
-      // Execute the job
-      await jobInstance.main()
-      .then(res => {
-        assistant.log(`cron/daily(): Job ${jobName} completed...`);
-      })
-      .catch(e => {
-        assistant.errorify(`Error executing ${jobName}: ${e}`, {code: 500, sentry: true});
-        caught = e;
-      })
+
+      // Setup
+      jobInstance.Manager = Manager;
+      jobInstance.assistant = assistant;
+      jobInstance.context = context;
+      jobInstance.libraries = Manager.libraries;
+
+      // Execute job
+      await jobInstance.main(assistant, context)
+        .then(res => {
+          assistant.log(`Completed!`);
+        })
+        .catch(e => {
+          assistant.errorify(`Error executing: ${e}`, {
+            code: 500,
+            sentry: true
+          });
+          caught = e;
+        })
     }
 
+    // If there was an error, reject
     if (caught) {
       return reject(caught);
     }

package/src/manager/helpers/assistant.js

@@ -81,6 +81,9 @@ BackendAssistant.prototype.init = function (ref, options) {
   // Set tag
   self.tag = `${self.meta.name}/${self.id}`;
 
+  // Set logger prefix
+  self.logPrefix = '';
+
   // Set stuff about request
   self.request = {};
   self.request.referrer = (self.ref.req.headers || {}).referrer || (self.ref.req.headers || {}).referer || '';
@@ -136,8 +139,16 @@ BackendAssistant.prototype.init = function (ref, options) {
     https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-CH-UA
   */
 
-  self.request.type = (self.ref.req.xhr || _.get(self.ref.req, 'headers.accept', '').indexOf('json') > -1) || (_.get(self.ref.req, 'headers.content-type', '').indexOf('json') > -1) ? 'ajax' : 'form';
-  self.request.path = (self.ref.req.path || '');
+  // Set request type
+  if (
+    self.ref.req.xhr || (self.ref.req?.headers?.accept || '').includes('json')
+    || (self.ref.req?.headers?.['content-type'] || '').includes('json')
+  ) {
+    self.request.type = 'ajax';
+  } else {
+    self.request.type = 'form';
+  }
+  self.request.path = self.ref.req.path || '';
   self.request.user = self.resolveAccount({authenticated: false});
 
   // Set body and query
@@ -255,8 +266,15 @@ BackendAssistant.prototype._log = function () {
   // 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()}]:`);
+  logs.unshift(
+    `[${self.tag} @ ${new Date().toISOString()}]${prefix}`
+  );
 
   // 3. Pass along arguments to console.log
   if (logs[1] === 'error') {
@@ -309,6 +327,30 @@ BackendAssistant.prototype._log = function () {
   }
 }
 
+BackendAssistant.prototype.setLogPrefix = function (s) {
+  const self = this;
+
+  // Set logger prefix
+  self.logPrefix = s
+
+  return self;
+};
+
+BackendAssistant.prototype.clearLogPrefix = function () {
+  const self = this;
+
+  // Set logger prefix
+  self.logPrefix = '';
+
+  return self;
+};
+
+BackendAssistant.prototype.getLogPrefix = function () {
+  const self = this;
+
+  return self.logPrefix;
+};
+
 BackendAssistant.prototype.getUser = function () {
   const self = this;
 
@@ -568,8 +610,8 @@ BackendAssistant.prototype.authenticate = async function (options) {
     // Check with custom BEM Token
     let storedApiKey;
     try {
-      const workingConfig = _.get(self.Manager, 'config') || functions.config();
-      storedApiKey = _.get(workingConfig, 'backend_manager.key', '')
+      const workingConfig = self.Manager?.config || functions.config();
+      const storedApiKey = workingConfig?.backend_manager?.key || '';
     } catch (e) {
 
     }
@@ -841,13 +883,18 @@ BackendAssistant.prototype.parseMultipartFormData = function (options) {
       return reject(new Error('Cannot run .parseMultipartForm() until .init() has been called'));
     }
     const existingData = self.request.multipartData;
-    // console.log('-----existingData', existingData, Object.keys(_.get(existingData, 'fields', {})).length, Object.keys(_.get(existingData, 'files', {})).length);
-    if (Object.keys(_.get(existingData, 'fields', {})).length + Object.keys(_.get(existingData, 'files', {})).length > 0) {
+    const getFields = existingData?.fields || {};
+    const getFiles = existingData?.files || {};
+
+    // If there are already fields or files, return them
+    if (Object.keys(getFields).length + Object.keys(getFiles).length > 0) {
       return resolve(existingData);
     }
 
+    // Set options
     options = options || {};
 
+    // Set headers
     const fs = require('fs');
     const req = self.ref.req;
     const res = self.ref.res;

package/src/manager/index.js

@@ -50,6 +50,7 @@ Manager.prototype.init = function (exporter, options) {
   options.setupFunctions = typeof options.setupFunctions === 'undefined' ? true : options.setupFunctions;
   options.setupFunctionsLegacy = typeof options.setupFunctionsLegacy === 'undefined' ? false : options.setupFunctionsLegacy;
   options.setupFunctionsIdentity = typeof options.setupFunctionsIdentity === 'undefined' ? true : options.setupFunctionsIdentity;
+  options.setupServer = typeof options.setupServer === 'undefined' ? true : options.setupServer;
   options.initializeLocalStorage = typeof options.initializeLocalStorage === 'undefined' ? false : options.initializeLocalStorage;
   options.resourceZone = typeof options.resourceZone === 'undefined' ? 'us-central1' : options.resourceZone;
   options.sentry = typeof options.sentry === 'undefined' ? true : options.sentry;
@@ -67,7 +68,7 @@ Manager.prototype.init = function (exporter, options) {
   // Load libraries
   self.libraries = {
     // Third-party
-    functions: require('firebase-functions'),
+    functions: options.projectType === 'firebase' ? require('firebase-functions') : null,
     admin: require('firebase-admin'),
     cors: require('cors')({ origin: true }),
     sentry: null,
@@ -92,7 +93,7 @@ Manager.prototype.init = function (exporter, options) {
   self.package = resolveProjectPackage();
   self.config = merge(
     requireJSON5(self.project.backendManagerConfigPath),
-    self.libraries.functions.config()
+    self.libraries.functions ? self.libraries.functions.config() : {}
   );
 
   // Saved config
@@ -224,7 +225,7 @@ Manager.prototype.init = function (exporter, options) {
   }
 
   // Setup custom server
-  if (options.projectType === 'custom') {
+  if (options.projectType === 'custom' && options.setupServer) {
     self.setupCustomServer(exporter, options);
   }
 
@@ -356,8 +357,12 @@ Manager.prototype._preProcess = function (mod) {
 
 Manager.prototype.Assistant = function(ref, options) {
   const self = this;
+
+  // Set options defaults
   ref = ref || {};
   options = options || {};
+
+  // Create assistant instance
   return (new self.libraries.Assistant()).init({
     req: ref.req,
     res: ref.res,
@@ -365,26 +370,6 @@ Manager.prototype.Assistant = function(ref, options) {
     functions: self.libraries.functions,
     Manager: self,
   }, options)
-  // return (new self.libraries.Assistant()).init({
-  //   req: ref.req,
-  //   res: ref.res,
-  //   admin: self.libraries.admin,
-  //   functions: self.libraries.functions,
-  //   Manager: self,
-  // }, {
-  //   accept: options.accept,
-  //   functionName: options.functionName,
-  //   functionType: options.functionType,
-  // })
-  // self._inner.ip = (!self._inner.ip || self._inner.ip === '127.0.0.1') ? ass.request.ip : self._inner.ip;
-  // self._inner.country = self._inner.country || ass.request.country;
-  // self._inner.referrer = self._inner.referrer || ass.request.referrer;
-  // self._inner.userAgent = (!self._inner.userAgent || self._inner.userAgent === 'empty') ? ass.request.userAgent : self._inner.userAgent;
-  // self._inner.name = self._inner.name || ass.meta.name;
-  // if (ref.req) {
-  //   console.log('ref.req.headers', ref.req.headers);
-  // }
-  // console.log('self._inner', self._inner);
 };
 
 Manager.prototype.User = function () {
@@ -826,7 +811,7 @@ Manager.prototype.setupFunctions = function (exporter, options) {
   // Setup cron jobs
   exporter.bm_cronDaily =
   self.libraries.functions
-  .runWith({ memory: '256MB', timeoutSeconds: 120 })
+  .runWith({ memory: '256MB', timeoutSeconds: 190 })
   .pubsub.schedule('every 24 hours')
   .onRun(async (context) => self._process((new (require(`${core}/cron/daily.js`))()).init(self, { context: context, })));
 };