fix(execute): parse stringified objects nested in arrays

[glowcloud]

Refs swagger-api/swagger-ui#9521

The URL for this example:

should now be encoded as:

http://localhost:3200/endpoint?param=%5B%7B%22a%22%3A%7B%22c%22%3A%22string%22%7D%2C%22b%22%3A0%7D%5D

which should decode to:

http://localhost:3200/endpoint?param=[{"a":{"c":"string"},"b":0}]

[glowcloud]

We're also doing a similar thing for parameters with schema and type object before going into builders:

swagger-js/src/execute/index.js

Lines 253 to 264 in f72651a

	if (
	specIsOAS3 &&
	parameter.schema &&
	parameter.schema.type === 'object' &&
	typeof value === 'string'
	) {
	try {
	value = JSON.parse(value);
	} catch (e) {
	throw new Error('Could not parse object parameter value string as JSON');
	}
	}

I was thinking of moving the parsing for arrays there as well, and I think it would have to look something like this:

if (
  specIsOAS3 &&
  parameter.content &&
  parameter.content['application/json'] &&
  parameter.content['application/json'].schema?.type === 'array' &&
  Array.isArray(value)
) {
  value = value.map((v) => {
    try {
      return JSON.parse(v);
    } catch (e) {
      return v;
    }
  });
}

so not sure if having this would actually be better.

[glowcloud]

I see that we can also refactor this line

swagger-js/src/execute/oas3/content-serializer.js

Line 26 in 5c60b7e

return value.toString();

to

return String(value)

[char0n]

return String(value)

Yeah sure, it's small enough change to smuggle it with the bugfix.

[char0n]

I was thinking of moving the parsing for arrays there as well, and I think it would have to look something like this:

I was thinking the other way around, cannot we move the code from

swagger-js/src/execute/index.js

Lines 253 to 264 in f72651a

	if (
	specIsOAS3 &&
	parameter.schema &&
	parameter.schema.type === 'object' &&
	typeof value === 'string'
	) {
	try {
	value = JSON.parse(value);
	} catch (e) {
	throw new Error('Could not parse object parameter value string as JSON');
	}
	}

to content-serializer to contain the logic there? If it's not possible, then placing your new code in

swagger-js/src/execute/index.js

Lines 253 to 264 in f72651a

	if (
	specIsOAS3 &&
	parameter.schema &&
	parameter.schema.type === 'object' &&
	typeof value === 'string'
	) {
	try {
	value = JSON.parse(value);
	} catch (e) {
	throw new Error('Could not parse object parameter value string as JSON');
	}
	}

should be just fine.

[glowcloud]

I was thinking of moving the parsing for arrays there as well, and I think it would have to look something like this:

I was thinking the other way around, cannot we move the code from

swagger-js/src/execute/index.js

Lines 253 to 264 in f72651a

	if (
	specIsOAS3 &&
	parameter.schema &&
	parameter.schema.type === 'object' &&
	typeof value === 'string'
	) {
	try {
	value = JSON.parse(value);
	} catch (e) {
	throw new Error('Could not parse object parameter value string as JSON');
	}
	}

to content-serializer to contain the logic there? If it's not possible, then placing your new code in

swagger-js/src/execute/index.js

Lines 253 to 264 in f72651a

	if (
	specIsOAS3 &&
	parameter.schema &&
	parameter.schema.type === 'object' &&
	typeof value === 'string'
	) {
	try {
	value = JSON.parse(value);
	} catch (e) {
	throw new Error('Could not parse object parameter value string as JSON');
	}
	}

should be just fine.

We can't move this to content-serializer as that's only for parameters with content, while this one is for parameters with schema. And I think that changing this to combine both logics might also create unnecessary parsing for arrays with objects in schema.

[char0n]

LGTM. nicely done

[swagger-bot]

🎉 This PR is included in version 3.26.8 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