@tmsfe/tms-core 0.0.1 → 0.0.5

package/package.json

@@ -1 +1,19 @@
-{"name":"@tmsfe/tms-core","version":"0.0.1","description":"tms-core","repository":{"type":"git"},"main":"dist/index","miniprogram":"dist","scripts":{},"author":"tms·web","gitHead":"67425bc1ca159701c3373a6aa9cdd801ffb82d8a","devDependencies":{}}
+{
+  "name": "@tmsfe/tms-core",
+  "version": "0.0.5",
+  "description": "tms运行时框架",
+  "repository": {
+    "type": "git",
+    "url": "http://git.code.oa.com/lbsweb/tms/tms-arch.git"
+  },
+  "main": "src/index",
+  "miniprogram": "src",
+  "buildOptions": {
+    "formats": [
+      "esm"
+    ]
+  },
+  "scripts": {},
+  "author": "tms·web",
+  "gitHead": "72bf52451594b49a1c9f78edbad5956d414a66ca"
+}

package/src/cloudService.js

@@ -0,0 +1,43 @@
+import { getEnvInfo, getAuthInfo } from './env';
+
+/**
+ * callCloudFunc 方法 调用云函数
+ * @param {String} name 要调用的云函数
+ * @param {Object} data 需要传给云函数的参数
+ * @param {Boolean} withAuth 是否需要补充userId，token参数，当云函数需要调用SinanServer时，需要这些参数来完成鉴权
+ * @returns {viod} 云函数
+ */
+export const callCloudFunc = async (name = '', data = {}, withAuth = true) => {
+  const { cloudEnvId, appVersion } = getEnvInfo();
+  const timestamp = Date.now();
+  const random = Math.random()
+    .toString()
+    .slice(2, 7);
+  const sourceId = 7; // 6 未知 7 云函数 8 出行 9 我的车
+
+  const mergedData = {
+    ...data,
+    timestamp,
+    seqId: `${timestamp}${sourceId}${random}`, // 补充seqId参数
+    appVersion, // 补充appVersion参数
+  };
+
+  if (withAuth) { // 补充userId， token参数
+    const { userId, token } = await getAuthInfo();
+    Object.assign(mergedData, { userId, token });
+  }
+
+  const res = await new Promise((resolve, reject) => {
+    wx.cloud.callFunction({
+      name,
+      data: mergedData,
+      config: { env: cloudEnvId },
+      success: resolve,
+      fail: (err) => {
+        reject({ err, name, mergedData });
+      },
+    });
+  });
+
+  return res;
+};

package/src/config.js

