backend-manager 4.0.32 → 4.1.1

package/CHANGELOG.md

@@ -14,7 +14,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
----
+---#
+# [4.1.0] - 2024-12-19
+### Changed
+- Attach `schema` to `bm-properties` response header.
+- `assistant.request.url` is now properly set for all environments (development, production, etc) and works whether called from custom domain or Firebase default function domain.
+
 ## [4.0.0] - 2024-05-08
 ### ⚠️ BREAKING
 - Require Node.js version `18` or higher.

package/package.json

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

package/src/manager/helpers/assistant.js

@@ -113,6 +113,7 @@ BackendAssistant.prototype.init = function (ref, options) {
   self.analytics = null;
   self.usage = null;
   self.settings = null;
+  self.schema = null;
 
   // Set meta
   self.meta = {};
@@ -251,12 +252,6 @@ BackendAssistant.prototype.init = function (ref, options) {
   self.constant.pastTime.timestamp = '1999-01-01T00:00:00Z';
   self.constant.pastTime.timestampUNIX = 915148800;
 
-  // Schema
-  // self.schema = {
-  //   dir: '',
-  //   name: '',
-  // }
-
   // Log options
   if (
     (self.isDevelopment())
@@ -568,9 +563,10 @@ function _attachHeaderProperties(self, options, error) {
     code: options.code,
     tag: self.tag,
     usage: {
-      current: self?.usage?.getUsage() || {},
-      limits: self?.usage?.getLimit() || {},
+      current: self.usage ? self.usage.getUsage() : {},
+      limits: self.usage ? self.usage.getLimit() : {},
     },
+    schema: self.schema || {},
     additional: options.additional || {},
   }
   const req = self.ref.req;
@@ -582,9 +578,10 @@ function _attachHeaderProperties(self, options, error) {
 
     // Add bm-properties to Access-Control-Expose-Headers
     const existingExposed = res.get('Access-Control-Expose-Headers') || '';
-    const newExposed = `${existingExposed}, bm-properties`.replace(/^, /, '');
 
+    // If it does not exist, add it
     if (!existingExposed.match(/bm-properties/i)) {
+      const newExposed = `${existingExposed}, bm-properties`.replace(/^, /, '');
       res.header('Access-Control-Expose-Headers', newExposed);
     }
   }
@@ -722,15 +719,21 @@ BackendAssistant.prototype.resolveAccount = function (user) {
 
 BackendAssistant.prototype.parseRepo = function (repo) {
   let repoSplit = repo.split('/');
+
+  // Remove .git from the end
   for (var i = 0; i < repoSplit.length; i++) {
     repoSplit[i] = repoSplit[i].replace('.git', '');
   }
+
+  // Remove unnecessary parts
   repoSplit = repoSplit.filter(function(value, index, arr){
-      return value !== 'http:' &&
-             value !== 'https:' &&
-             value !== '' &&
-             value !== 'github.com';
+    return value !== 'http:'
+      && value !== 'https:'
+      && value !== ''
+      && value !== 'github.com';
   });
+
+  // Return
   return {
     user: repoSplit[0],
     name: repoSplit[1],

package/src/manager/helpers/middleware.js

@@ -28,6 +28,7 @@ Middleware.prototype.run = function (libPath, options) {
     const assistant = Manager.Assistant({req: req, res: res});
 
     const data = assistant.request.data;
+    const headers = assistant.request.headers;
     const geolocation = assistant.request.geolocation;
     const client = assistant.request.client;
 
@@ -47,6 +48,7 @@ Middleware.prototype.run = function (libPath, options) {
 
     // Log
     assistant.log(`Middleware.process(): Request (${geolocation.ip} @ ${geolocation.country}, ${geolocation.region}, ${geolocation.city})`, JSON.stringify(data));
+    assistant.log(`Middleware.process(): Headers`, JSON.stringify(headers));
 
     // Set paths
     const routesDir = path.resolve(options.routesDir, libPath.replace('.js', ''));
@@ -118,7 +120,7 @@ Middleware.prototype.run = function (libPath, options) {
       }
 
       // Log
-      assistant.log(`Middleware.process(): Resolved settings with schema ${options.schema}`, JSON.stringify(assistant.settings));
+      assistant.log(`Middleware.process(): Resolved settings with schema=${options.schema}`, JSON.stringify(assistant.settings));
     } else {
       assistant.settings = data;
     }

package/src/manager/helpers/settings.js

@@ -47,13 +47,16 @@ Settings.prototype.resolve = function (assistant, schema, settings, options) {
     schema = loadSchema(assistant, schemaPath, settings, options);
   }
 
-  // Resolve settings
-  self.settings = powertools.defaults(settings, schema);
-
   // If schema is not an object, throw an error
   if (!schema || typeof schema !== 'object') {
     throw assistant.errorify(`Invalid schema provided`, {code: 400});
   }
+
+  // Resolve settings
+  self.settings = powertools.defaults(settings, schema);
+  // self.schema = _.merge({}, schema);
+  const resolvedSchema = {};
+
   // console.log('---schema', schema);
   // console.log('---options', options);
   // console.log('---self.settings', self.settings);
@@ -99,8 +102,27 @@ Settings.prototype.resolve = function (assistant, schema, settings, options) {
       assistant.warn(`Replacing ${path}: originalValue=${originalValue}, resolvedValue=${resolvedValue}, replaceValue=${replaceValue}`);
       _.set(self.settings, path, replaceValue);
     }
+
+    // Set defaults
+    // @@@TODO: FINISH THIS
+    // !!! NOT SURE WHAT TO DO FOR DEFAULT SINCE IT CAN BE A FN SOMETIMES ???
+    const resolvedNode = {
+      types: schemaNode.types || [],
+      // value: typeof replaceValue === 'undefined' ? undefined : replaceValue,
+      // default: ???,
+      required: isRequired,
+      available: typeof schemaNode.available === 'undefined' ? true : schemaNode.available,
+      min: typeof schemaNode.min === 'undefined' ? undefined : schemaNode.min,
+      max: typeof schemaNode.max === 'undefined' ? undefined : schemaNode.max,
+    }
+
+    // Update schema
+    _.set(resolvedSchema, path, resolvedNode);
   });
 
+  // Set schema
+  self.schema = resolvedSchema;
+
   // Resolve
   return self.settings;
 };

package/src/manager/helpers/usage.js

@@ -106,26 +106,23 @@ Usage.prototype.init = function (assistant, options) {
     self.log(`Usage.init(): Checking if usage data needs to be fetched (${diff} hours)...`);
 
     // Get app data to get plan limits using cached data if possible
+    assistant.log('*** init() 1 diff', diff);
+    assistant.log('*** init() 2 self.app', self.app);
     if (diff > 1 || options.refetch) {
-      await fetch('https://us-central1-itw-creative-works.cloudfunctions.net/getApp', {
-        method: 'post',
-        response: 'json',
-        body: {
-          id: options.app,
-        },
-      })
-      .then((json) => {
-        // Write data and last fetched to storage
-        self.storage.set(`${self.paths.app}.data`, json).write();
-        self.storage.set(`${self.paths.app}.lastFetched`, new Date().toISOString()).write();
-      })
-      .catch(e => {
-        assistant.errorify(`Usage.init(): Error fetching app data: ${e}`, {code: 500, sentry: true});
-      })
+      await self.getApp(options.app)
+        .then((json) => {
+          // Write data and last fetched to storage
+          self.storage.set(`${self.paths.app}.data`, json).write();
+          self.storage.set(`${self.paths.app}.lastFetched`, new Date().toISOString()).write();
+        })
+        .catch(e => {
+          assistant.errorify(`Usage.init(): Error fetching app data: ${e}`, {code: 500, sentry: true});
+        });
     }
 
     // Get app data
     self.app = self.storage.get(`${self.paths.app}.data`, {}).value();
+    assistant.log('*** init() 3 self.app', self.app);
 
     // Check for app data
     if (!self.app) {
@@ -311,14 +308,17 @@ Usage.prototype.getLimit = function (name) {
 Usage.prototype.update = function () {
   const self = this;
 
+  // Shortcuts
+  const Manager = self.Manager;
+  const assistant = self.assistant;
+
   return new Promise(async function(resolve, reject) {
-    const Manager = self.Manager;
-    const assistant = self.assistant;
+    const { admin } = Manager.libraries;
 
     // Write self.user to firestore or local if no user or if key is set
     if (self.useUnauthenticatedStorage) {
       if (self.options.unauthenticatedMode === 'firestore') {
-        Manager.libraries.admin.firestore().doc(`temporary/${self.key}`)
+        admin.firestore().doc(`temporary/${self.key}`)
           .set({
             usage: self.user.usage,
           }, {merge: true})
@@ -338,7 +338,7 @@ Usage.prototype.update = function () {
         return resolve(self.user.usage);
       }
     } else {
-      Manager.libraries.admin.firestore().doc(`users/${self.user.auth.uid}`)
+      admin.firestore().doc(`users/${self.user.auth.uid}`)
         .set({
           usage: self.user.usage,
         }, {merge: true})
@@ -378,4 +378,53 @@ Usage.prototype.log = function () {
   }
 };
 
+Usage.prototype.getApp = function (id) {
+  const self = this;
+
+  // Shortcuts
+  const Manager = self.Manager;
+  const assistant = self.assistant;
+
+  return new Promise(function(resolve, reject) {
+    const { admin } = Manager.libraries;
+
+    assistant.log('***getApp() 1 Manager.config.app.id', Manager.config.app.id);
+
+    try {
+      // If we're on ITW, we can read directly from Firestore
+      // If we don't do this, calling getApp on ITW will call getApp on ITW again and again
+      if (Manager.config.app.id === 'itw-creative-works') {
+        assistant.log('***getApp() 2');
+        admin.firestore().doc(`apps/${id}`)
+          .get()
+          .then((r) => {
+            const data = r.data();
+
+            // Check for data
+            if (!data) {
+              return reject(new Error('No data found'));
+            }
+
+            // Resolve
+            return resolve(data);
+          })
+          .catch((e) => reject(e));
+      } else {
+        assistant.log('***getApp() 3');
+        fetch('https://us-central1-itw-creative-works.cloudfunctions.net/getApp', {
+          method: 'post',
+          response: 'json',
+          body: {
+            id: id,
+          },
+        })
+        .then((json) => resolve(json))
+        .catch((e) => reject(e));
+      }
+    } catch (e) {
+      return reject(e);
+    }
+  });
+};
+
 module.exports = Usage;