Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update path for schema #259

Merged
merged 7 commits into from
Oct 27, 2023
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
1 change: 1 addition & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
with:
node-version: 18.x
- run: npm ci && npm run postinstall
- run: npm run prebuild
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to be clear, prebuild should automatically run when npm run build is triggered. But since we don't build before running our tests, I understand we have to manually call it here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! Didnt wanted to add a npm run build in here because its not needed by the test script

- run: npm run test

test-build:
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"lint": "eslint . --ext .ts,.json --max-warnings 0",
"lint:fix": "npm run lint -- --fix",
"publish:schema": "./scripts/publishSchema.sh",
"postinstall": "node scripts/postInstall"
"postinstall": "node scripts/postInstall",
"prebuild": "node scripts/preBuild"
},
"files": [
"/dist",
Expand Down
61 changes: 0 additions & 61 deletions scripts/postInstall.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,9 @@
const fs = require("fs");
const path = require("path");
const { execSync } = require("child_process");
const standaloneCode = require("ajv/dist/standalone").default;
const Ajv = require("ajv");
const { clone, cloneDeepWith } = require("lodash");

const openAttestationSchemav2 = require("../src/2.0/schema/schema.json");
const openAttestationSchemav3 = require("../src/3.0/schema/schema.json");
const quicktype = path.join(process.cwd(), "node_modules", ".bin", "quicktype");

// remove enum and pattern from the schema
function transformSchema(schema) {
const excludeKeys = ["enum", "pattern"];
function omit(value) {
if (value && typeof value === "object") {
const key = excludeKeys.find((key) => value[key]);
if (key) {
const node = clone(value);
excludeKeys.forEach((key) => {
delete node[key];
});
return node;
}
}
}

const newSchema = cloneDeepWith(schema, omit);
// because we remove check on enum (DNS-DID, DNS-TXT, etc.) the identity proof can match multiple sub schema in v2.
// so here we change oneOf to anyOf, so that if more than one identityProof matches, it still passes
if (newSchema?.definitions?.identityProof?.oneOf) {
newSchema.definitions.identityProof.anyOf = newSchema?.definitions?.identityProof?.oneOf;
delete newSchema?.definitions?.identityProof?.oneOf;
}
return newSchema;
}

if (fs.existsSync(quicktype) && process.env.npm_config_production !== "true") {
console.log('"Creating types from src/2.0/schema/schema.json"');
execSync(
Expand All @@ -47,36 +16,6 @@ if (fs.existsSync(quicktype) && process.env.npm_config_production !== "true") {
quicktype +
" -s schema -o src/__generated__/schema.3.0.ts -t OpenAttestationDocument --just-types src/3.0/schema/schema.json --no-date-times"
);

console.log('"Creating strict compiled schema for v2 and v3"');
const addFormats = require("ajv-formats").default;

let strictAjv = new Ajv({
allErrors: true,
allowUnionTypes: true,
schemas: [openAttestationSchemav2, openAttestationSchemav3],
code: { source: true },
}).addKeyword("deprecationMessage");
addFormats(strictAjv);

fs.writeFileSync(path.join(__dirname, "../src/__generated__/compiled_schema_strict.js"), standaloneCode(strictAjv));

console.log('"Creating non-strict compiled schema for v2 and v3"');
// custom ajv for loose schema validation
// it will allow invalid format, invalid pattern and invalid enum
let nonStrictAjv = new Ajv({
allErrors: true,
allowUnionTypes: true,
schemas: [transformSchema(openAttestationSchemav2), transformSchema(openAttestationSchemav3)],
code: { source: true },
validateFormats: false,
}).addKeyword("deprecationMessage");
addFormats(nonStrictAjv);

fs.writeFileSync(
path.join(__dirname, "../src/__generated__/compiled_schema_non_strict.js"),
standaloneCode(nonStrictAjv)
);
} else {
console.log("Not running quicktype");
}
65 changes: 65 additions & 0 deletions scripts/preBuild.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const fs = require("fs");
const path = require("path");
const standaloneCode = require("ajv/dist/standalone").default;
const Ajv = require("ajv");
const { clone, cloneDeepWith } = require("lodash");

const openAttestationSchemav2 = require(path.join(process.cwd(), "src/2.0/schema/schema.json"));
const openAttestationSchemav3 = require(path.join(process.cwd(), "src/3.0/schema/schema.json"));

// remove enum and pattern from the schema
function transformSchema(schema) {
const excludeKeys = ["enum", "pattern"];
function omit(value) {
if (value && typeof value === "object") {
const key = excludeKeys.find((key) => value[key]);
if (key) {
const node = clone(value);
excludeKeys.forEach((key) => {
delete node[key];
});
return node;
}
}
}

const newSchema = cloneDeepWith(schema, omit);
// because we remove check on enum (DNS-DID, DNS-TXT, etc.) the identity proof can match multiple sub schema in v2.
// so here we change oneOf to anyOf, so that if more than one identityProof matches, it still passes
if (newSchema?.definitions?.identityProof?.oneOf) {
newSchema.definitions.identityProof.anyOf = newSchema?.definitions?.identityProof?.oneOf;
delete newSchema?.definitions?.identityProof?.oneOf;
}
return newSchema;
}

console.log('"Creating strict compiled schema for v2 and v3"');
const addFormats = require("ajv-formats").default;

let strictAjv = new Ajv({
allErrors: true,
allowUnionTypes: true,
schemas: [openAttestationSchemav2, openAttestationSchemav3],
code: { source: true },
}).addKeyword("deprecationMessage");
addFormats(strictAjv);

fs.writeFileSync(path.join(__dirname, "../src/__generated__/compiled_schema_strict.js"), standaloneCode(strictAjv));

console.log('"Creating non-strict compiled schema for v2 and v3"');
// custom ajv for loose schema validation
// it will allow invalid format, invalid pattern and invalid enum
let nonStrictAjv = new Ajv({
allErrors: true,
allowUnionTypes: true,
schemas: [transformSchema(openAttestationSchemav2), transformSchema(openAttestationSchemav3)],
code: { source: true },
validateFormats: false,
}).addKeyword("deprecationMessage");
addFormats(nonStrictAjv);

fs.writeFileSync(
path.join(__dirname, "../src/__generated__/compiled_schema_non_strict.js"),
standaloneCode(nonStrictAjv)
);
Loading