fix: query string is incorrectly serialized for primitive parameters (#103)

kokovtsev · kokovtsev · commit cbcd3bcb8fbf · 2020-04-15T10:45:29.000+03:00
diff --git a/src/language/typescript/2.0/serializers/operation-object.ts b/src/language/typescript/2.0/serializers/operation-object.ts
@@ -411,8 +411,8 @@ export const serializeQueryParameterObject = (
 		case 'number':
 		case 'boolean': {
 			const f = serializedFragment(
-				`value => encodeURIComponent('${parameter.name}') + '=' + encodeURIComponent(value)`,
-				[],
+				`value => some(encodeURIComponent('${parameter.name}') + '=' + encodeURIComponent(value))`,
+				[serializedDependency('some', 'fp-ts/lib/Option')],
 				[],
 			);
 			return right(getSerializedOptionCallFragment(!required, f, encoded));
@@ -430,16 +430,16 @@ export const serializeQueryParameterObject = (
 				case 'pipes': {
 					const s = getCollectionSeparator(collectionFormat);
 					const f = serializedFragment(
-						`value => encodeURIComponent('${parameter.name}') + '=' + encodeURIComponent(value.join('${s}'))`,
-						[],
+						`value => some(encodeURIComponent('${parameter.name}') + '=' + encodeURIComponent(value.join('${s}')))`,
+						[serializedDependency('some', 'fp-ts/lib/Option')],
 						[],
 					);
 					return right(getSerializedOptionCallFragment(!required, f, encoded));
 				}
 				case 'multi': {
 					const f = serializedFragment(
-						`value => value.map(item => encodeURIComponent('${parameter.name}') + '=' + encodeURIComponent(item)).join('&')`,
-						[],
+						`value => some(value.map(item => encodeURIComponent('${parameter.name}') + '=' + encodeURIComponent(item)).join('&'))`,
+						[serializedDependency('some', 'fp-ts/lib/Option')],
 						[],
 					);
 					return right(getSerializedOptionCallFragment(!required, f, encoded));
diff --git a/src/language/typescript/3.0/bundled/openapi-3-utils.ts b/src/language/typescript/3.0/bundled/openapi-3-utils.ts
@@ -14,16 +14,16 @@ const content = `
 	export const serializePrimitiveParameter = (style: string, name: string, value: unknown): Either<Error, string> => {
 		switch (style) {
 			case 'matrix': {
-				return right(\`;\${name}=\${value}\`);
+				return right(\`;\${name}=\${encodeURIComponent(String(value))}\`);
 			}
 			case 'label': {
-				return right(\`.\${value}\`);
+				return right(\`.\${encodeURIComponent(String(value))}\`);
 			}
 			case 'form': {
-				return right(\`\${name}=\${value}\`);
+				return right(\`\${name}=\${encodeURIComponent(String(value))}\`);
 			}
 			case 'simple': {
-				return right(\`\${value}\`);
+				return right(\`\${encodeURIComponent(String(value))}\`);
 			}
 		}
 		return left(new Error(\`Unsupported style "\${style}" for parameter "\${name}"\`));
diff --git a/src/language/typescript/3.0/serializers/__tests__/operation-object.spec.ts b/src/language/typescript/3.0/serializers/__tests__/operation-object.spec.ts
@@ -0,0 +1,71 @@
+import { getParameters as createGetParameters } from '../operation-object';
+import { constant } from 'fp-ts/lib/function';
+import { left } from 'fp-ts/lib/Either';
+import { fromString } from '../../../../../utils/ref';
+import { PathItemObjectCodec } from '../../../../../schema/3.0/path-item-object';
+import { pipe } from 'fp-ts/lib/pipeable';
+import { either, option } from 'fp-ts';
+import { OperationObjectCodec } from '../../../../../schema/3.0/operation-object';
+import { sequenceTEither } from '@devexperts/utils/dist/adt/either.utils';
+
+describe('OperationObject', () => {
+	describe('getParameters', () => {
+		const getParameters = createGetParameters({
+			resolveRef: constant(left(new Error('Refs not supported'))),
+		});
+
+		it('should correctly handle primitive query parameters', () => {
+			const operation = pipe(
+				OperationObjectCodec.decode({
+					responses: {},
+					parameters: [
+						{
+							in: 'query',
+							name: 'offset',
+							required: false,
+							schema: {
+								type: 'number',
+							},
+						},
+						{
+							in: 'query',
+							name: 'limit',
+							required: true,
+							schema: {
+								type: 'number',
+							},
+						},
+					],
+				}),
+				either.mapLeft(constant(new Error())),
+			);
+
+			const pathItem = pipe(PathItemObjectCodec.decode({}), either.mapLeft(constant(new Error())));
+
+			const result = pipe(
+				sequenceTEither(fromString('#/test'), operation, pathItem),
+				either.chain(([ref, operation, pathItem]) => getParameters(ref, operation, pathItem)),
+			);
+
+			const generated = pipe(
+				result,
+				option.fromEither,
+				option.chain(result => result.serializedQueryString),
+				option.fold(constant(''), fragment => fragment.value.replace(/\s+/g, ' ')),
+			);
+
+			expect(generated).toEqual(
+				`compact([pipe(
+					optionFromNullable(number).encode(parameters.query.offset),
+					option.fromNullable,
+					option.chain(value => option.fromEither(serializePrimitiveParameter('form', 'offset', value))),
+				),pipe(
+					number.encode(parameters.query.limit),
+					value => option.fromEither(serializePrimitiveParameter('form', 'limit', value)),
+				)]).join('&')`
+					.trim()
+					.replace(/\s+/g, ' '),
+			);
+		});
+	});
+});
diff --git a/src/language/typescript/3.0/serializers/operation-object.ts b/src/language/typescript/3.0/serializers/operation-object.ts
@@ -12,7 +12,7 @@ import {
 	getParameterObjectSchema,
 	isRequired,
 	serializeParameterObject,
-	serializeParameterToTemplate,
+	serializeQueryParameterToTemplate,
 } from './parameter-object';
 import { pipe } from 'fp-ts/lib/pipeable';
 import { getSerializedKindDependency, serializedDependency } from '../../common/data/serialized-dependency';
@@ -70,7 +70,7 @@ const eqParameterByNameAndIn: Eq<ParameterObject> = getStructEq({
 });
 const contains = array.elem(eqParameterByNameAndIn);
 
-const getParameters = combineReader(
+export const getParameters = combineReader(
 	ask<ResolveRefContext>(),
 	e => (from: Ref, operation: OperationObject, pathItem: PathItemObject): Either<Error, Parameters> => {
 		const processedParameters: ParameterObject[] = [];
@@ -142,7 +142,7 @@ const getParameters = combineReader(
 						return resolvedSchema;
 					}
 
-					const queryStringFragment = serializeParameterToTemplate(
+					const queryStringFragment = serializeQueryParameterToTemplate(
 						from,
 						resolved.right,
 						resolvedSchema.right,
@@ -209,7 +209,7 @@ const getParameters = combineReader(
 			option.map(f =>
 				combineFragmentsK(f, c =>
 					serializedFragment(
-						`encodeURIComponent(compact([${c}]).join('&'))`,
+						`compact([${c}]).join('&')`,
 						[serializedDependency('compact', 'fp-ts/lib/Array')],
 						[],
 					),
diff --git a/src/language/typescript/3.0/serializers/parameter-object.ts b/src/language/typescript/3.0/serializers/parameter-object.ts
@@ -85,7 +85,7 @@ const getParameterExplode = (parameter: ParameterObject): boolean =>
 		option.getOrElse(() => getParameterObjectStyle(parameter) === 'form'),
 	);
 
-export const serializeParameterToTemplate = (
+export const serializeQueryParameterToTemplate = (
 	from: Ref,
 	parameter: ParameterObject,
 	parameterSchema: SchemaObject,
@@ -121,26 +121,32 @@ const getFn = (
 	if (PrimitiveSchemaObjectCodec.is(schema)) {
 		return right(
 			serializedFragment(
-				`value => serializePrimitiveParameter('${style}', '${parameter.name}', value)`,
-				[serializedDependency('serializePrimitiveParameter', pathToUtils)],
+				`value => option.fromEither(serializePrimitiveParameter('${style}', '${parameter.name}', value))`,
+				[
+					serializedDependency('option', 'fp-ts'),
+					serializedDependency('serializePrimitiveParameter', pathToUtils),
+				],
 				[],
 			),
 		);
 	}
 	if (ArraySchemaObjectCodec.is(schema)) {
 		return right(
 			serializedFragment(
-				`value => serializeArrayParameter('${style}', '${parameter.name}', value, ${explode})`,
-				[serializedDependency('serializeArrayParameter', pathToUtils)],
+				`value => option.fromEither(serializeArrayParameter('${style}', '${parameter.name}', value, ${explode}))`,
+				[serializedDependency('option', 'fp-ts'), serializedDependency('serializeArrayParameter', pathToUtils)],
 				[],
 			),
 		);
 	}
 	if (ObjectSchemaObjectCodec.is(schema)) {
 		return right(
 			serializedFragment(
-				`value => serializeObjectParameter('${style}', '${parameter.name}', value, ${explode})`,
-				[serializedDependency('serializeObjectParameter', pathToUtils)],
+				`value => option.fromEither(serializeObjectParameter('${style}', '${parameter.name}', value, ${explode}))`,
+				[
+					serializedDependency('option', 'fp-ts'),
+					serializedDependency('serializeObjectParameter', pathToUtils),
+				],
 				[],
 			),
 		);
diff --git a/src/language/typescript/common/data/serialized-fragment.ts b/src/language/typescript/common/data/serialized-fragment.ts
@@ -125,6 +125,9 @@ export function combineFragmentsK(
 	return serializedFragment(fragment.value, dependencies.concat(fragment.dependencies), refs.concat(fragment.refs));
 }
 
+/**
+ * @param f returns an Option
+ */
 export const getSerializedOptionCallFragment = (
 	nullable: boolean,
 	f: SerializedFragment,
@@ -136,12 +139,19 @@ export const getSerializedOptionCallFragment = (
 					`pipe(
 							${a},
 							option.fromNullable,
-							option.map(${fn}),
+							option.chain(${fn}),
 						)`,
 					[serializedDependency('option', 'fp-ts'), serializedDependency('pipe', 'fp-ts/lib/pipeable')],
 					[],
 			  )
-			: serializedFragment(`some((${fn})(${a}))`, [serializedDependency('some', 'fp-ts/lib/Option')], []),
+			: serializedFragment(
+					`pipe(
+							${a},
+							${fn},
+						)`,
+					[serializedDependency('pipe', 'fp-ts/lib/pipeable')],
+					[],
+			  ),
 	);
 
 export const commaFragment = serializedFragment(', ', [], []);

Original file line number	Diff line number	Diff line change
@@ -14,16 +14,16 @@ const content = `
`14`	`14`	`export const serializePrimitiveParameter = (style: string, name: string, value: unknown): Either<Error, string> => {`
`15`	`15`	`switch (style) {`
`16`	`16`	`case 'matrix': {`
`17`		- return right(\`;\${name}=\${value}\`);
	`17`	+ return right(\`;\${name}=\${encodeURIComponent(String(value))}\`);
`18`	`18`	`}`
`19`	`19`	`case 'label': {`
`20`		- return right(\`.\${value}\`);
	`20`	+ return right(\`.\${encodeURIComponent(String(value))}\`);
`21`	`21`	`}`
`22`	`22`	`case 'form': {`
`23`		- return right(\`\${name}=\${value}\`);
	`23`	+ return right(\`\${name}=\${encodeURIComponent(String(value))}\`);
`24`	`24`	`}`
`25`	`25`	`case 'simple': {`
`26`		- return right(\`\${value}\`);
	`26`	+ return right(\`\${encodeURIComponent(String(value))}\`);
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	return left(new Error(\`Unsupported style "\${style}" for parameter "\${name}"\`));