Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

urls [nfc]: Pass around Uri objects more (cut out some unneeded re-stringification) #247

Merged
merged 3 commits into from
Aug 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions lib/widgets/content.dart
Original file line number Diff line number Diff line change
Expand Up @@ -749,9 +749,7 @@ class RealmContentNetworkImage extends StatelessWidget {
this.cacheHeight,
});

/// An absolute URL string for the image.
// TODO: Take a [Uri] object, not a String
final String src;
final Uri src;

final double scale;
final ImageFrameBuilder? frameBuilder;
Expand Down Expand Up @@ -780,10 +778,8 @@ class RealmContentNetworkImage extends StatelessWidget {
Widget build(BuildContext context) {
final account = PerAccountStoreWidget.of(context).account;

final Uri parsedSrc = Uri.parse(src);

return Image.network(
parsedSrc.toString(),
src.toString(),

scale: scale,
frameBuilder: frameBuilder,
Expand All @@ -806,7 +802,7 @@ class RealmContentNetworkImage extends StatelessWidget {
isAntiAlias: isAntiAlias,

// Only send the auth header to the server `auth` belongs to.
headers: parsedSrc.origin == account.realmUrl.origin
headers: src.origin == account.realmUrl.origin
? authHeader(email: account.email, apiKey: account.apiKey)
: null,

Expand All @@ -823,10 +819,9 @@ class RealmContentNetworkImage extends StatelessWidget {
/// Resolve `url` to `account`'s realm, if relative
// This may dissolve when we start passing around URLs as [Uri] objects instead
// of strings.
String resolveUrl(String url, Account account) {
Uri resolveUrl(String url, Account account) {
final realmUrl = account.realmUrl;
final resolved = realmUrl.resolve(url); // TODO handle if fails to parse
return resolved.toString();
return realmUrl.resolve(url); // TODO handle if fails to parse
}

InlineSpan _errorUnimplemented(UnimplementedNode node) {
Expand Down
12 changes: 6 additions & 6 deletions lib/widgets/lightbox.dart
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class _LightboxHeroTag {
_LightboxHeroTag({required this.messageId, required this.src});

final int messageId;
final String src;
final Uri src;

@override
bool operator ==(Object other) {
Expand All @@ -40,7 +40,7 @@ class LightboxHero extends StatelessWidget {
});

final Message message;
final String src;
final Uri src;
final Widget child;

@override
Expand All @@ -66,7 +66,7 @@ class LightboxHero extends StatelessWidget {
class _CopyLinkButton extends StatelessWidget {
const _CopyLinkButton({required this.url});

final String url;
final Uri url;

@override
Widget build(BuildContext context) {
Expand All @@ -76,7 +76,7 @@ class _CopyLinkButton extends StatelessWidget {
onPressed: () async {
// TODO(i18n)
copyWithPopup(context: context, successContent: const Text('Link copied'),
data: ClipboardData(text: url));
data: ClipboardData(text: url.toString()));
});
}
}
Expand All @@ -90,7 +90,7 @@ class _LightboxPage extends StatefulWidget {

final Animation routeEntranceAnimation;
final Message message;
final String src;
final Uri src;

@override
State<_LightboxPage> createState() => _LightboxPageState();
Expand Down Expand Up @@ -205,7 +205,7 @@ class _LightboxPageState extends State<_LightboxPage> {
Route getLightboxRoute({
required BuildContext context,
required Message message,
required String src
required Uri src,
}) {
return AccountPageRouteBuilder(
context: context,
Expand Down
5 changes: 1 addition & 4 deletions lib/widgets/message_list.dart
Original file line number Diff line number Diff line change
Expand Up @@ -482,10 +482,7 @@ class MessageWithSender extends StatelessWidget {
: resolveUrl(author.avatarUrl!, store.account);
final avatar = (avatarUrl == null)
? const SizedBox.shrink()
: RealmContentNetworkImage(
avatarUrl,
filterQuality: FilterQuality.medium,
);
: RealmContentNetworkImage(avatarUrl, filterQuality: FilterQuality.medium);

final time = _kMessageTimestampFormat
.format(DateTime.fromMillisecondsSinceEpoch(1000 * message.timestamp));
Expand Down
8 changes: 4 additions & 4 deletions test/widgets/content_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ void main() {
group('RealmContentNetworkImage', () {
final authHeaders = authHeader(email: eg.selfAccount.email, apiKey: eg.selfAccount.apiKey);

Future<String?> actualAuthHeader(WidgetTester tester, String src) async {
Future<String?> actualAuthHeader(WidgetTester tester, Uri src) async {
final globalStore = TestZulipBinding.instance.globalStore;
addTearDown(TestZulipBinding.instance.reset);
await globalStore.add(eg.selfAccount, eg.initialSnapshot());
Expand All @@ -144,20 +144,20 @@ void main() {
}

testWidgets('includes auth header if `src` on-realm', (tester) async {
check(await actualAuthHeader(tester, 'https://chat.example/image.png'))
check(await actualAuthHeader(tester, Uri.parse('https://chat.example/image.png')))
.isNotNull().equals(authHeaders['Authorization']!);
debugNetworkImageHttpClientProvider = null;
});

testWidgets('excludes auth header if `src` off-realm', (tester) async {
check(await actualAuthHeader(tester, 'https://other.example/image.png'))
check(await actualAuthHeader(tester, Uri.parse('https://other.example/image.png')))
.isNull();
debugNetworkImageHttpClientProvider = null;
});

testWidgets('throws if no `PerAccountStoreWidget` ancestor', (WidgetTester tester) async {
await tester.pumpWidget(
const RealmContentNetworkImage('https://zulip.invalid/path/to/image.png', filterQuality: FilterQuality.medium));
RealmContentNetworkImage(Uri.parse('https://zulip.invalid/path/to/image.png'), filterQuality: FilterQuality.medium));
check(tester.takeException()).isA<AssertionError>();
});
});
Expand Down