@@ -0,0 +1,86 @@
+/**
+ * 小程序云控配置实现
+ */
+import Request from './request';
+import { getEnvInfo } from './env';
+
+const parseAllCfgs = (configPaths, resData, defaultCfgs) => configPaths.map((path, index) => {
+  const found = resData.find(cfg => cfg.configPath === path);
+  if (found) {
+    return JSON.parse(found.configValue);
+  }
+  if (defaultCfgs && defaultCfgs[index]) {
+    return defaultCfgs[index];
+  }
+  return {}; // 没找到配置，返回一个空对象
+});
+
+/**
+ * getConfig 批量拉取配置
+ * @description 拉取运营平台上的配置内容。关于运营平台的具体用法，参见{@link https://iwiki.woa.com/pages/viewpage.action?pageId=527948584}
+ * @category 配置相关
+ * @example <caption>拉取单个配置</caption>
+ * const cfg = await app.tms.getConfig('/${client}/violation/subscribe', {}, { title: '当前城市不支持订阅'})
+ * console.log(cfg); // 成功则返回服务端存储的配置，失败返回默认值
+ * @example <caption>批量拉取配置</caption>
+const cfgs = await app.tms.getConfig([
+  '/${client}/home/service',
+  '/${client}/home/navbar',
+], {}, [
+  [
+    { caption: '违章代缴', icon: 'violation.png' }
+  ],
+  { title: '晚上好，欢迎~' }
+]);
+console.log(cfgs); // 成功则返回服务端存储的配置，失败返回默认值
+ * @param {String|Array} configPath 配置路径，单个路径或配置路径数组，支持替换${client}为当前小程序。例如在出行小程序，${client}会变替换为sinan
+ * @param {Object} extendAttr 扩展属性，传给配置服务用于检索哪个版本的配置适用于当前用户。
+ * @param {Object} [defaultCfg] 默认配置，请求失败返回默认值。
+ * @returns {Promise<Object|Array<Object>>}
+ * 有默认值时，请求失败返回默认值。无默认值时，请求失败返回Promise.reject
+ */
+function getConfig(configPath, extendAttr = {}, defaultCfg) {
+  if (Array.isArray(configPath)) { // 复数形式
+    if (defaultCfg) { // 有默认值
+      if (!Array.isArray(defaultCfg) || configPath.length !== defaultCfg.length) {
+        throw new Error('配置路径和默认值的数组长度不一致');
+      }
+    }
+  }
+  const configPaths = Array.isArray(configPath) ? configPath : [configPath];
+  const defaultCfgs = (defaultCfg && (Array.isArray(defaultCfg) ? defaultCfg : [defaultCfg])) || null;
+  const { client } = getEnvInfo();
+  configPaths.forEach((path, index) => {
+    configPaths[index] = path.replace(/\$\{client\}/, client);
+  });
+  const extendAttrs = typeof extendAttr === 'string' ? extendAttr : JSON.stringify(extendAttr);
+  const api = new Request();
+  return api.post('marketing/config', {
+    extendAttrs,
+    configPaths,
+  })
+    .then((res = {}) => {
+      const { errCode, resData } = res || {};
+      if (resData && resData.length > 0) {
+        const parsed = parseAllCfgs(configPaths, resData, defaultCfgs);
+        if (Array.isArray(configPath)) {
+          return parsed;
+        }
+        return parsed[0];
+      }
+      if (defaultCfgs) {
+        return Array.isArray(configPath) ? defaultCfgs : defaultCfgs[0];
+      }
+      return Promise.reject({ errCode, resData, msg: `获取${configPaths.join(',')}配置失败，接口调用出错` });
+    })
+    .catch((e) => {
+      if (defaultCfgs) {
+        return Promise.resolve(Array.isArray(configPath) ? defaultCfgs : defaultCfgs[0]);
+      }
+      return Promise.reject({ err: e, msg: `获取${configPaths.join(',')}配置失败，接口调用出错` });
+    });
+}
+
+export {
+  getConfig,
+};

package/src/env.js

