[ToB][Frontend] Save user code

learning/tour-of-beam/frontend/assets/translations/en.yaml

@@ -27,7 +27,6 @@ ui:
   reportIssue: Report Issue in GitHub
   signIn: Sign in
   signOut: Sign out
-  solution: Solution
   toWebsite: To Apache Beam website
 
 pages:
@@ -38,7 +37,12 @@ pages:
     startTour: Start your tour
     title: Welcome to the Tour of Beam!
   tour:
+    assignment: Assignment
     completeUnit: Complete Unit
+    example: Example
+    myCode: My code
+    saving: Saving...
+    solution: Solution
     summaryTitle: Table of Contents
 
 dialogs:

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

@@ -29,13 +29,16 @@ class UnitContentCache extends Cache {
   final _unitContents = <String, Map<String, UnitContentModel>>{};
   final _futures = <String, Map<String, Future<UnitContentModel>>>{};
 
-  UnitContentModel? getUnitContent(String sdkId, String unitId) {
+  Future<UnitContentModel> getUnitContent(
+    String sdkId,
+    String unitId,
+  ) async {
     final future = _futures[sdkId]?[unitId];
     if (future == null) {
-      unawaited(_loadUnitContent(sdkId, unitId));
+      await _loadUnitContent(sdkId, unitId);
     }
 
-    return _unitContents[sdkId]?[unitId];
+    return _unitContents[sdkId]![unitId]!;
   }
 
   Future<UnitContentModel> _loadUnitContent(String sdkId, String unitId) async {

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

@@ -18,23 +18,92 @@
 
 import 'dart:async';
 
+import 'package:flutter/foundation.dart';
 import 'package:get_it/get_it.dart';
+import 'package:playground_components/playground_components.dart';
 
 import '../auth/notifier.dart';
+import '../enums/snippet_type.dart';
 import '../enums/unit_completion.dart';
+import '../models/unit_progress.dart';
+import '../repositories/client/client.dart';
 import '../repositories/models/get_user_progress_response.dart';
+import '../repositories/user_progress/abstract.dart';
+import '../repositories/user_progress/cloud.dart';
+import '../repositories/user_progress/hive.dart';
 import '../state.dart';
-import 'cache.dart';
 
-class UnitProgressCache extends Cache {
-  UnitProgressCache({required super.client});
+class UnitProgressCache extends ChangeNotifier {
+  final _cloudUserProgressRepository = CloudUserProgressRepository(
+    client: GetIt.instance.get<TobClient>(),
+  );
+  final _localStorageUserProgressRepository = HiveUserProgressRepository();
+
+  AbstractUserProgressRepository _getUserProgressRepository() {
+    if (isAuthenticated) {
+      return _cloudUserProgressRepository;
+    }
+    return _localStorageUserProgressRepository;
+  }
+
+  Future<GetUserProgressResponse?>? _future;
+
+  var _unitProgress = <UnitProgressModel>[];
+  final _unitProgressByUnitId = <String, UnitProgressModel>{};
 
   final _completedUnitIds = <String>{};
   final _updatingUnitIds = <String>{};
-  Future<GetUserProgressResponse?>? _future;
+
+  bool get isAuthenticated =>
+      GetIt.instance.get<AuthNotifier>().isAuthenticated;
+
+  Future<void> loadUnitProgress(Sdk sdk) async {
+    _future = _getUserProgressRepository().getUserProgress(sdk);
+    final result = await _future;
+
+    _unitProgressByUnitId.clear();
+    if (result != null) {
+      _unitProgress = result.units;
+      for (final unitProgress in _unitProgress) {
+        _unitProgressByUnitId[unitProgress.id] = unitProgress;
+      }
+    } else {
+      _unitProgress = [];
+    }
+    notifyListeners();
+  }
+
+  List<UnitProgressModel> _getUnitProgress() {
+    if (_future == null) {
+      unawaited(loadUnitProgress(GetIt.instance.get<AppNotifier>().sdk!));
+    }
+    return _unitProgress;
+  }
+
+  // Completion
+
+  Future<void> completeUnit(String sdkId, String unitId) async {
+    try {
+      addUpdatingUnitId(unitId);
+      await _getUserProgressRepository().completeUnit(sdkId, unitId);
+    } finally {
+      await loadUnitProgress(GetIt.instance.get<AppNotifier>().sdk!);
+      clearUpdatingUnitId(unitId);
+    }
+  }
 
   Set<String> getUpdatingUnitIds() => _updatingUnitIds;
 
+  Set<String> getCompletedUnits() {
+    _completedUnitIds.clear();
+    for (final unitProgress in _getUnitProgress()) {
+      if (unitProgress.isCompleted) {
+        _completedUnitIds.add(unitProgress.id);
+      }
+    }
+    return _completedUnitIds;
+  }
+
   void addUpdatingUnitId(String unitId) {
     _updatingUnitIds.add(unitId);
     notifyListeners();
@@ -52,6 +121,14 @@ class UnitProgressCache extends Cache {
     return _getUnitCompletion(unitId) == UnitCompletion.uncompleted;
   }
 
+  bool isUnitCompleted(String? unitId) {
+    return getCompletedUnits().contains(unitId);
+  }
+
+  String? getUnitSavedSnippetId(String? unitId) {
+    return _unitProgressByUnitId[unitId]?.userSnippetId;
+  }
+
   UnitCompletion _getUnitCompletion(String unitId) {
     final authNotifier = GetIt.instance.get<AuthNotifier>();
     if (!authNotifier.isAuthenticated) {
@@ -66,38 +143,33 @@ class UnitProgressCache extends Cache {
     return UnitCompletion.uncompleted;
   }
 
-  bool isUnitCompleted(String? unitId) {
-    return getCompletedUnits().contains(unitId);
-  }
+  // Snippet
 
-  Future<void> updateCompletedUnits() async {
-    final sdkId = GetIt.instance.get<AppNotifier>().sdkId;
-    if (sdkId != null) {
-      await _loadCompletedUnits(sdkId);
-    }
+  bool hasSavedSnippet(String? unitId) {
+    return _unitProgressByUnitId[unitId]?.userSnippetId != null;
   }
 
-  Set<String> getCompletedUnits() {
-    if (_future == null) {
-      unawaited(updateCompletedUnits());
-    }
-
-    return _completedUnitIds;
+  Future<void> saveSnippet({
+    required Sdk sdk,
+    required List<SnippetFile> snippetFiles,
+    required SnippetType snippetType,
+    required String unitId,
+  }) async {
+    await _getUserProgressRepository().saveUnitSnippet(
+      sdk: sdk,
+      snippetFiles: snippetFiles,
+      snippetType: snippetType,
+      unitId: unitId,
+    );
   }
 
-  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();
+  Future<ExampleLoadingDescriptor> getSavedDescriptor({
+    required Sdk sdk,
+    required String unitId,
+  }) async {
+    return _getUserProgressRepository().getSavedDescriptor(
+      sdk: sdk,
+      unitId: unitId,
+    );
   }
 }

learning/tour-of-beam/frontend/lib/config.dart

@@ -18,19 +18,17 @@
 
 // TODO(alexeyinkin): Generate this file on deployment.
 
-const _cloudFunctionsProjectRegion = 'us-central1';
-const _cloudFunctionsProjectId = 'tour-of-beam-2';
+const _cloudFunctionsProjectRegion = 'us-east1';
+const _cloudFunctionsProjectId = 'river-key-378010';
 const cloudFunctionsBaseUrl = 'https://'
     '$_cloudFunctionsProjectRegion-$_cloudFunctionsProjectId'
     '.cloudfunctions.net';
 
 // Copied from Playground's config.g.dart
 
 const String kAnalyticsUA = 'UA-73650088-2';
-const String kApiClientURL =
-    'https://backend-router-beta-dot-apache-beam-testing.appspot.com';
-const String kApiJavaClientURL =
-    'https://backend-java-beta-dot-apache-beam-testing.appspot.com';
+const String kApiClientURL = 'https://router.play-dev.beam.apache.org';
+const String kApiJavaClientURL = 'https://java.play-dev.beam.apache.org';
 const String kApiGoClientURL =
     'https://backend-go-beta-dot-apache-beam-testing.appspot.com';
 const String kApiPythonClientURL =

learning/tour-of-beam/frontend/lib/constants/hive_box_names.dart

@@ -0,0 +1,28 @@
+/*
+ * 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 'package:playground_components/playground_components.dart';
+
+class HiveBoxNames {
+  static const unitProgress = 'unit_progress';
+  static const snippets = 'snippets';
+
+  static String getSdkBoxName(Sdk sdk, String boxName) {
+    return '${sdk.id}_$boxName';
+  }
+}

learning/tour-of-beam/frontend/lib/constants/sizes.dart

@@ -19,7 +19,7 @@
 class TobSizes {
   static const double footerHeight = 35;
   static const double authOverlayWidth = 260;
-  static const double hintPopupWidth = 420;
+  static const double hintPopupWidth = 510;
 }
 
 class ScreenSizes {

learning/tour-of-beam/frontend/lib/enums/save_code_status.dart

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+enum SaveCodeStatus {
+  error,
+  saved,
+  saving,
+}

learning/tour-of-beam/frontend/lib/enums/snippet_type.dart

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+enum SnippetType {
+  original,
+  saved,
+  solution,
+}

learning/tour-of-beam/frontend/lib/firebase_options.dart

@@ -53,11 +53,11 @@ class DefaultFirebaseOptions {
   }
 
   static const FirebaseOptions web = FirebaseOptions(
-    apiKey: 'AIzaSyBtAreurqJ5D4IK6cNisZh5dnDRKljbJAw',
-    authDomain: 'astest-369409.firebaseapp.com',
-    projectId: 'astest-369409',
-    storageBucket: 'astest-369409.appspot.com',
-    messagingSenderId: '534850967604',
-    appId: '1:534850967604:web:55c6af8da7940df1ddd261',
+    apiKey: 'AIzaSyD-yN7OO9xjPQ5M-SJug96M2EfHwvjzd1A"',
+    authDomain: 'river-key-378010.firebaseapp.com"',
+    projectId: 'us-east1-river-key-378010',
+    storageBucket: 'river-key-378010.appspot.com',
+    messagingSenderId: '11155893632',
+    appId: '1:11155893632:web:0154abc4765db232086565',
   );
 }

learning/tour-of-beam/frontend/lib/locator.dart

@@ -48,7 +48,7 @@ void _initializeCaches() {
   GetIt.instance.registerSingleton(ContentTreeCache(client: client));
   GetIt.instance.registerSingleton(SdkCache(client: client));
   GetIt.instance.registerSingleton(UnitContentCache(client: client));
-  GetIt.instance.registerSingleton(UnitProgressCache(client: client));
+  GetIt.instance.registerSingleton(UnitProgressCache());
 }
 
 void _initializeState() {

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

@@ -20,16 +20,20 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'unit_progress.g.dart';
 
-@JsonSerializable(createToJson: false)
+@JsonSerializable()
 class UnitProgressModel {
   final String id;
   final bool isCompleted;
+  final String? userSnippetId;
 
   const UnitProgressModel({
     required this.id,
     required this.isCompleted,
+    required this.userSnippetId,
   });
 
   factory UnitProgressModel.fromJson(Map<String, dynamic> json) =>
       _$UnitProgressModelFromJson(json);
+
+  Map<String, dynamic> toJson() => _$UnitProgressModelToJson(this);
 }