Skip to content

[No QA] Fix import/no-cycle - part 1 - #99670

Open
LukasMod wants to merge 7 commits into
Expensify:mainfrom
callstack-internal:fix/no-cycle-api-middleware-registration
Open

[No QA] Fix import/no-cycle - part 1#99670
LukasMod wants to merge 7 commits into
Expensify:mainfrom
callstack-internal:fix/no-cycle-api-middleware-registration

Conversation

@LukasMod

@LukasMod LukasMod commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Move API middleware registration out of makeRequest to break the API <-> Middleware import cycle

src/libs/API/makeRequest.ts did two unrelated jobs. It owned the request pipeline (buildLogParams,
prepareRequest, processRequest), and it ran the 13 addMiddleware() calls at module scope. Only the
wiring half needs @libs/Middleware, and six of those middlewares import user action modules, every one of
which imports @libs/API. That closed an API -> Middleware -> action -> API cycle, so anything importing
@libs/API pulled the whole action graph in behind it.

The 13 addMiddleware() calls move to a new src/libs/Middleware/register.ts, unchanged and in the same
order, keeping the comments that document why the order matters. src/setup, the composition root that
index.js and tests/utils/TestHelper.ts already share, imports it for the side effect. Storybook runs its
own entry point and never loads src/setup, so it gets the same import.

This changes no behavior. addMiddleware is middlewares.push(middleware) and nothing else
(src/libs/Request.ts), so registration writes no Onyx state, and all five processWithMiddleware call
sites run from callbacks, none during module evaluation.

  • import/no-cycle drops from 534 findings to 478 (-56), from 148 files to 130, and the largest strongly
    connected cluster from 116 files to 98.

  • 18 files leave the cycle graph and none enters. All 11 libs/API and libs/Middleware files are out.
    None of the 478 remaining cycle paths touches either directory, against 459 of the original 534.

  • Diffing all 4498 findings by rule, import/no-cycle is the only count that moves

  • The eager startup closure goes from 1167 modules to 1168. register.ts is the one that enters, and none
    leaves. Startup therefore evaluates the same set of modules, though 16 of them (the Middleware modules,
    Network/LoadTest and deepReplaceKeysAndValues) now evaluate at index.js:11 rather than index.js:9,
    because they leave src/App.tsx's closure. Their only module-scope side effects are two
    Onyx.connectWithoutView calls in HandleUnusedOptimisticID.ts, and those still run before
    Onyx.init().

  • The closure from src/libs/API/index.ts goes from 442 modules to 71. Action modules reachable from the
    API barrel drop from 76 to 8, and Middleware modules to 0. This is a decoupling mechanism.

  • new test suites:

    • MiddlewareEntryPointTest.ts
    • MiddlewareRegistrationTest.ts

Fixed Issues

$ #99650
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Test 1: App reloads its data after a cache clear

  1. Sign in as account A and confirm the report list is populated.
  2. Go to Settings > Troubleshoot and select Clear cache and restart.
  3. Confirm the app stays signed in rather than returning to the sign-in screen.
  4. Confirm the LHN repopulates with the report list.
  5. Open a report and confirm its messages are there.

Test 2: Storybook boots

  1. Run npm run storybook.
  2. Confirm it opens in the browser
  3. Open PromotedActionsBar story
  4. Confirm the story renders instead of a blank frame or error

Offline tests

QA Steps

  • 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
  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
android.native.mov
Android: mWeb Chrome
android.web.mov
iOS: Native
ios.native.mov
iOS: mWeb Safari
ios.web.mov
MacOS: Chrome / Safari
web.mov

@LukasMod

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. What shall we delve into next?

Reviewed commit: 4906ebdd47

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@LukasMod
LukasMod force-pushed the fix/no-cycle-api-middleware-registration branch 4 times, most recently from 344ae53 to c254445 Compare August 27, 2026 14:57
@LukasMod
LukasMod force-pushed the fix/no-cycle-api-middleware-registration branch from 8eb1865 to 4733d21 Compare August 28, 2026 11:19
@LukasMod

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Hooray!

Reviewed commit: 4733d2137c

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@LukasMod
LukasMod marked this pull request as ready for review August 28, 2026 12:49
@LukasMod
LukasMod requested review from a team as code owners August 28, 2026 12:49
@melvin-bot
melvin-bot Bot requested review from joekaufmanexpensify and thelullabyy and removed request for a team August 28, 2026 12:49
@melvin-bot

melvin-bot Bot commented Aug 28, 2026

Copy link
Copy Markdown

@thelullabyy 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]

@melvin-bot
melvin-bot Bot removed the request for review from a team August 28, 2026 12:49
Comment thread src/libs/Middleware/register.ts Outdated
Comment thread tests/unit/MiddlewareEntryPointTest.ts Outdated
@codecov

codecov Bot commented Aug 28, 2026

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/libs/API/makeRequest.ts 92.50% <ø> (-1.84%) ⬇️
src/libs/Middleware/register.ts 100.00% <100.00%> (ø)
src/setup/index.ts 100.00% <ø> (ø)
... and 11 files with indirect coverage changes

@joekaufmanexpensify

Copy link
Copy Markdown
Contributor

No product review needed.

@joekaufmanexpensify
joekaufmanexpensify removed their request for review August 28, 2026 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants