feat: spike on url encoding of json object in query param

loopbackio · Nov 18, 2019 · 7f6f73d · 7f6f73d
1 parent fe83941
commit 7f6f73d
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 2 deletions.
diff --git a/examples/todo/src/__tests__/acceptance/todo.acceptance.ts b/examples/todo/src/__tests__/acceptance/todo.acceptance.ts
@@ -189,7 +189,7 @@ describe('TodoApplication', () => {
 
     await client
       .get('/todos')
-      .query({filter: {where: {isComplete: false}}})
+      .query({filter: encodeURIComponent(JSON.stringify({where: {isComplete: false}})) })
       .expect(200, [toJSON(todoInProgress)]);
   });
 

diff --git a/examples/todo/src/controllers/todo.controller.ts b/examples/todo/src/controllers/todo.controller.ts
@@ -84,7 +84,7 @@ export class TodoController {
     },
   })
   async findTodos(
-    @param.query.object('filter', getFilterSchemaFor(Todo))
+    @param.query.jsonObject('filter', getFilterSchemaFor(Todo))
     filter?: Filter<Todo>,
   ): Promise<Todo[]> {
     return this.todoRepo.find(filter);

diff --git a/packages/openapi-v3/src/decorators/parameter.decorator.ts b/packages/openapi-v3/src/decorators/parameter.decorator.ts
@@ -218,8 +218,39 @@ export namespace param {
         ...spec,
       });
     },
+
+    /**
+     * Define a parameter accepting a url encoded string of a JSON object,
+     *
+     * parameter is created with explode: false
+     * 
+     * @param name - Parameter name
+     * @param schema - Optional OpenAPI Schema describing the JSON object.
+     */
+    jsonObject: function(
+      name: string,
+      schema: SchemaObject | ReferenceObject = {
+        type: 'object',
+        additionalProperties: true,
+      },
+      spec?: Partial<ParameterObject>,
+    ) {
+      schema = {
+        type: 'object',
+        ...schema,
+      };
+      return param({
+        name,
+        in: 'query',
+        style: 'deepObject',
+        explode: false,
+        schema,
+        ...spec,
+      });
+    },
   };
 
+
   /**
    * Header parameter decorator
    */

diff --git a/packages/rest/src/coercion/coerce-parameter.ts b/packages/rest/src/coercion/coerce-parameter.ts
@@ -185,6 +185,12 @@ function parseJsonIfNeeded(
     return undefined;
   }
 
+  // if query param is deepObject but explode is false
+  // then a url encoded string is expected
+  if (spec.in === 'query' && spec.style === 'deepObject' && !spec.explode) {
+    data = decodeURIComponent(data);
+  }
+
   try {
     const result = parseJson(data);
     debug('Parsed parameter %s as %j', spec.name, result);