@paulirish/trace_engine 0.0.32 → 0.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (309) hide show
  1. package/.tmp/tsbuildinfo/analyze-trace.d.mts +18 -0
  2. package/.tmp/tsbuildinfo/analyze-trace.d.mts.map +1 -0
  3. package/.tmp/tsbuildinfo/models/trace/LanternComputationData.d.ts +46 -0
  4. package/.tmp/tsbuildinfo/models/trace/LanternComputationData.d.ts.map +1 -0
  5. package/.tmp/tsbuildinfo/models/trace/LegacyTracingModel.d.ts +2 -0
  6. package/.tmp/tsbuildinfo/models/trace/LegacyTracingModel.d.ts.map +1 -0
  7. package/.tmp/tsbuildinfo/models/trace/ModelImpl.d.ts +72 -0
  8. package/.tmp/tsbuildinfo/models/trace/ModelImpl.d.ts.map +1 -0
  9. package/.tmp/tsbuildinfo/models/trace/Processor.d.ts +25 -0
  10. package/.tmp/tsbuildinfo/models/trace/Processor.d.ts.map +1 -0
  11. package/.tmp/tsbuildinfo/models/trace/TracingManager.d.ts +2 -0
  12. package/.tmp/tsbuildinfo/models/trace/TracingManager.d.ts.map +1 -0
  13. package/.tmp/tsbuildinfo/models/trace/trace.d.ts +13 -0
  14. package/.tmp/tsbuildinfo/models/trace/trace.d.ts.map +1 -0
  15. package/.tmp/tsbuildinfo/test/test-trace-engine.d.mts +2 -0
  16. package/.tmp/tsbuildinfo/test/test-trace-engine.d.mts.map +1 -0
  17. package/.tmp/tsbuildinfo/third_party/third-party-web/third-party-web.d.ts +3 -0
  18. package/.tmp/tsbuildinfo/third_party/third-party-web/third-party-web.d.ts.map +1 -0
  19. package/.tmp/tsbuildinfo/tsconfig.tsbuildinfo +1 -0
  20. package/README.md +6 -10
  21. package/analyze-trace.mjs +51 -16
  22. package/core/platform/ArrayUtilities.js +1 -0
  23. package/core/platform/ArrayUtilities.js.map +1 -1
  24. package/core/platform/DevToolsPath.d.ts +1 -1
  25. package/core/platform/DevToolsPath.js.map +1 -1
  26. package/core/platform/MimeType.js +4 -2
  27. package/core/platform/MimeType.js.map +1 -1
  28. package/core/platform/NumberUtilities.js +8 -0
  29. package/core/platform/NumberUtilities.js.map +1 -1
  30. package/core/platform/ServerTiming.d.ts +31 -0
  31. package/core/platform/ServerTiming.js +212 -0
  32. package/core/platform/ServerTiming.js.map +1 -0
  33. package/core/platform/Timing.d.ts +1 -1
  34. package/core/platform/Timing.js.map +1 -1
  35. package/core/platform/TypescriptUtilities.d.ts +3 -0
  36. package/core/platform/TypescriptUtilities.js.map +1 -1
  37. package/core/platform/UIString.d.ts +1 -1
  38. package/core/platform/UIString.js.map +1 -1
  39. package/core/platform/UserVisibleError.d.ts +1 -1
  40. package/core/platform/UserVisibleError.js.map +1 -1
  41. package/core/platform/platform-tsconfig.json +1 -1
  42. package/core/platform/platform.d.ts +2 -2
  43. package/core/platform/platform.js +2 -2
  44. package/core/platform/platform.js.map +1 -1
  45. package/generated/protocol.d.ts +289 -16
  46. package/models/trace/LanternComputationData.d.ts +4 -4
  47. package/models/trace/LanternComputationData.js +22 -23
  48. package/models/trace/LanternComputationData.js.map +1 -1
  49. package/models/trace/ModelImpl.d.ts +11 -12
  50. package/models/trace/ModelImpl.js +22 -33
  51. package/models/trace/ModelImpl.js.map +1 -1
  52. package/models/trace/Processor.d.ts +21 -12
  53. package/models/trace/Processor.js +151 -67
  54. package/models/trace/Processor.js.map +1 -1
  55. package/models/trace/TracingManager.js.map +1 -1
  56. package/models/trace/extras/FetchNodes.d.ts +8 -8
  57. package/models/trace/extras/FetchNodes.js +16 -11
  58. package/models/trace/extras/FetchNodes.js.map +1 -1
  59. package/models/trace/extras/FilmStrip.d.ts +2 -2
  60. package/models/trace/extras/FilmStrip.js +8 -8
  61. package/models/trace/extras/FilmStrip.js.map +1 -1
  62. package/models/trace/extras/MainThreadActivity.d.ts +1 -1
  63. package/models/trace/extras/MainThreadActivity.js +1 -1
  64. package/models/trace/extras/MainThreadActivity.js.map +1 -1
  65. package/models/trace/extras/Metadata.js +2 -2
  66. package/models/trace/extras/Metadata.js.map +1 -1
  67. package/models/trace/extras/ThirdParties.d.ts +23 -0
  68. package/models/trace/extras/ThirdParties.js +152 -0
  69. package/models/trace/extras/ThirdParties.js.map +1 -0
  70. package/models/trace/extras/URLForEntry.d.ts +9 -1
  71. package/models/trace/extras/URLForEntry.js +18 -10
  72. package/models/trace/extras/URLForEntry.js.map +1 -1
  73. package/models/trace/extras/extras-tsconfig.json +1 -0
  74. package/models/trace/extras/extras.d.ts +4 -1
  75. package/models/trace/extras/extras.js +4 -1
  76. package/models/trace/extras/extras.js.map +1 -1
  77. package/models/trace/handlers/AnimationHandler.d.ts +2 -2
  78. package/models/trace/handlers/AnimationHandler.js +1 -1
  79. package/models/trace/handlers/AnimationHandler.js.map +1 -1
  80. package/models/trace/handlers/AuctionWorkletsHandler.d.ts +2 -2
  81. package/models/trace/handlers/AuctionWorkletsHandler.js +11 -11
  82. package/models/trace/handlers/AuctionWorkletsHandler.js.map +1 -1
  83. package/models/trace/handlers/ExtensionTraceDataHandler.d.ts +6 -6
  84. package/models/trace/handlers/ExtensionTraceDataHandler.js +12 -8
  85. package/models/trace/handlers/ExtensionTraceDataHandler.js.map +1 -1
  86. package/models/trace/handlers/FramesHandler.d.ts +34 -22
  87. package/models/trace/handlers/FramesHandler.js +54 -26
  88. package/models/trace/handlers/FramesHandler.js.map +1 -1
  89. package/models/trace/handlers/GPUHandler.d.ts +4 -4
  90. package/models/trace/handlers/GPUHandler.js +3 -3
  91. package/models/trace/handlers/GPUHandler.js.map +1 -1
  92. package/models/trace/handlers/ImagePaintingHandler.d.ts +3 -3
  93. package/models/trace/handlers/ImagePaintingHandler.js +6 -8
  94. package/models/trace/handlers/ImagePaintingHandler.js.map +1 -1
  95. package/models/trace/handlers/InitiatorsHandler.d.ts +3 -3
  96. package/models/trace/handlers/InitiatorsHandler.js +25 -14
  97. package/models/trace/handlers/InitiatorsHandler.js.map +1 -1
  98. package/models/trace/handlers/InvalidationsHandler.d.ts +4 -2
  99. package/models/trace/handlers/InvalidationsHandler.js +29 -11
  100. package/models/trace/handlers/InvalidationsHandler.js.map +1 -1
  101. package/models/trace/handlers/LargestImagePaintHandler.d.ts +2 -2
  102. package/models/trace/handlers/LargestImagePaintHandler.js +1 -1
  103. package/models/trace/handlers/LargestImagePaintHandler.js.map +1 -1
  104. package/models/trace/handlers/LargestTextPaintHandler.d.ts +2 -2
  105. package/models/trace/handlers/LargestTextPaintHandler.js +1 -1
  106. package/models/trace/handlers/LargestTextPaintHandler.js.map +1 -1
  107. package/models/trace/handlers/LayerTreeHandler.d.ts +6 -6
  108. package/models/trace/handlers/LayerTreeHandler.js +6 -6
  109. package/models/trace/handlers/LayerTreeHandler.js.map +1 -1
  110. package/models/trace/handlers/LayoutShiftsHandler.d.ts +14 -20
  111. package/models/trace/handlers/LayoutShiftsHandler.js +87 -12
  112. package/models/trace/handlers/LayoutShiftsHandler.js.map +1 -1
  113. package/models/trace/handlers/MemoryHandler.d.ts +2 -2
  114. package/models/trace/handlers/MemoryHandler.js +1 -1
  115. package/models/trace/handlers/MemoryHandler.js.map +1 -1
  116. package/models/trace/handlers/MetaHandler.d.ts +15 -14
  117. package/models/trace/handlers/MetaHandler.js +32 -30
  118. package/models/trace/handlers/MetaHandler.js.map +1 -1
  119. package/models/trace/handlers/ModelHandlers.d.ts +1 -1
  120. package/models/trace/handlers/ModelHandlers.js +1 -1
  121. package/models/trace/handlers/ModelHandlers.js.map +1 -1
  122. package/models/trace/handlers/NetworkRequestsHandler.d.ts +13 -12
  123. package/models/trace/handlers/NetworkRequestsHandler.js +68 -66
  124. package/models/trace/handlers/NetworkRequestsHandler.js.map +1 -1
  125. package/models/trace/handlers/PageFramesHandler.d.ts +2 -2
  126. package/models/trace/handlers/PageFramesHandler.js +2 -2
  127. package/models/trace/handlers/PageFramesHandler.js.map +1 -1
  128. package/models/trace/handlers/PageLoadMetricsHandler.d.ts +7 -7
  129. package/models/trace/handlers/PageLoadMetricsHandler.js +21 -24
  130. package/models/trace/handlers/PageLoadMetricsHandler.js.map +1 -1
  131. package/models/trace/handlers/RendererHandler.d.ts +19 -19
  132. package/models/trace/handlers/RendererHandler.js +5 -5
  133. package/models/trace/handlers/RendererHandler.js.map +1 -1
  134. package/models/trace/handlers/SamplesHandler.d.ts +6 -6
  135. package/models/trace/handlers/SamplesHandler.js +3 -3
  136. package/models/trace/handlers/SamplesHandler.js.map +1 -1
  137. package/models/trace/handlers/ScreenshotsHandler.d.ts +6 -4
  138. package/models/trace/handlers/ScreenshotsHandler.js +11 -9
  139. package/models/trace/handlers/ScreenshotsHandler.js.map +1 -1
  140. package/models/trace/handlers/SelectorStatsHandler.d.ts +3 -3
  141. package/models/trace/handlers/SelectorStatsHandler.js +2 -2
  142. package/models/trace/handlers/SelectorStatsHandler.js.map +1 -1
  143. package/models/trace/handlers/ServerTimingsHandler.d.ts +10 -0
  144. package/models/trace/handlers/ServerTimingsHandler.js +118 -0
  145. package/models/trace/handlers/ServerTimingsHandler.js.map +1 -0
  146. package/models/trace/handlers/Threads.d.ts +7 -7
  147. package/models/trace/handlers/Threads.js +5 -5
  148. package/models/trace/handlers/Threads.js.map +1 -1
  149. package/models/trace/handlers/UserInteractionsHandler.d.ts +13 -11
  150. package/models/trace/handlers/UserInteractionsHandler.js +13 -7
  151. package/models/trace/handlers/UserInteractionsHandler.js.map +1 -1
  152. package/models/trace/handlers/UserTimingsHandler.d.ts +5 -5
  153. package/models/trace/handlers/UserTimingsHandler.js +52 -9
  154. package/models/trace/handlers/UserTimingsHandler.js.map +1 -1
  155. package/models/trace/handlers/WarningsHandler.d.ts +5 -5
  156. package/models/trace/handlers/WarningsHandler.js +4 -5
  157. package/models/trace/handlers/WarningsHandler.js.map +1 -1
  158. package/models/trace/handlers/WorkersHandler.d.ts +4 -4
  159. package/models/trace/handlers/WorkersHandler.js +1 -1
  160. package/models/trace/handlers/WorkersHandler.js.map +1 -1
  161. package/models/trace/handlers/handlers-tsconfig.json +1 -1
  162. package/models/trace/handlers/types.d.ts +7 -7
  163. package/models/trace/handlers/types.js.map +1 -1
  164. package/models/trace/helpers/Extensions.d.ts +2 -2
  165. package/models/trace/helpers/Extensions.js.map +1 -1
  166. package/models/trace/helpers/Network.d.ts +2 -2
  167. package/models/trace/helpers/Network.js +19 -2
  168. package/models/trace/helpers/Network.js.map +1 -1
  169. package/models/trace/helpers/SamplesIntegrator.d.ts +5 -5
  170. package/models/trace/helpers/SamplesIntegrator.js +10 -11
  171. package/models/trace/helpers/SamplesIntegrator.js.map +1 -1
  172. package/models/trace/helpers/SyntheticEvents.d.ts +8 -14
  173. package/models/trace/helpers/SyntheticEvents.js +20 -31
  174. package/models/trace/helpers/SyntheticEvents.js.map +1 -1
  175. package/models/trace/helpers/Timing.d.ts +18 -4
  176. package/models/trace/helpers/Timing.js +43 -1
  177. package/models/trace/helpers/Timing.js.map +1 -1
  178. package/models/trace/helpers/Trace.d.ts +46 -32
  179. package/models/trace/helpers/Trace.js +53 -24
  180. package/models/trace/helpers/Trace.js.map +1 -1
  181. package/models/trace/helpers/TreeHelpers.d.ts +40 -8
  182. package/models/trace/helpers/TreeHelpers.js +147 -19
  183. package/models/trace/helpers/TreeHelpers.js.map +1 -1
  184. package/models/trace/helpers/helpers-tsconfig.json +3 -0
  185. package/models/trace/insights/Common.d.ts +4 -3
  186. package/models/trace/insights/Common.js +22 -7
  187. package/models/trace/insights/Common.js.map +1 -1
  188. package/models/trace/insights/CumulativeLayoutShift.d.ts +36 -13
  189. package/models/trace/insights/CumulativeLayoutShift.js +199 -73
  190. package/models/trace/insights/CumulativeLayoutShift.js.map +1 -1
  191. package/models/trace/insights/DocumentLatency.d.ts +9 -4
  192. package/models/trace/insights/DocumentLatency.js +82 -7
  193. package/models/trace/insights/DocumentLatency.js.map +1 -1
  194. package/models/trace/insights/FontDisplay.d.ts +11 -0
  195. package/models/trace/insights/FontDisplay.js +44 -0
  196. package/models/trace/insights/FontDisplay.js.map +1 -0
  197. package/models/trace/insights/InsightRunners.d.ts +3 -0
  198. package/models/trace/insights/InsightRunners.js +3 -0
  199. package/models/trace/insights/InsightRunners.js.map +1 -1
  200. package/models/trace/insights/InteractionToNextPaint.d.ts +4 -5
  201. package/models/trace/insights/InteractionToNextPaint.js +5 -3
  202. package/models/trace/insights/InteractionToNextPaint.js.map +1 -1
  203. package/models/trace/insights/LargestContentfulPaint.d.ts +20 -7
  204. package/models/trace/insights/LargestContentfulPaint.js +57 -37
  205. package/models/trace/insights/LargestContentfulPaint.js.map +1 -1
  206. package/models/trace/insights/RenderBlocking.d.ts +3 -3
  207. package/models/trace/insights/RenderBlocking.js +29 -24
  208. package/models/trace/insights/RenderBlocking.js.map +1 -1
  209. package/models/trace/insights/SlowCSSSelector.d.ts +11 -0
  210. package/models/trace/insights/SlowCSSSelector.js +67 -0
  211. package/models/trace/insights/SlowCSSSelector.js.map +1 -0
  212. package/models/trace/insights/ThirdPartyWeb.d.ts +13 -0
  213. package/models/trace/insights/ThirdPartyWeb.js +42 -0
  214. package/models/trace/insights/ThirdPartyWeb.js.map +1 -0
  215. package/models/trace/insights/Viewport.d.ts +5 -2
  216. package/models/trace/insights/Viewport.js +14 -9
  217. package/models/trace/insights/Viewport.js.map +1 -1
  218. package/models/trace/insights/insights-tsconfig.json +9 -0
  219. package/models/trace/insights/insights.d.ts +1 -0
  220. package/models/trace/insights/insights.js +1 -0
  221. package/models/trace/insights/insights.js.map +1 -1
  222. package/models/trace/insights/types.d.ts +43 -25
  223. package/models/trace/insights/types.js.map +1 -1
  224. package/models/trace/lantern/core/NetworkAnalyzer.d.ts +9 -9
  225. package/models/trace/lantern/core/NetworkAnalyzer.js +18 -15
  226. package/models/trace/lantern/core/NetworkAnalyzer.js.map +1 -1
  227. package/models/trace/lantern/graph/BaseNode.d.ts +4 -4
  228. package/models/trace/lantern/graph/BaseNode.js +21 -21
  229. package/models/trace/lantern/graph/BaseNode.js.map +1 -1
  230. package/models/trace/lantern/graph/CPUNode.d.ts +1 -1
  231. package/models/trace/lantern/graph/CPUNode.js +5 -5
  232. package/models/trace/lantern/graph/CPUNode.js.map +1 -1
  233. package/models/trace/lantern/graph/PageDependencyGraph.d.ts +4 -4
  234. package/models/trace/lantern/graph/PageDependencyGraph.js +5 -5
  235. package/models/trace/lantern/graph/PageDependencyGraph.js.map +1 -1
  236. package/models/trace/lantern/simulation/ConnectionPool.d.ts +7 -7
  237. package/models/trace/lantern/simulation/ConnectionPool.js +26 -26
  238. package/models/trace/lantern/simulation/ConnectionPool.js.map +1 -1
  239. package/models/trace/lantern/simulation/DNSCache.d.ts +3 -3
  240. package/models/trace/lantern/simulation/DNSCache.js +11 -11
  241. package/models/trace/lantern/simulation/DNSCache.js.map +1 -1
  242. package/models/trace/lantern/simulation/SimulationTimingMap.d.ts +1 -1
  243. package/models/trace/lantern/simulation/SimulationTimingMap.js +15 -15
  244. package/models/trace/lantern/simulation/SimulationTimingMap.js.map +1 -1
  245. package/models/trace/lantern/simulation/Simulator.d.ts +28 -28
  246. package/models/trace/lantern/simulation/Simulator.js +113 -113
  247. package/models/trace/lantern/simulation/Simulator.js.map +1 -1
  248. package/models/trace/lantern/simulation/TCPConnection.d.ts +9 -9
  249. package/models/trace/lantern/simulation/TCPConnection.js +36 -36
  250. package/models/trace/lantern/simulation/TCPConnection.js.map +1 -1
  251. package/models/trace/root-causes/LayoutShift.d.ts +13 -13
  252. package/models/trace/root-causes/LayoutShift.js +7 -25
  253. package/models/trace/root-causes/LayoutShift.js.map +1 -1
  254. package/models/trace/types/Configuration.d.ts +16 -0
  255. package/models/trace/types/Configuration.js +1 -0
  256. package/models/trace/types/Configuration.js.map +1 -1
  257. package/models/trace/types/Extensions.d.ts +9 -12
  258. package/models/trace/types/Extensions.js +2 -1
  259. package/models/trace/types/Extensions.js.map +1 -1
  260. package/models/trace/types/File.d.ts +55 -23
  261. package/models/trace/types/File.js +15 -3
  262. package/models/trace/types/File.js.map +1 -1
  263. package/models/trace/types/TraceEvents.d.ts +868 -713
  264. package/models/trace/types/TraceEvents.js +281 -276
  265. package/models/trace/types/TraceEvents.js.map +1 -1
  266. package/models/trace/types/types.d.ts +1 -1
  267. package/models/trace/types/types.js +1 -1
  268. package/models/trace/types/types.js.map +1 -1
  269. package/package.json +10 -4
  270. package/test/test-trace-engine.mjs +56 -3
  271. package/third_party/third-party-web/third-party-web.js +1 -0
  272. package/tsconfig.json +29 -0
  273. package/core/platform/PromiseUtilities.d.ts +0 -10
  274. package/core/platform/PromiseUtilities.js +0 -18
  275. package/core/platform/PromiseUtilities.js.map +0 -1
  276. package/core/platform/SetUtilities.d.ts +0 -2
  277. package/core/platform/SetUtilities.js +0 -23
  278. package/core/platform/SetUtilities.js.map +0 -1
  279. package/models/trace/EntriesFilter.d.ts +0 -72
  280. package/models/trace/EntriesFilter.js +0 -296
  281. package/models/trace/EntriesFilter.js.map +0 -1
  282. package/models/trace/LegacyTracingModel.js.map +0 -1
  283. package/models/trace/handlers/EnhancedTracesHandler.d.ts +0 -48
  284. package/models/trace/handlers/EnhancedTracesHandler.js +0 -165
  285. package/models/trace/handlers/EnhancedTracesHandler.js.map +0 -1
  286. package/models/trace/lantern/BaseNode.d.ts +0 -91
  287. package/models/trace/lantern/BaseNode.js +0 -268
  288. package/models/trace/lantern/BaseNode.js.map +0 -1
  289. package/models/trace/lantern/CPUNode.d.ts +0 -24
  290. package/models/trace/lantern/CPUNode.js +0 -64
  291. package/models/trace/lantern/CPUNode.js.map +0 -1
  292. package/models/trace/lantern/LanternError.d.ts +0 -3
  293. package/models/trace/lantern/LanternError.js +0 -7
  294. package/models/trace/lantern/LanternError.js.map +0 -1
  295. package/models/trace/lantern/MetricsModule.d.ts +0 -11
  296. package/models/trace/lantern/MetricsModule.js +0 -14
  297. package/models/trace/lantern/MetricsModule.js.map +0 -1
  298. package/models/trace/lantern/NetworkNode.d.ts +0 -22
  299. package/models/trace/lantern/NetworkNode.js +0 -83
  300. package/models/trace/lantern/NetworkNode.js.map +0 -1
  301. package/models/trace/lantern/PageDependencyGraph.d.ts +0 -43
  302. package/models/trace/lantern/PageDependencyGraph.js +0 -509
  303. package/models/trace/lantern/PageDependencyGraph.js.map +0 -1
  304. package/models/trace/lantern/SimulationModule.d.ts +0 -17
  305. package/models/trace/lantern/SimulationModule.js +0 -13
  306. package/models/trace/lantern/SimulationModule.js.map +0 -1
  307. package/models/trace/lantern/simulation/NetworkAnalyzer.d.ts +0 -112
  308. package/models/trace/lantern/simulation/NetworkAnalyzer.js +0 -486
  309. package/models/trace/lantern/simulation/NetworkAnalyzer.js.map +0 -1
