feat: add flag moveAllToComponents

asyncapi · Apr 6, 2024 · 13c0681 · 13c0681
1 parent d81adbd
commit 13c0681
Show file tree

Hide file tree

Showing 7 changed files with 181 additions and 143 deletions.
diff --git a/API.md b/API.md
@@ -35,6 +35,8 @@ user will only interact with this class. here we generate different kind of repo
 <dl>
 <dt><a href="#Rules">Rules</a> : <code>Object</code></dt>
 <dd></dd>
+<dt><a href="#DisableOptimizationFor">DisableOptimizationFor</a> : <code>Object</code></dt>
+<dd></dd>
 <dt><a href="#Options">Options</a> : <code>Object</code></dt>
 <dd></dd>
 </dl>
@@ -82,21 +84,21 @@ This function is used to get the optimized document after seeing the report.
 
 ## findAllComponents(optimizableComponentGroup) ⇒
 **Kind**: global function  
-**Returns**: A list of all elements in optimization report.  
+**Returns**: A list of optimization report elements.  
 
 | Param | Description |
 | --- | --- |
-| optimizableComponentGroup | list of all AsyncAPI Specification-valid components. |
+| optimizableComponentGroup | all AsyncAPI Specification-valid components. |
 
 <a name="findDuplicateComponents"></a>
 
 ## findDuplicateComponents(optimizableComponentGroup) ⇒
 **Kind**: global function  
-**Returns**: A list of duplicated elements in optimization report.  
+**Returns**: A list of optimization report elements.  
 
 | Param | Description |
 | --- | --- |
-| optimizableComponentGroup | list of all AsyncAPI Specification-valid components that you want to analyze for duplicates. |
+| optimizableComponentGroup | all AsyncAPI Specification-valid components that you want to analyze for duplicates. |
 
 <a name="hasParent"></a>
 
@@ -146,7 +148,16 @@ Converts JSON or YAML string object.
 | [removeComponents] | <code>Boolean</code> | whether to remove un-used components from `components` section or not. Defaults to `true`. |
 | [moveAllToComponents] | <code>Boolean</code> | whether to move all AsyncAPI Specification-valid components to the `components` section or not. Defaults to `true`. |
 | [moveDuplicatesToComponents] | <code>Boolean</code> | whether to move duplicated components to the `components` section or not. Defaults to `false`. |
-| [schemas] | <code>Boolean</code> | whether to add calculated `schemas` to the optimized AsyncAPI Document or not. Defaults to `true`. |
+
+<a name="DisableOptimizationFor"></a>
+
+## DisableOptimizationFor : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| [schema] | <code>Boolean</code> | whether object `schema` should be excluded from the process of optimization (`true` instructs **not** to add calculated `schemas` to the optimized AsyncAPI Document.) |
 
 <a name="Options"></a>
 
@@ -158,3 +169,5 @@ Converts JSON or YAML string object.
 | --- | --- | --- |
 | [rules] | [<code>Rules</code>](#Rules) | the list of rules that specifies which type of optimizations should be applied. |
 | [output] | <code>String</code> | specifies which type of output user wants, `'JSON'` or `'YAML'`. Defaults to `'YAML'`; |
+| [disableOptimizationFor] | [<code>DisableOptimizationFor</code>](#DisableOptimizationFor) | the list of objects that should be excluded from the process of optimization. |
+
diff --git a/examples/index.js b/examples/index.js
@@ -15,11 +15,9 @@ optimizer.getReport().then((report) => {
       moveDuplicatesToComponents: false,
     },
     disableOptimizationFor: {
-      schema: true,
+      schema: false,
     },
   })
   //store optimizedDocument as to output.yaml
   require('fs').writeFileSync('./examples/output.yaml', optimizedDocument)
 })
