Exporting the per-package RSS/atom feed with the rest of exported APIs. (dart-lang#8707)

Author: isoos

CHANGELOG.md

@@ -2,6 +2,7 @@ Important changes to data models, configuration, and migrations between each
 AppEngine version, listed here to ease deployment and troubleshooting.
 
 ## Next Release (replace with git tag when deployed)
+ * Note: after the release we should update the load balancer rules to also include the `/api/packages/<package>/feed.atom` URLs.
 
 ## `20250403t085600-all`
  * Bump runtimeVersion to `2025.04.01`.

app/lib/admin/actions/moderate_package.dart

@@ -79,6 +79,9 @@ Note: the action may take a longer time to complete as the public archive bucket
         return pkg;
       });
 
+      // make sure visibility cache is updated immediately
+      await purgePackageCache(package);
+
       // sync exported API(s)
       await apiExporter?.synchronizePackage(package, forceDelete: true);
 

app/lib/admin/actions/moderate_package_versions.dart

@@ -112,6 +112,9 @@ Set the moderated flag on a package version (updating the flag and the timestamp
         return v;
       });
 
+      // make sure visibility cache is updated immediately
+      await purgePackageCache(package);
+
       // sync exported API(s)
       await apiExporter?.synchronizePackage(package, forceDelete: true);
 

app/lib/frontend/handlers/atom_feed.dart

@@ -32,7 +32,7 @@ Future<shelf.Response> allPackagesAtomFeedhandler(shelf.Request request) async {
   );
 }
 
-/// Handles requests for `/packages/<package>/feed.atom`
+/// Handles requests for `/api/packages/<package>/feed.atom`
 Future<shelf.Response> packageAtomFeedhandler(
   shelf.Request request,
   String package,

app/lib/frontend/handlers/pubapi.client.dart

@@ -132,6 +132,13 @@ class PubApiClient {
     ));
   }
 
