Skip to content

Commit 58d5efa

Browse files
committed
fix: Add missing fields of FrameworkRenderingTiming
rename FrameworkPipelineTiming to FrameworkRenderingTiming add vmExecuteStart/End, dataProcessorStrart/End and setInitDataStart/End in FrameworkRenderingTiming. Change-Id: I94758afb6491967f02e944f546450b987753ff51
1 parent c0abddf commit 58d5efa

File tree

11 files changed

+146
-38
lines changed

11 files changed

+146
-38
lines changed

docs/en/api/lynx-api/performance-api/_meta.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
},
2626
{
2727
"type": "file",
28-
"name": "framework-pipeline-timing",
29-
"label": "FrameworkPipelineTiming",
28+
"name": "framework-rendering-timing",
29+
"label": "FrameworkRenderingTiming",
3030
"overviewHeaders": [],
3131
"collapsible": true,
3232
"collapsed": true

docs/en/api/lynx-api/performance-api/framework-pipeline-timing.mdx renamed to docs/en/api/lynx-api/performance-api/framework-rendering-timing.mdx

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { RuntimeBadge } from '@lynx';
22

3-
# FrameworkPipelineTiming
3+
# FrameworkRenderingTiming
44

55
This interface describes the performance data of key stages in [framework rendering](/guide/spec#framework-rendering).
66

@@ -94,9 +94,7 @@ hydrateParseSnapshotStart: number;
9494

9595
The timestamp when the framework starts deserializing [main thread](/guide/spec.html#main-thread-or-lynx-main-thread) information on the [background thread](/guide/spec.html#background-thread-aka-off-main-thread). This timestamp is a floating-point Unix timestamp (in milliseconds), accurate to three decimal places. For example: 1739594612307.429.
9696

97-
:::tip
9897
This property is only valid when `stage` is `hydrate`.
99-
:::
10098

10199
### hydrateParseSnapshotEnd
102100

@@ -106,12 +104,70 @@ hydrateParseSnapshotEnd: number;
106104

107105
The timestamp when the framework ends deserializing [main thread](/guide/spec.html#main-thread-or-lynx-main-thread) information on the [background thread](/guide/spec.html#background-thread-aka-off-main-thread). This timestamp is a floating-point Unix timestamp (in milliseconds), accurate to three decimal places. For example: 1739594612307.429.
108106

109-
:::tip
110107
This property is only valid when `stage` is `hydrate`.
111-
:::
108+
109+
### vmExecuteStart
110+
111+
```tsx
112+
vmExecuteStart: number;
113+
```
114+
115+
The timestamp when the framework starts executing [`main-thread.js`](/guide/spec.html#instances-of-main-thread-script) in the main thread to initialize the [Javascript Engine](/guide/spec.html#javascript-engine). This timestamp is a floating-point Unix timestamp (in milliseconds), accurate to three decimal places. For example: 1739594612307.429.
116+
117+
This property is only valid when `frameworkRenderingTiming` is present in [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry).
118+
119+
### vmExecuteEnd
120+
121+
```tsx
122+
vmExecuteEnd: number;
123+
```
124+
125+
The timestamp when the framework ends executing [`main-thread.js`](/guide/spec.html#instances-of-main-thread-script) in the main thread to initialize the [Javascript engine](/guide/spec.html#javascript-engine). This timestamp is a Unix timestamp expressed as a floating point (unit: milliseconds), accurate to three decimal places. For example: 1739594612307.429.
126+
127+
This property is only valid when `frameworkRenderingTiming` is present in [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry).
128+
129+
### dataProcessorStart
130+
131+
```tsx
132+
dataProcessorStart: number;
133+
```
134+
135+
The timestamp when the framework starts initial data processing by executing the [DataProcessor](api/react/interface.dataprocessordefinition) in the main thread. This timestamp is a floating-point Unix timestamp (unit: milliseconds), accurate to three decimal places. For example: 1739594612307.429.
136+
137+
This property is only valid when `frameworkRenderingTiming` is present in [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry).
138+
139+
### dataProcessorEnd
140+
141+
```tsx
142+
dataProcessorEnd: number;
143+
```
144+
145+
The timestamp when the framework completes initial data processing by executing the [DataProcessor](api/react/interface.dataprocessordefinition) in the main thread. This timestamp is a floating-point Unix timestamp (unit: milliseconds), accurate to three decimal places. For example: 1739594612307.429.
146+
147+
This property is only valid when `frameworkRenderingTiming` is present in [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry).
148+
149+
### setInitDataStart
150+
151+
```tsx
152+
setInitDataStart: number;
153+
```
154+
155+
The timestamp when the template's initial data starts to be updated based on the result of the [DataProcessor](api/react/interface.dataprocessordefinition). This timestamp is a floating point Unix timestamp (unit: milliseconds), accurate to three decimal places. For example: 1739594612307.429
156+
157+
This property is only valid when `frameworkRenderingTiming` is present in [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry).
158+
159+
### setInitDataEnd
160+
161+
```tsx
162+
setInitDataEnd: number;
163+
```
164+
165+
The timestamp at which the template's initial data ends is updated based on the result of the [DataProcessor](/api/react/interface.dataprocessordefinition). This timestamp is a floating point Unix timestamp (unit: milliseconds), accurate to three decimal places. For example: 1739594612307.429.
166+
167+
This property is only valid when `frameworkRenderingTiming` is present in [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry).
112168

113169
## Compatibility
114170

115171
import { LegacyCompatTable } from '@lynx';
116172

117-
<LegacyCompatTable metadata="lynx-api/performance-api/framework-pipeline-timing" />
173+
<LegacyCompatTable metadata="lynx-api/performance-api/framework-rendering-timing" />

docs/en/api/lynx-api/performance-api/performance-entry/load-bundle-entry.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,13 +199,13 @@ paintEnd: number;
199199

200200
The timestamp for the end of completing the final pixelation based on UI and UITree. This timestamp is represented as a floating-point Unix timestamp (in milliseconds) with three decimal places. For example: 1739594612307.429.
201201

202-
### frameworkPipelineTiming
202+
### frameworkRenderingTiming
203203

204204
```ts
205-
frameworkPipelineTiming: FrameworkPipelineTiming[keyof FrameworkPipelineTiming];
205+
frameworkRenderingTiming: FrameworkRenderingTiming;
206206
```
207207

208-
Performance data for key stages in [Framework Rendering](/guide/spec#framework-rendering). The type is [`FrameworkPipelineTiming`](/api/lynx-api/performance-api/framework-pipeline-timing).
208+
Performance data for key stages in [Framework Rendering](/guide/spec#framework-rendering). The type is [`FrameworkRenderingTiming`](/api/lynx-api/performance-api/framework-rendering-timing).
209209

210210
## Compatibility
211211

docs/en/api/lynx-api/performance-api/performance-entry/pipeline-entry.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { RuntimeBadge } from '@lynx';
44

55
`PipelineEntry` is responsible for recording performance data at key moments during the [Lynx Pipeline](/guide/spec#lynx-pipeline), specifically for [Framework Rendering](/guide/spec#framework-rendering) and [Pixel Pipeline](/guide/spec#pixel-pipeline). It inherits from [`PerformanceEntry`](../performance-entry).
66

7-
The Lynx Pipeline refers to the complete process from the trigger of rendering to the final display. This process is divided into four main parts: Load, Parse, Framework Rendering (FrameworkPipeline), and Engine Rendering (PixelPipeline).
7+
The Lynx Pipeline refers to the complete process from the trigger of rendering to the final display. This process is divided into four main parts: Load, Parse, Framework Rendering (FrameworkRendering), and Engine Rendering (PixelPipeline).
88

99
Due to the frequent triggering of the Lynx Pipeline, the framework only records the following two cases:
1010

@@ -171,13 +171,13 @@ paintEnd: number;
171171

172172
The timestamp for the end of completing the final pixelation based on UI and UITree. This timestamp is represented as a floating-point Unix timestamp (in milliseconds) with three decimal places. For example: 1739594612307.429.
173173

174-
### frameworkPipelineTiming
174+
### frameworkRenderingTiming
175175

176176
```ts
177-
frameworkPipelineTiming: FrameworkPipelineTiming[keyof FrameworkPipelineTiming];
177+
frameworkRenderingTiming: FrameworkRenderingTiming;
178178
```
179179

180-
Performance data for key stages in [Framework Rendering](/guide/spec#framework-rendering). The type is [`FrameworkPipelineTiming`](/api/lynx-api/performance-api/framework-pipeline-timing).
180+
Performance data for key stages in [Framework Rendering](/guide/spec#framework-rendering). The type is [`FrameworkRenderingTiming`](/api/lynx-api/performance-api/framework-rendering-timing).
181181

182182
## Compatibility
183183

docs/zh/api/lynx-api/performance-api/_meta.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
},
2626
{
2727
"type": "file",
28-
"name": "framework-pipeline-timing",
29-
"label": "FrameworkPipelineTiming",
28+
"name": "framework-rendering-timing",
29+
"label": "FrameworkRenderingTiming",
3030
"overviewHeaders": [],
3131
"collapsible": true,
3232
"collapsed": true

docs/zh/api/lynx-api/performance-api/framework-pipeline-timing.mdx renamed to docs/zh/api/lynx-api/performance-api/framework-rendering-timing.mdx

Lines changed: 61 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { RuntimeBadge } from '@lynx';
22

3-
# FrameworkPipelineTiming
3+
# FrameworkRenderingTiming
44

55
该接口描述了[框架渲染](/guide/spec#framework-rendering)中关键阶段的性能数据。
66

@@ -94,12 +94,8 @@ hydrateParseSnapshotStart: number;
9494

9595
框架在[后台线程](/guide/spec.html#background-thread-aka-off-main-thread)反序列化[主线程](/guide/spec.html#main-thread-or-lynx-main-thread)信息开始的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
9696

97-
:::tip
98-
9997
该属性仅当 `stage``hydrate` 时有效。
10098

101-
:::
102-
10399
### hydrateParseSnapshotEnd
104100

105101
```tsx
@@ -108,14 +104,70 @@ hydrateParseSnapshotEnd: number;
108104

109105
框架在[后台线程](/guide/spec.html#background-thread-aka-off-main-thread)反序列化[主线程](/guide/spec.html#main-thread-or-lynx-main-thread)信息结束的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
110106

111-
:::tip
112-
113107
该属性仅当 `stage``hydrate` 时有效。
114108

115-
:::
109+
### vmExecuteStart
110+
111+
```tsx
112+
vmExecuteStart: number;
113+
```
114+
115+
框架在主线程执行 [`main-thread.js`](/guide/spec.html#instances-of-main-thread-script) 初始化 [Javascript 引擎](/guide/spec.html#javascript-engine)开始的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
116+
117+
该属性仅当 `frameworkRenderingTiming` 存在于 [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry) 时有效。
118+
119+
### vmExecuteEnd
120+
121+
```tsx
122+
vmExecuteEnd: number;
123+
```
124+
125+
框架在主线程执行 [`main-thread.js`](/guide/spec.html#instances-of-main-thread-script) 初始化 [Javascript 引擎](/guide/spec.html#javascript-engine)结束的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
126+
127+
该属性仅当 `frameworkRenderingTiming` 存在于 [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry) 时有效。
128+
129+
### dataProcessorStart
130+
131+
```tsx
132+
dataProcessorStart: number;
133+
```
134+
135+
框架在主线程执行[数据预处理函数(DataProcessor)](api/react/interface.dataprocessordefinition) 进行初始数据处理开始的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
136+
137+
该属性仅当 `frameworkRenderingTiming` 存在于 [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry) 时有效。
138+
139+
### dataProcessorEnd
140+
141+
```tsx
142+
dataProcessorEnd: number;
143+
```
144+
145+
框架在主线程执行[数据预处理函数(DataProcessor)](api/react/interface.dataprocessordefinition) 进行初始数据处理结束的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
146+
147+
该属性仅当 `frameworkRenderingTiming` 存在于 [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry) 时有效。
148+
149+
### setInitDataStart
150+
151+
```tsx
152+
setInitDataStart: number;
153+
```
154+
155+
根据[数据预处理函数(DataProcessor)](api/react/interface.dataprocessordefinition) 的结果更新模版初始数据开始的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
156+
157+
该属性仅当 `frameworkRenderingTiming` 存在于 [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry) 时有效。
158+
159+
### setInitDataEnd
160+
161+
```tsx
162+
setInitDataEnd: number;
163+
```
164+
165+
根据[数据预处理函数(DataProcessor)](api/react/interface.dataprocessordefinition) 的结果更新模版初始数据结束的时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
166+
167+
该属性仅当 `frameworkRenderingTiming` 存在于 [LoadBundleEntry](/api/lynx-api/performance-api/performance-entry/load-bundle-entry) 时有效。
116168

117169
## 兼容性
118170

119171
import { LegacyCompatTable } from '@lynx';
120172

121-
<LegacyCompatTable metadata="lynx-api/performance-api/framework-pipeline-timing" />
173+
<LegacyCompatTable metadata="lynx-api/performance-api/framework-rendering-timing" />

docs/zh/api/lynx-api/performance-api/performance-entry/load-bundle-entry.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,13 +201,13 @@ paintEnd: number;
201201

202202
基于 UI 和 UITree,完成最终像素化的结束时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
203203

204-
### frameworkPipelineTiming
204+
### frameworkRenderingTiming
205205

206206
```ts
207-
frameworkPipelineTiming: FrameworkPipelineTiming[keyof FrameworkPipelineTiming];
207+
frameworkRenderingTiming: FrameworkRenderingTiming;
208208
```
209209

210-
[框架渲染](/guide/spec#framework-rendering)中关键阶段的性能数据. 类型为 [`FrameworkPipelineTiming`](/api/lynx-api/performance-api/framework-pipeline-timing)
210+
[框架渲染](/guide/spec#framework-rendering)中关键阶段的性能数据. 类型为 [`FrameworkRenderingTiming`](/api/lynx-api/performance-api/framework-rendering-timing)
211211

212212
## 兼容性
213213

docs/zh/api/lynx-api/performance-api/performance-entry/pipeline-entry.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { RuntimeBadge } from '@lynx';
44

55
`PipelineEntry` 负责记录 [Lynx Pipeline](/guide/spec#lynx-pipeline)[框架渲染(Framework Rendering)](/guide/spec#framework-rendering)[引擎渲染(Pixel Pipeline)](/guide/spec#pixel-pipeline)关键时刻的性能数据,继承自 [`PerformanceEntry`](../performance-entry)
66

7-
Lynx Pipeline 是指从渲染触发到最终显示的完整流程。该流程分为四个主要部分:加载(Load)、解析(Parse)、框架渲染(FrameworkPipeline)、引擎渲染(PixelPipeline)。
7+
Lynx Pipeline 是指从渲染触发到最终显示的完整流程。该流程分为四个主要部分:加载(Load)、解析(Parse)、框架渲染(FrameworkRendering)、引擎渲染(PixelPipeline)。
88

99
由于 Lynx Pipeline 触发频繁,框架仅统计以下两种情况:
1010

@@ -171,13 +171,13 @@ paintEnd: number;
171171

172172
基于 UI 和 UITree,完成最终像素化的结束时间戳。该时间戳是一个表示为浮点型的 Unix 时间戳(单位:毫秒),精确到小数点后三位。例如:1739594612307.429。
173173

174-
### frameworkPipelineTiming
174+
### frameworkRenderingTiming
175175

176176
```ts
177-
frameworkPipelineTiming: FrameworkPipelineTiming[keyof FrameworkPipelineTiming];
177+
frameworkRenderingTiming: FrameworkRenderingTiming;
178178
```
179179

180-
[框架渲染](/guide/spec#framework-rendering)中关键阶段的性能数据. 类型为 [`FrameworkPipelineTiming`](/api/lynx-api/performance-api/framework-pipeline-timing)
180+
[框架渲染](/guide/spec#framework-rendering)中关键阶段的性能数据. 类型为 [`frameworkRenderingTiming`](/api/lynx-api/performance-api/framework-rendering-timing)
181181

182182
## 兼容性
183183

packages/lynx-compat-data/lynx-api/performance-api/framework-pipeline-timing.json renamed to packages/lynx-compat-data/lynx-api/performance-api/framework-rendering-timing.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"lynx-api": {
33
"performance-api": {
4-
"framework-pipeline-timing": {
5-
"FrameworkPipelineTiming": {
4+
"framework-rendering-timing": {
5+
"FrameworkRenderingTiming": {
66
"__compat": {
77
"description": "",
8-
"lynx_path": "api/lynx-api/performance-api/framework-pipeline-timing",
8+
"lynx_path": "api/lynx-api/performance-api/framework-rendering-timing",
99
"support": {
1010
"android": {
1111
"version_added": "3.1"

packages/lynx-compat-data/lynx-api/performance-api/performance-entry/load-bundle-entry.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@
360360
}
361361
}
362362
},
363-
"frameworkPipelineTiming": {
363+
"frameworkRenderingTiming": {
364364
"__compat": {
365365
"description": "",
366366
"lynx_path": "api/lynx-api/performance-api/performance-entry/load-bundle-entry",

0 commit comments

Comments
 (0)