Skip to content

Commit 9a1b28f

Browse files
dean-journeyappsdean-journeyapps
committed
Added react-native-background-sync demo
1 parent 84a0af8 commit 9a1b28f

File tree

88 files changed

+6192
-655
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+6192
-655
lines changed

‎demos/react-native-background-sync/.env.local.template‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Replace the credentials below with your Supabase, PowerSync and Expo project details.
2+
EXPO_PUBLIC_SUPABASE_URL=https://foo.supabase.co
3+
EXPO_PUBLIC_SUPABASE_ANON_KEY=foo
4+
EXPO_PUBLIC_POWERSYNC_URL=https://foo.powersync.journeyapps.com

‎demos/react-native-background-sync/.gitignore‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Learn more https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files
2+
3+
# dependencies
4+
node_modules/
5+
6+
# Expo
7+
.expo/
8+
dist/
9+
web-build/
10+
11+
# Native
12+
*.orig.*
13+
*.jks
14+
*.p8
15+
*.p12
16+
*.key
17+
*.mobileprovision
18+
19+
# Metrom
20+
.metro-health-check*
21+
22+
# debug
23+
npm-debug.*
24+
25+
# macOS
26+
.DS_Store
27+
*.pem
28+
29+
# local env files
30+
.env*.local
31+
.env
32+
33+
# typescript
34+
*.tsbuildinfo
35+
36+
# IDE
37+
.vscode
38+
.fleet
39+
.idea
40+
41+
ios/
42+
43+
# @generated expo-cli sync-2b81b286409207a5da26e14c78851eb30d8ccbdb
44+
# The following patterns were generated by expo-cli
45+
46+
expo-env.d.ts
47+
# @end expo-cli

