fix: improve join command servers handling #2133
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: b49d76d The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
JLekawa
approved these changes
Jun 12, 2025
tatomyr
reviewed
Jun 13, 2025
packages/cli/tsconfig.json
Outdated
| @@ -5,6 +5,6 @@ | |||
| "outDir": "lib" | |||
| }, | |||
| "references": [{ "path": "../core" }, { "path": "../respect-core" }], | |||
| "include": ["src/**/*.ts"], | |||
| "include": ["src/**/*.ts", "src/__tests__/fixtures/join/documents.ts1"], | |||
There was a problem hiding this comment.
documents.ts1 looks wrong.
tatomyr
reviewed
Jun 17, 2025
| @@ -51,6 +61,10 @@ describe('handleJoin', () => { | |||
| ); | |||
| }); | |||
|
|
|||
| afterEach(() => { | |||
There was a problem hiding this comment.
Are you sure you need this? We've configured Vitest to restore all mocks: https://github.com/Redocly/redocly-cli/blob/main/vitest.config.ts#L49. Isn't that enough?
Comment on lines
+172
to
+183
| const firstDocServers = documents[0]?.parsed.servers; | ||
| const serversAreTheSame = | ||
| firstDocServers && | ||
| documents.slice(1).every((doc) => { | ||
| // include only documents with paths | ||
| if (Object.keys(doc.parsed.paths || {}).length === 0) { | ||
| return true; | ||
| } | ||
| return doc.parsed.servers?.every((server: Oas3Server) => | ||
| firstDocServers?.find((firstDocServer: Oas3Server) => firstDocServer.url === server.url) | ||
| ); | ||
| }); |
There was a problem hiding this comment.
A little bit easier to read for me (no magic numbers like 0 or 1 🙂):
Suggested change
| const firstDocServers = documents[0]?.parsed.servers; | |
| const serversAreTheSame = | |
| firstDocServers && | |
| documents.slice(1).every((doc) => { | |
| // include only documents with paths | |
| if (Object.keys(doc.parsed.paths || {}).length === 0) { | |
| return true; | |
| } | |
| return doc.parsed.servers?.every((server: Oas3Server) => | |
| firstDocServers?.find((firstDocServer: Oas3Server) => firstDocServer.url === server.url) | |
| ); | |
| }); | |
| const [first, ...others] = documents ?? []; | |
| const serversAreTheSame = others.every(({ parsed: { paths, servers } }) => { | |
| // include only documents with paths | |
| if (!paths || isEmptyObject(paths || {})) { | |
| return true; | |
| } | |
| return servers?.every((server: Oas3Server) => | |
| first.parsed.servers?.find(({ url }: Oas3Server) => url === server.url) | |
| ); | |
| }) |
| @@ -335,7 +336,10 @@ describe('E2E', () => { | |||
|
|
|||
| test.each(testDirNames)('test: %s', async (dir) => { | |||
| const testPath = join(__dirname, `join/${dir}`); | |||
| const args = getParams(indexEntryPoint, ['join', ...entrypoints]); | |||
| let args = getParams(indexEntryPoint, ['join', ...entrypoints]); | |||
| if (dir === 'three-files-one-without-servers') { | |||
There was a problem hiding this comment.
Could you move this to a separate describe/test? Or put a FIXME so I'll do that later. I try to avoid conditions in tests so they are easier to debug and maintain.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What/Why/How?
This pull request resolves an issue with the join command where it would incorrectly merge OpenAPI documents with different servers configurations, leading to a semantically invalid result.
The updated logic now handles server merging based on whether the input files share the same server definitions.
Reference
Resolves #2118
Testing
Check yourself
Security