backend-manager 2.5.71 → 2.5.73

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "2.5.71",
+  "version": "2.5.73",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -31,7 +31,7 @@
     "@google-cloud/storage": "^5.20.5",
     "@sendgrid/mail": "^7.7.0",
     "@sentry/node": "^6.19.7",
-    "backend-assistant": "^1.0.3",
+    "backend-assistant": "^1.0.4",
     "busboy": "^1.6.0",
     "chalk": "^4.1.2",
     "cors": "^2.8.5",

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

@@ -92,7 +92,8 @@ Module.prototype._setMetaStats = function (error, meta) {
             error: error,
           }
         }
-      }
+      },
+      metadata: Manager.Metadata().set({tag: 'admin:backup'}),
     }, {merge: true})
     .catch(e => {
       assistant.errorManager(e, {code: 500, sentry: false, send: false, log: true});

package/src/manager/functions/core/actions/api/admin/firestore-write.js

@@ -15,6 +15,7 @@ Module.prototype.main = function () {
     payload.data.payload.document = payload.data.payload.document || {};
     payload.data.payload.options = payload.data.payload.options || {};
     payload.data.payload.options.merge = typeof payload.data.payload.options.merge === 'undefined' ? true : payload.data.payload.options.merge;
+    payload.data.payload.options.metadataTag = typeof payload.data.payload.options.metadataTag === 'undefined' ? 'admin:firestore-write' : payload.data.payload.options.metadataTag;
 
     // Perform checks
     if (!payload.user.roles.admin) {
@@ -23,6 +24,12 @@ Module.prototype.main = function () {
       return reject(assistant.errorManager(`Path parameter required.`, {code: 400, sentry: false, send: false, log: false}).error)
     }
 
+    // Set metadata
+    payload.data.payload.document.metadata = Manager.Metadata().set({tag: payload.data.payload.options.metadataTag})
+
+    // Delete metadataTag
+    delete payload.data.payload.options.metadataTag;
+
     // Write to Firestore
     await self.libraries.admin.firestore().doc(payload.data.payload.path)
     .set(payload.data.payload.document, payload.data.payload.options)

package/src/manager/functions/core/actions/api/admin/get-stats.js

@@ -100,7 +100,7 @@ Module.prototype.updateStats = function (existingData) {
       return reject(error);
     }
 
-    // Fetch new stats
+    // Fetch new notification stats
     await self.getAllNotifications()
       .then(r => {
         _.set(update, 'notifications.total', r)
@@ -109,6 +109,7 @@ Module.prototype.updateStats = function (existingData) {
         error = new Error(`Failed getting notifications: ${e}`);
       })
 
+    // Fetch new subscription stats
     await self.getAllSubscriptions()
       .then(r => {
         _.set(update, 'subscriptions', r)
@@ -120,7 +121,8 @@ Module.prototype.updateStats = function (existingData) {
     if (error) {
       return reject(error);
     }
-
+    
+    // Count users online (in old gathering)
     await gatheringOnline
       .once('value')
       .then((snap) => {
@@ -133,6 +135,7 @@ Module.prototype.updateStats = function (existingData) {
         error = new Error(`Failed getting online users: ${e}`);
       })
 
+    // Count users online (in new session)
     await sessionsApp
       .once('value')
       .then((snap) => {
@@ -149,6 +152,10 @@ Module.prototype.updateStats = function (existingData) {
       return reject(error);
     }
 
+    // Set metadata
+    update.metadata = self.Manager.Metadata().set({tag: 'admin:get-stats'})
+
+    // Update stats
     await stats
       .set(update, { merge: true })
       .catch(function (e) {

package/src/manager/functions/core/actions/api/admin/sync-users.js

@@ -72,6 +72,10 @@ Module.prototype.main = function () {
 
                   const finalData = merge(newUser.properties, data);
 
+                  // Set metadata
+                  finalData.metadata = Manager.Metadata().set({tag: 'admin:sync-users'});
+
+                  // Save to database
                   await self.libraries.admin.firestore().doc(`users/${account.uid}`)
                     .set(finalData, {merge: true})
                     .then(r => {

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

@@ -224,24 +224,25 @@ Module.prototype.processState_tokenize = function (newUrl, user) {
     }
 
     const storeResponse = await self.libraries.admin.firestore().doc(`users/${user.auth.uid}`)
-    .set({
-      oauth2: {
-        [payload.data.payload.provider]: {
-          code: _.omit(
-            _.merge({}, payload.data.payload),
-            self.omittedPayloadFields,
-          ),
-          token: tokenizeResponse,
-          identity: verifiedIdentity,
-          updated: {
-            timestamp: assistant.meta.startTime.timestamp,
-            timestampUNIX: assistant.meta.startTime.timestampUNIX,
+      .set({
+        oauth2: {
+          [payload.data.payload.provider]: {
+            code: _.omit(
+              _.merge({}, payload.data.payload),
+              self.omittedPayloadFields,
+            ),
+            token: tokenizeResponse,
+            identity: verifiedIdentity,
+            updated: {
+              timestamp: assistant.meta.startTime.timestamp,
+              timestampUNIX: assistant.meta.startTime.timestampUNIX,
+            }
           }
-        }
-      }
-    }, { merge: true })
-    .then(r => r)
-    .catch(e => e)
+        },
+        metadata: Manager.Metadata().set({tag: 'user:oauth2'}),
+      }, { merge: true })
+      .then(r => r)
+      .catch(e => e)
 
     assistant.log('storeResponse', user.auth.uid, storeResponse, {environment: 'production'});
 
@@ -313,20 +314,21 @@ Module.prototype.processState_refresh = function (newUrl, user) {
     // }
 
     const storeResponse = await self.libraries.admin.firestore().doc(`users/${user.auth.uid}`)
-    .set({
-      oauth2: {
-        [payload.data.payload.provider]: {
-          token: refreshResponse,
-          // identity: verifiedIdentity,
-          updated: {
-            timestamp: assistant.meta.startTime.timestamp,
-            timestampUNIX: assistant.meta.startTime.timestampUNIX,
+      .set({
+        oauth2: {
+          [payload.data.payload.provider]: {
+            token: refreshResponse,
+            // identity: verifiedIdentity,
+            updated: {
+              timestamp: assistant.meta.startTime.timestamp,
+              timestampUNIX: assistant.meta.startTime.timestampUNIX,
+            }
           }
-        }
-      }
-    }, { merge: true })
-    .then(r => r)
-    .catch(e => e)
+        },
+        metadata: Manager.Metadata().set({tag: 'user:oauth2'}),
+      }, { merge: true })
+      .then(r => r)
+      .catch(e => e)
 
     assistant.log('storeResponse', user.auth.uid, storeResponse, {environment: 'production'});
 
@@ -351,23 +353,24 @@ Module.prototype.processState_deauthorize = function (newUrl, user) {
 
   return new Promise(async function(resolve, reject) {
     self.libraries.admin.firestore().doc(`users/${user.auth.uid}`)
-    .set({
-      oauth2: {
-        [payload.data.payload.provider]: {},
-        updated: {
-          timestamp: assistant.meta.startTime.timestamp,
-          timestampUNIX: assistant.meta.startTime.timestampUNIX,
-        }
-      }
-    }, { merge: true })
-    .then(function(data) {
-      return resolve({
-        data: {success: true},
-      });
-    })
-    .catch(function(e) {
-      return reject(e);
-    })
+      .set({
+        oauth2: {
+          [payload.data.payload.provider]: {},
+          updated: {
+            timestamp: assistant.meta.startTime.timestamp,
+            timestampUNIX: assistant.meta.startTime.timestampUNIX,
+          }
+        },
+        metadata: Manager.Metadata().set({tag: 'user:oauth2'}),
+      }, { merge: true })
+      .then(function(data) {
+        return resolve({
+          data: {success: true},
+        });
+      })
+      .catch(function(e) {
+        return reject(e);
+      })
   });
 };
 
@@ -392,22 +395,23 @@ Module.prototype.processState_status = function (newUrl, user) {
         }
 
         Manager.libraries.admin.firestore().doc(`users/${user.auth.uid}`)
-        .set({
-          oauth2: {
-            [payload.data.payload.provider]: {},
-            updated: {
-              timestamp: assistant.meta.startTime.timestamp,
-              timestampUNIX: assistant.meta.startTime.timestampUNIX,
-            }
-          }
-        }, { merge: true })
-        .then(async () => {
-          assistant.log(`Removed disconnected token for user: ${user.auth.uid}`)
-        })
-        .catch((e) => e)
-        .finally(() => {
-          return resolve();
-        })
+          .set({
+            oauth2: {
+              [payload.data.payload.provider]: {},
+              updated: {
+                timestamp: assistant.meta.startTime.timestamp,
+                timestampUNIX: assistant.meta.startTime.timestampUNIX,
+              }
+            },
+            metadata: Manager.Metadata().set({tag: 'user:oauth2'}),
+          }, { merge: true })
+          .then(async () => {
+            assistant.log(`Removed disconnected token for user: ${user.auth.uid}`)
+          })
+          .catch((e) => e)
+          .finally(() => {
+            return resolve();
+          })
       });
     }
 

package/src/manager/functions/core/actions/api/user/regenerate-api-keys.js

@@ -33,6 +33,7 @@ Module.prototype.main = function () {
       self.libraries.admin.firestore().doc(`users/${user.auth.uid}`)
       .set({
         api: newKeys,
+        metadata: Manager.Metadata().set({tag: 'user:regenerate-api-keys'}),
       }, {merge: true})
       .then(r => {
         return resolve({data: newKeys});

package/src/manager/functions/core/actions/api/user/sign-out-all-sessions.js

@@ -72,14 +72,13 @@ Module.prototype.signOutOfSession = function (uid, session) {
           .set('signout')
           .catch(e => self.assistant.error(`Failed to signout of session ${key}`, e))
 
-        // await powertools.wait(3000);
+        // Delay so the client has time to react to the command
+        await powertools.wait(5000);
 
         // Delete session
-        setTimeout(function () {
-          self.libraries.admin.database().ref(`${session}/${key}`)
-            .remove()
-            .catch(e => self.assistant.error(`Failed to delete session ${key}`, e))          
-        }, 30000);
+        self.libraries.admin.database().ref(`${session}/${key}`)
+          .remove()
+          .catch(e => self.assistant.error(`Failed to delete session ${key}`, e))          
 
         count++;
       }

package/src/manager/functions/core/actions/api/user/sign-up.js

@@ -52,64 +52,75 @@ Module.prototype.main = function () {
 
 };
 
+
+
 Module.prototype.signUp = function (payload) {
   const self = this;
-  const result = {
-    signedUp: false,
-    referrerUid: undefined,
-    // updatedReferral: true,
-  };
-  let error;
-  payload = payload || {};
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
 
   return new Promise(async function(resolve, reject) {
-    let existingUser = {};
-    let finalPayload = {};
+    const result = {
+      signedUp: false,
+      referrerUid: undefined,
+      // updatedReferral: true,
+    };
+
+    payload = payload || {};    
 
+    // Check if the user has a UID and email
     if (!_.get(payload, 'auth.uid', null) || !_.get(payload, 'auth.email', null)) {
       return reject(new Error('Cannot create user without UID and email.'))
     }
 
+    // Update the user who referred this user
     await self.updateReferral({
       affiliateCode: _.get(payload, 'affiliate.referrer', null),
       uid: payload.auth.uid,
     })
-    .then(r => {
+    .then((r) => {
       payload.affiliate.referrer = r.referrerUid;
       result.referrerUid = payload.affiliate.referrer;
     })
-    .catch(function (e) {
+    .catch((e) => {
       payload.affiliate.referrer = undefined;
       console.error('Failed to update affiliate code', e)
     })
 
-    // payload.affiliate.referrer = undefined;
-
-    await self.libraries.admin.firestore().doc(`users/${payload.auth.uid}`)
-    .get()
-    .then(async function (doc) {
-      existingUser = doc.data() || {};
-    })
-    .catch(function (e) {
-      error = e;
-    })
-
-    if (error) {
-      return reject(error);
-    }
-
-    const user = self.Manager.User(payload);
-
     // Merge the payload and the default user object
-    finalPayload = _.merge({}, existingUser, user.properties)
-
+    const user = {
+      activity: {
+        geolocation: {
+          // Main geolocation
+          ip: assistant.request.ip,
+          continent: assistant.request.continent,
+          country: assistant.request.country,
+          city: assistant.request.city,
+          latitude: assistant.request.latitude,
+          longitude: assistant.request.longitude,
+
+          // Get User Agent data
+          userAgent: assistant.request.userAgent,
+          language: assistant.request.language,
+          platform: assistant.request.platform,
+        },
+      },
+      affiliate: {
+        referrer: payload.affiliate.referrer,
+      },
+      metadata: Manager.Metadata().set({tag: 'user:sign-up'}),
+    }
+    
+    // Set the user
     self.libraries.admin.firestore().doc(`users/${payload.auth.uid}`)
-    .set(finalPayload, { merge: true })
-    .then(function(data) {
+    .set(user, { merge: true })
+    .then((data) => {
       result.signedUp = true;
+
       return resolve(result);
     })
-    .catch(function(e) {
+    .catch((e) => {
       return reject(e);
     })
 

package/src/manager/functions/core/actions/api/user/submit-feedback.js

@@ -65,7 +65,8 @@ Module.prototype.main = function () {
           decision: decision,
           owner: {
             uid: get(user, 'auth.uid', null),
-          }
+          },
+          metadata: Manager.Metadata().set({tag: 'user:submit-feedback'}),
         }, {merge: true})
         .then(r => {
           return resolve({

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const _ = require('lodash');
 const jetpack = require('fs-jetpack');
+const powertools = require('node-powertools');
 
 function Module() {
 
@@ -27,6 +28,7 @@ Module.prototype.init = function (Manager, data) {
   const resolved = self.resolveCommand(self.assistant.request.data.command);
   self.assistant.request.data.command = resolved.command;
   self.assistant.request.data.payload = self.assistant.request.data.payload || {};
+  self.assistant.request.data.options = self.assistant.request.data.options || {};
 
   if (Manager.options.log) {
     self.assistant.log(`Executing (log): ${resolved.command}`, self.assistant.request, JSON.stringify(self.assistant.request), {environment: 'production'})
@@ -48,15 +50,31 @@ Module.prototype.main = function() {
       self.payload.data = assistant.request.data;
       self.payload.user = await assistant.authenticate();
 
+      // Quit if OPTIONS request
       if (self.assistant.request.method === 'OPTIONS') {
         return resolve();
       }
 
+      // Resolve command
       const resolved = self.resolveCommand(self.payload.data.command);
 
       self.assistant.log(`Executing: ${resolved.command}`, self.payload, JSON.stringify(self.payload), {environment: 'production'})
       self.assistant.log(`Resolved URL: ${Manager.project.functionsUrl}?command=${encodeURIComponent(resolved.command)}&payload=${encodeURIComponent(JSON.stringify(self.assistant.request.data.payload))}`, {environment: 'development'})
 
+      // Set up options
+      self.payload.data.options = self.payload.data.options || {};
+      self.payload.data.options.delay = self.payload.data.options.delay || 0;
+
+      // Delay
+      if (self.payload.data.options.delay > 0) {
+        let delay = Math.floor(self.payload.data.options.delay / 1000);
+
+        await powertools.poll(() => {
+          self.assistant.log(`Delaying for ${delay--} seconds...`, {environment: 'production'});
+        }, {interval: 1000, timeout: self.payload.data.options.delay})
+        .catch(e => e);
+      }
+
       if (!resolved.exists) {
         self.payload.response.status = 400;
         self.payload.response.error = new Error(`${self.payload.data.command} is not a valid command`);

package/src/manager/functions/core/events/auth/on-create.js

@@ -1,3 +1,5 @@
+const { get } = require('lodash');
+
 function Module() {
   const self = this;
 }
@@ -19,13 +21,33 @@ Module.prototype.main = function () {
   const user = self.user;
 
   return new Promise(async function(resolve, reject) {
+    // Check if exists already
+    // It could exist already if user signed up with email and then signed in with Google
+    const existingUser = await libraries.admin.firestore().doc(`users/${user.uid}`)
+      .get()
+      .then((doc) => doc.data() || {})
+      .catch(e => e)
+
+    // If user already exists, skip auth-on-create handler
+    if (
+      existingUser instanceof Error
+      || get(existingUser, 'auth.uid', null)
+      || get(existingUser, 'auth.email', null)
+    ) {
+      assistant.log(`auth-on-create: Skipping handler because user already exists ${user.uid}:`, existingUser, {environment: 'production'});
+
+      return resolve(self);      
+    }      
+
+    // Build user object
     const newUser = self.Manager.User({
       auth: {
         uid: user.uid,
         email: user.email,
       }
-    });
+    }).properties;       
 
+    // Set up analytics
     const analytics = self.Manager.Analytics({
       assistant: assistant,
       uuid: user.uid,
@@ -42,14 +64,17 @@ Module.prototype.main = function () {
         return true
       }
     }).length < 1) {
-      return;
+      return resolve(self);      
     }
 
+    // Add metadata
+    newUser.metadata = self.Manager.Metadata().set({tag: 'auth:on-create'});
+
     // Add user record
-    await libraries.admin.firestore().doc(`users/${newUser.properties.auth.uid}`)
-      .set(newUser.properties, {merge: true})
-      .catch(e => {
-        assistant.error(e, {environment: 'production'});
+    await libraries.admin.firestore().doc(`users/${newUser.auth.uid}`)
+      .set(newUser, {merge: true})
+      .catch((e) => {
+        assistant.error(`auth-on-create: Failed save user record`, e, {environment: 'production'});
       })
 
     // Update user count
@@ -57,11 +82,12 @@ Module.prototype.main = function () {
       .update({
         'users.total': libraries.admin.firestore.FieldValue.increment(1),
       })
-      .catch(e => {
-        assistant.error(e, {environment: 'production'});
+      .catch((e) => {
+        assistant.error(`auth-on-create: Failed to increment user`, e, {environment: 'production'});
       })
 
-    assistant.log('User created:', user, {environment: 'production'});
+    assistant.log(`auth-on-create: User created ${user.uid}:`, newUser, user, {environment: 'production'});
+
     return resolve(self);      
   });
 };

package/src/manager/functions/core/events/auth/on-delete.js

@@ -19,6 +19,7 @@ Module.prototype.main = function () {
   const user = self.user;
 
   return new Promise(async function(resolve, reject) {
+    // Set up analytics
     const analytics = self.Manager.Analytics({
       assistant: assistant,
       uuid: user.uid,
@@ -29,11 +30,11 @@ Module.prototype.main = function () {
       // label: 'regular',
     });
 
-    // Add user record
+    // Delete user record
     await libraries.admin.firestore().doc(`users/${user.uid}`)
       .delete()
-      .catch(e => {
-        assistant.error(e, {environment: 'production'});
+      .catch((e) => {
+        assistant.error(`auth-on-delete: Delete user failed`, e, {environment: 'production'});
       })
 
     // Update user count
@@ -41,11 +42,11 @@ Module.prototype.main = function () {
       .update({
         'users.total': libraries.admin.firestore.FieldValue.increment(-1),
       })
-      .catch(e => {
-        assistant.error(e, {environment: 'production'});
+      .catch((e) => {
+        assistant.error(`auth-on-delete: Failed to decrement user`, e, {environment: 'production'});
       })
 
-    assistant.log('User deleted:', user, {environment: 'production'}); 
+    assistant.log(`auth-on-delete: User deleted ${user.uid}:`, user, {environment: 'production'}); 
     
     return resolve(self);
   });

package/src/manager/helpers/metadata.js

@@ -0,0 +1,32 @@
+const moment = require('moment');
+const uuidv4 = require('uuid').v4;
+
+function Metadata(Manager, document) {
+  const self = this;
+
+  self.Manager = Manager;
+
+  self.document = document || {};
+
+  return self;
+}
+
+Metadata.prototype.set = function (metadata) {
+  const self = this;
+
+  const now = moment();
+
+  self.document = self.document || {};
+  self.document.metadata = self.document.metadata || {};
+
+  self.document.metadata.updated = self.document.metadata.updated || {};
+  self.document.metadata.updated.timestamp = now.toISOString();
+  self.document.metadata.updated.timestampUNIX = now.unix();
+  self.document.metadata.tag = metadata.tag || uuidv4();
+
+  self.Manager.assistant.log(`Metadata: #${self.document.metadata.tag}`);
+
+  return self.document.metadata;
+};
+
+module.exports = Metadata;

package/src/manager/helpers/subscription-resolver.js

@@ -1,11 +1,14 @@
 const moment = require('moment');
 const { get } = require('lodash');
 
-function SubscriptionResolver(profile, resource) {
+function SubscriptionResolver(Manager, profile, resource) {
   const self = this;
   
+  self.Manager = Manager;
   self.profile = profile;
   self.resource = resource;
+
+  return self;
 }
 
 SubscriptionResolver.prototype.resolve = function (options) {

package/src/manager/helpers/user.js

@@ -5,9 +5,11 @@ const powertools = require('node-powertools');
 const UIDGenerator = require('uid-generator');
 const uidgen = new UIDGenerator(256);
 
-function User(settings, options) {
+function User(Manager, settings, options) {
   const self = this;
 
+  self.Manager = Manager;
+
   settings = settings || {};
   options = options || {};
 
@@ -81,6 +83,17 @@ function User(settings, options) {
         timestamp: _.get(settings, 'activity.created.timestamp', useDefaults ? now : null),
         timestampUNIX: _.get(settings, 'activity.created.timestampUNIX', useDefaults ? nowUNIX : null),
       },
+      geolocation: {
+        ip: _.get(settings, 'activity.geolocation.ip', useDefaults ? 'unknown' : null),
+        continent: _.get(settings, 'activity.geolocation.continent', useDefaults ? 'unknown' : null),
+        country: _.get(settings, 'activity.geolocation.country', useDefaults ? 'unknown' : null),
+        city: _.get(settings, 'activity.geolocation.city', useDefaults ? 'unknown' : null),
+        latitude: _.get(settings, 'activity.geolocation.latitude', useDefaults ? 'unknown' : null),
+        longitude: _.get(settings, 'activity.geolocation.longitude', useDefaults ? 'unknown' : null),
+        userAgent: _.get(settings, 'activity.geolocation.userAgent', useDefaults ? 'unknown' : null),
+        language: _.get(settings, 'activity.geolocation.language', useDefaults ? 'unknown' : null),
+        platform: _.get(settings, 'activity.geolocation.platform', useDefaults ? 'unknown' : null),
+      },
     },
     api: {
       clientId: _.get(settings, 'api.clientId', useDefaults ? `${uuid4()}` : null),

package/src/manager/index.js

@@ -554,7 +554,7 @@ Manager.prototype.Assistant = function(ref, options) {
 Manager.prototype.User = function () {
   const self = this;
   self.libraries.User = self.libraries.User || require('./helpers/user.js');
-  return new self.libraries.User(...arguments);
+  return new self.libraries.User(self, ...arguments);
 };
 
 Manager.prototype.Analytics = function () {
@@ -578,7 +578,13 @@ Manager.prototype.Roles = function () {
 Manager.prototype.SubscriptionResolver = function () {
   const self = this;
   self.libraries.SubscriptionResolver = self.libraries.SubscriptionResolver || require('./helpers/subscription-resolver.js');
-  return new self.libraries.SubscriptionResolver(...arguments);
+  return new self.libraries.SubscriptionResolver(self, ...arguments);
+};
+
+Manager.prototype.Metadata = function () {
+  const self = this;
+  self.libraries.Metadata = self.libraries.Metadata || require('./helpers/metadata.js');
+  return new self.libraries.Metadata(self, ...arguments);
 };
 
 // For importing API libraries