[shared_preferences] Fix a late initialized error with the example app

packages/shared_preferences/shared_preferences/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.5.3
+* Fixes a bug in the example app.
+
 ## 2.5.2
 
 * Fixes `setState` returning `Future` on `example/main.dart` error in example code.

packages/shared_preferences/shared_preferences/example/lib/main.dart

@@ -44,6 +44,10 @@ class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
   late Future<int> _counter;
   int _externalCounter = 0;
 
+  /// Completes when the preferences have been initialized, which happens after
+  /// legacy preferences have been migrated.
+  final Completer<void> _preferencesReady = Completer<void>();
+
   Future<void> _incrementCounter() async {
     final SharedPreferencesWithCache prefs = await _prefs;
     final int counter = (prefs.getInt('counter') ?? 0) + 1;
@@ -86,6 +90,7 @@ class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
         return prefs.getInt('counter') ?? 0;
       });
       _getExternalCounter();
+      _preferencesReady.complete();
     });
   }
 
@@ -96,25 +101,30 @@ class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
         title: const Text('SharedPreferencesWithCache Demo'),
       ),
       body: Center(
-          child: FutureBuilder<int>(
-              future: _counter,
-              builder: (BuildContext context, AsyncSnapshot<int> snapshot) {
-                switch (snapshot.connectionState) {
-                  case ConnectionState.none:
-                  case ConnectionState.waiting:
-                    return const CircularProgressIndicator();
-                  case ConnectionState.active:
-                  case ConnectionState.done:
-                    if (snapshot.hasError) {
-                      return Text('Error: ${snapshot.error}');
-                    } else {
-                      return Text(
-                        'Button tapped ${snapshot.data ?? 0 + _externalCounter} time${(snapshot.data ?? 0 + _externalCounter) == 1 ? '' : 's'}.\n\n'
-                        'This should persist across restarts.',
-                      );
-                    }
-                }
-              })),
+        child: _WaitForInitialization(
+          initialized: _preferencesReady.future,
+          builder: (BuildContext context) => FutureBuilder<int>(
+            future: _counter,
+            builder: (BuildContext context, AsyncSnapshot<int> snapshot) {
+              switch (snapshot.connectionState) {
+                case ConnectionState.none:
+                case ConnectionState.waiting:
+                  return const CircularProgressIndicator();
+                case ConnectionState.active:
+                case ConnectionState.done:
+                  if (snapshot.hasError) {
+                    return Text('Error: ${snapshot.error}');
+                  } else {
+                    return Text(
+                      'Button tapped ${snapshot.data ?? 0 + _externalCounter} time${(snapshot.data ?? 0 + _externalCounter) == 1 ? '' : 's'}.\n\n'
+                      'This should persist across restarts.',
+                    );
+                  }
+              }
+            },
+          ),
+        ),
+      ),
       floatingActionButton: FloatingActionButton(
         onPressed: _incrementCounter,
         tooltip: 'Increment',
@@ -123,3 +133,28 @@ class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
     );
   }
 }
+
+/// Waits for the [initialized] future to complete before rendering [builder].
+class _WaitForInitialization extends StatelessWidget {
+  const _WaitForInitialization({
+    required this.initialized,
+    required this.builder,
+  });
+
+  final Future<void> initialized;
+  final WidgetBuilder builder;
+
+  @override
+  Widget build(BuildContext context) {
+    return FutureBuilder<void>(
+      future: initialized,
+      builder: (BuildContext context, AsyncSnapshot<void> snapshot) {
+        if (snapshot.connectionState == ConnectionState.waiting ||
+            snapshot.connectionState == ConnectionState.none) {
+          return const CircularProgressIndicator();
+        }
+        return builder(context);
+      },
+    );
+  }
+}

packages/shared_preferences/shared_preferences/example/test/example_app_test.dart

