for consistency and safety, always use prefs constants

Author: Dieterbe

lib/helpers/consts.dart

@@ -62,6 +62,9 @@ const PREFS_LAST_UPDATED_CATEGORIES = 'lastUpdatedCategories';
 const PREFS_LAST_UPDATED_LANGUAGES = 'lastUpdatedLanguages';
 const PREFS_EXERCISE_CACHE_VERSION = 'cacheVersion';
 const PREFS_INGREDIENTS = 'ingredientData';
+const PREFS_WORKOUT_UNITS = 'workoutUnits';
+const PREFS_USER = 'userData';
+const PREFS_LAST_SERVER = 'lastServer';
 
 const DEFAULT_ANIMATION_DURATION = Duration(milliseconds: 200);
 const DEFAULT_ANIMATION_CURVE = Curves.bounceIn;

lib/providers/auth.dart

@@ -193,29 +193,29 @@ class AuthProvider with ChangeNotifier {
  });
  final serverData = json.encode({'serverUrl': this.serverUrl});
 
- prefs.setString('userData', userData);
- prefs.setString('lastServer', serverData);
+ prefs.setString(PREFS_USER, userData);
+ prefs.setString(PREFS_LAST_SERVER, serverData);
  return {'action': LoginActions.proceed};
  }
 
  /// Loads the last server URL from which the user successfully logged in
  Future<String> getServerUrlFromPrefs() async {
  final prefs = await SharedPreferences.getInstance();
- if (!prefs.containsKey('lastServer')) {
+ if (!prefs.containsKey(PREFS_LAST_SERVER)) {
  return DEFAULT_SERVER_PROD;
  }
 
- final userData = json.decode(prefs.getString('lastServer')!);
+ final userData = json.decode(prefs.getString(PREFS_LAST_SERVER)!);
  return userData['serverUrl'] as String;
  }
 
  Future<bool> tryAutoLogin() async {
  final prefs = await SharedPreferences.getInstance();
- if (!prefs.containsKey('userData')) {
+ if (!prefs.containsKey(PREFS_USER)) {
  log('autologin failed');
  return false;
  }
- final extractedUserData = json.decode(prefs.getString('userData')!);
+ final extractedUserData = json.decode(prefs.getString(PREFS_USER)!);
 
  token = extractedUserData['token'];
  serverUrl = extractedUserData['serverUrl'];
@@ -239,7 +239,7 @@ class AuthProvider with ChangeNotifier {
  }
 
  final prefs = await SharedPreferences.getInstance();
- prefs.remove('userData');
+ prefs.remove(PREFS_USER);
  }
 
  /// Returns the application name and version

lib/providers/nutrition.dart

@@ -304,9 +304,9 @@ class NutritionPlansProvider with ChangeNotifier {
  _ingredients.add(ingredient);
 
  final prefs = await SharedPreferences.getInstance();
- final ingredientData = json.decode(prefs.getString('ingredientData')!);
+ final ingredientData = json.decode(prefs.getString(PREFS_INGREDIENTS)!);
  ingredientData['ingredients'].add(ingredient.toJson());
- prefs.setString('ingredientData', json.encode(ingredientData));
+ prefs.setString(PREFS_INGREDIENTS, json.encode(ingredientData));
  log("Saved ingredient '${ingredient.name}' to cache.");
 
  return ingredient;

lib/providers/workout_plans.dart

@@ -331,8 +331,8 @@ class WorkoutPlansProvider with ChangeNotifier {
  Future<void> fetchAndSetUnits() async {
  // Load units from cache, if available
  final prefs = await SharedPreferences.getInstance();
- if (prefs.containsKey('workoutUnits')) {
- final unitData = json.decode(prefs.getString('workoutUnits')!);
+ if (prefs.containsKey(PREFS_WORKOUT_UNITS)) {
+ final unitData = json.decode(prefs.getString(PREFS_WORKOUT_UNITS)!);
  if (DateTime.parse(unitData['expiresIn']).isAfter(DateTime.now())) {
  unitData['repetitionUnits'].forEach(
  (e) => _repetitionUnit.add(RepetitionUnit.fromJson(e)),
@@ -358,7 +358,7 @@ class WorkoutPlansProvider with ChangeNotifier {
  'repetitionUnits': _repetitionUnit.map((e) => e.toJson()).toList(),
  'weightUnit': _weightUnits.map((e) => e.toJson()).toList(),
  };
- prefs.setString('workoutUnits', json.encode(exerciseData));
+ prefs.setString(PREFS_WORKOUT_UNITS, json.encode(exerciseData));
  notifyListeners();
  }
 

test/workout/workout_provider_test.dart

@@ -25,6 +25,7 @@ import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 import 'package:wger/core/locator.dart';
+import 'package:wger/helpers/consts.dart';
 import 'package:wger/models/workouts/repetition_unit.dart';
 import 'package:wger/models/workouts/weight_unit.dart';
 import 'package:wger/models/workouts/workout_plan.dart';
@@ -156,7 +157,7 @@ void main() {
  // Load the entries
  final provider = WorkoutPlansProvider(mockBaseProvider, exercisesProvider, []);
  await provider.fetchAndSetUnits();
- final prefsJson = jsonDecode(prefs.getString('workoutUnits')!);
+ final prefsJson = jsonDecode(prefs.getString(PREFS_WORKOUT_UNITS)!);
 
  expect(prefsJson['repetitionUnits'].length, 7);
  expect(prefsJson['weightUnit'].length, 6);