fix(cli): escape identifiers with conflicting name as decorators

Author: raymondfeng

packages/cli/generators/openapi/spec-helper.js

@@ -193,7 +193,7 @@ function buildMethodSpec(controllerSpec, op, options) {
   const paramNames = {};
   if (parameters) {
     args = parameters.map(p => {
-      const name = escapeIdentifier(p.name);
+      let name = escapeIdentifier(p.name);
       if (name in paramNames) {
         name = `${name}${paramNames[name]++}`;
       } else {
@@ -234,6 +234,7 @@ function buildMethodSpec(controllerSpec, op, options) {
     if (bodyName in paramNames) {
       bodyName = `${bodyName}${paramNames[bodyName]++}`;
     }
+    bodyName = escapeIdentifier(bodyName);
     if (contentType && contentType.schema) {
       registerAnonymousSchema(
         [methodName, bodyName],

packages/cli/generators/openapi/utils.js

@@ -128,6 +128,11 @@ const JS_KEYWORDS = [
   'false',
 ];
 
+/**
+ * Avoid tslint error - Shadowed name: 'requestBody'
+ */
+const DECORATOR_NAMES = ['operation', 'param', 'requestBody'];
+
 const SAFE_IDENTIFER = /^[a-zA-Z_$][0-9a-zA-Z_$]*$/;
 
 /**
@@ -148,6 +153,9 @@ function escapeIdentifier(name) {
   if (!name.match(SAFE_IDENTIFER)) {
     name = _.camelCase(name);
   }
+  if (DECORATOR_NAMES.includes(name)) {
+    return '_' + name;
+  }
   return name;
 }
 

packages/cli/test/integration/generators/openapi-uspto-with-anonymous.integration.js

@@ -55,7 +55,7 @@ describe('openapi-generator specific files', () => {
 
     assert.fileContent(
       searchController,
-      `async performSearch(@requestBody() requestBody: PerformSearchRequestBody, ` +
+      `async performSearch(@requestBody() _requestBody: PerformSearchRequestBody, ` +
         `@param({name: 'version', in: 'path'}) version: string, ` +
         `@param({name: 'dataset', in: 'path'}) dataset: string): ` +
         `Promise<PerformSearchResponseBody> {`,

packages/cli/test/unit/openapi/controller-spec.unit.js

@@ -44,13 +44,13 @@ describe('openapi to controllers/models', () => {
             comments: [
               'Creates a new customer',
               '\n',
-              '@param requestBody Customer to add',
+              '@param _requestBody Customer to add',
               '@param accessToken Access token',
               '@returns customer response',
             ],
             decoration: "@operation('post', '/customers')",
             signature:
-              'async createCustomer(@requestBody() requestBody: Customer, ' +
+              'async createCustomer(@requestBody() _requestBody: Customer, ' +
               "@param({name: 'access-token', in: 'query'}) accessToken: " +
               'string): Promise<Customer>',
           },

packages/cli/test/unit/openapi/openapi-utils.unit.js

@@ -11,6 +11,12 @@ describe('openapi utils', () => {
     expect(utils.escapeIdentifier('for')).to.eql('_for');
   });
 
+  it('escapes an identifier conflicting with decorators for ', () => {
+    expect(utils.escapeIdentifier('requestBody')).to.eql('_requestBody');
+    expect(utils.escapeIdentifier('operation')).to.eql('_operation');
+    expect(utils.escapeIdentifier('param')).to.eql('_param');
+  });
+
   it('escapes illegal chars for an identifier', () => {
     expect(utils.escapeIdentifier('foo bar')).to.eql('fooBar');
     expect(utils.escapeIdentifier('foo-bar')).to.eql('fooBar');