Add small comment about REPORT_METADATA onyx key

margelo · Oct 2, 2023 · 28651e9 · 28651e9
1 parent 9795ba4
commit 28651e9
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/ONYXKEYS.ts b/src/ONYXKEYS.ts
@@ -238,6 +238,9 @@ const ONYXKEYS = {
         POLICY_RECENTLY_USED_TAGS: 'policyRecentlyUsedTags_',
         WORKSPACE_INVITE_MEMBERS_DRAFT: 'workspaceInviteMembersDraft_',
         REPORT: 'report_',
+        // REPORT_METADATA is a perf optimization used to hold loading states (isLoadingReportActions, isLoadingMoreReportActions).
+        // A lot of components are connected to the Report entity and do not care about the actions. Setting the loading state
+        // directly on the report caused a lot of unnecessary re-renders
         REPORT_METADATA: 'reportMetadata_',
         REPORT_ACTIONS: 'reportActions_',
         REPORT_ACTIONS_DRAFTS: 'reportActionsDrafts_',