Implement SerDes.jsonType option for non-object internal types. (#632)

* Implement SerDes.jsonType option for non-object internal types. * Implement check for string on request SerDes deserialization.
cdimascio · Sep 12, 2021 · 01f5b5c · 01f5b5c
1 parent 522c3ec
commit 01f5b5c
Show file tree

Hide file tree

Showing 6 changed files with 222 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -767,6 +767,7 @@ To create custom serializers and/or deserializers, define:
 - `format` (required) - a custom 'unknown' format that triggers the serializer and/or deserializer
 - `deserialize` (optional) - upon receiving a request, transform a string property to an object. Deserialization occurs _after_ request schema validation.
 - `serialize` (optional) - before sending a response, transform an object to string. Serialization occurs _after_ response schema validation
+- `jsonType` (optional, default 'object') - set to override for deserialized types that are not 'object', eg 'array' 
 
 e.g.
 

diff --git a/src/framework/ajv/index.ts b/src/framework/ajv/index.ts
@@ -42,15 +42,27 @@ function createAjv(
         compile: (sch) => {
           if (sch) {
             return function validate(data, path, obj, propName) {
-              if (typeof data === 'object') return true;
-              if(!!sch.deserialize) {
+              if (!!sch.deserialize) {
+                if (typeof data !== 'string') {
+                  (<ajv.ValidateFunction>validate).errors = [
+                    {
+                      keyword: 'serdes',
+                      schemaPath: data,
+                      dataPath: path,
+                      message: `must be a string`,
+                      params: { 'x-eov-serdes': propName },
+                    },
+                  ];
+                  return false;
+                }
                 obj[propName] = sch.deserialize(data);
               }
               return true;
             };
           }
           return () => true;
         },
+        // errors: 'full',
       });
     }
     ajv.removeKeyword('readOnly');
@@ -86,7 +98,7 @@ function createAjv(
           if (sch) {
             return function validate(data, path, obj, propName) {
               if (typeof data === 'string') return true;
-              if(!!sch.serialize) {
+              if (!!sch.serialize) {
                 obj[propName] = sch.serialize(data);
               }
               return true;

diff --git a/src/framework/types.ts b/src/framework/types.ts
@@ -72,6 +72,7 @@ export type Format = {
 
 export type SerDes = {
   format: string;
+  jsonType?: string;
   serialize?: (o: unknown) => string;
   deserialize?: (s: string) => unknown;
 };
@@ -80,24 +81,29 @@ export class SerDesSingleton implements SerDes {
   serializer: SerDes;
   deserializer: SerDes;
   format: string;
+  jsonType: string;
   serialize?: (o: unknown) => string;
   deserialize?: (s: string) => unknown;
 
   constructor(param: {
     format: string;
+    jsonType?: string;
     serialize: (o: unknown) => string;
     deserialize: (s: string) => unknown;
   }) {
     this.format = param.format;
+    this.jsonType = param.jsonType || 'object';
     this.serialize = param.serialize;
     this.deserialize = param.deserialize;
     this.deserializer = {
-      format : param.format,
-      deserialize : param.deserialize
+      format: param.format,
+      jsonType: param.jsonType || 'object',
+      deserialize: param.deserialize
     }
     this.serializer = {
-      format : param.format,
-      serialize : param.serialize
+      format: param.format,
+      jsonType: param.jsonType || 'object',
+      serialize: param.serialize
     }
   }
 };

diff --git a/src/middlewares/parsers/schema.preprocessor.ts b/src/middlewares/parsers/schema.preprocessor.ts
@@ -356,7 +356,7 @@ export class SchemaPreprocessor {
       !!schema.format &&
       this.serDesMap[schema.format]
     ) {
-      (<any>schema).type = ['object', 'string'];
+      (<any>schema).type = [this.serDesMap[schema.format].jsonType || 'object', 'string'];
       schema['x-eov-serdes'] = this.serDesMap[schema.format];
     }
   }

diff --git a/test/resources/serdes.yaml b/test/resources/serdes.yaml
@@ -51,11 +51,16 @@ components:
     DateTime:
       type: string
       format: date-time
+    StringList:
+      type: string
+      format: string-list
     User:
       type: object
       properties:
         id:
           $ref: "#/components/schemas/ObjectId"
+        tags:
+          $ref: "#/components/schemas/StringList"
         creationDateTime:
           $ref: "#/components/schemas/DateTime"
         creationDate: