Fix cycle dependencies in metro console #53852

kubabutkiewicz · 2024-12-10T13:27:48Z

Explanation of Change

This PR is for fixing multiple occurrences of cycle dependencies warnings in the metro console.
Here is a proposal that I made in the open source channel
This is the first part of this effort, which is make change in metro config to load modules only when they are needed and change imports types to named imports in files which are causing cycles. In next PR I will create an eslint rule to enforce new import style.

There are still 2 warnings in the metro console for cycle dependencies but they are about CONST.ts file. Currently I dont know yet how we can fix it without changing export and import types of this file so there would be needed changes in a lot of places in the app so I will do it also separately since its already a huge PR.

Tests: I think in that case there is no way to write some specific units tests for that change.

Fixed Issues

$ #53417

Tests

There is no change in specific flow, we should run some smoke tests to check if app is running properly in our most sensitive places

Verify that no errors appear in the JS console

Offline tests

QA Steps

There is no change in specific flow, we should run some smoke tests to check if app is running properly in our most sensitive places

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Before:

Before.Video.mp4

After:

Android: mWeb Chrome

iOS: Native

Before:

Before.Video.mp4

After:

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…to fix/attempt-to-fix-cycular-dependecies-1

…Mode, Session, API, Reauthentication, extractPolicyIDFromQuery, Navigation

…to fix/attempt-to-fix-cycular-dependecies-1

fabioh8010

A couple of comments, but it sounds really good!

metro.config.js

package.json

src/libs/API/index.ts

src/libs/Middleware/Reauthentication.ts

src/libs/Network/MainQueue.ts

src/libs/actions/IOU.ts

src/libs/actions/OnyxUpdateManager/index.ts

src/types/onyx/SearchResults.ts

…to fix/attempt-to-fix-cycular-dependecies-1

mountiny · 2025-01-09T23:26:50Z

I have bumped them, they should be around

…to fix/attempt-to-fix-cycular-dependecies-1

eVoloshchak · 2025-01-10T13:33:10Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2025-01-10.at.14.41.22.mov

iOS: Native

Screen.Recording.2025-01-10.at.14.53.16.mov

MacOS: Chrome / Safari

Screen.Recording.2025-01-10.at.14.49.51.mov

eVoloshchak

LGTM!

melvin-bot · 2025-01-10T13:55:02Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #53417 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

…to fix/attempt-to-fix-cycular-dependecies-1

kubabutkiewicz · 2025-01-13T08:50:34Z

Hi, can we run again to run a workflow to find internal engineer @eVoloshchak @mountiny

…to fix/attempt-to-fix-cycular-dependecies-1

kubabutkiewicz · 2025-01-13T16:09:33Z

Hey I spoke with @fabioh8010 and we decided that it would be better to incorporate into this PR changes from this PR which is adding new eslint rules for the new import ways, so there wont be new cycle dependencies issues

github-actions · 2025-01-13T18:20:42Z

🚧 @francoisl has triggered a test build. You can view the workflow run here.

github-actions · 2025-01-13T18:44:49Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/53852/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53852/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/53852/NewExpensify.dmg	https://53852.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

francoisl · 2025-01-13T18:25:53Z

src/libs/Network/MainQueue.ts

-import * as NetworkStore from './NetworkStore';
-import * as SequentialQueue from './SequentialQueue';
+import {isAuthenticating, isOffline} from './NetworkStore';
+import {isRunning as sequentialQueueIsRunning} from './SequentialQueue';


NAB - for consistency with naming boolean variables and functions, we could have named this isSequentialQueueRunning instead

OSBotify · 2025-01-13T19:08:58Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

izarutskaya · 2025-01-14T13:51:20Z

@kubabutkiewicz I don't see QA steps, what should we check this ? Thanks

github-actions · 2025-01-14T13:59:41Z

🚀 Deployed to staging by https://github.com/francoisl in version: 9.0.85-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

github-actions · 2025-01-14T14:15:42Z

🚀 Deployed to staging by https://github.com/francoisl in version: 9.0.85-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

github-actions · 2025-01-14T14:41:04Z

🚀 Deployed to staging by https://github.com/francoisl in version: 9.0.85-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

github-actions · 2025-01-14T15:24:45Z

🚀 Deployed to staging by https://github.com/francoisl in version: 9.0.85-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

github-actions · 2025-01-14T15:48:56Z

🚀 Deployed to staging by https://github.com/francoisl in version: 9.0.85-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	cancelled 🔪

francoisl · 2025-01-14T18:39:41Z

@izarutskaya there are no specific QA steps for this, I think you can skip QA entirely. If you run into any weird regressions, it could possibly come from this PR, but there were no new features or existing features updated in this PR.

There is no change in specific flow, we should run some smoke tests to check if app is running properly in our most sensitive places

kubabutkiewicz · 2025-01-14T18:50:43Z

agree with @francoisl

github-actions · 2025-01-15T13:47:48Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.85-4 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	failure ❌
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2025-01-15T15:48:44Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.85-4 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	cancelled 🔪
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

kubabutkiewicz added 18 commits November 25, 2024 10:34

fix: attempt to use named export to fix cycular dependecies

ab2ef10

