test: convert all tests to typescript

Signed-off-by: Lance Ball <[email protected]>

Author: lance

package-lock.json

@@ -9,9 +9,8 @@
     "prelint": "npm run build",
     "lint": "standardx src examples",
     "fix": "standardx --fix",
-    "pretest": "npm run lint && npm run test:ts",
-    "test": "echo 'skipping js tests for now' # mocha test/**/*.js",
-    "test:ts": "mocha --require ts-node/register ./test-ts/**/*.ts",
+    "pretest": "npm run lint",
+    "test": "mocha --require ts-node/register ./test/**/*.ts",
     "coverage": "nyc --reporter=lcov --reporter=text npm run test",
     "coverage-publish": "wget -qO - https://coverage.codacy.com/get.sh | bash -s report -l JavaScript -r coverage/lcov.info",
     "generate-docs": "typedoc --excludeNotDocumented --out docs src",

package.json

@@ -6,7 +6,6 @@ import { ValidationError } from "./validation";
 
 export const enum Version { V1 = "1.0", V03 = "0.3" };
 
-
 /**
  * A CloudEvent describes event data in common formats to provide
  * interoperability across services, platforms and systems.
@@ -20,7 +19,7 @@ export class CloudEvent implements CloudEventV1, CloudEventV03 {
   datacontenttype?: string;
   dataschema?: string; // TODO: Is a URI type needed?
   subject?: string;
-  time?: string|Date;
+  #_time?: string|Date;
   data?: any;
   data_base64?: any;
   [key: string]: any; // Extensions should not exist as it's own object, but instead be keyed directly from the event
@@ -54,7 +53,7 @@ export class CloudEvent implements CloudEventV1, CloudEventV03 {
     this.subject = properties.subject;
     delete properties.subject;
 
-    this.time = properties.time;
+    this.#_time = properties.time;
     delete properties.time;
 
     this.data = properties.data;
@@ -77,10 +76,10 @@ export class CloudEvent implements CloudEventV1, CloudEventV03 {
     delete properties.schemaurl;
 
     // Make sure time has a default value and whatever is provided is formatted
-    if (!this.time) {
-      this.time = new Date().toISOString();
-    } else if (this.time instanceof Date) {
-      this.time = this.time.toISOString();
+    if (!this.#_time) {
+      this.#_time = new Date().toISOString();
+    } else if (this.#_time instanceof Date) {
+      this.#_time = this.#_time.toISOString();
     }
 
     // sanity checking
@@ -96,6 +95,20 @@ export class CloudEvent implements CloudEventV1, CloudEventV03 {
     }
   }
 
+  get time() {
+    return this.#_time as string|Date;
+  }
+
+  set time(val: string|Date) {
+    this.#_time = new Date(val).toISOString();
+  }
+
+  toJSON(): object {
+    const event = { ...this };
+    event.time = this.time;
+    return event;
+  }
+
   /**
    * Validates this CloudEvent against the schema
    * @returns boolean
@@ -109,7 +122,6 @@ export class CloudEvent implements CloudEventV1, CloudEventV03 {
     } else {
       throw new ValidationError("invalid payload");
     }
-    return false;
   }
 
   public static create(attributes: CloudEventV1Attributes | CloudEventV03Attributes, version?: Version): CloudEvent {

src/event/cloudevent.ts

@@ -5,7 +5,7 @@ import { Headers, validate } from "./headers";
 import { binaryParsers as v1Parsers } from "./v1/parsers";
 import { binaryParsers as v03Parsers } from "./v03/parsers";
 import { parserByContentType, MappedParser } from "../../parsers";
-import { isString, isBase64 } from "../../event/validation";
+import { isString, isBase64, ValidationError, isStringOrObjectOrThrow } from "../../event/validation";
 import CONSTANTS from "../../constants";
 
 /**
@@ -33,6 +33,16 @@ export class BinaryHTTPReceiver {
    * @throws {ValidationError} of the event does not conform to the spec
    */
   parse(payload: any, headers: Headers): CloudEvent {
+    if (!payload) throw new ValidationError("payload is null or undefined");
+    if (!headers) throw new ValidationError("headers is null or undefined");
+    isStringOrObjectOrThrow(payload, new ValidationError("payload must be an object or a string"));
+
+    if (headers[CONSTANTS.CE_HEADERS.SPEC_VERSION] &&
+      headers[CONSTANTS.CE_HEADERS.SPEC_VERSION] != Version.V03 &&
+      headers[CONSTANTS.CE_HEADERS.SPEC_VERSION] != Version.V1) {
+      throw new ValidationError(`invalid spec version ${headers[CONSTANTS.CE_HEADERS.SPEC_VERSION]}`);
+    }
+
     payload = isString(payload) && isBase64(payload)
       ? Buffer.from(payload, "base64").toString()
       : payload;

src/transport/http/binary_receiver.ts

@@ -62,6 +62,10 @@ export function headersFor(event: CloudEvent): Headers {
       }
     }
   });
