forked from keycloak/keycloak
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ConditionalRemover interface for External Infinispan feature
Add a ConditionalRemover interface to remove entries from a RemoteCache based on the key or value fields. The default implementation provided by this PR uses streaming/iteration to test and remove entries On a side change, moved all the transactions to the same package and created one transaction class per entity/cache to simplify code and avoid writing "RemoteChangeLogTransaction" with a long list of types. Fixes keycloak#31046 Signed-off-by: Pedro Ruivo <[email protected]>
- Loading branch information
Showing
25 changed files
with
637 additions
and
237 deletions.
There are no files selected for viewing
76 changes: 0 additions & 76 deletions
76
...n/java/org/keycloak/models/sessions/infinispan/changes/remote/UserSessionTransaction.java
This file was deleted.
Oops, something went wrong.
65 changes: 65 additions & 0 deletions
65
...va/org/keycloak/models/sessions/infinispan/changes/remote/remover/ConditionalRemover.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /* | ||
| * Copyright 2024 Red Hat, Inc. and/or its affiliates | ||
| * and other contributors as indicated by the @author tags. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.keycloak.models.sessions.infinispan.changes.remote.remover; | ||
|
|
||
| import org.infinispan.client.hotrod.RemoteCache; | ||
| import org.infinispan.commons.util.concurrent.AggregateCompletionStage; | ||
| import org.keycloak.models.sessions.infinispan.changes.remote.updater.Updater; | ||
| import org.keycloak.models.sessions.infinispan.remote.transaction.RemoteChangeLogTransaction; | ||
|
|
||
| /** | ||
| * It handles conditional remove operations. | ||
| * <p> | ||
| * This class is preferred to remove an unknown amount of entries by its key and/or value state. The implement may use | ||
| * queries (delete statements) or perform a full cache scan to find the entries to remove. | ||
| * <p> | ||
| * The method {@link #willRemove(Updater)} is invoked by {@link RemoteChangeLogTransaction} before perform any change | ||
| * tracked by the {@link Updater}. This is an optimization to prevent sending changes that would be removed by this | ||
| * {@link ConditionalRemover}. | ||
| * | ||
| * @param <K> The key's type stored in the {@link RemoteCache}. | ||
| * @param <V> The value's type stored in the {@link RemoteCache}. | ||
| */ | ||
| public interface ConditionalRemover<K, V> { | ||
|
|
||
| /** | ||
| * @param key The entry's key to test. | ||
| * @param value The entry's value to test. | ||
| * @return {@code true} if the entry will be removed from the {@link RemoteCache}. | ||
| */ | ||
| boolean willRemove(K key, V value); | ||
|
|
||
| /** | ||
| * @param updater The {@link Updater} to test. | ||
| * @return {@code true} if the entry tracked by the {@link Updater} will be removed from the {@link RemoteCache}. | ||
| */ | ||
| default boolean willRemove(Updater<K, V> updater) { | ||
| // The value can be null if the entry updated is marked as deleted. | ||
| // In that case, we don't have the value to check for the condition and will let the transaction perform the removal. | ||
| return updater.getValue() != null && willRemove(updater.getKey(), updater.getValue()); | ||
| } | ||
|
|
||
| /** | ||
| * Executes the conditional removes in the {@link RemoteCache}. | ||
| * | ||
| * @param cache The {@link RemoteCache} to perform the remove operations. | ||
| * @param stage The {@link AggregateCompletionStage} to add any incomplete tasks. | ||
| */ | ||
| void executeRemovals(RemoteCache<K, V> cache, AggregateCompletionStage<Void> stage); | ||
|
|
||
| } |
48 changes: 48 additions & 0 deletions
48
...g/keycloak/models/sessions/infinispan/changes/remote/remover/EmptyConditionalRemover.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Copyright 2024 Red Hat, Inc. and/or its affiliates | ||
| * and other contributors as indicated by the @author tags. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.keycloak.models.sessions.infinispan.changes.remote.remover; | ||
|
|
||
| import org.infinispan.client.hotrod.RemoteCache; | ||
| import org.infinispan.commons.util.concurrent.AggregateCompletionStage; | ||
|
|
||
| /** | ||
| * A {@link ConditionalRemover} that does not remove anything. | ||
| * | ||
| * @param <K> The key's type stored in the {@link RemoteCache}. | ||
| * @param <V> The value's type stored in the {@link RemoteCache}. | ||
| */ | ||
| public class EmptyConditionalRemover<K, V> implements ConditionalRemover<K, V> { | ||
|
|
||
| private static final EmptyConditionalRemover<?, ?> INSTANCE = new EmptyConditionalRemover<>(); | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| public static <K1, V1> ConditionalRemover<K1, V1> instance() { | ||
| return (ConditionalRemover<K1, V1>) INSTANCE; | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public boolean willRemove(K key, V value) { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public void executeRemovals(RemoteCache<K, V> cache, AggregateCompletionStage<Void> stage) { | ||
| //no-op | ||
| } | ||
| } |
56 changes: 56 additions & 0 deletions
56
...els/sessions/infinispan/changes/remote/remover/iteration/ByRealmIdConditionalRemover.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * Copyright 2024 Red Hat, Inc. and/or its affiliates | ||
| * and other contributors as indicated by the @author tags. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.keycloak.models.sessions.infinispan.changes.remote.remover.iteration; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.infinispan.client.hotrod.RemoteCache; | ||
| import org.keycloak.models.sessions.infinispan.changes.remote.remover.ConditionalRemover; | ||
| import org.keycloak.models.sessions.infinispan.entities.SessionEntity; | ||
|
|
||
| /** | ||
| * A {@link ConditionalRemover} implementation to remove {@link SessionEntity} from a {@link RemoteCache} based on | ||
| * {@link SessionEntity#getRealmId()} value. | ||
| * | ||
| * @param <K> The key's type stored in the {@link RemoteCache}. | ||
| * @param <V> The value's type stored in the {@link RemoteCache}. | ||
| */ | ||
| public class ByRealmIdConditionalRemover<K, V extends SessionEntity> extends IterationBasedConditionalRemover<K, V> { | ||
|
|
||
| private final List<String> realms; | ||
|
|
||
| public ByRealmIdConditionalRemover() { | ||
| realms = new ArrayList<>(); | ||
| } | ||
|
|
||
| public void removeByRealmId(String realmId) { | ||
| realms.add(realmId); | ||
| } | ||
|
|
||
| @Override | ||
| boolean isEmpty() { | ||
| return realms.isEmpty(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean willRemove(K key, V value) { | ||
| return realms.contains(value.getRealmId()); | ||
| } | ||
|
|
||
| } |
65 changes: 65 additions & 0 deletions
65
...essions/infinispan/changes/remote/remover/iteration/IterationBasedConditionalRemover.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /* | ||
| * Copyright 2024 Red Hat, Inc. and/or its affiliates | ||
| * and other contributors as indicated by the @author tags. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.keycloak.models.sessions.infinispan.changes.remote.remover.iteration; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import io.reactivex.rxjava3.core.Completable; | ||
| import io.reactivex.rxjava3.core.Flowable; | ||
| import io.reactivex.rxjava3.functions.Predicate; | ||
| import org.infinispan.client.hotrod.MetadataValue; | ||
| import org.infinispan.client.hotrod.RemoteCache; | ||
| import org.infinispan.commons.util.concurrent.AggregateCompletionStage; | ||
| import org.keycloak.models.sessions.infinispan.changes.remote.remover.ConditionalRemover; | ||
|
|
||
| /** | ||
| * An iteration based implementation of {@link ConditionalRemover}. | ||
| * <p> | ||
| * This class is not performance efficient since it has to download the full {@link RemoteCache} content to perform the | ||
| * removal tests. | ||
| * | ||
| * @param <K> The key's type stored in the {@link RemoteCache}. | ||
| * @param <V> The value's type stored in the {@link RemoteCache}. | ||
| */ | ||
| abstract class IterationBasedConditionalRemover<K, V> implements ConditionalRemover<K, V>, Predicate<Map.Entry<K, MetadataValue<V>>> { | ||
|
|
||
| @Override | ||
| public final void executeRemovals(RemoteCache<K, V> cache, AggregateCompletionStage<Void> stage) { | ||
| if (isEmpty()) { | ||
| return; | ||
| } | ||
| var rmStage = Flowable.fromPublisher(cache.publishEntriesWithMetadata(null, 2048)) | ||
| .filter(this) | ||
| .map(Map.Entry::getKey) | ||
| .flatMapCompletable(key -> Completable.fromCompletionStage(cache.removeAsync(key))) | ||
| .toCompletionStage(null); | ||
| stage.dependsOn(rmStage); | ||
| } | ||
|
|
||
| @Override | ||
| public final boolean test(Map.Entry<K, MetadataValue<V>> entry) throws Throwable { | ||
| return willRemove(entry.getKey(), entry.getValue().getValue()); | ||
| } | ||
|
|
||
| /** | ||
| * @return {@code true} if this implementation won't remove anything. It avoids iterating over the | ||
| * {@link RemoteCache} contents. | ||
| */ | ||
| abstract boolean isEmpty(); | ||
|
|
||
| } |
This file contains 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
This file contains 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
Oops, something went wrong.