Merge branch 'main' of https://github.com/fluttercommunity/flutter_workmanager

# Conflicts:
#	README.md
#	ios/Classes/SwiftWorkmanagerPlugin.swift

Author: aaronvargas

.github/workflows/format.yml

@@ -48,5 +48,5 @@ jobs:
         run: |
           flutter pub get
           flutter pub publish -n
-          pub global activate tuneup
-          pub global run tuneup check
+          flutter pub global activate tuneup
+          flutter pub global run tuneup check

.github/workflows/test.yml

@@ -37,6 +37,9 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v2
+      - uses: actions/setup-java@v1
+        with:
+          java-version: 11
       - uses: subosito/flutter-action@v1
         with:
           channel: 'stable'
@@ -76,6 +79,9 @@ jobs:
         target: [default]
     steps:
       - uses: actions/checkout@v2
+      - uses: actions/setup-java@v1
+        with:
+          java-version: 11
       - uses: subosito/flutter-action@v1
         with:
           channel: 'stable'

CHANGELOG.md

@@ -1,6 +1,13 @@
 # next
 
+* Documentation and example update to fix (#374) WorkManager not working when App is obfuscated or using Flutter 3.1+
+
+# 0.5.0
+
 * Android: Remove jetifier from example
+* Restore compatibility with Flutter 3.0.0, thank you @Cwiesen and @sunalwaysknows
+* Replaces `pedantic` checks with `flutter_lints`
+* Ability to specify custom tasks (and custom background work) for iOS was added. Thank you @tuyen-vuduc
 
 # 0.5.0-dev.8
 

IOS_SETUP.md

@@ -22,14 +22,20 @@ This will add the **UIBackgroundModes** key to your project's `Info.plist`:
 </array>
 ```
 
-Additionally, you must configure the background task identifiers. The default identifier is `workmanager.background.task` in the host Apps Info.plist:
+You **MUST** amend your `AppDelegate.swift` and `Info.plist` file to register your task ID.
 
+- AppDelegate.swift
+``` swift
+WorkmanagerPlugin.registerTask(withIdentifier: "task-identifier")
+```
+
+- Info.plist
 ``` xml
 <key>BGTaskSchedulerPermittedIdentifiers</key>
-<array>
-	<string>workmanager.background.task</string>
-</array>
-</plist>
+	<array>
+		<string>task-identifier</string>
+  </array>
+</key>
 ```
 
 And will set the correct *SystemCapabilities* for your target in the `project.pbxproj` file:

README.md

@@ -23,6 +23,7 @@ See sample folder for a complete working example.
 Before registering any task, the WorkManager plugin must be initialized.
 
 ```dart
+@pragma('vm:entry-point') // Mandatory if the App is obfuscated or using Flutter 3.1+
 void callbackDispatcher() {
   Workmanager().executeTask((task, inputData) {
     print("Native called background task: $backgroundTask"); //simpleTask will be emitted here.
@@ -71,7 +72,10 @@ void callbackDispatcher() {
 }
 ```
 
-Android tasks are identified using their `taskName`, whereas two default constants are provided for iOS background operations, depending on whether background fetch or BGTaskScheduler is used: `Workmanager.iOSBackgroundTask` & `Workmanager.iOSBackgroundProcessingTask`.
+Android tasks are identified using their `taskName`.
+iOS tasks are identitied using their `taskIdentifier`.
+
+However, there is an exception for iOS background fetch: `Workmanager.iOSBackgroundTask`, a constant for iOS background fetch task.
 
 ---
 
@@ -87,14 +91,14 @@ On Android, the `BackoffPolicy` will configure how `WorkManager` is going to ret
 
 Refer to the example app for a successful, retrying and a failed task.
 
-# Customisation (iOS - BGTaskScheduler only)
+# iOS specific setup and note
 
 iOS supports **One off tasks** with a few basic constraints 
 (Note on iOS this is for long-running Processing tasks run every 1-2 days):
 
 ```dart
 Workmanager().registerOneOffTask(
-  "1", // Ignored on iOS
+  "task-identifier",
   simpleTaskKey, // Ignored on iOS
   initialDelay: Duration(minutes: 30),
   constraints: Constraints(
@@ -130,14 +134,14 @@ Two kinds of background tasks can be registered :
 ```dart
 // One off task registration
 Workmanager().registerOneOffTask(
-    "1",
+    "oneoff-task-identifier", 
     "simpleTask"
 );
 
 // Periodic task registration
 Workmanager().registerPeriodicTask(
-    "2",
-    "simplePeriodicTask",
+    "periodic-task-identifier", 
+    "simplePeriodicTask", 
     // When no frequency is provided the default 15 minutes is set.
     // Minimum frequency is 15 min. Android will automatically change your frequency to 15 min if you have configured a lower frequency.
     frequency: Duration(hours: 1),

analysis_options.yml

@@ -1,4 +1,4 @@
-include: package:pedantic/analysis_options.yaml
+include: package:flutter_lints/flutter.yaml
 
 linter:
   rules:

android/build.gradle

@@ -2,14 +2,14 @@ group 'be.tramckrijte.workmanager'
 version '1.0-SNAPSHOT'
 
 buildscript {
-    ext.kotlin_version = '1.5.31'
+    ext.kotlin_version = '1.6.21'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.2.2'
+        classpath 'com.android.tools.build:gradle:7.1.3'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }

android/src/main/kotlin/be/tramckrijte/workmanager/BackgroundWorker.kt

@@ -151,7 +151,7 @@ class BackgroundWorker(
                         }
 
                         override fun error(
-                            errorCode: String?,
+                            errorCode: String,
                             errorMessage: String?,
                             errorDetails: Any?
                         ) {

example/android/build.gradle

@@ -1,12 +1,12 @@
 buildscript {
-    ext.kotlin_version = '1.5.31'
+    ext.kotlin_version = '1.6.21'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.2.2'
+        classpath 'com.android.tools.build:gradle:7.1.3'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }

example/android/gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-all.zip