+  // Treat time specially, since it's handled with getters and setters in CloudEvent
+  if (event.time) {
+    headers[CONSTANTS.CE_HEADERS.TIME] = event.time as string;
+  }
   return headers;
 }
 

src/transport/http/headers.ts

@@ -21,11 +21,10 @@ export function emitStructured(event: CloudEvent, options: Options): Promise<obj
 }
 
 function format(event: CloudEvent): string {
-  const formatted = JSON.parse(JSON.stringify(event));
-  return JSON.stringify(formatted, (key: string, value: any) => {
-    if (key === CONSTANTS.CE_ATTRIBUTES.DATA && isBinary(value)) {
-      return asBase64(value);
-    }
-    return value;
-  });
+  if (isBinary(event.data)) {
+    event.data_base64 = asBase64(event.data);
+  }
+  const json = JSON.stringify(event);
+  delete event.data_base64;
+  return json;
 }

src/transport/http/structured_emitter.ts

@@ -1,10 +1,10 @@
 import { CloudEvent, Version } from "../..";
 import { Headers, validate, sanitize } from "./headers";
-import { Parser } from "../../parsers";
+import { Parser, JSONParser } from "../../parsers";
 import { parserByContentType } from "../../parsers";
 import { structuredParsers as v1Parsers } from "./v1/parsers";
 import { structuredParsers as v03Parsers } from "./v03/parsers";
-import { isString, isBase64 } from "../../event/validation";
+import { isString, isBase64, ValidationError, isStringOrObjectOrThrow, isBinary, asBase64 } from "../../event/validation";
 import { CloudEventV1, validateV1 as validateV1 } from "../../event/v1";
 import { CloudEventV03, validateV03 as validateV03 } from "../../event/v03";
 import CONSTANTS from "../../constants";
@@ -33,18 +33,36 @@ export class StructuredHTTPReceiver {
    * @throws {ValidationError} if the payload and header combination do not conform to the spec
    */
   parse(payload: any, headers: Headers) {
+    if (!payload) throw new ValidationError("payload is null or undefined");
+    if (!headers) throw new ValidationError("headers is null or undefined");
+    isStringOrObjectOrThrow(payload, new ValidationError("payload must be an object or a string"));
+
+    if (headers[CONSTANTS.CE_HEADERS.SPEC_VERSION] &&
+      headers[CONSTANTS.CE_HEADERS.SPEC_VERSION] != Version.V03 &&
+      headers[CONSTANTS.CE_HEADERS.SPEC_VERSION] != Version.V1) {
+      throw new ValidationError(`invalid spec version ${headers[CONSTANTS.CE_HEADERS.SPEC_VERSION]}`);
+    }
+
     payload = isString(payload) && isBase64(payload)
       ? Buffer.from(payload, "base64").toString()
       : payload;
 
-    // Clone and low case all headers names
+      // Clone and low case all headers names
     const sanitizedHeaders = sanitize(headers);
 
-    const parser: Parser = parserByContentType[sanitizedHeaders[CONSTANTS.HEADER_CONTENT_TYPE]];
+    const contentType = sanitizedHeaders[CONSTANTS.HEADER_CONTENT_TYPE];
+    const parser: Parser = contentType ? parserByContentType[contentType] : new JSONParser();
+    if (!parser) throw new ValidationError(`invalid content type ${sanitizedHeaders[CONSTANTS.HEADER_CONTENT_TYPE]}`);
     const incoming = parser.parse(payload);
 
     const eventObj: { [key: string]: any } = {};
     const parserMap = this.version === Version.V1 ? v1Parsers : v03Parsers;
+
+    // if the incoming data is in binary form, encode to base64
+    if (isBinary(incoming.data)) {
+      eventObj.data_base64 = asBase64(incoming.data);
+    }
+
     parserMap.forEach((value, key) => {
       if (incoming[key]) {
         eventObj[value.name] = value.parser.parse(incoming[key]);
@@ -55,6 +73,13 @@ export class StructuredHTTPReceiver {
       eventObj[key] = incoming[key];
     }
 
+    // ensure data content is correctly encoded
+    if (eventObj.data && eventObj.datacontentencoding) {
+      if (eventObj.datacontentencoding === CONSTANTS.ENCODING_BASE64 && !isBase64(eventObj.data)) {
+        throw new ValidationError("invalid payload");
+      }
+    }
+
     const cloudevent = CloudEvent.create(eventObj as CloudEventV1 | CloudEventV03);
 
     // Validates the event