Move the filter from local storage to Firestore (#97)

* move filter from local storage to Firestore

* reformat code

* bump version

* try to fix filter bugs

* move filter from local storage to firebase - fix bugs

* move filter from local storage to firebase - fix bugs

* move filter from local storage to firebase - fix bugs

* remove useless conditions

* delete useless code and make setFilterNodes private method

* reformat code

* delete unused import

* Fix popupmenu offset

It popped lower than it should have, maybe something changed in the Flutter defaults

* Fix filter acting odd on auth state changes

* bump version

Co-authored-by: Ioana Alexandru <ioanaa.alexandru98@gmail.com>

Author: gabrielGavriluta

lib/authentication/service/auth_provider.dart

@@ -9,7 +9,6 @@ import 'package:acs_upb_mobile/widgets/toast.dart';
 import 'package:cloud_firestore/cloud_firestore.dart';
 import 'package:firebase_auth/firebase_auth.dart';
 import 'package:flutter/material.dart';
-import 'package:provider/provider.dart';
 
 extension DatabaseUser on User {
   static User fromSnap(DocumentSnapshot snap) {
@@ -142,7 +141,7 @@ class AuthProvider with ChangeNotifier {
   }
 
   String get uid {
-    return _firebaseUser.uid;
+    return _firebaseUser?.uid;
   }
 
   String get email => _firebaseUser.email;
@@ -392,17 +391,21 @@ class AuthProvider with ChangeNotifier {
       _firebaseUser = await FirebaseAuth.instance.currentUser();
 
       // Create document in 'users'
-      final user = User(
+      _currentUser = User(
         uid: res.user.uid,
         firstName: firstName,
         lastName: lastName,
         classes: classes,
       );
 
       final DocumentReference ref =
-          Firestore.instance.collection('users').document(user.uid);
-      await ref.setData(user.toData());
+          Firestore.instance.collection('users').document(_currentUser.uid);
+      await ref.setData(_currentUser.toData());
 
+      // Try to set the default from the user data
+      if (_currentUser.classes != null) {
+        await ref.updateData({'filter_nodes': _currentUser.classes});
+      }
       // Send verification e-mail
       await _firebaseUser.sendEmailVerification();
 
@@ -445,16 +448,15 @@ class AuthProvider with ChangeNotifier {
 
       final classes = info['class'];
 
-      final User user =
-          await Provider.of<AuthProvider>(context, listen: false).currentUser
-            ..firstName = firstName
-            ..lastName = lastName
-            ..classes = classes;
+      _currentUser
+        ..firstName = firstName
+        ..lastName = lastName
+        ..classes = classes;
 
       await Firestore.instance
           .collection('users')
-          .document(user.uid)
-          .updateData(user.toData());
+          .document(_currentUser.uid)
+          .updateData(_currentUser.toData());
 
       // Update display name
       final userUpdateInfo = UserUpdateInfo()

lib/main.dart

@@ -46,9 +46,12 @@ Future<void> main() async {
     ChangeNotifierProvider<PersonProvider>(create: (_) => PersonProvider()),
     ChangeNotifierProvider<QuestionProvider>(create: (_) => QuestionProvider()),
     ChangeNotifierProvider<NewsProvider>(create: (_) => NewsProvider()),
-    ChangeNotifierProvider<FilterProvider>(
-        create: (_) =>
-            FilterProvider(global: true, authProvider: authProvider)),
+    ChangeNotifierProxyProvider<AuthProvider, FilterProvider>(
+      create: (_) => FilterProvider(global: true),
+      update: (context, authProvider, filterProvider) {
+        return filterProvider..updateAuth(authProvider);
+      },
+    ),
     ChangeNotifierProxyProvider2<ClassProvider, FilterProvider,
         UniEventProvider>(
       create: (_) => UniEventProvider(

lib/pages/filter/service/filter_provider.dart

@@ -24,11 +24,9 @@ class FilterProvider with ChangeNotifier {
       {this.global = false,
       bool filterEnabled,
       this.defaultDegree,
-      this.defaultRelevance,
-      AuthProvider authProvider})
+      this.defaultRelevance})
       : _enabled = filterEnabled ?? PrefService.get('relevance_filter') ?? true,
-        _relevantNodes = defaultRelevance,
-        authProvider = authProvider ?? AuthProvider() {
+        _relevantNodes = defaultRelevance {
     if (defaultRelevance != null && !defaultRelevance.contains('All')) {
       if (defaultDegree == null) {
         throw ArgumentError(
@@ -49,17 +47,33 @@ class FilterProvider with ChangeNotifier {
   List<String> _relevantNodes;
   final List<String> defaultRelevance;
 
-  final AuthProvider authProvider;
+  AuthProvider _authProvider;
 
-  void resetFilter() {
-    _relevanceFilter = null;
+  void updateAuth(AuthProvider authProvider) {
+    _authProvider = authProvider;
+    clearCache();
+  }
 
+  void clearCache() {
+    _relevanceFilter = null;
     _relevantNodes = null;
+
     if (global) {
-      // Reset defaults
-      PrefService.setStringList('relevant_nodes', null);
+      // TODO(IoanaAlexandru): Remove this property
       PrefService.setBool('relevance_filter', true);
     }
+
+    notifyListeners();
+  }
+
+  Future<void> _setFilterNodes(List<String> nodes) async {
+    try {
+      final DocumentReference doc =
+          _db.collection('users').document(_authProvider.uid);
+      await doc.updateData({'filter_nodes': nodes});
+    } catch (e) {
+      print(e);
+    }
   }
 
   void enableFilter() {
@@ -85,8 +99,7 @@ class FilterProvider with ChangeNotifier {
   void updateFilter(Filter filter) {
     _relevanceFilter = filter;
     if (global) {
-      PrefService.setStringList(
-          'relevant_nodes', _relevanceFilter.relevantNodes);
+      _setFilterNodes(_relevanceFilter.relevantNodes);
     }
     notifyListeners();
   }
@@ -113,34 +126,31 @@ class FilterProvider with ChangeNotifier {
         levelNames.add(Map<String, String>.from(name));
       }
 
-      // Check if there is an existing setting already
-      if (global) {
-        _relevantNodes = PrefService.get('relevant_nodes') == null
-            ? null
-            : List<String>.from(PrefService.get('relevant_nodes'));
-      }
-
       final root = data['root'];
       _relevanceFilter = Filter(
         localizedLevelNames: levelNames,
         root: FilterNodeExtension.fromMap(root, 'All'),
       );
 
-      if (_relevantNodes != null) {
-        _relevantNodes ??= defaultRelevance;
-        for (final node in _relevantNodes) {
+      // Set the default relevance, if provided
+      if (defaultRelevance != null) {
+        for (final node in defaultRelevance) {
           _relevanceFilter.setRelevantUpToRoot(node, defaultDegree);
         }
         _relevantNodes = _relevanceFilter.relevantNodes;
-      } else {
-        // No previous setting or defaults => set the user's group
-        if (authProvider.isAuthenticatedFromCache) {
-          final user = await authProvider.currentUser;
-          // Try to set the default from the user data
-          if (user != null && user.classes != null) {
-            _relevanceFilter.setRelevantNodes(user.classes);
-          }
-        }
+      }
+
+      // Check if there is an existing setting already
+      if (global &&
+          _authProvider.isAuthenticatedFromCache &&
+          !_authProvider.isAnonymous) {
+        final DocumentReference docUsers =
+            _db.collection('users').document(_authProvider.uid);
+        final DocumentSnapshot snapUsers = await docUsers.get();
+
+        //Load filter_nodes from Firestore
+        _relevantNodes = List<String>.from(snapUsers['filter_nodes']);
+        _relevanceFilter.setRelevantNodes(_relevantNodes);
       }
 
       return cachedFilter;

lib/pages/timetable/service/uni_event_provider.dart

@@ -269,7 +269,8 @@ class UniEventProvider extends EventProvider<UniEventInstance>
           return events
               .where((event) =>
                   event.relevance == null ||
-                  (event.degree == _filter.baseNode &&
+                  (_filter != null &&
+                      event.degree == _filter.baseNode &&
                       event.relevance.any(_filter.relevantNodes.contains)))
               .map((e) => e.generateInstances(intersectingInterval: interval))
               .expand((e) => e);

lib/resources/utils.dart

@@ -1,7 +1,6 @@
 import 'package:acs_upb_mobile/authentication/service/auth_provider.dart';
 import 'package:acs_upb_mobile/generated/l10n.dart';
 import 'package:acs_upb_mobile/navigation/routes.dart';
-import 'package:acs_upb_mobile/pages/filter/service/filter_provider.dart';
 import 'package:acs_upb_mobile/widgets/toast.dart';
 import 'package:flutter/material.dart';
 import 'package:pedantic/pedantic.dart';
@@ -47,11 +46,9 @@ class Utils {
 
   static Future<void> signOut(BuildContext context) async {
     final authProvider = Provider.of<AuthProvider>(context, listen: false);
-    final filterProvider = Provider.of<FilterProvider>(context, listen: false);
     unawaited(Navigator.pushNamedAndRemoveUntil(
         context, Routes.login, (route) => false));
     unawaited(authProvider.signOut());
-    filterProvider.resetFilter();
   }
 
   static String wrapUrlWithCORS(String url) {

lib/widgets/scaffold.dart

@@ -77,7 +77,7 @@ class AppScaffold extends StatelessWidget {
                       ))
                   .toList();
             },
-            offset: const Offset(0, 100),
+            offset: const Offset(0, 15),
           )
         : Tooltip(
             message: action?.tooltip ?? action?.text ?? '',

pubspec.yaml

@@ -13,7 +13,7 @@ description: A mobile application for students at ACS UPB.
 # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
 #
 # ACS UPB Mobile uses semantic versioning. You can read more in the CONTRIBUTING.md file.
-version: 1.2.3+2
+version: 1.2.4+1
 
 environment:
   sdk: ">=2.7.0 <3.0.0"