Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contacts import #51018

Merged
merged 118 commits into from
Dec 11, 2024
Merged

Contacts import #51018

merged 118 commits into from
Dec 11, 2024

Conversation

perunt
Copy link
Contributor

@perunt perunt commented Oct 17, 2024

Details

In this PR, we've implemented a Nitro Module for accessing device contacts (iOS, Android) for native mobile platforms only. Key implementation details:

Utilized nitro-codegen for auto-generating bindings and supporting files
Based on react-native-nitro-template
Most code in modules/NitroContactModule is auto-generated through Nitro's toolchain

Most implementation is auto-generated, please focus review on:

  • modules/ContactsNitroModule/android/src/main/java/com/margelo/nitro/contacts/ContactsModulePackage.java
  • modules/ContactsNitroModule/ios/HybridContactsModule.swift
    And the rest JS code

Fixed Issues

$ #47938
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Scenario 1: Permission Granted

  1. Initiate a 'Submit Expense' request.
  2. Attach a photo to the expense.
  3. Verify that you are automatically navigated to the user-selected page.
  4. Confirm that the Contact Permission modal appears.
  5. Select "Accept" on the permission prompt.
  6. Check that new contacts from the device phonebook appear as expected.

Scenario 2: Permission Denied

  1. Initiate a 'Submit Expense' request.
  2. Attach a photo to the expense.
  3. Verify that you are automatically navigated to the user-selected page.
  4. Confirm that the Contact Permission modal appears.
  5. Select "Deny" on the permission prompt.
  6. Ensure that no contacts from the device phonebook are displayed.
  • 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
    • MacOS: Desktop
  • 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 verified the translation was requested/reviewed 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.js 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 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.
  • 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
R_ex.mp4
Android: mWeb Chrome
iOS: Native
RPReplay_Final1732184706.MP4
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@dubielzyk-expensify
Copy link
Contributor

Thanks for the recording @perunt . Looks good 👍

@perunt
Copy link
Contributor Author

perunt commented Dec 11, 2024

It becomes overdue very quickly 🥲

@melvin-bot melvin-bot bot requested a review from blimpich December 11, 2024 15:13
@perunt
Copy link
Contributor Author

perunt commented Dec 11, 2024

@blimpich is there anything else I can help with?

@blimpich blimpich merged commit 001a6e2 into Expensify:main Dec 11, 2024
19 checks passed
@blimpich
Copy link
Contributor

@blimpich is there anything else I can help with?

No I think we're good with this PR! Thank you!

@OSBotify
Copy link
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.

@Julesssss
Copy link
Contributor

Hey all. I am sorry but I need to revert this one. We merged major changes to the HybridApp repo and build process earlier today and this is likely to conflict. Here is an internal discussion for anyone with access.

@Julesssss Julesssss mentioned this pull request Dec 11, 2024
48 tasks
@Julesssss
Copy link
Contributor

Hopefully we should be able to resubmit quickly.

@DylanDylann
Copy link
Contributor

@Julesssss Let's me know when we can re-submit this PR

@blimpich
Copy link
Contributor

blimpich commented Dec 11, 2024

@blimpich is there anything else I can help with?

No I think we're good with this PR! Thank you!

@perunt I take back my previous statement, can you resubmit this PR 🫠? I'll follow along with the internal conversations about when we'll be safe to merge this in again.

@blimpich
Copy link
Contributor

blimpich commented Dec 11, 2024

@DylanDylann I'll follow along and let us know when we're good to try and merge again.

@Julesssss
Copy link
Contributor

Our main worry is conflicts due to similar files being touched. Once this issue is resolved and build issues are resolved (we expect many), you should be good to go!

Copy link
Contributor

🚀 Deployed to staging by https://github.com/blimpich in version: 9.0.75-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 iOS HybridApp 🍎🔄 success ✅

@mvtglobally
Copy link

Do we need to QA this? Can I check it off as it was reverted #53961

@Julesssss
Copy link
Contributor

@mvtglobally no QA required. thank you

@perunt
Copy link
Contributor Author

perunt commented Dec 12, 2024

@blimpich sure, I'll do it later today

Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.75-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 success ✅

@perunt perunt mentioned this pull request Dec 16, 2024
50 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants