Unnecessary call update user even field not change (#286)

Unnecessary call updateUser even if the field not changed

Author: krisadamqdc

packages/clerk_auth/lib/src/clerk_auth/auth.dart

@@ -649,19 +649,30 @@ class Auth {
         case SignUp signUp when hasInitialSignUp:
           // if we didn't create a SignUp object earlier,  now is the time to
           // update the preexisting SignUp object, in case of changes
-          await _api
-              .updateSignUp(
-                signUp,
-                strategy: strategy,
-                password: password,
-                firstName: firstName,
-                lastName: lastName,
-                username: username,
-                emailAddress: emailAddress,
-                phoneNumber: phoneNumber,
-                legalAccepted: legalAccepted,
-              )
-              .then(_housekeeping);
+          final needsUpdate = (password?.isNotEmpty == true) ||
+              (firstName is String && firstName != signUp.firstName) ||
+              (lastName is String && lastName != signUp.lastName) ||
+              (username is String && username != signUp.username) ||
+              (emailAddress is String && emailAddress != signUp.emailAddress) ||
+              (phoneNumber is String && phoneNumber != signUp.phoneNumber) ||
+              // We don't have current state for legalAccepted in SignUp;
+              // if provided, assume it's a change worth sending
+              (legalAccepted is bool);
+          if (needsUpdate) {
+            await _api
+                .updateSignUp(
+                  signUp,
+                  strategy: strategy,
+                  password: password,
+                  firstName: firstName,
+                  lastName: lastName,
+                  username: username,
+                  emailAddress: emailAddress,
+                  phoneNumber: phoneNumber,
+                  legalAccepted: legalAccepted,
+                )
+                .then(_housekeeping);
+          }
       }
     }
 

packages/clerk_auth/test/integration/clerk_auth/sign_up_test.dart

@@ -231,5 +231,73 @@ void main() {
         expect(httpService.isCompleted, true);
       });
     });