fix more files

3b05f56

lint

1eee276

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

f28bce0

…to fix/attempt-to-fix-cycular-dependecies-1

refactor imports in ReportUtils for PolicyUtils and ReportActionsUtils

765e46d

refacort imports in ReportUtils and actions/IOU

09bffc4

refactor imports in ReportUtils, SearchQueryUtils, App, IOU, Priority…

09b1e4c

…Mode, Session, API, Reauthentication, extractPolicyIDFromQuery, Navigation

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

f490ddc

…to fix/attempt-to-fix-cycular-dependecies-1

fix imports in OnyxUpdateManager

4d0d477

fixing rest of dependecy cycles

625283a

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

43398e7

…to fix/attempt-to-fix-cycular-dependecies-1

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

9795ed6

…to fix/attempt-to-fix-cycular-dependecies-1

fix: import in Report.ts

f1c0869

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

a03dc83

…to fix/attempt-to-fix-cycular-dependecies-1

fix: two cyclic dependecies

31847ee

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

68f4b4e

…to fix/attempt-to-fix-cycular-dependecies-1

fix: tests

4711615

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

642f272

…to fix/attempt-to-fix-cycular-dependecies-1

fabioh8010 reviewed Dec 11, 2024

View reviewed changes

kubabutkiewicz added 2 commits December 12, 2024 09:43

fix: resolve comments

fd30e2a

fix: resolve comment

f688e6c

kubabutkiewicz changed the title ~~Fix/attempt to fix cycular dependecies 1~~ Fix cycle dependencies in metro console Dec 12, 2024

kubabutkiewicz added 5 commits December 12, 2024 10:25

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

d76caa2

…to fix/attempt-to-fix-cycular-dependecies-1

rerun of workflows

10d59cd

revert commit

c64f181

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

75e9499

…to fix/attempt-to-fix-cycular-dependecies-1

fix: lint

e296606

kubabutkiewicz marked this pull request as ready for review December 12, 2024 13:05

kubabutkiewicz requested a review from a team as a code owner December 12, 2024 13:05

melvin-bot bot requested a review from eVoloshchak December 12, 2024 13:05

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

0eeda29

…to fix/attempt-to-fix-cycular-dependecies-1

eVoloshchak approved these changes Jan 10, 2025

View reviewed changes

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

a214b7c

…to fix/attempt-to-fix-cycular-dependecies-1

mountiny requested a review from francoisl January 13, 2025 11:14

mountiny assigned kubabutkiewicz Jan 13, 2025

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

7b7876e

…to fix/attempt-to-fix-cycular-dependecies-1

incorporate new eslint rules to forbid namespace imports

6f446da

francoisl added the Ready To Build label Jan 13, 2025

francoisl approved these changes Jan 13, 2025

View reviewed changes

francoisl merged commit bfbdb70 into Expensify:main Jan 13, 2025
17 checks passed

github-actions bot mentioned this pull request Jan 14, 2025

Deploy Checklist: New Expensify 2025-01-14 #55208

Closed

38 tasks

bernhardoj mentioned this pull request Feb 11, 2025

[$250] Taxes - App crashes when trying to disable tax rate. #56158

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix cycle dependencies in metro console #53852

Fix cycle dependencies in metro console #53852

kubabutkiewicz commented Dec 10, 2024 •

edited by francoisl

Loading

fabioh8010 left a comment

mountiny commented Jan 9, 2025

eVoloshchak commented Jan 10, 2025 •

edited

Loading

eVoloshchak left a comment

melvin-bot bot commented Jan 10, 2025

kubabutkiewicz commented Jan 13, 2025

kubabutkiewicz commented Jan 13, 2025 •

edited

Loading

github-actions bot commented Jan 13, 2025

github-actions bot commented Jan 13, 2025

francoisl Jan 13, 2025

OSBotify commented Jan 13, 2025

izarutskaya commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

francoisl commented Jan 14, 2025

kubabutkiewicz commented Jan 14, 2025

github-actions bot commented Jan 15, 2025

github-actions bot commented Jan 15, 2025

Fix cycle dependencies in metro console #53852

Fix cycle dependencies in metro console #53852

Conversation

kubabutkiewicz commented Dec 10, 2024 • edited by francoisl Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

fabioh8010 left a comment

Choose a reason for hiding this comment

mountiny commented Jan 9, 2025

eVoloshchak commented Jan 10, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 10, 2025

kubabutkiewicz commented Jan 13, 2025

kubabutkiewicz commented Jan 13, 2025 • edited Loading

github-actions bot commented Jan 13, 2025

github-actions bot commented Jan 13, 2025

francoisl Jan 13, 2025

Choose a reason for hiding this comment

OSBotify commented Jan 13, 2025

izarutskaya commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

francoisl commented Jan 14, 2025

kubabutkiewicz commented Jan 14, 2025

github-actions bot commented Jan 15, 2025

github-actions bot commented Jan 15, 2025

kubabutkiewicz commented Dec 10, 2024 •

edited by francoisl

Loading

eVoloshchak commented Jan 10, 2025 •

edited

Loading

kubabutkiewicz commented Jan 13, 2025 •

edited

Loading