fix(core): remove duplicate imports generated by swagger-typescript (#…

…502)
nx-dotnet · Aug 29, 2022 · 0fc17d4 · 0fc17d4
1 parent 22b4159
commit 0fc17d4
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 19 deletions.
diff --git a/packages/core/src/generators/swagger-typescript/__snapshots__/generator.spec.ts.snap b/packages/core/src/generators/swagger-typescript/__snapshots__/generator.spec.ts.snap
@@ -0,0 +1,50 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`swagger-typescript generator should run successfully for OpenAPI 3.0: libs/generated-ts/src/index.ts 1`] = `
+"export * from './interfaces/company';
+export * from './interfaces/person';
+export * from './interfaces/temperature';
+export * from './interfaces/weather-forecast';
+"
+`;
+
+exports[`swagger-typescript generator should run successfully for OpenAPI 3.0: libs/generated-ts/src/interfaces/company.ts 1`] = `
+"import { Person } from './person';
+
+export interface Company {
+    CEO?: Person
+    employees?: Person[]
+}
+"
+`;
+
+exports[`swagger-typescript generator should run successfully for OpenAPI 3.0: libs/generated-ts/src/interfaces/person.ts 1`] = `
+"import { Company } from './company';
+
+export interface Person {
+    employer?: Company
+}
+"
+`;
+
+exports[`swagger-typescript generator should run successfully for OpenAPI 3.0: libs/generated-ts/src/interfaces/temperature.ts 1`] = `
+"
+export interface Temperature {
+    temperatureC: number
+    temperatureF: number
+}
+"
+`;
+
+exports[`swagger-typescript generator should run successfully for OpenAPI 3.0: libs/generated-ts/src/interfaces/weather-forecast.ts 1`] = `
+"import { Temperature } from './temperature';
+import { Person } from './person';
+
+export interface WeatherForecast {
+    date: string
+    temperature?: Temperature
+    summary?: string
+    forecaster?: Person
+}
+"
+`;
diff --git a/packages/core/src/generators/swagger-typescript/generator.spec.ts b/packages/core/src/generators/swagger-typescript/generator.spec.ts
@@ -56,6 +56,9 @@ const MOCK_SWAGGER_JSON = `{
       "Company": {
         "type": "object",
         "properties": {
+          "CEO": {
+            "$ref": "#/components/schemas/Person"
+          },
           "employees": {
             "type": "array",
             "items": {
@@ -129,24 +132,31 @@ describe('swagger-typescript generator', () => {
       outputProject: 'generated-ts',
     });
 
+    // tree
+    //   .listChanges()
+    //   .forEach((change) =>
+    //     console.log(change.path, change.content?.toString()),
+    //   );
+
+    expectFileToMatchSnapshot(
+      'libs/generated-ts/src/interfaces/weather-forecast.ts',
+      tree,
+    );
     expectFileToMatchSnapshot(
-      'libs/generated-ts/src/interfaces/weather-forecast',
+      'libs/generated-ts/src/interfaces/temperature.ts',
       tree,
     );
     expectFileToMatchSnapshot(
-      'libs/generated-ts/src/interfaces/weather-forecasts',
+      'libs/generated-ts/src/interfaces/person.ts',
       tree,
     );
     expectFileToMatchSnapshot(
-      'libs/generated-ts/src/interfaces/temperature',
+      'libs/generated-ts/src/interfaces/company.ts',
       tree,
     );
-    expectFileToMatchSnapshot('libs/generated-ts/src/interfaces/person', tree);
-    expectFileToMatchSnapshot('libs/generated-ts/src/interfaces/company', tree);
-    // const config = readProjectConfiguration(appTree, 'test');
-    // expect(config).toBeDefined();
+    expectFileToMatchSnapshot('libs/generated-ts/src/index.ts', tree);
   });
 });
 
 const expectFileToMatchSnapshot = (file: string, tree: Tree) =>
-  expect(tree.read(file)?.toString()).toMatchSnapshot;
+  expect(tree.read(file)?.toString()).toMatchSnapshot(file);
diff --git a/packages/core/src/generators/swagger-typescript/generator.ts b/packages/core/src/generators/swagger-typescript/generator.ts
@@ -33,11 +33,15 @@ function generateInterfaceFiles(
         ? [tsInterface.elements]
         : []
     )?.reduce((necessary, next) => {
-      if (next !== 'object' && !builtInTypes.has(next)) {
-        necessary.push(names(next));
+      if (
+        next !== 'object' &&
+        !builtInTypes.has(next) &&
+        !necessary.has(next)
+      ) {
+        necessary.set(next, names(next));
       }
       return necessary;
-    }, [] as ReturnType<typeof names>[]);
+    }, new Map<string, ReturnType<typeof names>>());
 
     const templateOptions = {
       ...options,

diff --git a/...re/src/generators/swagger-typescript/templates/interface/__interfaceFileName__.ts__tmpl__ b/...re/src/generators/swagger-typescript/templates/interface/__interfaceFileName__.ts__tmpl__
@@ -1,13 +1,13 @@
-<% if (necessaryImports) for (const i of necessaryImports) { -%>
-import {<%=i.className%>} from './<%=i.fileName%>';
-<% } %>
+<% if (necessaryImports) for (const [, i] of necessaryImports) { -%>
+import { <%=i.className%> } from './<%=i.fileName%>';
+<% } -%>
 
-<% if (tsInterface.type === 'interface') { %>
+<% if (tsInterface.type === 'interface') { -%>
 export interface <%= interfaceClassName %> {
-    <% for (const property of tsInterface.properties) {-%>
+    <%_ for (const property of tsInterface.properties) {-%>
     <%= property.name %><% if (property.nullable) { %>?<%}%>: <%= property.type %>
-    <% } %>
+    <%_ } -%>
 }
-<% } else if (tsInterface.type === 'array') {%>
+<% } else if (tsInterface.type === 'array') { -%>
 export type <%= interfaceClassName %> = <%= tsInterface.elements %>[]
-<% } %>
+<% } -%>