@jolibox/implement 1.1.13-beta.1 → 1.1.13-beta.3

package/src/native/js-bridge/invoke.ts

@@ -1,208 +0,0 @@
-import { pack, unpack } from './utils';
-import { Deferred, isObject, isPromiseLike, InternalApplyNativeError, logger } from '@jolibox/common';
-import { formatErrorCode } from '../../common/report/errors';
-import { BACKGROUND_FORBIDDEN_METHODS, BUFFER_METHODS, SYNC_METHODS } from './const';
-import { createReportInvokeMetrics } from './report';
-import { InvokeHandler, On } from './types';
-
-import { AnyFunction } from '@jolibox/types';
-
-interface Invokes {
-  /** 暴露给宿主, 触发调用的方法 */
-  invokeHandler: InvokeHandler;
-  /** 基础库内部, 调用宿主的方法, 返回 native 返回对象 */
-  invokeNative: (method: string, args?: Record<string, unknown>, webviewId?: number) => any;
-  /** 基础库内部, 调用宿主的方法, 会根据 errMsg throwError */
-  applyNative: (method: string, args?: Record<string, unknown>, webviewId?: number) => any;
-}
-
-type Response = {
-  errMsg: string;
-  errNo?: number;
-  __timing?: {
-    receiveJSInvoke: number;
-    invokeCallback: number;
-  };
-} & Record<string, unknown>;
-
-// 后台期间积压的请求
-const asyncInvokes: {
-  method: string;
-  args?: Record<string, unknown>;
-  resolve: AnyFunction;
-}[] = [];
-
-//TODO: support arrayBuffer
-const NOT_SUPPORT_ARRAY_BUFFER = false;
-
-export function createInvoke(jsCore: jsb.JSCore, onNative: On): Invokes {
-  let resolveId = 0;
-  let IS_FOREGROUND = true;
-
-  const resolveMap = new Map<number, AnyFunction>();
-  const reportInvokeMetrics = createReportInvokeMetrics(jsCore, onNative);
-
-  onNative('onJoliboxEnterBackground', () => {
-    IS_FOREGROUND = false;
-  });
-
-  onNative('onJoliboxEnterForeground', () => {
-    IS_FOREGROUND = true;
-    // 从后台进入前台后, 处理之前在后台挤压的任务
-    asyncInvokes.forEach(async ({ method, args, resolve }) => {
-      const res = await invokeNative(method, args);
-      resolve(res);
-    });
-    // 清空积压
-    asyncInvokes.length = 0;
-  });
-
-  const invokeHandler: InvokeHandler = (resolveId, data): void => {
-    /**
-     * Android resolveId 是 `string`
-     * iOS 上待确认, IDE 上是 `number`
-     */
-    const resolve = resolveMap.get(Number(resolveId));
-    if (!resolve) return;
-    const response = unpack(data);
-    resolve(response);
-    resolveMap.delete(Number(resolveId));
-  };
-
-  const invokeNative = (
-    method: string,
-    args?: Record<string, unknown>
-  ): Record<string, unknown> | Promise<Record<string, unknown>> => {
-    const startTime = Date.now();
-    const isForeground = `${IS_FOREGROUND}`;
-
-    resolveId += 1;
-
-    const deferred = new Deferred<Response>();
-    resolveMap.set(resolveId, deferred.resolve);
-
-    if (!IS_FOREGROUND && BACKGROUND_FORBIDDEN_METHODS.includes(method)) {
-      // `FOREGROUND_FORBIDDEN_EVENTS` all async API
-      return new Promise<Record<string, unknown>>((resolve) => {
-        asyncInvokes.push({ method, args, resolve });
-      });
-    }
-
-    const basicReportParam = {
-      method,
-      startTime,
-      args,
-      isForeground
-    };
-
-    const invokeReportParam = {
-      ...basicReportParam,
-      invokeType: 'js-bridge'
-    } as const;
-
-    const useArrayBuffer = !NOT_SUPPORT_ARRAY_BUFFER && BUFFER_METHODS.includes(method);
-
-    const payload = pack(args, useArrayBuffer);
-    const params = useArrayBuffer ? payload : JSON.stringify(payload);
-
-    /** 调用结果 */
-    let response;
-
-    if (method.endsWith('Sync') || SYNC_METHODS.includes(method)) {
-      response = jsCore.call?.(method, payload, resolveId);
-    } else {
-      if (typeof params === 'string') {
-        response = jsCore.invoke(method, params, resolveId);
-      } else {
-        response = jsCore.call?.(method, params, resolveId);
-      }
-    }
-
-    /**
-     * 如果 invoke 返回了结果，则为同步调用
-     * - iOS 返回 `undefined`
-     * - Android 返回空字符串 `""`
-     */
-    if (response) {
-      try {
-        if (typeof response === 'string') {
-          response = JSON.parse(response);
-        }
-        response = unpack(response);
-      } catch (error) {
-        logger.error(error);
-      }
-      resolveMap.delete(resolveId);
-      if (response.errorCode) {
-        response.errorCode = formatErrorCode(method, response.errorCode);
-      }
-      reportInvokeMetrics({ ...invokeReportParam, ...response });
-
-      return response;
-    }
-
-    if (method.endsWith('Sync')) {
-      resolveMap.delete(resolveId);
-    }
-
-    return deferred.promise.then((response) => {
-      if (response.errorCode) {
-        response.errorCode = formatErrorCode(method, response.errorCode as number | undefined);
-      }
-      reportInvokeMetrics({ ...invokeReportParam, ...response });
-      return response;
-    });
-  };
-
-  const applyNative = (method: string, arg?: Record<string, unknown>) => {
-    const res = invokeNative(method, arg);
-    if (isPromiseLike(res)) {
-      return res.then((r) =>
-        ifThrowError(
-          method,
-          r as {
-            errMsg?: string;
-            errNo?: number;
-            errorType?: string;
-            errorCode?: number;
-          }
-        )
-      );
-    }
-    return ifThrowError(method, res);
-  };
-
-  return {
-    invokeNative,
-    applyNative,
-    invokeHandler
-  };
-}
-
-export function ifThrowError(
-  method: string,
-  res: {
-    errMsg?: string;
-    errNo?: number;
-    errorType?: string;
-    errorCode?: number;
-  }
-) {
-  if (!isObject(res)) {
-    logger.warn(`[Jolibox SDK]${method} no response value`);
-    return;
-  }
-  const { errMsg, errNo, errorType, errorCode, ...data } = res;
-
-  if (errMsg && errMsg !== `${method}:ok`) {
-    throw new InternalApplyNativeError(errMsg, errNo, errorType, errorCode);
-  }
-
-  return data;
-}
-
-export class ApplyNativeError extends Error {
-  constructor(message: string, readonly errNo?: number) {
-    super(message);
-  }
-}

