Merge branch 'main' into cmartins-bumpNode

Author: luacmartins

.github/actions/javascript/reassureStabilityCheck/index.js

@@ -0,0 +1,27 @@
+/*
+ *  NOTE: After changes to the file it needs to be compiled using [`ncc`](https://github.com/vercel/ncc)
+ *  Example: ncc build -t reassureStabilityCheck.ts -o index.js
+ */
+
+import * as core from '@actions/core';
+import {execSync} from 'child_process';
+
+async function run() {
+    try {
+        console.log('Running Reassure stability check...');
+        execSync('npx reassure check-stability --verbose', {stdio: 'inherit'});
+
+        console.log('Validating Reassure stability results...');
+        execSync('node .github/actions/javascript/validateReassureOutput', {stdio: 'inherit'});
+
+        return true;
+    } catch (error) {
+        console.log('error: ', error);
+        core.setFailed(error.message);
+        process.exit(1);
+    }
+}
+
+run();
+
+export default run;

.github/actions/javascript/reassureStabilityCheck/reassureStabilityCheck.ts

@@ -7,6 +7,9 @@ inputs:
     ALLOWED_RELATIVE_DURATION_DEVIATION:
         description: Allowable percentage deviation for the mean duration in regression test results.
         required: true
+    IS_VALIDATING_STABILITY:
+        description: Whether the workflow is validating a Reassure stability check or not.
+        required: true
 runs:
     using: 'node20'
     main: './index.js'

.github/actions/javascript/validateReassureOutput/action.yml

@@ -24966,12 +24966,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 const core = __importStar(__nccwpck_require__(2186));
 const fs_1 = __importDefault(__nccwpck_require__(7147));
+function getInputOrEnv(name) {
+    try {
+        return core.getInput(name, { required: true });
+    }
+    catch (_a) {
+        const envProperty = process.env[name];
+        if (!envProperty) {
+            throw new Error(`'${name}' env property not defined.`);
+        }
+        return envProperty;
+    }
+}
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const regressionOutput = JSON.parse(fs_1.default.readFileSync('.reassure/output.json', 'utf8'));
-            const allowedDurationDeviation = Number(core.getInput('ALLOWED_DURATION_DEVIATION', { required: true }));
-            const durationDeviationPercentage = Number(core.getInput('ALLOWED_RELATIVE_DURATION_DEVIATION', { required: true }));
+            const allowedDurationDeviation = Number(getInputOrEnv('ALLOWED_DURATION_DEVIATION'));
+            const durationDeviationPercentage = Number(getInputOrEnv('ALLOWED_RELATIVE_DURATION_DEVIATION'));
+            const isValidatingStability = Boolean(getInputOrEnv('IS_VALIDATING_STABILITY'));
             if (regressionOutput.significant === undefined || regressionOutput.significant.length === 0) {
                 console.log('No significant data available. Exiting...');
                 return true;
@@ -25018,7 +25031,12 @@ function run() {
             });
             const shouldFailWorkflow = outputs.some((output) => output.isDeviationExceeded);
             if (shouldFailWorkflow) {
-                core.setFailed(`🔴 Duration deviation exceeded the allowed ranges in one or more measurements.`);
+                if (isValidatingStability) {
+                    core.setFailed(`🔴 Duration deviation exceeded the allowed ranges in one or more measurements during the stability checks.`);
+                }
+                else {
+                    core.setFailed(`🔴 Duration deviation exceeded the allowed ranges in one or more measurements.`);
+                }
             }
             return true;
         }

.github/actions/javascript/validateReassureOutput/index.js

@@ -14,11 +14,25 @@ type MeasurementOutput = {
     isDeviationExceeded: boolean;
 };
 
