urls [nfc]: Represent realm URL as Uri object, not String

Author: chrisbobbe

lib/api/core.dart

@@ -5,9 +5,9 @@ import 'package:http/http.dart' as http;
 
 class Auth {
   Auth({required this.realmUrl, required this.email, required this.apiKey})
-   : assert(Uri.parse(realmUrl).query.isEmpty && Uri.parse(realmUrl).fragment.isEmpty);
+   : assert(realmUrl.query.isEmpty && realmUrl.fragment.isEmpty);
 
-  final String realmUrl;
+  final Uri realmUrl;
   final String email;
   final String apiKey;
 }
@@ -70,8 +70,7 @@ class LiveApiConnection extends ApiConnection {
   @override
   Future<String> get(String route, Map<String, dynamic>? params) async {
     assert(_isOpen);
-    final baseUrl = Uri.parse(auth.realmUrl);
-    final url = baseUrl.replace(
+    final url = auth.realmUrl.replace(
         path: "/api/v1/$route", queryParameters: encodeParameters(params));
     if (kDebugMode) print("GET $url");
     final response = await _client.get(url, headers: _headers());
@@ -85,7 +84,7 @@ class LiveApiConnection extends ApiConnection {
   Future<String> post(String route, Map<String, dynamic>? params) async {
     assert(_isOpen);
     final response = await _client.post(
-        Uri.parse(auth.realmUrl).replace(path: "/api/v1/$route"),
+        auth.realmUrl.replace(path: "/api/v1/$route"),
         headers: _headers(),
         body: encodeParameters(params));
     if (response.statusCode != 200) {

lib/api/route/account.dart

@@ -9,13 +9,13 @@ part 'account.g.dart';
 
 /// https://zulip.com/api/fetch-api-key
 Future<FetchApiKeyResult> fetchApiKey({
-  required String realmUrl,
+  required Uri realmUrl,
   required String username,
   required String password,
 }) async {
   // TODO dedupe this part with LiveApiConnection; make this function testable
   final response = await http.post(
-    Uri.parse(realmUrl).replace(path: "/api/v1/fetch_api_key"),
+    realmUrl.replace(path: "/api/v1/fetch_api_key"),
     body: encodeParameters({
       'username': RawParameter(username),
       'password': RawParameter(password),

lib/api/route/messages.dart

@@ -69,7 +69,7 @@ Future<SendMessageResult> sendMessage(
 }) async {
   // assert() is less verbose but would have no effect in production, I think:
   //   https://dart.dev/guides/language/language-tour#assert
-  if (Uri.parse(connection.auth.realmUrl).origin != 'https://chat.zulip.org') {
+  if (connection.auth.realmUrl.origin != 'https://chat.zulip.org') {
     throw Exception('This binding can currently only be used on https://chat.zulip.org.');
   }
 

lib/api/route/realm.dart

@@ -17,11 +17,11 @@ part 'realm.g.dart';
 //   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,
+  required Uri realmUrl,
 }) async {
   // TODO dedupe this part with LiveApiConnection; make this function testable
   final response = await http.get(
-    Uri.parse(realmUrl).replace(path: "/api/v1/server_settings"));
+    realmUrl.replace(path: "/api/v1/server_settings"));
   if (response.statusCode != 200) {
     throw Exception('error on GET server_settings: status ${response.statusCode}');
   }

lib/model/store.dart

@@ -244,7 +244,7 @@ class LiveGlobalStore extends GlobalStore {
 /// See "Server credentials" in the project README for how to fill in the
 /// `credential_fixture.dart` file this requires.
 final Account _fixtureAccount = Account(
-  realmUrl: credentials.realmUrl,
+  realmUrl: Uri.parse(credentials.realmUrl),
   email: credentials.email,
   apiKey: credentials.apiKey,
   userId: credentials.userId,

lib/widgets/app.dart

@@ -65,7 +65,7 @@ class ChooseAccountPage extends StatelessWidget {
             for (final (:accountId, :account) in globalStore.accountEntries)
               _buildAccountItem(context,
                 accountId: accountId,
-                title: Text(account.realmUrl),
+                title: Text(account.realmUrl.toString()),
                 subtitle: Text(account.email)),
             const SizedBox(height: 12),
             ElevatedButton(
@@ -103,7 +103,7 @@ class HomePage extends StatelessWidget {
               const SizedBox(height: 12),
               Text.rich(TextSpan(
                 text: 'Connected to: ',
-                children: [bold(store.account.realmUrl)])),
+                children: [bold(store.account.realmUrl.toString())])),
               Text.rich(TextSpan(
                 text: 'Zulip server version: ',
                 children: [bold(store.zulipVersion)])),

lib/widgets/content.dart

@@ -591,7 +591,7 @@ class RealmContentNetworkImage extends StatelessWidget {
       isAntiAlias: isAntiAlias,
 
       // Only send the auth header to the server `auth` belongs to.
-      headers: parsedSrc.origin == Uri.parse(auth.realmUrl).origin
+      headers: parsedSrc.origin == auth.realmUrl.origin
         ? authHeader(auth)
         : null,
 
@@ -609,7 +609,7 @@ class RealmContentNetworkImage extends StatelessWidget {
 // This may dissolve when we start passing around URLs as [Uri] objects instead
 // of strings.
 String resolveUrl(String url, Account account) {
-  final realmUrl = Uri.parse(account.realmUrl); // TODO clean this up
+  final realmUrl = account.realmUrl;
   final resolved = realmUrl.resolve(url); // TODO handle if fails to parse
   return resolved.toString();
 }

lib/widgets/login.dart

@@ -47,7 +47,7 @@ class _AddAccountPageState extends State<AddAccountPage> {
     }
 
     // TODO(#35): show feedback that we're working, while fetching server settings
-    final serverSettings = await getServerSettings(realmUrl: url.toString());
+    final serverSettings = await getServerSettings(realmUrl: url);
     if (context.mounted) {} // https://github.com/dart-lang/linter/issues/4007
     else {
       return;
@@ -105,7 +105,7 @@ class _EmailPasswordLoginPageState extends State<EmailPasswordLoginPage> {
   Future<int> _getUserId(FetchApiKeyResult fetchApiKeyResult) async {
     final FetchApiKeyResult(:email, :apiKey) = fetchApiKeyResult;
     final auth = Auth(
-      realmUrl: widget.realmUrl.toString(), email: email, apiKey: apiKey);
+      realmUrl: widget.realmUrl, email: email, apiKey: apiKey);
     final connection = LiveApiConnection(auth: auth); // TODO make this widget testable
     return (await getOwnUser(connection)).userId;
   }
@@ -124,7 +124,7 @@ class _EmailPasswordLoginPageState extends State<EmailPasswordLoginPage> {
     final FetchApiKeyResult result;
     try {
       result = await fetchApiKey(
-        realmUrl: realmUrl.toString(), username: email, password: password);
+        realmUrl: realmUrl, username: email, password: password);
     } on Exception catch (e) { // TODO(#37): distinguish API exceptions
       // TODO(#35): give feedback to user on failed login
       debugPrint(e.toString());
@@ -139,7 +139,7 @@ class _EmailPasswordLoginPageState extends State<EmailPasswordLoginPage> {
     }
 
     final account = Account(
-      realmUrl: realmUrl.toString(),
+      realmUrl: realmUrl,
       email: result.email,
       apiKey: result.apiKey,
       userId: userId,

test/api/fake_api.dart

@@ -3,7 +3,7 @@ import 'package:zulip/model/store.dart';
 
 /// An [ApiConnection] that accepts and replays canned responses, for testing.
 class FakeApiConnection extends ApiConnection {
-  FakeApiConnection({required String realmUrl, required String email})
+  FakeApiConnection({required Uri realmUrl, required String email})
       : super(auth: Auth(
                 realmUrl: realmUrl, email: email, apiKey: _fakeApiKey));
 

test/api/route/messages_test.dart

@@ -10,15 +10,15 @@ import 'route_checks.dart';
 void main() {
   test('sendMessage accepts fixture realm', () async {
     final connection = FakeApiConnection(
-        realmUrl: 'https://chat.zulip.org/', email: '[email protected]');
+        realmUrl: Uri.parse('https://chat.zulip.org/'), email: '[email protected]');
     connection.prepare(jsonEncode(SendMessageResult(id: 42).toJson()));
     check(sendMessage(connection, content: 'hello', topic: 'world'))
         .completes(it()..id.equals(42));
   });
 
   test('sendMessage rejects unexpected realm', () async {
     final connection = FakeApiConnection(
-        realmUrl: 'https://chat.example/', email: '[email protected]');
+        realmUrl: Uri.parse('https://chat.example/'), email: '[email protected]');
     connection.prepare(jsonEncode(SendMessageResult(id: 42).toJson()));
     check(sendMessage(connection, content: 'hello', topic: 'world'))
         .throws();