Skip to content

[NoQA] Add lint rule against opaque use of namespace imports - #107131

Merged
roryabraham merged 5 commits into
Expensify:mainfrom
Eskalifer1:namespace-usage-lint-rule
Nov 17, 2026
Merged

roryabraham merged 5 commits into
Expensify:mainfrom
Eskalifer1:namespace-usage-lint-rule

Conversation

@Eskalifer1

Copy link
Copy Markdown
Contributor

Explanation of Change

Step 5 of the plan in #106552.

Problem
knip stops checking a module's exports when the module is imported as import * as X and X is then used in a way knip cannot follow: indexed with a computed key, enumerated with Object.keys or for...in, rest-destructured, used as a destructuring default, or assigned to a variable that is never read as alias.member. It then treats every export as used and dead ones stay hidden. Earlier steps cleared the existing cases, but nothing stops new ones from coming back.

Solution
A lint rule reports exactly those forms for namespace imports of the repo's own modules. The list comes from running knip on each form: other whole-namespace uses such as spread, passing the namespace to a function, returning it or re-exporting it are tracked by knip, so they stay allowed. The five places on main that broke the rule are fixed here, so it needs no baseline entries:

  • WorkspaceDefaultAvatars, GroupDefaultAvatars and MCCIcons export one default object. ReportUtils and useEReceipt picked an icon by a computed key on the namespace, and these dictionaries have no other consumer, so indexing a plain object is the smallest change.
  • Two tests import what they need by name or as a type.

Result
A new hidden use of a namespace now fails lint, and knip sees unused exports in the three icon modules again.

main this PR change
Hidden namespace uses in the repo 5 0 -5
Unused-export probes knip reports in the three icon modules 0 of 3 3 of 3 +3

Fixed Issues

$ #106552
PROPOSAL:

Tests

A computed key on a namespace is reported

  1. Create src/libs/NamespaceProbe.ts with import * as Formula from '@libs/Formula'; export default function probe(key: keyof typeof Formula) { return Formula[key]; }.
  2. Run npm run lint -- src/libs/NamespaceProbe.ts.
  3. Verify the output contains rulesdir/no-opaque-namespace-usage with "computed key".
  4. Delete the file.

Plain member access is not reported

  1. Create src/libs/NamespaceProbe.ts with import * as Formula from '@libs/Formula'; export default function probe() { return Formula.parse; }.
  2. Run npm run lint -- src/libs/NamespaceProbe.ts.
  3. Verify the output does not contain rulesdir/no-opaque-namespace-usage.
  4. Delete the file.
  • Verify that no errors appear in the JS console

Offline tests

N/A, tooling only

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
  • 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 any copy / text that was added to the app 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)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • 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)
  • 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 the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@Eskalifer1

Copy link
Copy Markdown
Contributor Author

@codex Review
@MelvinBot Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-17T20:02:45.540357Z 31d4e36 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@MelvinBot

Copy link
Copy Markdown
Contributor

Review finding

[P2] Account for source order when checking alias reads — eslint-plugin-local-rules/no-opaque-namespace-usage.js:168–170

The rule counts member accesses anywhere in the file, but Knip registers aliases in source order. This valid pattern therefore passes lint while still hiding unused exports:

import * as NS from './utils';
function run() { Alias.used(); }
const Alias = NS;
NS.used();
run();

Confirmed with Knip 6.34.0: when utils exports used and unused, this produces no unused-export diagnostic. Moving the alias declaration above the function makes Knip report unused; the lint rule accepts both.

Match Knip’s source-order behavior and add regression coverage for both declaration orders.

Validation: Changed-file lint passed; 2,545 focused Jest tests and 19 Bun tests passed. No browser testing performed.


view run

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2780b16d19

ℹ️ 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".

@Eskalifer1

Copy link
Copy Markdown
Contributor Author

@codex review
@MelvinBot Review

@MelvinBot

Copy link
Copy Markdown
Contributor

Review finding

[P2] Include named-import aliases in source-order tracking — eslint-plugin-local-rules/no-opaque-namespace-usage.js:179–185

firstDeclarationStart considers only namespace aliases, but Knip also registers aliases of named imports. This causes a false-positive lint error when separate functions reuse an alias name:

import * as Utils from './utils';
import {obj} from './other';