package/src/native/js-bridge/js-bridge.ts

@@ -1,28 +0,0 @@
-import { createInvoke } from './invoke';
-import { createSubscribe } from './subscribe';
-import { JSBridge } from './types';
-import { createPublish } from './publish';
-
-/**
- * build js-bridge
- * @param jsCore jsCore function inject by native
- */
-export function createBridge(jsCore: jsb.JSCore): JSBridge {
-  const { subscribeHandler, onNative, offNative, subscribe, unsubscribe } = createSubscribe(jsCore);
-
-  const { invokeNative, invokeHandler, applyNative } = createInvoke(jsCore, onNative);
-  const publish = createPublish(jsCore);
-
-  return {
-    // 宿主调用
-    invokeHandler,
-    subscribeHandler,
-    applyNative,
-    invokeNative,
-    onNative,
-    offNative,
-    publish,
-    subscribe,
-    unsubscribe
-  };
-}

package/src/native/js-bridge/publish.ts

@@ -1,44 +0,0 @@
-import { CUSTOM_EVENT_PREFIX, BATCH_EVENT } from './const';
-
-type BatchEvent = [event: string, data: unknown];
-type BatchEvents = BatchEvent[];
-
-export function createPublish(jsCore: jsb.JSCore) {
-  const eventsMap = new Map<number | undefined, BatchEvents>();
-  let batchTask: Promise<void> | undefined;
-  const publish = (event: string, data: Record<string, unknown>, webviewId?: number, force?: boolean) => {
-    if (force) {
-      const ids = webviewId ? [webviewId] : '*';
-      jsCore.publish(`${CUSTOM_EVENT_PREFIX}${event}`, data, ids);
-      return;
-    }
-
-    if (!batchTask) {
-      batchTask = Promise.resolve().then(() => {
-        eventsMap.forEach((data, webviewId) => {
-          try {
-            const ids = webviewId ? [webviewId] : '*';
-            jsCore.publish(BATCH_EVENT, data, ids);
-          } catch {
-            // 避免一组 webview publish 的报错影响其他 webview publish
-          }
-        });
-
-        // reset
-        batchTask = undefined;
-        eventsMap.clear();
-      });
-    }
-
-    let events = eventsMap.get(webviewId);
-
-    if (!events) {
-      events = [];
-      eventsMap.set(webviewId, events);
-    }
-
-    events.push([`${CUSTOM_EVENT_PREFIX}${event}`, data]);
-  };
-
-  return publish;
-}

