Skip to content

Add contacts import nitro module #54459

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

Open
wants to merge 48 commits into
base: main
Choose a base branch
from

Conversation

perunt
Copy link
Contributor

@perunt perunt commented Dec 23, 2024

Explanation of Change

https://github.com/Expensify/Mobile-Expensify/pull/13516 - use this PR for Expensify-Mobile

During the revert of the NitroModules PR, we identified two main issues affecting our iOS builds. First, there was a mismatch between the minimum iOS deployment target (set to 13.4) and our app's requirement (iOS 15). Second, we discovered build failures specific to iOS simulators due to a known Swift compiler issue.
While investigating, we found that our CI environment was running an older version of Xcode (15.2), which contributed to the build failures. We've addressed this by updating our CI configuration to use newer macOS runners and updating the Ruby GitHub Action version.
To move forward cleanly, we'll be splitting this into two separate PRs:

  • CI infrastructure update for newer Xcode support
  • Re-introduction of ContactsModule with correct iOS configuration

After implementing these changes in isolation, our test builds are now passing successfully.

revert #54421

Fixed Issues

$ #47938
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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 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 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@perunt
Copy link
Contributor Author

perunt commented Jan 6, 2025

I didn't test the Hybrid App as I don't have access yet

@perunt perunt marked this pull request as ready for review January 6, 2025 12:38
@perunt perunt requested a review from a team as a code owner January 6, 2025 12:38
@melvin-bot melvin-bot bot requested review from DylanDylann and shawnborton and removed request for a team January 6, 2025 12:38
Copy link

melvin-bot bot commented Jan 6, 2025

@shawnborton @DylanDylann One of you needs to 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]

@staszekscp
Copy link
Contributor

Hey! I've created a PR with adjustments so everything works fine with HybridApp

@mateuuszzzzz
Copy link
Contributor

mateuuszzzzz commented Jan 7, 2025

Hi! @perunt what's your Xcode version locally? I'm testing PR on HybridApp and I cannot build for simulators (it builds fine on physical device tho). My version is 16.2 (16C5032a)

I'm also curious about swiftc version. Here is mine: swift-driver version: 1.115.1 Apple Swift version 6.0.3 (swiftlang-6.0.3.1.10 clang-1600.0.30.1)

The key information here is that some people might encounter issues when building on a simulator, while others might not, depending on their Swift compiler version. This can block HybridApp development for people without physical iPhone

@mateuuszzzzz
Copy link
Contributor

mateuuszzzzz commented Jan 7, 2025

Nevertheless I think this is not a serious issue and we can proceed further with this PR and its HybridApp part 😅

People experiencing issues with the Swift compiler can try downgrading their Xcode version or using a physical device if available. cc: @Julesssss

@mateuuszzzzz
Copy link
Contributor

I think only remaining thing is to bump Xcode on CI infrastructure. I have this PR that was created before Christmas: #54424
I will sync it with main later today

blimpich
blimpich previously approved these changes Jan 7, 2025
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

Tentatively approving, seems like we need to confirm first that this doesn't break hybrid app for simulator's as per above comments.

@blimpich
Copy link
Contributor

blimpich commented Jan 7, 2025

Also I think we need to merge main due to xcode being bumped, which is why the validate github actions check is failing.

@perunt
Copy link
Contributor Author

perunt commented Jan 10, 2025

I'm still dealing with Android errors after bumping RN. I'll ping you once it's done

Copy link
Contributor

github-actions bot commented Apr 1, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@perunt
Copy link
Contributor Author

perunt commented Apr 1, 2025

@perunt what's the status here? There are a number of failing tests

Yes, there are a bunch of errors in the tests and ReportUtils, which weren’t touched in this PR. Same with Storybook. I’m working on resolving those. Apart from that, the code is ready, I had some issues with migrating to the latest Nitro on Android, but everything's settled now.
I’ll address the remaining errors later today

Copy link
Contributor

github-actions bot commented Apr 2, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Apr 2, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Apr 2, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@perunt
Copy link
Contributor Author

