fix(client): correct serverinfo endpoint

[bastianccm]

Hi @Nerzal,

I assume the serverinfo broke with the latest update, it should be one ServerInfoRepresentation and the path should be /serverinfo, not /realms.

Let me know if I'm missing something here?

Best and thanks for all the work, Basti

[Nerzal]

I guess the test failure is unrelated i'll have to have a closer look at that

[bastianccm]

Looks like these tests:

gocloak/client_test.go

Lines 625 to 660 in 18f0f3d

	func Test_GetUserInfo(t *testing.T) {
	t.Parallel()
	cfg := GetConfig(t)
	client := NewClientWithDebug(t)
	SetUpTestUser(t, client)
	token := GetUserToken(t, client)
	userInfo, err := client.GetUserInfo(
	context.Background(),
	token.AccessToken,
	cfg.GoCloak.Realm,
	)
	require.NoError(t, err, "Failed to fetch userinfo")
	t.Log(userInfo)
	FailRequest(client, nil, 1, 0)
	_, err = client.GetUserInfo(
	context.Background(),
	token.AccessToken,
	cfg.GoCloak.Realm)
	require.Error(t, err, "")
	}
	func Test_GetRawUserInfo(t *testing.T) {
	t.Parallel()
	cfg := GetConfig(t)
	client := NewClientWithDebug(t)
	SetUpTestUser(t, client)
	token := GetUserToken(t, client)
	userInfo, err := client.GetUserInfo(
	context.Background(),
	token.AccessToken,
	cfg.GoCloak.Realm,
	)
	require.NoError(t, err, "Failed to fetch userinfo")
	t.Log(userInfo)
	require.NotEmpty(t, userInfo)
	}

As they are marked as parallel, it could be a race condition somehow?

[bastianccm]

See #396 which should resolve the test issues

[codecov]

Codecov Report

Merging #382 (dfc9b76) into main (c59ba6e) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #382   +/-   ##
=======================================
  Coverage   77.14%   77.14%           
=======================================
  Files           4        4           
  Lines        2140     2140           
=======================================
  Hits         1651     1651           
  Misses        333      333           
  Partials      156      156           

Impacted Files	Coverage Δ
client.go	75.42% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[bastianccm]

@Nerzal i assume the tests failed because keycloak was not yet ready, maybe you can run them again? I rebased the branch so it should work actually

[Nerzal]

Tests do now run, but as this is a breaking change, we'd have to bump the major version.
Do you know which keycloak versions this does support?

[bastianccm]

Actually it broke in Gocloak v12, as in v11 it was working just fine:
https://github.com/Nerzal/gocloak/blob/v11.2.0/client.go#L256

I think it has been part of keycloak "ever since", it was introduced 2014 in this commit: keycloak/keycloak@97897ca (Keycloak 1.0-alpha-2)

[Nerzal]

I'm not 100% sure what to do with this.
We could bump the major version and say, that we only support keycloak v12+ from now on.

[bastianccm]

@Nerzal i think we are mixing things up, it broke in gocloak v12, Keycloak has this API since v1.
While the gocloak api will break, it's a regression, it worked up to v11, and broke with the refactoring.
This is gocloak v11:

gocloak/client.go

Line 256 in 9556250

func (client *gocloak) GetServerInfo(ctx context.Context, accessToken string) (*ServerInfoRepesentation, error) {

This is gocloak v12:

gocloak/client.go

Line 270 in 18f0f3d

func (g *GoCloak) GetServerInfo(ctx context.Context, accessToken string) ([]*ServerInfoRepresentation, error) {

The serverinfo was never an array, I think a typo in gocloak made it one?

[Nerzal]

Okay, i'll have a look into that on Monday.