@@ -0,0 +1,116 @@
+
+const env = {
+  wxAppId: '', // 当前运行时小程序的appId
+  appVersion: '', // 当前运行时所在项目的版本号
+  appEnv: '', // 运行环境 test - 测试、production - 正式
+  client: '', // 运行时项目名，sinan - 腾讯出行服务； mycar - 我的车小程序
+  cloudEnvId: '', // 运行云函数的环境id
+};
+
+let baseAuthInfo = undefined;
+const getAuthInfoQueue = [];
+
+/**
+ * @description 设置用户信息
+ * @param {Object} authInfo 用户信息
+ * @param {Object} err err
+ * @returns {Void} 无返回值
+ */
+export const setAuthInfo = (authInfo, err) => {
+  baseAuthInfo = authInfo;
+  while (getAuthInfoQueue.length) {
+    const pro = getAuthInfoQueue.shift();
+    if (err) {
+      pro.reject(err);
+    } else {
+      pro.resolve(baseAuthInfo);
+    }
+  }
+};
+/**
+ * 获取登录状态信息
+ * @returns {Object} 当前用户状态参数
+ */
+export const getAuthInfo = async () => {
+  if (baseAuthInfo !== undefined) {
+    return baseAuthInfo;
+  }
+  return new Promise((resolve, reject) => getAuthInfoQueue.push({ resolve, reject }));
+};
+
+/**
+ * tms.getEnvInfo 用于获取运行时所在的环境信息
+ * @returns {object} 运行时环境信息.
+ */
+export const getEnvInfo = () => env;
+/**
+ * 设置环境变量
+ * @param {object} envInfo 环境变量
+ * @returns {undefined} 无.
+ */
+export const setEnvInfo = (envInfo) => {
+  const { wxAppId, appVersion, appEnv, client, cloudEnvId } = envInfo;
+  env.wxAppId = wxAppId;
+  env.appVersion = appVersion;
+  env.appEnv = appEnv;
+  env.client = client;
+  env.cloudEnvId = cloudEnvId;
+};
+
+let appPagePaths = []; // app页面路径集合
+let homePageInfo = null; // 首页信息 { isTab, path, tabs }
+
+/**
+ * 获取app内所有页面的路径
+ * @returns {Array<String>} 页面路径集合
+ */
+export const getAppPagePaths = () => appPagePaths;
+
+/**
+ * 设置app内所有页面的路径
+ * @param {Array<String>} paths    页面路径集合
+ * @param {Object|null}   homePage 首页信息
+ * @param {Boolean}       homePath.isTab 首页是否tab页
+ * @param {String}        homePath.path  首页页面路径（isTab=false时使用此字段）
+ * @param {Array<String>} homePath.tabs  tab页面路径列表（isTab=true时使用自此段）
+ * @returns {void}
+ */
+export const setAppPagePaths = (paths, homePage) => {
+  appPagePaths = paths;
+  const { isTab = false, path = '', tabs = [] } = homePage || {};
+  homePageInfo = { isTab, path, tabs };
+};
+
+/**
+ * 判断页面是否存在于当前app中
+ * @param {String} page 页面路径
+ * @returns {Boolean} 页面是否存在app中
+ */
+export const isAppPageExist = (page) => {
+  const route = !page ? '' : String(page).split('?')[0];
+  if (!route || !Array.isArray(appPagePaths)) return false;
+  const routeWithoutPrefixSlash = route[0] === '/' ? route.substring(1) : route;
+  return appPagePaths.some(path => path === routeWithoutPrefixSlash || path === `/${routeWithoutPrefixSlash}`);
+};
+
+// 以下变量标识各小程序appId
+const MOBILITY_APPID = 'wx65cc950f42e8fff1';      // 出行服务小程序AppId
+const MOBILITY_DEMO_APPID = 'wxa7ce727b525f80b0'; // 出行服务demo小程序AppId
+const SINAN_HOME = '/modules/index/carlife/pages/index/index'; // 出行首页地址
+const MYCAR_HOME = '/modules/car/index/index'; // 我的车首页地址
+
+/**
+ * 获取首页信息
+ * @returns {Object|null}   homePage 首页信息
+ * @returns {Boolean}       homePath.isTab 首页是否tab页
+ * @returns {String}        homePath.path  首页页面路径（isTab=false时使用此字段）
+ * @returns {Array<String>} homePath.tabs  tab页面路径列表（isTab=true时使用自此段）
+ */
+export const getHomePage = () => {
+  if (homePageInfo) return homePageInfo;
+  // 返回默认信息
+  const mpAppId = wx.getAccountInfoSync()?.miniProgram?.appId;
+  const homePagePath = [MOBILITY_APPID, MOBILITY_DEMO_APPID].indexOf(mpAppId) > -1 ? SINAN_HOME : MYCAR_HOME;
+  homePageInfo = { isTab: false, path: homePagePath, tabs: [] };
+  return homePageInfo;
+};

package/src/eventDispatcher.js

