Remove deprecated methods in data providers and models #13565

hmlnarik · 2022-08-05T09:30:52Z

hmlnarik
Aug 5, 2022

Description

Since 2020, multiple methods became deprecated, usually replaced by a similar method with a consistent parameter positions and / or stream variants. Examples of these transitions are below.

I propose removing all of these deprecated methods in Keycloak 20. Maintaining the deprecated methods brings no value, and the deprecation period has been IMO sufficient.

Please state your agreement or concerns with this intention by Sep 15 here.

Cc: @keycloak/kc-maintainers @keycloak/kc-external-maintainers

Scope

All *Model classes and all data-oriented *Provider classes like UserProvider, GroupProvider etc.

Examples of these methods

Remove getRequiredCredentials() here:

keycloak/server-spi/src/main/java/org/keycloak/models/RealmModel.java

Lines 270 to 282 in 4323d79

    
               /** 
        
                * @deprecated Use {@link #getRequiredCredentialsStream() getRequiredCredentialsStream} instead. 
        
                */ 
        
               @Deprecated 
        
               default List<RequiredCredentialModel> getRequiredCredentials() { 
        
                   return getRequiredCredentialsStream().collect(Collectors.toList()); 
        
               } 
        
               /** 
        
                * Returns required credentials as a stream. 
        
                * @return Stream of {@link RequiredCredentialModel}. Never returns {@code null}. 
        
                */ 
        
               Stream<RequiredCredentialModel> getRequiredCredentialsStream();

Remove searchForGroupByName() here:

keycloak/server-spi/src/main/java/org/keycloak/storage/group/GroupLookupProvider.java

Lines 37 to 65 in 4323d79

    
               /** 
        
                * Returns groups with the given string in name for the given realm. 
        
                * 
        
                * @param realm Realm. 
        
                * @param search Case sensitive searched string. 
        
                * @param firstResult First result to return. Ignored if {@code null}. 
        
                * @param maxResults Maximum number of results to return. Ignored if {@code null}. 
        
                * @return List of groups with the given string in name. 
        
                * @deprecated Use {@link #searchForGroupByNameStream(RealmModel, String, Integer, Integer) searchForGroupByNameStream} instead. 
        
                */ 
        
               @Deprecated 
        
               default List<GroupModel> searchForGroupByName(RealmModel realm, String search, Integer firstResult, Integer maxResults) { 
        
                   return searchForGroupByNameStream(realm, search, firstResult, maxResults).collect(Collectors.toList()); 
        
               } 
        
               /** 
        
                * Returns the group hierarchy with the given string in name for the given realm. 
        
                * 
        
                * For a matching group node the parent group is fetched by id (with all children) and added to the result stream. 
        
                * This is done until the group node does not have a parent (root group) 
        
                * 
        
                * @param realm Realm. 
        
                * @param search Case sensitive searched string. 
        
                * @param firstResult First result to return. Ignored if negative or {@code null}. 
        
                * @param maxResults Maximum number of results to return. Ignored if negative or {@code null}. 
        
                * @return Stream of root groups that have the given string in their name themself or a group in their child-collection has. 
        
                * The returned hierarchy contains siblings that do not necessarily have a matching name. Never returns {@code null}. 
        
                */ 
        
               Stream<GroupModel> searchForGroupByNameStream(RealmModel realm, String search, Integer firstResult, Integer maxResults);

mduchrow · 2022-08-05T09:53:04Z

mduchrow
Aug 5, 2022

As long as there is an adequate replacement method (and I think it is) the removal should be no problem.
Perhaps a hint the release-notes of KC 20 that the replacements for deprecated methods are documented in the KC 19 code could help with the migration of plugins.

0 replies

abstractj · 2022-08-05T12:17:46Z

abstractj
Aug 5, 2022
Maintainer

@hmlnarik what you suggest make sense. I'd suggest a blog post with all the details about which APIs will become EOL by Sept 15, so it's transparent to our community. Here's an example from Node.js https://nodejs.org/api/deprecations.html

2 replies

hmlnarik Aug 5, 2022
Author

+1 to the blog post, this must be needs to be well advertised.
Re timing, by Sep 15, I would like to have go / no-go decision. The blog would be published shortly afterwards.

abstractj Aug 5, 2022
Maintainer

+1 from me

mposolda · 2022-08-08T12:26:19Z

mposolda
Aug 8, 2022
Maintainer

+1 for remove these deprecated methods. The 2 years period should be enough and there was already multiple Keycloak releases with the deprecated methods.

0 replies

Navigation Menu

Repository navigation

Remove deprecated methods in data providers and models #13565

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 3 comments 2 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Remove deprecated methods in data providers and models #13565

Uh oh!

Uh oh!

hmlnarik Aug 5, 2022

Description

Scope

Examples of these methods

Replies: 3 comments · 2 replies

Uh oh!

mduchrow Aug 5, 2022

Uh oh!

abstractj Aug 5, 2022 Maintainer

Uh oh!

hmlnarik Aug 5, 2022 Author

Uh oh!

abstractj Aug 5, 2022 Maintainer

Uh oh!

mposolda Aug 8, 2022 Maintainer

hmlnarik
Aug 5, 2022

Replies: 3 comments 2 replies

mduchrow
Aug 5, 2022

abstractj
Aug 5, 2022
Maintainer

hmlnarik Aug 5, 2022
Author

abstractj Aug 5, 2022
Maintainer

mposolda
Aug 8, 2022
Maintainer