fix: duplicated tags

Author: CountRedClaw

src/apitypes/graphql/graphql.changes.ts

@@ -37,7 +37,7 @@ export const compareDocuments = async (
   currDoc: ResolvedVersionDocument | undefined,
   ctx: CompareOperationsPairContext): Promise<{
   operationChanges: OperationChanges[]
-  tags: string[]
+  tags: Set<string>
 }> => {
   const { apiType, rawDocumentResolver, previousVersion, currentVersion, previousPackageId, currentPackageId } = ctx
   const prevFile = prevDoc && await rawDocumentResolver(previousVersion, previousPackageId, prevDoc.slug)
@@ -78,17 +78,15 @@ export const compareDocuments = async (
   ) as { merged: GraphApiSchema; diffs: Diff[] }
 
   if (isEmpty(diffs)) {
-    return { operationChanges: [], tags: [] }
+    return { operationChanges: [], tags: new Set() }
   }
 
   let operationDiffs: Diff[] = []
 
   const { currentGroup, previousGroup } = ctx
-  const currGroupSlug = slugify(removeFirstSlash(currentGroup || ''))
-  const prevGroupSlug = slugify(removeFirstSlash(previousGroup || ''))
 
   const tags = new Set<string>()
-  const changedOperations: OperationChanges[] = []
+  const operationChanges: OperationChanges[] = []
 
   for (const type of GRAPHQL_TYPE_KEYS) {
     const operationsByType = merged[type]
@@ -116,12 +114,12 @@ export const compareDocuments = async (
         continue
       }
 
-      changedOperations.push(createOperationChange(apiType, operationDiffs, previous, current, currentGroup, previousGroup))
+      operationChanges.push(createOperationChange(apiType, operationDiffs, previous, current, currentGroup, previousGroup))
       getOperationTags(current ?? previous).forEach(tag => tags.add(tag))
     }
   }
 
-  return { operationChanges: changedOperations, tags: Array.from(tags) }
+  return { operationChanges, tags }
 }
 
 function getCopyWithEmptyOperations(template: GraphApiSchema): GraphApiSchema {

src/apitypes/rest/rest.changes.ts

@@ -71,7 +71,7 @@ export const compareDocuments = async (
   ctx: CompareOperationsPairContext,
 ): Promise<{
   operationChanges: OperationChanges[]
-  tags: string[]
+  tags: Set<string>
 }> => {
   const {
     apiType,
@@ -118,11 +118,11 @@ export const compareDocuments = async (
   ) as { merged: OpenAPIV3.Document; diffs: Diff[] }
 
   if (isEmpty(diffs)) {
-    return { operationChanges: [], tags: [] }
+    return { operationChanges: [], tags: new Set() }
   }
 
   const tags = new Set<string>()
-  const changedOperations: OperationChanges[] = []
+  const operationChanges: OperationChanges[] = []
 
   for (const path of Object.keys(merged.paths)) {
     const pathData = merged.paths[path]
@@ -172,12 +172,12 @@ export const compareDocuments = async (
 
       await reclassifyBreakingChanges(previous?.operationId, merged, operationDiffs, ctx)
 
-      changedOperations.push(createOperationChange(apiType, operationDiffs, previous, current, currentGroup, previousGroup))
+      operationChanges.push(createOperationChange(apiType, operationDiffs, previous, current, currentGroup, previousGroup))
       getOperationTags(current ?? previous).forEach(tag => tags.add(tag))
     }
   }
 
-  return { operationChanges: changedOperations, tags: Array.from(tags) }
+  return { operationChanges, tags }
 }
 
 async function reclassifyBreakingChanges(

src/components/compare/compare.operations.ts

@@ -160,7 +160,7 @@ async function compareCurrentApiType(
       apiType,
       changesSummary,
       numberOfImpactedOperations,
-      tags: tags.sort(),
+      tags,
       apiAudienceTransitions,
     },
     operationChanges,

src/components/compare/compare.utils.ts

@@ -210,7 +210,7 @@ export const comparePairedDocs = async (
   ctx: CompareOperationsPairContext,
 ): Promise<[OperationChanges[], string[]]> => {
   const operationChanges: OperationChanges[] = []
-  const tags: string[] = []
+  const tags = new Set<string>()
 
   for (const [prevDoc, currDoc] of pairedDocs) {
     const {
@@ -219,10 +219,10 @@ export const comparePairedDocs = async (
     } = await apiBuilder.compareDocuments!(operationsMap, prevDoc, currDoc, ctx)
 
     operationChanges.push(...docsPairOperationChanges)
-    tags.push(...docsPairTags)
+    docsPairTags.forEach(tag => tags.add(tag))
   }
 
-  return [operationChanges, tags]
+  return [operationChanges, Array.from(tags).sort()]
 }
 
 export function createOperationChange(

src/types/internal/apiBuilder.ts

@@ -111,7 +111,7 @@ export type DocumentDumper<T> = (document: ZippableDocument<T>, format?: typeof
 export type OperationDataCompare<T> = (current: T, previous: T, ctx: CompareOperationsPairContext) => Promise<Diff[]>
 export type DocumentsCompare = (operationsMap: OperationsMap, currDoc: ResolvedVersionDocument | undefined, prevDoc: ResolvedVersionDocument | undefined, ctx: CompareOperationsPairContext) => Promise<{
   operationChanges: OperationChanges[]
-  tags: string[]
+  tags: Set<string>
 }>
 export type OperationIdNormalizer = (operation: ResolvedOperation) => NormalizedOperationId
 export type DocumentExporter = (

test/changes.test.ts

@@ -262,4 +262,20 @@ describe('Changes test', () => {
       }),
     ]))
   })
+
+  test('Tags are not duplicated', async () => {
+    const result = await buildChangelogPackage('changelog/tags')
+
+    expect(result).toEqual(operationTypeMatcher({
+      tags: expect.toIncludeSameMembers([
+        'sameTagInDifferentPaths1',
+        'sameTagInDifferentPaths2',
+        'sameTagInDifferentPaths3',
+        'sameTagInMethodSiblings1',
+        'sameTagInMethodSiblings2',
+        'sameTagInMethodSiblings3',
+        'tag',
+      ]),
+    }))
+  })
 })

test/projects/changelog/tags/after.yaml

@@ -0,0 +1,43 @@
+openapi: 3.0.3
+info:
+  title: test
+  version: 0.1.0
+paths:
+  /added1:
+    get:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInDifferentPaths1
+        - sameTagInDifferentPaths3
+  /added2:
+    get:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInDifferentPaths1
+        - sameTagInDifferentPaths3
+        - sameTagInMethodSiblings2
+    post:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInMethodSiblings2
+  /changed1:
+    get:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInDifferentPaths1
+        - sameTagInMethodSiblings3
+        - tag
+    post:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInMethodSiblings3

test/projects/changelog/tags/before.yaml

@@ -0,0 +1,43 @@
+openapi: 3.0.3
+info:
+  title: test
+  version: 0.1.0
+paths:
+  /removed1:
+    get:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInDifferentPaths1
+        - sameTagInDifferentPaths2
+  /removed2:
+    get:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInDifferentPaths1
+        - sameTagInDifferentPaths2
+        - sameTagInMethodSiblings1
+    post:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInMethodSiblings1
+  /changed1:
+    get:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - sameTagInDifferentPaths1
+        - tag
+        - missingByDesign
+    post:
+      responses:
+        '200':
+          content: { }
+      tags:
+        - missingByDesign