Skip to content

Commit

Permalink
Merge pull request #139 from kokovtsev/feature/asyncapi-channel-params
Browse files Browse the repository at this point in the history 
feat(asyncapi): channel parameters
  • Loading branch information
@nikolaenkov
nikolaenkov authored May 17, 2021
2 parents 977f534 + 33ea85d commit b4bc263
Show file tree
Hide file tree
Showing 11 changed files with 499 additions and 143 deletions.
26 changes: 15 additions & 11 deletions src/language/typescript/3.0/serializers/__tests__/operation-object.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ 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';
import { normalizeCodeSnippet } from '../../../../../../test/utils';

describe('OperationObject', () => {
describe('getParameters', () => {
Expand Down Expand Up @@ -51,20 +52,23 @@ describe('OperationObject', () => {
result,
option.fromEither,
option.chain(result => result.serializedQueryString),
option.fold(constant(''), fragment => fragment.value.replace(/\s+/g, ' ')),
option.fold(constant(''), fragment => normalizeCodeSnippet(fragment.value)),
);

expect(generated).toEqual(
`compact([pipe(
optionFromNullable(number).encode(parameters.query['offset']),
option.fromNullable,
option.chain(value => fromEither(serializePrimitiveParameter('form', 'offset', value))),
),pipe(
number.encode(parameters.query['limit']),
value => fromEither(serializePrimitiveParameter('form', 'limit', value)),
)]).join('&')`
.trim()
.replace(/\s+/g, ' '),
normalizeCodeSnippet(`
compact([
pipe(
optionFromNullable(number).encode(parameters.query['offset']),
option.fromNullable,
option.chain(value => fromEither(serializePrimitiveParameter('form', 'offset', value))),
),
pipe(
number.encode(parameters.query['limit']),
value => fromEither(serializePrimitiveParameter('form', 'limit', value)),
)
]).join('&')
`),
);
});
});
Expand Down
204 changes: 204 additions & 0 deletions src/language/typescript/asyncapi-2.0.0/serializers/__tests__/channel-item-object.spec.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
import { constant } from 'fp-ts/lib/function';
import { fromString } from '../../../../../utils/ref';
import { pipe } from 'fp-ts/lib/pipeable';
import { either, record } from 'fp-ts';
import { sequenceTEither } from '@devexperts/utils/dist/adt/either.utils';
import { ChannelItemObjectCodec } from '../../../../../schema/asyncapi-2.0.0/channel-item-object';
import { serializeChannelItemObject as createSerializeChannelItemObject } from '../channel-item-object';
import { normalizeType } from '../../../../../../test/utils';
import { reportIfFailed } from '../../../../../utils/io-ts';
import { flow } from 'fp-ts/lib/function';

const refs = {
'#/components/schemas/ChatCategory': {
schema: {
type: 'string',
},
},
};

describe('ChannelItemObject', () => {
describe('serializeChannelItemObject', () => {
const serializeChannelItemObject = createSerializeChannelItemObject({
resolveRef: (ref, dec) =>
pipe(
record.lookup(ref, refs),
either.fromOption(() => new Error('Refs not supported')),
either.chain(flow(dec.decode, reportIfFailed)),
),
});

it('should correctly handle channel path parameters without other parameters', () => {
const operation = pipe(
ChannelItemObjectCodec.decode({
description: 'Sample channel',
parameters: {
userId: {
schema: { type: 'number' },
},
topic: {
schema: { type: 'string' },
},
},
publish: {
message: {
payload: {
type: 'object',
properties: {
text: { type: 'string' },
},
},
},
},
}),
either.mapLeft(constant(new Error())),
);

const result = pipe(
sequenceTEither(operation, fromString('#/whatever')),
either.chain(([op, ref]) => serializeChannelItemObject(ref, '/message/{userId}/{topic}', op, 'HKT')),
either.map(result =>
normalizeType({
...result,
io: `const channels = {${result.io}}`,
type: `type Channels = {${result.type}}`,
}),
),
);

expect(result).toEqual(
either.right(
normalizeType({
type: `
type Channels = {
['/message/{userId}/{topic}']:
(parameters: { topic: string; userId: number }) =>
{ send: (payload: { text: Option<string> }) => void }
}
`,
io: `
const channels = {['/message/{userId}/{topic}']: (parameters) => {
const channel = e.webSocketClient.channel({
channel: \`/message/\${encodeURIComponent(number.encode(parameters.userId).toString())}/\${encodeURIComponent(string.encode(parameters.topic).toString())}\`,
method: 'GET',
})
return {
send: payload => {
channel.send(type({ text: optionFromNullable(string) }).encode(payload));
}
};
}}`,
dependencies: [
{ name: 'string', path: 'io-ts' },
{ name: 'Option', path: 'fp-ts/lib/Option' },
{ name: 'optionFromNullable', path: 'io-ts-types/lib/optionFromNullable' },
{ name: 'type', path: 'io-ts' },
{ name: 'number', path: 'io-ts' },
{ name: 'WebSocketClient', path: './/client/client' },
{ name: 'partial', path: 'io-ts' },
],
refs: [],
}),
),
);
});

it('should correctly handle channel path parameters with other parameters', () => {
const operation = pipe(
ChannelItemObjectCodec.decode({
description: 'Sample channel',
parameters: {
userId: {
schema: { type: 'number' },
},
category: {
$ref: '#/components/schemas/ChatCategory',
},
},
bindings: {
ws: {
query: {
type: 'object',
properties: {
search: { type: 'string' },
},
},
},
},
publish: {
message: {
payload: {
type: 'object',
properties: {
text: { type: 'string' },
},
},
},
},
}),
either.mapLeft(constant(new Error())),
);

const result = pipe(
sequenceTEither(operation, fromString('#/whatever')),
either.chain(([op, ref]) => serializeChannelItemObject(ref, '/message/{userId}/{category}', op, 'HKT')),
either.map(result =>
normalizeType({
...result,
io: `const channels = {${result.io}}`,
type: `type Channels = {${result.type}}`,
}),
),
);

expect(result).toEqual(
either.right(
normalizeType({
type: `
type Channels = {
['/message/{userId}/{category}']:
(parameters: {query?: {search: Option<string>}; category: string; userId: number }) =>
{ send: (payload: { text: Option<string> }) => void }
}
`,
io: `
const channels = {
['/message/{userId}/{category}']: (parameters) => {
const encoded = partial({
query: type({ search: optionFromNullable(string) })
}).encode(parameters);
const channel = e.webSocketClient.channel({
channel: \`/message/\${
encodeURIComponent(number.encode(parameters.userId).toString())
}/\${
encodeURIComponent(string.encode(parameters.category).toString())
}\`,
method: 'GET',
...encoded
});
return {
send: payload => {
channel.send(type({ text: optionFromNullable(string) }).encode(payload));
}
};
}
}
`,
dependencies: [
{ name: 'string', path: 'io-ts' },
{ name: 'Option', path: 'fp-ts/lib/Option' },
{ name: 'optionFromNullable', path: 'io-ts-types/lib/optionFromNullable' },
{ name: 'type', path: 'io-ts' },
{ name: 'number', path: 'io-ts' },
{ name: 'WebSocketClient', path: './/client/client' },
{ name: 'partial', path: 'io-ts' },
],
refs: [],
}),
),
);
});
});
});
6 changes: 5 additions & 1 deletion src/language/typescript/asyncapi-2.0.0/serializers/asyncapi-object.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ import { utilsFile } from '../../common/bundled/utils';

export const serializeAsyncAPIObject = combineReader(
serializeComponentsObject,
serializeComponentsObject => (name: string, asyncAPIObject: AsyncAPIObject): Either<Error, FSEntity> => {
serializeChannelsObject,
(serializeComponentsObject, serializeChannelsObject) => (
name: string,
asyncAPIObject: AsyncAPIObject,
): Either<Error, FSEntity> => {
const components = pipe(
asyncAPIObject.components,
option.map(components =>
Expand Down
Loading

0 comments on commit b4bc263

Please sign in to comment.