[No QA] Console error cleanup: fix require cycle warnings (part 1) #52561

JKobrynski · 2024-11-14T13:54:53Z

Explanation of Change

This PR is the first part of require cycles fixes. It resolves about 40 different require cycles.

Fixed Issues

$ #51099
PROPOSAL: N/A

Tests

N/A

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
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.
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.

Screenshots/Videos

N/A

…-> Reauthentication.ts -> Authentication.ts

… -> ... -> PolicyUtils.ts

… require cycle

…-> Report.ts -> ReportConnection.ts

…-> TransactionUtils/index.ts chain

…-> Navigation.ts require cycle

melvin-bot · 2024-11-15T15:07:27Z

@eVoloshchak Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

kubabutkiewicz · 2024-11-15T15:22:50Z

src/libs/models/BankAccountState.ts

+    VERIFYING: 'VERIFYING',
+};
+
+export default BankAccountState;


maybe its better to move just to src/CONST.ts file?

fabioh8010 · 2024-11-18T11:43:22Z

src/libs/TransactionUtils/index.ts

-                    const policyTagsObj = Object.values(Object.values(policyTags).at(0)?.tags ?? {});
-                    const availableTags = policyTagsObj
-                        .filter((tag) => differentValues.includes(tag.name) && tag.enabled && tag.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE)
+                CategoryActions().then((actions) => {


This doesn't look right because you are mutating keep and change to return them at the end of the function. If this code is wrapped in a promise we will have racing condition problems

fabioh8010 · 2024-11-18T11:43:28Z

src/libs/TransactionUtils/index.ts

-                }
+                });
+            } else if (fieldName === 'tag') {
+                TagActions().then((module) => {


fabioh8010 · 2024-11-18T11:44:44Z

src/libs/actions/PriorityMode.ts

-            if (!ReportUtils.isValidReport(report) || !ReportUtils.isReportParticipant(currentUserAccountID ?? -1, report)) {
-                return;
-            }
+        ReportConnection().then((module) => {


Same, validReports is used outside of this wrapped function, this might be a problem

JKobrynski added 8 commits November 14, 2024 10:46

fix cycles related to CONST.ts

86dbf16

fix require cycles starting with Log.ts -> Network/index.ts

eddc1d2

fix require cycles starting with API/index.ts -> Middleware/index.ts …

14a8253

…-> Reauthentication.ts -> Authentication.ts

Fix require cycles starting with Navigation.ts -> ReportConnection.ts…

172e2df

… -> ... -> PolicyUtils.ts

fix the ReportConnection.ts -> PriorityMode.ts -> ReportConnection.ts…

1cd0315

… require cycle

fix import cycles starting with (and containing) ReportConnection.ts …

8dc09af

…-> Report.ts -> ReportConnection.ts

fix require cycles containing Navigation.ts -> reportUtils.ts -> ... …

d24daac

…-> TransactionUtils/index.ts chain

fix the Navigation.ts -> ... -> saveLastRoute/index.ios.ts -> App.ts …

eb5a8ff

…-> Navigation.ts require cycle

JKobrynski changed the title ~~Console error cleanup: fix require cycle warnings (part 1)~~ [No QA] Console error cleanup: fix require cycle warnings (part 1) Nov 15, 2024

JKobrynski added 2 commits November 15, 2024 15:32

fix require cycles containing IOU.ts -> FileUtils.ts chain

a103417

add missing comment to dynamic import

9d01ed0

JKobrynski marked this pull request as ready for review November 15, 2024 15:07

JKobrynski requested a review from a team as a code owner November 15, 2024 15:07

melvin-bot bot requested review from eVoloshchak and removed request for a team November 15, 2024 15:07

JKobrynski mentioned this pull request Nov 15, 2024

Console error cleanup. #51099

Open

kubabutkiewicz reviewed Nov 15, 2024

View reviewed changes

MrRefactor approved these changes Nov 16, 2024

View reviewed changes

Merge branch 'main' into fixRequireCycleWarnings_part1

b9b3681

fabioh8010 reviewed Nov 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Console error cleanup: fix require cycle warnings (part 1) #52561

[No QA] Console error cleanup: fix require cycle warnings (part 1) #52561

JKobrynski commented Nov 14, 2024 •

edited

Loading

melvin-bot bot commented Nov 15, 2024

kubabutkiewicz Nov 15, 2024

fabioh8010 Nov 18, 2024

fabioh8010 Nov 18, 2024

fabioh8010 Nov 18, 2024

[No QA] Console error cleanup: fix require cycle warnings (part 1) #52561

Are you sure you want to change the base?

[No QA] Console error cleanup: fix require cycle warnings (part 1) #52561

Conversation

JKobrynski commented Nov 14, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 15, 2024

kubabutkiewicz Nov 15, 2024

Choose a reason for hiding this comment

fabioh8010 Nov 18, 2024

Choose a reason for hiding this comment

fabioh8010 Nov 18, 2024

Choose a reason for hiding this comment

fabioh8010 Nov 18, 2024

Choose a reason for hiding this comment

JKobrynski commented Nov 14, 2024 •

edited

Loading