fix: apply feedback

inc update Signed-off-by: Douglas McConnachie <[email protected]>
loopbackio · Apr 16, 2020 · 3a4ddd5 · 3a4ddd5
1 parent c2f7114
commit 3a4ddd5
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 49 deletions.
diff --git a/packages/openapi-v3/package-lock.json b/packages/openapi-v3/package-lock.json
diff --git a/packages/rest/src/__tests__/unit/rest.server/consolidate.spec.extension.unit.ts b/packages/rest/src/__tests__/unit/rest.server/consolidate.spec.extension.unit.ts
@@ -4,9 +4,9 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {
-  ComponentsSpecBuilder,
-  OpenApiSpecBuilder,
-  OperationSpecBuilder,
+  aComponentsSpec,
+  anOpenApiSpec,
+  anOperationSpec,
 } from '@loopback/openapi-spec-builder';
 import {expect} from '@loopback/testlab';
 import {ConsolidationEnhancer} from '../../../spec-enhancers/consolidate.spec-enhancer';
@@ -15,11 +15,11 @@ const consolidationEnhancer = new ConsolidationEnhancer();
 
 describe('consolidateSchemaObjects', () => {
   it('moves schema with title to component.schemas, replaces with reference', () => {
-    const INPUT_SPEC = new OpenApiSpecBuilder()
+    const INPUT_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         '/',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -37,11 +37,11 @@ describe('consolidateSchemaObjects', () => {
       )
       .build();
 
-    const EXPECTED_SPEC = new OpenApiSpecBuilder()
+    const EXPECTED_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         '/',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -53,7 +53,7 @@ describe('consolidateSchemaObjects', () => {
         }),
       )
       .withComponents(
-        new ComponentsSpecBuilder().withSchema('loopback.example', {
+        aComponentsSpec().withSchema('loopback.example', {
           title: 'loopback.example',
           properties: {
             test: {
@@ -68,11 +68,11 @@ describe('consolidateSchemaObjects', () => {
   });
 
   it('ignores schema without title property', () => {
-    const INPUT_SPEC = new OpenApiSpecBuilder()
+    const INPUT_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         '/',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -93,11 +93,11 @@ describe('consolidateSchemaObjects', () => {
   });
 
   it('avoids naming collision', () => {
-    const INPUT_SPEC = new OpenApiSpecBuilder()
+    const INPUT_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         '/',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -114,7 +114,7 @@ describe('consolidateSchemaObjects', () => {
         }),
       )
       .withComponents(
-        new ComponentsSpecBuilder().withSchema('loopback.example', {
+        aComponentsSpec().withSchema('loopback.example', {
           title: 'Different loopback.example exists',
           properties: {
             testDiff: {
@@ -125,11 +125,11 @@ describe('consolidateSchemaObjects', () => {
       )
       .build();
 
-    const EXPECTED_SPEC = new OpenApiSpecBuilder()
+    const EXPECTED_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         '/',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -141,7 +141,7 @@ describe('consolidateSchemaObjects', () => {
         }),
       )
       .withComponents(
-        new ComponentsSpecBuilder()
+        aComponentsSpec()
           .withSchema('loopback.example', {
             title: 'Different loopback.example exists',
             properties: {
@@ -165,12 +165,12 @@ describe('consolidateSchemaObjects', () => {
   });
 
   it('consolidates same schema in multiple locations', () => {
-    const INPUT_SPEC = new OpenApiSpecBuilder()
+    const INPUT_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         // first time has 'loopback.example'
         '/path1',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -190,7 +190,7 @@ describe('consolidateSchemaObjects', () => {
         'get',
         // second time has 'loopback.example'
         '/path2',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -208,11 +208,11 @@ describe('consolidateSchemaObjects', () => {
       )
       .build();
 
-    const EXPECTED_SPEC = new OpenApiSpecBuilder()
+    const EXPECTED_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         '/path1',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -226,7 +226,7 @@ describe('consolidateSchemaObjects', () => {
       .withOperation(
         'get',
         '/path2',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {
@@ -238,7 +238,7 @@ describe('consolidateSchemaObjects', () => {
         }),
       )
       .withComponents(
-        new ComponentsSpecBuilder().withSchema('loopback.example', {
+        aComponentsSpec().withSchema('loopback.example', {
           title: 'loopback.example',
           properties: {
             test: {
@@ -254,11 +254,11 @@ describe('consolidateSchemaObjects', () => {
 
   it('obeys disabled option when set to true', () => {
     consolidationEnhancer.disabled = true;
-    const INPUT_SPEC = new OpenApiSpecBuilder()
+    const INPUT_SPEC = anOpenApiSpec()
       .withOperation(
         'get',
         '/',
-        new OperationSpecBuilder().withResponse(200, {
+        anOperationSpec().withResponse(200, {
           description: 'Example',
           content: {
             'application/json': {

diff --git a/packages/rest/src/spec-enhancers/consolidate.spec-enhancer.ts b/packages/rest/src/spec-enhancers/consolidate.spec-enhancer.ts
@@ -67,7 +67,7 @@ export class ConsolidationEnhancer implements OASEnhancer {
     @inject(CoreBindings.APPLICATION_CONFIG, {optional: true})
     readonly config?: ApplicationConfig,
   ) {
-    this.disabled = !(this.config?.rest?.openApiSpec?.consolidate || true);
+    this.disabled = !(this.config?.rest?.openApiSpec?.consolidate ?? true);
   }
 
   modifySpec(spec: OpenApiSpec): OpenApiSpec {