feat: support force updating to latest version

MetaMask · May 16, 2024 · 6a2ed05 · 6a2ed05
1 parent ef34b5d
commit 6a2ed05
Show file tree

Hide file tree

Showing 7 changed files with 99 additions and 10 deletions.
diff --git a/packages/snaps-controllers/src/snaps/SnapController.test.tsx b/packages/snaps-controllers/src/snaps/SnapController.test.tsx
@@ -6439,6 +6439,59 @@ describe('SnapController', () => {
       controller.destroy();
     });
 
+    it('updates to latest when latest version is specified', async () => {
+      const { manifest } = await getMockSnapFilesWithUpdatedChecksum({
+        manifest: getSnapManifest({
+          version: '1.1.0' as SemVerVersion,
+        }),
+      });
+
+      const location = new LoopbackLocation({
+        manifest: manifest.result,
+      });
+
+      location.resolveVersion.mockImplementation(
+        async () => '1.1.0' as SemVerRange,
+      );
+
+      const messenger = getSnapControllerMessenger();
+      const controller = getSnapController(
+        getSnapControllerOptions({
+          messenger,
+          state: {
+            snaps: getPersistedSnapsState(),
+          },
+          detectSnapLocation: loopbackDetect(location),
+        }),
+      );
+
+      const result = await controller.installSnaps(MOCK_ORIGIN, {
+        [MOCK_SNAP_ID]: { version: 'latest' },
+      });
+
+      const newSnapTruncated = controller.getTruncated(MOCK_SNAP_ID);
+
+      const newSnap = controller.get(MOCK_SNAP_ID);
+
+      expect(result[MOCK_SNAP_ID]).toStrictEqual(newSnapTruncated);
+      expect(newSnap?.version).toBe('1.1.0');
+      expect(newSnap?.versionHistory).toStrictEqual([
+        {
+          origin: MOCK_ORIGIN,
+          version: '1.0.0',
+          date: expect.any(Number),
+        },
+        {
+          origin: MOCK_ORIGIN,
+          version: '1.1.0',
+          date: expect.any(Number),
+        },
+      ]);
+      expect(newSnap?.status).toBe(SnapStatus.Running);
+
+      controller.destroy();
+    });
+
     it('requests approval for new and already approved permissions and revoke unused permissions', async () => {
       const rootMessenger = getControllerMessenger();
       const messenger = getSnapControllerMessenger(rootMessenger);

diff --git a/packages/snaps-controllers/src/snaps/SnapController.ts b/packages/snaps-controllers/src/snaps/SnapController.ts
@@ -2129,6 +2129,7 @@ export class SnapController extends BaseController<
         // Existing snaps may need to be updated, unless they should be re-installed (e.g. local snaps)
         // Everything else is treated as an install
         const isUpdate = this.has(snapId) && !location.shouldAlwaysReload;
+        const forceLatest = rawVersion === 'latest';
 
         if (isUpdate && this.#isValidUpdate(snapId, version)) {
           const existingSnap = this.getExpect(snapId);
@@ -2148,7 +2149,7 @@ export class SnapController extends BaseController<
           origin,
           snapId,
           location,
-          version,
+          forceLatest && isUpdate ? await location.resolveVersion() : version,
         );
       }
 

diff --git a/packages/snaps-controllers/src/snaps/location/http.ts b/packages/snaps-controllers/src/snaps/location/http.ts
@@ -7,6 +7,7 @@ import {
   normalizeRelative,
   parseJson,
 } from '@metamask/snaps-utils';
+import type { SemVerRange } from '@metamask/utils';
 import { assert, assertStruct } from '@metamask/utils';
 
 import type { SnapLocation } from './location';
@@ -109,6 +110,10 @@ export class HttpLocation implements SnapLocation {
     return this.fetch(relativePath);
   }
 
+  async resolveVersion(): Promise<SemVerRange> {
+    return '*' as SemVerRange;
+  }
+
   get root(): URL {
     return new URL(this.url);
   }

diff --git a/packages/snaps-controllers/src/snaps/location/local.ts b/packages/snaps-controllers/src/snaps/location/local.ts
@@ -1,5 +1,6 @@
 import type { SnapManifest, VirtualFile } from '@metamask/snaps-utils';
 import { LocalSnapIdStruct, SnapIdPrefixes } from '@metamask/snaps-utils';
+import type { SemVerRange } from '@metamask/utils';
 import { assert, assertStruct } from '@metamask/utils';
 
 import type { HttpOptions } from './http';
@@ -33,6 +34,10 @@ export class LocalLocation implements SnapLocation {
     return convertCanonical(await this.#http.fetch(path));
   }
 
+  async resolveVersion(): Promise<SemVerRange> {
+    return '*' as SemVerRange;
+  }
+
   get shouldAlwaysReload() {
     return true;
   }

diff --git a/packages/snaps-controllers/src/snaps/location/location.ts b/packages/snaps-controllers/src/snaps/location/location.ts
@@ -23,6 +23,8 @@ export interface SnapLocation {
   manifest(): Promise<VirtualFile<SnapManifest>>;
   fetch(path: string): Promise<VirtualFile>;
 
+  resolveVersion(): Promise<SemVerRange>;
+
   readonly shouldAlwaysReload?: boolean;
 }
 

diff --git a/packages/snaps-controllers/src/snaps/location/npm.ts b/packages/snaps-controllers/src/snaps/location/npm.ts
@@ -54,6 +54,11 @@ export interface NpmOptions {
 export abstract class BaseNpmLocation implements SnapLocation {
   protected readonly meta: NpmMeta;
 
+  #resolvedPackage: {
+    tarballURL: string;
+    targetVersion: SemVerVersion;
+  } | null = null;
+
   #validatedManifest?: VirtualFile<SnapManifest>;
 
   #files?: Map<string, VirtualFile>;
@@ -165,18 +170,32 @@ export abstract class BaseNpmLocation implements SnapLocation {
     return this.meta.requestedRange;
   }
 
+  async resolveVersion(): Promise<SemVerRange> {
+    if (!this.#resolvedPackage) {
+      const resolvedVersion = await this.meta.resolveVersion(
+        this.meta.requestedRange,
+      );
+
+      const resolved = await resolveNpmVersion(
+        this.meta.packageName,
+        resolvedVersion,
+        this.meta.registry,
+        this.meta.fetch,
+      );
+
+      this.#resolvedPackage = resolved;
+    }
+
+    return this.#resolvedPackage.targetVersion as unknown as SemVerRange;
+  }
+
   async #lazyInit() {
     assert(this.#files === undefined);
-    const resolvedVersion = await this.meta.resolveVersion(
-      this.meta.requestedRange,
-    );
 
-    const { tarballURL, targetVersion } = await resolveNpmVersion(
-      this.meta.packageName,
-      resolvedVersion,
-      this.meta.registry,
-      this.meta.fetch,
-    );
+    const targetVersion = await this.resolveVersion();
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const { tarballURL } = this.#resolvedPackage!;
 
     if (!isValidUrl(tarballURL) || !tarballURL.toString().endsWith('.tgz')) {
       throw new Error(

diff --git a/packages/snaps-controllers/src/test-utils/location.ts b/packages/snaps-controllers/src/test-utils/location.ts
@@ -146,6 +146,10 @@ export class LoopbackLocation implements SnapLocation {
     );
     return file;
   });
+
+  resolveVersion = jest.fn(async () => {
+    return '*' as SemVerRange;
+  });
   /* eslint-enable @typescript-eslint/require-await */
 
   get shouldAlwaysReload() {