feat: add --all flag to list and delete, --all-but-latest to delete; (#341)

* feat: add --all flag to list and delete, --all-but-latest to delete;

* changeset

Author: thymikee

.changeset/bright-rabbits-bathe.md

@@ -0,0 +1,6 @@
+---
+'@rnef/tools': patch
+'@rnef/cli': patch
+---
+
+feat: add --all flag to list and delete, --all-but-latest to delete

packages/cli/src/lib/plugins/remoteCache.ts

@@ -18,6 +18,8 @@ type Flags = {
   traits?: string[];
   name?: string;
   json?: boolean;
+  all?: boolean;
+  allButLatest?: boolean;
 };
 
 async function remoteCache({
@@ -55,14 +57,26 @@ async function remoteCache({
 
   switch (action) {
     case 'list': {
-      const artifacts = await remoteBuildCache.list({ artifactName });
-      const artifact = artifacts[0];
-      if (artifact) {
+      const artifacts = await remoteBuildCache.list({
+        artifactName,
+        limit: args.all ? undefined : 1,
+      });
+      if (artifacts.length > 0 && !args.all) {
+        const artifact = artifacts[0];
         if (isJsonOutput) {
           console.log(JSON.stringify(artifact, null, 2));
         } else {
           logger.log(`- name: ${artifact.name}
-  - url: ${artifact.url}`);
+- url: ${artifact.url}`);
+        }
+      } else if (artifacts.length > 0 && args.all) {
+        if (isJsonOutput) {
+          console.log(JSON.stringify(artifacts, null, 2));
+        } else {
+          artifacts.forEach((artifact) => {
+            logger.log(`- name: ${artifact.name}
+- url: ${artifact.url}`);
+          });
         }
       }
       break;
@@ -117,7 +131,11 @@ async function remoteCache({
       break;
     }
     case 'delete': {
-      const deletedArtifacts = await remoteBuildCache.delete({ artifactName });
+      const deletedArtifacts = await remoteBuildCache.delete({
+        artifactName,
+        limit: args.all || args.allButLatest ? undefined : 1,
+        skipLatest: args.allButLatest,
+      });
       if (isJsonOutput) {
         console.log(JSON.stringify(deletedArtifacts, null, 2));
       } else {
@@ -144,6 +162,10 @@ function validateArgs(args: Flags, action: string) {
       'Action is required. Available actions: list, list-all, download, upload, delete'
     );
   }
+  if (action === 'list-all') {
+    // return early as we don't need to validate name or platform to list all artifacts
+    return;
+  }
   if (args.name && (args.platform || args.traits)) {
     throw new RnefError(
       'Cannot use "--name" together with "--platform" or "--traits". Use either name or platform with traits'
@@ -193,6 +215,16 @@ export const remoteCachePlugin =
           name: '--name <string>',
           description: 'Full artifact name',
         },
+        {
+          name: '--all',
+          description:
+            'List or delete all matching artifacts. Affects "list" and "delete" actions only',
+        },
+        {
+          name: '--all-but-latest',
+          description:
+            'Delete all but the latest matching artifact. Affects "delete" action only',
+        },
         {
           name: '-p, --platform <string>',
           description: 'Select platform, e.g. ios or android',

packages/tools/src/lib/build-cache/common.ts

@@ -49,11 +49,21 @@ export interface RemoteBuildCache {
 
   /**
    * Delete a remote artifact
-   * @param artifact - Remote artifact to delete, as returned by `list` method
+   * @param artifactName - Name of the artifact to delete, e.g. `rnef-android-debug-1234567890` for android in debug variant
+   * @param limit - Optional maximum number of artifacts to delete
+   * @param skipLatest - Optional flag to skip the latest artifact, helpful when deleting all but the latest artifact
    * @returns Array of deleted artifacts
    * @throws {Error} Throws if artifact is not found or deletion fails
    */
-  delete({ artifactName }: { artifactName: string }): Promise<RemoteArtifact[]>;
+  delete({
+    artifactName,
+    limit,
+    skipLatest,
+  }: {
+    artifactName: string;
+    limit?: number;
+    skipLatest?: boolean;
+  }): Promise<RemoteArtifact[]>;
 
   /**
    * Upload a local artifact stored in build cache to remote storage

packages/tools/src/lib/build-cache/github/GitHubBuildCache.ts

@@ -67,19 +67,28 @@ export class GitHubBuildCache implements RemoteBuildCache {
 
   async delete({
     artifactName,
+    limit,
+    skipLatest,
   }: {
     artifactName: string;
+    limit?: number;
+    skipLatest?: boolean;
   }): Promise<RemoteArtifact[]> {
     const repoDetails = await this.getRepoDetails();
     const artifacts = await fetchGitHubArtifactsByName(
       artifactName,
       repoDetails,
-      undefined
+      limit
     );
     if (artifacts.length === 0) {
       throw new Error(`No artifact found with name "${artifactName}"`);
     }
-    return await deleteGitHubArtifacts(artifacts, repoDetails, artifactName);
+    const [, ...rest] = artifacts;
+    return await deleteGitHubArtifacts(
+      skipLatest ? rest : artifacts,
+      repoDetails,
+      artifactName
+    );
   }
 
   async upload(): Promise<RemoteArtifact> {