login: Fetch all the data we'll want for an accounts table

README.md

@@ -44,14 +44,21 @@ community.  See [issue #15][].
 In this early prototype, we don't yet have a UI for logging into
 a Zulip server.  Instead, you supply Zulip credentials at build time.
 
-To do this, log into the Zulip web app for the test account you want
-to use, and [download a `.zuliprc` file][download-zuliprc].  Then
-create a file `lib/credential_fixture.dart` in this worktree with the
-following form:
+To do this, log into the Zulip web app for the test account
+you want to use, and gather two kinds of information:
+* [Download a `.zuliprc` file][download-zuliprc].
+  This will contain a realm URL, email, and API key.
+* Find the account's user ID.  You can do this by visiting your
+  DMs with yourself, and looking at the URL;
+  it's the number after `pm-with/` or `dm-with/`.
+
+Then create a file `lib/credential_fixture.dart` in this worktree
+with the following form, and fill in the gathered information:
 ```dart
 const String realmUrl = '…';
 const String email = '…';
 const String apiKey = '…';
+const int userId = /* … */ -1;
 ```
 
 Now build and run the app (see "Flutter help" above), and things

lib/api/core.dart

@@ -3,12 +3,12 @@ import 'dart:convert';
 import 'package:flutter/foundation.dart';
 import 'package:http/http.dart' as http;
 
-abstract class Auth {
-  String get realmUrl;
+class Auth {
+  const Auth({required this.realmUrl, required this.email, required this.apiKey});
 
-  String get email;
-
-  String get apiKey;
+  final String realmUrl;
+  final String email;
+  final String apiKey;
 }
 
 /// A value for an API request parameter, to use directly without JSON encoding.

lib/api/route/account.dart

@@ -33,8 +33,13 @@ Future<FetchApiKeyResult> fetchApiKey({
 class FetchApiKeyResult {
   final String apiKey;
   final String email;
+  final int? userId; // TODO(server-7)
 
-  FetchApiKeyResult({required this.apiKey, required this.email});
+  FetchApiKeyResult({
+    required this.apiKey,
+    required this.email,
+    this.userId,
+  });
 
   factory FetchApiKeyResult.fromJson(Map<String, dynamic> json) =>
     _$FetchApiKeyResultFromJson(json);

lib/api/route/realm.dart

@@ -0,0 +1,74 @@
+import 'dart:convert';
+
+import 'package:http/http.dart' as http;
+import 'package:json_annotation/json_annotation.dart';
+
+part 'realm.g.dart';
+
+/// https://zulip.com/api/get-server-settings
+///
+/// Despite the name, this is really a home for certain realm-specific
+/// settings, as well as some information about the server as a whole.
+///
+/// The Zulip server offers this endpoint at the root domain of a server,
+/// even when there is no Zulip realm at that domain.  This binding, however,
+/// only operates on an actual Zulip realm.
+// TODO(#35): Perhaps detect realmless root domain, for more specific onboarding feedback.
+//   See thread, and the zulip-mobile code and chat thread it links to:
+//     https://github.com/zulip/zulip-flutter/pull/55#discussion_r1160267577
+Future<GetServerSettingsResult> getServerSettings({
+  required String realmUrl,
+}) async {
+  // TODO dedupe this part with LiveApiConnection; make this function testable
+  final response = await http.get(
+    Uri.parse("$realmUrl/api/v1/server_settings"));
+  if (response.statusCode != 200) {
+    throw Exception('error on GET server_settings: status ${response.statusCode}');
+  }
+  final data = utf8.decode(response.bodyBytes);
+
+  final json = jsonDecode(data);
+  return GetServerSettingsResult.fromJson(json);
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class GetServerSettingsResult {
+  final Map<String, bool> authenticationMethods;
+  // final List<ExternalAuthenticationMethod> external_authentication_methods; // TODO handle
+
+  final int zulipFeatureLevel;
+  final String zulipVersion;
+  final String? zulipMergeBase; // TODO(server-5)
+
+  final bool pushNotificationsEnabled;
+  final bool isIncompatible;
+
+  final bool emailAuthEnabled;
+  final bool requireEmailFormatUsernames;
+  final String realmUri;
+  final String realmName;
+  final String realmIcon;
+  final String realmDescription;
+  final bool? realmWebPublicAccessEnabled; // TODO(server-5)
+
+  GetServerSettingsResult({
+    required this.authenticationMethods,
+    required this.zulipFeatureLevel,
+    required this.zulipVersion,
+    this.zulipMergeBase,
+    required this.pushNotificationsEnabled,
+    required this.isIncompatible,
+    required this.emailAuthEnabled,
+    required this.requireEmailFormatUsernames,
+    required this.realmUri,
+    required this.realmName,
+    required this.realmIcon,
+    required this.realmDescription,
+    this.realmWebPublicAccessEnabled,
+  });
+
+  factory GetServerSettingsResult.fromJson(Map<String, dynamic> json) =>
+    _$GetServerSettingsResultFromJson(json);
+
+  Map<String, dynamic> toJson() => _$GetServerSettingsResultToJson(this);
+}

lib/api/route/users.dart

@@ -0,0 +1,37 @@
+import 'dart:convert';
+
+import 'package:json_annotation/json_annotation.dart';
+
+import '../core.dart';
+
+part 'users.g.dart';
+
+/// https://zulip.com/api/get-own-user, abridged
+///
+/// This route's return type is simplified because we use it only
+/// as a workaround on old servers.
+Future<GetOwnUserResult> getOwnUser(ApiConnection connection) async {
+  final data = await connection.get('users/me', {});
+  return GetOwnUserResult.fromJson(jsonDecode(data));
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class GetOwnUserResult {
+  final int userId;
+
+  // There are many more properties in this route's result.
+  // But we use this route only as a workaround on old servers:
+  //  https://github.com/zulip/zulip/issues/24980
+  //  https://chat.zulip.org/#narrow/stream/378-api-design/topic/user.20ID.20in.20fetch-api-key/near/1540592
+  // for which `userId` is the only property we need.
+  // TODO(server-7): Drop getOwnUser entirely, relying on userId from fetchApiKey.
+
+  GetOwnUserResult({
+    required this.userId,
+  });
+
+  factory GetOwnUserResult.fromJson(Map<String, dynamic> json) =>
+    _$GetOwnUserResultFromJson(json);
+
+  Map<String, dynamic> toJson() => _$GetOwnUserResultToJson(this);
+}

lib/model/store.dart

@@ -201,16 +201,21 @@ class PerAccountStore extends ChangeNotifier {
 }
 
 @immutable
-class Account implements Auth {
-  const Account(
-      {required this.realmUrl, required this.email, required this.apiKey});
-
-  @override
-  final String realmUrl;
-  @override
-  final String email;
-  @override
-  final String apiKey;
+class Account extends Auth {
+  const Account({
+    required super.realmUrl,
+    required super.email,
+    required super.apiKey,
+    required this.userId,
+    required this.zulipFeatureLevel,
+    required this.zulipVersion,
+    required this.zulipMergeBase,
+  });
+
+  final int userId;
+  final int zulipFeatureLevel;
+  final String zulipVersion;
+  final String? zulipMergeBase;
 }
 
 class LiveGlobalStore extends GlobalStore {
@@ -240,6 +245,10 @@ const Account _fixtureAccount = Account(
   realmUrl: credentials.realmUrl,
   email: credentials.email,
   apiKey: credentials.apiKey,
+  userId: credentials.userId,
+  zulipFeatureLevel: 169,
+  zulipVersion: '6.0-1235-g061f1dc43b',
+  zulipMergeBase: '6.0-1235-g061f1dc43b',
 );
 
 /// A [PerAccountStore] which polls an event queue to stay up to date.

lib/widgets/login.dart

@@ -1,6 +1,9 @@
 import 'package:flutter/material.dart';
 
+import '../api/core.dart';
 import '../api/route/account.dart';
+import '../api/route/realm.dart';
+import '../api/route/users.dart';
 import '../model/store.dart';
 import 'app.dart';
 import 'store.dart';
@@ -32,17 +35,27 @@ class _AddAccountPageState extends State<AddAccountPage> {
     super.dispose();
   }
 
-  void _onSubmitted(BuildContext context, String value) {
+  Future<void> _onSubmitted(BuildContext context, String value) async {
     final Uri? url = Uri.tryParse(value);
     switch (url) {
       case Uri(scheme: 'https' || 'http'):
         // TODO(#35): validate realm URL further?
-        // TODO(#36): support login methods beyond email/password
-        Navigator.push(context,
-          EmailPasswordLoginPage.buildRoute(realmUrl: url));
+        break;
       default:
         // TODO(#35): give feedback to user on bad realm URL
+        return;
     }
+
+    // TODO(#35): show feedback that we're working, while fetching server settings
+    final serverSettings = await getServerSettings(realmUrl: url.toString());
+    if (context.mounted) {} // https://github.com/dart-lang/linter/issues/4007
+    else {
+      return;
+    }
+
+    // TODO(#36): support login methods beyond email/password
+    Navigator.push(context,
+      EmailPasswordLoginPage.buildRoute(realmUrl: url, serverSettings: serverSettings));
   }
 
   @override
@@ -69,13 +82,16 @@ class _AddAccountPageState extends State<AddAccountPage> {
 }
 
 class EmailPasswordLoginPage extends StatefulWidget {
-  const EmailPasswordLoginPage({super.key, required this.realmUrl});
+  const EmailPasswordLoginPage({
+    super.key, required this.realmUrl, required this.serverSettings});
 
   final Uri realmUrl;
+  final GetServerSettingsResult serverSettings;
 
-  static Route<void> buildRoute({required Uri realmUrl}) {
+  static Route<void> buildRoute({
+      required Uri realmUrl, required GetServerSettingsResult serverSettings}) {
     return _LoginSequenceRoute(builder: (context) =>
-      EmailPasswordLoginPage(realmUrl: realmUrl));
+      EmailPasswordLoginPage(realmUrl: realmUrl, serverSettings: serverSettings));
   }
 
   @override
@@ -86,6 +102,14 @@ class _EmailPasswordLoginPageState extends State<EmailPasswordLoginPage> {
   final GlobalKey<FormFieldState<String>> _emailKey = GlobalKey();
   final GlobalKey<FormFieldState<String>> _passwordKey = GlobalKey();
 
+  Future<int> _getUserId(FetchApiKeyResult fetchApiKeyResult) async {
+    final FetchApiKeyResult(:email, :apiKey) = fetchApiKeyResult;
+    final auth = Auth(
+      realmUrl: widget.realmUrl.toString(), email: email, apiKey: apiKey);
+    final connection = LiveApiConnection(auth: auth); // TODO make this widget testable
+    return (await getOwnUser(connection)).userId;
+  }
+
   void _submit() async {
     final context = _emailKey.currentContext!;
     final realmUrl = widget.realmUrl;
@@ -106,13 +130,23 @@ class _EmailPasswordLoginPageState extends State<EmailPasswordLoginPage> {
       debugPrint(e.toString());
       return;
     }
+
+    // TODO(server-7): Rely on user_id from fetchApiKey.
+    final int userId = result.userId ?? await _getUserId(result);
     if (context.mounted) {} // https://github.com/dart-lang/linter/issues/4007
     else {
       return;
     }
 
     final account = Account(
-      realmUrl: realmUrl.toString(), email: result.email, apiKey: result.apiKey);
+      realmUrl: realmUrl.toString(),
+      email: result.email,
+      apiKey: result.apiKey,
+      userId: userId,
+      zulipFeatureLevel: widget.serverSettings.zulipFeatureLevel,
+      zulipVersion: widget.serverSettings.zulipVersion,
+      zulipMergeBase: widget.serverSettings.zulipMergeBase,
+    );
     final globalStore = GlobalStoreWidget.of(context);
     final accountId = await globalStore.insertAccount(account);
     if (context.mounted) {} // https://github.com/dart-lang/linter/issues/4007