Add Reassure tests (Phase 1)

.github/actions/validateReassureOutput/validateReassureOutput.ts → .github/actions/javascript/validateReassureOutput/validateReassureOutput.ts

@@ -4,7 +4,7 @@
  */
 
 import * as core from '@actions/core';
-import type {CompareResult, PerformanceEntry} from '@callstack/reassure-compare/src/types';
+import type {CompareResult, MeasureEntry} from '@callstack/reassure-compare';
 import fs from 'fs';
 
 async function run() {
@@ -21,8 +21,8 @@ async function run() {
 
         for (let i = 0; i < regressionOutput.significant.length; i++) {
             const measurement = regressionOutput.significant[i];
-            const baseline: PerformanceEntry = measurement.baseline;
-            const current: PerformanceEntry = measurement.current;
+            const baseline: MeasureEntry = measurement.baseline;
+            const current: MeasureEntry = measurement.current;
 
             console.log(`Processing measurement ${i + 1}: ${measurement.name}`);
 

.github/scripts/buildActions.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+#
+# Used to precompile all Github Action node.js scripts using ncc.
+# This bundles them with their dependencies into a single executable node.js script.
+
+# In order for this script to be safely run from anywhere, we cannot use the raw relative path '../actions'.
+declare ACTIONS_DIR
+ACTIONS_DIR="$(dirname "$(dirname "$0")")/actions/javascript"
+
+# List of paths to all JS files that implement our GH Actions
+declare -r GITHUB_ACTIONS=(
+    "$ACTIONS_DIR/validateReassureOutput/validateReassureOutput.ts"
+)
+
+# This will be inserted at the top of all compiled files as a warning to devs.
+declare -r NOTE_DONT_EDIT='/**
+ * NOTE: This is a compiled file. DO NOT directly edit this file.
+ */
+'
+
+# This stores all the process IDs of the ncc commands so they can run in parallel
+declare ASYNC_BUILDS
+
+for ((i=0; i < ${#GITHUB_ACTIONS[@]}; i++)); do
+  ACTION=${GITHUB_ACTIONS[$i]}
+  ACTION_DIR=$(dirname "$ACTION")
+
+  # Build the action in the background
+  npx ncc build --transpile-only --external encoding "$ACTION" -o "$ACTION_DIR" &
+  ASYNC_BUILDS[i]=$!
+done
+
+for ((i=0; i < ${#GITHUB_ACTIONS[@]}; i++)); do
+  ACTION=${GITHUB_ACTIONS[$i]}
+  ACTION_DIR=$(dirname "$ACTION")
+
+  # Wait for the background build to finish
+  wait "${ASYNC_BUILDS[$i]}"
+
+  # Prepend the warning note to the top of the compiled file
+  OUTPUT_FILE="$ACTION_DIR/index.js"
+  echo "$NOTE_DONT_EDIT$(cat "$OUTPUT_FILE")" > "$OUTPUT_FILE"
+done

.github/workflows/reassurePerfTests.yml

@@ -42,6 +42,6 @@ jobs:
                   npx reassure --branch
             - name: Validate output.json
               id: validateReassureOutput
-              uses: ./.github/actions/validateReassureOutput
+              uses: ./.github/actions/javascript/validateReassureOutput
               with:
                   DURATION_DEVIATION_PERCENTAGE: 20

.prettierignore

@@ -1,3 +1,5 @@
+# The GH actions don't seem to compile and verify themselves well when Prettier is applied to them
+.github/actions/javascript/**/index.js
 dist
 package.json
 package-lock.json

jest.config.js

@@ -13,4 +13,5 @@ module.exports = {
     timers: 'fake',
     testEnvironment: 'jsdom',
     setupFilesAfterEnv: ['@testing-library/jest-native/extend-expect', './jestSetup.js'],
+    testTimeout: 10000,
 };

lib/Onyx.ts

@@ -1,6 +1,5 @@
 /* eslint-disable no-continue */
 import _ from 'underscore';
-import lodashPick from 'lodash/pick';
 import * as Logger from './Logger';
 import cache, {TASK} from './OnyxCache';
 import * as PerformanceUtils from './PerformanceUtils';
@@ -620,65 +619,6 @@ function clear(keysToPreserve: OnyxKey[] = []): Promise<void> {
     return cache.captureTask(TASK.CLEAR, promise) as Promise<void>;
 }
 
-function updateSnapshots(data: OnyxUpdate[]) {
-    const snapshotCollectionKey = OnyxUtils.getSnapshotKey();
-    if (!snapshotCollectionKey) return [];
-
-    const promises: Array<() => Promise<void>> = [];
-
-    const snapshotCollection = OnyxUtils.getCachedCollection(snapshotCollectionKey);
-    const snapshotCollectionKeyLength = snapshotCollectionKey.length;
-
-    Object.entries(snapshotCollection).forEach(([snapshotKey, snapshotValue]) => {
-        // Snapshots may not be present in cache. We don't know how to update them so we skip.
-        if (!snapshotValue) {
-            return;
-        }
-
-        let updatedData: Record<string, unknown> = {};
-
-        data.forEach(({key, value}) => {
-            // snapshots are normal keys so we want to skip update if they are written to Onyx
-            if (OnyxUtils.isCollectionMemberKey(snapshotCollectionKey, key, snapshotCollectionKeyLength)) {
-                return;
-            }
-
-            if (typeof snapshotValue !== 'object' || !('data' in snapshotValue)) {
-                return;
-            }
-
-            const snapshotData = snapshotValue.data;
-            if (!snapshotData || !snapshotData[key]) {
-                return;
-            }
-
-            if (Array.isArray(value) || Array.isArray(snapshotData[key])) {
-                updatedData[key] = value || [];
-                return;
-            }
-
-            if (value === null) {
-                updatedData[key] = value;
-                return;
-            }
-
-            const oldValue = updatedData[key] || {};
-            const newValue = lodashPick(value, Object.keys(snapshotData[key]));
-
-            updatedData = {...updatedData, [key]: Object.assign(oldValue, newValue)};
-        });
-
-        // Skip the update if there's no data to be merged
-        if (utils.isEmptyObject(updatedData)) {
-            return;
-        }
-
-        promises.push(() => merge(snapshotKey, {data: updatedData}));
-    });
-
-    return promises;
-}
-
 /**
  * Insert API responses and lifecycle data into Onyx
  *
@@ -804,7 +744,7 @@ function update(data: OnyxUpdate[]): Promise<void> {
         }
     });
 
-    const snapshotPromises = updateSnapshots(data);
+    const snapshotPromises = OnyxUtils.updateSnapshots(data, merge);
 
     // We need to run the snapshot updates before the other updates so the snapshot data can be updated before the loading state in the snapshot
     const finalPromises = snapshotPromises.concat(promises);

lib/OnyxUtils.ts

@@ -3,6 +3,7 @@
 import {deepEqual} from 'fast-equals';
 import lodashClone from 'lodash/clone';
 import type {ValueOf} from 'type-fest';
+import lodashPick from 'lodash/pick';
 import DevTools from './DevTools';
 import * as Logger from './Logger';
 import type Onyx from './Onyx';
@@ -25,6 +26,7 @@ import type {
     OnyxInput,
     OnyxKey,
     OnyxMergeCollectionInput,
+    OnyxUpdate,
     OnyxValue,
     Selector,
 } from './types';
@@ -650,8 +652,8 @@ function keysChanged<TKey extends CollectionKeyBase>(
     collectionKey: TKey,
     partialCollection: OnyxCollection<KeyValueMapping[TKey]>,
     partialPreviousCollection: OnyxCollection<KeyValueMapping[TKey]> | undefined,
-    notifyRegularSubscibers = true,
-    notifyWithOnyxSubscibers = true,
+    notifyConnectSubscribers = true,
+    notifyWithOnyxSubscribers = true,
 ): void {
     // We prepare the "cached collection" which is the entire collection + the new partial data that
     // was merged in via mergeCollection().
@@ -687,7 +689,7 @@ function keysChanged<TKey extends CollectionKeyBase>(
 
         // Regular Onyx.connect() subscriber found.
         if (typeof subscriber.callback === 'function') {
-            if (!notifyRegularSubscibers) {
+            if (!notifyConnectSubscribers) {
                 continue;
             }
 
@@ -731,7 +733,7 @@ function keysChanged<TKey extends CollectionKeyBase>(
 
         // React component subscriber found.
         if (utils.hasWithOnyxInstance(subscriber)) {
-            if (!notifyWithOnyxSubscibers) {
+            if (!notifyWithOnyxSubscribers) {
                 continue;
             }
 
@@ -1436,6 +1438,65 @@ function unsubscribeFromKey(subscriptionID: number): void {
     delete callbackToStateMapping[subscriptionID];
 }
 
+function updateSnapshots(data: OnyxUpdate[], mergeFn: typeof Onyx.merge): Array<() => Promise<void>> {
+    const snapshotCollectionKey = OnyxUtils.getSnapshotKey();
+    if (!snapshotCollectionKey) return [];
+
+    const promises: Array<() => Promise<void>> = [];
+
+    const snapshotCollection = OnyxUtils.getCachedCollection(snapshotCollectionKey);
+    const snapshotCollectionKeyLength = snapshotCollectionKey.length;
+
+    Object.entries(snapshotCollection).forEach(([snapshotEntryKey, snapshotEntryValue]) => {
+        // Snapshots may not be present in cache. We don't know how to update them so we skip.
+        if (!snapshotEntryValue) {
+            return;
+        }
+
+        let updatedData: Record<string, unknown> = {};
+
+        data.forEach(({key, value}) => {
+            // snapshots are normal keys so we want to skip update if they are written to Onyx
+            if (OnyxUtils.isCollectionMemberKey(snapshotCollectionKey, key, snapshotCollectionKeyLength)) {
+                return;
+            }
+
+            if (typeof snapshotEntryValue !== 'object' || !('data' in snapshotEntryValue)) {
+                return;
+            }
+
+            const snapshotData = snapshotEntryValue.data;
+            if (!snapshotData || !snapshotData[key]) {
+                return;
+            }
+
+            if (Array.isArray(value) || Array.isArray(snapshotData[key])) {
+                updatedData[key] = value || [];
+                return;
+            }
+
+            if (value === null) {
+                updatedData[key] = value;
+                return;
+            }
+
+            const oldValue = updatedData[key] || {};
+            const newValue = lodashPick(value, Object.keys(snapshotData[key]));
+
+            updatedData = {...updatedData, [key]: Object.assign(oldValue, newValue)};
+        });
+
+        // Skip the update if there's no data to be merged
+        if (utils.isEmptyObject(updatedData)) {
+            return;
+        }
+
+        promises.push(() => mergeFn(snapshotEntryKey, {data: updatedData}));
+    });
+
+    return promises;
+}
+
 const OnyxUtils = {
     METHOD,
     getMergeQueue,
@@ -1485,6 +1546,11 @@ const OnyxUtils = {
     getEvictionBlocklist,
     getSkippableCollectionMemberIDs,
     setSkippableCollectionMemberIDs,
+    storeKeyBySubscriptions,
+    deleteKeyBySubscriptions,
+    addKeyToRecentlyAccessedIfNeeded,
+    reduceCollectionWithSelector,
+    updateSnapshots,
 };
 
 GlobalSettings.addGlobalSettingsChangeListener(({enablePerformanceMetrics}) => {