backend-manager 3.2.172 → 3.2.174

package/dist/manager/helpers/usage.js

@@ -1,381 +0,0 @@
-/**
- * Usage
- * Meant to check and update usage for a user
- * Uses the ITWCW apps/{app}/products/{product}/limits/{metric} to check limits
- * Stores usage in the user's firestore document OR in local/temp storage if no user
- */
-
-const fetch = require('wonderful-fetch');
-const moment = require('moment');
-const _ = require('lodash');
-const hcaptcha = require('hcaptcha');
-
-function Usage(m) {
-  const self = this;
-
-  self.Manager = m;
-
-  self.user = null;
-  self.app = null;
-  self.options = null;
-  self.assistant = null;
-  self.storage = null;
-
-  self.paths = {
-    user: '',
-    app: '',
-  }
-
-  self.initialized = false;
-}
-
-Usage.prototype.init = function (assistant, options) {
-  const self = this;
-
-  return new Promise(async function(resolve, reject) {
-    const Manager = self.Manager;
-
-    // Set options
-    options = options || {};
-    options.app = options.app || Manager.config.app.id;
-    options.refetch = typeof options.refetch === 'undefined' ? false : options.refetch;
-    options.clear = typeof options.clear === 'undefined' ? false : options.clear;
-    options.today = typeof options.today === 'undefined' ? undefined : options.today;
-    options.key = typeof options.key === 'undefined' ? undefined : options.key;
-    options.unauthenticatedMode = typeof options.unauthenticatedMode === 'undefined' ? 'firestore' : options.unauthenticatedMode;
-    options.whitelistKeys = options.whitelistKeys || [];
-    options.log = typeof options.log === 'undefined' ? false : options.log;
-
-    // Check for required options
-    if (!assistant) {
-      return reject(new Error('Missing required {assistant} parameter'));
-    }
-
-    // Add BEM to whitelist keys
-    options.whitelistKeys.push(
-      Manager?.config?.backend_manager?.key
-      || process.env.BACKEND_MANAGER_KEY
-    );
-
-    // Set options
-    self.options = options;
-
-    // Set assistant
-    self.assistant = assistant;
-
-    // Setup storage
-    self.storage = Manager.storage({name: 'usage', temporary: true, clear: options.clear, log: options.log});
-
-    // Set local key
-    self.key = (options.key || self.assistant.request.geolocation.ip || '')
-      .replace(/[\.:]/g, '_');
-
-    // Set paths
-    self.paths.user = `users.${self.key}`;
-    self.paths.app = `apps.${options.app}`;
-
-    // Get storage data
-    const appLastFetched = moment(self.storage.get(`${self.paths.app}.lastFetched`, 0).value());
-    const diff = moment().diff(appLastFetched, 'hours');
-
-    // Authenticate user (user will be resolved as well)
-    self.user = await assistant.authenticate();
-
-    self.useUnauthenticatedStorage = !self.user.auth.uid || self.options.key;
-
-    // Load usage with temporary if unauthenticated
-    if (self.useUnauthenticatedStorage) {
-      let foundUsage;
-
-      if (options.unauthenticatedMode === 'firestore') {
-        // TODO: Make it request using .where() query so it doesnt use a read if it doesnt have to
-        foundUsage = await Manager.libraries.admin.firestore().doc(`temporary/${self.key}`)
-          .get()
-          .then((r) => _.get(r.data(), 'usage'))
-          .catch((e) => {
-            assistant.errorify(`Usage.init(): Error fetching usage data: ${e}`, {code: 500, sentry: true});
-          });
-      } else {
-        foundUsage = self.storage.get(`${self.paths.user}.usage`, {}).value();
-      }
-
-      self.user.usage = foundUsage ? foundUsage : self.user.usage;
-    }
-
-    // Log
-    self.log(`Usage.init(): Checking if usage data needs to be fetched (${diff} hours)...`);
-
-    // 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});
-      })
-    }
-
-    // Get app data
-    self.app = self.storage.get(`${self.paths.app}.data`, {}).value();
-
-    // Check for app data
-    if (!self.app) {
-      return reject(new Error('Usage.init(): No app data found'));
-    }
-
-    // Log
-    self.log(`Usage.init(): Got app data`, self.app);
-    self.log(`Usage.init(): Got user`, self.user);
-
-    // Set initialized to true
-    self.initialized = true;
-
-    // Resolve
-    return resolve(self);
-  });
-};
-
-Usage.prototype.validate = function (name, options) {
-  const self = this;
-
-  return new Promise(async function(resolve, reject) {
-    const Manager = self.Manager;
-    const assistant = self.assistant;
-
-    // Set options
-    options = options || {};
-    options.useCaptchaResponse = typeof options.useCaptchaResponse === 'undefined' ? true : options.useCaptchaResponse;
-    options.log = typeof options.log === 'undefined' ? true : options.log;
-    options.throw = typeof options.throw === 'undefined' ? false : options.throw;
-
-    // Check for required options
-    const period = self.getUsage(name);
-    const allowed = self.getLimit(name);
-
-    // Log (independent of options.log because this is important)
-    if (options.log) {
-      assistant.log(`Usage.validate(): Checking ${period}/${allowed} for ${name}...`);
-    }
-
-    // Reject function
-    function _reject() {
-      reject(
-        assistant.errorify(`You have exceeded your ${name} usage limit of ${period}/${allowed}.`, {code: 429})
-      );
-    }
-
-    // Dev mode throw
-    if (options.throw) {
-      return _reject();
-    }
-
-    // Check if they have a white list key
-    const hasWhitelistKey = self.options.whitelistKeys.some((key) => key && key === self?.user?.api?.privateKey);
-    if (hasWhitelistKey) {
-      self.log(`Usage.validate(): Whitelist key found for ${name}`);
-
-      return resolve(true);
-    }
-
-    // If they are under the limit, resolve
-    if (period < allowed) {
-      self.log(`Usage.validate(): Valid for ${name}`);
-
-      return resolve(true);
-    }
-
-    // If they are using captcha, attempt to resolve
-    const captchaResponse = assistant.request.data['h-captcha-response'];
-    if (captchaResponse && options.useCaptchaResponse) {
-      self.log(`Usage.validate(): Checking captcha response`, captchaResponse);
-
-      const captchaResult = await hcaptcha.verify(process.env.HCAPTCHA_SECRET, captchaResponse)
-        .then((data) => data)
-        .catch((e) => e);
-
-      // If the captcha is valid, resolve
-      if (!captchaResult || captchaResult instanceof Error || !captchaResult.success) {
-        return reject(
-          assistant.errorify(`Captcha verification failed.`, {code: 400})
-        );
-      }
-    }
-
-    // Otherwise, they are over the limit, reject
-    return _reject();
-  });
-};
-
-Usage.prototype.increment = function (name, value, options) {
-  const self = this;
-  const Manager = self.Manager;
-  const assistant = self.assistant;
-
-  // Set name
-  name = name || 'requests';
-
-  // Set value
-  value = typeof value === 'undefined' ? 1 : value;
-
-  // Set options
-  options = options || {};
-  options.id = options.id || null;
-
-  // Update total and period
-  ['total', 'period', 'last'].forEach((key) => {
-    const resolved = `usage.${name}.${key}`;
-    const existing = _.get(self.user, resolved, 0);
-
-    if (key === 'last') {
-      const now = moment(
-        typeof self.options.today === 'undefined' ? new Date() : self.options.today
-      );
-
-      _.set(self.user, resolved, {
-        id: options.id,
-        timestamp: now.toISOString(),
-        timestampUNIX: now.unix(),
-      });
-    } else {
-      _.set(self.user, resolved, existing + value);
-    }
-  });
-
-  // Log the updated user
-  self.log(`Usage.init(): Incremented ${name} for user`, self.user);
-
-  return self;
-};
-
-Usage.prototype.set = function (name, value) {
-  const self = this;
-  const Manager = self.Manager;
-  const assistant = self.assistant;
-
-  // Set name
-  name = name || 'requests';
-
-  // Set value
-  value = typeof value === 'undefined' ? 0 : value;
-
-  // Update total and period
-  const resolved = `usage.${name}.period`;
-
-  // Set the value
-  _.set(self.user, resolved, value);
-
-  // Log the updated user
-  self.log(`Usage.init(): Set ${name} for user`, self.user);
-
-  return self;
-};
-
-Usage.prototype.getUsage = function (name) {
-  const self = this;
-  const Manager = self.Manager;
-  const assistant = self.assistant;
-
-  // Get usage
-  if (name) {
-    return _.get(self.user, `usage.${name}.period`, 0);
-  } else {
-    return self.user.usage;
-  }
-};
-
-Usage.prototype.getLimit = function (name) {
-  const self = this;
-  const Manager = self.Manager;
-  const assistant = self.assistant;
-
-  // Get key
-  const key = `products.${self.options.app}-${self.user.plan.id}.limits`;
-
-  // Get limit
-  if (name) {
-    return _.get(self.app, `${key}.${name}`, 0);
-  } else {
-    return _.get(self.app, key, {});
-  }
-};
-
-Usage.prototype.update = function () {
-  const self = this;
-
-  return new Promise(async function(resolve, reject) {
-    const Manager = self.Manager;
-    const assistant = self.assistant;
-
-    // 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}`)
-          .set({
-            usage: self.user.usage,
-          }, {merge: true})
-          .then(() => {
-            self.log(`Usage.update(): Updated user.usage in firestore`, self.user.usage);
-
-            return resolve(self.user.usage);
-          })
-          .catch(e => {
-            return reject(assistant.errorify(e, {code: 500, sentry: true}));
-          });
-      } else {
-        self.storage.set(`${self.paths.user}.usage`, self.user.usage).write();
-
-        self.log(`Usage.update(): Updated user.usage in local storage`, self.user.usage);
-
-        return resolve(self.user.usage);
-      }
-    } else {
-      Manager.libraries.admin.firestore().doc(`users/${self.user.auth.uid}`)
-        .set({
-          usage: self.user.usage,
-        }, {merge: true})
-        .then(() => {
-          self.log(`Usage.update(): Updated user.usage in firestore`, self.user.usage);
-
-          return resolve(self.user.usage);
-        })
-        .catch(e => {
-          return reject(assistant.errorify(e, {code: 500, sentry: true}));
-        });
-    }
-  });
-};
-
-Usage.prototype.addWhitelistKeys = function (keys) {
-  const self = this;
-
-  const options = self.options;
-
-  // Make keys and array if not already
-  keys = Array.isArray(keys) ? keys : [keys];
-
-  // Add keys to whitelist
-  options.whitelistKeys = options.whitelistKeys.concat(keys);
-
-  // Log
-  return self;
-};
-
-Usage.prototype.log = function () {
-  const self = this;
-
-  // Log
-  if (self.options.log) {
-    self.assistant.log(...arguments);
-  }
-};
-
-module.exports = Usage;

