feat(Android): setup background task #54616

szymonrybczak · 2024-12-27T11:42:14Z

Explanation of Change

Warning

This Pull Request is rebased on top of the Upgrade to React Native 0.76 Pull Request because it's using a new type-safe way of creating EventEmitters available only in 0.76, and relevant PR for iOS because it shares the same JS specs

Adds an implementation of background task on Android. This implemenation leverages JobScheduler API for scheduling tasks.

From the more technical perspective it's a C++ TurboModule that was bootstrapped as a Local Library so it's linked inside package.json.

For now, we're scheduling new tasks in 15-minute intervals after the execution of the previous one.

How to test it?

You can view scheduled background task when running adb shell dumpsys jobscheduler:

JOB #u0a164/6588028: 2eca6dd com.expensify.chat.dev/com.expensify.reactnativebackgroundtask.BackgroundJobService
    u0a164 tag=*job*/com.expensify.chat.dev/com.expensify.reactnativebackgroundtask.BackgroundJobService
    Source: uid=u0a164 user=0 pkg=com.expensify.chat.dev
    JobInfo:
      Service: com.expensify.chat.dev/com.expensify.reactnativebackgroundtask.BackgroundJobService
      PERIODIC: interval=+15m0s0ms flex=+15m0s0ms
      PERSISTED
      Priority: 300 [DEFAULT]
      Requires: charging=false batteryNotLow=false deviceIdle=false
      Extras: {taskName=FLUSH-SEQUENTIAL-QUEUE-BACKGROUND-FETCH}
      Network type: NetworkRequest [ NONE id=0, [ Capabilities: INTERNET&TRUSTED&VALIDATED&NOT_VCN_MANAGED Uid: 10164 UnderlyingNetworks: Null] ]
      Backoff: policy=1 initial=+30s0ms
      Has early constraint
      Has late constraint

To force execution of the background task can execute following command on attached device:

adb shell cmd jobscheduler run -f com.expensify.chat.dev 6588028

specified id is a hash code of the FLUSH-SEQUENTIAL-QUEUE-BACKGROUND-FETCH string.

Here's a video presenting this behaviour:

CleanShot.2024-12-27.at.12.38.54.mp4

Fixed Issues

$ #50140
PROPOSAL: #50140

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open the app on physical iPhone with Account A
Open the app on Web with Account B
With Account A activate the Flight mode and send some messages, for easier tracking send from 1 to 9, each on its one message
Move Account A’s app into background
Enable turn off the Flight mode
Watch the Account B, messages and any performed actions should show up

Note: take into account that could some time for the first time, this times will be improved and vary depending on the app usage on the device. We set the interval between tasks to 15 minutes but at the end of the day Android decides when to execute it.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-12-27T11:42:20Z

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

github-actions · 2024-12-28T21:18:12Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

modules/background-task/android/build.gradle

modules/background-task/android/gradle.properties

modules/background-task/android/build.gradle

modules/background-task/expensify-react-native-background-task.podspec

shubham1206agra · 2025-01-08T07:26:58Z

@szymonrybczak Can you fix the lint?

github-actions · 2025-01-08T08:56:23Z

🚧 @Beamanator has triggered a test build. You can view the workflow run here.

github-actions · 2025-01-08T09:22:42Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/54616/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/54616/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/54616/NewExpensify.dmg	https://54616.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

ishpaul777 · 2025-01-14T18:42:40Z

@szymonrybczak can you please merge i'll try building again on my local, adhoc android build is still crashing for me

szymonrybczak · 2025-01-14T22:24:55Z

@ishpaul777 done ✅ let me know what are the results when you run app locally 🙏

luacmartins

Nice work so far. We just got the iOS PR merged, let's try to get this one merged soon too.

modules/background-task/android/build.gradle

shubham1206agra · 2025-01-15T07:18:16Z

@szymonrybczak Local build is not crashing, but background task is not starting at all. Even if I force it.

shubham1206agra · 2025-01-15T07:19:11Z

shubham1206agra · 2025-01-17T09:47:09Z

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 tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
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 proper code patterns were followed (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
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
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)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- 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
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- 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 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.
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

Screen.Recording.2025-01-17.at.2.39.44.PM.mov

shubham1206agra · 2025-01-17T09:48:11Z

@szymonrybczak Can you fix your PR description?

mountiny · 2025-01-17T09:50:41Z

@ishpaul777 @shubham1206agra please keep in mind that it is c+ responsibility to make sure native changes and any podfile changes are also reflected in hybrid app when the contributor does not have access - we had to add the pod changes in this PR https://github.com/Expensify/Mobile-Expensify/pull/13365/files just for your interest.

Please check if there is anything more to add from this PR too

shubham1206agra · 2025-01-17T09:54:33Z

@mountiny, I did not reviewed the iOS PR for this feature. @mananjadhav reviewed that PR.

shubham1206agra · 2025-01-17T09:56:51Z

@szymonrybczak Can you check if you need to do some config in HybridApp?

shubham1206agra · 2025-01-17T10:59:06Z

@ishpaul777 @shubham1206agra please keep in mind that it is c+ responsibility to make sure native changes and any podfile changes are also reflected in hybrid app when the contributor does not have access - we had to add the pod changes in this PR https://github.com/Expensify/Mobile-Expensify/pull/13365/files just for your interest.

Please check if there is anything more to add from this PR too

@mountiny Can confirm it is working on HybridApp on latest main

mountiny · 2025-01-17T12:04:23Z

@shubham1206agra SWM has updated the Podfile for the ios part - just noting that if you need to make more changes here, dont forget about it.

@szymonrybczak I believe you should have access to HybridApp now too

melvin-bot · 2025-01-17T14:25:57Z

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

luacmartins · 2025-01-17T14:26:40Z

Failing action was just a GH comment. Not an emergency

OSBotify · 2025-01-17T14:34:38Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-01-21T08:30:29Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.88-0 🚀

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

github-actions · 2025-01-23T18:05:56Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.88-7 🚀

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

szymonrybczak requested a review from a team as a code owner December 27, 2024 11:42

melvin-bot bot requested review from ntdiary and removed request for a team December 27, 2024 11:42

szymonrybczak force-pushed the szymonrybczak/feat/android/setup-background-task branch from 756438d to 33d2010 Compare December 27, 2024 11:53

gedu mentioned this pull request Dec 27, 2024

Implement custom Background Processing task from Scratch #52700

Closed

mountiny added the Ready To Build label Dec 27, 2024

mountiny requested review from ishpaul777 and removed request for ntdiary December 27, 2024 12:22

mountiny assigned szymonrybczak Dec 27, 2024

This comment has been minimized.

Sign in to view