Skip to content

Commit 838a3cb

Browse files
fadi-georgefadi-george
authored
chore: [SDK-4334] add Appium-based E2E test workflow for React Native (#1942)
1 parent e80926f commit 838a3cb

56 files changed

Lines changed: 1702 additions & 1711 deletions

Some content is hidden

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

‎.github/actions/setup-demo/action.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: 'Setup Demo'
2+
description: 'Installs toolchains, builds the SDK, sets up the demo app, and creates the .env file'
3+
inputs:
4+
onesignal-app-id:
5+
description: 'OneSignal App ID for the demo .env'
6+
required: true
7+
onesignal-api-key:
8+
description: 'OneSignal API Key for the demo .env'
9+
required: true
10+
install-pods:
11+
description: 'Whether to run pod update for iOS'
12+
required: false
13+
default: 'false'
14+
runs:
15+
using: 'composite'
16+
steps:
17+
- name: Set up Vite+
18+
uses: voidzero-dev/setup-vp@v1
19+
with:
20+
cache: true
21+
run-install: true
22+
23+
- name: Set up Bun
24+
uses: oven-sh/setup-bun@v2
25+
26+
- name: Cache bun dependencies
27+
uses: actions/cache@v5
28+
with:
29+
path: examples/demo/node_modules
30+
key: bun-${{ runner.os }}-${{ hashFiles('examples/demo/bun.lock') }}
31+
restore-keys: bun-${{ runner.os }}-
32+
33+
- name: Install and set up demo
34+
shell: bash
35+
working-directory: examples/demo
36+
run: |
37+
bun run setup
38+
bun install
39+
40+
- name: Cache CocoaPods
41+
if: inputs.install-pods == 'true'
42+
uses: actions/cache@v5
43+
with:
44+
path: examples/demo/ios/Pods
45+
key: pods-${{ runner.os }}-${{ hashFiles('examples/demo/ios/Podfile.lock') }}
46+
restore-keys: pods-${{ runner.os }}-
47+
48+
- name: Update CocoaPods
49+
if: inputs.install-pods == 'true'
50+
shell: bash
51+
working-directory: examples/demo
52+
run: bun run update:pods
53+
54+
- name: Create demo .env
55+
shell: bash
56+
working-directory: examples/demo
57+
run: |
58+
echo "ONESIGNAL_APP_ID=${{ inputs.onesignal-app-id }}" > .env
59+
echo "ONESIGNAL_API_KEY=${{ inputs.onesignal-api-key }}" >> .env
60+
echo "E2E_MODE=true" >> .env

‎.github/workflows/e2e.yml‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
name: E2E Tests
2+
3+
on:
4+
push:
5+
branches:
6+
- rel/**
7+
workflow_dispatch:
8+
inputs:
9+
platform:
10+
description: 'Platform to test'
11+
required: true
12+
default: 'both'
13+
type: choice
14+
options:
15+
- android
16+
- ios
17+
- both
18+
19+
permissions:
20+
contents: read
21+
22+
concurrency:
23+
group: ${{ github.workflow }}-${{ github.ref }}
24+
cancel-in-progress: true
25+
26+
jobs:
27+
build-android:
28+
if: >-
29+
github.event_name == 'push' ||
30+
github.event.inputs.platform == 'android' ||
31+
github.event.inputs.platform == 'both'
32+
runs-on: ubuntu-latest
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v6
36+
37+
- name: Set up Java
38+
uses: actions/setup-java@v5
39+
with:
40+
distribution: temurin
41+
java-version: '17'
42+
43+
- name: Set up demo
44+
uses: ./.github/actions/setup-demo
45+
with:
46+
onesignal-app-id: ${{ vars.APPIUM_ONESIGNAL_APP_ID }}
47+
onesignal-api-key: ${{ secrets.APPIUM_ONESIGNAL_API_KEY }}
48+
49+
- name: Build release APK
50+
working-directory: examples/demo/android
51+
run: ./gradlew assembleRelease
52+
53+
- name: Upload APK
54+
uses: actions/upload-artifact@v7
55+
with:
56+
name: demo-apk
57+
path: examples/demo/android/app/build/outputs/apk/release/app-release.apk
58+
retention-days: 1
59+
compression-level: 0
60+
61+
build-ios:
62+
if: >-
63+
github.event_name == 'push' ||
64+
github.event.inputs.platform == 'ios' ||
65+
github.event.inputs.platform == 'both'
66+
runs-on: macos-latest
67+
steps:
68+
- name: Checkout
69+
uses: actions/checkout@v6
70+
71+
- name: Set up demo
72+
uses: ./.github/actions/setup-demo
73+
with:
74+
onesignal-app-id: ${{ vars.APPIUM_ONESIGNAL_APP_ID }}
75+
onesignal-api-key: ${{ secrets.APPIUM_ONESIGNAL_API_KEY }}
76+
install-pods: 'true'
77+
78+
- name: Cache Xcode DerivedData
79+
uses: actions/cache@v5
80+
with:
81+
path: examples/demo/ios/build
82+
key: deriveddata-${{ runner.os }}-${{ hashFiles('examples/demo/ios/Podfile.lock') }}
83+
restore-keys: deriveddata-${{ runner.os }}-
84+
85+
- name: Set up iOS codesigning
86+
uses: OneSignal/sdk-shared/.github/actions/setup-ios-demo-codesigning@main
87+
with:
88+
p12-base64: ${{ secrets.APPIUM_IOS_DEV_CERT_P12_BASE64 }}
89+
p12-password: ${{ secrets.APPIUM_IOS_DEV_CERT_PASSWORD }}
90+
asc-key-id: ${{ secrets.APPIUM_APP_STORE_CONNECT_KEY_ID }}
91+
asc-issuer-id: ${{ secrets.APPIUM_APP_STORE_CONNECT_ISSUER_ID }}
92+
asc-private-key: ${{ secrets.APPIUM_APP_STORE_CONNECT_PRIVATE_KEY }}
93+
94+
- name: Build signed IPA
95+
working-directory: examples/demo/ios
96+
run: |
97+
xcodebuild archive \
98+
-workspace demo.xcworkspace \
99+
-scheme demo \
100+
-configuration Release \
101+
-sdk iphoneos \
102+
-destination 'generic/platform=iOS' \
103+
-archivePath build/demo.xcarchive \
104+
-derivedDataPath build \
105+
CODE_SIGN_STYLE=Manual \
106+
COMPILER_INDEX_STORE_ENABLE=NO
107+
xcodebuild -exportArchive \
108+
-archivePath build/demo.xcarchive \
109+
-exportOptionsPlist ExportOptions.plist \
110+
-exportPath build/ipa
111+
112+
- name: Verify aps-environment in IPA
113+
working-directory: examples/demo/ios
114+
run: |
115+
IPA=$(ls build/ipa/*.ipa | head -n1)
116+
unzip -oq "$IPA" -d /tmp/ipa
117+
APP=$(ls -d /tmp/ipa/Payload/*.app | head -n1)
118+
codesign -d --entitlements - "$APP" 2>&1 | tee /tmp/entitlements.txt
119+
if ! grep -q 'aps-environment' /tmp/entitlements.txt; then
120+
echo "::error::Built IPA is missing aps-environment entitlement; push subscription will not work"
121+
exit 1
122+
fi
123+
124+
- name: Upload IPA
125+
uses: actions/upload-artifact@v7
126+
with:
127+
name: demo-ipa
128+
path: examples/demo/ios/build/ipa/demo.ipa
129+
retention-days: 1
130+
compression-level: 0
131+
132+
e2e-android:
133+
needs: build-android
134+
uses: OneSignal/sdk-shared/.github/workflows/appium-e2e.yml@main
135+
secrets: inherit
136+
with:
137+
platform: android
138+
app-artifact: demo-apk
139+
app-filename: app-release.apk
140+
sdk-type: react-native
141+
build-name: react-native-android-${{ github.ref_name }}-${{ github.run_number }}
142+
143+
e2e-ios:
144+
needs: build-ios
145+
uses: OneSignal/sdk-shared/.github/workflows/appium-e2e.yml@main
146+
secrets: inherit
147+
with:
148+
platform: ios
149+
app-artifact: demo-ipa
150+
app-filename: demo.ipa
151+
sdk-type: react-native
152+
build-name: react-native-ios-${{ github.ref_name }}-${{ github.run_number }}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ build
1515
dist
1616
android/build
1717
*.tgz
18+
.rn-sdk-source.stamp
1819

1920
# OSX
2021
#

‎android/build.gradle‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ android {
2727
dependencies {
2828
implementation "com.facebook.react:react-native:${safeExtGet('reactNativeVersion', '+')}"
2929

30+
// androidx.startup runs our OneSignalInitializer during Application.onCreate so we can register
31+
// an ActivityLifecycleCallbacks before MainActivity.onResume fires. This avoids the cold-start
32+
// race where ReactApplicationContext.getCurrentActivity() returns null and the OneSignal SDK
33+
// ends up holding an ApplicationContext instead of the real Activity.
34+
implementation 'androidx.startup:startup-runtime:1.1.1'
35+
3036
// api is used instead of implementation so the parent :app project can access any of the OneSignal Java
3137
// classes if needed. Such as com.onesignal.NotificationExtenderService
3238
//

‎android/src/main/AndroidManifest.xml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
1-
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
1+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
2+
xmlns:tools="http://schemas.android.com/tools">
3+
<application>
4+
<provider
5+
android:name="androidx.startup.InitializationProvider"
6+
android:authorities="${applicationId}.androidx-startup"
7+
android:exported="false"
8+
tools:node="merge">
9+
<meta-data
10+
android:name="com.onesignal.rnonesignalandroid.OneSignalInitializer"
11+
android:value="androidx.startup" />
12+
</provider>
13+
</application>
214
</manifest>

‎android/src/main/java/com/onesignal/rnonesignalandroid/ActivityLifecycleTracker.java‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
package com.onesignal.rnonesignalandroid;
2+
3+
import android.app.Activity;
4+
import android.app.Application;
5+
import android.os.Bundle;
6+
import androidx.annotation.Nullable;
7+
import java.lang.ref.WeakReference;
8+
9+
/**
10+
* Tracks the host app's current Activity from Application.onCreate onward.
11+
*
12+
* <p>Registered very early via {@link OneSignalInitializer} (androidx.startup) so it captures the
13+
* first {@code MainActivity.onResume} that fires before the React Native bridge has loaded the JS
14+
* bundle. Without this, {@link com.facebook.react.bridge.ReactApplicationContext#getCurrentActivity()}
15+
* frequently returns {@code null} during cold start in bridgeless mode, causing
16+
* {@code RNOneSignal.initialize} to hand the OneSignal SDK an ApplicationContext instead of the
17+
* real Activity. That in turn leaves {@code ApplicationService.current == null} and queues
18+
* {@code requestPermission()} until the next foreground.
19+
*/
20+
public class ActivityLifecycleTracker implements Application.ActivityLifecycleCallbacks {
21+
private static final ActivityLifecycleTracker INSTANCE = new ActivityLifecycleTracker();
22+
23+
private volatile WeakReference<Activity> currentActivity = new WeakReference<>(null);
24+
25+
private ActivityLifecycleTracker() {}
26+
27+
public static ActivityLifecycleTracker getInstance() {
28+
return INSTANCE;
29+
}
30+
31+
@Nullable
32+
public Activity getCurrentActivity() {
33+
return currentActivity.get();
34+
}
35+
36+
@Override
37+
public void onActivityCreated(Activity activity, @Nullable Bundle savedInstanceState) {
38+
currentActivity = new WeakReference<>(activity);
39+
}
40+
41+
@Override
42+
public void onActivityStarted(Activity activity) {
43+
currentActivity = new WeakReference<>(activity);
44+
}
45+
46+
@Override
47+
public void onActivityResumed(Activity activity) {
48+
currentActivity = new WeakReference<>(activity);
49+
}
50+
51+
@Override
52+
public void onActivityPaused(Activity activity) {
53+
// Intentionally no-op: keep the reference so a transient overlay (e.g. permission dialog,
54+
// PermissionsActivity) doesn't blank out the current Activity for callers that race with it.
55+
}
56+
57+
@Override
58+
public void onActivityStopped(Activity activity) {
59+
// Intentionally no-op for the same reason as onActivityPaused.
60+
}
61+
62+
@Override
63+
public void onActivitySaveInstanceState(Activity activity, Bundle outState) {}
64+
65+
@Override
66+
public void onActivityDestroyed(Activity activity) {
67+
Activity current = currentActivity.get();
68+
if (current == activity) {
69+
currentActivity = new WeakReference<>(null);
70+
}
71+
}
72+
}

‎android/src/main/java/com/onesignal/rnonesignalandroid/OneSignalInitializer.java‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
package com.onesignal.rnonesignalandroid;
2+
3+
import android.app.Application;
4+
import android.content.Context;
5+
import androidx.annotation.NonNull;
6+
import androidx.startup.Initializer;
7+
import java.util.Collections;
8+
import java.util.List;
9+
10+
/**
11+
* androidx.startup entry point that registers {@link ActivityLifecycleTracker} against the host
12+
* {@link Application} during {@code Application.onCreate}, before any Activity is created.
13+
*
14+
* <p>This does NOT initialize the OneSignal SDK itself: the App ID is supplied at runtime by JS
15+
* via {@code OneSignal.initialize(appId)}. The job here is purely to capture the current Activity
16+
* early so that when JS later calls initialize, {@code RNOneSignal} can hand a real Activity to
17+
* {@code OneSignal.initWithContext}.
18+
*/
19+
public class OneSignalInitializer implements Initializer<ActivityLifecycleTracker> {
20+
21+
@NonNull
22+
@Override
23+
public ActivityLifecycleTracker create(@NonNull Context context) {
24+
ActivityLifecycleTracker tracker = ActivityLifecycleTracker.getInstance();
25+
Context appContext = context.getApplicationContext();
26+
if (appContext instanceof Application) {
27+
((Application) appContext).registerActivityLifecycleCallbacks(tracker);
28+
}
29+
return tracker;
30+
}
31+
32+
@NonNull
33+
@Override
34+
public List<Class<? extends Initializer<?>>> dependencies() {
35+
return Collections.emptyList();
36+
}
37+
}

‎android/src/main/java/com/onesignal/rnonesignalandroid/RNOneSignal.java‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,11 +238,21 @@ public void initialize(String appId) {
238238
}
239239

240240
ReactApplicationContext reactContext = getReactApplicationContext();
241-
Context context = reactContext.getCurrentActivity();
241+
// Prefer the Activity captured by ActivityLifecycleTracker (registered via androidx.startup
242+
// before MainActivity.onResume), then fall back to ReactApplicationContext's accessor and
243+
// finally the ApplicationContext. Passing the real Activity lets the OneSignal SDK populate
244+
// ApplicationService.current immediately, so requestPermission() can launch the OS dialog
245+
// on the first cold-start instead of waiting for the next foreground event.
246+
Context context = ActivityLifecycleTracker.getInstance().getCurrentActivity();
247+
if (context == null) {
248+
context = reactContext.getCurrentActivity();
249+
}
242250
if (context == null) {
243251
context = reactContext.getApplicationContext();
244252
}
245253

254+
Logging.debug(
255+
"OneSignal initialize using context: " + context.getClass().getSimpleName(), null);
246256
OneSignal.initWithContext(context, appId);
247257
oneSignalInitDone = true;
248258
}

0 commit comments

Comments
 (0)