Remove JSON schemas in favour of structs (#862)

* Remove JSON schemas in favour of structs * Fix browser export * Fix build script * Fix other packages * Add tests * Fix PR comments * Remove custom minSize struct * Fix export * Update coverage * Remove ajv cli * Remove @json-schema-tools/transpiler
MetaMask · Oct 26, 2022 · abdcbea · abdcbea
1 parent 99f1fcd
commit abdcbea
Show file tree

Hide file tree

Showing 30 changed files with 308 additions and 598 deletions.
diff --git a/packages/cli/src/cmds/init/initUtils.test.ts b/packages/cli/src/cmds/init/initUtils.test.ts
@@ -47,7 +47,8 @@ jest.mock('fs', () => ({
 jest.mock('@metamask/snap-utils', () => ({
   ...jest.requireActual('@metamask/snap-utils'),
   readJsonFile: jest.fn(),
-  validateSnapJsonFile: jest.fn(),
+  assertIsNpmSnapPackageJson: jest.fn(),
+  assertIsSnapManifest: jest.fn(),
 }));
 jest.mock('init-package-json');
 jest.mock('mkdirp');
@@ -75,7 +76,7 @@ describe('initUtils', () => {
         .mockImplementationOnce(async () => '');
 
       const validateSnapJsonFileMock = jest
-        .spyOn(snapUtils, 'validateSnapJsonFile')
+        .spyOn(snapUtils, 'assertIsNpmSnapPackageJson')
         .mockImplementationOnce(() => true);
 
       jest.spyOn(console, 'log').mockImplementation();

diff --git a/packages/cli/src/cmds/init/initUtils.ts b/packages/cli/src/cmds/init/initUtils.ts
@@ -5,9 +5,10 @@ import {
   NpmSnapFileNames,
   SnapManifest,
   NpmSnapPackageJson,
-  validateSnapJsonFile,
+  assertIsNpmSnapPackageJson,
   readJsonFile,
   deepClone,
+  assertIsSnapManifest,
 } from '@metamask/snap-utils';
 import initPackageJson from 'init-package-json';
 import mkdirp from 'mkdirp';
@@ -48,7 +49,7 @@ export async function asyncPackageInit(
 
     try {
       const packageJson = await readJsonFile(NpmSnapFileNames.PackageJson);
-      validateSnapJsonFile(NpmSnapFileNames.PackageJson, packageJson);
+      assertIsNpmSnapPackageJson(packageJson);
 
       console.log(
         `Init: Successfully parsed '${NpmSnapFileNames.PackageJson}'!`,
@@ -292,7 +293,7 @@ export async function buildSnapManifest(
     };
 
     try {
-      validateSnapJsonFile(NpmSnapFileNames.Manifest, manifest);
+      assertIsSnapManifest(manifest);
     } catch (error) {
       /* istanbul ignore next */
       throw new Error(

diff --git a/packages/controllers/jest.config.js b/packages/controllers/jest.config.js
@@ -10,8 +10,8 @@ module.exports = {
     global: {
       branches: 85.74,
       functions: 95.3,
-      lines: 94.84,
-      statements: 94.93,
+      lines: 94.83,
+      statements: 94.92,
     },
   },
   projects: [

diff --git a/packages/controllers/src/snaps/SnapController.ts b/packages/controllers/src/snaps/SnapController.ts
@@ -35,7 +35,6 @@ import {
   SNAP_PREFIX,
   ValidatedSnapId,
   validateSnapId,
-  validateSnapJsonFile,
   validateSnapShasum,
   TruncatedSnapFields,
   Snap,
@@ -51,6 +50,7 @@ import {
   fromEntries,
   SnapStatus,
   SnapStatusEvents,
+  assertIsSnapManifest,
 } from '@metamask/snap-utils';
 import {
   Duration,
@@ -1904,7 +1904,7 @@ export class SnapController extends BaseController<
       versionRange = DEFAULT_REQUESTED_SNAP_VERSION,
     } = args;
 
-    validateSnapJsonFile(NpmSnapFileNames.Manifest, manifest);
+    assertIsSnapManifest(manifest);
     const { version } = manifest;
 
     if (!satisfiesVersionRange(version, versionRange)) {
@@ -2044,11 +2044,10 @@ export class SnapController extends BaseController<
       );
     }
 
-    const _manifest = await (
+    const manifest = await (
       await this._fetchFunction(manifestUrl.toString(), fetchOptions)
     ).json();
-    validateSnapJsonFile(NpmSnapFileNames.Manifest, _manifest);
-    const manifest = _manifest as SnapManifest;
+    assertIsSnapManifest(manifest);
 
     const {
       source: {

diff --git a/packages/utils/jest.config.js b/packages/utils/jest.config.js
@@ -16,9 +16,9 @@ module.exports = {
   coverageThreshold: {
     global: {
       branches: 86.05,
-      functions: 97,
-      lines: 96.68,
-      statements: 96.76,
+      functions: 97.14,
+      lines: 96.79,
+      statements: 96.86,
     },
   },
   moduleFileExtensions: ['js', 'json', 'jsx', 'ts', 'tsx', 'node'],

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -44,11 +44,7 @@
     "lint": "yarn lint:eslint && yarn lint:misc --check",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:changelog": "yarn auto-changelog validate",
-    "ajv-compile": "ajv compile --strict=true --all-errors",
-    "build:ajv": "./scripts/build-ajv.sh",
-    "build:pre-tsc": "yarn build:ajv && node scripts/transpileSchemaTypes.js",
-    "build:tsc": "tsc --project tsconfig.local.json",
-    "build": "yarn build:pre-tsc && yarn build:tsc",
+    "build": "tsc --project tsconfig.local.json",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
     "publish:package": "../../scripts/publish-package.sh"
@@ -60,7 +56,6 @@
     "@metamask/utils": "^3.1.0",
     "@noble/hashes": "^1.1.3",
     "@scure/base": "^1.1.1",
-    "ajv": "^8.11.0",
     "eth-rpc-errors": "^4.0.3",
     "fast-deep-equal": "^3.1.3",
     "rfdc": "^1.3.0",
@@ -69,7 +64,6 @@
     "superstruct": "^0.16.5"
   },
   "devDependencies": {
-    "@json-schema-tools/transpiler": "^1.10.2",
     "@lavamoat/allow-scripts": "^2.0.3",
     "@metamask/auto-changelog": "^2.6.0",
     "@metamask/eslint-config": "^9.0.0",
@@ -78,7 +72,6 @@
     "@metamask/eslint-config-typescript": "^9.0.1",
     "@types/jest": "^27.5.1",
     "@types/semver": "^7.3.10",
-    "ajv-cli": "^5.0.0",
     "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.23.4",

diff --git a/packages/utils/scripts/build-ajv.sh b/packages/utils/scripts/build-ajv.sh
diff --git a/packages/utils/scripts/transpileSchemaTypes.js b/packages/utils/scripts/transpileSchemaTypes.js
diff --git a/packages/utils/src/fs.test.ts b/packages/utils/src/fs.test.ts
@@ -11,9 +11,8 @@ import {
   validateFilePath,
   validateDirPath,
 } from './fs';
-import { NpmSnapFileNames } from './types';
+import { NpmSnapFileNames, SnapManifest } from './types';
 import { DEFAULT_SNAP_BUNDLE, getSnapManifest } from './test-utils';
-import { SnapManifest } from './json-schemas';
 
 jest.mock('fs');
 

diff --git a/packages/utils/src/index.browser.ts b/packages/utils/src/index.browser.ts
@@ -4,7 +4,6 @@ export * from './deep-clone';
 export * from './default-endowments';
 export * from './flatMap';
 export * from './json-rpc';
-export * from './json-schemas';
 export * from './namespace';
 export * from './notification';
 export * from './object';

diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -6,7 +6,6 @@ export * from './eval';
 export * from './flatMap';
 export * from './fs';
 export * from './json-rpc';
-export * from './json-schemas';
 export * from './manifest';
 export * from './mock';
 export * from './namespace';

diff --git a/packages/utils/src/json-schemas/NpmSnapPackageJson.ts b/packages/utils/src/json-schemas/NpmSnapPackageJson.ts
diff --git a/packages/utils/src/json-schemas/README.md b/packages/utils/src/json-schemas/README.md