+function getInputOrEnv(name: string): string {
+    try {
+        return core.getInput(name, {required: true});
+    } catch {
+        const envProperty = process.env[name];
+        if (!envProperty) {
+            throw new Error(`'${name}' env property not defined.`);
+        }
+
+        return envProperty;
+    }
+}
+
 async function run() {
     try {
         const regressionOutput: CompareResult = JSON.parse(fs.readFileSync('.reassure/output.json', 'utf8'));
-        const allowedDurationDeviation = Number(core.getInput('ALLOWED_DURATION_DEVIATION', {required: true}));
-        const durationDeviationPercentage = Number(core.getInput('ALLOWED_RELATIVE_DURATION_DEVIATION', {required: true}));
+        const allowedDurationDeviation = Number(getInputOrEnv('ALLOWED_DURATION_DEVIATION'));
+        const durationDeviationPercentage = Number(getInputOrEnv('ALLOWED_RELATIVE_DURATION_DEVIATION'));
+        const isValidatingStability = Boolean(getInputOrEnv('IS_VALIDATING_STABILITY'));
 
         if (regressionOutput.significant === undefined || regressionOutput.significant.length === 0) {
             console.log('No significant data available. Exiting...');
@@ -77,7 +91,11 @@ async function run() {
 
         const shouldFailWorkflow = outputs.some((output) => output.isDeviationExceeded);
         if (shouldFailWorkflow) {
-            core.setFailed(`🔴 Duration deviation exceeded the allowed ranges in one or more measurements.`);
+            if (isValidatingStability) {
+                core.setFailed(`🔴 Duration deviation exceeded the allowed ranges in one or more measurements during the stability checks.`);
+            } else {
+                core.setFailed(`🔴 Duration deviation exceeded the allowed ranges in one or more measurements.`);
+            }
         }
 
         return true;

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

@@ -25,18 +25,27 @@ jobs:
           node-version-file: '.nvmrc'
 
       - name: Install dependencies
-        run: npm install
+        run: npm ci
 
-      - name: Run Reassure baseline tests
-        run: npx reassure --baseline --verbose
+      - name: Reassure stability check
+        uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08
+        with:
+          timeout_minutes: 30
+          max_attempts: 3
+          retry_on: error
+          command: node .github/actions/javascript/reassureStabilityCheck
+        env:
+          ALLOWED_DURATION_DEVIATION: 10
+          ALLOWED_RELATIVE_DURATION_DEVIATION: 20
+          IS_VALIDATING_STABILITY: true
 
       - name: Checkout PR head SHA
         run: |
           git fetch origin ${{ github.event.pull_request.head.sha }} --no-tags --depth=1
           git switch --force --detach ${{ github.event.pull_request.head.sha }}
           
       - name: Reinstall dependencies
-        run: npm install --force
+        run: npm ci
 
       - name: Run Reassure delta tests
         run: npx reassure --branch --verbose
@@ -49,9 +58,10 @@ jobs:
           if-no-files-found: ignore
           include-hidden-files: true
 
-      - name: Validate output.json
-        id: validateReassureOutput
+      - name: Validate Reassure results
+        id: validateReassureResults
         uses: ./.github/actions/javascript/validateReassureOutput
         with:
           ALLOWED_DURATION_DEVIATION: 10
           ALLOWED_RELATIVE_DURATION_DEVIATION: 20
+          IS_VALIDATING_STABILITY: false

.github/workflows/reassurePerfTests.yml

@@ -9,12 +9,16 @@
 <dd><p>Initialize the store with actions and listening for storage events</p>
 </dd>
 <dt><a href="#connect">connect(connectOptions)</a> ⇒</dt>
+<dd><p>Connects to an Onyx key given the options passed and listens to its changes.
+This method will be deprecated soon. Please use <code>Onyx.connectWithoutView()</code> instead.</p>
+</dd>
+<dt><a href="#connectWithoutView">connectWithoutView(connectOptions)</a> ⇒</dt>
 <dd><p>Connects to an Onyx key given the options passed and listens to its changes.</p>
 </dd>
 <dt><a href="#disconnect">disconnect(connection)</a></dt>
 <dd><p>Disconnects and removes the listener from the Onyx key.</p>
 </dd>
-<dt><a href="#set">set(key, value)</a></dt>
+<dt><a href="#set">set(key, value, options)</a></dt>
 <dd><p>Write a value to our store with the given key</p>
 </dd>
 <dt><a href="#multiSet">multiSet(data)</a></dt>
@@ -66,6 +70,33 @@ Initialize the store with actions and listening for storage events
 
 ## connect(connectOptions) ⇒
 Connects to an Onyx key given the options passed and listens to its changes.
+This method will be deprecated soon. Please use `Onyx.connectWithoutView()` instead.
+
+**Kind**: global function  
+**Returns**: The connection object to use when calling `Onyx.disconnect()`.  
+
+| Param | Description |
+| --- | --- |
+| connectOptions | The options object that will define the behavior of the connection. |
+| connectOptions.key | The Onyx key to subscribe to. |
+| connectOptions.callback | A function that will be called when the Onyx data we are subscribed changes. |
+| connectOptions.waitForCollectionCallback | If set to `true`, it will return the entire collection to the callback as a single object. |
+| connectOptions.withOnyxInstance | The `withOnyx` class instance to be internally passed. **Only used inside `withOnyx()` HOC.** |
+| connectOptions.statePropertyName | The name of the component's prop that is connected to the Onyx key. **Only used inside `withOnyx()` HOC.** |
+| connectOptions.displayName | The component's display name. **Only used inside `withOnyx()` HOC.** |
+| connectOptions.selector | This will be used to subscribe to a subset of an Onyx key's data. **Only used inside `useOnyx()` hook or `withOnyx()` HOC.**        Using this setting on `useOnyx()` or `withOnyx()` can have very positive performance benefits because the component will only re-render        when the subset of data changes. Otherwise, any change of data on any property would normally        cause the component to re-render (and that can be expensive from a performance standpoint). |
+
+**Example**  
+```ts
+const connection = Onyx.connectWithoutView({
+    key: ONYXKEYS.SESSION,
+    callback: onSessionChange,
+});
+```
+<a name="connectWithoutView"></a>
+
+## connectWithoutView(connectOptions) ⇒
+Connects to an Onyx key given the options passed and listens to its changes.
 
 **Kind**: global function  
 **Returns**: The connection object to use when calling `Onyx.disconnect()`.  
@@ -83,7 +114,7 @@ Connects to an Onyx key given the options passed and listens to its changes.
 
 **Example**  
 ```ts
-const connection = Onyx.connect({
+const connection = Onyx.connectWithoutView({
     key: ONYXKEYS.SESSION,
     callback: onSessionChange,
 });
@@ -97,11 +128,11 @@ Disconnects and removes the listener from the Onyx key.
 
 | Param | Description |
 | --- | --- |
-| connection | Connection object returned by calling `Onyx.connect()`. |
+| connection | Connection object returned by calling `Onyx.connect()` or `Onyx.connectWithoutView()`. |
 
 **Example**  
 ```ts
-const connection = Onyx.connect({
+const connection = Onyx.connectWithoutView({
     key: ONYXKEYS.SESSION,
     callback: onSessionChange,
 });
@@ -110,7 +141,7 @@ Onyx.disconnect(connection);
 ```
 <a name="set"></a>
 
-## set(key, value)
+## set(key, value, options)
 Write a value to our store with the given key
 
 **Kind**: global function  
@@ -119,6 +150,7 @@ Write a value to our store with the given key
 | --- | --- |
 | key | ONYXKEY to set |
 | value | value to store |
+| options | optional configuration object |
 
 <a name="multiSet"></a>
 

API.md

@@ -59,6 +59,26 @@ API.Authenticate(params)
 
 The data will then be cached and stored via [`AsyncStorage`](https://github.com/react-native-async-storage/async-storage).
 
+### Performance Options for Large Objects
+
+For performance-critical scenarios with large objects, `Onyx.set()` accepts optional flag to skip expensive operations:
+
+```javascript
+Onyx.set(ONYXKEYS.LARGE_DATA, computedValue, {
+    skipCacheCheck: true,     // Skip deep equality check
+});
+```
+
+**Options:**
+- `skipCacheCheck`: Skips the deep equality comparison with the cached value. By default, Onyx compares new values against cached ones to avoid unnecessary updates. For large objects, this comparison can be expensive.
+
+#### When to Use SetOptions
+- **Use `skipCacheCheck: true`** for:
+  - Large objects where deep equality checking is expensive
+  - Values that you know have changed
+
+**Note**: These option is recommended only for large objects where performance is critical. Most use cases should use the standard `Onyx.set(key, value)` syntax.
+
 ## Merging data
 
 We can also use `Onyx.merge()` to merge new `Object` or `Array` data in with existing data.
@@ -169,16 +189,7 @@ export default withOnyx({
 })(App);
 ```
 
-Differently from `useOnyx()`, `withOnyx()` will delay the rendering of the wrapped component until all keys/entities have been fetched and passed to the component, this can be convenient for simple cases. This however, can really delay your application if many entities are connected to the same component, you can pass an `initialValue` to each key to allow Onyx to eagerly render your component with this value.
-
-```javascript
-export default withOnyx({
-    session: {
-        key: ONYXKEYS.SESSION,
-        initialValue: {}
-    },
-})(App);
-```
+Differently from `useOnyx()`, `withOnyx()` will delay the rendering of the wrapped component until all keys/entities have been fetched and passed to the component, this can be convenient for simple cases. This however, can really delay your application if many entities are connected to the same component.
 
 Additionally, if your component has many keys/entities when your component will mount but will receive many updates as data is fetched from DB and passed down to it, as every key that gets fetched will trigger a `setState` on the `withOnyx` HOC. This might cause re-renders on the initial mounting, preventing the component from mounting/rendering in reasonable time, making your app feel slow and even delaying animations.
 
@@ -194,8 +205,7 @@ const App = ({session, markReadyForHydration}) => (
 // Second argument to funciton is `shouldDelayUpdates`
 export default withOnyx({
     session: {
-        key: ONYXKEYS.SESSION,
-        initialValue: {}
+        key: ONYXKEYS.SESSION
     },
 }, true)(App);
 ```
@@ -379,7 +389,7 @@ If a platform needs to use a separate library (like using MMVK for react-native)
 
 [Docs](./API.md)
 
-# Storage Eviction
+# Cache Eviction
 
 Different platforms come with varying storage capacities and Onyx has a way to gracefully fail when those storage limits are encountered. When Onyx fails to set or modify a key the following steps are taken:
 1. Onyx looks at a list of recently accessed keys (access is defined as subscribed to or modified) and locates the key that was least recently accessed