CCM-12896: Extract a schema-utils utility

gareth-allan · gareth-allan · commit cff21940704b · 2025-12-15T16:15:55.000Z
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/python-schema-generator/requirements-dev.txt b/src/python-schema-generator/requirements-dev.txt
@@ -1,4 +1,3 @@
 -r requirements.txt
 pytest>=7.4.0
 pytest-cov>=4.1.0
-pytest-mock>=3.11.0
diff --git a/src/python-schema-generator/requirements.txt b/src/python-schema-generator/requirements.txt
@@ -1,3 +1 @@
 datamodel-code-generator>=0.25.0,<1.0.0
-pydantic>=2.0.0,<3.0.0
-PyYAML>=6.0
diff --git a/src/python-schema-generator/src/__tests__/merge-allof.test.ts b/src/python-schema-generator/src/__tests__/merge-allof.test.ts
@@ -1,6 +1,6 @@
 /* eslint-disable security/detect-non-literal-fs-filename */
 
-import { eventSchemasDir } from 'file-utils';
+import { eventSchemasDir } from 'utils';
 import { mergeAllOfInSchemas } from 'merge-allof';
 import mockFs from 'mock-fs';
 import { readdirSync } from 'node:fs';
diff --git a/src/python-schema-generator/src/file-utils.ts b/src/python-schema-generator/src/file-utils.ts
@@ -1,45 +1,9 @@
 // We don't accept user input, so path traversal attacks should not be a risk.
 /* eslint-disable security/detect-non-literal-fs-filename */
 
