login: Mark WebAuthPayload.userId as required, relying on server 5+, FL 108+.

See "Feature level 108" from Zulip API changelog:

  https://zulip.com/api/changelog

Signed-off-by: Zixuan James Li <[email protected]>

Author: PIG208

lib/api/model/web_auth.dart

@@ -7,7 +7,7 @@ import 'package:flutter/foundation.dart';
 class WebAuthPayload {
   final Uri realm;
   final String email;
-  final int? userId; // TODO(server-5) new in FL 108
+  final int userId;
   final String otpEncryptedApiKey;
 
   WebAuthPayload._({
@@ -25,21 +25,16 @@ class WebAuthPayload {
         queryParameters: {
           'realm': String realmStr,
           'email': String email,
-          // 'user_id' handled below
+          'user_id': String userIdStr,
           'otp_encrypted_api_key': String otpEncryptedApiKey,
         },
       )
     ) {
       final Uri? realm = Uri.tryParse(realmStr);
       if (realm == null) throw const FormatException();
 
-      // TODO(server-5) require in queryParameters (new in FL 108)
-      final userIdStr = url.queryParameters['user_id'];
-      int? userId;
-      if (userIdStr != null) {
-        userId = int.tryParse(userIdStr, radix: 10);
-        if (userId == null) throw const FormatException();
-      }
+      final userId = int.tryParse(userIdStr, radix: 10);
+      if (userId == null) throw const FormatException();
 
       if (!RegExp(r'^[0-9a-fA-F]{64}$').hasMatch(otpEncryptedApiKey)) {
         throw const FormatException();

lib/widgets/login.dart

@@ -293,8 +293,7 @@ class _LoginPageState extends State<LoginPage> {
       if (payload.realm.origin != widget.serverSettings.realmUrl.origin) throw Error();
       final apiKey = payload.decodeApiKey(_otp!);
       await _tryInsertAccountAndNavigate(
-        // TODO(server-5): Rely on userId from payload.
-        userId: payload.userId ?? await _getUserId(payload.email, apiKey),
+        userId: payload.userId,
         email: payload.email,
         apiKey: apiKey,
       );

test/api/model/web_auth_test.dart

@@ -23,19 +23,6 @@ void main() {
       check(payload.decodeApiKey(otp)).equals(eg.selfAccount.apiKey);
     });
 
-    // TODO(server-5) remove
-    test('legacy: no userId', () {
-      final queryParams = {...wellFormed.queryParameters}..remove('user_id');
-      final payload = WebAuthPayload.parse(
-        wellFormed.replace(queryParameters: queryParams));
-      check(payload)
-        ..otpEncryptedApiKey.equals(encryptedApiKey)
-        ..email.equals('self@example')
-        ..userId.isNull()
-        ..realm.equals(Uri.parse('https://chat.example/'));
-      check(payload.decodeApiKey(otp)).equals(eg.selfAccount.apiKey);
-    });
-
     test('parse fails when an expected field is missing', () {
       final queryParams = {...wellFormed.queryParameters}..remove('email');
       final input = wellFormed.replace(queryParameters: queryParams);
@@ -93,6 +80,6 @@ void main() {
 extension WebAuthPayloadChecks on Subject<WebAuthPayload> {
   Subject<String> get otpEncryptedApiKey => has((x) => x.otpEncryptedApiKey, 'otpEncryptedApiKey');
   Subject<String> get email => has((x) => x.email, 'email');
-  Subject<int?> get userId => has((x) => x.userId, 'userId');
+  Subject<int> get userId => has((x) => x.userId, 'userId');
   Subject<Uri> get realm => has((x) => x.realm, 'realm');
 }