‎demos/react-native-background-sync/LICENSE‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎demos/react-native-background-sync/README.md‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
# PowerSync + Supabase React Native Expo Background Sync
2+
3+
## Overview
4+
5+
Demo app demonstrating background sync using PowerSync, Expo and Supabase.
6+
7+
This demo app uses expo-background-task to run a background task that syncs your PowerSync database in the background. To learn more, see the [Expo Background Task docs](https://docs.expo.dev/versions/latest/sdk/background-task).
8+
9+
## Info
10+
11+
The background sync logic is located in `library/utils.ts`.
12+
13+
## Getting Started
14+
15+
In the repo directory, use [pnpm](https://pnpm.io/installation) to install dependencies:
16+
17+
```bash
18+
pnpm install
19+
pnpm build:packages
20+
```
21+
22+
Then switch into the demo's directory:
23+
24+
```bash
25+
cd demos/react-native-background-sync
26+
```
27+
28+
Set up the Environment variables: Copy the `.env` file:
29+
30+
```bash
31+
cp .env .env.local
32+
```
33+
34+
And then edit `.env.local` to insert your credentials for `Supabase`.
35+
36+
### Run on iOS (see [configuring background modes on iOS](https://docs.expo.dev/versions/latest/sdk/task-manager/#configuration))
37+
38+
To enable background tasks in PowerSync on iOS, you need to add both processing and fetch to the UIBackgroundModes array in your app’s Info.plist (ios/powersyncreactnativebackgroundsync/Info.plist). The fetch mode is required so your app can periodically run background fetches, allowing PowerSync to upload and download data even when the app is not in the foreground:
39+
40+
```xml
41+
<key>UIBackgroundModes</key>
42+
<array>
43+
<string>processing</string>
44+
<string>fetch</string>
45+
</array>
46+
```
47+
48+
then run
49+
50+
```sh
51+
pnpm ios
52+
```
53+
54+
### Run on Android
55+
56+
```sh
57+
pnpm android
58+
```
59+
60+
## Supabase and background sync
61+
62+
The `SupabaseConnector` has been configured to override the default `fetch` function that the `@supabase/supabase-js` SDK uses. By default, the `fetch` function used does not work in the background [see here](https://github.com/facebook/react-native/issues/47437), so we need to override it with a something that works in the background, like `expo/fetch`.
63+
64+
```typescript
65+
this.client = createClient(AppConfig.supabaseUrl!, AppConfig.supabaseAnonKey!, {
66+
auth: {
67+
persistSession: true
68+
},
69+
global: {
70+
// Override the default fetch function to use expo-fetch
71+
fetch: fetch as any
72+
}
73+
});
74+
```
75+
76+
## How to force a background task to run (in development)
77+
78+
### Android
79+
80+
`com.anonymous.powersyncreactnativebackgroundsync` is the package name of the app.
81+
82+
The following command will show you the jobscheduler for your app:
83+
84+
```bash
85+
adb shell dumpsys jobscheduler | grep -A 40 -m 1 -E "JOB #.* com.anonymous.powersyncreactnativebackgroundsync"
86+
```
87+
88+
The result should look something like this:
89+
90+
```bash
91+
JOB #u0a212/0: 74a550e com.anonymous.powersyncreactnativebackgroundsync/androidx.work.impl.background.systemjob.SystemJobService
92+
```
93+
94+
The number after the `/` is the job ID. In this case, it is 0. You can use this to force the job to run by using the following command:
95+
96+
```bash
97+
adb shell cmd jobscheduler run -f com.anonymous.powersyncreactnativebackgroundsync 0
98+
```
99+
100+
### iOS
101+
102+
Background tasks are not supported on iOS simulators.
103+
104+
## ⚠️ Please note
105+
106+
The app needs to be in the background for it to run and ultimately, the OS decides when to run background tasks so forcing it to run might not always work immediately. The background task should run on it's own within 20 minutes after the app is put in the background. Testing background sync seems to work better and more consistently on a physical device. If you don't see any logs after starting your background task, you may need to watch all the logs on the device using `adb logcat` (on Android).
107+
108+
When the background task starts, you will see the following logs:
109+
110+
```javascript
111+
[Background Task] Starting background task at ...
112+
[Background Task] Initializing PowerSync
113+
```
114+
115+
After it has connected to the PowerSync instance, you will see the following log:
116+
117+
```javascript
118+
[Background Task] Download complete
119+
Finished task 'background-powersync-task' with eventId ...
120+
```
121+
122+
At this point, the background task has successfully connected to PowerSync (on a different thread) and inserted a mock list item to simulate pending transactions in the `ps_crud` table. It has not yet uploaded this transaction to the source database.
123+
124+
After a couple of minutes, you will see the following logs:
125+
126+
```javascript
127+
Could not apply checkpoint due to local data. Will retry at completed upload or next checkpoint.
128+
129+
Could not apply pending checkpoint even after completed upload
130+
131+
Validated and applied checkpoint
132+
```
133+
134+
Typically this means that the background task has successfully uploaded the transaction to the source database.
135+
136+
## The background task design
137+
138+
This function `initializeBackgroundTask` sets up automatic background syncing for your app. Here's how it works:
139+
140+
### What it does
141+
142+
- Waits for your app to fully load before setting up background tasks
143+
- Watches for when users switch between your app and other apps
144+
- Registers the background task to run when the app goes to the background
145+
- Unregisters the background task when the app comes back to the foreground
146+
147+
### Why this approach
148+
149+
- Prevents conflicts - Avoids having multiple PowerSync connections (on different threads). When a task is unregistered, the connection to PowerSync is closed.
150+
151+
### User experience
152+
153+
- When user minimizes your app or switches to another app → background sync is scheduled to start
154+
- When user returns to your app → background sync stops if it is running (since the app can sync normally while in use)
155+
- User doesn't need to do anything - it's completely automatic
156+
157+
### Technical details
158+
159+
- Uses a minimum interval setting to control how often background sync runs (this is use-case dependent)
160+
- Checks if tasks are already registered to avoid duplicates
161+
- Includes logging to help with debugging
162+
163+
This ensures your app stays up-to-date even when users aren't actively using it, while being efficient with device resources.
164+
165+
### EAS Build configuration
166+
167+
General information on defining environment variables with Expo can be [found here](https://docs.expo.dev/build-reference/variables/#can-eas-build-use-env-files).
168+
169+
## Learn More
170+
171+
Check out [the PowerSync SDK for React Native on GitHub](https://github.com/powersync-ja/powersync-js/tree/main/packages/react-native) - your feedback and contributions are welcome!
172+
173+
To learn more about PowerSync, see the [PowerSync docs](https://docs.powersync.com).

‎demos/react-native-background-sync/android/.gitignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# OSX
2+
#
3+
.DS_Store
4+
5+
# Android/IntelliJ
6+
#
7+
build/
8+
.idea
9+
.gradle
10+
local.properties
11+
*.iml
12+
*.hprof
13+
.cxx/
14+
15+
# Bundle artifacts
16+
*.jsbundle

0 commit comments

Comments
 (0)