Ios bg tasks enhancements final

.github/workflows/analysis.yml

@@ -5,7 +5,7 @@ jobs:
   package-analysis:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: axel-op/dart-package-analyzer@v3
         with:
           # Required:

.github/workflows/examples.yml

@@ -10,10 +10,10 @@ jobs:
   example_android:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 17
       - uses: subosito/flutter-action@v2
         with:
           channel: "stable"
@@ -25,7 +25,7 @@ jobs:
   example_ios:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: subosito/flutter-action@v2
         with:
           channel: "stable"

.github/workflows/format.yml

@@ -10,7 +10,7 @@ jobs:
   format_dart:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable'
@@ -23,22 +23,22 @@ jobs:
 
     steps:
       - name: "checkout"
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: "ktlint"
         uses: "vroy/gha-kotlin-linter@v1"
 
   format_swift:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: GitHub Action for SwiftLint
         uses: norio-nomura/[email protected]
 
   publishable:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable'

.github/workflows/pr.yml

@@ -0,0 +1,42 @@
+name: "Pull-Request Check"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/[email protected]
+        id: lint_pr_title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # When the previous steps fails, the workflow would stop. By adding this
+        # condition you can continue the execution with the populated error message.
+        if: always() && (steps.lint_pr_title.outputs.error_message != null)
+        with:
+          header: pr-title-lint-error
+          message: |
+            Hey there and thank you for opening this pull request! 👋🏼
+
+            We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
+
+            Details:
+
+            ```
+            ${{ steps.lint_pr_title.outputs.error_message }}
+            ```
+
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: pr-title-lint-error
+          delete: true

.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable'
@@ -22,7 +22,7 @@ jobs:
   native_ios_tests:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable'
@@ -34,10 +34,10 @@ jobs:
   native_android_tests:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 17
       - uses: subosito/flutter-action@v1
         with:
           channel: 'stable'
@@ -57,7 +57,7 @@ jobs:
       - uses: futureware-tech/simulator-action@v1
         with:
           model: '${{ matrix.device }}'
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable'
@@ -76,10 +76,10 @@ jobs:
         # api-level: [21, 29]
         target: [default]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 17
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable'

CHANGELOG.md

@@ -1,5 +1,7 @@
-# next
+# 0.5.2
 
+* Android: Bump to workmanager 2.8.1
+* Android: Move to Android Gradle Plugin 8.x
 * Android: Migrate away from ResolvableFuture (#399).
 
 # 0.5.1

IOS_SETUP.md

@@ -10,6 +10,8 @@ This plugin is compatible with **Swift 4.2** and up. Make sure you are using **X
 > ⚠️ BGTaskScheduler is similar to Background Fetch described below and brings a similar set of constraints. Most notably, there are no guarantees when the background task will be run. Excerpt from the documentation:
 > 
 > Schedule a processing task request to ask that the system launch your app when conditions are favorable for battery life to handle deferrable, longer-running processing, such as syncing, database maintenance, or similar tasks. The system will attempt to fulfill this request to the best of its ability within the next two days as long as the user has used your app within the past week.
+> 
+> Workmanager BGTaskScheduler methods `registerOneOffTask`, `registerPeriodicTask`, and `registerProcessingTask` are only available on iOS 13+
 
 ![Screenshot of Background Fetch Capabilities tab in Xcode ](.art/ios_background_mode_background_processing.png)
 
@@ -19,6 +21,9 @@ This will add the **UIBackgroundModes** key to your project's `Info.plist`:
 <key>UIBackgroundModes</key>
 <array>
 	<string>processing</string>
+
+	<!-- If you need periodic tasks in iOS 13+ you need to enable Background Fetch as well -->
+	<string>fetch</string>
 </array>
 ```
 
@@ -31,16 +36,25 @@ import workmanager
 
 ``` swift
 // In AppDelegate.application method
-WorkmanagerPlugin.registerTask(withIdentifier: "task-identifier")
+WorkmanagerPlugin.registerBGProcessingTask(withIdentifier: "task-identifier")
+
+// Register a periodic task in iOS 13+
+WorkmanagerPlugin.registerPeriodicTask(withIdentifier: "be.tramckrijte.workmanagerExample.iOSBackgroundAppRefresh", frequency: NSNumber(value: 20 * 60))
 ```
 
 - Info.plist
 ``` xml
 <key>BGTaskSchedulerPermittedIdentifiers</key>
-	<array>
-		<string>task-identifier</string>
-  </array>
+<array>
+	<string>task-identifier</string>
+
+	<!-- Register a periodic task in iOS 13+ -->
+	<string>be.tramckrijte.workmanagerExample.iOSBackgroundAppRefresh</string>
+</array>
 ```
+> ⚠️ On iOS 13+, adding a `BGTaskSchedulerPermittedIdentifiers` key to the Info.plist for new `BGTaskScheduler` API disables the `performFetchWithCompletionHandler` and `setMinimumBackgroundFetchInterval`
+methods, which means you cannot use both old Background Fetch and new `registerPeriodicTask` at the same time, you have to choose one based on your minimum iOS target version. 
+For details see [Apple Docs](https://developer.apple.com/documentation/uikit/app_and_environment/scenes/preparing_your_ui_to_run_in_the_background/using_background_tasks_to_update_your_app)
 
 And will set the correct *SystemCapabilities* for your target in the `project.pbxproj` file:
 
@@ -64,7 +78,11 @@ e -l objc -- (void)[[BGTaskScheduler sharedScheduler] _simulateLaunchForTaskWith
 
 ## Enabling Background Fetch
 
-> ⚠️ Background fetch is one supported way to do background work on iOS with work manager: **Periodic tasks** are available on Android only for now! (see #109)
+> ⚠️ Background fetch is one supported way to do background work on iOS with work manager. Note that this API is deprecated starting iOS 13, however it still works on iOS 13+ as of writing this article
+
+> ⚠️ On iOS 13+, adding a `BGTaskSchedulerPermittedIdentifiers` key to the Info.plist for new `BGTaskScheduler` API disables the `performFetchWithCompletionHandler` and `setMinimumBackgroundFetchInterval`
+methods, which means you cannot use both old Background Fetch and new `registerPeriodicTask` at the same time, you have to choose one based on your minimum iOS target version. 
+For details see [Apple Docs](https://developer.apple.com/documentation/uikit/app_and_environment/scenes/preparing_your_ui_to_run_in_the_background/using_background_tasks_to_update_your_app)
 
 Background fetching is very different compared to Android's Background Jobs.  
 In order for your app to support Background Fetch, you have to add the *Background Modes* capability in Xcode for your app's Target and check *Background fetch*: