Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

resource methods: deduplicate request types between regular and body methods #166

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
+91 −72
Draft

resource methods: deduplicate request types between regular and body methods #166

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
077c53a
resource methods: deduplicate request types between regular and body …
declanvong May 11, 2020
2fa3178
autoformat
declanvong May 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 81 additions & 68 deletions src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import { promisify } from 'bluebird';
import sortObject from 'deep-sort-object';
import fs from 'fs';
import lineReader from 'line-reader';
import _ from 'lodash';
import path, {basename, join, resolve} from 'path';
import path, { basename, join, resolve } from 'path';
import request from 'request';
import sortObject from 'deep-sort-object';
import lineReader from 'line-reader';
import {promisify} from 'bluebird';
import { Template } from './template';
import {
camelCaseParts,
ensureDirectoryExists,
getResourceTypeName,
getTypeName,
parseVersion,
} from './utils';
import {StreamWriter, TextWriter} from './writer';
import {Template} from './template';
import { StreamWriter, TextWriter } from './writer';

type JsonSchema = gapi.client.discovery.JsonSchema;
type RestResource = gapi.client.discovery.RestResource;
Expand Down Expand Up @@ -417,10 +419,11 @@ function getMethodReturn(
const name = schemas['Request'] ? 'client.Request' : 'Request';

if (method.response) {
const schema = schemas[checkExists(method.response.$ref)];
const schemaName = method.response.$ref;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated refactoring

const schema = schemas[checkExists(schemaName)];

if (schema && !_.isEmpty(schema.properties)) {
return `${name}<${method.response.$ref}>`;
if (schema && !isEmptySchema(schema)) {
return `${name}<${schemaName}>`;
} else {
return `${name}<{}>`;
}
Expand Down Expand Up @@ -461,34 +464,6 @@ export class App {
return dir;
}

/**
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer consumed or needed, since we've replaced it with a simpler method write.

* Creates a callback that writes request parameters.
*/
private static createRequestParameterWriterCallback(
parameters: Record<string, JsonSchema>,
schemas: Record<string, JsonSchema>,
ref?: string
) {
return function requestParameterWriterCallback(
writer: TypescriptTextWriter
) {
writer.anonymousType(() => {
_.forEach(parameters, (data, key) => {
if (data.description) {
writer.comment(formatComment(data.description));
}

writer.property(key, getType(data, schemas), Boolean(data.required));
});

if (ref) {
writer.comment('Request body');
writer.property('resource', ref, true);
}
});
};
}

/**
* Writes specified resource definition.
*/
Expand All @@ -498,38 +473,83 @@ export class App {
parameters: Record<string, JsonSchema> = {},
schemas: Record<string, JsonSchema>
) {
_.forEach(resources, (resource, resourceName) => {
const resourceInterfaceName = getResourceTypeName(resourceName);
// Accumulates the request method parameter types, to be written after all of the resource interfaces.
const requestTypeWriters: (() => void)[] = [];

// Write all resource interfaces
_.forEach(resources, (resource, resourceName) => {
if (resource.resources) {
this.writeResources(out, resource.resources, parameters, schemas);
}

out.interface(resourceInterfaceName, () => {
out.interface(getResourceTypeName(resourceName), () => {
if (resource.resources) {
_.forEach(resource.resources, (_, childResourceName) => {
const childResourceInterfaceName = getResourceTypeName(
childResourceName
);
out.property(childResourceName, childResourceInterfaceName);
});
}
Comment on lines +485 to +492
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has just been moved up from below, wasn't touched


_.forEach(resource.methods, method => {
if (method.description) {
out.comment(formatComment(method.description));
}

const requestRef = method.request?.$ref;
const requestParameters: Record<string, JsonSchema> = sortObject({
...parameters,
...method.parameters,
// Construct request type, e.g. get(...) on InvitationsResource -> GetInvitationsRequest
const methodType = checkExists(getName(method.id));
const methodParts = method.id?.split('.');
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As raised in the previous PR, we weren't including the parent path down to the resource method, which meant we'd get some interface duplication, e.g. NotesResource in the containeranalysis API.

Using method.id (looks something like containeranalysis.projects.notes.occurrences.list) instead of just resourceName (just notes) will let us process it into something like ListProjectsNotesOccurencesRequest, which is fully namespaced and shouldn't conflict.

const methodName = methodParts
? camelCaseParts(methodParts.slice(1, methodParts.length - 1))
: '';
const requestTypeName =
methodType[0].toUpperCase() +
methodType.slice(1) +
methodName +
'Request';

const hasResourcePolicy = !!(
parameters.resource || method.parameters?.resource
);

// Prepare the request object to be written
requestTypeWriters.push(() => {
out.interface(requestTypeName, (writer: TypescriptTextWriter) => {
const requestParams: Record<string, JsonSchema> = sortObject({
...parameters,
...method.parameters,
});

_.forEach(requestParams, (data, key) => {
if (data.description) {
writer.comment(formatComment(data.description));
}
writer.property(
key,
getType(data, schemas),
data.required || false
);
});

// If the request takes a body (e.g. a POST request), add it as the 'resource' property.
if (method.request?.$ref && !hasResourcePolicy) {
writer.comment('Request body');
writer.property('resource', method.request.$ref, true);
}
});
});

if (!requestParameters.resource || !requestRef) {
const requestRef = method.request?.$ref;
if (!hasResourcePolicy || !requestRef) {
// generate method(request)
out.method(
formatPropertyName(checkExists(getName(method.id))),
formatPropertyName(methodType),
[
{
parameter: 'request',
type: App.createRequestParameterWriterCallback(
requestParameters,
schemas,
requestRef
),
required: Boolean(requestRef),
type: requestTypeName,
required: !!method.parameters,
},
],
getMethodReturn(method, schemas)
Expand All @@ -539,37 +559,30 @@ export class App {
if (requestRef) {
// generate method(request, body)
out.method(
formatPropertyName(checkExists(getName(method.id))),
formatPropertyName(methodType),
[
{
parameter: 'request',
type: App.createRequestParameterWriterCallback(
requestParameters,
schemas
),
required: true,
type: `Omit<${requestTypeName}, 'resource'>`,
required: !!method.parameters,
},
{
parameter: 'body',
type: requestRef,
type: hasResourcePolicy
? requestRef
: `${requestTypeName}['resource']`,
required: true,
},
],
getMethodReturn(method, schemas)
);
}
});

if (resource.resources) {
_.forEach(resource.resources, (_, childResourceName) => {
const childResourceInterfaceName = getResourceTypeName(
childResourceName
);
out.property(childResourceName, childResourceInterfaceName);
});
}
});
});

// Then write all request types
requestTypeWriters.forEach(write => write());
}

private static getTypingsName(api: string, version: string | null) {
Expand Down
19 changes: 13 additions & 6 deletions src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,23 @@ export function parseVersion(version: string) {
return matches ? `${matches[1] || 0}.${matches[2] || 0}` : '0.0';
}

export function camelCaseParts(parts: string[]) {
return parts.map(x => `${x[0].toUpperCase()}${x.substring(1)}`).join('');
}

export function getTypeName(resourceName: string) {
if (resourceName.trim() === '') {
return '';
}
resourceName = camelCaseParts(resourceName.split(/[.-]/));
return `${resourceName[0].toUpperCase()}${resourceName.substring(1)}`;
}

/**
* Returns the capitalized name of the TypeScript interface for the specified resource.
*/
export function getResourceTypeName(resourceName: string) {
resourceName = resourceName
.split('-')
.map(x => `${x[0].toUpperCase()}${x.substring(1)}`)
.join('');

return `${resourceName[0].toUpperCase()}${resourceName.substring(1)}Resource`;
return getTypeName(resourceName) + 'Resource';
}

/**
Expand Down