@@ -0,0 +1,95 @@
+/* eslint-disable require-jsdoc */
+/**
+ * Copyright 2017-present, Tencent, Inc.
+ * All rights reserved.
+ *
+ * @desc: 自定义事件机制
+ * @author: kexinwu@tencent.com
+ *
+ */
+
+/**
+ * EventDispatcher 类 事件监听器
+ * @class EventDispatcher
+ * @classdesc 用于统一维护小程序的事件
+ */
+export default class EventDispatcher {
+  constructor() {
+    this.handlers = [];
+  }
+
+  /**
+   * @memberof EventDispatcher
+   * @param {String} type 事件名
+   * @param {Function} handler 事件处理函数
+   * @returns {Function} handler 事件处理函数
+   */
+  bind(type, handler) {
+    if (typeof this.handlers[type] === 'undefined') {
+      this.handlers[type] = [];
+    }
+    this.handlers[type].push(handler);
+  }
+
+  /**
+   * @memberof EventDispatcher
+   * @param       {String} type 事件名
+   * @param       {Function} handler 事件处理函数
+   * @returns     {Function} handler 事件处理函数
+   */
+  bindOnce(type, handler) {
+    if (typeof this.handlers[type] === 'undefined') {
+      this.handlers[type] = [];
+    }
+
+    const isBinded = this.handlers[type].length === 0;
+
+    if (isBinded) {
+      this.handlers[type].push(handler);
+    }
+  }
+
+  /**
+   * @memberof EventDispatcher
+   * @param {String} type 事件名
+   * @returns {Void} 无返回值
+   */
+  remove(type) {
+    this.handlers[type] = [];
+  }
+
+  /**
+   * @memberof EventDispatcher
+   * @param       {String} type 事件名
+   * @param       {Function} handler 事件处理函数
+   * @returns {Void} 无返回值
+   */
+  unbind(type, handler) {
+    if (this.handlers[type] instanceof Array) {
+      const handlers = this.handlers[type];
+
+      let i = 0;
+      const l = handlers.length;
+      for (; i < l; i += 1) {
+        if (handlers[i] === handler) {
+          break;
+        }
+      }
+
+      handlers.splice(i, 1);
+    }
+  }
+
+  /**
+   * @memberof EventDispatcher
+   * @param  {Object} evt 事件描述
+   * @param  {String} evt.type 事件类型
+   * @returns     {Function} handler 事件处理函数
+   */
+  dispatch(evt) {
+    if (this.handlers[evt.type] instanceof Array) {
+      const handlers = this.handlers[evt.type];
+      handlers.forEach(handler => handler(evt));
+    }
+  }
+}

package/src/fastreport.js

@@ -0,0 +1,77 @@
+/**
+ * @copyright 2020-present, Tencent, Inc. All rights reserved.
+ * @author Fenggang.Sun <fenggangsun@tencent.com>
+ * @file 快速上报数据，不处理过多逻辑，保证快速上报
+ */
+import Request from './request';
+import { getEnvInfo } from './env';
+import Sync from './syncfnmanager';
+
+let simulatedUserIdCache; // 模拟用户id在内存里的缓存
+
+const getSystemInfo = () => {
+  const system = Sync.getSystemInfoSync();
+  const { model = '', version: wxVersion = '', platform = '', SDKVersion = '', host = '' } = system;
+
+  return { model, wxVersion, platform, SDKVersion, host };
+};
+
+/**
+ * @class FastReport
+ * @classdesc 快速上报模块，不依赖用户标识和位置
+ */
+export default class FastReport {
+  /**
+   * @memberof FastReport
+   * @description 快速上报
+   * @param {Object} param 埋点数据
+   * @param {Boolean} simulatedUserId 是否上报模拟用户Id
+   * @param {Number} simulatedUserIdIndex 上报模拟用户ID时放在哪个字段
+   * @param {Boolean} reportShowScene 是否上报小程序onShow场景值
+   * @param {Boolean} appVer 是否上报小程序版本
+   * @returns {Promsie} 返回上报结果
+   */
+  static report(param, simulatedUserId = true, simulatedUserIdIndex = 40, reportShowScene = true, appVer = true) {
+    if (!param?.[27]) return Promise.reject('invalid report param');
+    const data = new Array(41);
+    const env = getEnvInfo();
+    Object.keys(param).forEach((key) => {
+      data[key] = param[key] === null ? '' : JSON.stringify(param[key]);
+    });
+    data[9] = '2';
+    data[33] = getSystemInfo();
+    appVer && !data[10] && (data[10] = env.appVersion);
+    if (!data[26]) data[26] = data[27]?.[0];
+    data[28] = env.client;
+    if (reportShowScene && !data[29]) {
+      const appShowScene = wx.getStorageSync('appShowScene');
+      if (appShowScene) data[29] = String(appShowScene);
+    }
+    if (simulatedUserId && !data[simulatedUserIdIndex]) {
+      data[simulatedUserIdIndex] = FastReport.getSimulatedUserId();
+    }
+
+    return new Request({ withAuth: false }).post('basic/event/upload', { batch: [data] })
+      .catch(() => null);
+  }
+
+  /**
+   * @memberof FastReport
+   * @description 获取模拟的用户身份标识
+   * @returns {String} 用户的临时标识
+   */
+  static getSimulatedUserId() {
+    // 优先使用内存级缓存
+    if (simulatedUserIdCache) return simulatedUserIdCache;
+    const key = 'SimulatedUserKey';
+    // 读取本地缓存记录的值
+    simulatedUserIdCache = wx.getStorageSync(key);
+    if (simulatedUserIdCache) return simulatedUserIdCache;
+    // 生成新的值
+    const nonce = Math.random().toString(36)
+      .substr(2, 10);
+    simulatedUserIdCache = `${Date.now()}_${nonce}`;
+    wx.setStorage({ key, data: simulatedUserIdCache });
+    return simulatedUserIdCache;
+  }
+};

