backend-manager 3.1.0 → 3.1.2

package/CHANGELOG.md

@@ -15,6 +15,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - `Security` in case of vulnerabilities.
 
 ---
+## [3.1.0] - 2023-12-19
+### Added
+- Added `.analytics()` API GA4 support.
+
+#### New Analytics Format
+```js
+  analytics.send({
+    name: 'tutorial_begin',
+    params: {
+      tutorial_id: 'tutorial_1',
+      tutorial_name: 'the_beginning',
+      tutorial_step: 1,
+    },
+  });
+```
+- Added `.usage()` API to track user usage.
+- Added `.middleware()` API to help setup http functions.
+- Added `.respond()` function to `assistant.js` to help with http responses.
+
 ## [3.0.0] - 2023-09-05
 ### ⚠️ BREAKING
 - Updated `firebase-admin` from `9.12.0` --> `11.10.1`
@@ -30,6 +49,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Removed `backend-assistant` dependency and moved to custom library within this module at `./src/manager/helpers/assistant.js`
 - Replaced `require('firebase-functions/lib/logger/compat')` with the updated `require('firebase-functions/logger/compat')`
 - Changed default for `options.setupFunctionsLegacy` from `true` --> `false`
+- `.analytics()` is broken due to GA4 updates and should not be used until the next feature release
 - Updated geolocation and client data retrieval to new format:
 #### New Way
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -69,4 +69,4 @@
     "wonderful-log": "^1.0.5",
     "yargs": "^17.7.2"
   }
-}
+}

package/src/manager/helpers/assistant.js

@@ -283,7 +283,7 @@ BackendAssistant.prototype.emergency = function () {
   self.log.apply(self, args);
 };
 
-BackendAssistant.prototype._log = function() {
+BackendAssistant.prototype._log = function () {
   const self = this;
 
   // 1. Convert args to a normal array
@@ -344,7 +344,7 @@ BackendAssistant.prototype._log = function() {
   }
 }
 
-BackendAssistant.prototype.errorManager = function(e, options) {
+BackendAssistant.prototype.errorManager = function (e, options) {
   const self = this;
 
   // Set options
@@ -361,6 +361,9 @@ BackendAssistant.prototype.errorManager = function(e, options) {
   options.send = typeof options.send === 'undefined'
     ? true
     : options.send;
+  options.stack = typeof options.stack === 'undefined'
+    ? true
+    : options.stack;
 
   // Construct error
   const newError = e instanceof Error
@@ -390,12 +393,15 @@ BackendAssistant.prototype.errorManager = function(e, options) {
 
   // Quit and respond to the request
   if (options.send && self.ref.res && self.ref.res.status) {
+    const sendable = newError?.stack && options.stack
+      ? newError?.stack
+      : newError?.message;
+
     self.ref.res
       .status(options.code)
       .send((
-        newError?.message
-          // ? newError.stack
-          ? newError.message
+        sendable
+          ? sendable
           : newError
       ) || 'Unknown error');
   }
@@ -419,6 +425,14 @@ BackendAssistant.prototype.respond = function(response, options) {
     ? true
     : options.log;
 
+  // Handle error
+  if (
+    response instanceof Error
+    || (options.code >= 400 && options.code <= 599)
+  ) {
+    return self.errorify(response, options);
+  }
+
   // Attach properties
   _attachHeaderProperties(self, options);
 

package/src/manager/helpers/middleware.js

@@ -54,7 +54,7 @@ Middleware.prototype.run = function (library, req, res, options) {
 
     // Process
     try {
-      library.main(assistant, req, res)
+      library.main(assistant)
       // .then(result => {
       //   return res.status(200).json(result);
       // })

package/src/manager/index.js

@@ -198,8 +198,8 @@ Manager.prototype.init = function (exporter, options) {
     exporter.bm_api =
     self.libraries.functions
     .runWith({memory: '256MB', timeoutSeconds: 60})
-    .https
-    .onRequest(async (req, res) => {
+    // TODO: Replace this with new API
+    .https.onRequest(async (req, res) => {
       return self._process((new (require(`${core}/actions/api.js`))()).init(self, { req: req, res: res, }))
     });