@@ -0,0 +1,123 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/services.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:shared_preferences_example/main.dart';
+import 'package:shared_preferences_platform_interface/in_memory_shared_preferences_async.dart';
+import 'package:shared_preferences_platform_interface/shared_preferences_async_platform_interface.dart';
+import 'package:shared_preferences_platform_interface/types.dart';
+
+void main() {
+  group('SharedPreferences example app', () {
+    setUp(() {
+      SharedPreferencesAsyncPlatform.instance = FakeSharedPreferencesAsync();
+    });
+
+    tearDown(() {
+      SharedPreferencesAsyncPlatform.instance = null;
+    });
+
+    testWidgets('builds successfully', (WidgetTester tester) async {
+      await tester.pumpWidget(const MyApp());
+    });
+  });
+}
+
+// Note: this code is duplicated in
+// shared_preferences/test/shared_preferences_async_test.dart. Since we cannot
+// import the relative path ../../test/shared_preferences_async_test.dart on the
+// web platform, we had to copy it here for use in this test library.
+base class FakeSharedPreferencesAsync extends SharedPreferencesAsyncPlatform {
+  final InMemorySharedPreferencesAsync backend =
+      InMemorySharedPreferencesAsync.empty();
+  final List<MethodCall> log = <MethodCall>[];
+
+  @override
+  Future<bool> clear(
+      ClearPreferencesParameters parameters, SharedPreferencesOptions options) {
+    log.add(MethodCall('clear', <Object>[...?parameters.filter.allowList]));
+    return backend.clear(parameters, options);
+  }
+
+  @override
+  Future<bool?> getBool(String key, SharedPreferencesOptions options) {
+    log.add(MethodCall('getBool', <String>[key]));
+    return backend.getBool(key, options);
+  }
+
+  @override
+  Future<double?> getDouble(String key, SharedPreferencesOptions options) {
+    log.add(MethodCall('getDouble', <String>[key]));
+    return backend.getDouble(key, options);
+  }
+
+  @override
+  Future<int?> getInt(String key, SharedPreferencesOptions options) {
+    log.add(MethodCall('getInt', <String>[key]));
+    return backend.getInt(key, options);
+  }
+
+  @override
+  Future<Set<String>> getKeys(
+      GetPreferencesParameters parameters, SharedPreferencesOptions options) {
+    log.add(MethodCall('getKeys', <String>[...?parameters.filter.allowList]));
+    return backend.getKeys(parameters, options);
+  }
+
+  @override
+  Future<Map<String, Object>> getPreferences(
+      GetPreferencesParameters parameters, SharedPreferencesOptions options) {
+    log.add(MethodCall(
+        'getPreferences', <Object>[...?parameters.filter.allowList]));
+    return backend.getPreferences(parameters, options);
+  }
+
+  @override
+  Future<String?> getString(String key, SharedPreferencesOptions options) {
+    log.add(MethodCall('getString', <String>[key]));
+    return backend.getString(key, options);
+  }
+
+  @override
+  Future<List<String>?> getStringList(
+      String key, SharedPreferencesOptions options) {
+    log.add(MethodCall('getStringList', <String>[key]));
+    return backend.getStringList(key, options);
+  }
+
+  @override
+  Future<bool> setBool(
+      String key, bool value, SharedPreferencesOptions options) {
+    log.add(MethodCall('setBool', <Object>[key, value]));
+    return backend.setBool(key, value, options);
+  }
+
+  @override
+  Future<bool> setDouble(
+      String key, double value, SharedPreferencesOptions options) {
+    log.add(MethodCall('setDouble', <Object>[key, value]));
+    return backend.setDouble(key, value, options);
+  }
+
+  @override
+  Future<bool> setInt(String key, int value, SharedPreferencesOptions options) {
+    log.add(MethodCall('setInt', <Object>[key, value]));
+    return backend.setInt(key, value, options);
+  }
+
+  @override
+  Future<bool> setString(
+      String key, String value, SharedPreferencesOptions options) {
+    log.add(MethodCall('setString', <Object>[key, value]));
+    return backend.setString(key, value, options);
+  }
+
+  @override
+  Future<bool> setStringList(
+      String key, List<String> value, SharedPreferencesOptions options) {
+    log.add(MethodCall('setStringList', <Object>[key, value]));
+    return backend.setStringList(key, value, options);
+  }
+}

packages/shared_preferences/shared_preferences/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for reading and writing simple key-value pairs.
   Wraps NSUserDefaults on iOS and SharedPreferences on Android.
 repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22
-version: 2.5.2
+version: 2.5.3
 
 environment:
   sdk: ^3.5.0