Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Copy unawaited implementation into Ably Flutter to fix build failures for Flutter 2.2.3 #198

Merged
merged 1 commit into from Nov 3, 2021
Merged

Copy unawaited implementation into Ably Flutter to fix build failures for Flutter 2.2.3 #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions lib/src/common/src/backwards_compatibility.dart
View file
Open in desktop
@@ -0,0 +1,14 @@
/// This function was added to add backwards compatibility.
///
/// `unawaited` was previously imported in code from package:pedantic.
/// However, this package was deprecated, and `unawaited` was added to Flutter
/// directly. Unfortunately, it was only added in Flutter 2.5 (Dart 2.14).
///
/// Users who use the package with Flutter versions older than 2.5 will
/// face missing method errors. Forcing users to upgrade to 2.5 may force them
/// to undergo [breaking changes](https://flutter.dev/docs/release/breaking-changes#released-in-flutter-25).
///
/// Reminder: Once we increase our minimum dart version support to 2.14 and
/// minimum Flutter version support 2.5.0, we can remove this method and replace
/// it with `unawaited`
void unawaitedWorkaroundForDartPre214(Future<void> future) {}
3 changes: 2 additions & 1 deletion lib/src/platform/src/realtime/realtime.dart
View file
Open in desktop
Expand Up @@ -3,6 +3,7 @@ import 'dart:collection';

import '../../../authentication/authentication.dart';
import '../../../common/common.dart';
import '../../../common/src/backwards_compatibility.dart';
import '../../../error/error.dart';
import '../../../generated/platform_constants.dart';
import '../../../push_notifications/push_notifications.dart';
Expand Down Expand Up @@ -78,7 +79,7 @@ class Realtime extends PlatformObject
Future<void> connect() async {
final queueItem = Completer<void>();
_connectQueue.add(queueItem);
unawaited(_connect());
unawaitedWorkaroundForDartPre214(_connect());
return queueItem.future;
}

Expand Down
3 changes: 2 additions & 1 deletion lib/src/platform/src/realtime/realtime_channel.dart
View file
Open in desktop
Expand Up @@ -4,6 +4,7 @@ import 'dart:collection';
import 'package:flutter/services.dart';
import 'package:meta/meta.dart';

import '../../../common/src/backwards_compatibility.dart';
import '../../../error/error.dart';
import '../../../generated/platform_constants.dart';
import '../../../message/message.dart';
Expand Down Expand Up @@ -75,7 +76,7 @@ class RealtimeChannel extends PlatformObject
];
final queueItem = _PublishQueueItem(Completer<void>(), messages);
_publishQueue.add(queueItem);
unawaited(_publishInternal());
unawaitedWorkaroundForDartPre214(_publishInternal());
return queueItem.completer.future;
}

Expand Down
3 changes: 2 additions & 1 deletion lib/src/platform/src/rest/rest_channel.dart
View file
Open in desktop
Expand Up @@ -4,6 +4,7 @@ import 'dart:collection';
import 'package:flutter/services.dart';

import '../../../../ably_flutter.dart';
import '../../../common/src/backwards_compatibility.dart';
import '../../../error/error.dart';
import '../../../generated/platform_constants.dart';
import '../../../message/message.dart';
Expand Down Expand Up @@ -69,7 +70,7 @@ class RestChannel extends PlatformObject implements RestChannelInterface {
];
final queueItem = PublishQueueItem(Completer<void>(), messages);
_publishQueue.add(queueItem);
unawaited(_publishInternal());
unawaitedWorkaroundForDartPre214(_publishInternal());
return queueItem.completer.future;
}

Expand Down
3 changes: 2 additions & 1 deletion test/realtime/channel_test.dart
View file
Open in desktop
@@ -1,6 +1,7 @@
import 'dart:async';

import 'package:ably_flutter/ably_flutter.dart';
import 'package:ably_flutter/src/common/src/backwards_compatibility.dart';
import 'package:ably_flutter/src/generated/platform_constants.dart';
import 'package:fake_async/fake_async.dart';
import 'package:flutter_test/flutter_test.dart';
Expand Down Expand Up @@ -86,7 +87,7 @@ void main() {
return Future.value('token');
}

unawaited(
unawaitedWorkaroundForDartPre214(
fakeAsync((async) async {
final options = ClientOptions()
..authCallback = timingOutOnceThenSucceedsAuthCallback
Expand Down
3 changes: 2 additions & 1 deletion test/rest/channel_test.dart
View file
Open in desktop
@@ -1,6 +1,7 @@
import 'dart:async';

import 'package:ably_flutter/ably_flutter.dart';
import 'package:ably_flutter/src/common/src/backwards_compatibility.dart';
import 'package:ably_flutter/src/generated/platform_constants.dart';
import 'package:fake_async/fake_async.dart';
import 'package:flutter_test/flutter_test.dart';
Expand Down Expand Up @@ -83,7 +84,7 @@ void main() {
return Future.value('token');
}

unawaited(
unawaitedWorkaroundForDartPre214(
fakeAsync((async) async {
final options = ClientOptions()
..authCallback = timingOutOnceThenSucceedsAuthCallback
Expand Down