package/src/index-proxy.js

@@ -0,0 +1,214 @@
+/**
+ * 由于需要把tms-core、tms-runtime从主包中移到vendor分包中使用分包异步化加载，
+ * 但是很多分包中都会立即调用getApp().tms的接口，为了保证调用不出错，
+ * 特地新增此代理js，用于在app.js中先挂在到app.tms下，等vendor加载完再替换掉。
+ * 注意：tms-core、tms-runtime有改动都要来这里确认proxy有没有问题。
+ */
+
+import syncApi from './syncfnmanager';
+import md5 from './md5';
+import { rpxToPx } from './rpx';
+import { serialize } from './objUtils';
+import * as stringUtils from './stringUtils';
+import * as timeUtils from './timeUtils';
+import * as ipxHelper from './ipxHelper';
+
+let app = null;
+let initOptions = null;
+let tmsPromise = null;
+let tms = null;
+let logger = null;
+
+function invoke(obj, funcName, args) {
+  if (obj[funcName]) {
+    return obj[funcName](...args);
+  }
+
+  // 非法调用的时候就要及时上报日志，方便解决问题
+  if (!logger) {
+    logger = wx.getRealtimeLogManager();
+  }
+  const msg = `tms-proxy: Cannot read property ${funcName}`;
+  logger.addFilterMsg('tms-proxy');
+  logger.error(msg);
+  console.error(msg);
+  return Promise.reject(msg);
+}
+
+function initProxy(appObj, options) {
+  app = appObj;
+  initOptions = options;
+}
+
+function awaitTMS() {
+  if (tmsPromise === null) {
+    tmsPromise = new Promise((resolve) => {
+      app.initPromise.then((res) => {
+        tms = res;
+        resolve(res);
+      });
+    });
+  }
+  return tmsPromise;
+}
+
+// 返回Promise的函数，无返回结果的也可以放这里
+const asyncFuncs = {};
+const asyncFuncNames = [
+  // 这行是tms-ui的
+  'showDrawer', 'hideDrawer', 'showModal', 'hideModal',
+  // 这行是tms-runtime的
+  'getPhone', 'login', 'getLoginInfo', 'getOpenId', 'getMycarPubOpenId', 'getSinanPubOpenId',
+  // tms-core
+  'setAuthInfo', 'getConfig', 'navigateToWebview', 'callCloudFunc',
+  'setUserLocation', 'getUserLocation', 'getMpOpenId', 'getOuterOpenId',
+];
+asyncFuncNames.forEach((funcName) => {
+  asyncFuncs[funcName] = function (...args) {
+    return awaitTMS().then(tms => invoke(tms, funcName, args));
+  };
+});
+
+// 返回对象的函数，并且对象的所有接口都可以以promise的形式返回
+const objFuncs = {};
+const objFuncNames = [
+  'getLogManager', 'getRealtimeLogManager', 'getReporter',
+  'getFastReporter', 'getEventDispatcher',
+];
+objFuncNames.forEach((funcName) => {
+  objFuncs[funcName] = function (...args1) {
+    const ps = awaitTMS().then(tms => invoke(tms, funcName, args1));
+    return new Proxy({}, {
+      get(obj, name) {
+        return function (...args2) {
+          return ps.then(funcObj => invoke(funcObj, name, args2));
+        };
+      },
+    });
+  };
+});
+
+// tms-runtime
+function getCarManager() {
+  return {
+    getCarInfo() {
+      if (tms) {
+        return tms.getCarManager().getCarInfo();
+      }
+      return wx.getStorageSync('currentCar') || {};
+    },
+    setCarInfo(param = {}) {
+      awaitTMS().then(tms => tms.getCarManager().setCarInfo(param));
+    },
+    getCarList() {
+      return awaitTMS().then(tms => tms.getCarManager().getCarList());
+    },
+  };
+}
+
+function getLocationManager() {
+  let manager = null;
+  const ps = awaitTMS().then((tms) => {
+    manager = tms.getLocationManager();
+  });
+  let currLoc = null;
+  const getUserLocation = () => {
+    if (manager) {
+      return manager.getUserLocation();
+    }
+    return currLoc;
+  };
+  const setUserLocation = (loc) => {
+    if (manager) {
+      manager.setUserLocation(loc);
+    } else if (loc && (typeof loc === 'object')) {
+      currLoc = loc;
+      ps.then(() => manager.setUserLocation(loc));
+    }
+  };
+  return new Proxy({}, {
+    get(obj, name) {
+      if (name === 'getUserLocation') {
+        return getUserLocation;
+      }
+      if (name === 'setUserLocation') {
+        return setUserLocation;
+      }
+      return function (...args) {
+        return ps.then(() => invoke(manager, name, args));
+      };
+    },
+  });
+}
+
+function createRequest(config = {}) {
+  let request = null;
+  const ps = awaitTMS().then((tms) => {
+    request = tms.createRequest(config);
+  });
+  const makeUrl = (path) => {
+    if (request) {
+      return request.makeUrl(path);
+    }
+    if ((/^http/i).test(path)) {
+      return path;
+    }
+    const host = config?.host || initOptions.defaultHost;
+    const validHost = (/^http/i).test(host) ? host : `https://${host}`;
+    return `${validHost}/${path}`;
+  };
+  return new Proxy({}, {
+    get(obj, name) {
+      if (name === 'makeUrl') {
+        return makeUrl;
+      }
+      return function (...args) {
+        return ps.then(() => invoke(request, name, args));
+      };
+    },
+  });
+}
+
+function getEnvInfo() {
+  if (tms) {
+    return tms.getEnvInfo();
+  }
+  const { wxAppId, appVersion, appEnv, client } = initOptions;
+  return { wxAppId, appVersion, appEnv, client };
+}
+
+function isAppPageExist(...args) {
+  if (tms) {
+    return tms.isAppPageExist(...args);
+  }
+  return true; // todo: 可能不正确
+}
+
+function getHomePage() {
+  if (tms) {
+    return tms.getHomePage();
+  }
+  return initOptions.homePage;
+}
+
+const api = {
+  isProxy: true, // 方便定位问题时判断是否proxy
+  initProxy,
+  md5,
+  getCarManager,
+  getLocationManager,
+  rpxToPx,
+  serialize,
+  createRequest,
+  getEnvInfo,
+  isAppPageExist,
+  getHomePage,
+  ...asyncFuncs,
+  ...objFuncs,
+  ...syncApi,
+  ...stringUtils,
+  ...timeUtils,
+  ...ipxHelper,
+};
+
+export default api;

package/src/index-proxy.test.js

@@ -0,0 +1,19 @@
+import tmsProxy from './index-proxy';
+
+describe('tmsProxy', () => {
+  beforeAll(() => {
+    tmsProxy.initProxy({
+      initPromise: new Promise(() => {}),
+    }, {});
+  });
+
+  it('tmsProxy.getCarManager test', () => {
+    const car = tmsProxy.getCarManager();
+    expect(car).toBeInstanceOf(Object);
+  });
+
+  it('tmsProxy.createRequest test', () => {
+    const request = tmsProxy.createRequest();
+    expect(request).toBeInstanceOf(Object);
+  });
+});