perunt commented Apr 2, 2025

@roryabraham all green. I’ve cleaned up the boilerplate and slightly changed the structure to make it easier to add a new module. Meanwhile it reuses all config from the root, so it should be good to go now

blimpich
blimpich previously approved these changes Apr 7, 2025
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

LGTM. @roryabraham can you take another look?

We need to resolve merge conflicts but with a PR this big lets just get consensus and then once that is reached we'll make sure to approve and merge right after Taras resolves the most recent round of merge conflicts

@blimpich
Copy link
Contributor

blimpich commented Apr 7, 2025

@DylanDylann can you go through the checklist?

@DylanDylann
Copy link
Contributor

Back to this PR today

Copy link
Contributor

github-actions bot commented Apr 8, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Copy link
Contributor

github-actions bot commented Apr 8, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@DylanDylann
Copy link
Contributor

@perunt Could you build Hybrid App successfully?

@perunt
Copy link
Contributor Author

perunt commented Apr 9, 2025

@perunt Could you build Hybrid App successfully?

It worked for me. Try using https://github.com/Expensify/Mobile-Expensify/pull/13516 for Mobile-Expensify. But in any case, Android should work even without that PR

@perunt
Copy link
Contributor Author

perunt commented Apr 9, 2025

@DylanDylann or instead of using this PR, you can simply switch 'ContactsModule' to 'NitroUtils' in the Podfile

firstName: detail?.firstName ?? '',
lastName: detail?.lastName ?? '',
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
firstName: (detail?.firstName || ('firstName' in participant ? participant.firstName : '')) ?? '',
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
firstName: (detail?.firstName || ('firstName' in participant ? participant.firstName : '')) ?? '',
firstName: (detail?.firstName || (participant?.firstName ?? ''))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did you check if the type works here? I'm seeing an error on my end with these changes
That's why I'm checking if the participant has a firstName/lastName property

I'll update the type to include it so everything looks clean

