fix: refactor password criteria matching [CLERK_SDK #20]

Author: shinyford

packages/clerk_auth/lib/models/environment/password_settings.dart

@@ -6,6 +6,10 @@ part 'password_settings.g.dart';
 
 @JsonSerializable(explicitToJson: true, fieldRename: FieldRename.snake)
 class PasswordSettings {
+  static final _lowerCaseRE = RegExp(r'[a-z]');
+  static final _upperCaseRE = RegExp(r'[A-Z]');
+  static final _numberRE = RegExp(r'[0-9]');
+
   static const empty = PasswordSettings();
 
   final String allowedSpecialCharacters;
@@ -51,4 +55,21 @@ class PasswordSettings {
   factory PasswordSettings.fromJson(Map<String, dynamic> json) => _$PasswordSettingsFromJson(json);
 
   Map<String, dynamic> toJson() => _$PasswordSettingsToJson(this);
+
+  bool meetsLowerCaseCriteria(String password) =>
+      requireLowercase == false || _lowerCaseRE.hasMatch(password);
+  bool meetsUpperCaseCriteria(String password) =>
+      requireUppercase == false || _upperCaseRE.hasMatch(password);
+  bool meetsNumberCriteria(String password) =>
+      requireNumbers == false || _numberRE.hasMatch(password);
+
+  bool meetsSpecialCharCriteria(String password) =>
+      requireSpecialChar == false ||
+      allowedSpecialCharacters.runes.toSet().intersection(password.runes.toSet()).isNotEmpty;
+
+  bool meetsRequiredCriteria(String password) =>
+      meetsLowerCaseCriteria(password) &&
+      meetsUpperCaseCriteria(password) &&
+      meetsNumberCriteria(password) &&
+      meetsSpecialCharCriteria(password);
 }

packages/clerk_flutter/example/lib/main.dart

@@ -27,7 +27,7 @@ class MainApp extends StatelessWidget {
             padding: horizontalPadding32,
             child: Center(
               child: ClerkAuthBuilder(
-                signedInBuilder: (context, auth) => ClerkUserButton(),
+                signedInBuilder: (context, auth) => const ClerkUserButton(),
                 signedOutBuilder: (context, auth) => const ClerkAuthenticationWidget(),
               ),
             ),

packages/clerk_flutter/lib/src/widgets/control/clerk_auth.dart

@@ -136,22 +136,19 @@ class _ClerkAuthData extends InheritedWidget {
 
 class ClerkAuthProvider extends Clerk.Auth with ChangeNotifier {
   static const _kRotatingTokenNonce = 'rotating_token_nonce';
-  static final _lowerCaseRE = RegExp(r'[a-z]');
-  static final _upperCaseRE = RegExp(r'[A-Z]');
-  static final _numberRE = RegExp(r'[0-9]');
 
   final ClerkTranslator translator;
   final _errors = StreamController<Clerk.AuthError>();
   late final errorStream = _errors.stream.asBroadcastStream();
-  final OverlayEntry loadingOverlay;
+  final OverlayEntry _loadingOverlay;
 
   ClerkAuthProvider({
     required super.publicKey,
     required super.publishableKey,
     this.translator = const DefaultClerkTranslator(),
     Widget? loading,
     super.persistor,
-  }) : this.loadingOverlay = OverlayEntry(builder: (context) => loading ?? defaultLoadingWidget);
+  }) : _loadingOverlay = OverlayEntry(builder: (context) => loading ?? defaultLoadingWidget);
 
   @override
   void update() => notifyListeners();
@@ -216,13 +213,13 @@ class ClerkAuthProvider extends Clerk.Auth with ChangeNotifier {
   }) async {
     T? result;
     try {
-      Overlay.of(context).insert(loadingOverlay);
+      Overlay.of(context).insert(_loadingOverlay);
       result = await fn.call();
     } on Clerk.AuthError catch (error) {
       _errors.add(error);
       onError?.call(error);
     } finally {
-      loadingOverlay.remove();
+      _loadingOverlay.remove();
     }
     return result;
   }
@@ -232,23 +229,7 @@ class ClerkAuthProvider extends Clerk.Auth with ChangeNotifier {
   bool passwordIsValid(String? password, String? confirmation) {
     if (password case String password when password.isNotEmpty) {
       if (password != confirmation) return false;
-
-      final criteria = env.user.passwordSettings;
-
-      if (criteria.requireLowercase && _lowerCaseRE.hasMatch(password) == false) return false;
-
-      if (criteria.requireUppercase && _upperCaseRE.hasMatch(password) == false) return false;
-
-      if (criteria.requireNumbers && _numberRE.hasMatch(password) == false) return false;
-
-      if (criteria.requireSpecialChar) {
-        final pRunes = password.runes.toSet();
-        final scRunes = criteria.allowedSpecialCharacters.runes.toSet();
-        final lacksSpecialChar = pRunes.intersection(scRunes).isEmpty;
-        if (lacksSpecialChar) return false;
-      }
-
-      return true;
+      return env.user.passwordSettings.meetsRequiredCriteria(password);
     }
 
     return false;
@@ -267,23 +248,20 @@ class ClerkAuthProvider extends Clerk.Auth with ChangeNotifier {
       final criteria = env.user.passwordSettings;
       final missing = <String>[];
 
-      if (criteria.requireLowercase && _lowerCaseRE.hasMatch(password) == false) {
+      if (criteria.meetsLowerCaseCriteria(password) == false) {
         missing.add('a LOWERCASE letter');
       }
 
-      if (criteria.requireUppercase && _upperCaseRE.hasMatch(password) == false) {
+      if (criteria.meetsUpperCaseCriteria(password) == false) {
         missing.add('an UPPERCASE letter');
       }
 
-      if (criteria.requireNumbers && _numberRE.hasMatch(password) == false) {
+      if (criteria.meetsNumberCriteria(password) == false) {
         missing.add('a NUMBER');
       }
 
-      if (criteria.requireSpecialChar) {
-        final pRunes = password.runes.toSet();
-        final scRunes = criteria.allowedSpecialCharacters.runes.toSet();
-        final lacksSpecialChar = pRunes.intersection(scRunes).isEmpty;
-        if (lacksSpecialChar) missing.add('a SPECIAL CHARACTER (###)');
+      if (criteria.meetsSpecialCharCriteria(password) == false) {
+        missing.add('a SPECIAL CHARACTER (###)');
       }
 
       if (missing.isNotEmpty) {

packages/clerk_flutter/lib/src/widgets/user/clerk_user_button.dart

@@ -5,15 +5,34 @@ import 'package:clerk_flutter/clerk_flutter.dart';
 import 'package:common/common.dart';
 import 'package:flutter/material.dart';
 
-class ClerkUserButton extends StatelessWidget {
-  static const _closeDelay = Duration(milliseconds: 250);
-
+class ClerkUserButton extends StatefulWidget {
   final bool showName;
 
-  ClerkUserButton({super.key, this.showName = true});
+  const ClerkUserButton({super.key, this.showName = true});
+
+  @override
+  State<ClerkUserButton> createState() => _ClerkUserButtonState();
+}
+
+class _ClerkUserButtonState extends State<ClerkUserButton> {
+  static const _closeDelay = Duration(milliseconds: 250);
 
   final _sessions = <Clerk.Session>[];
 
+  Future<void> _manage(List<Clerk.Session> sessions) async {
+    // adding to a list of existing sessions means we have ones that are now deleted
+    // still available in `_sessions`, making for prettier UI
+    _sessions.addOrReplaceAll(sessions, by: (s) => s.id);
+
+    // after a delay period, all deleted sessions will have been closed, so we can
+    // clear the `_sessions` cache of any such for next time round
+    // Using `removeWhere` maintains the list order in `_sessions`, stopping weird
+    // UI jumping as arbitrary list order is imposed
+    await Future.delayed(_closeDelay);
+
+    _sessions.removeWhere((s) => sessions.contains(s) == false);
+  }
+
   @override
   Widget build(BuildContext context) {
     return DecoratedBox(
@@ -26,19 +45,7 @@ class ClerkUserButton extends StatelessWidget {
         final translator = auth.translator;
         final sessions = auth.client.sessions;
 
-        // adding to a list of existing sessions means we have ones that are now deleted
-        // still available in `_sessions`, making for prettier UI
-        _sessions.addOrReplaceAll(sessions, by: (s) => s.id);
-
-        // after a delay period, all deleted sessions will have been closed, so we can
-        // clear the `_sessions` cache of any such for next time round
-        //
-        // Using `removeWhere` maintains the list order in `_sessions`, stopping weird
-        // UI jumping as arbitrary list order is imposed
-        Future.delayed(
-          _closeDelay,
-          () => _sessions.removeWhere((s) => sessions.contains(s) == false),
-        );
+        _manage(sessions);
 
         return ClerkVerticalCard(
           topPortion: Column(
@@ -48,9 +55,9 @@ class ClerkUserButton extends StatelessWidget {
                 _SessionRow(
                   key: Key(session.id),
                   session: session,
-                  closed: auth.client.sessions.contains(session) == false,
+                  closed: sessions.contains(session) == false,
                   selected: session == auth.client.activeSession,
-                  showName: showName,
+                  showName: widget.showName,
                   onTap: () => auth.call(context, () => auth.setActiveSession(session)),
                 ),
               if (auth.env.config.singleSessionMode == false)
@@ -82,7 +89,7 @@ class ClerkUserButton extends StatelessWidget {
             ],
           ),
           bottomPortion: Closeable(
-            open: auth.client.sessions.length > 1,
+            open: sessions.length > 1,
             child: Padding(
               padding: horizontalPadding16 + verticalPadding12,
               child: GestureDetector(
@@ -191,7 +198,7 @@ class _DottedBorderPainter extends CustomPainter {
   static const _twoPi = 2 * math.pi;
 
   final double dashLength;
-  final double gapLength;
+  final double gapLength; // actually, minimum gap length
 
   final Paint _paint;
   final Paint _backgroundPaint;
@@ -201,7 +208,10 @@ class _DottedBorderPainter extends CustomPainter {
     required Color backgroundColor,
     this.dashLength = 0,
     this.gapLength = 0,
-  })  : assert(dashLength > 0 || gapLength == 0, 'dashLength cannot be 0 unless gapLength is 0'),
+  })  : assert(
+          dashLength > 0 || gapLength == 0,
+          'dashLength cannot be 0 or less unless gapLength is 0',
+        ),
         _paint = Paint()
           ..style = PaintingStyle.stroke
           ..color = color,

packages/common/lib/src/extensions.dart

@@ -32,10 +32,11 @@ extension StringExtension on String {
 }
 
 extension ListExtension on List {
-  void addOrReplaceAll<T, S>(Iterable<T> list, {S Function(T)? by}) {
+  void addOrReplaceAll<T>(Iterable<T> list, {dynamic Function(T)? by}) {
+    by ??= (t) => t;
     for (final item in list) {
-      final identifier = by?.call(item) ?? item;
-      switch (indexWhere((i) => (by?.call(i) ?? i) == identifier)) {
+      final identifier = by.call(item);
+      switch (indexWhere((i) => by!.call(i) == identifier)) {
         case int idx when idx > -1:
           this[idx] = item;
         default: