Browse Source

ref(perf): Explain VisuallyCompleteWithData (#37827)

* ref(perf): Explain VisuallyCompleteWithData 

Puts an explanation on a component that might be wrapping some code throughout the application.
Kev 2 years ago
parent
commit
6bea24f3da
1 changed files with 7 additions and 0 deletions
  1. 7 0
      static/app/utils/performanceForSentry.tsx

+ 7 - 0
static/app/utils/performanceForSentry.tsx

@@ -206,6 +206,13 @@ export const CustomerProfiler = ({id, children}: {children: ReactNode; id: strin
   );
 };
 
+/**
+ * This component wraps the main component on a page with a measurement checking for visual completedness.
+ * It uses the data check to make sure endpoints have resolved and the component is meaningfully rendering
+ * which sets it apart from simply checking LCP, which makes it a good back up check the LCP heuristic performance.
+ *
+ * Since this component is guaranteed to be part of the -real- critical path, it also wraps the component with the custom profiler.
+ */
 export const VisuallyCompleteWithData = ({
   id,
   hasData,