Skip to content

Remove unsafe assertions from SearchRouter parser substitutions - #100942

Draft
KJ21-ENG wants to merge 1 commit into
Expensify:mainfrom
KJ21-ENG:seatbelt-v2/replacement-search-router-a7f9ba43
Draft

Remove unsafe assertions from SearchRouter parser substitutions#100942
KJ21-ENG wants to merge 1 commit into
Expensify:mainfrom
KJ21-ENG:seatbelt-v2/replacement-search-router-a7f9ba43

Conversation

@KJ21-ENG

Copy link
Copy Markdown
Contributor

Explanation of Change

Add separate raw generated-parser declaration/types and remove unsafe assertions from the SearchRouter substitution seam. Generated JavaScript is unchanged: the declaration truthfully preserves quoted/comma values, range positions, duplicate occurrence indexes, tax aliases, dynamic and mixed-case keys, explicit substitution precedence, the positive-account me fallback, stale-map pruning, and null, full, or key-only autocomplete results.

SearchRouterUtils intentionally now returns undefined when a Report or ExpenseReport has absent, missing, or non-string reportID; valid string IDs and existing overlay traversal are preserved.

Changed files:

  • src/components/Search/SearchRouter/SearchRouterUtils.ts
  • src/components/Search/SearchRouter/buildSubstitutionsMap.ts
  • src/components/Search/SearchRouter/getAutocompleteSelectionSubstitutionKey.ts
  • src/components/Search/SearchRouter/getQueryWithSubstitutions.ts
  • src/components/Search/SearchRouter/getUpdatedSubstitutionsMap.ts
  • src/components/Search/types.ts
  • src/libs/SearchParser/autocompleteParser.d.ts

Fixed Issues

$ #94739
PROPOSAL: #94739 (comment)

Tests

Focused local checks passed lint, format, spelling, identity, hygiene, five existing Jest suites (39 tests), 171 parser assertions, and 35 production assertions. No new committed tests were added. Local TypeScript remains waived, not passed: the changed-root and no-skipLibCheck API probes have no candidate/API-probe diagnostics, but 43 imported-App and 738 imported/dependency diagnostics prevent a complete local program guarantee.

Fork CI run 34477141288, attempt 1 passed full typecheck, lint, format, React Compiler, Jest, and final collection for signed head 6e4840e1f3a7265b51759ace5d62a15f5e0adb47 against 4541881ce86bcac1185c2b8088e9fd4beb23be3c.

Manual QA has not been performed; repeat the staging steps below.

  • Verify that no errors appear in the JS console

Offline tests

Not performed and not applicable to this exact diff: it changes no offline behavior, network request, or offline fallback.

QA Steps

Manual QA required. QA before review. The defensive reportID guard changes a runtime contextual-search outcome. On staging, use Search to open SearchRouter over both Report and ExpenseReport, then exercise nested routes, an overlay route, and a non-report screen. Enter or select quoted/comma workspace or room names and duplicate values; submit the result and verify the expected report context and substitutions. For missing or non-string report IDs, verify no crash and no contextual report lookup. Check the JS console throughout.

  • Verify that no errors appear in the JS console

PR Author Checklist

The issue is linked and repeatable QA is documented, but no manual, offline, console, High Traffic, all-platform, screenshot, or new-unit-test work was performed. Conditional CSS, asset, copy, layout, Storybook, deeplink, markdown-editing, and new-pattern claims are not applicable to this diff and remain unchecked.

  • 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 followed proper code patterns (see Reviewing the code)
    • 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 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)
  • 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.
  • 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

No screenshots or video were produced.

Seatbelt-Operation: s08-a7f9ba43-4541881-sign-1
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.

1 participant