[connectivity_platform_interface] Add ConnectivityResult.unknown. (flutter#2560)

ditman · EdwinRomelta · commit 9fcf342bf20b · 2020-06-11T10:44:35.000+07:00
Some platforms might not be able to determine the connectivity status of
the device on which the app is running (like some desktop Web browsers).

This allows users of the `connectivity` plugin to distinguish between
"no connectivity" and "connectivity couldn't be determined".

This requires a Major Version bump for users of the plugin who may be
switch/case on ConnectivityResult values, since Dart forces users to be
exhaustive in those cases (if they don't have a "default" entry, this
new value becomes a compilation error in their code).

This will also cause a Major Version bump in the core `connectivity`
plugin itself.

Note that by default, the ConnectivityResults returned by the MethodChannel implementation will now default to 'unknown' if they're not explicitly "none", so this might have some effect in your code!
diff --git a/packages/connectivity/connectivity_platform_interface/CHANGELOG.md b/packages/connectivity/connectivity_platform_interface/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 2.0.0
+
+* Added `ConnectivityResult.unknown`, for the cases where the plugin is unable to determine the
+connectivity status of the device. _(This happens mostly in the `web` platform.)_
+
 ## 1.0.3
 
 * Make the pedantic dev_dependency explicit.
diff --git a/packages/connectivity/connectivity_platform_interface/lib/src/enums.dart b/packages/connectivity/connectivity_platform_interface/lib/src/enums.dart
@@ -7,7 +7,10 @@ enum ConnectivityResult {
   mobile,
 
   /// None: Device not connected to any network
-  none
+  none,
+
+  /// Unknown: The plugin wasn't able to determine the connectivity status of the device
+  unknown,
 }
 
 /// The status of the location service authorization.
diff --git a/packages/connectivity/connectivity_platform_interface/lib/src/utils.dart b/packages/connectivity/connectivity_platform_interface/lib/src/utils.dart
@@ -8,8 +8,9 @@ ConnectivityResult parseConnectivityResult(String state) {
     case 'mobile':
       return ConnectivityResult.mobile;
     case 'none':
-    default:
       return ConnectivityResult.none;
+    default:
+      return ConnectivityResult.unknown;
   }
 }
 
diff --git a/packages/connectivity/connectivity_platform_interface/pubspec.yaml b/packages/connectivity/connectivity_platform_interface/pubspec.yaml
@@ -3,7 +3,7 @@ description: A common platform interface for the connectivity plugin.
 homepage: https://github.com/flutter/plugins/tree/master/packages/connectivity/connectivity_platform_interface
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 1.0.3
+version: 2.0.0
 
 dependencies:
   flutter:

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,9 @@ ConnectivityResult parseConnectivityResult(String state) {`
`8`	`8`	`case 'mobile':`
`9`	`9`	`return ConnectivityResult.mobile;`
`10`	`10`	`case 'none':`
`11`		`- default:`
`12`	`11`	`return ConnectivityResult.none;`
	`12`	`+ default:`
	`13`	`+ return ConnectivityResult.unknown;`
`13`	`14`	`}`
`14`	`15`	`}`
`15`	`16`