backend-manager 4.1.0 → 4.1.2

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.1.0",
+  "version": "4.1.2",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -50,10 +50,10 @@
     "busboy": "^1.6.0",
     "chalk": "^4.1.2",
     "cors": "^2.8.5",
-    "dotenv": "^16.4.5",
-    "express": "^4.21.1",
+    "dotenv": "^16.4.7",
+    "express": "^4.21.2",
     "firebase-admin": "^12.7.0",
-    "firebase-functions": "^6.1.1",
+    "firebase-functions": "^6.1.2",
     "fs-jetpack": "^5.1.0",
     "glob": "^11.0.0",
     "hcaptcha": "^0.1.1",
@@ -67,7 +67,7 @@
     "mime-types": "^2.1.35",
     "mocha": "^8.4.0",
     "moment": "^2.30.1",
-    "nanoid": "^3.3.7",
+    "nanoid": "^3.3.8",
     "node-fetch": "^2.7.0",
     "node-powertools": "^1.7.0",
     "npm-api": "^1.0.1",
@@ -80,7 +80,7 @@
     "uid-generator": "^2.0.0",
     "ultimate-jekyll-poster": "^1.0.2",
     "uuid": "^9.0.1",
-    "wonderful-fetch": "^1.2.2",
+    "wonderful-fetch": "^1.3.0",
     "wonderful-log": "^1.0.7",
     "yaml": "^2.6.1",
     "yargs": "^17.7.2"

package/src/manager/functions/core/actions/api/admin/payment-processor.js

@@ -8,7 +8,7 @@ function Module() {
 Module.prototype.main = function () {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = self.Manager;
   const Api = self.Api;
   const assistant = self.assistant;

package/src/manager/functions/core/actions/api/admin/run-hook.js

@@ -8,7 +8,7 @@ function Module() {
 Module.prototype.main = function () {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = self.Manager;
   const Api = self.Api;
   const assistant = self.assistant;
@@ -55,7 +55,7 @@ Module.prototype.main = function () {
 Module.prototype.loadHook = function () {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = self.Manager;
   const assistant = self.assistant;
   const payload = self.payload;

package/src/manager/functions/core/actions/api/user/validate-settings.js

@@ -10,7 +10,7 @@ function Module() {
 Module.prototype.main = function () {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = self.Manager;
   const Api = self.Api;
   const assistant = self.assistant;

package/src/manager/functions/core/actions/api.js

@@ -331,7 +331,7 @@ function resolveBasePath(basePath, command) {
 Module.prototype.resolveApiPath = function (command) {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = self.Manager;
   const libraries = self.libraries;
   const assistant = self.assistant;

package/src/manager/helpers/middleware.js

@@ -18,7 +18,7 @@ function Middleware(m, req, res) {
 Middleware.prototype.run = function (libPath, options) {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = self.Manager;
   const req = self.req;
   const res = self.res;
@@ -27,11 +27,17 @@ Middleware.prototype.run = function (libPath, options) {
   return cors(req, res, async () => {
     const assistant = Manager.Assistant({req: req, res: res});
 
+    // Set properties
     const data = assistant.request.data;
     const headers = assistant.request.headers;
+    const method = assistant.request.method;
+    const url = assistant.request.url;
     const geolocation = assistant.request.geolocation;
     const client = assistant.request.client;
 
+    // Strip URL
+    const strippedUrl = stripUrl(url);
+
     // Set options
     options = options || {};
     options.authenticate = typeof options.authenticate === 'boolean' ? options.authenticate : true;
@@ -47,7 +53,7 @@ Middleware.prototype.run = function (libPath, options) {
     options.schemasDir = typeof options.schemasDir === 'undefined' ? `${Manager.cwd}/schemas` : options.schemasDir;
 
     // Log
-    assistant.log(`Middleware.process(): Request (${geolocation.ip} @ ${geolocation.country}, ${geolocation.region}, ${geolocation.city})`, JSON.stringify(data));
+    assistant.log(`Middleware.process(): Request (${geolocation.ip} @ ${geolocation.country}, ${geolocation.region}, ${geolocation.city}) [${method} > ${strippedUrl}]`, JSON.stringify(data));
     assistant.log(`Middleware.process(): Headers`, JSON.stringify(headers));
 
     // Set paths
@@ -62,6 +68,7 @@ Middleware.prototype.run = function (libPath, options) {
     }
 
     // Load library
+    // TODO: Support for methods, so first check for method specific file then fallback to index.js
     let library;
     try {
       libPath = path.resolve(routesDir, `index.js`);
@@ -153,4 +160,10 @@ function clean(obj) {
   }
 }
 
+function stripUrl(url) {
+  const newUrl = new URL(url);
+
+  return `${newUrl.hostname}${newUrl.pathname}`.replace(/\/$/, '');
+}
+
 module.exports = Middleware;

package/src/manager/helpers/usage.js

@@ -107,21 +107,15 @@ Usage.prototype.init = function (assistant, options) {
 
     // Get app data to get plan limits using cached data if possible
     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
@@ -311,14 +305,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 +335,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 +375,49 @@ 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;
+
+    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') {
+        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 {
+        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;

package/src/manager/routes/restart/index.js

@@ -7,7 +7,7 @@ function Route() {
 Route.prototype.main = async function (assistant) {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = assistant.Manager;
   const usage = assistant.usage;
   const user = assistant.usage.user;

package/src/manager/routes/test/index.js

@@ -7,7 +7,7 @@ function Route() {
 Route.prototype.main = async function (assistant) {
   const self = this;
 
-  // Set shortcuts
+  // Shortcuts
   const Manager = assistant.Manager;
   const usage = assistant.usage;
   const user = assistant.usage.user;