package/dist/manager/helpers/user.js

@@ -1,198 +0,0 @@
-const _ = require('lodash');
-const uuid4 = require('uuid').v4;
-const shortid = require('shortid');
-const powertools = require('node-powertools');
-const UIDGenerator = require('uid-generator');
-const uidgen = new UIDGenerator(256);
-
-function User(Manager, settings, options) {
-  const self = this;
-
-  self.Manager = Manager;
-
-  settings = settings || {};
-  options = options || {};
-
-  options.defaults = typeof options.defaults === 'undefined' ? true : options.defaults;
-  options.prune = typeof options.prune === 'undefined' ? false : options.prune;
-
-  const now = powertools.timestamp(new Date(), {output: 'string'});
-  const nowUNIX = powertools.timestamp(now, {output: 'unix'});
-  const oldDate = powertools.timestamp(new Date(0), {output: 'string'})
-  const oldDateUNIX = powertools.timestamp(oldDate, {output: 'unix'});
-
-  const defaults = options.defaults;
-
-  self.properties = {
-    auth: {
-      uid: _.get(settings, 'auth.uid', null),
-      email: _.get(settings, 'auth.email', null),
-      temporary: _.get(settings, 'auth.temporary', defaults ? false : null),
-    },
-    plan: {
-      id: _.get(settings, 'plan.id', defaults ? 'basic' : null), // intro | basic | advanced | premium
-      status: _.get(settings, 'plan.status', defaults ? 'cancelled' : null), // active | suspended | cancelled
-      expires: {
-        timestamp: _.get(settings, 'plan.expires.timestamp', defaults ? oldDate : null),
-        timestampUNIX: _.get(settings, 'plan.expires.timestampUNIX', defaults ? oldDateUNIX : null),
-      },
-      trial: {
-        activated: _.get(settings, 'plan.trial.activated', defaults ? false : null),
-        expires: {
-          timestamp: _.get(settings, 'plan.trial.expires.timestamp', defaults ? oldDate : null),
-          timestampUNIX: _.get(settings, 'plan.trial.expires.timestampUNIX', defaults ? oldDateUNIX : null),
-        },
-      },
-      limits: {
-        // devices: _.get(settings, 'plan.limits.devices', null),
-      },
-      payment: {
-        processor: _.get(settings, 'plan.payment.processor', null), // paypal | stripe | chargebee, etc
-        orderId: _.get(settings, 'plan.payment.orderId', null), // xxx-xxx-xxx
-        resourceId: _.get(settings, 'plan.payment.resourceId', null), // x-xxxxxx
-        frequency: _.get(settings, 'plan.payment.frequency', null), // monthly || annually
-        active: _.get(settings, 'plan.payment.active', defaults ? false : null), // true | false
-        startDate: {
-          timestamp: _.get(settings, 'plan.payment.startDate.timestamp', defaults ? now : null), // x-xxxxxx
-          timestampUNIX: _.get(settings, 'plan.payment.startDate.timestampUNIX', defaults ? nowUNIX : null), // x-xxxxxx
-        },
-        updatedBy: {
-          event: {
-            name: _.get(settings, 'plan.payment.updatedBy.event.name', null), // x-xxxxxx
-            id: _.get(settings, 'plan.payment.updatedBy.event.id', null), // x-xxxxxx
-          },
-          date: {
-            timestamp: _.get(settings, 'plan.payment.updatedBy.date.timestamp', defaults ? now : null), // x-xxxxxx
-            timestampUNIX: _.get(settings, 'plan.payment.updatedBy.date.timestampUNIX', defaults ? nowUNIX : null), // x-xxxxxx
-          },
-        },
-      }
-    },
-    roles: {
-      admin: _.get(settings, 'roles.admin', defaults ? false : null),
-      betaTester: _.get(settings, 'roles.betaTester', defaults ? false : null),
-      developer: _.get(settings, 'roles.developer', defaults ? false : null),
-    },
-    affiliate: {
-      code: _.get(settings, 'affiliate.code', defaults ? self.Manager.Utilities().randomId({size: 7}) : null),
-      referrals: _.get(settings, 'affiliate.referrals', []),
-      referrer: _.get(settings, 'affiliate.referrer', null),
-    },
-    activity: {
-      lastActivity: {
-        timestamp: _.get(settings, 'activity.lastActivity.timestamp', defaults ? now : null),
-        timestampUNIX: _.get(settings, 'activity.lastActivity.timestampUNIX', defaults ? nowUNIX : null),
-      },
-      created: {
-        timestamp: _.get(settings, 'activity.created.timestamp', defaults ? now : null),
-        timestampUNIX: _.get(settings, 'activity.created.timestampUNIX', defaults ? nowUNIX : null),
-      },
-      geolocation: {
-        ip: _.get(settings, 'activity.geolocation.ip', defaults ? '' : null),
-        continent: _.get(settings, 'activity.geolocation.continent', defaults ? '' : null),
-        country: _.get(settings, 'activity.geolocation.country', defaults ? '' : null),
-        region: _.get(settings, 'activity.geolocation.region', defaults ? '' : null),
-        city: _.get(settings, 'activity.geolocation.city', defaults ? '' : null),
-        latitude: _.get(settings, 'activity.geolocation.latitude', defaults ? 0 : null),
-        longitude: _.get(settings, 'activity.geolocation.longitude', defaults ? 0 : null),
-      },
-      client: {
-        userAgent: _.get(settings, 'activity.client.userAgent', defaults ? '' : null),
-        language: _.get(settings, 'activity.client.language', defaults ? '' : null),
-        platform: _.get(settings, 'activity.client.platform', defaults ? '' : null),
-        mobile: _.get(settings, 'activity.client.mobile', defaults ? null : null),
-      },
-    },
-    api: {
-      clientId: _.get(settings, 'api.clientId', defaults ? `${uuid4()}` : null),
-      privateKey: _.get(settings, 'api.privateKey', defaults ? `${uidgen.generateSync()}` : null),
-    },
-    usage: {
-      requests: {
-        period: _.get(settings, 'usage.requests.period', defaults ? 0 : null),
-        total: _.get(settings, 'usage.requests.total', defaults ? 0 : null),
-        last: {
-          id: _.get(settings, 'usage.requests.last.id', defaults ? '' : null),
-          timestamp: _.get(settings, 'usage.requests.last.timestamp', defaults ? oldDate : null),
-          timestampUNIX: _.get(settings, 'usage.requests.last.timestampUNIX', defaults ? oldDateUNIX : null),
-        },
-      },
-    },
-    personal: {
-      birthday: {
-        timestamp: _.get(settings, 'personal.birthday.timestamp', defaults ? oldDate : null),
-        timestampUNIX: _.get(settings, 'personal.birthday.timestampUNIX', defaults ? oldDateUNIX : null),
-      },
-      gender: _.get(settings, 'personal.gender', defaults ? '' : null),
-      location: {
-        country: _.get(settings, 'personal.location.country', defaults ? '' : null),
-        region: _.get(settings, 'personal.location.region', defaults ? '' : null),
-        city: _.get(settings, 'personal.location.city', defaults ? '' : null),
-      },
-      name: {
-        first: _.get(settings, 'personal.name.first', defaults ? '' : null),
-        last: _.get(settings, 'personal.name.last', defaults ? '' : null),
-      },
-      telephone: {
-        countryCode: _.get(settings, 'personal.telephone.countryCode', defaults ? 0 : null),
-        national: _.get(settings, 'personal.telephone.national', defaults ? 0 : null),
-      },
-    },
-    oauth2: {
-      // updated: {
-      //   timestamp: _.get(settings, 'oauth2.updated.timestamp', defaults ? oldDate : null),
-      //   timestampUNIX: _.get(settings, 'oauth2.updated.timestampUNIX', defaults ? oldDateUNIX : null),
-      // },
-    },
-  }
-
-  if (options.prune) {
-    self.properties = pruneObject(self.properties);
-  }
-
-  self.resolve = function (options) {
-    options = options || {};
-    options.defaultPlan = options.defaultPlan || 'basic';
-    const planId = _.get(self.properties, 'plan.id', options.defaultPlan);
-    const premiumExpire = _.get(self.properties, 'plan.expires.timestamp', 0);
-
-    let difference = ((new Date(premiumExpire).getTime() - new Date().getTime())/(24*3600*1000));
-    // console.log('---difference', difference);
-    if (difference <= -1) {
-      _.set(self.properties, 'plan.id', options.defaultPlan);
-      // console.log('---REVERTED TO BASIC BECAUSE EXPIRED');
-    } else {
-      // console.log('---ITS FINE');
-    }
-    return self;
-  }
-
-  self.merge = function (userObject) {
-    self.properties = _.merge({}, self.properties, userObject)
-    return self;
-  }
-
-  return self;
-}
-
-
-// https://stackoverflow.com/a/26202058/7305269
-function pruneObject(obj) {
-  return function prune(current) {
-    _.forOwn(current, function (value, key) {
-      if (_.isUndefined(value) || _.isNull(value) || _.isNaN(value) ||
-        (_.isObject(value) && _.isEmpty(prune(value)))) {
-
-        delete current[key];
-      }
-    });
-    // remove any leftover undefined values from the delete
-    // operation on an array
-    if (_.isArray(current)) _.pull(current, undefined);
-
-    return current;
-
-  }(_.cloneDeep(obj));  // Do not modify the original object, create a clone instead
-}
-
-module.exports = User;