added more test coverage for client v2 by edewit · Pull Request #50557 · keycloak/keycloak

edewit · 2026-07-02T10:14:39Z

Signed-off-by: Erik Jan de Wit erikjan.dewit@gmail.com

Copilot

Pull request overview

Extends the JS Keycloak Admin Client (v2 endpoints generated from the OpenAPI spec) test suite to validate filtering and sorting behavior, improving confidence that the OpenAPI-driven client and server contract match.

Changes:

Adds a new Mocha test covering clients.v2().get() sorting (sort=clientId) and filtering (q=clientId eq ...).
Adjusts TypeScript test config to include Mocha/Node ambient types for test compilation/IDE support.
Adds a pnpm minimumReleaseAgeExclude entry to unblock a specific @types/node version.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

File	Description
js/pnpm-workspace.yaml	Adds a pnpm minimum-release-age exclusion for a specific `@types/node` version.
js/libs/keycloak-admin-client/tsconfig.test.json	Adds Mocha/Node typings for the test TS project configuration.
js/libs/keycloak-admin-client/test/tsconfig.json	Introduces a test-folder TS config extending the shared test config.
js/libs/keycloak-admin-client/test/clientsV2.spec.ts	Adds v2 API coverage for client sorting and filtering.

Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

js/pnpm-lock.yaml: Generated file

michalvavrik

Thanks for the PR

Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.

Files not reviewed (1)

js/pnpm-lock.yaml: Generated file

michalvavrik

Just two more things (two comments) and LGTM. We could probably expand test coverage with adding a test for descending order, but I am only reviewing what I see and I found it useful and well done. Thanks

michalvavrik · 2026-07-15T15:47:27Z

+    const clientId1 = faker.internet.username();
+    const clientId2 = faker.internet.username();
+
+    // Create two clients using v2 API


You will know this better as I do, but AFAICT it is customary in this js/libs/keycloak-admin-client/test/clientsV2.spec.ts to delete clients you create. I am judging based on:

currentClientId before/after -> deleted

"should create and delete a client" deleted

"should create an OIDC client with full configuration" deleted

It is not too important, but maybe you should delete these clients as well? This seems to be only place that doesn't clean up.

Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

js/pnpm-lock.yaml: Generated file

michalvavrik

LGTM, thanks

Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

js/pnpm-lock.yaml: Generated file

shawkins · 2026-07-16T21:23:00Z

+        sort: "clientId",
+      },
+    });
+    expect(sortedClients).to.be.ok;
+    expect(sortedClients).to.be.an("array");
+    const clientIds = sortedClients!.map((c) => c.clientId!);
+    const caseInsensitiveSortedClientIds = [...clientIds].sort((a, b) =>
+      a.localeCompare(b, undefined, { sensitivity: "base" }),
+    );
+    expect(caseInsensitiveSortedClientIds).to.deep.equal(clientIds);


@edewit seems valid that the test should be broadened to a non-default sort.

yes, right... done

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

js/pnpm-lock.yaml: Generated file

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

relates: keycloak#50113 Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

js/libs/keycloak-admin-client/test/clientsV2.spec.ts:160

These deletions run only after all assertions pass, so a sort/filter regression—or failure while creating the second client—leaves test clients in the shared realm and can pollute later list results. Track each successful creation and delete it from an afterEach hook or a finally block.

    await kcAdminClient.clients.v2().byId(clientId1).delete();
    await kcAdminClient.clients.v2().byId(clientId2).delete();

shawkins

LGTM, thanks @edewit

edewit requested a review from a team as a code owner July 2, 2026 10:14

Copilot AI review requested due to automatic review settings July 2, 2026 10:14

edewit requested a review from a team as a code owner July 2, 2026 10:14

Copilot started reviewing on behalf of edewit July 2, 2026 10:15 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts Outdated

Copilot AI review requested due to automatic review settings July 7, 2026 10:06

edewit force-pushed the expand-tests branch from 2d6ab59 to 079f049 Compare July 7, 2026 10:06

Copilot started reviewing on behalf of edewit July 7, 2026 10:07 View session

Copilot AI reviewed Jul 7, 2026

View reviewed changes

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts Outdated

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts

stianst added the team/core-iam label Jul 14, 2026

michalvavrik added the team/cloud-native label Jul 14, 2026

michalvavrik suggested changes Jul 15, 2026

View reviewed changes

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts Outdated

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts

Copilot AI review requested due to automatic review settings July 15, 2026 14:39

Copilot started reviewing on behalf of edewit July 15, 2026 14:45 View session

edewit requested a review from michalvavrik July 15, 2026 14:47

Copilot AI reviewed Jul 15, 2026

View reviewed changes

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts

michalvavrik reviewed Jul 15, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 16, 2026 06:59

Copilot started reviewing on behalf of edewit July 16, 2026 06:59 View session

edewit requested a review from michalvavrik July 16, 2026 06:59

Copilot AI reviewed Jul 16, 2026

View reviewed changes

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts Outdated

michalvavrik approved these changes Jul 16, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 16, 2026 14:48

Copilot started reviewing on behalf of edewit July 16, 2026 14:57 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 16, 2026 21:25

shawkins force-pushed the expand-tests branch from 35b0864 to d244292 Compare July 16, 2026 21:25

Copilot started reviewing on behalf of shawkins July 16, 2026 21:25 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts Outdated

Copilot AI review requested due to automatic review settings July 17, 2026 07:04

edewit force-pushed the expand-tests branch from d244292 to 01b5434 Compare July 17, 2026 07:04

Copilot started reviewing on behalf of edewit July 17, 2026 07:04 View session

Copilot AI reviewed Jul 17, 2026

View reviewed changes

Comment thread js/libs/keycloak-admin-client/test/clientsV2.spec.ts Outdated

Copilot AI review requested due to automatic review settings July 17, 2026 08:10

edewit force-pushed the expand-tests branch from 01b5434 to ed1ec6d Compare July 17, 2026 08:10

Copilot started reviewing on behalf of edewit July 17, 2026 08:10 View session

Copilot AI reviewed Jul 17, 2026

View reviewed changes

edewit added 7 commits July 20, 2026 14:03

added more test coverage for client v2

71631d7

relates: keycloak#50113 Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

fixed types

5305513

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

use sort

f1814b7

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

PR review

cd44cc9

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

PR review

7d6398e

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

made sort algorithm same as server

0349947

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

switched to none default sort

6093b29

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

Copilot AI review requested due to automatic review settings July 20, 2026 12:03

edewit force-pushed the expand-tests branch from ed1ec6d to 6093b29 Compare July 20, 2026 12:03

Copilot started reviewing on behalf of edewit July 20, 2026 12:03 View session

Copilot AI reviewed Jul 20, 2026

View reviewed changes

vmuzikar requested a review from shawkins July 21, 2026 13:17

shawkins approved these changes Jul 21, 2026

View reviewed changes

shawkins merged commit 7a9b036 into keycloak:main Jul 21, 2026
69 checks passed

edewit deleted the expand-tests branch July 23, 2026 08:30

Uh oh!

Conversation

edewit commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

michalvavrik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

michalvavrik left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michalvavrik Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edewit Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

michalvavrik left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

shawkins Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

edewit Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

shawkins left a comment

Choose a reason for hiding this comment

edewit commented Jul 2, 2026 •

edited

Loading

michalvavrik left a comment •

edited

Loading

michalvavrik Jul 15, 2026 •

edited

Loading