backend-manager 4.0.15 → 4.0.17

package/package.json

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

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

@@ -355,6 +355,11 @@ Module.prototype.uploadPost = function (content) {
       return reject(existing);
     }
 
+    // We have to arbitrarily wait for a bit to ensure the images have started the GitHub build action
+    // Otherwise, the GH action might say: "Canceling since a higher priority waiting request for 'refs/heads/master' exists"
+    // The result of this is that the file will be comitted in the repo but not included in the public build
+    await powertools.wait(30000);
+
     // Upload post
     await self.octokit.rest.repos.createOrUpdateFileContents({
       owner: owner,

package/src/manager/helpers/assistant.js

@@ -562,15 +562,22 @@ function _attachHeaderProperties(self, options, error) {
 BackendAssistant.prototype.authenticate = async function (options) {
   const self = this;
 
+  // Shortcuts
   let admin = self.ref.admin;
   let functions = self.ref.functions;
   let req = self.ref.req;
   let res = self.ref.res;
   let data = self.request.data;
+
+  // Build the ID token from the request
   let idToken;
+  let backendManagerKey;
+  // let user;
 
+  // Set options
   options = options || {};
   options.resolve = typeof options.resolve === 'undefined' ? true : options.resolve;
+  options.debug = typeof options.debug === 'undefined' ? false : options.debug;
 
   function _resolve(user) {
     user = user || {};
@@ -586,51 +593,89 @@ BackendAssistant.prototype.authenticate = async function (options) {
     }
   }
 
+  // Extract the BEM token
+  // Having this is separate from the ID token allows for the user to be authenticated as an ADMIN
+  if (options.backendManagerKey || data.backendManagerKey) {
+    // Read token from backendManagerKey or authenticationToken or apiKey
+    backendManagerKey = options.backendManagerKey || data.backendManagerKey;
+
+    // Log the token
+    self.log('Found "backendManagerKey" parameter', backendManagerKey);
+  }
+
+  // Extract the token / API key
+  // This is the main token that will be used to authenticate the user (it can be a JWT or a user's API key)
   if (req?.headers?.authorization && req?.headers?.authorization?.startsWith('Bearer ')) {
     // Read the ID Token from the Authorization header.
     idToken = req.headers.authorization.split('Bearer ')[1];
+
+    // Log the token
     self.log('Found "Authorization" header', idToken);
   } else if (req?.cookies?.__session) {
     // Read the ID Token from cookie.
     idToken = req.cookies.__session;
+
+    // Log the token
     self.log('Found "__session" cookie', idToken);
-  } else if (data.backendManagerKey || data.authenticationToken) {
-    // Check with custom BEM Token
-    let storedApiKey;
+  } else if (
+    options.authenticationToken || data.authenticationToken
+    || options.apiKey || data.apiKey
+  ) {
+    // Read token OR API Key from options or data
+    idToken = options.authenticationToken || data.authenticationToken
+    || options.apiKey || data.apiKey;
+
+    // Log the token
+    self.log('Found "authenticationToken" parameter', idToken);
+  } else {
+    // No token found
+    return _resolve(self.request.user);
+  }
+
+  // Check if the token is a JWT
+  if (isJWT(idToken)) {
+    // Check with firebase
     try {
-      // Disabled this 5/11/24 because i dont know why we would need to do functions.config() if we already have the Manager
-      // const workingConfig = self.Manager?.config || functions.config();
-      storedApiKey = self.Manager?.config?.backend_manager?.key || '';
-    } catch (e) {
-      // Do nothing
-    }
+      const decodedIdToken = await admin.auth().verifyIdToken(idToken);
 
-    // Set idToken as working token of either backendManagerKey or authenticationToken
-    idToken = data.backendManagerKey || data.authenticationToken;
+      // Log the token
+      if (options.debug) {
+        self.log('JWT token decoded', decodedIdToken.email, decodedIdToken.user_id);
+      }
 
-    // Log the token
-    self.log('Found "backendManagerKey" or "authenticationToken" parameter', {storedApiKey: storedApiKey, idToken: idToken});
+      // Get the user
+      await admin.firestore().doc(`users/${decodedIdToken.user_id}`)
+      .get()
+      .then((doc) => {
+        // Set the user
+        if (doc.exists) {
+          self.request.user = Object.assign({}, self.request.user, doc.data());
+          self.request.user.authenticated = true;
+          self.request.user.auth.uid = decodedIdToken.user_id;
+          self.request.user.auth.email = decodedIdToken.email;
+        }
+
+        // Log the user
+        if (options.debug) {
+          self.log('Found user doc', self.request.user)
+        }
+      })
 
-    // Check if the token is correct
-    if (storedApiKey && (storedApiKey === data.backendManagerKey || storedApiKey === data.authenticationToken)) {
-      self.request.user.authenticated = true;
-      self.request.user.roles.admin = true;
+      // Return the user
       return _resolve(self.request.user);
-    }
-  } else if (options.apiKey || data.apiKey) {
-    const apiKey = options.apiKey || data.apiKey;
-    self.log('Found "options.apiKey"', apiKey);
-
-    if (apiKey.includes('test')) {
+    } catch (error) {
+      self.error('Error while verifying JWT:', error);
       return _resolve(self.request.user);
     }
-
+  } else {
+    // Query by API key
     await admin.firestore().collection(`users`)
       .where('api.privateKey', '==', apiKey)
       .get()
       .then(function(querySnapshot) {
         querySnapshot.forEach(function(doc) {
           self.request.user = doc.data();
+          self.request.user = Object.assign({}, self.request.user, doc.data());
           self.request.user.authenticated = true;
         });
       })
@@ -639,39 +684,6 @@ BackendAssistant.prototype.authenticate = async function (options) {
       });
 
     return _resolve(self.request.user);
-  } else {
-    // self.log('No Firebase ID token was able to be extracted.',
-    //   'Make sure you authenticate your request by providing either the following HTTP header:',
-    //   'Authorization: Bearer <Firebase ID Token>',
-    //   'or by passing a "__session" cookie',
-    //   'or by passing backendManagerKey or authenticationToken in the body or query');
-
-    return _resolve(self.request.user);
-  }
-
-  // Check with firebase
-  try {
-    const decodedIdToken = await admin.auth().verifyIdToken(idToken);
-    if (options.debug) {
-      self.log('Token correctly decoded', decodedIdToken.email, decodedIdToken.user_id);
-    }
-    await admin.firestore().doc(`users/${decodedIdToken.user_id}`)
-    .get()
-    .then(async function (doc) {
-      if (doc.exists) {
-        self.request.user = Object.assign({}, self.request.user, doc.data());
-      }
-      self.request.user.authenticated = true;
-      self.request.user.auth.uid = decodedIdToken.user_id;
-      self.request.user.auth.email = decodedIdToken.email;
-      if (options.debug) {
-        self.log('Found user doc', self.request.user)
-      }
-    })
-    return _resolve(self.request.user);
-  } catch (error) {
-    self.error('Error while verifying Firebase ID token:', error);
-    return _resolve(self.request.user);
   }
 };
 
@@ -992,6 +1004,21 @@ BackendAssistant.prototype.parseMultipartFormData = function (options) {
   });
 }
 
