keycloak/keycloak

OutOfMemoryError in `org.keycloak.authorization.admin.ScopeService.getPermissions`

Offen

#17.414 geöffnet am 02.03.2023

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Java (8.346 Forks)batch import
area/admin/apiarea/authorization-serviceshelp wantedkind/bugpriority/normalstatus/auto-bumpteam/core-iam

Repository-Metriken

Stars
 (34.398 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Before reporting an issue

  • I have searched existing issues
  • I have reproduced the issue with the latest release

Area

admin/ui

Describe the bug

Reason: OutOfMemoryError throws because method getPermissions in ScopeService return all items without pagination. In case of a lot of items it is become OutOfMemoryError.

Code flow

image

image

image

Query:

@NamedQuery(name="findPolicyIdByScope", query="select pe from PolicyEntity pe inner join pe.scopes s where pe.type = 'scope' and pe.resourceServer.id = :serverId and s.id in (:scopeIds)"),

Version

21.0.1

Expected behavior

No OutOfMemoryError

Actual behavior

OutOfMemoryError

How to Reproduce?

Create authorization client with scope and a lot of attached resources (100500+).

Anything else?

No response

Contributor Guide

Research-Richtung
Das Problem liegt in `org.keycloak.authorization.admin.ScopeService.getPermissions`, das alle Elemente ohne Paginierung zurückgibt und bei vielen Elementen zu OutOfMemoryError führt. Zur Behebung fügen Sie der JPA Abfrage `findPolicyIdByScope` in der `PolicyEntity` Paginierung hinzu. Sehen Sie sich vorhandene Paginierungsmuster in Keycloak an (z. B. in anderen Diensten) und ändern Sie die Methode so, dass sie Paginierungsparameter akzeptiert und ein paginiertes Ergebnis zurückgibt.
Tech Stack
java
Domain
backend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Java
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80