+  Future<List<int>> packageAtomFeed(String package) async {
+    return await _client.requestBytes(
+      verb: 'get',
+      path: '/api/packages/$package/feed.atom',
+    );
+  }
+
   Future<_i5.PublisherInfo> createPublisher(String publisherId) async {
     return _i5.PublisherInfo.fromJson(await _client.requestJson(
       verb: 'post',

app/lib/frontend/handlers/pubapi.dart

@@ -9,6 +9,7 @@ import 'package:_pub_shared/data/package_api.dart';
 import 'package:_pub_shared/data/publisher_api.dart';
 import 'package:_pub_shared/data/task_api.dart';
 import 'package:api_builder/api_builder.dart';
+import 'package:pub_dev/frontend/handlers/atom_feed.dart';
 import 'package:shelf/shelf.dart';
 import 'package:shelf_router/shelf_router.dart';
 
@@ -215,6 +216,11 @@ class PubApi {
   ) async =>
       await packageBackend.inviteUploader(package, invite);
 
+  /// Renders the Atom XML feed for the package.
+  @EndPoint.get('/api/packages/<package>/feed.atom')
+  Future<Response> packageAtomFeed(Request request, String package) =>
+      packageAtomFeedhandler(request, package);
+
   // ****
   // **** Publisher API
   // ****

app/lib/frontend/handlers/pubapi.g.dart

@@ -176,11 +176,6 @@ class PubSiteService {
   Future<Response> packageVersions(Request request, String package) =>
       packageVersionsListHandler(request, package);
 
-  /// Renders the Atom XML feed for the package.
-  @Route.get('/packages/<package>/feed.atom')
-  Future<Response> packageAtomFeed(Request request, String package) =>
-      packageAtomFeedhandler(request, package);
-
   @Route.get('/packages/<package>')
   Future<Response> package(Request request, String package) =>
       packageVersionHandlerHtml(request, package);

app/lib/frontend/handlers/routes.dart

@@ -244,6 +244,10 @@ final class ApiExporter {
           versionListing,
           forceWrite: forceWrite,
         );
+    await _api.package(package).feedAtomFile.write(
+          await buildPackageAtomFeedContent(package),
+          forceWrite: forceWrite,
+        );
   }
 
   /// Scan for updates from packages until [abort] is resolved, or [claim]

app/lib/frontend/handlers/routes.g.dart

@@ -273,6 +273,13 @@ final class ExportedPackage {
   ExportedJsonFile<ListAdvisoriesResponse> get advisories =>
       _suffix<ListAdvisoriesResponse>('/advisories');
 
+  /// Interface for writing `/api/packages/<package>/feed.atom`
+  ExportedAtomFeedFile get feedAtomFile => ExportedAtomFeedFile._(
+        _owner,
+        '/api/packages/$_package/feed.atom',
+        Duration(hours: 12),
+      );
+
   /// Interace for writing `/api/archives/<package>-<version>.tar.gz`.
   ExportedBlob tarball(String version) => ExportedBlob._(
         _owner,
@@ -399,6 +406,7 @@ final class ExportedPackage {
     await Future.wait([
       _owner._pool.withResource(() async => await versions.delete()),
       _owner._pool.withResource(() async => await advisories.delete()),
+      _owner._pool.withResource(() async => await feedAtomFile.delete()),
       ..._owner._prefixes.map((prefix) async {
         await _owner._listBucket(
           prefix: prefix + '/api/archives/$_package-',

app/lib/package/api_export/api_exporter.dart

@@ -135,7 +135,7 @@ String pkgArchiveDownloadUrl(String package, String version, {Uri? baseUri}) {
 }
 
 String pkgFeedUrl(String package) {
-  return '/packages/$package/feed.atom';
+  return '/api/packages/$package/feed.atom';
 }
 
 String pkgDocUrl(

app/lib/package/api_export/exported_api.dart

@@ -82,11 +82,13 @@ void main() {
         '$runtimeVersion/api/archives/oxygen-2.0.0-dev.tar.gz',
         '$runtimeVersion/api/packages/oxygen',
         '$runtimeVersion/api/packages/oxygen/advisories',
+        '$runtimeVersion/api/packages/oxygen/feed.atom',
         'latest/api/archives/oxygen-1.0.0.tar.gz',
         'latest/api/archives/oxygen-1.2.0.tar.gz',
         'latest/api/archives/oxygen-2.0.0-dev.tar.gz',
         'latest/api/packages/oxygen',
         'latest/api/packages/oxygen/advisories',
+        'latest/api/packages/oxygen/feed.atom',
       });
 
       final oxygenDataJson = data['latest/api/packages/oxygen'];

app/lib/shared/urls.dart

@@ -77,9 +77,9 @@ void main() {
     });
   });
 
-  testWithProfile('/packages/<package>/feed.atom', fn: () async {
+  testWithProfile('/api/packages/<package>/feed.atom', fn: () async {
     final content = await expectAtomXmlResponse(
-        await issueGet('/packages/oxygen/feed.atom'));
+        await issueGet('/api/packages/oxygen/feed.atom'));
     // check if content is valid XML
     final root = XmlDocument.parse(content);
     final feed = root.rootElement;
@@ -110,11 +110,11 @@ void main() {
     entries.forEach((e) => e.parent!.children.remove(e));
 
     final restExp = RegExp('<feed xmlns="http://www.w3.org/2005/Atom">\n'
-        '  <id>${activeConfiguration.primarySiteUri}/packages/oxygen/feed.atom</id>\n'
+        '  <id>${activeConfiguration.primarySiteUri}/api/packages/oxygen/feed.atom</id>\n'
         '  <title>Recently published versions of package oxygen on pub.dev</title>\n'
         '  <updated>(.*)</updated>\n'
         '  <link href="${activeConfiguration.primarySiteUri}/packages/oxygen" rel="alternate"/>\n'
-        '  <link href="${activeConfiguration.primarySiteUri}/packages/oxygen/feed.atom" rel="self"/>\n'
+        '  <link href="${activeConfiguration.primarySiteUri}/api/packages/oxygen/feed.atom" rel="self"/>\n'
         '  <generator version="0.1.0">Pub Feed Generator</generator>\n'
         '  <subtitle>oxygen is awesome</subtitle>\n'
         '(\\s*)'

app/test/admin/exported_api_sync_test.dart

@@ -131,6 +131,10 @@ Future<void> _testExportedApiSynchronization(
       await bucket.readBytes('$runtimeVersion/api/archives/foo-1.0.0.tar.gz'),
       isNotNull,
     );
+    expect(
+      await bucket.readBytes('$runtimeVersion/api/packages/foo/feed.atom'),
+      isNotNull,
+    );
     expect(
       await bucket.readGzippedJson('$runtimeVersion/api/packages/foo'),
       {
@@ -152,6 +156,10 @@ Future<void> _testExportedApiSynchronization(
       await bucket.readString('$runtimeVersion/feed.atom'),
       contains('v1.0.0 of foo'),
     );
+    expect(
+      await bucket.readString('$runtimeVersion/api/packages/foo/feed.atom'),
+      contains('v1.0.0 of foo'),
+    );
   }
 
   _log.info('## New package');
@@ -185,6 +193,10 @@ Future<void> _testExportedApiSynchronization(
       await bucket.readString('latest/feed.atom'),
       contains('v1.0.0 of foo'),
     );
+    expect(
+      await bucket.readString('latest/api/packages/foo/feed.atom'),
+      contains('v1.0.0 of foo'),
+    );
     // Note. that name completion data won't be updated until search caches
     //       are purged, so we won't test that it is updated.
 
@@ -205,6 +217,10 @@ Future<void> _testExportedApiSynchronization(
       await bucket.readString('latest/feed.atom'),
       contains('v2.0.0 of bar'),
     );
+    expect(
+      await bucket.readString('latest/api/packages/bar/feed.atom'),
+      contains('v2.0.0 of bar'),
+    );
   }
 
   _log.info('## New package version');
@@ -247,6 +263,10 @@ Future<void> _testExportedApiSynchronization(
       await bucket.readString('$runtimeVersion/feed.atom'),
       contains('v3.0.0 of bar'),
     );
+    expect(
+      await bucket.readString('latest/api/packages/bar/feed.atom'),
+      contains('v3.0.0 of bar'),
+    );
   }
 
   _log.info('## Discontinued flipped on');
@@ -424,6 +444,10 @@ Future<void> _testExportedApiSynchronization(
       await bucket.readGzippedJson('latest/api/packages/bar'),
       isNull,
     );
+    expect(
+      await bucket.readGzippedJson('latest/api/packages/feed.atom'),
+      isNull,
+    );
     expect(
       await bucket.readBytes('latest/api/archives/bar-2.0.0.tar.gz'),
       isNull,

app/test/frontend/handlers/atom_feed_test.dart

@@ -132,6 +132,13 @@ class PubApiClient {
     ));
   }
 
+  Future<List<int>> packageAtomFeed(String package) async {
+    return await _client.requestBytes(
+      verb: 'get',
+      path: '/api/packages/$package/feed.atom',
+    );
+  }
+
   Future<_i5.PublisherInfo> createPublisher(String publisherId) async {
     return _i5.PublisherInfo.fromJson(await _client.requestJson(
       verb: 'post',

app/test/package/api_export/api_exporter_test.dart

@@ -73,8 +73,8 @@ class PublicPagesScript {
       'Pub Feed Generator',
     );
     _contains(
-      await _pubClient.getContent('/packages/retry/feed.atom'),
-      '/packages/retry/feed.atom',
+      await _pubClient.getContent('/api/packages/retry/feed.atom'),
+      '/api/packages/retry/feed.atom',
     );
   }