+
+    test('does not updateSignUp when values are unchanged', () async {
+      await runWithLogging(() async {
+        expect(auth.user, null);
+
+        // 1) Create initial sign up with emailCode and an email address
+        httpService.expect(
+          'POST /v1/client/sign_ups strategy=email_code&email_address=$emailAddress',
+          200,
+          '{"response":{"object":"sign_up_attempt","id":"SIGN_UP_ATTEMPT_ID","status":"missing_requirements","required_fields":["password"],"optional_fields":["oauth_github","oauth_google","email_address","phone_number","username","last_name","first_name","oauth_apple"],"missing_fields":["password"],"unverified_fields":["email_address"],"verifications":{"email_address":null,"phone_number":null,"web3_wallet":null,"external_account":null},"username":null,"email_address":"$emailAddress","phone_number":null,"web3_wallet":null,"password_enabled":false,"first_name":null,"last_name":null,"unsafe_metadata":{},"public_metadata":{},"custom_action":false,"external_id":null,"created_session_id":null,"created_user_id":null,"abandon_at":1732107014735,"legal_accepted_at":null},"client":{"object":"client","id":"CLIENT_ID","sessions":[],"sign_in":null,"sign_up":{"object":"sign_up_attempt","id":"SIGN_UP_ATTEMPT_ID","status":"missing_requirements","required_fields":["password"],"optional_fields":["phone_number","username","first_name","last_name","oauth_github","oauth_google","oauth_apple","email_address"],"missing_fields":["password"],"unverified_fields":["email_address"],"verifications":{"email_address":null,"phone_number":null,"web3_wallet":null,"external_account":null},"username":null,"email_address":"$emailAddress","phone_number":null,"web3_wallet":null,"password_enabled":false,"first_name":null,"last_name":null,"unsafe_metadata":{},"public_metadata":{},"custom_action":false,"external_id":null,"created_session_id":null,"created_user_id":null,"abandon_at":1732107014735,"legal_accepted_at":null},"last_active_session_id":null,"cookie_expires_at":null,"created_at":1732020614717,"updated_at":1732020614748}}',
+        );
+
+        // Initial create
+        Client client = await auth.attemptSignUp(
+          strategy: Strategy.emailCode,
+          emailAddress: emailAddress,
+        );
+        expect(client.signUp?.status, Status.missingRequirements);
+
+        // 2) Call attemptSignUp again with the same email
+        // No HTTP expectation should be queued for this invocation.
+        client = await auth.attemptSignUp(
+          strategy: Strategy.emailCode,
+          emailAddress: emailAddress, // unchanged
+        );
+
+        // State should remain in missing requirements; no extra PATCH occurred.
+        expect(client.signUp?.status, Status.missingRequirements);
+      });
+    });
+
+    test('updates SignUp when provided value changes', () async {
+      await runWithLogging(() async {
+        expect(auth.user, null);
+
+        final firstEmail = '$username[email protected]';
+        final secondEmail = '$username[email protected]';
+
+        // 1) Create initial sign up with first email
+        httpService.expect(
+          'POST /v1/client/sign_ups strategy=email_code&email_address=$firstEmail',
+          200,
+          '{"response":{"object":"sign_up_attempt","id":"SIGN_UP_ATTEMPT_ID","status":"missing_requirements","required_fields":["password"],"optional_fields":["oauth_github","oauth_google","email_address","phone_number","username","last_name","first_name","oauth_apple"],"missing_fields":["password"],"unverified_fields":["email_address"],"verifications":{"email_address":null,"phone_number":null,"web3_wallet":null,"external_account":null},"username":null,"email_address":"$firstEmail","phone_number":null,"web3_wallet":null,"password_enabled":false,"first_name":null,"last_name":null,"unsafe_metadata":{},"public_metadata":{},"custom_action":false,"external_id":null,"created_session_id":null,"created_user_id":null,"abandon_at":1732107014735,"legal_accepted_at":null},"client":{"object":"client","id":"CLIENT_ID","sessions":[],"sign_in":null,"sign_up":{"object":"sign_up_attempt","id":"SIGN_UP_ATTEMPT_ID","status":"missing_requirements","required_fields":["password"],"optional_fields":["phone_number","username","first_name","last_name","oauth_github","oauth_google","oauth_apple","email_address"],"missing_fields":["password"],"unverified_fields":["email_address"],"verifications":{"email_address":null,"phone_number":null,"web3_wallet":null,"external_account":null},"username":null,"email_address":"$firstEmail","phone_number":null,"web3_wallet":null,"password_enabled":false,"first_name":null,"last_name":null,"unsafe_metadata":{},"public_metadata":{},"custom_action":false,"external_id":null,"created_session_id":null,"created_user_id":null,"abandon_at":1732107014735,"legal_accepted_at":null},"last_active_session_id":null,"cookie_expires_at":null,"created_at":1732020614717,"updated_at":1732020614748}}',
+        );
+
+        Client client = await auth.attemptSignUp(
+          strategy: Strategy.emailCode,
+          emailAddress: firstEmail,
+        );
+        expect(client.signUp?.status, Status.missingRequirements);
+
+        // 2) Provide a different email -> should PATCH
+        httpService.expect(
+          'PATCH /v1/client/sign_ups/SIGN_UP_ATTEMPT_ID strategy=email_code&email_address=$secondEmail',
+          200,
+          '{"response":{"object":"sign_up_attempt","id":"SIGN_UP_ATTEMPT_ID","status":"missing_requirements","required_fields":["password"],"optional_fields":["oauth_github","oauth_google","email_address","phone_number","username","last_name","first_name","oauth_apple"],"missing_fields":["password"],"unverified_fields":["email_address"],"verifications":{"email_address":null,"phone_number":null,"web3_wallet":null,"external_account":null},"username":null,"email_address":"$secondEmail","phone_number":null,"web3_wallet":null,"password_enabled":false,"first_name":null,"last_name":null,"unsafe_metadata":{},"public_metadata":{},"custom_action":false,"external_id":null,"created_session_id":null,"created_user_id":null,"abandon_at":1732107014735,"legal_accepted_at":null},"client":{"object":"client","id":"CLIENT_ID","sessions":[],"sign_in":null,"sign_up":{"object":"sign_up_attempt","id":"SIGN_UP_ATTEMPT_ID","status":"missing_requirements","required_fields":["password"],"optional_fields":["phone_number","username","first_name","last_name","oauth_github","oauth_google","oauth_apple","email_address"],"missing_fields":["password"],"unverified_fields":["email_address"],"verifications":{"email_address":null,"phone_number":null,"web3_wallet":null,"external_account":null},"username":null,"email_address":"$secondEmail","phone_number":null,"web3_wallet":null,"password_enabled":false,"first_name":null,"last_name":null,"unsafe_metadata":{},"public_metadata":{},"custom_action":false,"external_id":null,"created_session_id":null,"created_user_id":null,"abandon_at":1732107014735,"legal_accepted_at":null},"last_active_session_id":null,"cookie_expires_at":null,"created_at":1732020614717,"updated_at":1732020614748}}',
+        );
+
+        client = await auth.attemptSignUp(
+          strategy: Strategy.emailCode,
+          emailAddress: secondEmail,
+        );
+
+        // Still in missing requirements, but email reflected the change via PATCH
+        expect(client.signUp?.status, Status.missingRequirements);
+        expect(client.signUp?.emailAddress, secondEmail);
+      });
+    });
   });
 }