alternateText: formatPhoneNumber(login) || displayName,
icons: [
{
source: detail?.avatar ?? FallbackAvatar,
source: ('avatar' in participant ? participant.avatar : detail?.avatar) ?? FallbackAvatar,
Copy link
Contributor

Choose a reason for hiding this comment

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

same above

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TS complains about this as well
I'll update the type to include it

@blimpich blimpich requested a review from roryabraham April 9, 2025 17:38
@@ -14,4 +14,5 @@ web/gtm.js
src/libs/SearchParser/searchParser.js
src/libs/SearchParser/autocompleteParser.js
help/_scripts/**
modules/**
Copy link
Contributor

Choose a reason for hiding this comment

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

why ignore this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's a bit leftover. It's a bit leftover.
Since we reuse everything from the root and don't use a separate formatting system I need to change it so it ignores only autogenerated nitrogen files

@@ -65,7 +65,7 @@
</Testables>
</TestAction>
<LaunchAction
buildConfiguration = "ReleaseProduction"
buildConfiguration = "DebugDevelopment"
Copy link
Contributor

Choose a reason for hiding this comment

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

This change looks sus to me - why is it introduced?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tested it during merge, it wasn't intentional changes, removed
Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we rename this to modules/ExpensifyNitroUtils/ExpensifyNitroUtils.podspec? That way it shows up in the Podfile.lock as ExpensifyNitroUtils instead of UtilsModule, making it clearer what it is.


set (PACKAGE_NAME UtilsModule)
set (CMAKE_VERBOSE_MAKEFILE ON)
set (CMAKE_CXX_STANDARD 20)
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason not to use C++23?

Copy link
Contributor

Choose a reason for hiding this comment

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

Should this path be modules/ExpensifyNitroUtils/android/src/main/java/com/expensify/nitro/utils/UtilsModulePackage.java?


private fun requestContactPermission(): Boolean {
val currentActivity = context.currentActivity
return if (currentActivity != null) {
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB but I think this would be clearer written in a style more similar to other programming languages:

if (currentActivity == null) {
    return false
}

// Request permissions
ActivityCompat.requestPermissions(
    currentActivity, 
    arrayOf(REQUIRED_PERMISSION), 
    PERMISSION_REQUEST_CODE
)
return true


companion object {
const val PERMISSION_REQUEST_CODE = 1
const val REQUIRED_PERMISSION = Manifest.permission.READ_CONTACTS
Copy link
Contributor

Choose a reason for hiding this comment

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

This is only used once and cast to an array. Why not just initialize it as an array here?

Suggested change
const val REQUIRED_PERMISSION = Manifest.permission.READ_CONTACTS
const val REQUIRED_PERMISSIONS = arrayOf(Manifest.permission.READ_CONTACTS)

}

private fun hasPhoneContactsPermission(): Boolean {
val result = ContextCompat.checkSelfPermission(context, Manifest.permission.READ_CONTACTS) == PackageManager.PERMISSION_GRANTED
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB remove the redundant result variable here

ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE
)

val sortOrder = "${ContactsContract.Data.CONTACT_ID} ASC"
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should sort by last name rather than CONTACT_ID?


context.contentResolver?.let { resolver ->
val projection = arrayOf(
ContactsContract.Data.MIMETYPE,
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB move projection, selection, selectionArgs, and sortOrder to companion because they're static and never change

"scripts": {
"postinstall": "tsc || exit 0;",
"typecheck": "tsc --noEmit",
"clean": "del-cli android/build node_modules/**/android/build lib",
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is del-cli being used here? Would rm -rf work the same? Also del-cli isn't listed as a dev dependency, so I'm not sure this would work out of the box.

@@ -46,7 +46,7 @@
"perf-test": "NODE_OPTIONS=--experimental-vm-modules npx reassure",
"typecheck": "NODE_OPTIONS=--max_old_space_size=8192 tsc",
"lint": "NODE_OPTIONS=--max_old_space_size=8192 eslint . --max-warnings=0 --cache --cache-location=node_modules/.cache/eslint",
"lint-changed": "NODE_OPTIONS=--max_old_space_size=8192 eslint --max-warnings=0 --config ./.eslintrc.changed.js $(git diff --diff-filter=AM --name-only origin/main HEAD -- \"*.ts\" \"*.tsx\")",
"lint-changed": "NODE_OPTIONS=--max_old_space_size=8192 eslint --max-warnings=0 --config ./.eslintrc.changed.js $(git diff --diff-filter=AM --name-only origin/main HEAD -- \"*.ts\" \"*.tsx\" \":!modules/**\")",
Copy link
Contributor

Choose a reason for hiding this comment

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

Why disable lint in the modules directory?

CONST.DEVICE_CONTACT.IMAGE_DATA,
]);
}
return [] as Contact[];
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB flip this for better readability:

if (response !== RESULTS.GRANTED) {
    return [] as Contact[];
}

return ContactsNitroModule.getAll(...)

@@ -6816,6 +6816,14 @@ const CONST = {
},
},

DEVICE_CONTACT: {
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like this is duplicated from modules/ExpensifyNitroUtils/specs/ContactsModule.nitro.ts - could we just use that as the source of truth?

export type ContactFields = 'FIRST_NAME' | 'LAST_NAME' | 'MIDDLE_NAME' | 'PHONE_NUMBERS' | 'EMAIL_ADDRESSES' | 'IMAGE_DATA' | 'THUMBNAIL_IMAGE_DATA' | 'GIVEN_NAME_KEY';

export interface ContactsModule extends HybridObject<{ios: 'swift'; android: 'kotlin'}> {
getAll(keys: ContactFields[]): Promise<Contact[]>;
Copy link
Contributor

Choose a reason for hiding this comment

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

I see this is only used once, so you could simplify things by just hard-coding the fields we query to [FIRST_NAME, LAST_NAME, PHONE_NUMBERS, EMAIL_ADDRESSES, IMAGE_DATA] since those are the only fields we deep to be using.

@blimpich
Copy link
Contributor

@perunt any update here?

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.

7 participants