feat: performance optimization for `changelog` build type #36

CountRedClaw · 2025-08-25T15:20:00Z

build type: changelog

calculate diffs for whole specifications, split per operations afterwards
optimize diffs deduplication

build type: build

remove hash calculation for each operation (not used anymore on frontend)

…rsions checks

src/apitypes/graphql/graphql.consts.ts

src/apitypes/rest/rest.changes.ts

src/components/compare/compare.utils.ts

src/types/external/types.ts

JayLim2 · 2025-09-02T10:19:33Z

test/projects/changelog/change-method/after.yaml

+  version: 0.1.0
+paths:
+  /api/v1/path1:
+    get:


nothing changed

content type changed from application/xml to application/json

so then rename change-method to change-content-type :)

JayLim2 · 2025-09-02T10:19:47Z

test/projects/changelog/change-method/before.yaml

+  version: 0.1.0
+paths:
+  /api/v1/path1:
+    get:


nothing changed (before)

content type changed from application/xml to application/json

test/projects/changelog/documents-matching/before/spec2.yaml

…e-optimization # Conflicts: # package.json

src/apitypes/rest/rest.changes.ts

src/apitypes/rest/rest.types.ts

JayLim2 · 2025-10-06T11:53:27Z

src/apitypes/graphql/graphql.changes.ts

+      let operationDiffs: Diff[] = []
+      if (operationChanged) {
+        operationDiffs = [...(methodData as WithAggregatedDiffs<GraphApiOperation>)[DIFFS_AGGREGATED_META_KEY]??[]]
+      }


JayLim2 · 2025-10-06T12:00:05Z

src/apitypes/rest/rest.changes.ts

+    prevDocData = createCopyWithEmptyPathItems(currDocData)
+  }
+  if (prevDocData && !currDocData) {
+    currDocData = createCopyWithEmptyPathItems(prevDocData)


is it possible to have collisions here? I mean, can prevDocData and currDocData be overridden in second if operators?

Collision- no. Added comments to clarify what cases are handled by each piece. This is sequential processing and result of first step (if there are prefix groups) should still be processed by second step (create empty counterpart document if necessary)

JayLim2 · 2025-10-06T12:25:17Z

src/apitypes/rest/rest.types.ts

+//   externalDocs?: ExternalDocumentationObject;
+//   'x-express-openapi-additional-middleware'?: (((request: any, response: any, next: any) => Promise<void>) | ((request: any, response: any, next: any) => void))[];
+//   'x-express-openapi-validation-strict'?: boolean;
+// }


shouldn't we remove it?

JayLim2 · 2025-10-06T13:08:40Z

src/components/compare/compare.utils.ts


-    const groupSlug = convertToSlug(areOperationsFromCurrentVersion ? currentGroup : previousGroup)
+function removeRedundantPartialPairs<T extends [object | undefined, object | undefined]>(
+  tuples: T[],


I would add unit tests for such not trivial utilities

Added unit tests for dedupeTuples and removeRedundantPartialPairs functions

JayLim2 · 2025-10-06T13:37:07Z

test/changes.test.ts

  })

