Skip to content

fix: preserve iOS PDF password form during rotation - #104182

Open
nabi-ebrahimi wants to merge 3 commits into
Expensify:mainfrom
nabi-ebrahimi:fix/103531-ios-pdf-keyboard-avoidance
Open

nabi-ebrahimi wants to merge 3 commits into
Expensify:mainfrom
nabi-ebrahimi:fix/103531-ios-pdf-keyboard-avoidance

Conversation

@nabi-ebrahimi

@nabi-ebrahimi nabi-ebrahimi commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Move keyboard avoidance from the attachment screen to the PDF password form on iOS, preventing keyboard and rotation changes from resizing the pager and switching attachments. Use automaticOffset to account for the modal header and keep Confirm reachable above the keyboard.

The change is scoped to iOS modal PDFs, preserving existing Android and inline-preview behavior.

Fixed Issues

$ #103531

PROPOSAL: #103531 (comment)

Tests

Preconditions: A 1:1 chat contains several attachments, including a password-protected PDF that is not the first attachment.

  1. Log in and open the chat.
  2. Open the protected PDF and tap Enter the password.
  3. With the password field focused and the software keyboard visible, rotate to landscape.
  4. Verify the same PDF and password form stay open and Confirm remains reachable and tappable.
  5. Submit an incorrect password, then retry with the correct password and verify the PDF unlocks.
  6. Rotate back to portrait and verify the PDF remains open.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests, using a previously loaded PDF while offline.

QA Steps

Same as Tests.

  • 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
Screen_Recording_20261016_201858_New.Expensify.Dev.mp4
Android: mWeb Chrome
Screen_Recording_20261016_202643_Chrome.mp4
iOS: Native
iPhone.11.simulator.iOS.26.3.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari

@codecov

codecov Bot commented Oct 16, 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 Δ
...nableAttachmentModalKeyboardAvoidance/index.ios.ts 100.00% <100.00%> (ø)
...alScreen/AttachmentModalContainer/index.native.tsx 86.66% <ø> (ø)
src/components/PDFView/index.native.tsx 84.31% <66.66%> (-1.41%) ⬇️
...leAttachmentModalKeyboardAvoidance/index.native.ts 0.00% <0.00%> (ø)
...uldEnableAttachmentModalKeyboardAvoidance/index.ts 0.00% <0.00%> (ø)
... and 148 files with indirect coverage changes

@nabi-ebrahimi
nabi-ebrahimi marked this pull request as ready for review October 17, 2026 09:43
@nabi-ebrahimi
nabi-ebrahimi requested review from a team as code owners October 17, 2026 09:43
@melvin-bot
melvin-bot Bot requested review from heyjennahay and huult and removed request for a team October 17, 2026 09:43
@melvin-bot

melvin-bot Bot commented Oct 17, 2026

Copy link
Copy Markdown

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

@chatgpt-codex-connector

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

Copy link
Copy Markdown

Codex Review Summary

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

Review Status Commit Review trigger
📝 Code Review ⚠️ Failed 2026-10-17T10:05:39.966573Z 92083a6 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.

Comment thread src/components/PDFView/index.native.tsx Outdated
Comment thread src/pages/media/AttachmentModalScreen/AttachmentModalContainer/index.native.tsx Outdated
@huult

huult commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

@MelvinBot review this?

@huult

huult commented Oct 17, 2026

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 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 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
    • 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
    • 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 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).
  • 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

@MelvinBot

Copy link
Copy Markdown
Contributor

The fix approach looks right to me. It needs one change before approval: replace the runtime getPlatform() checks with platform-specific files (CONSISTENCY-1). I also found two minor issues.

  1. Platform checks (must fix). PDFView/index.native.tsx:76 and AttachmentModalContainer/index.native.tsx:66 branch on iOS inside shared .native.tsx files. Move each value into a small index.ios.ts / index.ts helper. For example, use a shouldEnableKeyboardAvoidingView helper that returns false on iOS and true elsewhere. This also resolves both open bot comments.
  2. Web prop leak (minor). automaticOffset is now in the shared KeyboardAvoidingView/types.ts. However, the web stub spreads ...rest onto Animated.View at BaseKeyboardAvoidingView/index.tsx:18. No web caller passes it today. Still, destructure it there so a future caller doesn't get an unknown-DOM-prop warning.
  3. PR body (minor). The checklist says unit tests were added, but the diff has none. The iOS mWeb Safari and MacOS video sections are also empty.
Why the approach is sound
  • Before this PR, the ScreenWrapper keyboard avoidance (padding) wrapped the whole attachment screen. When the keyboard opened or the device rotated, the pager resized and the carousel jumped to a different attachment.
  • The inner KeyboardAvoidingView around PDFPasswordForm had no behavior. In react-native-keyboard-controller, that means it returned {} and did nothing. Giving it padding keeps the resizing inside the page, so the pager size stays stable.
  • automaticOffset measures the view's real on-screen position. This accounts for the modal header, so Confirm stays above the keyboard.
  • The attachment modal routes contain no other text inputs. Turning off screen-level avoidance on iOS should not affect other flows.
  • Android and inline previews are unchanged.

I did not test this on a device. The change is iOS-native only, and this run could only test on web.


view run

@github-actions

github-actions Bot commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@nabi-ebrahimi
nabi-ebrahimi force-pushed the fix/103531-ios-pdf-keyboard-avoidance branch from a38f197 to f5e7b2f Compare October 17, 2026 10:58

This branch has not been deployed

No deployments
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.

3 participants