@@ -1,9 +1,10 @@
1
1
  import type * as Handlers from '../handlers/handlers.js';
2
2
  import type * as Types from '../types/types.js';
3
- import { type NavigationInsightContext } from './types.js';
3
+ import type { InsightResults, InsightSetContextWithNavigation, TraceInsightSets } from './types.js';
4
+ export declare function getInsight<InsightName extends keyof InsightResults>(insightName: InsightName, insights: TraceInsightSets | null, key: string | null): InsightResults[InsightName] | null;
4
5
  /**
5
6
  * Finds a network request given a navigation context and URL.
6
7
  * Considers redirects.
7
8
  */
8
- export declare function findRequest(traceData: Pick<Handlers.Types.TraceParseData, 'Meta' | 'NetworkRequests'>, context: NavigationInsightContext, url: string): Types.TraceEvents.SyntheticNetworkRequest | null;
9
- export declare function findLCPRequest(traceData: Pick<Handlers.Types.TraceParseData, 'Meta' | 'NetworkRequests' | 'LargestImagePaint'>, context: NavigationInsightContext, lcpEvent: Types.TraceEvents.TraceEventLargestContentfulPaintCandidate): Types.TraceEvents.SyntheticNetworkRequest | null;
9
+ export declare function findRequest(parsedTrace: Pick<Handlers.Types.ParsedTrace, 'Meta' | 'NetworkRequests'>, context: InsightSetContextWithNavigation, url: string): Types.Events.SyntheticNetworkRequest | null;
10
+ export declare function findLCPRequest(parsedTrace: Pick<Handlers.Types.ParsedTrace, 'Meta' | 'NetworkRequests' | 'LargestImagePaint'>, context: InsightSetContextWithNavigation, lcpEvent: Types.Events.LargestContentfulPaintCandidate): Types.Events.SyntheticNetworkRequest | null;
@@ -2,27 +2,42 @@
2
2
  // Use of this source code is governed by a BSD-style license that can be