-  test('comparison should have 1 breaking and 1 annotation changes', async () => {
+  test('Comparison should have 1 breaking and 1 annotation changes', async () => {


comparison of...what?

Changed the name of the test group to make it clear these are tests for changelog build type.

JayLim2 · 2025-10-06T13:43:29Z

test/projects/changelog/add-prefix-to-server/before.yaml

+  title: test
+  version: 0.1.0
+servers:
+  - url: https://example1.com/api/v2


why is this in before.yaml?

JayLim2 · 2025-10-06T13:50:39Z

test/projects/changelog/remove-root-servers/after.yaml

+  version: 0.1.0
+servers:
+  - url: https://example2.com
+    description: It is a description of server


why is it in after.yaml?

Switched before and after to avoid confusion.

JayLim2 · 2025-10-06T13:58:04Z

test/projects/multifiles/test.md

@@ -1 +1 @@
-# test
+# test


is this file necessary for tests?

The file was changed in the PR due to linter errors.
This is an existing test called multifiles, so I wouldn't change it here.

…nd path item servers object when comparing prefix groups

… as close to source as possible

…plication

…o avoid confusion

CountRedClaw added 9 commits July 16, 2025 20:34

test: add operation.deprecated check

a508c54

test: add operation.metadata.originalPath checks

c6ab782

style: cleanup

27e473a

test: add operation.deprecatedInfo & operation.deprecatedInPreviousVe…

cf1464e

…rsions checks

refactor: compare documents instead of operations

6f03215

feat: implement documents matching based on operations

3f1f531

refactor: simplify documents matching

6f736a2

feat: support prefix groups comparison

e820f6b

test: add missing cases

00c574f

github-actions bot added enhancement New feature or request refactor labels Aug 25, 2025

github-actions bot assigned b41ex Aug 25, 2025

chore: use api-diff from branch

227b690

CountRedClaw linked an issue Aug 26, 2025 that may be closed by this pull request

Process whole specs for GraphQL and REST to collect per-operation data for build type changelog #30

Open

CountRedClaw added 2 commits August 26, 2025 13:39

refactor: cleanup

4cdcddb

refactor: cleanup

bd38e7d

CountRedClaw linked an issue Aug 27, 2025 that may be closed by this pull request

Add e2e tests for build types 'build' and 'changelog' #29

Open

CountRedClaw added 3 commits August 27, 2025 22:49

refactor: simplify comparison logic

98687ac

fix: aggregate missing root-level diffs

4cc235b

refactor: cleanup

d25fce4

JayLim2 requested changes Sep 2, 2025

View reviewed changes

CountRedClaw added 7 commits September 3, 2025 12:07

test: add missing cases

53839b9

fix: review remarks

6cc72d3

refactor

3ac3019

perf: add data for measurements

53c3f2c

perf: add data for measurements

a3b64dc

Merge remote-tracking branch 'origin/develop' into feature/performanc…

5eee209

…e-optimization # Conflicts: # package.json

chore: use api-diff from branch

cc7cb9d

github-actions bot added the bug Something isn't working label Sep 8, 2025

fix: remove prefix from servers case

7817a91

makeev-pavel reviewed Oct 6, 2025

View reviewed changes

src/apitypes/rest/rest.changes.ts Outdated Show resolved Hide resolved

makeev-pavel reviewed Oct 6, 2025

View reviewed changes

src/apitypes/rest/rest.types.ts Outdated Show resolved Hide resolved

JayLim2 reviewed Oct 6, 2025

View reviewed changes

b41ex added 21 commits October 8, 2025 19:27

fix: operation matching when operation base path moved between path a…

4a910a5

…nd path item servers object when comparing prefix groups

refactor: rename test to avoid problems with selective run

4ab42f1

fix: incorrect calculation of operation ids in prefix groups

68d9c6f

fix: enforce group prefix validation

39fde46

refactor: skip useless test

a5e0d54

fix: add pahth parameter rename test for prefix groups

1af80ce

fix return full operation ids when comparing prefix groups

60fdc32

refactor: reuse group prefix validation function

a3a6a64

refactor: export createCopyWithPrefixGroupOperationsOnly for reuse in UI

9305c38

refactor: modify createCopyWithPrefixGroupOperationsOnly to keep copy…

13b5a9d

… as close to source as possible

refactor: export RestOperationData to use in UI

1f6c82f

refactor: fix code formatting

c1d8040

refactor: use existing isValidHttp method

c1c2345

refactor: extract method to calculateNormalizedOperationId

2c83aa2

refactor: remove obsolete comment

50edb39

docs: add comments

b878676

refactor: add unit test for removeRedundantPartialPairs

22a8260

docs: rename test group to emphasize it is for the changelog build type

2d229f5

refactor: use extractOperationBasePath from api-diff to avoid code du…

15143fc

…plication

refactor: switch between and after samples for add-prefix-to-server t…

527e525

…o avoid confusion

refactor: add unit tests for dedupeTuples function

21196bb

b41ex requested review from JayLim2 and makeev-pavel October 12, 2025 18:57

b41ex mentioned this pull request Oct 12, 2025

fix: adapt tests for performance optimization for changelog build type Netcracker/qubership-apihub-ui-tests#61

Open

makeev-pavel approved these changes Oct 13, 2025

View reviewed changes

b41ex added 2 commits October 17, 2025 13:17

fix: collect openapi version changes for operations

4364707

fix: add missing samples

5c6cb18

Uh oh!

feat: performance optimization for changelog build type #36

Are you sure you want to change the base?

feat: performance optimization for changelog build type #36

Uh oh!

Conversation

CountRedClaw commented Aug 25, 2025 • edited by b41ex Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

feat: performance optimization for `changelog` build type #36

feat: performance optimization for `changelog` build type #36

CountRedClaw commented Aug 25, 2025 •

edited by b41ex

Loading