From 5d19e1c8d1a6c0b5cd7532d43b707191eaf105b7 Mon Sep 17 00:00:00 2001
From: Edmond Chui <1967998+EdmondChuiHW@users.noreply.github.com>
Date: Mon, 23 Sep 2024 13:25:44 +0100
Subject: [PATCH] Fix: profiling crashes #30661 #28838 (#31024)

<!--
  Thanks for submitting a pull request!
We appreciate you spending the time to work on these changes. Please
provide enough information so that others can review your pull request.
The three fields below are mandatory.

Before submitting a pull request, please make sure the following is
done:

1. Fork [the repository](https://github.com/facebook/react) and create
your branch from `main`.
  2. Run `yarn` in the repository root.
3. If you've fixed a bug or added code that should be tested, add tests!
4. Ensure the test suite passes (`yarn test`). Tip: `yarn test --watch
TestName` is helpful in development.
5. Run `yarn test --prod` to test in the production environment. It
supports the same options as `yarn test`.
6. If you need a debugger, run `yarn test --debug --watch TestName`,
open `chrome://inspect`, and press "Inspect".
7. Format your code with
[prettier](https://github.com/prettier/prettier) (`yarn prettier`).
8. Make sure your code lints (`yarn lint`). Tip: `yarn linc` to only
check changed files.
  9. Run the [Flow](https://flowtype.org/) type checks (`yarn flow`).
  10. If you haven't already, complete the CLA.

Learn more about contributing:
https://reactjs.org/docs/how-to-contribute.html
-->

## Summary

Profiling fails sometimes because `onProfilingStatus` is called
repeatedly on some occasions, e.g. multiple calls to
`getProfilingStatus`.

Subsequent calls should be a no-op if the profiling status hasn't
changed.

Reported via #30661 #28838.

> [!TIP]
> Hide whitespace changes on this PR

<img width="328" alt="screenshot showing the UI controls for hiding
whitespace changes on GitHub"
src="https://github.com/user-attachments/assets/036385cf-2610-4e69-a717-17c05d7ef047">


## How did you test this change?

<!--
Demonstrate the code is solid. Example: The exact commands you ran and
their output, screenshots / videos if the pull request changes the user
interface.
How exactly did you verify that your PR solves the issue you wanted to
solve?
  If you leave this empty, your PR will very likely be closed.
-->

Tested as part of Fusebox implementation of reload-to-profile.

https://github.com/facebook/react/pull/31021?#discussion_r1770589753
---
 .../src/devtools/ProfilerStore.js             | 50 ++++++++++---------
 1 file changed, 26 insertions(+), 24 deletions(-)

diff --git a/packages/react-devtools-shared/src/devtools/ProfilerStore.js b/packages/react-devtools-shared/src/devtools/ProfilerStore.js
index 46b2edcab4d32..a55487ec19a37 100644
--- a/packages/react-devtools-shared/src/devtools/ProfilerStore.js
+++ b/packages/react-devtools-shared/src/devtools/ProfilerStore.js
@@ -289,6 +289,10 @@ export default class ProfilerStore extends EventEmitter<{
   };
 
   onProfilingStatus: (isProfiling: boolean) => void = isProfiling => {
+    if (this._isProfiling === isProfiling) {
+      return;
+    }
+
     if (isProfiling) {
       this._dataBackends.splice(0);
       this._dataFrontend = null;
@@ -315,36 +319,34 @@ export default class ProfilerStore extends EventEmitter<{
       });
     }
 
-    if (this._isProfiling !== isProfiling) {
-      this._isProfiling = isProfiling;
+    this._isProfiling = isProfiling;
 
-      // Invalidate suspense cache if profiling data is being (re-)recorded.
-      // Note that we clear again, in case any views read from the cache while profiling.
-      // (That would have resolved a now-stale value without any profiling data.)
-      this._cache.invalidate();
+    // Invalidate suspense cache if profiling data is being (re-)recorded.
+    // Note that we clear again, in case any views read from the cache while profiling.
+    // (That would have resolved a now-stale value without any profiling data.)
+    this._cache.invalidate();
 
-      this.emit('isProfiling');
+    this.emit('isProfiling');
 
-      // If we've just finished a profiling session, we need to fetch data stored in each renderer interface
-      // and re-assemble it on the front-end into a format (ProfilingDataFrontend) that can power the Profiler UI.
-      // During this time, DevTools UI should probably not be interactive.
-      if (!isProfiling) {
-        this._dataBackends.splice(0);
-        this._rendererQueue.clear();
+    // If we've just finished a profiling session, we need to fetch data stored in each renderer interface
+    // and re-assemble it on the front-end into a format (ProfilingDataFrontend) that can power the Profiler UI.
+    // During this time, DevTools UI should probably not be interactive.
+    if (!isProfiling) {
+      this._dataBackends.splice(0);
+      this._rendererQueue.clear();
 
-        // Only request data from renderers that actually logged it.
-        // This avoids unnecessary bridge requests and also avoids edge case mixed renderer bugs.
-        // (e.g. when v15 and v16 are both present)
-        this._rendererIDsThatReportedProfilingData.forEach(rendererID => {
-          if (!this._rendererQueue.has(rendererID)) {
-            this._rendererQueue.add(rendererID);
+      // Only request data from renderers that actually logged it.
+      // This avoids unnecessary bridge requests and also avoids edge case mixed renderer bugs.
+      // (e.g. when v15 and v16 are both present)
+      this._rendererIDsThatReportedProfilingData.forEach(rendererID => {
+        if (!this._rendererQueue.has(rendererID)) {
+          this._rendererQueue.add(rendererID);
 
-            this._bridge.send('getProfilingData', {rendererID});
-          }
-        });
+          this._bridge.send('getProfilingData', {rendererID});
+        }
+      });
 
-        this.emit('isProcessingData');
-      }
+      this.emit('isProcessingData');
     }
   };
 }