function first() {
    const Alias = obj;
    return Alias.member;
}
function second() {
    const Alias = Utils;
    consume(Alias);
}
Utils.other();
first();
second();

Confirmed with Knip 6.34.0 and the actual lint pipeline: lint reports unread alias, although Knip still reports unused exports. Include named-import aliases in the declaration bookkeeping and add regression coverage.

The previous source-order finding is fixed. Validation passed: 2,506 focused Jest tests and changed-file lint. No browser testing performed.


view run

@Eskalifer1

Copy link
Copy Markdown
Contributor Author

@MelvinBot Review

@MelvinBot

Copy link
Copy Markdown
Contributor

Review finding

[P2] Exclude external-package aliases from declaration tracking — eslint-plugin-local-rules/no-opaque-namespace-usage.js:230–233

The new bookkeeping includes package imports, but Knip 6.34 registers aliases only for internally resolved imports. Consequently, this pattern incorrectly passes the rule:

import * as Utils from './utils';
import React from 'react';

function first() {
    const Alias = React;
    return Alias.createElement;
}
function second() {
    const Alias = Utils;
    consume(Alias);
}
Utils.other();
first();
second();

The rule counts the earlier React alias access; Knip does not register that alias, so the later namespace alias remains opaque and hides unused exports.

Restrict auxiliary alias declarations to internal imports and add regression coverage. The previous internal named-import case is addressed.

Verification: Traced against installed Knip source. Runtime reproduction, lint, and tests were blocked by execution permissions.


view run

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: 931db2443e

ℹ️ 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".

@Eskalifer1

Copy link
Copy Markdown
Contributor Author

@MelvinBot Review

@MelvinBot

Copy link
Copy Markdown
Contributor

Review findings

[P2] Restrict exported-spread traversal to Knip-supported property keys — eslint-plugin-local-rules/no-opaque-namespace-usage.js:169–170

The traversal accepts quoted property keys, but Knip only descends through identifier keys. For example:

Utils.used();
export const copy = {'nested': {...obj}};
function run() {
    const copy = Utils;
    consume(copy);
}
run();

With internal imports for Utils and obj, lint accepts this while Knip hides unused Utils exports. Changing 'nested' to nested makes Knip report them. Match Knip’s property restrictions and add regression coverage.

[P2] Register destructuring-default aliases — eslint-plugin-local-rules/no-opaque-namespace-usage.js:136–154

Knip registers const {value: Alias = obj} = {} as an alias declaration, but getAssignedAlias omits it. Consequently, an earlier Alias.member read does not count toward a later namespace alias of the same name, producing an incorrect unread alias error even though Knip reports unused exports. Include this declaration form in the bookkeeping.

Validation: Both findings reproduced against Knip 6.34.0 and the current rule. The previous external-package alias finding is fixed. Focused checks passed: 857 Jest tests, 19 Bun tests, and changed-file lint.


view run

@Eskalifer1

Copy link
Copy Markdown
Contributor Author

The previos finding mirrors how Knip 6.34 registers aliases, but our lint rule does not copy every internal quirk. Shapes such as quoted keys inside an exported nested spread, destructuring-default aliases, shadowed or parenthesized namespace names, and two {key: NS} declarations with the same variable and key do not occur in the repo, and the rule reports 0 violations in it. They are listed in the rule header, and the rule can be extended with a test if one ever appears.

@Eskalifer1
Eskalifer1 marked this pull request as ready for review November 17, 2026 19:44
@Eskalifer1
Eskalifer1 requested review from a team as code owners November 17, 2026 19:44
@expensify-chore-bot
expensify-chore-bot Bot requested review from bernhardoj and removed request for a team November 17, 2026 19:44
@expensify-chore-bot

Copy link
Copy Markdown

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

@expensify-chore-bot
expensify-chore-bot Bot requested review from garrettmknight and removed request for a team November 17, 2026 19:44
@Eskalifer1

Copy link
Copy Markdown
Contributor Author

Sorry for the noise @bernhardoj, this issue doeb't require C+

@roryabraham

Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 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)
  • 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)
  • 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.
  • 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: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@roryabraham
roryabraham merged commit 602e805 into Expensify:main Nov 17, 2026
42 of 44 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚧 roryabraham has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.5.41-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site update needed — this PR adds developer linting and refactors internal imports without changing user-facing features, workflows, or labels, so no existing article becomes incorrect.


view run

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.5.41-2 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

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.

4 participants