+const isJWT = (token) => {
+  // Ensure the token has three parts separated by dots
+  const parts = token.split('.');
+
+  try {
+    // Decode the header (first part) to verify it is JSON
+    const header = JSON.parse(Buffer.from(parts[0], 'base64').toString('utf8'));
+    // Check for expected JWT keys in the header
+    return header.alg && header.typ === 'JWT';
+  } catch (err) {
+    // If parsing fails, it's not a valid JWT
+    return false;
+  }
+};
+
 // Not sure what this is for? But it has a good serializer code
 // Disabled 2024-03-21 because there was another stringify() function that i was intending to use but it was actually using this
 // It was adding escaped quotes to strings

package/src/manager/helpers/{assistant2.js → assistantORIG.js}

@@ -562,22 +562,15 @@ function _attachHeaderProperties(self, options, error) {
 BackendAssistant.prototype.authenticate = async function (options) {
   const self = this;
 
-  // Shortcuts
   let admin = self.ref.admin;
   let functions = self.ref.functions;
   let req = self.ref.req;
   let res = self.ref.res;
   let data = self.request.data;
-
-  // Build the ID token from the request
   let idToken;
-  let backendManagerKey;
-  // let user;
 
-  // Set options
   options = options || {};
   options.resolve = typeof options.resolve === 'undefined' ? true : options.resolve;
-  options.debug = typeof options.debug === 'undefined' ? false : options.debug;
 
   function _resolve(user) {
     user = user || {};
@@ -593,89 +586,51 @@ BackendAssistant.prototype.authenticate = async function (options) {
     }
   }
 
-  // Extract the BEM token
-  // Having this is separate from the ID token allows for the user to be authenticated as an ADMIN
-  if (options.backendManagerKey || data.backendManagerKey) {
-    // Read token from backendManagerKey or authenticationToken or apiKey
-    backendManagerKey = options.backendManagerKey || data.backendManagerKey;
-
-    // Log the token
-    self.log('Found "backendManagerKey" parameter', backendManagerKey);
-  }
-
-  // Extract the token / API key
-  // This is the main token that will be used to authenticate the user (it can be a JWT or a user's API key)
   if (req?.headers?.authorization && req?.headers?.authorization?.startsWith('Bearer ')) {
     // Read the ID Token from the Authorization header.
     idToken = req.headers.authorization.split('Bearer ')[1];
-
-    // Log the token
     self.log('Found "Authorization" header', idToken);
   } else if (req?.cookies?.__session) {
     // Read the ID Token from cookie.
     idToken = req.cookies.__session;
-
-    // Log the token
     self.log('Found "__session" cookie', idToken);
-  } else if (
-    options.authenticationToken || data.authenticationToken
-    || options.apiKey || data.apiKey
-  ) {
-    // Read token OR API Key from options or data
-    idToken = options.authenticationToken || data.authenticationToken
-    || options.apiKey || data.apiKey;
-
-    // Log the token
-    self.log('Found "authenticationToken" parameter', idToken);
-  } else {
-    // No token found
-    return _resolve(self.request.user);
-  }
-
-  // Check if the token is a JWT
-  if (isJWT(idToken)) {
-    // Check with firebase
+  } else if (data.backendManagerKey || data.authenticationToken) {
+    // Check with custom BEM Token
+    let storedApiKey;
     try {
-      const decodedIdToken = await admin.auth().verifyIdToken(idToken);
+      // Disabled this 5/11/24 because i dont know why we would need to do functions.config() if we already have the Manager
+      // const workingConfig = self.Manager?.config || functions.config();
+      storedApiKey = self.Manager?.config?.backend_manager?.key || '';
+    } catch (e) {
+      // Do nothing
+    }
 
-      // Log the token
-      if (options.debug) {
-        self.log('JWT token decoded', decodedIdToken.email, decodedIdToken.user_id);
-      }
+    // Set idToken as working token of either backendManagerKey or authenticationToken
+    idToken = data.backendManagerKey || data.authenticationToken;
 
-      // Get the user
-      await admin.firestore().doc(`users/${decodedIdToken.user_id}`)
-      .get()
-      .then((doc) => {
-        // Set the user
-        if (doc.exists) {
-          self.request.user = Object.assign({}, self.request.user, doc.data());
-          self.request.user.authenticated = true;
-          self.request.user.auth.uid = decodedIdToken.user_id;
-          self.request.user.auth.email = decodedIdToken.email;
-        }
-
-        // Log the user
-        if (options.debug) {
-          self.log('Found user doc', self.request.user)
-        }
-      })
+    // Log the token
+    self.log('Found "backendManagerKey" or "authenticationToken" parameter', {storedApiKey: storedApiKey, idToken: idToken});
 
-      // Return the user
+    // Check if the token is correct
+    if (storedApiKey && (storedApiKey === data.backendManagerKey || storedApiKey === data.authenticationToken)) {
+      self.request.user.authenticated = true;
+      self.request.user.roles.admin = true;
       return _resolve(self.request.user);
-    } catch (error) {
-      self.error('Error while verifying JWT:', error);
+    }
+  } else if (options.apiKey || data.apiKey) {
+    const apiKey = options.apiKey || data.apiKey;
+    self.log('Found "options.apiKey"', apiKey);
+
+    if (apiKey.includes('test')) {
       return _resolve(self.request.user);
     }
-  } else {
-    // Query by API key
+
     await admin.firestore().collection(`users`)
       .where('api.privateKey', '==', apiKey)
       .get()
       .then(function(querySnapshot) {
         querySnapshot.forEach(function(doc) {
           self.request.user = doc.data();
-          self.request.user = Object.assign({}, self.request.user, doc.data());
           self.request.user.authenticated = true;
         });
       })
@@ -684,6 +639,39 @@ BackendAssistant.prototype.authenticate = async function (options) {
       });
 
     return _resolve(self.request.user);
+  } else {
+    // self.log('No Firebase ID token was able to be extracted.',
+    //   'Make sure you authenticate your request by providing either the following HTTP header:',
+    //   'Authorization: Bearer <Firebase ID Token>',
+    //   'or by passing a "__session" cookie',
+    //   'or by passing backendManagerKey or authenticationToken in the body or query');
+
+    return _resolve(self.request.user);
+  }
+
+  // Check with firebase
+  try {
+    const decodedIdToken = await admin.auth().verifyIdToken(idToken);
+    if (options.debug) {
+      self.log('Token correctly decoded', decodedIdToken.email, decodedIdToken.user_id);
+    }
+    await admin.firestore().doc(`users/${decodedIdToken.user_id}`)
+    .get()
+    .then(async function (doc) {
+      if (doc.exists) {
+        self.request.user = Object.assign({}, self.request.user, doc.data());
+      }
+      self.request.user.authenticated = true;
+      self.request.user.auth.uid = decodedIdToken.user_id;
+      self.request.user.auth.email = decodedIdToken.email;
+      if (options.debug) {
+        self.log('Found user doc', self.request.user)
+      }
+    })
+    return _resolve(self.request.user);
+  } catch (error) {
+    self.error('Error while verifying Firebase ID token:', error);
+    return _resolve(self.request.user);
   }
 };
 