3
3
  // found in the LICENSE file.
4
4
  import * as Helpers from '../helpers/helpers.js';
5
+ export function getInsight(insightName, insights, key) {
6
+ if (!insights || !key) {
7
+ return null;
8
+ }
9
+ const insightSets = insights.get(key);
10
+ if (!insightSets) {
11
+ return null;
12
+ }
13
+ const insight = insightSets.data[insightName];
14
+ if (insight instanceof Error) {
15
+ return null;
16
+ }
17
+ // For some reason typescript won't narrow the type by removing Error, so do it manually.
18
+ return insight;
19
+ }
5
20
  /**
6
21
  * Finds a network request given a navigation context and URL.
7
22
  * Considers redirects.
8
23
  */
9
- export function findRequest(traceData, context, url) {
10
- const request = traceData.NetworkRequests.byTime.find(req => {
24
+ export function findRequest(parsedTrace, context, url) {
25
+ const request = parsedTrace.NetworkRequests.byTime.find(req => {
11
26
  const urlMatch = req.args.data.url === url || req.args.data.redirects.some(r => r.url === url);
12
27
  if (!urlMatch) {
13
28
  return false;
14
29
  }
15
- const nav = Helpers.Trace.getNavigationForTraceEvent(req, context.frameId, traceData.Meta.navigationsByFrameId);
16
- return nav?.args.data?.navigationId === context.navigationId;
30
+ const nav = Helpers.Trace.getNavigationForTraceEvent(req, context.frameId, parsedTrace.Meta.navigationsByFrameId);
31
+ return nav === context.navigation;
17
32
  });
18
33
  return request ?? null;
19
34
  }
20
- export function findLCPRequest(traceData, context, lcpEvent) {
35
+ export function findLCPRequest(parsedTrace, context, lcpEvent) {
21
36
  const lcpNodeId = lcpEvent.args.data?.nodeId;
22
37
  if (!lcpNodeId) {
23
38
  throw new Error('no lcp node id');
24
39
  }
25
- const imagePaint = traceData.LargestImagePaint.get(lcpNodeId);
40
+ const imagePaint = parsedTrace.LargestImagePaint.get(lcpNodeId);
26
41
  if (!imagePaint) {
27
42
  return null;
28
43
  }
@@ -30,7 +45,7 @@ export function findLCPRequest(traceData, context, lcpEvent) {
30
45
  if (!lcpUrl) {
31
46
  throw new Error('no lcp url');
32
47
  }
33
- const lcpRequest = findRequest(traceData, context, lcpUrl);
48
+ const lcpRequest = findRequest(parsedTrace, context, lcpUrl);
34
49
  if (!lcpRequest) {
35
50
  throw new Error('no lcp request found');
36
51
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/Common.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAG7B,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AAKjD;;;GAGG;AACH,MAAM,UAAU,WAAW,CACvB,SAAwE,EAAE,OAAiC,EAC3G,GAAW;IACb,MAAM,OAAO,GAAG,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC1D,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC/F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAChH,OAAO,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,YAAY,CAAC;IAC/D,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,IAAI,IAAI,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,cAAc,CAC1B,SAA4F,EAC5F,OAAiC,EAAE,QAAqE;IAE1G,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;IAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,UAAU,GAAG,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAE3D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport type * as Handlers from '../handlers/handlers.js';\nimport * as Helpers from '../helpers/helpers.js';\nimport type * as Types from '../types/types.js';\n\nimport {type NavigationInsightContext} from './types.js';\n\n/**\n * Finds a network request given a navigation context and URL.\n * Considers redirects.\n */\nexport function findRequest(\n traceData: Pick<Handlers.Types.TraceParseData, 'Meta'|'NetworkRequests'>, context: NavigationInsightContext,\n url: string): Types.TraceEvents.SyntheticNetworkRequest|null {\n const request = traceData.NetworkRequests.byTime.find(req => {\n const urlMatch = req.args.data.url === url || req.args.data.redirects.some(r => r.url === url);\n if (!urlMatch) {\n return false;\n }\n\n const nav = Helpers.Trace.getNavigationForTraceEvent(req, context.frameId, traceData.Meta.navigationsByFrameId);\n return nav?.args.data?.navigationId === context.navigationId;\n });\n return request ?? null;\n}\n\nexport function findLCPRequest(\n traceData: Pick<Handlers.Types.TraceParseData, 'Meta'|'NetworkRequests'|'LargestImagePaint'>,\n context: NavigationInsightContext, lcpEvent: Types.TraceEvents.TraceEventLargestContentfulPaintCandidate):\n Types.TraceEvents.SyntheticNetworkRequest|null {\n const lcpNodeId = lcpEvent.args.data?.nodeId;\n if (!lcpNodeId) {\n throw new Error('no lcp node id');\n }\n\n const imagePaint = traceData.LargestImagePaint.get(lcpNodeId);\n if (!imagePaint) {\n return null;\n }\n\n const lcpUrl = imagePaint.args.data?.imageUrl;\n if (!lcpUrl) {\n throw new Error('no lcp url');\n }\n const lcpRequest = findRequest(traceData, context, lcpUrl);\n\n if (!lcpRequest) {\n throw new Error('no lcp request found');\n }\n\n return lcpRequest;\n}\n"]}
1
+ {"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/Common.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAG7B,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AAKjD,MAAM,UAAU,UAAU,CACtB,WAAwB,EAAE,QAA+B,EAAE,GAAgB;IAC7E,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,IAAI,OAAO,YAAY,KAAK,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,yFAAyF;IACzF,OAAO,OAAsC,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CACvB,WAAuE,EAAE,OAAwC,EACjH,GAAW;IACb,MAAM,OAAO,GAAG,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC5D,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC/F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAClH,OAAO,GAAG,KAAK,OAAO,CAAC,UAAU,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,IAAI,IAAI,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,cAAc,CAC1B,WAA2F,EAC3F,OAAwC,EACxC,QAAsD;IACxD,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;IAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAChE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAE7D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport type * as Handlers from '../handlers/handlers.js';\nimport * as Helpers from '../helpers/helpers.js';\nimport type * as Types from '../types/types.js';\n\nimport type {InsightResults, InsightSetContextWithNavigation, TraceInsightSets} from './types.js';\n\nexport function getInsight<InsightName extends keyof InsightResults>(\n insightName: InsightName, insights: TraceInsightSets|null, key: string|null): InsightResults[InsightName]|null {\n if (!insights || !key) {\n return null;\n }\n\n const insightSets = insights.get(key);\n if (!insightSets) {\n return null;\n }\n\n const insight = insightSets.data[insightName];\n if (insight instanceof Error) {\n return null;\n }\n\n // For some reason typescript won't narrow the type by removing Error, so do it manually.\n return insight as InsightResults[InsightName];\n}\n\n/**\n * Finds a network request given a navigation context and URL.\n * Considers redirects.\n */\nexport function findRequest(\n parsedTrace: Pick<Handlers.Types.ParsedTrace, 'Meta'|'NetworkRequests'>, context: InsightSetContextWithNavigation,\n url: string): Types.Events.SyntheticNetworkRequest|null {\n const request = parsedTrace.NetworkRequests.byTime.find(req => {\n const urlMatch = req.args.data.url === url || req.args.data.redirects.some(r => r.url === url);\n if (!urlMatch) {\n return false;\n }\n\n const nav = Helpers.Trace.getNavigationForTraceEvent(req, context.frameId, parsedTrace.Meta.navigationsByFrameId);\n return nav === context.navigation;\n });\n return request ?? null;\n}\n\nexport function findLCPRequest(\n parsedTrace: Pick<Handlers.Types.ParsedTrace, 'Meta'|'NetworkRequests'|'LargestImagePaint'>,\n context: InsightSetContextWithNavigation,\n lcpEvent: Types.Events.LargestContentfulPaintCandidate): Types.Events.SyntheticNetworkRequest|null {\n const lcpNodeId = lcpEvent.args.data?.nodeId;\n if (!lcpNodeId) {\n throw new Error('no lcp node id');\n }\n\n const imagePaint = parsedTrace.LargestImagePaint.get(lcpNodeId);\n if (!imagePaint) {\n return null;\n }\n\n const lcpUrl = imagePaint.args.data?.imageUrl;\n if (!lcpUrl) {\n throw new Error('no lcp url');\n }\n const lcpRequest = findRequest(parsedTrace, context, lcpUrl);\n\n if (!lcpRequest) {\n throw new Error('no lcp request found');\n }\n\n return lcpRequest;\n}\n"]}
@@ -1,13 +1,32 @@
1
+ import type * as Protocol from '../../../generated/protocol.js';
1
2
  import * as Types from '../types/types.js';
2
- import { type InsightResult, type NavigationInsightContext, type RequiredData } from './types.js';
3
+ import type { InsightResult, InsightSetContext, RequiredData } from './types.js';
4
+ export type CLSInsightResult = InsightResult<{
5
+ animationFailures: readonly NoncompositedAnimationFailure[];
6
+ shifts: Map<Types.Events.SyntheticLayoutShift, LayoutShiftRootCausesData>;
7
+ clusters: Types.Events.SyntheticLayoutShiftCluster[];
8
+ worstCluster: Types.Events.SyntheticLayoutShiftCluster | undefined;
9
+ }>;
3
10
  export declare function deps(): ['Meta', 'Animations', 'LayoutShifts', 'NetworkRequests'];
4
11
  export declare const enum AnimationFailureReasons {
5
- UNSUPPORTED_CSS_PROPERTY = "UNSUPPORTED_CSS_PROPERTY",
12
+ ACCELERATED_ANIMATIONS_DISABLED = "ACCELERATED_ANIMATIONS_DISABLED",
13
+ EFFECT_SUPPRESSED_BY_DEVTOOLS = "EFFECT_SUPPRESSED_BY_DEVTOOLS",
14
+ INVALID_ANIMATION_OR_EFFECT = "INVALID_ANIMATION_OR_EFFECT",
15
+ EFFECT_HAS_UNSUPPORTED_TIMING_PARAMS = "EFFECT_HAS_UNSUPPORTED_TIMING_PARAMS",
16
+ EFFECT_HAS_NON_REPLACE_COMPOSITE_MODE = "EFFECT_HAS_NON_REPLACE_COMPOSITE_MODE",
17
+ TARGET_HAS_INVALID_COMPOSITING_STATE = "TARGET_HAS_INVALID_COMPOSITING_STATE",
18
+ TARGET_HAS_INCOMPATIBLE_ANIMATIONS = "TARGET_HAS_INCOMPATIBLE_ANIMATIONS",
19
+ TARGET_HAS_CSS_OFFSET = "TARGET_HAS_CSS_OFFSET",
20
+ ANIMATION_AFFECTS_NON_CSS_PROPERTIES = "ANIMATION_AFFECTS_NON_CSS_PROPERTIES",
21
+ TRANSFORM_RELATED_PROPERTY_CANNOT_BE_ACCELERATED_ON_TARGET = "TRANSFORM_RELATED_PROPERTY_CANNOT_BE_ACCELERATED_ON_TARGET",
6
22
  TRANSFROM_BOX_SIZE_DEPENDENT = "TRANSFROM_BOX_SIZE_DEPENDENT",
7
- FILTER_MAY_MOVE_PIXELS = "FILTER_MAY_MOVE_PIXELS",
8
- NON_REPLACE_COMPOSITE_MODE = "NON_REPLACE_COMPOSITE_MODE",
9
- INCOMPATIBLE_ANIMATIONS = "INCOMPATIBLE_ANIMATIONS",
10
- UNSUPPORTED_TIMING_PARAMS = "UNSUPPORTED_TIMING_PARAMS"
23
+ FILTER_RELATED_PROPERTY_MAY_MOVE_PIXELS = "FILTER_RELATED_PROPERTY_MAY_MOVE_PIXELS",
24
+ UNSUPPORTED_CSS_PROPERTY = "UNSUPPORTED_CSS_PROPERTY",
25
+ MIXED_KEYFRAME_VALUE_TYPES = "MIXED_KEYFRAME_VALUE_TYPES",
26
+ TIMELINE_SOURCE_HAS_INVALID_COMPOSITING_STATE = "TIMELINE_SOURCE_HAS_INVALID_COMPOSITING_STATE",
27
+ ANIMATION_HAS_NO_VISIBLE_CHANGE = "ANIMATION_HAS_NO_VISIBLE_CHANGE",
28
+ AFFECTS_IMPORTANT_PROPERTY = "AFFECTS_IMPORTANT_PROPERTY",
29
+ SVG_TARGET_HAS_INDEPENDENT_TRANSFORM_PROPERTY = "SVG_TARGET_HAS_INDEPENDENT_TRANSFORM_PROPERTY"
11
30
  }
12
31
  export interface NoncompositedAnimationFailure {
13
32
  /**
@@ -22,13 +41,17 @@ export interface NoncompositedAnimationFailure {
22
41
  /**
23
42
  * Unsupported properties.
24
43
  */
25
- unsupportedProperties?: Types.TraceEvents.TraceEventAnimation['args']['data']['unsupportedProperties'];
44
+ unsupportedProperties?: Types.Events.Animation['args']['data']['unsupportedProperties'];
45
+ /**
46
+ * Animation event.
47
+ */
48
+ animation?: Types.Events.SyntheticAnimationPair;
26
49
  }
27
50
  export interface LayoutShiftRootCausesData {
28
- iframes: Types.TraceEvents.TraceEventRenderFrameImplCreateChildFrame[];
29
- fontRequests: Types.TraceEvents.SyntheticNetworkRequest[];
51
+ iframeIds: string[];
52
+ fontRequests: Types.Events.SyntheticNetworkRequest[];
53
+ nonCompositedAnimations: NoncompositedAnimationFailure[];
54
+ unsizedImages: Protocol.DOM.BackendNodeId[];
30
55
  }
31
- export declare function generateInsight(traceParsedData: RequiredData<typeof deps>, context: NavigationInsightContext): InsightResult<{
32
- animationFailures?: readonly NoncompositedAnimationFailure[];
33
- shifts?: Map<Types.TraceEvents.TraceEventLayoutShift, LayoutShiftRootCausesData>;
34
- }>;
56
+ export declare function getNonCompositedFailure(animationEvent: Types.Events.SyntheticAnimationPair): NoncompositedAnimationFailure[];
57
+ export declare function generateInsight(parsedTrace: RequiredData<typeof deps>, context: InsightSetContext): CLSInsightResult;
@@ -15,8 +15,45 @@ export function deps() {
15
15
  */
16
16
  const ACTIONABLE_FAILURE_REASONS = [
17
17
  {
18
- flag: 1 << 13,
19
- failure: "UNSUPPORTED_CSS_PROPERTY" /* AnimationFailureReasons.UNSUPPORTED_CSS_PROPERTY */,
18
+ flag: 1 << 0,
19
+ failure: "ACCELERATED_ANIMATIONS_DISABLED" /* AnimationFailureReasons.ACCELERATED_ANIMATIONS_DISABLED */,
20
+ },
21
+ {
22
+ flag: 1 << 1,
23
+ failure: "EFFECT_SUPPRESSED_BY_DEVTOOLS" /* AnimationFailureReasons.EFFECT_SUPPRESSED_BY_DEVTOOLS */,
24
+ },
25
+ {
26
+ flag: 1 << 2,
27
+ failure: "INVALID_ANIMATION_OR_EFFECT" /* AnimationFailureReasons.INVALID_ANIMATION_OR_EFFECT */,
28
+ },
29
+ {
30
+ flag: 1 << 3,
31
+ failure: "EFFECT_HAS_UNSUPPORTED_TIMING_PARAMS" /* AnimationFailureReasons.EFFECT_HAS_UNSUPPORTED_TIMING_PARAMS */,
32
+ },
33
+ {
34
+ flag: 1 << 4,
35
+ failure: "EFFECT_HAS_NON_REPLACE_COMPOSITE_MODE" /* AnimationFailureReasons.EFFECT_HAS_NON_REPLACE_COMPOSITE_MODE */,
36
+ },
37
+ {
38
+ flag: 1 << 5,
39
+ failure: "TARGET_HAS_INVALID_COMPOSITING_STATE" /* AnimationFailureReasons.TARGET_HAS_INVALID_COMPOSITING_STATE */,
40
+ },
41
+ {
42
+ flag: 1 << 6,
43
+ failure: "TARGET_HAS_INCOMPATIBLE_ANIMATIONS" /* AnimationFailureReasons.TARGET_HAS_INCOMPATIBLE_ANIMATIONS */,
44
+ },
45
+ {
46
+ flag: 1 << 7,
47
+ failure: "TARGET_HAS_CSS_OFFSET" /* AnimationFailureReasons.TARGET_HAS_CSS_OFFSET */,
48
+ },
49
+ // The failure 1 << 8 is marked as obsolete in Blink
50
+ {
51
+ flag: 1 << 9,
52
+ failure: "ANIMATION_AFFECTS_NON_CSS_PROPERTIES" /* AnimationFailureReasons.ANIMATION_AFFECTS_NON_CSS_PROPERTIES */,
53
+ },
54
+ {
55
+ flag: 1 << 10,
56
+ failure: "TRANSFORM_RELATED_PROPERTY_CANNOT_BE_ACCELERATED_ON_TARGET" /* AnimationFailureReasons.TRANSFORM_RELATED_PROPERTY_CANNOT_BE_ACCELERATED_ON_TARGET */,
20
57
  },
21
58
  {
22
59
  flag: 1 << 11,
@@ -24,58 +61,106 @@ const ACTIONABLE_FAILURE_REASONS = [
24
61
  },
25
62
  {
26
63
  flag: 1 << 12,
27
- failure: "FILTER_MAY_MOVE_PIXELS" /* AnimationFailureReasons.FILTER_MAY_MOVE_PIXELS */,
64
+ failure: "FILTER_RELATED_PROPERTY_MAY_MOVE_PIXELS" /* AnimationFailureReasons.FILTER_RELATED_PROPERTY_MAY_MOVE_PIXELS */,
28
65
  },
29
66
  {
30
- flag: 1 << 4,
31
- failure: "NON_REPLACE_COMPOSITE_MODE" /* AnimationFailureReasons.NON_REPLACE_COMPOSITE_MODE */,
67
+ flag: 1 << 13,
68
+ failure: "UNSUPPORTED_CSS_PROPERTY" /* AnimationFailureReasons.UNSUPPORTED_CSS_PROPERTY */,
32
69
  },
70
+ // The failure 1 << 14 is marked as obsolete in Blink
33
71
  {
34
- flag: 1 << 6,
35
- failure: "INCOMPATIBLE_ANIMATIONS" /* AnimationFailureReasons.INCOMPATIBLE_ANIMATIONS */,
72
+ flag: 1 << 15,
73
+ failure: "MIXED_KEYFRAME_VALUE_TYPES" /* AnimationFailureReasons.MIXED_KEYFRAME_VALUE_TYPES */,
36
74
  },
37
75
  {
38
- flag: 1 << 3,
39
- failure: "UNSUPPORTED_TIMING_PARAMS" /* AnimationFailureReasons.UNSUPPORTED_TIMING_PARAMS */,
76
+ flag: 1 << 16,
77
+ failure: "TIMELINE_SOURCE_HAS_INVALID_COMPOSITING_STATE" /* AnimationFailureReasons.TIMELINE_SOURCE_HAS_INVALID_COMPOSITING_STATE */,
78
+ },
79
+ {
80
+ flag: 1 << 17,
81
+ failure: "ANIMATION_HAS_NO_VISIBLE_CHANGE" /* AnimationFailureReasons.ANIMATION_HAS_NO_VISIBLE_CHANGE */,
82
+ },
83
+ {
84
+ flag: 1 << 18,
85
+ failure: "AFFECTS_IMPORTANT_PROPERTY" /* AnimationFailureReasons.AFFECTS_IMPORTANT_PROPERTY */,
86
+ },
87
+ {
88
+ flag: 1 << 19,
89
+ failure: "SVG_TARGET_HAS_INDEPENDENT_TRANSFORM_PROPERTY" /* AnimationFailureReasons.SVG_TARGET_HAS_INDEPENDENT_TRANSFORM_PROPERTY */,
40
90
  },
41
91
  ];
42
92
  // 500ms window.
43
93
  // Use this window to consider events and requests that may have caused a layout shift.
44
- const INVALIDATION_WINDOW = Helpers.Timing.secondsToMicroseconds(Types.Timing.Seconds(0.5));
45
- function isInInvalidationWindow(event, targetEvent) {
46
- const eventEnd = event.dur ? event.ts + event.dur : event.ts;
47
- return eventEnd < targetEvent.ts && eventEnd >= targetEvent.ts - INVALIDATION_WINDOW;
48
- }
94
+ const ROOT_CAUSE_WINDOW = Helpers.Timing.secondsToMicroseconds(Types.Timing.Seconds(0.5));
49
95
  /**
50
- * Returns a list of NoncompositedAnimationFailures.
96
+ * Returns if an event happens within the root cause window, before the target event.
97
+ * ROOT_CAUSE_WINDOW v target event
98
+ * |------------------------|=======================
51
99
  */
52
- function getNonCompositedAnimations(animations) {
100
+ function isInRootCauseWindow(event, targetEvent) {
101
+ const eventEnd = event.dur ? event.ts + event.dur : event.ts;
102
+ return eventEnd < targetEvent.ts && eventEnd >= targetEvent.ts - ROOT_CAUSE_WINDOW;
103
+ }
104
+ export function getNonCompositedFailure(animationEvent) {
53
105
  const failures = [];
54
- for (const event of animations) {
55
- const beginEvent = event.args.data.beginEvent;
56
- const instantEvents = event.args.data.instantEvents || [];
106
+ const beginEvent = animationEvent.args.data.beginEvent;
107
+ const instantEvents = animationEvent.args.data.instantEvents || [];
108
+ /**
109
+ * Animation events containing composite information are ASYNC_NESTABLE_INSTANT ('n').
110
+ * An animation may also contain multiple 'n' events, so we look through those with useful non-composited data.
111
+ */
112
+ for (const event of instantEvents) {
113
+ const failureMask = event.args.data.compositeFailed;
114
+ const unsupportedProperties = event.args.data.unsupportedProperties;
115
+ if (!failureMask) {
116
+ continue;
117
+ }
118
+ const failureReasons = ACTIONABLE_FAILURE_REASONS.filter(reason => failureMask & reason.flag).map(reason => reason.failure);
119
+ const failure = {
120
+ name: beginEvent.args.data.displayName,
121
+ failureReasons,
122
+ unsupportedProperties,
123
+ animation: animationEvent,
124
+ };
125
+ failures.push(failure);
126
+ }
127
+ return failures;
128
+ }
129
+ function getNonCompositedFailureRootCauses(animationEvents, prePaintEvents, shiftsByPrePaint, rootCausesByShift) {
130
+ const allAnimationFailures = [];
131
+ for (const animation of animationEvents) {
57
132
  /**
58
133
  * Animation events containing composite information are ASYNC_NESTABLE_INSTANT ('n').
59
134
  * An animation may also contain multiple 'n' events, so we look through those with useful non-composited data.
60
135
  */
61
- for (const event of instantEvents) {
62
- const failureMask = event.args.data.compositeFailed;
63
- const unsupportedProperties = event.args.data.unsupportedProperties;
64
- if (!failureMask || !unsupportedProperties) {
65
- continue;
136
+ const failures = getNonCompositedFailure(animation);
137
+ if (!failures) {
138
+ continue;
139
+ }
140
+ allAnimationFailures.push(...failures);
141
+ const nextPrePaint = getNextEvent(prePaintEvents, animation);
142
+ // If no following prePaint, this is not a root cause.
143
+ if (!nextPrePaint) {
144
+ continue;
145
+ }
146
+ // If the animation event is outside the ROOT_CAUSE_WINDOW, it could not be a root cause.
147
+ if (!isInRootCauseWindow(animation, nextPrePaint)) {
148
+ continue;
149
+ }
150
+ const shifts = shiftsByPrePaint.get(nextPrePaint);
151
+ // if no layout shift(s), this is not a root cause.
152
+ if (!shifts) {
153
+ continue;
154
+ }
155
+ for (const shift of shifts) {
156
+ const rootCausesForShift = rootCausesByShift.get(shift);
157
+ if (!rootCausesForShift) {
158
+ throw new Error('Unaccounted shift');
66
159
  }
67
- const failureReasons = ACTIONABLE_FAILURE_REASONS.filter(reason => failureMask & reason.flag).map(reason => {
68
- return reason.failure;
69
- });
70
- const failure = {
71
- name: beginEvent.args.data.displayName,
72
- failureReasons,
73
- unsupportedProperties,
74
- };
75
- failures.push(failure);
160
+ rootCausesForShift.nonCompositedAnimations.push(...failures);
76
161
  }
77
162
  }
78
- return failures;
163
+ return allAnimationFailures;
79
164
  }
80
165
  /**
81
166
  * Given an array of layout shift and PrePaint events, returns a mapping from
@@ -106,24 +191,23 @@ function getShiftsByPrePaintEvents(layoutShifts, prePaintEvents) {
106
191
  return shiftsByPrePaint;
107
192
  }
108
193
  /**
109
- * This gets the first prePaint event that follows the provided event and returns it.
194
+ * Given a source event list, this returns the first event of that list that directly follows the target event.
110
195
  */
111
- function getNextPrePaintEvent(prePaintEvents, targetEvent) {
112
- // Get the first PrePaint event that happened after the targetEvent.
113
- const nextPrePaintIndex = Platform.ArrayUtilities.nearestIndexFromBeginning(prePaintEvents, prePaint => prePaint.ts > targetEvent.ts + (targetEvent.dur || 0));
196
+ function getNextEvent(sourceEvents, targetEvent) {
197
+ const index = Platform.ArrayUtilities.nearestIndexFromBeginning(sourceEvents, source => source.ts > targetEvent.ts + (targetEvent.dur || 0));
114
198
  // No PrePaint event registered after this event
115
- if (nextPrePaintIndex === null) {
199
+ if (index === null) {
116
200
  return undefined;
117
201
  }
118
- return prePaintEvents[nextPrePaintIndex];
202
+ return sourceEvents[index];
119
203
  }
120
204
  /**
121
205
  * An Iframe is considered a root cause if the iframe event occurs before a prePaint event
122
206
  * and within this prePaint event a layout shift(s) occurs.
123
207
  */
124
- function getIframeRootCauses(iframeCreatedEvents, prePaintEvents, shiftsByPrePaint, rootCausesByShift) {
208
+ function getIframeRootCauses(iframeCreatedEvents, prePaintEvents, shiftsByPrePaint, rootCausesByShift, domLoadingEvents) {
125
209
  for (const iframeEvent of iframeCreatedEvents) {
126
- const nextPrePaint = getNextPrePaintEvent(prePaintEvents, iframeEvent);
210
+ const nextPrePaint = getNextEvent(prePaintEvents, iframeEvent);
127
211
  // If no following prePaint, this is not a root cause.
128
212
  if (!nextPrePaint) {
129
213
  continue;
@@ -134,31 +218,64 @@ function getIframeRootCauses(iframeCreatedEvents, prePaintEvents, shiftsByPrePai
134
218
  continue;
135
219
  }
136
220
  for (const shift of shifts) {
137
- const rootCausesForShift = Platform.MapUtilities.getWithDefault(rootCausesByShift, shift, () => {
138
- return {
139
- iframes: [],
140
- fontRequests: [],
141
- };
221
+ const rootCausesForShift = rootCausesByShift.get(shift);
222
+ if (!rootCausesForShift) {
223
+ throw new Error('Unaccounted shift');
224
+ }
225
+ // Look for the first dom event that occurs within the bounds of the iframe event.
226
+ // This contains the frame id.
227
+ const domEvent = domLoadingEvents.find(e => {
228
+ const maxIframe = Types.Timing.MicroSeconds(iframeEvent.ts + (iframeEvent.dur ?? 0));
229
+ return e.ts >= iframeEvent.ts && e.ts <= maxIframe;
142
230
  });
143
- rootCausesForShift.iframes.push(iframeEvent);
231
+ if (domEvent && domEvent.args.frame) {
232
+ rootCausesForShift.iframeIds.push(domEvent.args.frame);
233
+ }
144
234
  }
145
235
  }
146
236
  return rootCausesByShift;
147
237
  }
238
+ /**
239
+ * An unsized image is considered a root cause if its PaintImage can be correlated to a
240
+ * layout shift. We can correlate PaintImages with unsized images by their matching nodeIds.
241
+ * X <- layout shift
242
+ * |----------------|
243
+ * ^ PrePaint event |-----|
244
+ * ^ PaintImage
245
+ */
246
+ function getUnsizedImageRootCauses(unsizedImageEvents, paintImageEvents, shiftsByPrePaint, rootCausesByShift) {
247
+ shiftsByPrePaint.forEach((shifts, prePaint) => {
248
+ const paintImage = getNextEvent(paintImageEvents, prePaint);
249
+ // The unsized image corresponds to this PaintImage.
250
+ const matchingNode = unsizedImageEvents.find(unsizedImage => unsizedImage.args.data.nodeId === paintImage?.args.data.nodeId);
251
+ if (!matchingNode) {
252
+ return;
253
+ }
254
+ // The unsized image is a potential root cause of all the shifts of this prePaint.
255
+ for (const shift of shifts) {
256
+ const rootCausesForShift = rootCausesByShift.get(shift);
257
+ if (!rootCausesForShift) {
258
+ throw new Error('Unaccounted shift');
259
+ }
260
+ rootCausesForShift.unsizedImages.push(matchingNode.args.data.nodeId);
261
+ }
262
+ });
263
+ return rootCausesByShift;
264
+ }
148
265
  /**
149
266
  * A font request is considered a root cause if the request occurs before a prePaint event
150
267
  * and within this prePaint event a layout shift(s) occurs. Additionally, this font request should
151
- * happen within the INVALIDATION_WINDOW of the prePaint event.
268
+ * happen within the ROOT_CAUSE_WINDOW of the prePaint event.
152
269
  */
153
270
  function getFontRootCauses(networkRequests, prePaintEvents, shiftsByPrePaint, rootCausesByShift) {
154
271
  const fontRequests = networkRequests.filter(req => req.args.data.resourceType === 'Font' && req.args.data.mimeType.startsWith('font'));
155
272
  for (const req of fontRequests) {
156
- const nextPrePaint = getNextPrePaintEvent(prePaintEvents, req);
273
+ const nextPrePaint = getNextEvent(prePaintEvents, req);
157
274
  if (!nextPrePaint) {
158
275
  continue;
159
276
  }
160
- // If the req is outside the INVALIDATION_WINDOW, it could not be a root cause.
161
- if (!isInInvalidationWindow(req, nextPrePaint)) {
277
+ // If the req is outside the ROOT_CAUSE_WINDOW, it could not be a root cause.
278
+ if (!isInRootCauseWindow(req, nextPrePaint)) {
162
279
  continue;
163
280
  }
164
281
  // Get the shifts that belong to this prepaint
@@ -169,41 +286,50 @@ function getFontRootCauses(networkRequests, prePaintEvents, shiftsByPrePaint, ro
169
286
  }
170
287
  // Include the root cause to the shifts in this prePaint.
171
288
  for (const shift of shifts) {
172
- const rootCausesForShift = Platform.MapUtilities.getWithDefault(rootCausesByShift, shift, () => {
173
- return {
174
- iframes: [],
175
- fontRequests: [],
176
- };
177
- });
289
+ const rootCausesForShift = rootCausesByShift.get(shift);
290
+ if (!rootCausesForShift) {
291
+ throw new Error('Unaccounted shift');
292
+ }
178
293
  rootCausesForShift.fontRequests.push(req);
179
294
  }
180
295
  }
181
296
  return rootCausesByShift;
182
297
  }
183
- export function generateInsight(traceParsedData, context) {
184
- const isWithinSameNavigation = ((event) => {
185
- const nav = Helpers.Trace.getNavigationForTraceEvent(event, context.frameId, traceParsedData.Meta.navigationsByFrameId);
186
- return nav?.args.data?.navigationId === context.navigationId;
187
- });
188
- const compositeAnimationEvents = traceParsedData.Animations.animations.filter(isWithinSameNavigation);
189
- const animationFailures = getNonCompositedAnimations(compositeAnimationEvents);
190
- const iframeEvents = traceParsedData.LayoutShifts.renderFrameImplCreateChildFrameEvents.filter(isWithinSameNavigation);
191
- const networkRequests = traceParsedData.NetworkRequests.byTime.filter(isWithinSameNavigation);
192
- const layoutShifts = traceParsedData.LayoutShifts.clusters.flatMap(cluster =>
193
- // Use one of the events in the cluster to determine if within the same navigation.
194
- isWithinSameNavigation(cluster.events[0]) ? cluster.events : []);
195
- const prePaintEvents = traceParsedData.LayoutShifts.prePaintEvents.filter(isWithinSameNavigation);
298
+ export function generateInsight(parsedTrace, context) {
299
+ const isWithinContext = (event) => Helpers.Timing.eventIsInBounds(event, context.bounds);
300
+ const compositeAnimationEvents = parsedTrace.Animations.animations.filter(isWithinContext);
301
+ const iframeEvents = parsedTrace.LayoutShifts.renderFrameImplCreateChildFrameEvents.filter(isWithinContext);
302
+ const networkRequests = parsedTrace.NetworkRequests.byTime.filter(isWithinContext);
303
+ const domLoadingEvents = parsedTrace.LayoutShifts.domLoadingEvents.filter(isWithinContext);
304
+ const unsizedImageEvents = parsedTrace.LayoutShifts.layoutImageUnsizedEvents.filter(isWithinContext);
305
+ const clusterKey = context.navigation ? context.navigationId : Types.Events.NO_NAVIGATION;
306
+ const clusters = parsedTrace.LayoutShifts.clustersByNavigationId.get(clusterKey) ?? [];
307
+ const clustersByScore = clusters.toSorted((a, b) => b.clusterCumulativeScore - a.clusterCumulativeScore);
308
+ const worstCluster = clustersByScore.at(0);
309
+ const layoutShifts = clusters.flatMap(cluster => cluster.events);
310
+ const prePaintEvents = parsedTrace.LayoutShifts.prePaintEvents.filter(isWithinContext);
311
+ const paintImageEvents = parsedTrace.LayoutShifts.paintImageEvents.filter(isWithinContext);
196
312
  // Get root causes.
197
313
  const rootCausesByShift = new Map();
198
314
  const shiftsByPrePaint = getShiftsByPrePaintEvents(layoutShifts, prePaintEvents);
199
315
  for (const shift of layoutShifts) {
200
- rootCausesByShift.set(shift, { iframes: [], fontRequests: [] });
316
+ rootCausesByShift.set(shift, { iframeIds: [], fontRequests: [], nonCompositedAnimations: [], unsizedImages: [] });
201
317
  }
202
- getIframeRootCauses(iframeEvents, prePaintEvents, shiftsByPrePaint, rootCausesByShift);
318
+ // Populate root causes for rootCausesByShift.
319
+ getIframeRootCauses(iframeEvents, prePaintEvents, shiftsByPrePaint, rootCausesByShift, domLoadingEvents);
203
320
  getFontRootCauses(networkRequests, prePaintEvents, shiftsByPrePaint, rootCausesByShift);
321
+ getUnsizedImageRootCauses(unsizedImageEvents, paintImageEvents, shiftsByPrePaint, rootCausesByShift);
322
+ const animationFailures = getNonCompositedFailureRootCauses(compositeAnimationEvents, prePaintEvents, shiftsByPrePaint, rootCausesByShift);
323
+ const relatedEvents = [...layoutShifts];
324
+ if (worstCluster) {
325
+ relatedEvents.push(worstCluster);
326
+ }
204
327
  return {
328
+ relatedEvents,
205
329
  animationFailures,
206
330
  shifts: rootCausesByShift,
331
+ clusters,
332
+ worstCluster,
207
333
  };
208
334
  }
209
335
  //# sourceMappingURL=CumulativeLayoutShift.js.map