Merge pull request #1838 from instructure/release/teacher-1.22.0-55

Release Teacher 1.22.0 (55)

PULL_REQUEST_TEMPLATE

@@ -12,5 +12,7 @@
 ## Checklist
 
 - [ ] Follow-up e2e test ticket created or not needed
+- [ ] Tested in dark mode
+- [ ] Tested in light mode
 - [ ] A11y checked
 - [ ] Approve from product or not needed

apps/flutter_parent/lib/l10n/res/intl_ms.arb

@@ -1,5 +1,5 @@
 {
-  "@@last_modified": "2022-01-28T12:37:40.360857",
+  "@@last_modified": "2022-10-28T11:03:07.232972",
   "alertsLabel": "Isyarat",
   "@alertsLabel": {
     "description": "The label for the Alerts tab",
@@ -259,6 +259,13 @@
     "placeholders_order": [],
     "placeholders": {}
   },
+  "findAnotherSchool": "Cari sekolah lain",
+  "@findAnotherSchool": {
+    "description": "Text for the find-another-school button",
+    "type": "text",
+    "placeholders_order": [],
+    "placeholders": {}
+  },
   "domainSearchInputHint": "Masukkan nama sekolah atau daerah...",
   "@domainSearchInputHint": {
     "description": "Input hint for the text box on the domain search screen",
@@ -2660,4 +2667,4 @@
     "placeholders_order": [],
     "placeholders": {}
   }
-}
+}

apps/flutter_parent/lib/models/feature_flags.dart

@@ -0,0 +1,32 @@
+// Copyright (C) 2023 - present Instructure, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, version 3 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import 'package:built_value/built_value.dart';
+import 'package:built_value/serializer.dart';
+
+part 'feature_flags.g.dart';
+
+abstract class FeatureFlags implements Built<FeatureFlags, FeatureFlagsBuilder> {
+
+  @BuiltValueSerializer(serializeNulls: true) // Add this line to get nulls to serialize when we convert to JSON
+  static Serializer<FeatureFlags> get serializer => _$featureFlagsSerializer;
+
+  @BuiltValueField(wireName: 'send_usage_metrics')
+  bool get sendUsageMetrics;
+
+  FeatureFlags._();
+  factory FeatureFlags([void Function(FeatureFlagsBuilder) updates]) = _$FeatureFlags;
+
+  static void _initializeBuilder(FeatureFlagsBuilder b) => b..sendUsageMetrics = false;
+}

apps/flutter_parent/lib/models/serializers.dart

@@ -90,6 +90,7 @@ import 'dataseeding/pairing_code.dart';
 import 'dataseeding/seed_context.dart';
 import 'dataseeding/seeded_user.dart';
 import 'dataseeding/user_name_data.dart';
+import 'feature_flags.dart';
 import 'file_upload_config.dart';
 
 part 'serializers.g.dart';
@@ -128,6 +129,7 @@ part 'serializers.g.dart';
   CreateSubmissionWrapper,
   CreateUserInfo,
   Enrollment,
+  FeatureFlags,
   FileUploadConfig,
   Grade,
   GradeSubmissionInfo,

apps/flutter_parent/lib/network/api/features_api.dart

@@ -0,0 +1,27 @@
+// Copyright (C) 2023 - present Instructure, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, version 3 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+import 'package:flutter_parent/models/feature_flags.dart';
+import 'package:flutter_parent/network/utils/dio_config.dart';
+import 'package:flutter_parent/network/utils/fetch.dart';
+
+class FeaturesApi {
+
+  Future<FeatureFlags> getFeatureFlags() {
+    var dio = canvasDio(forceRefresh: true);
+
+    return fetch(dio.get('/features/environment'));
+  }
+}

apps/flutter_parent/lib/network/api/heap_api.dart

@@ -0,0 +1,44 @@
+// Copyright (C) 2023 - present Instructure, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, version 3 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import 'dart:convert';
+
+import 'package:dio/dio.dart';
+import 'package:encrypt/encrypt.dart' as encrypt;
+import 'package:flutter_parent/network/utils/api_prefs.dart';
+import 'package:flutter_parent/network/utils/dio_config.dart';
+import 'package:flutter_parent/network/utils/fetch.dart';
+import 'package:flutter_parent/network/utils/private_consts.dart';
+
+class HeapApi {
+  Future<Response> track(String event, {Map<String, dynamic> extras = const {}}) {
+    final heapDio = DioConfig.heap();
+    final userId = ApiPrefs.getCurrentLogin().user.id;
+
+    final encrypter = encrypt.Encrypter(encrypt.AES(encrypt.Key.fromUtf8(ENCRYPT_KEY)));
+    final encryptedId = encrypter.encrypt(userId, iv: encrypt.IV.fromUtf8(ENCRYPT_IV)).base64;
+
+    var data = {
+      'app_id' : HEAP_PRODUCTION_ID,
+      'identity' : encryptedId,
+      'event' : event
+    };
+
+    if (extras.isNotEmpty) {
+      data['properties'] = json.encode(extras);
+    }
+
+    return fetch(heapDio.dio.post('/track', data: data));
+  }
+}

