Skip to content

Add required SignerFields#81602

Open
NikkiWines wants to merge 5 commits intomainfrom
nikki-fix-invalid-inputs
Open

Add required SignerFields#81602
NikkiWines wants to merge 5 commits intomainfrom
nikki-fix-invalid-inputs

Conversation

@NikkiWines
Copy link
Contributor

@NikkiWines NikkiWines commented Feb 5, 2026

Explanation of Change

This PR fixes an issue where required signer fields (signerFullName, signerDateOfBirth, signerJobTitle) were being silently omitted from the API request payload when not present in the form draft. This caused the Auth backend to receive incomplete data and fail with cryptic validation errors like "Invalid inputs" instead of properly identifying which required fields were missing.

Fix:

  1. Added a requiredSignerFields constant defining which fields must always be sent to the backend
  2. Modified the logic to always include required fields (with empty string if not present) so the backend can properly validate and return meaningful error messages
  3. Used SafeString() to ensure consistent string handling

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/593959
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console
  1. Go to a workspace with Non-USD bank account setup in progress
  2. Navigate to the Signer Info step
  3. Complete the form with all required fields filled
  4. Submit and verify the request succeeds
  5. Check the network tab to verify signerDateOfBirth, signerFullName, and signerJobTitle are present in the payload

Offline tests

N/A - This change affects form submission, which requires network connectivity

QA Steps

  • Verify that no errors appear in the JS console
  1. On staging, attempt to complete the Non-USD bank account Signer Info step
  2. Verify all required signer fields are being sent in the API request
  3. Verify that if any required field is missing, a proper validation error is returned instead of generic "Invalid inputs"

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

N/A - Backend/utility change only, no UI changes

Android: mWeb Chrome

N/A - Backend/utility change only, no UI changes

iOS: Native

N/A - Backend/utility change only, no UI changes

iOS: mWeb Safari

N/A - Backend/utility change only, no UI changes

MacOS: Chrome / Safari

N/A - Backend/utility change only, no UI changes

@NikkiWines NikkiWines self-assigned this Feb 5, 2026
@codecov
Copy link

codecov bot commented Feb 5, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
...ils/getSignerDetailsAndSignerFilesForSignerInfo.ts 0.00% <0.00%> (ø)
... and 12 files with indirect coverage changes

@NikkiWines NikkiWines marked this pull request as ready for review February 6, 2026 19:19
@NikkiWines NikkiWines requested review from a team as code owners February 6, 2026 19:19
@melvin-bot melvin-bot bot requested a review from jayeshmangwani February 6, 2026 19:19
@melvin-bot
Copy link

melvin-bot bot commented Feb 6, 2026

@jayeshmangwani 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 requested review from joekaufmanexpensify and removed request for a team February 6, 2026 19:19
// Always include required fields (with empty string if not present) so Auth validation can catch them
// For non-required fields, only include if they have a value
if (requiredSignerFields.has(fieldName) || reimbursementAccountDraft?.[fieldName]) {
signerDetails[fieldName] = SafeString(reimbursementAccountDraft?.[fieldName]);
Copy link
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-2 (docs)

The SafeString() function is applied to required fields even when they might be undefined, but there is no documentation explaining what SafeString(undefined) returns. This could lead to unexpected behavior if SafeString(undefined) does not return an empty string as intended.

Suggested fix: Add a comment explaining the behavior, or make the intent explicit by using a ternary operator to return an empty string when the field is not present.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.


// These fields are required by the backend and must always be included in the request
// so that proper validation errors can be returned if they're missing
const requiredSignerFields = new Set<string>([FULL_NAME, DATE_OF_BIRTH, JOB_TITLE]);
Copy link
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-6 (docs)

When isUserBeneficialOwner is true, the code explicitly sets FULL_NAME, DATE_OF_BIRTH, and ADDRESS to empty strings (line 50-52 in the original file), but JOB_TITLE is now always required via requiredSignerFields. This may be inconsistent with the intended behavior.

Consider whether JOB_TITLE should be conditionally required based on isUserBeneficialOwner, or if the current behavior is correct. If JOB_TITLE should always be required regardless of beneficial owner status, consider adding it to the explicit initialization block for consistency.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

Copy link

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

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: 6131c9f7fc

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

Comment on lines +48 to +51
// Always include required fields (with empty string if not present) so Auth validation can catch them
// For non-required fields, only include if they have a value
if (requiredSignerFields.has(fieldName) || reimbursementAccountDraft?.[fieldName]) {
signerDetails[fieldName] = SafeString(reimbursementAccountDraft?.[fieldName]);

Choose a reason for hiding this comment

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

P2 Badge Preserve boolean type for downloadedPDSandFSG

When DOWNLOADED_PDS_AND_FSG is present, this now runs through SafeString, which converts booleans to strings (e.g., 'true'). The API/type definitions expect a boolean for this field (see ReimbursementAccount and EnterSignerInfo flows), so sending a string can cause backend validation to reject the payload or mis-handle the value. This regression only appears for this field because it’s the lone boolean in signerDetailsFields.

Useful? React with 👍 / 👎.

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