backend-manager 3.2.115 → 3.2.117

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "3.2.115",
+  "version": "3.2.117",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -45,8 +45,8 @@
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "express": "^4.19.2",
-    "firebase-admin": "^11.11.1",
-    "firebase-functions": "^4.9.0",
+    "firebase-admin": "^12.1.0",
+    "firebase-functions": "^5.0.1",
     "fs-jetpack": "^5.1.0",
     "glob": "^10.3.12",
     "hcaptcha": "^0.1.1",

package/src/manager/helpers/middleware.js

@@ -50,6 +50,11 @@ Middleware.prototype.run = function (libPath, options) {
     const routesDir = path.resolve(options.routesDir, libPath.replace('.js', ''));
     const schemasDir = path.resolve(options.schemasDir);
 
+    // Wakeup trigger (quit immediately if wakeup is true to avoid cold start on a future request)
+    if (data.wakeup) {
+      return assistant.respond({wakeup: true});
+    }
+
     // Load library
     let library;
     try {

package/src/manager/helpers/utilities.js

@@ -18,7 +18,9 @@ Utilities.prototype.iterateCollection = function (callback, options) {
 
   return new Promise(function(resolve, reject) {
     let batch = -1;
+    let collectionCount = 0;
 
+    // Set defaults
     options = options || {};
     options.collection = options.collection || '';
     options.batchSize = options.batchSize || 1000;
@@ -31,21 +33,26 @@ Utilities.prototype.iterateCollection = function (callback, options) {
       : options.prefetchCursor;
     options.log = options.log;
 
+    // List all documents in a collection
     async function listAllDocuments(nextPageToken) {
-      let query = admin.firestore().collection(options.collection)
+      let query = admin.firestore().collection(options.collection);
 
+      // Insert where clauses
       options.where
       .forEach(clause => {
         query = query.where(clause.field, clause.operator, clause.value);
       });
 
+      // Insert orderBy
       if (options.orderBy) {
         query = query.orderBy(options.orderBy);
       }
 
+      // Process the first batch differently
       if (batch === -1) {
         let prefetchedCursor = null;
 
+        // Prefetch the cursor
         if (options.prefetchCursor) {
           prefetchedCursor = await admin.firestore().doc(`${options.collection}/${options.startAt || options.startAfter}`)
           .get()
@@ -56,11 +63,30 @@ Utilities.prototype.iterateCollection = function (callback, options) {
           }
         }
 
+        // Insert startAt or startAfter
         if (options.startAt) {
           query = query.startAt(prefetchedCursor || options.startAt);
         } else if (options.startAfter) {
           query = query.startAfter(prefetchedCursor || options.startAfter);
         }
+
+        // Calculate count
+        const collectionCountResult = await query.count().get()
+        .then((r) => r.data().count)
+        .catch((e) => e);
+
+        // Check for errors
+        if (collectionCountResult instanceof Error) {
+          return reject(collectionCountResult);
+        }
+
+        // Set collection count
+        collectionCount = collectionCountResult;
+
+        // Log
+        if (options.log) {
+          console.log('Total count:', collectionCount);
+        }
       }
 
       // Start at next page
@@ -71,6 +97,7 @@ Utilities.prototype.iterateCollection = function (callback, options) {
       // batchSize
       query = query.limit(options.batchSize);
 
+      // Get
       query.get()
         .then(async (snap) => {
           const lastVisible = snap.docs[snap.docs.length - 1];
@@ -85,22 +112,26 @@ Utilities.prototype.iterateCollection = function (callback, options) {
             console.log('Processing batch:', batch);
           }
 
-          callback({
-            snap: snap,
-            docs: snap.docs.map(x => x),
-          }, batch)
-            .then(r => {
-              // Construct a new query starting at this document
-              if (lastVisible) {
-                listAllDocuments(lastVisible)
-              } else {
-                return resolve();
-              }
-            })
-            .catch((e) => {
-              console.error('Callback failed', e);
-              return reject(e);
-            });
+          callback(
+            {
+              snap: snap,
+              docs: snap.docs.map(x => x),
+            },
+            batch,
+            collectionCount,
+          )
+          .then(r => {
+            // Construct a new query starting at this document
+            if (lastVisible) {
+              listAllDocuments(lastVisible)
+            } else {
+              return resolve();
+            }
+          })
+          .catch((e) => {
+            console.error('Callback failed', e);
+            return reject(e);
+          });
 
         })
         .catch((e) => {
@@ -109,6 +140,7 @@ Utilities.prototype.iterateCollection = function (callback, options) {
         });
     }
 
+    // Run
     listAllDocuments();
   });
 };

package/src/manager/index.js

@@ -68,7 +68,9 @@ Manager.prototype.init = function (exporter, options) {
   // Load libraries
   self.libraries = {
     // Third-party
-    functions: options.projectType === 'firebase' ? require('firebase-functions') : null,
+    functions: options.projectType === 'firebase'
+      ? require('firebase-functions')
+      : null,
     admin: require('firebase-admin'),
     cors: require('cors')({ origin: true }),
     sentry: null,

package/src/manager/libraries/openai copy.js

@@ -1,326 +0,0 @@
-const fetch = require('wonderful-fetch');
-const jetpack = require('fs-jetpack');
-const powertools = require('node-powertools');
-const _ = require('lodash');
-const JSON5 = require('json5');
-
-const TOKEN_COST_TABLE = {
-  // Mar 6th, 2024
-  'gpt-4-turbo-preview': {
-    input: 0.0100,
-    output: 0.0300,
-  },
-  'gpt-4-1106-preview': {
-    input: 0.0100,
-    output: 0.0300,
-  },
-  'gpt-4': {
-    input: 0.0300,
-    output: 0.0600,
-  },
-  'gpt-3.5-turbo': {
-    input: 0.0005,
-    output: 0.0015,
-  },
-
-  // Nov 6th, 2023
-  // 'gpt-4-turbo-preview': {
-  //   input: 0.0100,
-  //   output: 0.0300,
-  // },
-  // 'gpt-4-1106-preview': {
-  //   input: 0.0100,
-  //   output: 0.0300,
-  // },
-  // 'gpt-4': {
-  //   input: 0.0300,
-  //   output: 0.0600,
-  // },
-  // 'gpt-3.5-turbo': {
-  //   input: 0.0010,
-  //   output: 0.0020,
-  // },
-}
-
-function OpenAI(assistant, key) {
-  const self = this;
-
-  self.assistant = assistant;
-  self.Manager = assistant.Manager;
-  self.user = assistant.user;
-  self.key = key;
-
-  self.tokens = {
-    total: {
-      count: 0,
-      price: 0,
-    },
-    input: {
-      count: 0,
-      price: 0,
-    },
-    output: {
-      count: 0,
-      price: 0,
-    },
-  }
-
-  return self;
-}
-
-OpenAI.prototype.request = function (options) {
-  const self = this;
-  const Manager = self.Manager;
-  const assistant = self.assistant;
-
-  return new Promise(async function(resolve, reject) {
-    options = _.merge({}, options);
-
-    options.model = typeof options.model === 'undefined' ? 'gpt-3.5-turbo' : options.model;
-    options.timeout = typeof options.timeout === 'undefined' ? 120000 : options.timeout;
-    options.moderate = typeof options.moderate === 'undefined' ? true : options.moderate;
-    options.log = typeof options.log === 'undefined' ? false : options.log;
-    options.user = options.user || assistant.getUser();
-
-    options.retries = typeof options.retries === 'undefined' ? 0 : options.retries;
-    options.retryTriggers = typeof options.retryTriggers === 'undefined' ? ['network', 'parse'] : options.retryTriggers;
-
-    options.prompt = options.prompt || {};
-    options.prompt.path = options.prompt.path || '';
-    options.prompt.content = options.prompt.content || '';
-    options.prompt.settings = options.prompt.settings || {};
-
-    options.message = options.message || {};
-    options.message.path = options.message.path || '';
-    options.message.content = options.message.content || '';
-    options.message.settings = options.message.settings || {};
-
-    options.history = options.history || {};
-    options.history.messages = options.history.messages || [];
-    options.history.limit = typeof options.history.limit === 'undefined' ? 5 : options.history.limit;
-
-    options.response = typeof options.response === 'undefined' ? undefined : options.response;
-    options.temperature = typeof options.temperature === 'undefined' ? 0.7 : options.temperature;
-    options.maxTokens = typeof options.maxTokens === 'undefined' ? 512 : options.maxTokens;
-
-    let attempt = 0;
-
-    function _log() {
-      if (!options.log)  {
-        return;
-      }
-
-      assistant.log('callOpenAI():', ...arguments);
-    }
-
-    function _load(input) {
-      // console.log('*** input!!!', input.content.slice(0, 50), input.path);
-      // console.log('*** input.content', input.content.slice(0, 50));
-      // console.log('*** input.path', input.path);
-      // _log('Loading', input);
-
-      let content = '';
-
-      // Load content
-      if (input.path) {
-        const exists = jetpack.exists(input.path);
-        if (!exists) {
-          return new Error(`Path ${input.path} not found`);
-        } else if (exists === 'dir') {
-          return new Error(`Path ${input.path} is a directory`);
-        }
-
-        try {
-          content = jetpack.read(input.path);
-        } catch (e) {
-          return new Error(`Error reading file ${input.path}: ${e}`);
-        }
-      } else {
-        content = input.content;
-      }
-
-      return powertools.template(content, input.settings).trim();
-    }
-
-    // Log
-    _log('Starting', self.key, options);
-
-    // Load prompt
-    const prompt = _load(options.prompt);
-    const message = _load(options.message);
-    const user = options.user?.auth?.uid || assistant.request.geolocation.ip;
-    const responseFormat = options.response === 'json' && !options.model.includes('gpt-3.5')
-      ? { type: 'json_object' }
-      : undefined;
-
-    // Log
-    _log('Prompt', prompt);
-    _log('Message', message);
-    _log('User', user);
-
-    // Check for errors
-    if (prompt instanceof Error) {
-      return reject(assistant.errorify(`Error loading prompt: ${prompt}`, {code: 400}));
-    }
-
-    if (message instanceof Error) {
-      return reject(assistant.errorify(`Error loading message: ${message}`, {code: 400}));
-    }
-
-    // Format history
-    options.history.messages.forEach((m) => {
-      m.role = m.role || 'system';
-      m.content = (m.content || '').trim();
-    });
-
-    // Request
-    function _request(mode, options) {
-      return new Promise(async function(resolve, reject) {
-        let resultPath = '';
-        const request = {
-          url: '',
-          method: 'post',
-          response: 'json',
-          // log: true,
-          tries: 1,
-          timeout: options.timeout,
-          headers: {
-            'Authorization': `Bearer ${Manager.config.openai.key}`,
-          },
-          body: {},
-        }
-
-        if (mode === 'chatgpt') {
-          request.url = 'https://api.openai.com/v1/chat/completions';
-          options.history.messages = options.history.messages.slice(-options.history.limit);
-          options.history.messages.unshift({
-            role: 'system',
-            content: prompt,
-          });
-
-          // Set last history item
-          const lastHistory = options.history.messages[options.history.messages.length - 1];
-
-          // If message is different than last message in history, add it
-          if (lastHistory?.content !== message) {
-            options.history.messages.push({
-              role: 'user',
-              content: message,
-            });
-          }
-
-          // Log message
-          _log('Messages', options.history.messages);
-
-          request.body = {
-            model: options.model,
-            response_format: responseFormat,
-            messages: options.history.messages,
-            temperature: options.temperature,
-            max_tokens: options.maxTokens,
-            user: user,
-          }
-          resultPath = 'choices[0].message.content';
-        } else if (mode === 'moderation') {
-          request.url = 'https://api.openai.com/v1/moderations';
-          request.body = {
-            input: message,
-            user: user,
-          }
-          resultPath = 'results[0]';
-        }
-
-        // Request
-        await fetch(request.url, request)
-        .then((r) => {
-          // Set token counts
-          self.tokens.total.count += r?.usage?.total_tokens || 0;
-          self.tokens.input.count += r?.usage?.prompt_tokens || 0;
-          self.tokens.output.count += r?.usage?.completion_tokens || 0;
-
-          // Set token prices
-          self.tokens.total.price = (self.tokens.total.count / 1000) * TOKEN_COST_TABLE[options.model].input;
-          self.tokens.input.price = (self.tokens.input.count / 1000) * TOKEN_COST_TABLE[options.model].input;
-          self.tokens.output.price = (self.tokens.output.count / 1000) * TOKEN_COST_TABLE[options.model].output;
-
-          return resolve(_.get(r, resultPath));
-        })
-        .catch((e) => {
-          return reject(e);
-        })
-      });
-    }
-
-    // Moderate if needed
-    let moderation = null;
-    if (options.moderate) {
-      moderation = await _request('moderation', options)
-      .then(async (r) => {
-        _log('Moderated', r);
-
-        return r;
-      })
-      .catch((e) => e);
-
-      // Check for moderation flag
-      if (moderation.flagged) {
-        return reject(assistant.errorify(`This request is inappropriate`, {code: 451}));
-      }
-    }
-
-    function _attempt() {
-      const retries = options.retries;
-      const triggers = options.retryTriggers;
-
-      // Increment attempt
-      attempt++;
-
-      // Log
-      _log(`Request ${attempt}/${retries}`);
-
-      // Request
-      _request('chatgpt', options)
-      .then((r) => {
-        _log('Response', r);
-
-        // Try to parse JSON response if needed
-        try {
-          const content = options.response === 'json' ? JSON5.parse(r) : r;
-
-          // Return
-          return resolve({
-            content: content,
-            tokens: self.tokens,
-            moderation: moderation,
-          })
-        } catch (e) {
-          assistant.error('Error parsing response', r, e);
-
-          // Retry
-          if (attempt < retries && triggers.includes('parse')) {
-            return _attempt();
-          }
-
-          // Return
-          return reject(e);
-        }
-      })
-      .catch((e) => {
-        assistant.error('Error requesting', e);
-
-        // Retry
-        if (attempt < retries && triggers.includes('network')) {
-          return _attempt();
-        }
-
-        // Return
-        return reject(e);
-      });
-    }
-
-    // Make attempt
-    _attempt();
-  });
-}
-
-module.exports = OpenAI;