[ToB] [Frontend] Authentication, unit progress, complete unit, SDK selection

build.gradle.kts

@@ -173,6 +173,7 @@ tasks.rat {
     "learning/tour-of-beam/frontend/**/*.gen.dart",
     "learning/tour-of-beam/frontend/.metadata",
     "learning/tour-of-beam/frontend/pubspec.lock",
+    "learning/tour-of-beam/frontend/lib/firebase_options.dart",
 
     // Ignore .gitkeep file
     "**/.gitkeep",

learning/tour-of-beam/frontend/README.md

@@ -17,47 +17,67 @@
      under the License.
  -->
 
- # Tour of Beam
- These are the main sources of the Tour of Beam website.
+# Tour of Beam
 
- # About
+These are the main sources of the Tour of Beam website.
+
+# About
 
 ## Getting started
-Running, debugging, and testing all require this first step that fetches
-dependencies and generates code:
+
+This project relies on generated code for some functionality:
+deserializers, test mocks, constants for asset files,
+extracted Beam symbols for the editor, etc.
+
+All generated files are version-controlled, so after checkout the project is immediately runnable.
+However, after changes you may need to re-run code generation:
 
 ```bash
-cd ../../../playground/frontend/playground_components
-flutter pub get
-flutter pub run build_runner build
-cd ../../../learning/tour-of-beam/frontend
-flutter pub get
-flutter pub run build_runner build
+cd beam
+./gradlew :playground:frontend:playground_components:generateCode
+cd learning/tour-of-beam/frontend
+flutter pub run build_runner build --delete-conflicting-outputs
 ```
 
 ### Run
 
 The following command is used to build and serve the frontend app locally:
 
-`$ flutter run -d chrome`
+```bash
+flutter run -d chrome
+```
+
+### Backend Selection
+
+To change the Google Project that is used as the backend:
+
+1. Update Firebase configuration:
+   https://firebase.google.com/docs/flutter/setup?platform=web
+
+2. In `/lib/config.dart`, update:
+   1. Google Project ID and region.
+   2. Playground's backend URLs.
+
+# Deployment
+
+# Tests
 
+Install ChromeDriver to run integration tests in a browser: https://docs.flutter.dev/testing/integration-tests#running-in-a-browser
+Run integration tests:
+flutter drive \
+ --driver=test_driver/integration_test.dart \
+ --target=integration_test/counter_test.dart \
+ -d web-server
 
- # Deployment
+# Packages
 
- # Tests
- Install ChromeDriver to run integration tests in a browser: https://docs.flutter.dev/testing/integration-tests#running-in-a-browser
- Run integration tests:
- flutter drive \
-   --driver=test_driver/integration_test.dart \
-   --target=integration_test/counter_test.dart \
-   -d web-server
+`flutter pub get`
 
- # Packages
- `flutter pub get`
+# Contribution guide
 
- # Contribution guide
- For checks: `./gradlew rat`
+For checks: `./gradlew rat`
+Exclusions for file checks can be added in the Tour of Beam section of this file: `beam/build.gradle.kts`
 
- # Additional resources
+# Additional resources
 
- # Troubleshooting
+# Troubleshooting

learning/tour-of-beam/frontend/lib/auth/notifier.dart

@@ -0,0 +1,45 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import 'dart:async';
+
+import 'package:firebase_auth/firebase_auth.dart';
+import 'package:firebase_auth_platform_interface/firebase_auth_platform_interface.dart';
+import 'package:flutter/material.dart';
+
+class AuthNotifier extends ChangeNotifier {
+  AuthNotifier() {
+    FirebaseAuth.instance.authStateChanges().listen((user) {
+      notifyListeners();
+    });
+  }
+
+  bool get isAuthenticated => FirebaseAuth.instance.currentUser != null;
+
+  Future<String?> getToken() async {
+    return await FirebaseAuth.instance.currentUser?.getIdToken();
+  }
+
+  Future<void> logIn(AuthProvider authProvider) async {
+    await FirebaseAuth.instance.signInWithPopup(authProvider);
+  }
+
+  Future<void> logOut() async {
+    await FirebaseAuth.instance.signOut();
+  }
+}

learning/tour-of-beam/frontend/test/overflow_test.dart → learning/tour-of-beam/frontend/lib/cache/cache.dart

@@ -17,22 +17,12 @@
  */
 
 import 'package:flutter/material.dart';
-import 'package:flutter_test/flutter_test.dart';
-import 'package:tour_of_beam/locator.dart';
-import 'package:tour_of_beam/pages/tour/screen.dart';
-import 'package:tour_of_beam/pages/tour/state.dart';
-import 'common/test_screen_wrapper.dart';
 
-void main() async {
-  await initializeServiceLocator();
+import '../repositories/client/client.dart';
 
-  testWidgets('WelcomeScreen overflow', (tester) async {
-    tester.binding.window.physicalSizeTestValue = const Size(500, 296);
-    // TODO(nausharipov): fix the failure
-    await tester.pumpWidget(
-      TestScreenWrapper(
-        child: TourScreen(TourNotifier(initialSdkId: '')),
-      ),
-    );
-  });
+/// A base class for caching entities from network requests.
+abstract class Cache extends ChangeNotifier {
+  final TobClient client;
+
+  Cache({required this.client});
 }

learning/tour-of-beam/frontend/lib/cache/content_tree.dart

@@ -18,24 +18,19 @@
 
 import 'dart:async';
 
-import 'package:flutter/widgets.dart';
-
 import '../models/content_tree.dart';
-import '../repositories/client/client.dart';
+import 'cache.dart';
 
-class ContentTreeCache extends ChangeNotifier {
-  final TobClient client;
+class ContentTreeCache extends Cache {
+  ContentTreeCache({
+    required super.client,
+  });
 
   final _treesBySdkId = <String, ContentTreeModel>{};
   final _futuresBySdkId = <String, Future<ContentTreeModel>>{};
 
-  ContentTreeCache({
-    required this.client,
-  });
-
   ContentTreeModel? getContentTree(String sdkId) {
-    final future = _futuresBySdkId[sdkId];
-    if (future == null) {
+    if (_futuresBySdkId.containsKey(sdkId)) {
       unawaited(_loadContentTree(sdkId));
     }
 

learning/tour-of-beam/frontend/lib/cache/sdk.dart

@@ -18,22 +18,19 @@
 
 import 'dart:async';
 
-import 'package:flutter/widgets.dart';
 import 'package:playground_components/playground_components.dart';
 
-import '../repositories/client/client.dart';
 import '../repositories/models/get_sdks_response.dart';
+import 'cache.dart';
 
-class SdkCache extends ChangeNotifier {
-  final TobClient client;
+class SdkCache extends Cache {
+  SdkCache({
+    required super.client,
+  });
 
   final _sdks = <Sdk>[];
   Future<GetSdksResponse>? _future;
 
-  SdkCache({
-    required this.client,
-  });
-
   List<Sdk> getSdks() {
     if (_future == null) {
       unawaited(_loadSdks());

learning/tour-of-beam/frontend/lib/cache/unit_content.dart

@@ -18,21 +18,17 @@
 
 import 'dart:async';
 
-import 'package:flutter/widgets.dart';
-
 import '../models/unit_content.dart';
-import '../repositories/client/client.dart';
+import 'cache.dart';
 
-class UnitContentCache extends ChangeNotifier {
-  final TobClient client;
+class UnitContentCache extends Cache {
+  UnitContentCache({
+    required super.client,
+  });
 
   final _unitContents = <String, Map<String, UnitContentModel>>{};
   final _futures = <String, Map<String, Future<UnitContentModel>>>{};
 
-  UnitContentCache({
-    required this.client,
-  });
-
   UnitContentModel? getUnitContent(String sdkId, String unitId) {
     final future = _futures[sdkId]?[unitId];
     if (future == null) {

learning/tour-of-beam/frontend/lib/cache/unit_progress.dart

@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import 'dart:async';
+
+import 'package:get_it/get_it.dart';
+
+import '../auth/notifier.dart';
+import '../enums/unit_completion.dart';
+import '../repositories/models/get_user_progress_response.dart';
+import '../state.dart';
+import 'cache.dart';
+
+class UnitProgressCache extends Cache {
+  UnitProgressCache({required super.client});
+
+  final _completedUnitIds = <String>{};
+  final _updatingUnitIds = <String>{};
+  Future<GetUserProgressResponse?>? _future;
+
+  Set<String> getUpdatingUnitIds() => _updatingUnitIds;
+
+  void addUpdatingUnitId(String unitId) {
+    _updatingUnitIds.add(unitId);
+    notifyListeners();
+  }
+
+  void clearUpdatingUnitId(String unitId) {
+    _updatingUnitIds.remove(unitId);
+    notifyListeners();
+  }
+
+  bool canCompleteUnit(String? unitId) {
+    if (unitId == null) {
+      return false;
+    }
+    return _getUnitCompletion(unitId) == UnitCompletion.uncompleted;
+  }
+
+  UnitCompletion _getUnitCompletion(String unitId) {
+    final authNotifier = GetIt.instance.get<AuthNotifier>();
+    if (!authNotifier.isAuthenticated) {
+      return UnitCompletion.unauthenticated;
+    }
+    if (_updatingUnitIds.contains(unitId)) {
+      return UnitCompletion.updating;
+    }
+    if (isUnitCompleted(unitId)) {
+      return UnitCompletion.completed;
+    }
+    return UnitCompletion.uncompleted;
+  }
+
+  bool isUnitCompleted(String? unitId) {
+    return getCompletedUnits().contains(unitId);
+  }
+
+  Future<void> updateCompletedUnits() async {
+    final sdkId = GetIt.instance.get<AppNotifier>().sdkId;
+    if (sdkId != null) {
+      await _loadCompletedUnits(sdkId);
+    }
+  }
+
+  Set<String> getCompletedUnits() {
+    if (_future == null) {
+      unawaited(updateCompletedUnits());
+    }
+
+    return _completedUnitIds;
+  }
+
+  Future<void> _loadCompletedUnits(String sdkId) async {
+    _future = client.getUserProgress(sdkId);
+    final result = await _future;
+
+    _completedUnitIds.clear();
+    if (result != null) {
+      for (final unitProgress in result.units) {
+        if (unitProgress.isCompleted) {
+          _completedUnitIds.add(unitProgress.id);
+        }
+      }
+    }
+
+    notifyListeners();
+  }
+}

learning/tour-of-beam/frontend/lib/components/builders/content_tree.dart

@@ -33,13 +33,13 @@ class ContentTreeBuilder extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    final cache = GetIt.instance.get<ContentTreeCache>();
+    final contentTreeCache = GetIt.instance.get<ContentTreeCache>();
 
     return AnimatedBuilder(
-      animation: cache,
+      animation: contentTreeCache,
       builder: (context, child) => builder(
         context,
-        cache.getContentTree(sdkId),
+        contentTreeCache.getContentTree(sdkId),
         child,
       ),
     );

learning/tour-of-beam/frontend/lib/components/builders/sdks.dart

@@ -31,11 +31,11 @@ class SdksBuilder extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    final cache = GetIt.instance.get<SdkCache>();
+    final sdkCache = GetIt.instance.get<SdkCache>();
 
     return AnimatedBuilder(
-      animation: cache,
-      builder: (context, child) => builder(context, cache.getSdks(), child),
+      animation: sdkCache,
+      builder: (context, child) => builder(context, sdkCache.getSdks(), child),
     );
   }
 }