-
Notifications
You must be signed in to change notification settings - Fork 227
/
hosted.dart
2080 lines (1907 loc) · 68.5 KB
/
hosted.dart
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'dart:async';
import 'dart:convert';
import 'dart:io' as io;
import 'dart:io';
import 'dart:typed_data';
import 'package:collection/collection.dart' show IterableExtension, maxBy;
import 'package:crypto/crypto.dart';
import 'package:http/http.dart' as http;
import 'package:meta/meta.dart';
import 'package:path/path.dart' as p;
import 'package:pub_semver/pub_semver.dart';
import 'package:stack_trace/stack_trace.dart';
import '../authentication/client.dart';
import '../crc32c.dart';
import '../exceptions.dart';
import '../http.dart';
import '../io.dart';
import '../language_version.dart';
import '../log.dart' as log;
import '../package.dart';
import '../package_name.dart';
import '../pubspec.dart';
import '../rate_limited_scheduler.dart';
import '../source.dart';
import '../system_cache.dart';
import '../utils.dart';
import 'cached.dart';
import 'root.dart';
const contentHashesDocumentationUrl = 'https://dart.dev/go/content-hashes';
/// Validates and normalizes a [hostedUrl] which is pointing to a pub server.
///
/// A [hostedUrl] is a URL pointing to a _hosted pub server_ as defined by the
/// [repository-spec-v2][1]. The default value is `pub.dev`, and can be
/// overwritten using `PUB_HOSTED_URL`. It can also specified for individual
/// hosted-dependencies in `pubspec.yaml`, and for the root package using the
/// `publish_to` key.
///
/// The [hostedUrl] is always normalized to a [Uri] with path that ends in slash
/// unless the path is merely `/`, in which case we normalize to the bare
/// domain.
///
/// We change `https://pub.dartlang.org` to `https://pub.dev`, this maintains
/// backwards compatibility with `pubspec.lock`-files which contain
/// `https://pub.dartlang.org`.
///
/// Throws [FormatException] if there is anything wrong with [hostedUrl].
///
/// [1]: ../../../doc/repository-spec-v2.md
Uri validateAndNormalizeHostedUrl(String hostedUrl) {
Uri u;
try {
u = Uri.parse(hostedUrl);
} on FormatException catch (e) {
throw FormatException(
'invalid url: ${e.message}',
e.source,
e.offset,
);
}
if (!u.hasScheme || (u.scheme != 'http' && u.scheme != 'https')) {
throw FormatException('url scheme must be https:// or http://', hostedUrl);
}
if (!u.hasAuthority || u.host == '') {
throw FormatException('url must have a hostname', hostedUrl);
}
if (u.userInfo != '') {
throw FormatException('user-info is not supported in url', hostedUrl);
}
if (u.hasQuery) {
throw FormatException('querystring is not supported in url', hostedUrl);
}
if (u.hasFragment) {
throw FormatException('fragment is not supported in url', hostedUrl);
}
u = u.normalizePath();
// If we have a path of only `/`
if (u.path == '/') {
u = u.replace(path: '');
}
// If there is a path, and it doesn't end in a slash we normalize to slash
if (u.path.isNotEmpty && !u.path.endsWith('/')) {
u = u.replace(path: '${u.path}/');
}
// pub.dev and pub.dartlang.org are identical.
//
// We rewrite here to avoid caching both, and to avoid having different
// credentials for these two.
//
// Changing this to pub.dev raises the following concerns:
//
// 1. It would blow through users caches.
// 2. It would cause conflicts for users checking pubspec.lock into git, if
// using different versions of the dart-sdk / pub client.
// 3. It might cause other problems (investigation needed) for pubspec.lock
// across different versions of the dart-sdk / pub client.
// 4. It would expand the API surface we're committed to supporting
// long-term.
//
// Clearly, a bit of investigation is necessary before we update this to
// pub.dev, it might be attractive to do next time we change the server API.
if (u == Uri.parse('https://pub.dartlang.org')) {
log.fine('Using https://pub.dev instead of https://pub.dartlang.org.');
u = Uri.parse('https://pub.dev');
}
if (runningFromTest &&
u == Uri.parse('https://pub.dev') &&
Platform.environment.containsKey('_PUB_TEST_DEFAULT_HOSTED_URL')) {
u = Uri.parse(Platform.environment['_PUB_TEST_DEFAULT_HOSTED_URL']!);
}
return u;
}
/// A package source that gets packages from a package hosting site that uses
/// the same API as pub.dev.
class HostedSource extends CachedSource {
static HostedSource instance = HostedSource._();
HostedSource._();
@override
final name = 'hosted';
@override
final hasMultipleVersions = true;
static String pubDevUrl = 'https://pub.dev';
static String pubDartlangUrl = 'https://pub.dartlang.org';
static bool isPubDevUrl(String url) {
final parsedUrl = Uri.parse(url);
if (parsedUrl.scheme != 'http' && parsedUrl.scheme != 'https') {
// A non http(s) url is not pub.dev.
return false;
}
if (parsedUrl.host.isEmpty) {
// The empty host is not pub.dev.
return false;
}
final origin = parsedUrl.origin;
// Allow the defaultHostedUrl to be overriden when running from tests
if (runningFromTest &&
io.Platform.environment['_PUB_TEST_DEFAULT_HOSTED_URL'] != null) {
return origin == io.Platform.environment['_PUB_TEST_DEFAULT_HOSTED_URL'];
}
return origin == pubDevUrl || origin == pubDartlangUrl;
}
static bool isFromPubDev(PackageId id) {
final description = id.description.description;
return description is HostedDescription && isPubDevUrl(description.url);
}
/// Gets the default URL for the package server for hosted dependencies.
late final String defaultUrl = () {
// Changing this to pub.dev raises the following concerns:
//
// 1. It would blow through users caches.
// 2. It would cause conflicts for users checking pubspec.lock into git, if
// using different versions of the dart-sdk / pub client.
// 3. It might cause other problems (investigation needed) for pubspec.lock
// across different versions of the dart-sdk / pub client.
// 4. It would expand the API surface we're committed to supporting
// long-term.
//
// Clearly, a bit of investigation is necessary before we update this to
// pub.dev, it might be attractive to do next time we change the server API.
try {
var defaultHostedUrl = 'https://pub.dev';
// Allow the defaultHostedUrl to be overriden when running from tests
if (runningFromTest) {
defaultHostedUrl =
io.Platform.environment['_PUB_TEST_DEFAULT_HOSTED_URL'] ??
defaultHostedUrl;
}
return validateAndNormalizeHostedUrl(
io.Platform.environment['PUB_HOSTED_URL'] ?? defaultHostedUrl,
).toString();
} on FormatException catch (e) {
throw ConfigException(
'Invalid `PUB_HOSTED_URL="${e.source}"`: ${e.message}',
);
}
}();
/// Whether extra metadata headers should be sent for HTTP requests to a given
/// [url].
static bool shouldSendAdditionalMetadataFor(Uri url) {
if (runningFromTest && Platform.environment.containsKey('PUB_HOSTED_URL')) {
if (url.origin != Platform.environment['PUB_HOSTED_URL']) {
return false;
}
} else {
if (!HostedSource.isPubDevUrl(url.toString())) return false;
}
if (Platform.environment.containsKey('CI') &&
Platform.environment['CI'] != 'false') {
return false;
}
return true;
}
/// Returns a reference to a hosted package named [name].
///
/// If [url] is passed, it's the URL of the pub server from which the package
/// should be downloaded. [url] will be normalized and validated using
/// [validateAndNormalizeHostedUrl]. This can throw a [FormatException].
PackageRef refFor(String name, {String? url}) {
final d = HostedDescription(name, url ?? defaultUrl);
return PackageRef(name, d);
}
/// Ensures that [description] is a valid hosted package description.
///
/// Simple hosted dependencies only consist of a plain string, which is
/// resolved against the default host. In this case, [description] will be
/// null.
///
/// Hosted dependencies may also specify a custom host from which the package
/// is fetched. There are two syntactic forms of those dependencies:
///
/// 1. With an url and an optional name in a map: `hosted: {url: <url>}`
/// 2. With a direct url: `hosted: <url>`
@override
PackageRef parseRef(
String name,
Object? description, {
required Description containingDescription,
required LanguageVersion languageVersion,
}) {
return PackageRef(
name,
_parseDescription(name, description, languageVersion),
);
}
@override
PackageId parseId(
String name,
Version version,
Object? description, {
String? containingDir,
}) {
// Old pub versions only wrote `description: <pkg>` into the lock file.
if (description is String) {
if (description != name) {
throw const FormatException(
'The description should be the same as the name',
);
}
return PackageId(
name,
version,
ResolvedHostedDescription(
HostedDescription(name, defaultUrl),
sha256: null,
),
);
}
if (description is! Map) {
throw const FormatException(
'The description should be a string or a map.',
);
}
final url = description['url'];
if (url is! String) {
throw const FormatException('The url should be a string.');
}
final sha256 = description['sha256'];
if (sha256 != null && sha256 is! String) {
throw const FormatException('The sha256 should be a string.');
}
final foundName = description['name'];
if (foundName is! String) {
throw const FormatException('The name should be a string.');
}
if (foundName != name) {
throw FormatException('The name should be $name');
}
return PackageId(
name,
version,
ResolvedHostedDescription(
HostedDescription(name, url),
sha256: _parseContentHash(sha256 as String?),
),
);
}
/// Decodes a sha256 hash from a lock-file or package-listing.
/// It is expected to be a hex-encoded String of length 64.
///
/// Throws a [FormatException] if the string cannot be decoded.
Uint8List? _parseContentHash(String? encoded) {
if (encoded == null) return null;
if (encoded.length != 64) {
throw const FormatException('Content-hash has incorrect length');
}
try {
return hexDecode(encoded);
} on FormatException catch (e) {
return throw FormatException(
'Badly formatted content-hash: ${e.message}',
);
}
}
/// Parses the description for a package.
///
/// If the package parses correctly, this returns a (name, url) pair. If not,
/// this throws a descriptive FormatException.
HostedDescription _parseDescription(
String packageName,
Object? description,
LanguageVersion languageVersion,
) {
if (description == null) {
// Simple dependency without a `hosted` block, use the default server.
return HostedDescription(packageName, defaultUrl);
}
final canUseShorthandSyntax = languageVersion.supportsShorterHostedSyntax;
if (description is String) {
// Old versions of pub (pre Dart 2.15) interpret `hosted: foo` as
// `hosted: {name: foo, url: <default>}`.
// For later versions, we treat it as `hosted: {name: <inferred>,
// url: foo}` if a user opts in by raising their min SDK environment.
//
// Since the old behavior is very rarely used and we want to show a
// helpful error message if the new syntax is used without raising the SDK
// environment, we throw an error if something that looks like a URI is
// used as a package name.
if (canUseShorthandSyntax) {
return HostedDescription(packageName, description);
} else {
if (_looksLikePackageName.hasMatch(description)) {
// Valid use of `hosted: package` dependency with an old SDK
// environment.
return HostedDescription(description, defaultUrl);
} else {
const shorterSyntaxVersion =
LanguageVersion.firstVersionWithShorterHostedSyntax;
throw FormatException(
'Using `hosted: <url>` is only supported with a minimum SDK '
'constraint of $shorterSyntaxVersion.',
);
}
}
}
if (description is! Map) {
throw const FormatException(
'The description must be a package name or map.',
);
}
var name = description['name'];
if (canUseShorthandSyntax) name ??= packageName;
if (name is! String) {
const shorterSyntaxVersion =
LanguageVersion.firstVersionWithShorterHostedSyntax;
throw FormatException(
"The 'name' key must have a string value without "
'a minimum Dart SDK constraint of $shorterSyntaxVersion.0 or higher.',
);
}
final u = description['url'];
if (u != null && u is! String) {
throw const FormatException("The 'url' key must be a string value.");
}
final url = u ?? defaultUrl;
return HostedDescription(name, url as String);
}
static final RegExp _looksLikePackageName =
RegExp(r'^[a-zA-Z_]+[a-zA-Z0-9_]*$');
late final RateLimitedScheduler<_RefAndCache, List<_VersionInfo>> _scheduler =
RateLimitedScheduler(
_fetchVersions,
maxConcurrentOperations: 10,
);
List<_VersionInfo> _versionInfoFromPackageListing(
Map body,
PackageRef ref,
Uri location,
SystemCache cache,
) {
final description = ref.description;
if (description is! HostedDescription) {
throw ArgumentError('Wrong source');
}
final versions = body['versions'];
if (versions is! List) {
throw const FormatException('versions must be a list');
}
return versions.map((map) {
if (map is! Map) {
throw const FormatException('versions list element must be a map');
}
final pubspecData = map['pubspec'];
if (pubspecData is! Map) {
throw const FormatException('pubspec must be a map');
}
final pubspec = Pubspec.fromMap(
pubspecData,
cache.sources,
expectedName: ref.name,
location: location,
containingDescription: description,
);
final archiveSha256 = map['archive_sha256'];
if (archiveSha256 != null && archiveSha256 is! String) {
throw const FormatException('archive_sha256 must be a String');
}
final archiveUrl = map['archive_url'];
if (archiveUrl is! String) {
throw const FormatException('archive_url must be a String');
}
final isDiscontinued = body['isDiscontinued'] ?? false;
if (isDiscontinued is! bool) {
throw const FormatException('isDiscontinued must be a bool');
}
final replacedBy = body['replacedBy'];
if (replacedBy is! String?) {
throw const FormatException('replacedBy must be a String');
}
final retracted = map['retracted'] ?? false;
if (retracted is! bool) {
throw const FormatException('retracted must be a bool');
}
DateTime? advisoriesDate;
final advisoriesUpdated = body['advisoriesUpdated'];
if (advisoriesUpdated != null) {
if (advisoriesUpdated is! String) {
throw const FormatException('advisoriesUpdated must be a String');
}
advisoriesDate = DateTime.parse(advisoriesUpdated);
}
final status = PackageStatus(
isDiscontinued: isDiscontinued,
discontinuedReplacedBy: replacedBy,
isRetracted: retracted,
advisoriesUpdated: advisoriesDate,
);
return _VersionInfo(
pubspec.version,
pubspec,
Uri.parse(archiveUrl),
status,
_parseContentHash(archiveSha256 as String?),
);
}).toList();
}
Future<List<_VersionInfo>> _fetchVersionsNoPrefetching(
PackageRef ref,
SystemCache cache,
) async {
final description = ref.description;
if (description is! HostedDescription) {
throw ArgumentError('Wrong source');
}
final packageName = description.packageName;
final hostedUrl = description.url;
final url = _listVersionsUrl(ref);
log.io('Get versions from $url.');
final String bodyText;
final dynamic body;
final List<_VersionInfo> result;
try {
// TODO(sigurdm): Implement cancellation of requests. This probably
// requires resolution of: https://github.com/dart-lang/http/issues/424.
bodyText = await withAuthenticatedClient(cache, Uri.parse(hostedUrl),
(client) async {
return await retryForHttp(
'fetching versions for "$packageName" from "$url"', () async {
final request = http.Request('GET', url);
request.attachPubApiHeaders();
request.attachMetadataHeaders();
final response = await client.fetch(request);
return response.body;
});
});
final decoded = jsonDecode(bodyText);
if (decoded is! Map<String, dynamic>) {
throw const FormatException('version listing must be a mapping');
}
body = decoded;
result = _versionInfoFromPackageListing(
body as Map<String, dynamic>,
ref,
url,
cache,
);
} on Exception catch (error, stackTrace) {
_throwFriendlyError(error, stackTrace, packageName, hostedUrl);
}
// Cache the response on disk.
// Don't cache overly big responses.
if (bodyText.length < 1000 * 1024) {
await _cacheVersionListingResponse(body, ref, cache);
}
return result;
}
Future<List<_VersionInfo>> _fetchVersions(_RefAndCache refAndCache) async {
final ref = refAndCache.ref;
final description = ref.description;
if (description is! HostedDescription) {
throw ArgumentError('Wrong source');
}
final preschedule =
Zone.current[_prefetchingKey] as void Function(_RefAndCache)?;
/// Prefetch the dependencies of the latest version, we are likely to need
/// them later.
void prescheduleDependenciesOfLatest(
List<_VersionInfo>? listing,
SystemCache cache,
) {
if (listing == null || listing.isEmpty) return;
final latestVersion =
maxBy<_VersionInfo, Version>(listing, (e) => e.version)!;
final dependencies = latestVersion.pubspec.dependencies.values;
unawaited(
withDependencyType(DependencyType.none, () async {
for (final packageRange in dependencies) {
if (packageRange.source is HostedSource) {
preschedule!(_RefAndCache(packageRange.toRef(), cache));
}
}
}),
);
}
final cache = refAndCache.cache;
if (preschedule != null) {
/// If we have a cached response - preschedule dependencies of that.
prescheduleDependenciesOfLatest(
await _cachedVersionListingResponse(ref, cache),
cache,
);
}
final result = await _fetchVersionsNoPrefetching(ref, cache);
if (preschedule != null) {
// Preschedule the dependencies from the actual response.
// This might overlap with those from the cached response. But the
// scheduler ensures each listing will be fetched at most once.
prescheduleDependenciesOfLatest(result, cache);
}
return result;
}
Future<List<Advisory>?> _fetchAdvisories(
PackageRef ref,
SystemCache cache,
) async {
final description = ref.description;
if (description is! HostedDescription) {
throw ArgumentError('Wrong source');
}
final packageName = description.packageName;
final hostedUrl = description.url;
final url = _listAdvisoriesUrl(ref);
log.io('Fetching security advisories from $url.');
final String bodyText;
final Map<String, dynamic> body;
final List<Advisory>? result;
try {
bodyText = await withAuthenticatedClient(cache, Uri.parse(hostedUrl),
(client) async {
return await retryForHttp(
'fetching advisories for "$packageName" from "$url"', () async {
final request = http.Request('GET', url);
request.attachPubApiHeaders();
request.attachMetadataHeaders();
final response = await client.fetch(request);
return response.body;
});
});
final decoded = jsonDecode(bodyText);
if (decoded is! Map<String, dynamic>) {
throw const FormatException('security advisories must be a mapping');
}
body = decoded;
result = _extractAdvisoryDetailsForPackage(decoded, ref.name);
} on FormatException catch (error, stackTrace) {
log.warning(
'Failed to decode advisories for $packageName from $hostedUrl.\n'
'$error\n'
'${Chain.forTrace(stackTrace)}');
return null;
} on PubHttpResponseException catch (error, stackTrace) {
if (isPubDevUrl(hostedUrl)) {
fail(
'Failed to fetch advisories for "$packageName" from "$hostedUrl".\n',
error,
stackTrace,
);
} else {
log.warning(
'Warning: Unable to fetch advisories for "$packageName" '
'from "$hostedUrl".\n',
);
}
return null;
}
// Cache the response on disk.
// Don't cache overly big responses.
if (bodyText.length < 5000 * 1024) {
await _cacheAdvisoriesResponse(body, ref, cache);
}
return result;
}
/// Extracts relevant details from [body] about advisories affecting the
/// package named [packageName]. The details are used when generating output
/// for runs such as `dart pub upgrade`.
List<Advisory>? _extractAdvisoryDetailsForPackage(
Map body,
String packageName,
) {
final advisoriesList = <Advisory>[];
final advisories = body['advisories'];
if (advisories is! List) {
throw const FormatException('advisories must be a list');
}
final advisoriesUpdated = body['advisoriesUpdated'];
if (advisoriesUpdated is! String) {
throw const FormatException('advisoriesUpdated must be a String');
}
for (final advisory in advisories) {
if (advisory is! Map) {
throw const FormatException('advisory must be a map');
}
final databaseSpecific = advisory['database_specific'];
if (databaseSpecific is! Map?) {
throw const FormatException('database_specific must be a map or null');
}
final pubDisplayUrl = databaseSpecific?['pub_display_url'];
if (pubDisplayUrl is! String?) {
throw const FormatException('pub_display_url must be a String or null');
}
final id = advisory['id'];
if (id is! String) {
throw const FormatException('id must be a String');
}
final summary = advisory['summary'];
if (summary is! String) {
throw const FormatException('summary must be a String');
}
final aliasIDs = <String>[];
final aliases = advisory['aliases'];
if (aliases is! List) {
throw const FormatException('aliases must be a list');
}
for (final id in aliases) {
if (id is! String) {
throw const FormatException('alias IDs must be a string');
}
aliasIDs.add(id);
}
final affectedPackages = advisory['affected'];
if (affectedPackages is! List) {
throw const FormatException('affectedPackages must be a list');
}
bool matchesNameAndEcosystem(
dynamic affectedPackage,
String name,
String ecosystem,
) {
if (affectedPackage is! Map) {
throw const FormatException('`affected` must be a map');
}
final package = affectedPackage['package'];
if (package is! Map) {
throw const FormatException('`package` must be a map');
}
final affectedName = package['name'];
if (affectedName is! String) {
throw const FormatException('package name must be a String');
}
if (affectedName == name) {
final affectedEcosystem = package['ecosystem'];
if (affectedEcosystem is! String) {
throw const FormatException('ecosystem must be a String');
}
return affectedEcosystem.toLowerCase() == ecosystem;
}
return false;
}
for (final affectedPackage in affectedPackages) {
if (affectedPackage is! Map) {
throw const FormatException('`affected` must be a list of maps');
}
if (matchesNameAndEcosystem(affectedPackage, packageName, 'pub')) {
final affectedVersions = <String>{};
final versions = affectedPackage['versions'];
if (versions is! List) {
throw const FormatException('package versions must be a list');
}
for (final v in versions) {
if (v is! String) {
throw const FormatException(
'package version elements must be a string',
);
}
affectedVersions.add(v);
}
advisoriesList.add(
Advisory(
id: id,
affectedVersions: affectedVersions,
aliases: aliasIDs,
summary: summary,
pubDisplayUrl: pubDisplayUrl,
),
);
}
}
}
return advisoriesList;
}
Future<List<Advisory>?> _getAdvisories(
PackageId id,
SystemCache cache,
Duration? maxAge,
) async {
final advisoriesUpdated =
(await status(id.toRef(), id.version, cache, maxAge: maxAge))
.advisoriesUpdated;
if (advisoriesUpdated == null) return null;
Future<List<Advisory>?> readAdvisoriesFromCache() async {
final advisoriesCachePath = _advisoriesCachePath(id.toRef(), cache);
final stat = io.File(advisoriesCachePath).statSync();
if (stat.type == io.FileSystemEntityType.file) {
if (advisoriesUpdated.isAfter(stat.modified)) {
tryDeleteEntry(advisoriesCachePath);
return null;
}
try {
final doc = jsonDecode(readTextFile(advisoriesCachePath));
if (doc is! Map) {
throw const FormatException('Broken cached advisories response');
}
final cachedAdvisoriesUpdated = doc['advisoriesUpdated'];
if (cachedAdvisoriesUpdated is! String) {
throw const FormatException('Broken cached advisories response');
}
final parsedCacheAdvisoriesUpdated =
DateTime.parse(cachedAdvisoriesUpdated);
final advisoriesUpdated =
(await status(id.toRef(), id.version, cache)).advisoriesUpdated;
if (
// We could not obtain the timestamp of latest advisory update.
advisoriesUpdated == null ||
// The cached entry is too old.
advisoriesUpdated.isAfter(parsedCacheAdvisoriesUpdated)) {
tryDeleteEntry(advisoriesCachePath);
} else {
return _extractAdvisoryDetailsForPackage(doc, id.toRef().name);
}
} on io.IOException {
// Could not read the file. Delete if it exists.
tryDeleteEntry(advisoriesCachePath);
} on FormatException catch (e) {
tryDeleteEntry(advisoriesCachePath);
log.fine('Failed to read cached advisories: $e');
}
}
return null;
}
return await readAdvisoriesFromCache() ??
await _fetchAdvisories(id.toRef(), cache);
}
/// An in-memory cache to store the cached version listing loaded from
/// [_versionListingCachePath].
///
/// Invariant: Entries in this cache are the parsed version of the exact same
/// information cached on disk. I.e. if the entry is present in this cache,
/// there will not be a newer version on disk.
final Map<PackageRef, (DateTime, List<_VersionInfo>)> _responseCache = {};
/// If a cached version listing response for [ref] exists on disk and is less
/// than [maxAge] old it is parsed and returned.
///
/// Otherwise deletes a cached response if it exists and returns `null`.
///
/// If [maxAge] is not given, we will try to get the cached version no matter
/// how old it is.
Future<List<_VersionInfo>?> _cachedVersionListingResponse(
PackageRef ref,
SystemCache cache, {
Duration? maxAge,
}) async {
final cachedInfo = _responseCache[ref];
if (cachedInfo != null) {
final (cacheTimestamp, versionInfo) = cachedInfo;
final cacheAge = DateTime.now().difference(cacheTimestamp);
if (maxAge == null || maxAge > cacheAge) {
// The cached value is not too old.
return versionInfo;
}
}
final cachePath = _versionListingCachePath(ref, cache);
final stat = io.File(cachePath).statSync();
final now = DateTime.now();
if (stat.type == io.FileSystemEntityType.file) {
if (maxAge == null || now.difference(stat.modified) < maxAge) {
try {
final cachedDoc = jsonDecode(readTextFile(cachePath));
if (cachedDoc is! Map) {
throw const FormatException(
'Broken cached version listing response',
);
}
final timestamp = cachedDoc['_fetchedAt'];
if (timestamp is! String) {
throw const FormatException(
'Broken cached version listing response',
);
}
final parsedTimestamp = DateTime.parse(timestamp);
final cacheAge = DateTime.now().difference(parsedTimestamp);
if (maxAge != null && cacheAge > maxAge) {
// Too old according to internal timestamp - delete.
tryDeleteEntry(cachePath);
} else {
final res = _versionInfoFromPackageListing(
cachedDoc,
ref,
Uri.file(cachePath),
cache,
);
_responseCache[ref] = (parsedTimestamp, res);
return res;
}
} on io.IOException {
// Could not read the file. Delete if it exists.
tryDeleteEntry(cachePath);
} on FormatException {
// Decoding error - bad file or bad timestamp. Delete the file.
tryDeleteEntry(cachePath);
}
} else {
// File too old
tryDeleteEntry(cachePath);
}
}
return null;
}
Future<void> _cacheAdvisoriesResponse(
Map<String, dynamic> body,
PackageRef ref,
SystemCache cache,
) async {
final path = _advisoriesCachePath(ref, cache);
try {
ensureDir(p.dirname(path));
writeTextFile(
path,
jsonEncode(
<String, dynamic>{
...body,
},
),
);
} on io.IOException catch (e) {
// Not being able to write this cache is not fatal. Just move on...
log.fine('Failed writing cache file. $e');
}
}
/// Saves the (decoded) response from package-listing of [ref].
Future<void> _cacheVersionListingResponse(
Map<String, dynamic> body,
PackageRef ref,
SystemCache cache,
) async {
final path = _versionListingCachePath(ref, cache);
try {
ensureDir(p.dirname(path));
await writeTextFileAsync(
path,
jsonEncode(
<String, dynamic>{
...body,
'_fetchedAt': DateTime.now().toIso8601String(),
},
),
);
// Delete the entry in the in-memory cache to maintain the invariant that
// cached information in memory is the same as that on the disk.
_responseCache.remove(ref);
} on io.IOException catch (e) {
// Not being able to write this cache is not fatal. Just move on...
log.fine('Failed writing cache file. $e');
}
}
@override
Future<PackageStatus> status(
PackageRef ref,
Version version,
SystemCache cache, {
Duration? maxAge,
}) async {
// If we don't have the specific version we return the empty response, since
// it is more or less harmless..
//
// This can happen if the connection is broken, or the server is faulty.
// We want to avoid a crash
//
// TODO(sigurdm): Consider representing the non-existence of the
// package-version in the return value.
return (await _versionInfo(ref, version, cache, maxAge: maxAge))?.status ??
PackageStatus();
}
Future<_VersionInfo?> _versionInfo(
PackageRef ref,
Version version,
SystemCache cache, {
Duration? maxAge,
}) async {
if (cache.isOffline) {
// Do we have a cached version response on disk?
final versionListing = await _cachedVersionListingResponse(ref, cache);
if (versionListing == null) {
return null;
}
return versionListing.firstWhereOrNull((l) => l.version == version);
}
// Did we already get info for this package?
var versionListing = _scheduler.peek(_RefAndCache(ref, cache));
if (maxAge != null) {
// Do we have a cached version response on disk?
versionListing ??=
await _cachedVersionListingResponse(ref, cache, maxAge: maxAge);
}
// Otherwise retrieve the info from the host.
versionListing ??= await _scheduler
.schedule(_RefAndCache(ref, cache))
// Failures retrieving the listing here should just be ignored.
.catchError(
(_) async => <_VersionInfo>[],
test: (error) => error is Exception,
);
return versionListing.firstWhereOrNull((l) => l.version == version);
}