package/src/native/js-bridge/report.ts

@@ -1,311 +0,0 @@
-import { On } from './types';
-import { isObject, isString, InternalMetricReportError } from '@jolibox/common';
-
-type MetricReporter = (points: unknown) => unknown;
-interface MetricCache {
-  [props: string]: MetricCache | (number | string)[];
-}
-
-interface PVMetricCache {
-  [props: string]: PVMetricCache | number;
-}
-
-type MetricCacheType = MetricCache | PVMetricCache;
-type MetricType = 'pv' | 'default';
-type Prettier<T> = T extends Record<string, unknown> ? { [K in keyof T]: T[K] } : T;
-type MetricPoint<Tag extends string, Name extends string> = Prettier<
-  {
-    [k in Tag]: string;
-  } & {
-    [K in Name]: number | string;
-  }
->;
-
-interface PVPoint {
-  [props: string]: string | JSON;
-}
-
-const getType = (type: unknown): MetricType => {
-  if (type === 'pv') return type;
-  return 'default';
-};
-
-interface MetricConfig<Tag extends string, Name extends string, Type extends string> {
-  reporter: MetricReporter;
-  interval?: number;
-  eventName: string;
-  tagNameOrder: Tag[];
-  metricName: Name;
-  type?: Type;
-}
-
-export class MetricsMonitor<Tag extends string, Name extends string, Type extends string> {
-  reporter: MetricReporter;
-  interval = 30;
-  lastReportTime = 0;
-  cache: MetricCacheType = {};
-  eventName: string;
-  tagNameOrder: Tag[];
-  metricName: Name;
-  type: MetricType;
-
-  constructor(config: MetricConfig<Tag, Name, Type>) {
-    const { reporter, interval = 30, eventName, tagNameOrder, metricName, type } = config;
-    this.reporter = reporter;
-    this.interval = interval;
-    this.eventName = eventName;
-    this.tagNameOrder = tagNameOrder;
-    this.metricName = metricName;
-    this.type = getType(type);
-  }
-
-  report(point: Type extends 'pv' ? PVPoint : MetricPoint<Tag, Name>) {
-    if (this.type === 'pv') {
-      this.addPVPoint(point);
-    } else {
-      this.addPoint(point as MetricPoint<Tag, Name>);
-    }
-
-    this.tryReport(false);
-  }
-
-  flush() {
-    this.tryReport(true);
-  }
-
-  private tryReport(force: boolean) {
-    if (!Object.keys(this.cache).length) {
-      return;
-    }
-
-    if (force) {
-      this.reporter(this.processPoints(this.cache));
-      this.clearPoints();
-      return;
-    }
-
-    this.lastReportTime = this.lastReportTime || Date.now();
-
-    if (Date.now() - this.lastReportTime >= this.interval * 1000) {
-      this.reporter(this.processPoints(this.cache));
-      this.clearPoints();
-      this.lastReportTime = Date.now();
-    }
-  }
-
-  private addPoint(point: MetricPoint<Tag, Name>) {
-    const safeSetVal = (
-      target: MetricCache,
-      props: Tag[],
-      metricName: Name,
-      point: MetricPoint<Tag, Name>
-    ) => {
-      const currentProp = props.shift();
-      if (currentProp) {
-        const currentVal = point[currentProp];
-        if (!target[currentVal]) target[currentVal] = {};
-
-        safeSetVal(target[currentVal] as MetricCache, props, metricName, point);
-      } else {
-        if (!target[metricName]) target[metricName] = [];
-        (target[metricName] as unknown[]).push(point[metricName]);
-      }
-    };
-
-    safeSetVal(this.cache as MetricCache, [...this.tagNameOrder], this.metricName, point);
-  }
-
-  private addPVPoint(point: PVPoint) {
-    const safeSetVal = (
-      target: Record<string, unknown>,
-      props: Tag[],
-      metricName: Name,
-      relation: unknown
-    ) => {
-      const currentProp = props.shift();
-
-      if (!currentProp && isObject(relation)) {
-        throw new InternalMetricReportError(
-          `report value failed to match tagNameOrder, ${JSON.stringify(originParams)}`
-        );
-      }
-
-      if (currentProp) {
-        const keys: string[] = [];
-        if (isObject(relation)) {
-          keys.push(...Object.keys(relation));
-        } else if (isString(relation)) {
-          if (props.length > 0) {
-            throw new InternalMetricReportError(
-              `report value failed to match tagNameOrder, ${JSON.stringify(originParams)}`
-            );
-          }
-
-          keys.push(relation);
-        } else {
-          throw new InternalMetricReportError(
-            `expected metric value to be a string, but got a(n) ${typeof relation}, ${JSON.stringify(
-              originParams
-            )}`
-          );
-        }
-
-        keys.forEach((key) => {
-          if (!target[key]) target[key] = {};
-          const value = isObject(relation) ? relation[key] : relation;
-          safeSetVal(target[key] as MetricCache, [...props], metricName, value);
-        });
-      } else {
-        if (!target[metricName]) {
-          target[metricName] = 1;
-        } else {
-          (target[metricName] as number)++;
-        }
-      }
-    };
-
-    const originParams = {
-      point,
-      metricName: this.metricName,
-      tagNameOrder: this.tagNameOrder
-    };
-    safeSetVal(this.cache, [...this.tagNameOrder], this.metricName, point);
-  }
-
-  private processPoints(points: MetricCacheType) {
-    return {
-      eventName: this.eventName,
-      tagNameOrder: this.tagNameOrder,
-      metricName: this.metricName,
-      metricAggregateType: this.type === 'pv' ? 'itoa' : 'arr',
-      data: points
-    };
-  }
-
-  private clearPoints() {
-    this.cache = {};
-  }
-}
-
-interface InvokeMetrics {
-  errMsg: string;
-  errNo?: number;
-  __timing?: {
-    receiveJSInvoke: number;
-    invokeCallback: number;
-  };
-  method: string;
-  startTime: number;
-  args?: Record<string, unknown>;
-  isForeground: string;
-
-  [prop: string]: unknown;
-}
-
-let monitorHasInitialized = false;
-let invokeMonitor: MetricsMonitor<
-  'status' | 'method' | 'errNo' | 'errMsg' | 'isForeground',
-  'duration',
-  'default'
->;
-let invokeJSToNativeMonitor: MetricsMonitor<'status' | 'method' | 'isForeground', 'duration', 'default'>;
-let invokeNativeToJSMonitor: MetricsMonitor<'status' | 'method' | 'isForeground', 'duration', 'default'>;
-
-export type reportInvokeFn = (invokeMetrics: InvokeMetrics) => void;
-
-export function createReportInvokeMetrics(jsCore: jsb.JSCore, onNative: On): reportInvokeFn {
-  if (!monitorHasInitialized) {
-    /** invoke 埋点 */
-    invokeMonitor = new MetricsMonitor({
-      eventName: 'jolibox_invoke',
-      tagNameOrder: ['status', 'method', 'errNo', 'errMsg', 'isForeground'],
-      metricName: 'duration',
-      reporter(data) {
-        jsCore.invoke('track', JSON.stringify({ event: 'reportMetrics', data }), -1);
-      }
-    });
-
-    /** invoke js -> native */
-    invokeJSToNativeMonitor = new MetricsMonitor({
-      eventName: 'jolibox_invoke_js2native',
-      tagNameOrder: ['status', 'method', 'isForeground'],
-      metricName: 'duration',
-      reporter(data) {
-        jsCore.invoke('track', JSON.stringify({ event: 'reportMetrics', data }), -1);
-      }
-    });
-
-    /** invoke native -> js */
-    invokeNativeToJSMonitor = new MetricsMonitor({
-      eventName: 'jolibox_invoke_native2js',
-      tagNameOrder: ['status', 'method', 'isForeground'],
-      metricName: 'duration',
-      reporter(data) {
-        jsCore.invoke('track', JSON.stringify({ event: 'reportMetrics', data }), -1);
-      }
-    });
-
-    onNative('onJoliboxEnterBackground', () => {
-      invokeMonitor.flush();
-      invokeJSToNativeMonitor.flush();
-      invokeNativeToJSMonitor.flush();
-    });
-
-    monitorHasInitialized = true;
-  }
-
-  function report(invokeMetrics: InvokeMetrics) {
-    const {
-      method,
-      args,
-      startTime,
-      isForeground,
-      errMsg = `${method}:fail no errMsg`,
-      errNo = 0,
-      __timing = {
-        receiveJSInvoke: 0,
-        invokeCallback: 0
-      }
-    } = invokeMetrics;
-    const { receiveJSInvoke, invokeCallback } = __timing;
-    const status = errMsg.match(/\S:(\S+)\s?/)?.[1] ?? 'fail';
-
-    // report sync
-    invokeMonitor.report({
-      status,
-      method: normalizeMethod(method, args),
-      errNo: `${errNo}`,
-      errMsg,
-      isForeground,
-      duration: Date.now() - startTime
-    });
-
-    if (startTime && receiveJSInvoke && invokeCallback) {
-      invokeJSToNativeMonitor.report({
-        status,
-        method,
-        isForeground,
-        duration: Number((receiveJSInvoke - startTime).toFixed(3))
-      });
-      invokeNativeToJSMonitor.report({
-        status,
-        method,
-        isForeground,
-        duration: Number((Date.now() - invokeCallback).toFixed(3))
-      });
-    }
-  }
-
-  function normalizeMethod(method: string, args?: Record<string, unknown>) {
-    // Reserve an interface;
-    // an API might be provided later to directly expose client-side methods to users.
-    if (method === 'callHostMethod' || method === 'callHostMethodSync') {
-      if (args?.method) {
-        return `${method}-${args.method}`;
-      }
-    }
-    return method;
-  }
-
-  return report;
-}