-import { mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
+import { mkdirSync, writeFileSync } from 'node:fs';
 import path from 'node:path';
 
-export const eventSchemasDir = path.resolve(
-  __dirname,
-  '..',
-  '..',
-  '..',
-  'schemas',
-  'digital-letters',
-  '2025-10-draft',
-  'events',
-);
-
-export const destinationPackageName = 'digital-letters-events';
-
-/**
- * Lists all event schema filenames in the digital letters schemas directory.
- *
- * @returns An array of schema filenames.
- */
-export function listEventSchemas(): string[] {
-  const flattenedSchemaFiles = readdirSync(eventSchemasDir).filter((f) =>
-    f.endsWith('.flattened.schema.json'),
-  );
-
-  return flattenedSchemaFiles;
-}
-
-/**
- * Loads and parses a JSON schema from the specified file path.
- *
- * @param schemaPath The path to the JSON schema file.
- * @returns The parsed JSON schema object.
- */
-export function loadSchema(schemaPath: string): any {
-  return JSON.parse(readFileSync(schemaPath, 'utf8'));
-}
-
 /**
  * Creates the specified output directory if it doesn't exist.
  *
diff --git a/src/python-schema-generator/src/merge-allof.ts b/src/python-schema-generator/src/merge-allof.ts
@@ -1,13 +1,8 @@
 /* eslint-disable no-console */
-import {
-  createOutputDir,
-  eventSchemasDir,
-  listEventSchemas,
-  loadSchema,
-  writeFile,
-} from 'file-utils';
+import { createOutputDir, writeFile } from 'file-utils';
 import mergeAllOf from 'json-schema-merge-allof';
 import path from 'node:path';
+import { eventSchemasDir, listEventSchemas, loadSchema } from 'utils';
 
 export function mergeAllOfInSchemas(): void {
   const eventSchemaFilenames = listEventSchemas();
diff --git a/src/typescript-schema-generator/package.json b/src/typescript-schema-generator/package.json
@@ -2,7 +2,8 @@
   "dependencies": {
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
-    "json-schema-to-typescript": "^15.0.4"
+    "json-schema-to-typescript": "^15.0.4",
+    "utils": "^0.0.1"
   },
   "description": "A tool to generate Typescript types and standalone validator functions for the application's event schemas.",
   "devDependencies": {
diff --git a/src/typescript-schema-generator/src/__tests__/generate-types.test.ts b/src/typescript-schema-generator/src/__tests__/generate-types.test.ts
@@ -1,11 +1,11 @@
 /* eslint-disable security/detect-non-literal-fs-filename */
 
-import { destinationPackageName, eventSchemasDir } from 'file-utils';
 import { generateTypes } from 'generate-types';
 import { compile } from 'json-schema-to-typescript';
 import mockFs from 'mock-fs';
 import { readFileSync, readdirSync } from 'node:fs';
 import path from 'node:path';
+import { destinationPackageName, eventSchemasDir } from 'utils';
 
 jest.mock('json-schema-to-typescript');
 
diff --git a/src/typescript-schema-generator/src/__tests__/generate-validators.test.ts b/src/typescript-schema-generator/src/__tests__/generate-validators.test.ts
@@ -1,10 +1,10 @@
 /* eslint-disable security/detect-non-literal-fs-filename */
 import standaloneCode from 'ajv/dist/standalone';
-import { destinationPackageName, eventSchemasDir } from 'file-utils';
 import { generateValidators } from 'generate-validators';
 import mockFs from 'mock-fs';
 import { readFileSync, readdirSync } from 'node:fs';
 import path from 'node:path';
+import { destinationPackageName, eventSchemasDir } from 'utils';
 
 jest.mock('ajv/dist/2020');
 jest.mock('ajv/dist/standalone');
diff --git a/src/typescript-schema-generator/src/file-utils.ts b/src/typescript-schema-generator/src/file-utils.ts
@@ -1,44 +1,9 @@
 // We don't accept user input, so path traversal attacks should not be a risk.
 /* eslint-disable security/detect-non-literal-fs-filename */
 
-import { mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
+import { mkdirSync, writeFileSync } from 'node:fs';
 import path from 'node:path';
-
-export const eventSchemasDir = path.resolve(
-  __dirname,
-  '..',
-  '..',
-  '..',
-  'schemas',
-  'digital-letters',
-  '2025-10-draft',
-  'events',
-);
-
-export const destinationPackageName = 'digital-letters-events';
-
-/**
- * Lists all event schema filenames in the digital letters schemas directory.
- *
- * @returns An array of schema filenames.
- */
-export function listEventSchemas(): string[] {
-  const flattenedSchemaFiles = readdirSync(eventSchemasDir).filter((f) =>
-    f.endsWith('.flattened.schema.json'),
-  );
-
-  return flattenedSchemaFiles;
-}
-
-/**
- * Loads and parses a JSON schema from the specified file path.
- *
- * @param schemaPath The path to the JSON schema file.
- * @returns The parsed JSON schema object.
- */
-export function loadSchema(schemaPath: string): any {
-  return JSON.parse(readFileSync(schemaPath, 'utf8'));
-}
+import { destinationPackageName } from 'utils';
 
 /**
  * Creates the specified output directory if it doesn't exist.
diff --git a/src/typescript-schema-generator/src/generate-types.ts b/src/typescript-schema-generator/src/generate-types.ts
@@ -1,14 +1,8 @@
 /* eslint-disable no-console */
+import { createOutputDir, writeFile, writeTypesIndex } from 'file-utils';
 import { compile } from 'json-schema-to-typescript';
 import path from 'node:path';
-import {
-  createOutputDir,
-  eventSchemasDir,
-  listEventSchemas,
-  loadSchema,
-  writeFile,
-  writeTypesIndex,
-} from 'file-utils';
+import { eventSchemasDir, listEventSchemas, loadSchema } from 'utils';
 
 export async function generateTypes() {
   const eventSchemaFilenames = listEventSchemas();
diff --git a/src/typescript-schema-generator/src/generate-validators.ts b/src/typescript-schema-generator/src/generate-validators.ts
@@ -5,15 +5,13 @@ import path from 'node:path';
 import Ajv from 'ajv/dist/2020';
 
 import standaloneCode from 'ajv/dist/standalone';
+import { createOutputDir, writeFile, writeTypesIndex } from 'file-utils';
 import {
-  createOutputDir,
   destinationPackageName,
   eventSchemasDir,
   listEventSchemas,
   loadSchema,
-  writeFile,
-  writeTypesIndex,
-} from 'file-utils';
+} from 'utils';
 
 export function generateValidators() {
   const ajv = new Ajv({
diff --git a/utils/utils/package.json b/utils/utils/package.json
@@ -24,6 +24,7 @@
     "aws-sdk-client-mock-jest": "^4.1.0",
     "jest": "^29.7.0",
     "jest-mock-extended": "^3.0.7",
+    "mock-fs": "^5.5.0",
     "typescript": "^5.8.2"
   },
   "exports": {
diff --git a/utils/utils/src/__tests__/schema-utils/schema-utils.test.ts b/utils/utils/src/__tests__/schema-utils/schema-utils.test.ts
@@ -0,0 +1,47 @@
+import mockFs from 'mock-fs';
+import path from 'node:path';
+import { eventSchemasDir, listEventSchemas, loadSchema } from 'utils';
+
+describe('schema-utils', () => {
+  beforeEach(() => {
+    mockFs({
+      [eventSchemasDir]: {
+        'one.flattened.schema.json': '{"title": "One"}',
+        'two.schema.json': '{"title": "Two"}',
+        'three.flattened.schema.json': '{"title": "Three"}',
+        'four.flattened.schema.txt': '{"title": "Four"}',
+      },
+    });
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+  });
+
+  describe('listEventSchemas', () => {
+    it('should list all flattened schemas', () => {
+      const schemas = listEventSchemas();
+
+      expect(schemas.length).toBe(2);
+      expect(schemas).toEqual(
+        expect.arrayContaining([
+          'one.flattened.schema.json',
+          'three.flattened.schema.json',
+        ]),
+      );
+    });
+  });
+
+  describe('loadSchema', () => {
+    it('should load and parse a JSON schema', () => {
+      const schemaPath = path.resolve(
+        eventSchemasDir,
+        'one.flattened.schema.json',
+      );
+
+      const schema = loadSchema(schemaPath);
+
+      expect(schema).toEqual({ title: 'One' });
+    });
+  });
+});
diff --git a/utils/utils/src/index.ts b/utils/utils/src/index.ts
@@ -13,3 +13,4 @@ export * from './types';
 export * from './event-publisher';
 export * from './event-bridge-utils';
 export * from './key-generation-utils';
+export * from './schema-utils';
diff --git a/utils/utils/src/schema-utils/index.ts b/utils/utils/src/schema-utils/index.ts
@@ -0,0 +1 @@
+export * from './schema-utils';
diff --git a/utils/utils/src/schema-utils/schema-utils.ts b/utils/utils/src/schema-utils/schema-utils.ts
@@ -0,0 +1,42 @@
+// We don't accept user input, so path traversal attacks should not be a risk.
+/* eslint-disable security/detect-non-literal-fs-filename */
+
+import { readFileSync, readdirSync } from 'node:fs';
+import path from 'node:path';
+
+export const eventSchemasDir = path.resolve(
+  __dirname,
+  '..',
+  '..',
+  '..',
+  '..',
+  'schemas',
+  'digital-letters',
+  '2025-10-draft',
+  'events',
+);
+
+export const destinationPackageName = 'digital-letters-events';
+
+/**
+ * Lists all event schema filenames in the digital letters schemas directory.
+ *
+ * @returns An array of schema filenames.
+ */
+export function listEventSchemas(): string[] {
+  const flattenedSchemaFiles = readdirSync(eventSchemasDir).filter((f) =>
+    f.endsWith('.flattened.schema.json'),
+  );
+
+  return flattenedSchemaFiles;
+}
+
+/**
+ * Loads and parses a JSON schema from the specified file path.
+ *
+ * @param schemaPath The path to the JSON schema file.
+ * @returns The parsed JSON schema object.
+ */
+export function loadSchema(schemaPath: string): any {
+  return JSON.parse(readFileSync(schemaPath, 'utf8'));
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1 @@`
`1`	`1`	`datamodel-code-generator>=0.25.0,<1.0.0`
`2`		`-pydantic>=2.0.0,<3.0.0`
`3`		`-PyYAML>=6.0`