Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions packages/concertino/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,10 @@
/* eslint-disable valid-jsdoc */
import { IModels } from '@accordproject/concerto-metamodel';
import { IConcertino } from './spec/concertino.metamodel@4.0.0-alpha.2';
import schema from './spec/concertino.schema.json';
import { convertToConcertino } from './concertinoSerializer';
import { convertToMetamodel } from './metamodelSerializer';
import Ajv, { ValidateFunction } from 'ajv';
import { readFileSync } from 'fs';
import { join } from 'path';

/**
* Conversion options for Concertino format.
Expand All @@ -36,14 +35,12 @@ export interface ConcertinoOptions {
version?: string;
}

const schema = JSON.parse(readFileSync(join(__dirname, 'spec/concertino.schema.json'), 'utf-8'));

/**
* Concertino utility class for converting between Concerto metamodel and Concertino format.
*/
export class ConcertinoConverter {
private options: ConcertinoOptions;
private validate: ValidateFunction;
private validate?: ValidateFunction;
private ajv: Ajv;

/**
Expand All @@ -56,7 +53,6 @@ export class ConcertinoConverter {
...options
};
this.ajv = new Ajv();
this.validate = this.ajv.compile(schema);
}

/**
Expand All @@ -82,11 +78,19 @@ export class ConcertinoConverter {
}

public isValid(concertino: IConcertino): boolean {
return this.validate(concertino);
return this.getValidator()(concertino);
}

public getValidationErrors() {
return this.validate.errors;
return this.validate?.errors ?? null;
}

private getValidator(): ValidateFunction {
if (!this.validate) {
this.validate = this.ajv.compile(schema);
}

return this.validate;
}

}
Expand Down
35 changes: 34 additions & 1 deletion packages/concertino/test/concertino.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ import { ConcertinoConverter } from '../src/';
import { determineScalarType, dispatchDeclaration, getInheritanceChain, determinePropertyType } from '../src/concertinoSerializer';
import { readdirSync, statSync } from 'fs';
import { IModel, IModels } from '@accordproject/concerto-metamodel';
import { it, expect, describe } from 'vitest';
import Ajv from 'ajv';
import { afterEach, it, expect, describe, vi } from 'vitest';

const loadAllCtoFiles = (dir: string, models: object[]): void => {
const files = readdirSync(dir);
Expand All @@ -32,6 +33,10 @@ const loadAllCtoFiles = (dir: string, models: object[]): void => {
});
};

afterEach(() => {
vi.restoreAllMocks();
});

describe('concertino roundtripping (sample models)', () => {
const models: IModel[] = [];

Expand Down Expand Up @@ -64,6 +69,34 @@ describe('concertino roundtripping (sample models)', () => {
});

describe('concertino edge cases and error handling', () => {
it('should lazily compile the validator', () => {
const compileSpy = vi.spyOn(Ajv.prototype, 'compile');
const converter = new ConcertinoConverter();
const ast = {
$class: 'concerto.metamodel@1.0.0.Models',
models: [{
$class: 'concerto.metamodel@1.0.0.Model',
namespace: 'sourceUriTest@1.0.0',
sourceUri: 'uri'
}],
};

expect(compileSpy).not.toHaveBeenCalled();
expect(converter.getValidationErrors()).toBeNull();

const concertino = converter.fromConcertoMetamodel(ast);
expect(compileSpy).not.toHaveBeenCalled();
expect(converter.toConcertoMetamodel(concertino)).toStrictEqual(ast);
expect(compileSpy).not.toHaveBeenCalled();

expect(converter.isValid(concertino)).toBe(true);
expect(compileSpy).toHaveBeenCalledTimes(1);
expect(converter.getValidationErrors()).toBeNull();

expect(converter.isValid(concertino)).toBe(true);
expect(compileSpy).toHaveBeenCalledTimes(1);
});

it('should roundtrip sourceUri', () => {
const converter = new ConcertinoConverter();
const ast = {
Expand Down
2 changes: 1 addition & 1 deletion packages/concertino/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
"resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
Expand Down
Loading