apps/flutter_parent/lib/network/utils/analytics.dart

@@ -14,7 +14,10 @@
 import 'package:device_info/device_info.dart';
 import 'package:firebase_crashlytics/firebase_crashlytics.dart';
 import 'package:flutter/foundation.dart';
+import 'package:flutter_parent/network/api/heap_api.dart';
+import 'package:flutter_parent/utils/features_utils.dart';
 import 'package:flutter_parent/utils/debug_flags.dart';
+import 'package:flutter_parent/utils/service_locator.dart';
 
 /// Event names
 /// The naming scheme for the majority of these is found in a google doc so that we can be consistent
@@ -79,10 +82,12 @@ class AnalyticsParamConstants {
 
 class Analytics {
 
+  HeapApi get _heap => HeapApi();
   /// Set the current screen in analytics
   void setCurrentScreen(String screenName) async {
-    if (kReleaseMode) {
-
+    final usageMetricsEnabled = await FeaturesUtils.getUsageMetricFeatureFlag();
+    if (kReleaseMode && usageMetricsEnabled) {
+      await _heap.track(screenName);
     }
 
     if (DebugFlags.isDebug) {
@@ -97,8 +102,9 @@ class Analytics {
   /// * [event] should be one of [AnalyticsEventConstants]
   /// * [extras] a map of keys [AnalyticsParamConstants] to values. Use sparingly, we only get 25 unique parameters
   void logEvent(String event, {Map<String, dynamic> extras = const {}}) async {
-    if (kReleaseMode) {
-
+    final usageMetricsEnabled = await FeaturesUtils.getUsageMetricFeatureFlag();
+    if (kReleaseMode && usageMetricsEnabled) {
+      await _heap.track(event, extras: extras);
     }
 
     if (DebugFlags.isDebug) {

apps/flutter_parent/lib/network/utils/dio_config.dart

@@ -193,6 +193,15 @@ class DioConfig {
         pageSize: pageSize);
   }
 
+  static DioConfig heap() {
+    final baseUrl = "https://heapanalytics.com/api/";
+    final headers = {
+      'accept': 'application/json',
+      'content-type': 'application/json'
+    };
+    return DioConfig(baseUrl: baseUrl, baseHeaders: headers);
+  }
+
   /// Clears the cache, deleting only the entries related to path OR clearing everything if path is null
   Future<bool> clearCache({String path}) {
     // The methods below are currently broken in unit tests due to sqflite (even when the sqflite MethodChannel has been

apps/flutter_parent/lib/router/router_error_screen.dart

@@ -22,6 +22,7 @@ import 'package:flutter_parent/router/panda_router.dart';
 import 'package:flutter_parent/utils/design/canvas_icons.dart';
 import 'package:flutter_parent/utils/design/parent_colors.dart';
 import 'package:flutter_parent/utils/design/parent_theme.dart';
+import 'package:flutter_parent/utils/features_utils.dart';
 import 'package:flutter_parent/utils/quick_nav.dart';
 import 'package:flutter_parent/utils/service_locator.dart';
 import 'package:flutter_parent/utils/url_launcher.dart';
@@ -90,6 +91,7 @@ class RouterErrorScreen extends StatelessWidget {
   _switchUsers(BuildContext context) async {
     await ParentTheme.of(context).setSelectedStudent(null); // TODO - Test this, do we need it here?
     await ApiPrefs.performLogout(switchingLogins: true, app: ParentApp.of(context));
+    await FeaturesUtils.performLogout();
     locator<QuickNav>().pushRouteAndClearStack(context, PandaRouter.login());
   }
 }

apps/flutter_parent/lib/screens/dashboard/dashboard_screen.dart

@@ -42,6 +42,7 @@ import 'package:flutter_parent/utils/common_widgets/user_name.dart';
 import 'package:flutter_parent/utils/design/canvas_icons.dart';
 import 'package:flutter_parent/utils/design/parent_colors.dart';
 import 'package:flutter_parent/utils/design/parent_theme.dart';
+import 'package:flutter_parent/utils/features_utils.dart';
 import 'package:flutter_parent/utils/quick_nav.dart';
 import 'package:flutter_parent/utils/service_locator.dart';
 import 'package:flutter_svg/flutter_svg.dart';
@@ -567,9 +568,10 @@ class DashboardState extends State<DashboardScreen> {
     await ParentTheme.of(context).setSelectedStudent(null);
     await ApiPrefs.performLogout(switchingLogins: switchingUsers, app: ParentApp.of(context));
     MasqueradeUI.of(context).refresh();
-    locator<Analytics>()
+    await locator<Analytics>()
         .logEvent(switchingUsers ? AnalyticsEventConstants.SWITCH_USERS : AnalyticsEventConstants.LOGOUT);
     locator<QuickNav>().pushRouteAndClearStack(context, PandaRouter.login());
+    await FeaturesUtils.performLogout();
   }
 
   _navDrawerHeader(User user) => Column(