@jolibox/implement 1.1.10 → 1.1.11-beta.10

package/src/common/ads/index.ts

@@ -1,9 +1,10 @@
 import { AdsActionDetection } from './ads-action-detection';
 import { AdsAntiCheating } from './anti-cheating';
-import { Track } from '../report';
 import { context } from '../context';
 import { ChannelPolicy } from './channel-policy';
 import { EventEmitter } from '@jolibox/common';
+import type { Track } from '../report';
+import type { IHttpClient } from '../http';
 
 declare global {
   interface Window {
@@ -254,10 +255,6 @@ interface IJoliboxAdsResponse {
   };
 }
 
-interface HttpClient {
-  get<T>(url: string, options?: { query?: Record<string, string> }): Promise<T>;
-}
-
 export const adEventEmitter = new EventEmitter<{
   isAdShowing: [boolean];
 }>();
@@ -278,8 +275,8 @@ export class JoliboxAdsImpl {
   /**
    * Internal constructor, should not be called directly
    */
-  constructor(readonly track: Track, readonly httpClient: HttpClient, readonly checkNetwork: () => boolean) {
-    this.antiCheating = new AdsAntiCheating(checkNetwork);
+  constructor(readonly track: Track, readonly httpClient: IHttpClient, readonly checkNetwork: () => boolean) {
+    this.antiCheating = new AdsAntiCheating(track, httpClient, checkNetwork);
     this.adsActionDetection = new AdsActionDetection(this.track);
     this.channelPolicy = new ChannelPolicy(httpClient);
   }
@@ -400,7 +397,10 @@ export class JoliboxAdsImpl {
 
       const beforeAd = () => {
         adEventEmitter.emit('isAdShowing', true);
-        this.track('CallBeforeAd', {});
+        this.track('CallBeforeAd', {
+          type: params.type,
+          name: params.name ?? ''
+        });
         if (originBeforeAd) {
           originBeforeAd();
         }
@@ -408,7 +408,10 @@ export class JoliboxAdsImpl {
 
       const afterAd = () => {
         adEventEmitter.emit('isAdShowing', false);
-        this.track('CallAfterAd', {});
+        this.track('CallAfterAd', {
+          type: params.type,
+          name: params.name ?? ''
+        });
         if (originAfterAd) {
           originAfterAd();
         }
@@ -478,36 +481,46 @@ export class JoliboxAdsImpl {
       }
     }
 
-    const adsDisplayPermission = this.antiCheating.checkAdsDisplayPermission(
+    const { reason, info } = this.antiCheating.checkAdsDisplayPermission(
       params.type === 'reward' ? 'reward' : 'interstitial'
     );
 
-    switch (adsDisplayPermission) {
+    switch (reason) {
       case 'NETWORK_NOT_OK':
       case 'BANNED_FOR_SESSION':
-        console.warn('Ads not allowed', adsDisplayPermission);
+        // console.warn('Ads not allowed', reason);
         params.adBreakDone?.({
           breakType: params.type,
-          breakName: adsDisplayPermission,
+          breakName: reason,
           breakFormat: params.type === 'reward' ? 'reward' : 'interstitial',
           breakStatus: 'noAdPreloaded'
         });
-        this.track('PreventAdsCheating', {
-          reason: adsDisplayPermission
-        });
+        this.antiCheating.report(reason);
         return;
       case 'BLOCK_INITIAL':
       case 'BANNED_FOR_TIME':
       case 'WAITING_BANNED_RELEASE':
-        console.warn('Ads not allowed', adsDisplayPermission);
+        // console.warn('Ads not allowed', adsDisplayPermission);
         params.adBreakDone?.({
           breakType: params.type,
           breakFormat: params.type === 'reward' ? 'reward' : 'interstitial',
-          breakStatus: 'viewed' // TODO: need to confirm
+          breakStatus: 'frequencyCapped'
         });
-        this.track('PreventAdsCheating', {
-          reason: adsDisplayPermission
+        this.antiCheating.report(reason);
+        return;
+      case 'HOLDING_HIGH_FREQ':
+        // follow google's style to forbid high freq request
+        params.adBreakDone?.({
+          breakFormat: params.type === 'reward' ? 'reward' : 'interstitial',
+          breakName: '',
+          breakStatus: (info?.count ?? 0) > 6 ? 'other' : 'frequencyCapped',
+          breakType: params.type
         });
+        // every 3 hit, report to anti-cheating system
+        // if a user click 1 time every 1 second, it will cause 20 reports for 1 minute
+        if (info?.count && info.count !== 0 && info.count % 3 === 0) {
+          this.antiCheating.report(reason, info?.count);
+        }
         return;
       default:
         // allowed

package/src/common/context/index.ts

@@ -1,7 +1,7 @@
 import { mergeArray, mergeWith } from '@jolibox/common';
 import { DeviceInfo, HostInfo, HostUserInfo, SdkInfo } from './types';
 import { Env } from '@jolibox/types';
-import { parseUrlQuery } from './url-parse';
+import { parseUrlQuery, encodeJoliSourceQuery, QueryParams } from './url-parse';
 import { getAppVersion } from '../http/xua';
 import { getDeviceId } from '@jolibox/common';
 
@@ -36,12 +36,13 @@ const env = Object.assign({}, nativeEnv?.() ?? defaultEnv);
 type MPType = 'game' | 'miniApp';
 
 const wrapContext = () => {
-  const { payloadJson, headerJson } = env.schema.length ? parseUrlQuery(env.schema) : {};
+  const { payloadJson, headerJson, signature } = env.schema.length ? parseUrlQuery(env.schema) : {};
   const defaultSessionId = `${env.deviceInfo.did}-${new Date().getTime()}`;
   const url = new URL(env.schema.length ? env.schema : window.location.href);
   const urlParams = url.searchParams;
   const defaultGameID = urlParams.get('mpId') ?? urlParams.get('appId') ?? urlParams.get('gameId') ?? '';
-  const sessionId = payloadJson?.sessionId ?? urlParams.get('sessionId') ?? defaultSessionId;
+  const sessionId =
+    env.clientSessionId ?? payloadJson?.sessionId ?? urlParams.get('sessionId') ?? defaultSessionId;
   const testAdsMode = !!(payloadJson?.testAdsMode ?? urlParams.get('testAdsMode') === 'true');
   const joliboxEnv = payloadJson?.joliboxEnv ?? urlParams.get('joliboxEnv') ?? 'production';
   const testMode = joliboxEnv === 'staging';
@@ -93,8 +94,23 @@ const wrapContext = () => {
     get webviewId(): number {
       return env.webviewId ?? -1;
     },
+    get shouldInterupt(): boolean | undefined {
+      return payloadJson?.__shouldInterupt;
+    },
+    get from(): number | undefined {
+      return payloadJson?.__from;
+    },
     onEnvConfigChanged: (newConfig: Partial<Env>) => {
       mergeWith(env, newConfig, mergeArray);
+    },
+    encodeJoliSourceQuery: (newPayloadJson: QueryParams['payloadJson']) => {
+      if (headerJson && signature) {
+        return encodeJoliSourceQuery(
+          { ...payloadJson, ...newPayloadJson },
+          urlParams.get('joliSource') ?? ''
+        );
+      }
+      return urlParams.get('joliSource') ?? '';
     }
   };
 };

package/src/common/context/url-parse.ts

@@ -14,6 +14,12 @@ interface PayloadJson {
   joliboxEnv?: 'staging' | 'production';
   sessionId?: string;
   __mpType?: 'game' | 'miniApp';
+  __orientation?: 'HORIZONTAL' | 'VERTICAL';
+  __transparent?: boolean;
+  __entryPath?: string;
+  __showStatusBar?: boolean;
+  __shouldInterupt?: boolean;
+  __from?: number; // 从哪个小程序打开的
 }
 
 interface Signature {
@@ -21,7 +27,7 @@ interface Signature {
   payloadSig?: string;
 }
 
-interface QueryParams {
+export interface QueryParams {
   headerJson: HeaderJson;
   payloadJson: PayloadJson;
   signature: Signature;
@@ -38,6 +44,12 @@ const base64UrlDecode = <T>(input: string): T => {
   }
 };
 
+const base64UrlEncode = <T>(input: T): string => {
+  const jsonStr = JSON.stringify(input);
+  const base64 = btoa(jsonStr);
+  return base64.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
+};
+
 export const parseUrlQuery = (url: string): QueryParams => {
   try {
     const urlObj = new URL(url);
@@ -63,3 +75,14 @@ export const parseUrlQuery = (url: string): QueryParams => {
     };
   }
 };
+
+export const encodeJoliSourceQuery = (payloadJson: PayloadJson, originJoliSource: string): string => {
+  const joli_source = originJoliSource.split('.');
+  if (joli_source && joli_source.length === 3) {
+    const headerJsonStr = joli_source[0];
+    const payloadJsonStr = base64UrlEncode(payloadJson);
+    const signatureJsonStr = joli_source[2];
+    return `${headerJsonStr}.${payloadJsonStr}.${signatureJsonStr}`;
+  }
+  return originJoliSource;
+};

package/src/native/api/ads.ts

@@ -22,6 +22,13 @@ const ads = new JoliboxAdsImpl(
         responseType: 'json',
         appendHostCookie: true,
         ...options
+      }).then((res) => res.response.data as T),
+    post: <T>(url: string, data: any, options?: any) =>
+      fetch<T>(url, {
+        method: 'POST',
+        responseType: 'json',
+        appendHostCookie: true,
+        ...options
       }).then((res) => res.response.data as T)
   },
   checkNetworkStatus

package/src/native/api/index.ts

@@ -6,3 +6,4 @@ import './keyboard';
 import './task';
 import './login';
 import './ads';
+import './navigate';

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,61 @@
+import { createCommands, UserCustomError } from '@jolibox/common';
+import { invokeNative } from '../bootstrap/bridge';
+import { createSyncAPI, t, registerCanIUse } from './base';
+import { context } from '@/common/context';
+
+const commands = createCommands();
+
+const openSchemaSync = createSyncAPI('openSchemaSync', {
+  paramsSchema: t.tuple(t.string()),
+  implement: (schema) => {
+    // Add compatibility logic for incomplete URLs
+    let finalSchema = schema;
+    if (!schema.match(/^https?:\/\//)) {
+      finalSchema = `https://${context.mpId}.app.jolibox.com${schema.startsWith('/') ? '' : '/'}${schema}`;
+    }
+
+    const res = invokeNative('openSchemaSync', {
+      schema: finalSchema
+    });
+    if (res.errNo !== 0) {
+      throw new UserCustomError(res.errMsg, res.errNo);
+    }
+  }
+});
+
+const openPageSync = createSyncAPI('openPageSync', {
+  paramsSchema: t.tuple(t.string()),
+  implement: (page) => {
+    const { errNo, errMsg, data } = invokeNative('openPageSync', { url: page });
+    if (errNo !== 0 || !data) {
+      throw new UserCustomError(errMsg, errNo);
+    }
+    return { webviewId: data.webviewId };
+  }
+});
+
+const closePageSync = createSyncAPI('closePageSync', {
+  paramsSchema: t.tuple(t.number()),
+  implement: (webviewId) => {
+    const { errNo, errMsg } = invokeNative('closePageSync', { webviewId });
+    if (errNo !== 0) {
+      throw new UserCustomError(errMsg, errNo);
+    }
+  }
+});
+
+commands.registerCommand('RouterSDK.openSchema', openSchemaSync);
+commands.registerCommand('RouterSDK.openPage', openPageSync);
+commands.registerCommand('RouterSDK.closePage', closePageSync);
+
+registerCanIUse('router.openSchema', {
+  version: '1.1.10'
+});
+
+registerCanIUse('router.openPage', {
+  version: '1.1.10'
+});
+
+registerCanIUse('router.closePage', {
+  version: '1.1.10'
+});

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 '../ui/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/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;
 }