@jolibox/implement 1.1.10 → 1.1.11-beta.1

package/src/native/api/lifecycle.ts

@@ -1,8 +1,9 @@
-import { BaseError, createCommands, wrapUserFunction, hostEmitter } from '@jolibox/common';
+import { BaseError, createCommands, wrapUserFunction, hostEmitter, isBoolean } from '@jolibox/common';
 import { createAPI, createSyncAPI, registerCanIUse, t } from './base';
 import { reportError } from '@/common/report/errors/report';
-import { applyNative, onNative } from '../bootstrap/bridge';
+import { applyNative, onNative, publish } from '../bootstrap/bridge';
 import { nativeTaskEmitter } from '../report';
+import { context } from '@/common/context';
 
 const EXIT_GAME = 'exitGame';
 const ON_READY = 'onReady';
@@ -13,11 +14,22 @@ const commands = createCommands();
 
 const safeCallbackWrapper = wrapUserFunction(reportError as (err: Error | BaseError) => void);
 const exitGame = createAPI(EXIT_GAME, {
-  paramsSchema: t.tuple(t.function()),
-  implement: async (onBeforeExit: () => void) => {
+  paramsSchema: t.tuple(t.function(), t.boolean().optional().default(false)),
+  implement: async (onBeforeExit: () => void, shouldStay = false) => {
     const safeCallback = safeCallbackWrapper(onBeforeExit);
     // 集中上报
     safeCallback.call(this);
+    // 透传context.shouldInterupt 且值为false时，为内部小程序。广播onRetentionResult
+    if (isBoolean(context.shouldInterupt) && !context.shouldInterupt && context.from) {
+      publish(
+        'onRetentionResult',
+        {
+          shouldStay
+        },
+        context.from,
+        true
+      );
+    }
     await applyNative('exitAppAsync');
   }
 });

package/src/native/api/navigate.ts

@@ -0,0 +1,23 @@
+import { createCommands, UserCustomError } from '@jolibox/common';
+import { invokeNative } from '../bootstrap/bridge';
+import { createSyncAPI, t, registerCanIUse } from './base';
+
+const commands = createCommands();
+
+const openSchemaSync = createSyncAPI('openSchemaSync', {
+  paramsSchema: t.tuple(t.string()),
+  implement: (schema) => {
+    const res = invokeNative('openSchemaSync', {
+      schema
+    });
+    if (res.errNo !== 0) {
+      throw new UserCustomError(res.errMsg, res.errNo);
+    }
+  }
+});
+
+commands.registerCommand('API.openSchemaSync', openSchemaSync);
+
+registerCanIUse('openSchemaSync', {
+  version: '1.1.9'
+});

package/src/native/bootstrap/bridge.ts

@@ -38,7 +38,16 @@ const bridge = createBridge(core);
 
 const { invokeHandler } = bridge;
 
-export const { applyNative, invokeNative, onNative, offNative, subscribeHandler } = bridge;
+export const {
+  applyNative,
+  invokeNative,
+  onNative,
+  offNative,
+  subscribeHandler,
+  publish,
+  subscribe,
+  unsubscribe
+} = bridge;
 
 export const onNativeWithError: On = (event, handler) => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/native/bootstrap/index.ts

@@ -1,26 +1,56 @@
-import { invokeNative, onNative, RuntimeLoader } from './bridge';
+import { invokeNative, onNative, RuntimeLoader, subscribe } from './bridge';
 import { joliboxJSCore } from '../js-core';
 import { context } from '@/common/context';
 import { hostEmitter, isBoolean } from '@jolibox/common';
 import { taskTracker, track } from '../report';
 import { initializeNativeEnv } from './init-env';
 import { adEventEmitter } from '@/common/ads';
+import { openRetentionSchema } from './retention';
 
 let cleanStyles: () => void;
 RuntimeLoader.onReady(() => {
   // TODO: merge some env config
 });
 
-RuntimeLoader.doExit(() => {
+const doActualExit = () => {
   //埋点上报
   track('onBeforeExit', {
     timestamp: Date.now()
   });
   cleanStyles?.();
   taskTracker.close(Date.now() - start_timestamp);
+};
+
+/**
+ * 退出逻辑
+ * 1. 如果正在展示广告，则禁止退出
+ * 2. 如果指定退出挽留逻辑，则按照指定逻辑运行
+ * 3. 如果退出挽留逻辑返回 true，则按照指定逻辑运行
+ * 4. 否则，按照默认逻辑运行
+ */
+RuntimeLoader.doExit(async () => {
   if (isAdShowing) {
     return true; // Forbid exit on watching ads
   }
+
+  // 指定退出挽留逻辑，则按照指定逻辑运行
+  if (isBoolean(context.shouldInterupt)) {
+    // 不需要打断退出，上报埋点
+    if (!context.shouldInterupt) {
+      doActualExit();
+    }
+    return context.shouldInterupt;
+  }
+
+  // const stay = await openRetentionSchema();
+  // if (stay) {
+  //   // 挽留成功，打断退出
+  //   return true;
+  // }
+
+  // 退出，对应上报
+  //埋点上报
+  doActualExit();
   return false;
 });
 

package/src/native/bootstrap/retention.ts

@@ -0,0 +1,40 @@
+import { context } from '@/common/context';
+import { invokeNative, subscribe } from './bridge';
+import { Deferred } from '@jolibox/common';
+
+export async function openRetentionSchema() {
+  const { data } = invokeNative('envSync');
+  const { orientation, webviewId } = data;
+  let joliPayload: Record<string, unknown> = {
+    __mpType: 'miniApp',
+    __transparent: true,
+    // set entryPath
+    __orientation: orientation ?? 'VERTICAL', // 默认竖屏
+    __showStatusBar: false,
+    __shouldInterupt: false
+  };
+  if (webviewId) {
+    joliPayload = {
+      ...joliPayload,
+      __from: webviewId
+    };
+  }
+
+  const joliSource = context.encodeJoliSourceQuery(joliPayload);
+
+  const host = context.testMode ? 'stg-game.jolibox.com' : 'game.jolibox.com';
+  const retentionSchema = `https://${host}/game/G32115508989327465281365749294/?appId=G32115508989327465281365749294&joliSource=${joliSource}`;
+
+  const quitResultDeffer = new Deferred<boolean>();
+
+  subscribe('onRetentionResult', ({ shouldStay }) => {
+    quitResultDeffer.resolve(shouldStay);
+  });
+  // 异步
+  setTimeout(() => {
+    invokeNative('openSchemaSync', {
+      schema: retentionSchema
+    });
+  }, 0);
+  return quitResultDeffer.promise;
+}

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

@@ -9,3 +9,5 @@ export const BUFFER_METHODS: string[] = [];
 export const BACKGROUND_FORBIDDEN_METHODS: string[] = [];
 
 export const SYNC_METHODS: string[] = ['env', 'createRequestTask', 'login'];
+
+export const BATCH_EVENT = '__batch_event__';

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

@@ -1,15 +1,17 @@
 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 } = createSubscribe(jsCore);
+  const { subscribeHandler, onNative, offNative, subscribe, unsubscribe } = createSubscribe(jsCore);
 
   const { invokeNative, invokeHandler, applyNative } = createInvoke(jsCore, onNative);
+  const publish = createPublish(jsCore);
 
   return {
     // 宿主调用
@@ -18,6 +20,9 @@ export function createBridge(jsCore: jsb.JSCore): JSBridge {
     applyNative,
     invokeNative,
     onNative,
-    offNative
+    offNative,
+    publish,
+    subscribe,
+    unsubscribe
   };
 }

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

@@ -0,0 +1,44 @@
+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/subscribe.ts

@@ -1,17 +1,21 @@
-import { EventEmitter } from '@jolibox/common';
+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'],
@@ -28,6 +32,8 @@ export function createSubscribe(jsCore: jsb.JSCore): Subscribes {
   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
@@ -44,6 +50,24 @@ export function createSubscribe(jsCore: jsb.JSCore): Subscribes {
       } 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

@@ -7,6 +7,13 @@ 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>,
@@ -23,4 +30,7 @@ export interface JSBridge {
   applyNative: jsb.service.ApplyNative;
   onNative: jsb.service.OnNative;
   offNative: jsb.service.OffNative;
+  publish: Publish;
+  subscribe: On;
+  unsubscribe: Off;
 }

package/src/native/js-core/jolibox-js-core.ts

@@ -1,5 +1,5 @@
 import { InternalInvokeNativeError } from '@jolibox/common';
-// import { normalizeParams } from './utils';
+import { normalizeParams } from './utils';
 import { Env } from '@jolibox/types';
 import { reportError } from '@/common/report/errors/report';
 
@@ -23,6 +23,7 @@ declare global {
       invoke: (invokeString: string) => void;
       onDocumentReady: (paramsstr: string) => void;
       doExit: (uuidString: string) => void;
+      publish: (params: { event: string; webviewIds: number[] | '*'; paramsString: string }) => void;
     };
     webkit?: {
       messageHandlers: {
@@ -30,7 +31,7 @@ declare global {
           postMessage: (params: { event: string; callbackId: number; paramsString: string }) => void;
         };
         publish: {
-          postMessage: (params: { event: string; webviewIds: string; paramsString: string }) => void;
+          postMessage: (params: { event: string; webviewIds: number[] | '*'; paramsString: string }) => void;
         };
         onDocumentReady: {
           postMessage: (params: { path: string }) => void;
@@ -47,14 +48,14 @@ export const RuntimeLoader = {
   trigger() {
     // noop
   },
-  exit(): boolean {
+  exit(): Promise<boolean> {
     //noop
-    return false; // 默认不打断退出
+    return Promise.resolve(false); // 默认不打断退出
   },
   onReady(fn: () => void) {
     RuntimeLoader.trigger = fn;
   },
-  doExit(fn: () => boolean) {
+  doExit(fn: () => Promise<boolean>) {
     RuntimeLoader.exit = fn;
   }
 };
@@ -81,8 +82,8 @@ if (window.webkit) {
     RuntimeLoader.trigger();
     _joliboxJSCore.onDocumentReady.postMessage({ path });
   };
-  const doExit = (uuid: string) => {
-    const shouldInterrupt = RuntimeLoader.exit();
+  const doExit = async (uuid: string) => {
+    const shouldInterrupt = await RuntimeLoader.exit();
     _joliboxJSCore.doExit.postMessage({ uuid, shouldInterrupt });
   };
 
@@ -96,14 +97,17 @@ if (window.webkit) {
         callbackId
       });
     },
-    // publish(event, params, webviewIds) {
-    //   const data = normalizeParams(params as Record<string, unknown>, 'joliboxJSCore');
-    //   _joliboxJSCore.publish.postMessage({
-    //     event,
-    //     paramsString: JSON.stringify(data),
-    //     webviewIds: JSON.stringify(webviewIds)
-    //   });
-    // },
+    publish(event, params, webviewIds) {
+      const data = normalizeParams(params as Record<string, unknown>, 'joliboxJSCore');
+      window.prompt(
+        'publish',
+        JSON.stringify({
+          event,
+          paramsString: JSON.stringify(data),
+          webviewIds
+        })
+      );
+    },
     call(method: string, params: Record<string, unknown>, callbackId) {
       const res = window.prompt(
         'invoke',
@@ -137,8 +141,8 @@ if (window.JoliAndroidSDKBridge) {
     _joliboxJSCore.onDocumentReady(JSON.stringify({ path }));
   };
 
-  const doExit = (uuid: string) => {
-    const shouldInterrupt = RuntimeLoader.exit();
+  const doExit = async (uuid: string) => {
+    const shouldInterrupt = await RuntimeLoader.exit();
     _joliboxJSCore.doExit(JSON.stringify({ uuid, shouldInterrupt }));
   };
 
@@ -154,14 +158,14 @@ if (window.JoliAndroidSDKBridge) {
       );
     },
     doExit,
-    // publish(event, params, webviewIds) {
-    //   const data = normalizeParams(params as Record<string, unknown>, 'joliboxJSCore');
-    //   _joliboxJSCore.publish({
-    //     event,
-    //     paramsString: JSON.stringify(data),
-    //     webviewIds: JSON.stringify(webviewIds)
-    //   });
-    // },
+    publish(event, params, webviewIds) {
+      const data = normalizeParams(params as Record<string, unknown>, 'joliboxJSCore');
+      _joliboxJSCore.publish({
+        event,
+        paramsString: JSON.stringify(data),
+        webviewIds
+      });
+    },
     call(method: string, params: Record<string, unknown>, callbackId) {
       const res = window.prompt(
         'invoke',

package/src/native/types/global.d.ts

@@ -15,6 +15,7 @@ declare global {
       onDocumentReady: (path: string) => void;
       doExit: (uuid: string) => void;
       bind?: (id: number, handler: (...args: unknown[]) => unknown) => void;
+      publish: (event: string, data: unknown, webviewIds: number[] | '*') => void;
     }
 
     type ApplyNativeReturn<T> = T extends Promise<infer U>

package/src/native/types/native-method-map.d.ts

@@ -255,6 +255,13 @@ declare global {
         /** 错误码 */
         errNo?: number;
       };
+
+      openSchemaSync: (params: { schema: string }) => {
+        /** 错误消息 */
+        errMsg: string;
+        /** 错误码 */
+        errNo?: number;
+      };
     }
 
     interface NativeEventMap {
@@ -293,6 +300,11 @@ declare global {
           token?: string;
         }
       ];
+      onInfoTapped: [
+        {
+          uuid: string;
+        }
+      ];
     }
   }
 }