feat: app router 2 and redesigned config APIs (#463)

* feat: support app router 2 and redesigned config APIs

* fix(Insight): pick #464

* fix: skip refreshing if approuter disabled

* docs: AV.init/AV.setServerURLs/AV.request

* refactor(AppRouter): make disabled a property of AppRouter

* fix(AppRouter): change default serverURLs

* feat(AppRouter): use service urls for push and cloudfunction

* fix: lowercase default server urls

Author: leeyeh

src/app-router.js

@@ -0,0 +1,62 @@
+const {
+  ajax,
+} = require('./utils');
+const Cache = require('./cache');
+
+function AppRouter(AV) {
+  this.AV = AV;
+  this.lockedUntil = 0;
+  Cache.getAsync('serverURLs').then(data => {
+    if (!data) return this.lock(0);
+    const {
+      serverURLs,
+      lockedUntil,
+    } = data;
+    this.AV._setServerURLs(serverURLs, false);
+    this.lockedUntil = lockedUntil;
+  }).catch(() => this.lock(0));
+}
+
+AppRouter.prototype.disable = function disable() {
+  this.disabled = true;
+};
+AppRouter.prototype.lock = function lock(ttl) {
+  this.lockedUntil = Date.now() + ttl;
+};
+AppRouter.prototype.refresh = function refresh() {
+  if (this.disabled) return;
+  if (Date.now() < this.lockedUntil) return;
+  this.lock(10);
+  const url = 'https://app-router.leancloud.cn/2/route';
+  return ajax({
+    method: 'get',
+    url,
+    query: {
+      appId: this.AV.applicationId,
+    },
+  }).then(servers => {
+    if (this.disabled) return;
+    let ttl = servers.ttl;
+    if (!ttl) throw new Error('missing ttl');
+    ttl = ttl * 1000;
+    const protocal = 'https://';
+    const serverURLs = {
+      push: protocal + servers.push_server,
+      stats: protocal + servers.stats_server,
+      engine: protocal + servers.engine_server,
+      api: protocal + servers.api_server,
+    };
+    this.AV._setServerURLs(serverURLs, false);
+    this.lock(ttl);
+    return Cache.setAsync('serverURLs', {
+      serverURLs,
+      lockedUntil: this.lockedUntil,
+    }, ttl);
+  }).catch(error => {
+    // bypass all errors
+    console.warn(`refresh server URLs failed: ${error.message}`);
+    this.lock(600);
+  });
+};
+
+module.exports = AppRouter;

src/av.js

@@ -1,105 +1,25 @@
 const _ = require('underscore');
 const userAgent = require('./ua');
 const {
-  isNullOrUndefined,
+  inherits,
+  parseDate,
 } = require('./utils');
 
 const AV = global.AV || {};
 
 // All internal configuration items
-AV._config = AV._config || {};
-const AVConfig = AV._config;
-
-_.extend(AVConfig, {
-
-  // 服务器节点地区，默认中国大陆
-  region: 'cn',
-
-  // 服务器的 URL，默认初始化时被设置为大陆节点地址
-  APIServerURL: AVConfig.APIServerURL || '',
-
-  // 禁用 currentUser，通常用于多用户环境
-  disableCurrentUser: false,
-
-  // Internal config can modifie the UserAgent
+AV._config = {
   userAgent,
-
-  // set production environment or test environment
-  // 1: production environment, 0: test environment, null: default environment
-  applicationProduction: null,
-});
+  serverURLs: {},
+  useMasterKey: false,
+  production: null,
+};
 
 /**
  * Contains all AV API classes and functions.
  * @namespace AV
  */
 
-// Helpers
-// -------
-
-// Shared empty constructor function to aid in prototype-chain creation.
-var EmptyConstructor = function() {};
-
-// Helper function to correctly set up the prototype chain, for subclasses.
-// Similar to `goog.inherits`, but uses a hash of prototype properties and
-// class properties to be extended.
-var inherits = function(parent, protoProps, staticProps) {
-  var child;
-
-  // The constructor function for the new subclass is either defined by you
-  // (the "constructor" property in your `extend` definition), or defaulted
-  // by us to simply call the parent's constructor.
-  if (protoProps && protoProps.hasOwnProperty('constructor')) {
-    child = protoProps.constructor;
-  } else {
-    /** @ignore */
-    child = function(){ parent.apply(this, arguments); };
-  }
-
-  // Inherit class (static) properties from parent.
-  _.extend(child, parent);
-
-  // Set the prototype chain to inherit from `parent`, without calling
-  // `parent`'s constructor function.
-  EmptyConstructor.prototype = parent.prototype;
-  child.prototype = new EmptyConstructor();
-
-  // Add prototype properties (instance properties) to the subclass,
-  // if supplied.
-  if (protoProps) {
-    _.extend(child.prototype, protoProps);
-  }
-
-  // Add static properties to the constructor function, if supplied.
-  if (staticProps) {
-    _.extend(child, staticProps);
-  }
-
-  // Correctly set child's `prototype.constructor`.
-  child.prototype.constructor = child;
-
-  // Set a convenience property in case the parent's prototype is
-  // needed later.
-  child.__super__ = parent.prototype;
-
-  return child;
-};
-
-/**
- * Call this method to set production environment variable.
- * @function AV.setProduction
- * @param {Boolean} production True is production environment,and
- *  it's true by default.
- */
-AV.setProduction = (production) => {
-  if (!isNullOrUndefined(production)) {
-    AVConfig.applicationProduction = production ? 1 : 0;
-  } else {
-    // change to default value
-    AVConfig.applicationProduction = null;
-  }
-};
-
 /**
  * Returns prefix for localStorage keys used by this instance of AV.
  * @param {String} path The relative suffix to append to it.
@@ -158,26 +78,7 @@ AV._getInstallationId = function() {
   });
 };
 
-AV._parseDate = function(iso8601) {
-  var regexp = new RegExp(
-    "^([0-9]{1,4})-([0-9]{1,2})-([0-9]{1,2})" + "T" +
-    "([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})" +
-    "(.([0-9]+))?" + "Z$");
-  var match = regexp.exec(iso8601);
-  if (!match) {
-    return null;
-  }
-
-  var year = match[1] || 0;
-  var month = (match[2] || 1) - 1;
-  var day = match[3] || 0;
-  var hour = match[4] || 0;
-  var minute = match[5] || 0;
-  var second = match[6] || 0;
-  var milli = match[8] || 0;
-
-  return new Date(Date.UTC(year, month, day, hour, minute, second, milli));
-};
+AV._parseDate = parseDate;
 
 // A self-propagating extend function.
 AV._extend = function(protoProps, classProps) {
@@ -186,15 +87,6 @@ AV._extend = function(protoProps, classProps) {
   return child;
 };
 
-// Helper function to get a value from a Backbone object as a property
-// or as a function.
-AV._getValue = function(object, prop) {
-  if (!(object && object[prop])) {
-    return null;
-  }
-  return _.isFunction(object[prop]) ? object[prop]() : object[prop];
-};
-
 /**
  * Converts a value in a AV Object into the appropriate representation.
  * This is the JS equivalent of Java's AV.maybeReferenceAndEncode(Object)

src/cache.js

@@ -20,7 +20,7 @@ const getCacheData = (cacheData, key) => {
 };
 
 exports.getAsync = (key) => {
-  key = `${AV.applicationId}/${key}`;
+  key = `AV/${AV.applicationId}/${key}`;
   return storage.getItemAsync(key)
     .then(cache => getCacheData(cache, key));
 };
@@ -31,7 +31,7 @@ exports.setAsync = (key, value, ttl) => {
     cache.expiredAt = Date.now() + ttl;
   }
   return storage.setItemAsync(
-    `${AV.applicationId}/${key}`,
+    `AV/${AV.applicationId}/${key}`,
      JSON.stringify(cache)
    );
 };

src/cloudfunction.js

@@ -1,5 +1,5 @@
 const _ = require('underscore');
-const AVRequest = require('./request').request;
+const { _request, request } = require('./request');
 
 module.exports = function(AV) {
   /**
@@ -21,11 +21,14 @@ module.exports = function(AV) {
      * @return {Promise} A promise that will be resolved with the result
      * of the function.
      */
-    run: function(name, data, options) {
-      var request = AVRequest('functions', name, null, 'POST',
-                                   AV._encode(data, null, true), options);
-
-      return request.then(function(resp) {
+    run(name, data, options) {
+      return request({
+        service: 'engine',
+        method: 'POST',
+        path: `/functions/${name}`,
+        data: AV._encode(data, null, true),
+        authOptions: options,
+      }).then((resp) => {
         return AV._decode(resp).result;
       });
     },
@@ -38,12 +41,18 @@ module.exports = function(AV) {
      * @param {AuthOptions} options
      * @return {Promise} A promise that will be resolved with the result of the function.
      */
-    rpc: function(name, data, options) {
+    rpc(name, data, options) {
       if (_.isArray(data)) {
         return Promise.reject(new Error('Can\'t pass Array as the param of rpc function in JavaScript SDK.'));
       }
 
-      return AVRequest('call', name, null, 'POST', AV._encodeObjectOrArray(data), options).then(function(resp) {
+      return request({
+        service: 'engine',
+        method: 'POST',
+        path: `/call/${name}`,
+        data: AV._encodeObjectOrArray(data),
+        authOptions: options,
+      }).then((resp) => {
         return AV._decode(resp).result;
       });
     },
@@ -54,10 +63,8 @@ module.exports = function(AV) {
      * of the function.
      * @since 0.5.9
      */
-    getServerDate: function() {
-      var request = AVRequest("date", null, null, 'GET');
-
-      return request.then(function(resp) {
+    getServerDate() {
+      return _request("date", null, null, 'GET').then(function(resp) {
         return AV._decode(resp);
       });
     },
@@ -69,16 +76,15 @@ module.exports = function(AV) {
      * @return {Promise} A promise that will be resolved with the result
      * of the function.
      */
-    requestSmsCode: function(data){
+    requestSmsCode(data) {
       if(_.isString(data)) {
         data = { mobilePhoneNumber: data };
       }
       if(!data.mobilePhoneNumber) {
         throw new Error('Missing mobilePhoneNumber.');
       }
-      var request = AVRequest("requestSmsCode", null, null, 'POST',
+      return _request("requestSmsCode", null, null, 'POST',
                                     data);
-      return request;
     },
 
     /**
@@ -88,17 +94,16 @@ module.exports = function(AV) {
      * @return {Promise} A promise that will be resolved with the result
      * of the function.
      */
-    verifySmsCode: function(code, phone){
+    verifySmsCode(code, phone) {
       if(!code)
         throw new Error('Missing sms code.');
       var params = {};
       if(_.isString(phone)) {
          params['mobilePhoneNumber'] = phone;
       }
 
-      var request = AVRequest("verifySmsCode", code, null, 'POST',
+      return _request("verifySmsCode", code, null, 'POST',
                                    params);
-      return request;
     }
   });
 };

src/file.js

@@ -3,7 +3,7 @@ const cos = require('./uploader/cos');
 const qiniu = require('./uploader/qiniu');
 const s3 = require('./uploader/s3');
 const AVError = require('./error');
-const AVRequest = require('./request').request;
+const AVRequest = require('./request')._request;
 const Promise = require('./promise');
 const { tap } = require('./utils');
 const debug = require('debug')('leancloud:file');