package/src/native/js-bridge/subscribe.ts

@@ -1,74 +0,0 @@
-import { EventEmitter, logger } from '@jolibox/common';
-import { DataObj, unpack } from './utils';
-import { Off, On } from './types';
-import { AnyFunction } from '@jolibox/types';
-import { MetricsMonitor } from './report';
-import { BATCH_EVENT, CUSTOM_EVENT_PREFIX } from './const';
-
-export interface Subscribes {
-  onNative: On;
-  offNative: Off;
-  subscribeHandler: AnyFunction;
-  subscribe: On;
-  unsubscribe: Off;
-}
-
-export function createSubscribe(jsCore: jsb.JSCore): Subscribes {
-  const nativeEmitter = new EventEmitter();
-  const customEmitter = new EventEmitter();
-  const publishMonitor = new MetricsMonitor({
-    eventName: 'jolibox_publish',
-    tagNameOrder: ['type', 'event'],
-    metricName: 'duration',
-    reporter(data) {
-      jsCore.invoke('track', JSON.stringify({ event: 'reportMetrics', data }), -1);
-    }
-  });
-
-  nativeEmitter.on('onJoliboxEnterBackground', () => {
-    publishMonitor.flush();
-  });
-
-  return {
-    onNative: nativeEmitter.on.bind(nativeEmitter),
-    offNative: nativeEmitter.off.bind(nativeEmitter),
-    subscribe: customEmitter.on.bind(customEmitter),
-    unsubscribe: customEmitter.off.bind(customEmitter),
-    subscribeHandler(event, data, webviewId) {
-      // ios: jsc 端基于系统方法，前端接受到的 data 总是 string 类型, webview 基于 evaluateJavascript，前端接受到的 data 总是 object 类型
-      // android: 传入为 string 则接收到 string，传入为可序列化成功的 object，则接收到 object
-      const unpackedData = unpack(data);
-      let originalParams: undefined | DataObj;
-      if (unpackedData.__extra) {
-        originalParams = unpackedData.params;
-        const { type, startTime } = unpackedData.__extra;
-        publishMonitor.report({
-          type,
-          event,
-          duration: Date.now() - startTime // ms
-        });
-      } else {
-        originalParams = unpackedData;
-      }
-
-      if (event === BATCH_EVENT) {
-        const list = originalParams as [event: string, data: unknown][];
-        list.forEach((item) => {
-          const [_event, _data] = item;
-          try {
-            customEmitter.emit(_event.slice(CUSTOM_EVENT_PREFIX.length), _data, webviewId);
-          } catch {
-            // 忽略
-          }
-        });
-        return;
-      }
-
-      if (event.startsWith(CUSTOM_EVENT_PREFIX)) {
-        customEmitter.emit(event.slice(CUSTOM_EVENT_PREFIX.length), originalParams, webviewId);
-        return;
-      }
-      nativeEmitter.emit(event, originalParams, webviewId);
-    }
-  };
-}

package/src/native/js-bridge/types.ts

@@ -1,36 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Listener = (...args: any[]) => any;
-
-export type On = <T extends string>(event: T, handler: Listener) => void;
-
-export type Off = <T extends string>(event: T, handler: Listener) => void;
-
-export type InvokeHandler = (callbackId: string | number, data: string | Record<string, unknown>) => void;
-
-export type Publish = (
-  event: string,
-  data: Record<string, unknown>,
-  webviewId?: number,
-  force?: boolean
-) => void;
-
-export type SubscribeHandler = (
-  event: string,
-  data: string | Record<string, unknown>,
-  webviewId?: number
-) => void;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type AnyFunction = (...args: any[]) => any;
-
-export interface JSBridge {
-  invokeHandler: InvokeHandler;
-  subscribeHandler: SubscribeHandler;
-  invokeNative: jsb.service.InvokeNative;
-  applyNative: jsb.service.ApplyNative;
-  onNative: jsb.service.OnNative;
-  offNative: jsb.service.OffNative;
-  publish: Publish;
-  subscribe: On;
-  unsubscribe: Off;
-}