@@ -1004,21 +992,6 @@ BackendAssistant.prototype.parseMultipartFormData = function (options) {
   });
 }
 
-const isJWT = (token) => {
-  // Ensure the token has three parts separated by dots
-  const parts = token.split('.');
-
-  try {
-    // Decode the header (first part) to verify it is JSON
-    const header = JSON.parse(Buffer.from(parts[0], 'base64').toString('utf8'));
-    // Check for expected JWT keys in the header
-    return header.alg && header.typ === 'JWT';
-  } catch (err) {
-    // If parsing fails, it's not a valid JWT
-    return false;
-  }
-};
-
 // Not sure what this is for? But it has a good serializer code
 // Disabled 2024-03-21 because there was another stringify() function that i was intending to use but it was actually using this
 // It was adding escaped quotes to strings

package/src/manager/helpers/utilities.js

@@ -27,6 +27,7 @@ Utilities.prototype.iterateCollection = function (callback, options) {
     // Set counters
     let batch = -1;
     let collectionCount = 0;
+    let callbackResults = [];
 
     // Set defaults
     options = options || {};
@@ -116,7 +117,7 @@ Utilities.prototype.iterateCollection = function (callback, options) {
 
           // If no documents, resolve
           if (snap.docs.length === 0) {
-            return resolve();
+            return resolve(callbackResults);
           }
 
           // Log
@@ -134,11 +135,14 @@ Utilities.prototype.iterateCollection = function (callback, options) {
             collectionCount,
           )
           .then((r) => {
+            // Append to result
+            callbackResults.push(r);
+
             // Construct a new query starting at this document (unless we've reached the end)
             if (lastVisible && batch + 1 < options.maxBatches) {
               iterate(lastVisible)
             } else {
-              return resolve();
+              return resolve(callbackResults);
             }
           })
           .catch((e) => {
@@ -180,6 +184,7 @@ Utilities.prototype.iterateUsers = function (callback, options) {
 
     // Set counters
     let batch = -1;
+    let callbackResults = [];
 
     // Set defaults
     options = options || {};
@@ -199,7 +204,7 @@ Utilities.prototype.iterateUsers = function (callback, options) {
 
           // If no users, resolve
           if (listUsersResult.users.length === 0) {
-            return resolve();
+            return resolve(callbackResults);
           }
 
           // Log
@@ -213,12 +218,15 @@ Utilities.prototype.iterateUsers = function (callback, options) {
             users: listUsersResult.users,
             pageToken: listUsersResult.pageToken,
           }, batch)
-            .then(r => {
+            .then((r) => {
+              // Append to result
+              callbackResults.push(r);
+
               // Construct a new query starting at this document (unless we've reached the end)
               if (listUsersResult.pageToken && batch + 1 < options.maxBatches) {
                 iterate(listUsersResult.pageToken);
               } else {
-                return resolve();
+                return resolve(callbackResults);
               }
             })
             .catch((e) => {
@@ -279,7 +287,7 @@ Utilities.prototype.getDocumentWithOwnerUser = function (path, options) {
     // Get document
     const document = await admin.firestore().doc(path)
       .get()
-      .then(doc => {
+      .then((doc) => {
         const data = doc.data();
 
         // If the document doesn't exist, throw an error
@@ -308,7 +316,7 @@ Utilities.prototype.getDocumentWithOwnerUser = function (path, options) {
     // Get the owner user
     const user = admin.firestore().doc(`users/${ownerUID}`)
       .get()
-      .then(doc => {
+      .then((doc) => {
         const data = doc.data();
 
         // If the user doesn't exist, throw an error