@heybox/hb-sdk 0.7.5-alpha.0 → 0.8.0-alpha

package/dist/devtools/browser-dev-host/main.js

@@ -251,6 +251,10 @@ class MiniProgramBridgeServer {
         this.dispatcher = options.dispatcher;
         this.targetOrigin = options.targetOrigin || '*';
     }
+    /** 返回当前已完成握手的协议版本。 */
+    get protocolVersion() {
+        return this.handshaken ? this.bridgeVersion : undefined;
+    }
     /** 开始监听 iframe 内 SDK 消息。 */
     start() {
         if (this.started) {
@@ -342,9 +346,10 @@ class MiniProgramBridgeServer {
     isTrustedMiniProgramMessage(event) {
         return (event.source === this.iframe.contentWindow &&
             isMiniProgramBridgeMessage(event.data) &&
+            (!this.handshaken || event.data.version === this.bridgeVersion) &&
             // 历史 v1 小程序可能在启动后跳转到不同的合法文档 origin；source 与 nonce
             // 仍然绑定到当前 iframe 实例，v2 继续执行严格 origin 校验。
-            (event.data.version === 1 || this.targetOrigin === '*' || event.origin === this.targetOrigin) &&
+            ((this.handshaken ? this.bridgeVersion : event.data.version) === 1 || this.targetOrigin === '*' || event.origin === this.targetOrigin) &&
             event.data.nonce === this.nonce);
     }
     handleHandshake(payload, version, origin) {
@@ -747,20 +752,6 @@ function parseLoginResponse(response) {
     }
     return { ...envelope, result: mapped };
 }
-function parseLocalIdentityBeginResponse(response) {
-    const envelope = parseAPIResponse(response, '小程序本地身份接口响应异常');
-    const result = envelope.result;
-    const mapped = {};
-    if (result.local_identity && typeof result.local_identity === 'object') {
-        mapped.localIdentity = {
-            appUserId: result.local_identity.app_user_id,
-        };
-    }
-    if (result.consent_challenge && typeof result.consent_challenge === 'object') {
-        mapped.consentChallenge = mapChallenge(result.consent_challenge);
-    }
-    return { ...envelope, result: mapped };
-}
 
 const userMiniprogramAuthorizationCancelEndpoint = {
     auth: 'none',
@@ -786,29 +777,17 @@ const userMiniprogramAuthorizationRevokeEndpoint = {
     parse: (response) => parseAPIResponse(response, '小程序授权撤销接口响应异常'),
 };
 
-const userMiniprogramLocalIdentityBeginEndpoint = {
+const userMiniprogramLocalIdentityEndpoint = {
     auth: 'none',
     bodyEncoding: 'form',
     channel: 'api',
     failurePresentation: 'none',
-    id: 'heybox.user_miniprogram.runtime.auth.local_identity.begin.post',
+    id: 'heybox.user_miniprogram.runtime.local_identity.post',
     method: 'POST',
-    path: '/user_miniprogram/runtime/auth/local_identity/begin',
+    path: '/user_miniprogram/runtime/local_identity',
     body: (input) => runtimeContextBody(input.runtimeContext),
-    parse: (response) => parseLocalIdentityBeginResponse(response),
-};
-
-const userMiniprogramLocalIdentityConfirmEndpoint = {
-    auth: 'none',
-    bodyEncoding: 'form',
-    channel: 'api',
-    failurePresentation: 'none',
-    id: 'heybox.user_miniprogram.runtime.auth.local_identity.confirm.post',
-    method: 'POST',
-    path: '/user_miniprogram/runtime/auth/local_identity/confirm',
-    body: (input) => ({ ...runtimeContextBody(input.runtimeContext), challenge: input.challenge }),
     parse(response) {
-        const envelope = parseAPIResponse(response, '小程序本地身份确认接口响应异常');
+        const envelope = parseAPIResponse(response, '小程序隔离身份接口响应异常');
         return { ...envelope, result: { appUserId: envelope.result.app_user_id } };
     },
 };
@@ -1323,35 +1302,11 @@ function createAuthorizationCoordinator(options) {
     }
     async function requestLocalIdentity(userId, miniProgramId) {
         const expectedGeneration = generation;
-        const beginEnvelope = await request(userMiniprogramLocalIdentityBeginEndpoint, {
+        const envelope = await request(userMiniprogramLocalIdentityEndpoint, {
             runtimeContext: { miniProgramId },
         });
         await assertAuthorizationContext(userId, expectedGeneration);
-        const begin = readSuccessfulResult$3(beginEnvelope, '用户本地身份');
-        const hasIdentity = hasOwn(begin, 'localIdentity');
-        const hasChallenge = hasOwn(begin, 'consentChallenge');
-        if (hasIdentity === hasChallenge) {
-            throw createCapabilityBridgeError('INVALID_RESPONSE', '用户本地身份 begin 必须返回 exact oneof');
-        }
-        let localIdentity;
-        if (hasIdentity) {
-            localIdentity = validateLocalIdentity(begin.localIdentity);
-        }
-        else {
-            const identityChallenge = validateConsentChallenge(begin.consentChallenge);
-            if (identityChallenge.requestedScopes.length !== 1 ||
-                identityChallenge.requestedScopes[0] !== 'identity' ||
-                identityChallenge.displayedScopes.length !== 1 ||
-                identityChallenge.displayedScopes[0] !== 'identity') {
-                throw createCapabilityBridgeError('INVALID_RESPONSE', '用户本地身份 challenge 必须仅包含 identity scope');
-            }
-            const confirmEnvelope = await request(userMiniprogramLocalIdentityConfirmEndpoint, {
-                runtimeContext: { miniProgramId },
-                challenge: identityChallenge.challenge,
-            });
-            await assertAuthorizationContext(userId, expectedGeneration);
-            localIdentity = validateLocalIdentity(readSuccessfulResult$3(confirmEnvelope, '用户本地身份确认'));
-        }
+        const localIdentity = validateLocalIdentity(readSuccessfulResult$3(envelope, '用户本地身份'));
         for (const scope of USER_INFO_AUTHORIZATION_SCOPES)
             grantedScopes.add(scope);
         emit('user_info_authorization_change', authorizationFromScopes(grantedScopes));
@@ -5747,6 +5702,9 @@ class MiniProgramRuntimeImpl {
         this.probeSequence = 0;
         this.hostVisible = true;
         this.awaitingControlledDocumentLoad = false;
+        this.documentRevalidationPending = false;
+        this.documentRevalidationGeneration = 0;
+        this.iframeHiddenForRevalidation = false;
         this.runtimePermissions = undefined;
         this.options = options;
         this.iframe = options.iframe;
@@ -5776,13 +5734,22 @@ class MiniProgramRuntimeImpl {
         this.iframeLoadListener = () => {
             if (this.awaitingControlledDocumentLoad) {
                 this.awaitingControlledDocumentLoad = false;
+                if (this.stateValue === 'ready' && this.bridgeServer?.protocolVersion === 2 && this.sdkVersionDecision?.heartbeatEnabled) {
+                    this.beginDocumentRevalidation();
+                    return;
+                }
                 if (this.compatibilityWithoutSdk && !this.readyContext) {
                     this.completeCompatibilityLaunch();
                 }
                 return;
             }
             if (this.stateValue === 'ready') {
-                this.scheduleUnexpectedDocumentLoadFailure();
+                if (this.bridgeServer?.protocolVersion === 2 && this.sdkVersionDecision?.heartbeatEnabled) {
+                    this.beginDocumentRevalidation();
+                }
+                else {
+                    this.scheduleUnexpectedDocumentLoadFailure();
+                }
             }
         };
         this.iframe.addEventListener('error', this.iframeErrorListener);
@@ -5830,14 +5797,34 @@ class MiniProgramRuntimeImpl {
         this.hostVisible = true;
         this.emitLifecycleEvent('show');
         if (!wasVisible && this.stateValue === 'ready' && this.sdkVersionDecision?.heartbeatEnabled) {
-            this.sendLocationProbe();
+            if (this.documentRevalidationPending) {
+                this.armDocumentRevalidationTimer(this.documentRevalidationGeneration);
+                this.resendDocumentRevalidationProbe();
+            }
+            else {
+                this.sendLocationProbe();
+            }
         }
     }
     hide() {
         this.hostVisible = false;
         this.clearHeartbeat();
+        this.clearDocumentRevalidationTimer();
         this.emitLifecycleEvent('hide');
     }
+    prepareForHistoryTraversal() {
+        if (this.stateValue !== 'ready' || this.bridgeServer?.protocolVersion !== 2 || !this.sdkVersionDecision?.heartbeatEnabled) {
+            return () => undefined;
+        }
+        const generation = this.beginDocumentRevalidation({ deferProbe: true });
+        this.preparedHistoryTraversalGeneration = generation;
+        return () => {
+            if (this.preparedHistoryTraversalGeneration !== generation) {
+                return;
+            }
+            this.cancelPreparedHistoryTraversal();
+        };
+    }
     createReadyPromise() {
         return new Promise((resolve, reject) => {
             this.resolveReady = resolve;
@@ -5934,11 +5921,7 @@ class MiniProgramRuntimeImpl {
                 this.handleBridgeReady();
             },
             onDuplicateHandshake: () => {
-                this.trace({
-                    runtimeId: this.nonce,
-                    timestamp: Date.now(),
-                    type: 'duplicate_handshake',
-                });
+                this.handleDuplicateBridgeHandshake();
             },
             onInternalEvent: (message) => {
                 this.handleInternalBridgeEvent(message);
@@ -6179,7 +6162,7 @@ class MiniProgramRuntimeImpl {
         }
     }
     sendLocationProbe() {
-        if (this.isInactive() || !this.hostVisible || !this.sdkVersionDecision?.heartbeatEnabled) {
+        if (this.isInactive() || !this.hostVisible || !this.sdkVersionDecision?.heartbeatEnabled || this.documentRevalidationPending) {
             return;
         }
         if (this.pendingProbeId) {
@@ -6214,6 +6197,123 @@ class MiniProgramRuntimeImpl {
         this.pendingProbeId = undefined;
         this.consecutiveHeartbeatMisses = 0;
     }
+    beginDocumentRevalidation(options = {}) {
+        this.clearUnexpectedDocumentLoadFailure();
+        this.clearHeartbeat();
+        this.clearDocumentRevalidationTimer();
+        this.preparedHistoryTraversalGeneration = undefined;
+        this.documentRevalidationPending = true;
+        const generation = ++this.documentRevalidationGeneration;
+        if (!this.iframeHiddenForRevalidation) {
+            this.iframeVisibilityBeforeRevalidation = this.iframe.style.visibility;
+            this.iframe.style.visibility = 'hidden';
+            this.iframeHiddenForRevalidation = true;
+        }
+        this.armDocumentRevalidationTimer(generation);
+        if (!options.deferProbe) {
+            this.sendDocumentRevalidationProbe();
+        }
+        return generation;
+    }
+    sendDocumentRevalidationProbe() {
+        if (this.isInactive() || !this.hostVisible || !this.documentRevalidationPending || !this.sdkVersionDecision?.heartbeatEnabled) {
+            return;
+        }
+        const probeId = `${Date.now().toString(36)}_${++this.probeSequence}`;
+        this.pendingProbeId = probeId;
+        this.postLocationProbe(probeId);
+    }
+    resendDocumentRevalidationProbe() {
+        if (this.isInactive() || !this.hostVisible || !this.documentRevalidationPending || !this.sdkVersionDecision?.heartbeatEnabled) {
+            return;
+        }
+        if (!this.pendingProbeId) {
+            this.sendDocumentRevalidationProbe();
+            return;
+        }
+        this.postLocationProbe(this.pendingProbeId);
+    }
+    postLocationProbe(probeId) {
+        this.bridgeServer?.postInternalRequest(RUNTIME_LOCATION_PROBE_METHOD, probeId, {
+            probeId,
+            timestamp: Date.now(),
+        });
+        this.trace({
+            runtimeId: this.nonce,
+            timestamp: Date.now(),
+            type: 'location_probe',
+            method: RUNTIME_LOCATION_PROBE_METHOD,
+        });
+    }
+    armDocumentRevalidationTimer(generation) {
+        if (!this.hostVisible) {
+            return;
+        }
+        this.documentRevalidationTimer = setTimeout(() => {
+            this.documentRevalidationTimer = undefined;
+            if (this.isInactive() || !this.documentRevalidationPending || generation !== this.documentRevalidationGeneration) {
+                return;
+            }
+            this.emitUrlSecurityViolation('UNEXPECTED_DOCUMENT_LOAD', this.launchUrl);
+            this.failRuntime(createBridgeError('UNEXPECTED_DOCUMENT_LOAD', '小程序 iframe 文档再验证超时'));
+        }, HEARTBEAT_INTERVAL);
+    }
+    clearDocumentRevalidationTimer() {
+        if (this.documentRevalidationTimer) {
+            clearTimeout(this.documentRevalidationTimer);
+            this.documentRevalidationTimer = undefined;
+        }
+    }
+    completeDocumentRevalidation() {
+        this.clearDocumentRevalidationTimer();
+        this.documentRevalidationPending = false;
+        this.preparedHistoryTraversalGeneration = undefined;
+        this.pendingProbeId = undefined;
+        this.consecutiveHeartbeatMisses = 0;
+        if (this.iframeHiddenForRevalidation && this.iframe.style.visibility === 'hidden') {
+            this.iframe.style.visibility = this.iframeVisibilityBeforeRevalidation ?? '';
+        }
+        this.iframeVisibilityBeforeRevalidation = undefined;
+        this.iframeHiddenForRevalidation = false;
+        if (this.hostVisible && this.sdkVersionDecision?.heartbeatEnabled) {
+            this.heartbeatTimer = setTimeout(() => {
+                this.heartbeatTimer = undefined;
+                this.sendLocationProbe();
+            }, HEARTBEAT_INTERVAL);
+        }
+    }
+    clearDocumentRevalidation() {
+        this.clearDocumentRevalidationTimer();
+        this.documentRevalidationPending = false;
+        this.preparedHistoryTraversalGeneration = undefined;
+        this.iframeVisibilityBeforeRevalidation = undefined;
+        this.iframeHiddenForRevalidation = false;
+    }
+    cancelPreparedHistoryTraversal() {
+        this.clearDocumentRevalidationTimer();
+        this.documentRevalidationPending = false;
+        this.preparedHistoryTraversalGeneration = undefined;
+        this.pendingProbeId = undefined;
+        this.consecutiveHeartbeatMisses = 0;
+        if (this.iframeHiddenForRevalidation && this.iframe.style.visibility === 'hidden') {
+            this.iframe.style.visibility = this.iframeVisibilityBeforeRevalidation ?? '';
+        }
+        this.iframeVisibilityBeforeRevalidation = undefined;
+        this.iframeHiddenForRevalidation = false;
+        if (this.hostVisible && this.sdkVersionDecision?.heartbeatEnabled) {
+            this.sendLocationProbe();
+        }
+    }
+    handleDuplicateBridgeHandshake() {
+        this.trace({
+            runtimeId: this.nonce,
+            timestamp: Date.now(),
+            type: 'duplicate_handshake',
+        });
+        if (this.documentRevalidationPending) {
+            this.resendDocumentRevalidationProbe();
+        }
+    }
     handleInternalBridgeEvent(message) {
         if (message.method === SDK_CSP_VIOLATION_METHOD) {
             this.handleCspViolation(message.payload);
@@ -6245,12 +6345,16 @@ class MiniProgramRuntimeImpl {
             this.failRuntime(createBridgeError('URL_OUT_OF_SCOPE', '小程序页面地址超出允许范围'));
             return;
         }
-        if (report.trigger === 'hashchange') {
-            this.clearUnexpectedDocumentLoadFailure();
-        }
         if (report.probeId !== undefined) {
             this.pendingProbeId = undefined;
             this.consecutiveHeartbeatMisses = 0;
+            if (this.documentRevalidationPending) {
+                this.completeDocumentRevalidation();
+            }
+        }
+        else if (this.documentRevalidationPending && !this.pendingProbeId) {
+            this.preparedHistoryTraversalGeneration = undefined;
+            this.sendDocumentRevalidationProbe();
         }
     }
     handleCspViolation(payload) {
@@ -6360,6 +6464,7 @@ class MiniProgramRuntimeImpl {
         this.clearHandshakeTimeout();
         this.clearHeartbeat();
         this.clearUnexpectedDocumentLoadFailure();
+        this.clearDocumentRevalidation();
         this.destroyBridgeServer();
         this.capabilityGraph?.dispose();
         this.capabilityGraph = undefined;