refactor: build UA with platform info provided by adapters

Author: leeyeh

package-lock.json

@@ -11,7 +11,7 @@
     "precommit": "pretty-quick --staged",
     "lint": "tsc storage.d.ts --strict",
     "test": "npm run lint && npm run test:node",
-    "test:node": "cross-env NODE_ENV=test nyc --reporter lcov --reporter text mocha --timeout 300000 test/index.js",
+    "test:node": "cross-env NODE_ENV=test PLATFORM=NODE_JS nyc --reporter lcov --reporter text mocha --timeout 300000 test/index.js",
     "test:real": "cross-env REAL_BACKEND=1 npm run test:node",
     "docs": "jsdoc src README.md package.json -d docs -c .jsdocrc.json",
     "build:node": "cross-env PLATFORM=NODE_JS babel src --out-dir dist/node",
@@ -23,10 +23,10 @@
     "prepublishOnly": "./script/check-version.js"
   },
   "dependencies": {
-    "@leancloud/adapter-types": "^1.0.2",
-    "@leancloud/platform-adapters-browser": "^1.0.2",
-    "@leancloud/platform-adapters-node": "^1.0.2",
-    "@leancloud/platform-adapters-weapp": "^1.0.3",
+    "@leancloud/adapter-types": "^3.0.0",
+    "@leancloud/platform-adapters-browser": "^1.1.0",
+    "@leancloud/platform-adapters-node": "^1.1.0",
+    "@leancloud/platform-adapters-weapp": "^1.2.0",
     "babel-runtime": "^6.26.0",
     "debug": "^3.1.0",
     "eventemitter3": "^2.0.3",
@@ -75,7 +75,6 @@
   "browser": {
     "@leancloud/platform-adapters-node": "@leancloud/platform-adapters-browser",
     "./src/utils/parse-base64.js": "./src/utils/parse-base64-browser.js",
-    "./src/ua/comments.js": "./src/ua/comments-browser.js",
     "./dist/node/entry/index.js": "./dist/av.js"
   },
   "react-native": {

package.json

@@ -1,18 +1,29 @@
 const _ = require('underscore');
-const adapters = {};
+const EventEmitter = require('eventemitter3');
+const { inherits } = require('./utils');
 
-const getAdapter = name => {
-  const adapter = adapters[name];
-  if (adapter === undefined) {
-    throw new Error(`${name} adapter is not configured`);
-  }
-  return adapter;
-};
-const setAdapters = newAdapters => {
-  _.extend(adapters, newAdapters);
-};
+const AdapterManager = inherits(EventEmitter, {
+  constructor() {
+    EventEmitter.apply(this);
+    this._adapters = {};
+  },
+  getAdapter(name) {
+    const adapter = this._adapters[name];
+    if (adapter === undefined) {
+      throw new Error(`${name} adapter is not configured`);
+    }
+    return adapter;
+  },
+  setAdapters(newAdapters) {
+    _.extend(this._adapters, newAdapters);
+    _.keys(newAdapters).forEach(name => this.emit(name, newAdapters[name]));
+  },
+});
+
+const adapterManager = new AdapterManager();
 
 module.exports = {
-  getAdapter,
-  setAdapters,
+  getAdapter: adapterManager.getAdapter.bind(adapterManager),
+  setAdapters: adapterManager.setAdapters.bind(adapterManager),
+  adapterManager,
 };

src/adapter.js

@@ -1,4 +1,4 @@
-const { ajax } = require('./utils');
+const ajax = require('./utils/ajax');
 const Cache = require('./cache');
 
 function AppRouter(AV) {

src/app-router.js

@@ -1,9 +1,9 @@
 const _ = require('underscore');
 const uuid = require('uuid/v4');
 const debug = require('debug');
-const getUA = require('./ua');
 const { inherits, parseDate } = require('./utils');
-const { setAdapters } = require('./adapter');
+const version = require('./version');
+const { setAdapters, adapterManager } = require('./adapter');
 
 const AV = global.AV || {};
 
@@ -16,12 +16,33 @@ AV._config = {
   requestTimeout: null,
 };
 
+const initialUserAgent = `LeanCloud-JS-SDK/${version}`;
+
 // configs shared by all AV instances
 AV._sharedConfig = {
-  userAgent: getUA(),
+  userAgent: initialUserAgent,
   liveQueryRealtime: null,
 };
 
+adapterManager.on('platformInfo', platformInfo => {
+  let ua = initialUserAgent;
+  if (platformInfo) {
+    if (platformInfo.userAgent) {
+      ua = platformInfo.userAgent;
+    } else {
+      let comments = platformInfo.name;
+      if (platformInfo.version) {
+        comments += `/${platformInfo.version}`;
+      }
+      if (platformInfo.extra) {
+        comments += `; ${platformInfo.extra}`;
+      }
+      ua += ` (${comments})`;
+    }
+  }
+  AV._sharedConfig.userAgent = ua;
+});
+
 /**
  * Contains all AV API classes and functions.
  * @namespace AV

src/av.js

@@ -1,12 +1,6 @@
 const adapters = require('@leancloud/platform-adapters-node');
-const getUA = require('../ua');
-const comments = (process.env.PLATFORM === 'NODE_JS'
-  ? [process.env.PLATFORM]
-  : []
-).concat(require('../ua/comments'));
 
 module.exports = AV => {
   AV.setAdapters(adapters);
-  AV._sharedConfig.userAgent = getUA(comments);
   return AV;
 };

src/entry/use-adapters.js

@@ -2,7 +2,8 @@ const _ = require('underscore');
 const md5 = require('md5');
 const { extend } = require('underscore');
 const AV = require('./av');
-const { getSessionToken, ajax } = require('./utils');
+const { getSessionToken } = require('./utils');
+const ajax = require('./utils/ajax');
 
 // 计算 X-LC-Sign 的签名方法
 const sign = (key, isMasterKey) => {