-
-// , { rules: { schemas: false } }
diff --git a/src/Optimizer.ts b/src/Optimizer.ts
@@ -88,14 +88,18 @@ export class Optimizer {
    * @typedef {Object} Rules
    * @property {Boolean=} reuseComponents - whether to reuse components from `components` section or not. Defaults to `true`.
    * @property {Boolean=} removeComponents - whether to remove un-used components from `components` section or not. Defaults to `true`.
-   * @property {Boolean=} moveAllToComponents - whether to move all AsyncAPI Specification-valid components to the `components` section or not.
-   * @property {Boolean=} moveDuplicatesToComponents - whether to move duplicated components to the `components` section or not. Defaults to `true`.
+   * @property {Boolean=} moveAllToComponents - whether to move all AsyncAPI Specification-valid components to the `components` section or not. Defaults to `true`.
+   * @property {Boolean=} moveDuplicatesToComponents - whether to move duplicated components to the `components` section or not. Defaults to `false`.
+   */
+  /**
+   * @typedef {Object} DisableOptimizationFor
+   * @property {Boolean=} schema - whether object `schema` should be excluded from the process of optimization (`true` instructs **not** to add calculated `schemas` to the optimized AsyncAPI Document.)
    */
-
   /**
    * @typedef {Object} Options
    * @property {Rules=} rules - the list of rules that specifies which type of optimizations should be applied.
    * @property {String=} output - specifies which type of output user wants, `'JSON'` or `'YAML'`. Defaults to `'YAML'`;
+   * @property {DisableOptimizationFor=} disableOptimizationFor - the list of objects that should be excluded from the process of optimization.
    */
   /**
    * This function is used to get the optimized document after seeing the report.

diff --git a/src/Reporters/moveAllToComponents.ts b/src/Reporters/moveAllToComponents.ts
@@ -26,7 +26,7 @@ const findAllComponents = (
       if (component.component['x-origin']) {
         componentName = String(component.component['x-origin']).split('/').reverse()[0]
       } else {
-        componentName = String(component.path).split('.')[1]
+        componentName = String(component.path).split('.').reverse()[0]
       }
       const target = `components.${optimizableComponentGroup.type}.${componentName}`
       resultElements.push({

diff --git a/src/Reporters/moveDuplicatesToComponents.ts b/src/Reporters/moveDuplicatesToComponents.ts
@@ -5,7 +5,7 @@ import Debug from 'debug'
 const debug = Debug('reporter:moveDuplicatesToComponents')
 /**
  *
- * @param optimizableComponentGroup components that you want to analyze for duplicates.
+ * @param optimizableComponentGroup all AsyncAPI Specification-valid components that you want to analyze for duplicates.
  * @returns A list of optimization report elements.
  */
 const findDuplicateComponents = (
@@ -28,7 +28,7 @@ const findDuplicateComponents = (
           if (component.component['x-origin']) {
             componentName = String(component.component['x-origin']).split('/').reverse()[0]
           } else {
-            componentName = String(component.path).split('.')[1]
+            componentName = String(component.path).split('.').reverse()[0]
           }
           const target = `components.${optimizableComponentGroup.type}.${componentName}`
           resultElements.push({
@@ -60,7 +60,11 @@ const findDuplicateComponents = (
 }
 
 export const moveDuplicatesToComponents: Reporter = (optimizableComponentsGroup) => {
-  return createReport(findDuplicateComponents, optimizableComponentsGroup, 'moveDuplicatesToComponents')
+  return createReport(
+    findDuplicateComponents,
+    optimizableComponentsGroup,
+    'moveDuplicatesToComponents'
+  )
 }
 
 function getOutsideComponents(

diff --git a/test/Reporters/Reporters.spec.ts b/test/Reporters/Reporters.spec.ts
@@ -11,96 +11,96 @@ import { OptimizableComponentGroup } from '../../src/index.d'
 
 const moveAllToComponentsExpectedResult: any[] = [
   {
-    action: 'move',
     path: 'channels.withDuplicatedMessage1.messages.duped1',
-    target: 'components.messages.withDuplicatedMessage1',
+    action: 'move',
+    target: 'components.messages.duped1',
   },
   {
-    action: 'move',
     path: 'channels.withDuplicatedMessage2.messages.duped2',
-    target: 'components.messages.withDuplicatedMessage2',
+    action: 'move',
+    target: 'components.messages.duped2',
   },
   {
-    action: 'move',
     path: 'channels.withFullFormMessage.messages.canBeReused',
-    target: 'components.messages.withFullFormMessage',
+    action: 'move',
+    target: 'components.messages.canBeReused',
   },
   {
-    action: 'move',
     path: 'channels.withDuplicatedMessage1',
+    action: 'move',
     target: 'components.channels.withDuplicatedMessage1FromXOrigin',
   },
   {
-    action: 'move',
     path: 'channels.withDuplicatedMessage2',
+    action: 'move',
     target: 'components.channels.withDuplicatedMessage2',
   },
   {
-    action: 'move',
     path: 'channels.withFullFormMessage',
+    action: 'move',
     target: 'components.channels.withFullFormMessage',
   },
   {
-    action: 'move',
     path: 'channels.UserSignedUp1',
+    action: 'move',
     target: 'components.channels.UserSignedUp1',
   },
   {
-    action: 'move',
     path: 'channels.UserSignedUp2',
+    action: 'move',
     target: 'components.channels.UserSignedUp2',
   },
   {
-    action: 'move',
     path: 'channels.deleteAccount',
+    action: 'move',
     target: 'components.channels.deleteAccount',
   },
   {
-    action: 'move',
     path: 'channels.withDuplicatedMessage1.messages.duped1.payload',
-    target: 'components.schemas.withDuplicatedMessage1',
+    action: 'move',
+    target: 'components.schemas.payload',
   },
   {
-    action: 'move',
     path: 'channels.withDuplicatedMessage2.messages.duped2.payload',
-    target: 'components.schemas.withDuplicatedMessage2',
+    action: 'move',
+    target: 'components.schemas.payload',
   },
   {
-    action: 'move',
     path: 'channels.UserSignedUp1.messages.myMessage.payload',
-    target: 'components.schemas.UserSignedUp1',
+    action: 'move',
+    target: 'components.schemas.payload',
   },
   {
-    action: 'move',
     path: 'channels.UserSignedUp1.messages.myMessage.payload.properties.displayName',
-    target: 'components.schemas.UserSignedUp1',
+    action: 'move',
+    target: 'components.schemas.displayName',
   },
   {
-    action: 'move',
     path: 'channels.UserSignedUp1.messages.myMessage.payload.properties.email',
-    target: 'components.schemas.UserSignedUp1',
+    action: 'move',
+    target: 'components.schemas.email',
   },
   {
-    action: 'move',
     path: 'channels.deleteAccount.messages.deleteUser.payload',
-    target: 'components.schemas.deleteAccount',
+    action: 'move',
+    target: 'components.schemas.payload',
   },
   {
-    action: 'move',
     path: 'operations.user/deleteAccount.subscribe',
-    target: 'components.operations.user/deleteAccount',
+    action: 'move',
+    target: 'components.operations.subscribe',
   },
 ]
 const moveDuplicatesToComponentsExpectedResult: any[] = [
   {
     path: 'channels.withDuplicatedMessage1.messages.duped1',
     action: 'move',
-    target: 'components.messages.withDuplicatedMessage1',
+    target: 'components.messages.duped1',
   },
   {
     path: 'channels.withDuplicatedMessage2.messages.duped2',
     action: 'reuse',
-    target: 'components.messages.withDuplicatedMessage1',
+    target: 'components.messages.duped1',
   },
   {
     path: 'channels.UserSignedUp1',
@@ -115,12 +115,12 @@ const moveDuplicatesToComponentsExpectedResult: any[] = [
   {
     path: 'channels.withDuplicatedMessage1.messages.duped1.payload',
     action: 'move',
-    target: 'components.schemas.withDuplicatedMessage1',
+    target: 'components.schemas.payload',
   },
   {
     path: 'channels.withDuplicatedMessage2.messages.duped2.payload',
     action: 'reuse',
-    target: 'components.schemas.withDuplicatedMessage1',
+    target: 'components.schemas.payload',
   },
 ]
 const RemoveComponentsExpectedResult = [