Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .changeset/forty-jars-scream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
"@lynx-js/web-mainthread-apis": patch
"@lynx-js/web-core-server": patch
"@lynx-js/web-constants": patch
"@lynx-js/web-core": patch
---

feat: add `_SetSourceMapRelease(errInfo)` MTS API.

You can get `errInfo.release` through `e.detail.release` in the error event callback of lynx-view.

The `_SetSourceMapRelease` function is not complete yet, because it is currently limited by the Web platform and some functions and some props such as `err.stack` do not need to be supported for the time being.
2 changes: 1 addition & 1 deletion packages/web-platform/web-constants/src/endpoints.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export const BackgroundThreadStartEndpoint = createRpcEndpoint<[
* Error message, info
*/
export const reportErrorEndpoint = createRpcEndpoint<
[Error, unknown],
[Error, unknown, string],
void
>('reportError', false, false);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,10 @@ export type GetTemplatePartsPAPI = (
templateElement: WebFiberElementImpl,
) => Record<string, WebFiberElementImpl> | undefined;

interface JSErrorInfo {
release: string;
}

export interface MainThreadGlobalThis {
__AddEvent: AddEventPAPI;
__GetEvent: GetEventPAPI;
Expand Down Expand Up @@ -327,6 +331,7 @@ export interface MainThreadGlobalThis {
ssrEncode?: () => string;
ssrHydrate?: (encodeData?: string) => void;
_ReportError: (error: Error, _: unknown) => void;
_SetSourceMapRelease: (errInfo: JSErrorInfo) => void;
__OnLifecycleEvent: (lifeCycleEvent: Cloneable) => void;
__LoadLepusChunk: (path: string) => boolean;
__FlushElementTree: (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ const mainThreadInjectVars = [
'lynx',
'globalThis',
'_ReportError',
'_SetSourceMapRelease',
'__AddConfig',
'__AddDataset',
'__GetAttributes',
Expand Down
3 changes: 2 additions & 1 deletion packages/web-platform/web-core/src/apis/LynxView.ts
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ export class LynxView extends HTMLElement {
napiModulesCall: (...args) => {
return this.#onNapiModulesCall?.(...args);
},
onError: (error: Error) => {
onError: (error: Error, release: string) => {
this.dispatchEvent(
new CustomEvent('error', {
detail: {
Expand All @@ -450,6 +450,7 @@ export class LynxView extends HTMLElement {
},
},
error,
release,
},
}),
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export function createRenderAllOnUI(
timeStamp?: number,
) => void,
callbacks: {
onError?: (err: Error) => void;
onError?: (err: Error, release: string) => void;
},
) {
if (!globalThis.module) {
Expand All @@ -48,8 +48,8 @@ export function createRenderAllOnUI(
document.createElement.bind(document),
() => {},
markTimingInternal,
(err) => {
callbacks.onError?.(err);
(err, _, release) => {
callbacks.onError?.(err, release);
},
triggerI18nResourceFallback,
(initI18nResources: InitI18nResources) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export function createRenderMultiThread(
mainThreadRpc: Rpc,
shadowRoot: ShadowRoot,
callbacks: {
onError?: (err: Error) => void;
onError?: (err: Error, release: string) => void;
},
) {
registerReportErrorHandler(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import type { Rpc } from '@lynx-js/web-worker-rpc';

export function registerReportErrorHandler(
rpc: Rpc,
onError?: (e: Error) => void,
onError?: (e: Error, release: string) => void,
) {
rpc.registerHandler(
reportErrorEndpoint,
(e) => {
onError?.(e);
(e, _, release) => {
onError?.(e, release);
},
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { createRenderAllOnUI } from './createRenderAllOnUI.js';
export type StartUIThreadCallbacks = {
nativeModulesCall: NativeModulesCall;
napiModulesCall: NapiModulesCall;
onError?: (err: Error) => void;
onError?: (err: Error, release: string) => void;
customTemplateLoader?: (url: string) => Promise<LynxTemplate>;
};

Expand Down
1 change: 1 addition & 0 deletions packages/web-platform/web-core/src/utils/loadTemplate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ const mainThreadInjectVars = [
'lynx',
'globalThis',
'_ReportError',
'_SetSourceMapRelease',
'__AddConfig',
'__AddDataset',
'__GetAttributes',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -619,6 +619,7 @@ export function createMainThreadGlobalThis(
return pageElement;
};

let release = '';
const isCSSOG = !pageConfig.enableCSSSelector;
const mtsGlobalThis: MainThreadGlobalThis = {
__AddEvent,
Expand Down Expand Up @@ -679,7 +680,8 @@ export function createMainThreadGlobalThis(
...config.browserConfig,
},
lynx: createMainThreadLynx(config),
_ReportError: callbacks._ReportError,
_ReportError: (err, _) => callbacks._ReportError(err, _, release),
_SetSourceMapRelease: (errInfo) => release = errInfo?.release,
__OnLifecycleEvent: callbacks.__OnLifecycleEvent,
__FlushElementTree,
__lynxGlobalBindingValues: lynxGlobalBindingValues,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ function initializeMainThreadTest() {
docu.commit();
decodeOperation(elementOperations);
},
_ReportError: function(error: string, info?: unknown): void {
_ReportError: function(): void {
document.body.innerHTML = '';
},
__OnLifecycleEvent() {
Expand All @@ -146,6 +146,7 @@ function initializeMainThreadTest() {
});
},
createElement: docu.createElement.bind(docu),
_I18nResourceTranslation: () => {},
},
});
const originalGlobalThis = globalThis;
Expand Down
22 changes: 22 additions & 0 deletions packages/web-platform/web-tests/tests/react.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,28 @@ test.describe('reactlynx3 tests', () => {
await wait(500);
expect(offset).toBe(true);
});
test('api-set-release', async ({ page }, { title }) => {
let success = false;
await page.on('console', async (msg) => {
const event = await msg.args()[0]?.evaluate((e) => {
return {
type: e.type,
release: e.detail?.release,
};
});
if (!event || event.type !== 'error') {
return;
}
if (
typeof event.release === 'string' && event.release === '1'
) {
success = true;
}
});
await goto(page, title);
await wait(500);
expect(success).toBe(true);
});

test('api-preheat', async ({ page }, { title }) => {
await goto(page, title);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Copyright 2023 The Lynx Authors. All rights reserved.
// Licensed under the Apache License Version 2.0 that can be found in the
// LICENSE file in the root directory of this source tree.
import { root } from '@lynx-js/react';

function App() {
if (__MAIN_THREAD__) {
_SetSourceMapRelease({ release: '1' });
}
throw new Error('error');
}

root.render(<App></App>);