feat: Android JS Engine / Plugin (#6)

ionic-team · Jul 18, 2023 · 1f52918 · 1f52918
1 parent 25e0279
commit 1f52918
Show file tree

Hide file tree

Showing 181 changed files with 10,313 additions and 7,542 deletions.
diff --git a/.github/workflows/reusable_build-packages.yml b/.github/workflows/reusable_build-packages.yml
@@ -23,6 +23,11 @@ jobs:
         with:
           main-branch-name: 'main'
 
+      - uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
       - name: 'Build Packages'
         shell: bash
         run: |

diff --git a/apps/example-app/android/app/capacitor.build.gradle b/apps/example-app/android/app/capacitor.build.gradle
@@ -13,7 +13,7 @@ dependencies {
     implementation project(':capacitor-haptics')
     implementation project(':capacitor-keyboard')
     implementation project(':capacitor-status-bar')
-    implementation project(':ionic-enterprise-background-runner')
+    implementation project(':capacitor-background-runner')
 
 }
 

diff --git a/apps/example-app/android/capacitor.settings.gradle b/apps/example-app/android/capacitor.settings.gradle
@@ -14,5 +14,5 @@ project(':capacitor-keyboard').projectDir = new File('../../../node_modules/.pnp
 include ':capacitor-status-bar'
 project(':capacitor-status-bar').projectDir = new File('../../../node_modules/.pnpm/@capacitor+status-bar@4.1.1_@capacitor+core@4.7.3/node_modules/@capacitor/status-bar/android')
 
-include ':ionic-enterprise-background-runner'
-project(':ionic-enterprise-background-runner').projectDir = new File('../../../packages/capacitor-plugin/android')
+include ':capacitor-background-runner'
+project(':capacitor-background-runner').projectDir = new File('../../../packages/capacitor-plugin/android')
diff --git a/apps/example-app/android/settings.gradle b/apps/example-app/android/settings.gradle
@@ -4,10 +4,3 @@ project(':capacitor-cordova-android-plugins').projectDir = new File('./capacitor
 
 apply from: 'capacitor.settings.gradle'
 
-def androidEngineProject = new File("./android-engine")
-if (!androidEngineProject.exists()) {
-    androidEngineProject = new File("../node_modules/@ionic-enterprise/background-runner/android/android-engine")
-}
-
-include ':android-engine'
-project(':android-engine').projectDir = androidEngineProject
diff --git a/apps/example-app/capacitor.config.ts b/apps/example-app/capacitor.config.ts
@@ -12,8 +12,7 @@ const config: CapacitorConfig = {
       event: "monitorLocation",
       repeat: true,
       interval: 2,
-      autoStart: true,
-      // TODO: Add Android / iOS constraints
+      autoStart: false,
     },
   },
 };

diff --git a/apps/example-app/ios/App/Podfile b/apps/example-app/ios/App/Podfile
@@ -15,7 +15,7 @@ def capacitor_pods
   pod 'CapacitorHaptics', :path => '../../../../node_modules/.pnpm/@capacitor+haptics@4.1.0_@capacitor+core@4.7.3/node_modules/@capacitor/haptics'
   pod 'CapacitorKeyboard', :path => '../../../../node_modules/.pnpm/@capacitor+keyboard@4.1.1_@capacitor+core@4.7.3/node_modules/@capacitor/keyboard'
   pod 'CapacitorStatusBar', :path => '../../../../node_modules/.pnpm/@capacitor+status-bar@4.1.1_@capacitor+core@4.7.3/node_modules/@capacitor/status-bar'
-  pod 'IonicEnterpriseBackgroundRunner', :path => '../../../../packages/capacitor-plugin'
+  pod 'CapacitorBackgroundRunner', :path => '../../../../packages/capacitor-plugin'
 end
 
 target 'App' do

diff --git a/apps/example-app/package.json b/apps/example-app/package.json
@@ -12,7 +12,7 @@
     "@capacitor/ios": "^4.7.3",
     "@capacitor/keyboard": "4.1.1",
     "@capacitor/status-bar": "4.1.1",
-    "@ionic-enterprise/background-runner": "*",
+    "@capacitor/background-runner": "*",
     "@ionic/react": "^6.0.0",
     "@ionic/react-router": "^6.0.0",
     "@testing-library/dom": "^9.2.0",

diff --git a/apps/example-app/src/background.js b/apps/example-app/src/background.js
@@ -40,10 +40,12 @@ addEventListener("testLastKnownLocation", async (details) => {
 
   console.log("current location: " + JSON.stringify(location));
 
-  CapacitorNotifications.schedule({
-    title: "Enterprise Background Runner",
-    body: `Your current location: ${location.lat}, ${location.lng}`,
-  });
+  CapacitorNotifications.schedule([
+    {
+      title: "Enterprise Background Runner",
+      body: `Your current location: ${location.lat}, ${location.lng}`,
+    },
+  ]);
 
   CapacitorKV.set("testValue", JSON.stringify(location));
 
@@ -90,7 +92,7 @@ addEventListener("testNetworkStatus", (details) => {
 
 addEventListener("scheduleNotification", (details) => {
   let scheduleDate = new Date();
-  scheduleDate.setSeconds(scheduleDate.getSeconds() + 15);
+  scheduleDate.setSeconds(scheduleDate.getSeconds() + 30);
 
   CapacitorNotifications.schedule([
     {
@@ -100,6 +102,7 @@ addEventListener("scheduleNotification", (details) => {
       scheduleAt: scheduleDate,
     },
   ]);
+
   details.completed();
 });
 
@@ -122,10 +125,14 @@ addEventListener("monitorLocation", async (details) => {
 
   CapacitorKV.set("track", JSON.stringify(track));
 
-  CapacitorNotifications.schedule({
-    title: "Enterprise Background Runner",
-    body: "Recording your current location",
-  });
+  CapacitorNotifications.schedule([
+    {
+      id: 500,
+      title: "Enterprise Background Runner",
+      body: "Recording your current location",
+      scheduleAt: new Date(),
+    },
+  ]);
 
   details.completed();
 });
@@ -139,10 +146,12 @@ addEventListener("getSavedLocations", (details) => {
 addEventListener("remoteNotification", (details) => {
   console.log("received silent push notification");
 
-  CapacitorNotifications.schedule({
-    title: "Enterprise Background Runner",
-    body: "Received silent push notification",
-  });
+  CapacitorNotifications.schedule([
+    {
+      title: "Enterprise Background Runner",
+      body: "Received silent push notification",
+    },
+  ]);
 
   console.log(`details: ${JSON.stringify(details)}`);
 
@@ -190,10 +199,12 @@ addEventListener("WatchConnectivity_didReceiveUserInfo", (details) => {
 addEventListener("WatchConnectivity_didReceiveMessage", (details) => {
   const msg = details.message.result;
 
-  CapacitorNotifications.schedule({
-    title: "Enterprise Background Runner",
-    body: msg,
-  });
+  CapacitorNotifications.schedule([
+    {
+      title: "Enterprise Background Runner",
+      body: msg,
+    },
+  ]);
 
   console.log(`watch sent data: ${JSON.stringify(details)}`);
   details.completed();

diff --git a/apps/example-app/src/components/ExploreContainer.tsx b/apps/example-app/src/components/ExploreContainer.tsx
@@ -1,4 +1,4 @@
-import { BackgroundRunner } from "@ionic-enterprise/background-runner";
+import { BackgroundRunner } from "@capacitor/background-runner";
 import "./ExploreContainer.css";
 import { IonButton } from "@ionic/react";
 
@@ -114,45 +114,6 @@ const ExploreContainer: React.FC<ContainerProps> = ({ name }) => {
     }
   }
 
-  const onTestCurrentLocation = async () => {
-    try {
-      await BackgroundRunner.dispatchEvent({
-        label: "com.example.background.task",
-        event: "testCurrentLocation",
-        details: {},
-      });
-    } catch (err) {
-      alert(err);
-      console.error(err);
-    }
-  }
-
-  const onTestStartLiveLocation = async () => {
-    try {
-      await BackgroundRunner.dispatchEvent({
-        label: "com.example.background.task",
-        event: "testStartLocationWatch",
-        details: {},
-      });
-    } catch (err) {
-      alert(err);
-      console.error(err);
-    }
-  }
-
-  const onTestStopLiveLocation = async () => {
-    try {
-      await BackgroundRunner.dispatchEvent({
-        label: "com.example.background.task",
-        event: "testEndLocationWatch",
-        details: {},
-      });
-    } catch (err) {
-      alert(err);
-      console.error(err);
-    }
-  }
-
   const onMonitorLocation = async () => {
     try {
       await BackgroundRunner.dispatchEvent({
@@ -281,10 +242,7 @@ const ExploreContainer: React.FC<ContainerProps> = ({ name }) => {
       <IonButton onClick={onTestKV}>Test KV</IonButton>
       <IonButton onClick={onTestGetKV}>Test Get KV</IonButton>
       <IonButton onClick={onTestNotification}>Test Notification</IonButton>
-      <IonButton onClick={onTestLocation}>Get Last Known Location</IonButton>
-      <IonButton onClick={onTestCurrentLocation}>Get Current Location</IonButton>
-      <IonButton onClick={onTestStartLiveLocation}>Start Live Location</IonButton>
-      <IonButton onClick={onTestStopLiveLocation}>Stop Live Location</IonButton>
+      <IonButton onClick={onTestLocation}>GetLast Known Location</IonButton>
       <IonButton onClick={onMonitorLocation}>Record Location</IonButton>
       <IonButton onClick={onGetTrackedLocations}>Get Location Report</IonButton>
       <IonButton onClick={onCheckWatchReachable}>Check Watch Status</IonButton>

diff --git a/packages/android-engine/.editorconfig b/packages/android-engine/.editorconfig
@@ -0,0 +1,4 @@
+[*.{kt,kts}]
+ktlint_standard_no-wildcard-imports = disabled
+ktlint_standard_package-name = disabled
+
diff --git a/packages/android-engine/.gitignore b/packages/android-engine/.gitignore
@@ -1,15 +1,12 @@
 *.iml
 .gradle
-local.properties
-.idea/caches
-.idea/libraries
-.idea/modules.xml
-.idea/workspace.xml
-.idea/navEditor.xml
-.idea/kotlinc.xml
-.idea/assetWizardSettings.xml
-.idea/androidTestResultsUserPreferences.xml
-
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
 .DS_Store
 /build
 /captures

diff --git a/packages/android-engine/.idea/.name b/packages/android-engine/.idea/.name