Skip to content

feat: precompile cloudevent schema #471

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 15, 2022
Merged

feat: precompile cloudevent schema #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2e8cc9a
feat: precompile cloudevent schema
lance Feb 10, 2022
9e9c0f0
fixup: ajv-formats in dev deps
lance Feb 10, 2022
e5b90e7
fixup: revert v0.3 changes
lance Feb 14, 2022
e196efc
fixup: make src/schema/v1.js transient
lance Feb 14, 2022
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 .eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"plugins": [
"header"
],
"ignorePatterns": ["**/schema/*"],
"rules": {
"no-var": "error",
"standard/no-callback-literal": "off",
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ index.js
/bundles
/dist
/docs
src/schema/v1.js

# Runtime data
pids
Expand Down
137 changes: 117 additions & 20 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
"main": "dist/index.js",
"scripts": {
"watch": "tsc --project tsconfig.json --watch",
"build": "tsc --project tsconfig.json && tsc --project tsconfig.browser.json && webpack",
"build:src": "tsc --project tsconfig.json",
"build:browser": "tsc --project tsconfig.browser.json && webpack",
"build:schema": "ajv compile -c ./src/schema/formats.js -s src/schema/cloudevent.json --strict-types false -o src/schema/v1.js",
"build": "npm run build:schema && npm run build:src && npm run build:browser",
"lint": "npm run lint:md && npm run lint:js",
"lint:js": "eslint 'src/**/*.{js,ts}' 'test/**/*.{js,ts}' cucumber.js",
"lint:md": "remark .",
Expand Down Expand Up @@ -106,13 +109,12 @@
},
"homepage": "https://github.com/cloudevents/sdk-javascript#readme",
"dependencies": {
"ajv": "~6.12.3",
"ajv": "^8.6.3",
"util": "^0.12.4",
"uuid": "~8.3.0"
},
"devDependencies": {
"@cucumber/cucumber": "^8.0.0-rc.1",
"@types/ajv": "^1.0.0",
"@types/chai": "^4.2.11",
"@types/cucumber": "^6.0.1",
"@types/got": "^9.6.11",
Expand All @@ -122,6 +124,8 @@
"@types/uuid": "^8.0.0",
"@typescript-eslint/eslint-plugin": "^4.29.0",
"@typescript-eslint/parser": "^4.29.0",
"ajv-cli": "^5.0.0",
"ajv-formats": "^2.1.1",
"axios": "^0.21.3",
"chai": "~4.2.0",
"eslint": "^7.32.0",
Expand Down
86 changes: 0 additions & 86 deletions src/event/schemas.ts
View file
Open in desktop

This file was deleted.

17 changes: 3 additions & 14 deletions src/event/spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,17 @@
SPDX-License-Identifier: Apache-2.0
*/

import Ajv, { Options } from "ajv";
import { ValidationError } from "./validation";

import { CloudEventV1 } from "./interfaces";
import { schemaV1 } from "./schemas";
import { Version } from "./cloudevent";
import validate from "../schema/v1";

const ajv = new Ajv({ extendRefs: true } as Options);

// handle date-time format specially because a user could pass
// Date().toString(), which is not spec compliant date-time format
ajv.addFormat("js-date-time", function (dateTimeString) {
const date = new Date(Date.parse(dateTimeString));
return date.toString() !== "Invalid Date";
});

const isValidAgainstSchemaV1 = ajv.compile(schemaV1);

export function validateCloudEvent<T>(event: CloudEventV1<T>): boolean {
if (event.specversion === Version.V1) {
if (!isValidAgainstSchemaV1(event)) {
throw new ValidationError("invalid payload", isValidAgainstSchemaV1.errors);
if (!validate(event)) {
throw new ValidationError("invalid payload", (validate as any).errors);
Copy link
Member

Choose a reason for hiding this comment

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

(validate as any) seems a bit off. Why do we need to cast to any?

I'm seeing validate as a function:

function validate(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
    instancePath?: string | undefined;
    parentData: any;
    parentDataProperty: any;
    rootData?: any;
}): boolean

Copy link
Member Author

Choose a reason for hiding this comment

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

The function that AJV generates has an errors object attached to it if there are errors found when validating with validate(data). It's a non-optimal API. Here you can see it in the generated validation code. I welcome suggestions on how to deal with this another way.

function validate20(data, { instancePath = "", parentData, parentDataProperty, rootData = data } = {}) {
  let vErrors = null;
  let errors = 0;
  if (errors === 0) {
    if (data && typeof data == "object" && !Array.isArray(data)) {
      let missing0;
      if (
        (data.id === undefined && (missing0 = "id")) ||
        (data.source === undefined && (missing0 = "source")) ||
        (data.specversion === undefined && (missing0 = "specversion")) ||
        (data.type === undefined && (missing0 = "type"))
      ) {
        validate20.errors = [
          {
            instancePath,
            schemaPath: "#/required",
            keyword: "required",
            params: { missingProperty: missing0 },
            message: `must have required property '${  missing0  }'`,
          },
        ];
        return false;
      }

}
} else {
return false;
Expand Down
Loading