Add test coverage

Author: FrederikBolding

packages/snaps-utils/jest.config.js

@@ -19,4 +19,7 @@ module.exports = deepmerge(baseConfig, {
     // https://github.com/facebook/jest/issues/5274
     './src/eval-worker.ts',
   ],
+
+  // This is required for `jest-fetch-mock` to work.
+  resetMocks: false,
 });

packages/snaps-utils/package.json

@@ -125,6 +125,7 @@
     "istanbul-lib-report": "^3.0.0",
     "istanbul-reports": "^3.1.5",
     "jest": "^29.0.2",
+    "jest-fetch-mock": "^3.0.3",
     "jest-silent-reporter": "^0.6.0",
     "memfs": "^3.4.13",
     "prettier": "^3.3.3",

packages/snaps-utils/src/manifest/validators/production-platform-version.test.ts

@@ -0,0 +1,110 @@
+import type { SemVerVersion } from '@metamask/utils';
+import assert from 'assert';
+import fetchMock from 'jest-fetch-mock';
+
+import { productionPlatformVersion } from './production-platform-version';
+import { getMockSnapFiles, getSnapManifest } from '../../test-utils';
+
+const MOCK_GITHUB_RESPONSE = JSON.stringify({
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  target_commitish: '5fceb7ed2ef18a3984786db1161a76ca5c8e15b9',
+});
+
+const MOCK_PACKAGE_JSON = JSON.stringify({
+  dependencies: {
+    '@metamask/snaps-sdk': '6.1.0',
+  },
+});
+
+describe('productionPlatformVersion', () => {
+  beforeAll(() => {
+    fetchMock.enableMocks();
+  });
+
+  afterAll(() => {
+    fetchMock.disableMocks();
+  });
+
+  it('reports if the version is greater than the production version', async () => {
+    fetchMock.mockResponses(MOCK_GITHUB_RESPONSE, MOCK_PACKAGE_JSON);
+
+    const report = jest.fn();
+    assert(productionPlatformVersion.semanticCheck);
+
+    await productionPlatformVersion.semanticCheck(
+      getMockSnapFiles({
+        manifest: getSnapManifest({
+          platformVersion: '6.5.0' as SemVerVersion,
+        }),
+      }),
+      { report },
+    );
+
+    expect(report).toHaveBeenCalledTimes(1);
+  });
+
+  it('does nothing if the version is less than the production version', async () => {
+    fetchMock.mockResponses(MOCK_GITHUB_RESPONSE, MOCK_PACKAGE_JSON);
+
+    const report = jest.fn();
+    assert(productionPlatformVersion.semanticCheck);
+
+    await productionPlatformVersion.semanticCheck(
+      getMockSnapFiles({
+        manifest: getSnapManifest({
+          platformVersion: '6.0.0' as SemVerVersion,
+        }),
+      }),
+      { report },
+    );
+
+    expect(report).toHaveBeenCalledTimes(0);
+  });
+
+  it('does nothing if the version is equal to the production version', async () => {
+    fetchMock.mockResponses(MOCK_GITHUB_RESPONSE, MOCK_PACKAGE_JSON);
+
+    const report = jest.fn();
+    assert(productionPlatformVersion.semanticCheck);
+
+    await productionPlatformVersion.semanticCheck(
+      getMockSnapFiles({
+        manifest: getSnapManifest({
+          platformVersion: '6.1.0' as SemVerVersion,
+        }),
+      }),
+      { report },
+    );
+
+    expect(report).toHaveBeenCalledTimes(0);
+  });
+
+  it('does nothing if the version is not set', async () => {
+    const report = jest.fn();
+    assert(productionPlatformVersion.semanticCheck);
+
+    const rawManifest = getSnapManifest();
+    delete rawManifest.platformVersion;
+
+    const files = getMockSnapFiles({
+      manifest: rawManifest,
+    });
+
+    await productionPlatformVersion.semanticCheck(files, { report });
+
+    expect(report).toHaveBeenCalledTimes(0);
+  });
+
+  it('does nothing if the request to check the production version fails', async () => {
+    fetchMock.mockResponse('', { status: 404 });
+
+    const report = jest.fn();
+    assert(productionPlatformVersion.semanticCheck);
+
+    const files = getMockSnapFiles();
+
+    await productionPlatformVersion.semanticCheck(files, { report });
+
+    expect(report).toHaveBeenCalledTimes(0);
+  });
+});

packages/snaps-utils/src/manifest/validators/production-platform-version.ts

@@ -13,13 +13,17 @@ async function determineProductionVersion() {
     // TODO: Cache this check.
     const latestRelease = await fetch(
       'https://api.github.com/repos/metamask/metamask-extension/releases/latest',
-    ).then(async (response) => response.json());
+    );
 
-    const latestReleaseCommit = latestRelease.target_commitish;
+    const latestReleaseJson = await latestRelease.json();
 
-    const packageJson = await fetch(
+    const latestReleaseCommit = latestReleaseJson.target_commitish;
+
+    const packageJsonResponse = await fetch(
       `https://raw.githubusercontent.com/MetaMask/metamask-extension/${latestReleaseCommit}/package.json`,
-    ).then(async (response) => response.json());
+    );
+
+    const packageJson = await packageJsonResponse.json();
 
     const versionRange = packageJson.dependencies['@metamask/snaps-sdk'];
 

yarn.lock

@@ -4564,6 +4564,7 @@ __metadata:
     istanbul-lib-report: "npm:^3.0.0"
     istanbul-reports: "npm:^3.1.5"
     jest: "npm:^29.0.2"
+    jest-fetch-mock: "npm:^3.0.3"
     jest-silent-reporter: "npm:^0.6.0"
     luxon: "npm:^3.5.0"
     marked: "npm:^12.0.1"