-
Notifications
You must be signed in to change notification settings - Fork 784
Fix K8s token refresh by caching K8sClient at executor level #6925
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
66 changes: 66 additions & 0 deletions
66
plugins/nf-k8s/src/test/nextflow/k8s/K8sExecutorTest.groovy
This file contains hidden or 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,66 @@ | ||
| /* | ||
| * Copyright 2013-2026, Seqera Labs | ||
| * | ||
| * 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 nextflow.k8s | ||
|
|
||
| import java.util.concurrent.TimeUnit | ||
|
|
||
| import com.google.common.cache.CacheBuilder | ||
| import nextflow.k8s.client.ClientConfig | ||
| import nextflow.k8s.client.K8sClient | ||
| import spock.lang.Specification | ||
|
|
||
| /** | ||
| * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com> | ||
| */ | ||
| class K8sExecutorTest extends Specification { | ||
|
|
||
| def 'should cache k8s client and refresh after expiration' () { | ||
| given: | ||
| def CONFIG = new K8sConfig( | ||
| client: [server: 'http://k8s-server'], | ||
| namespace: 'test-ns', | ||
| serviceAccount: 'test-sa', | ||
| clientRefreshInterval: '100ms' | ||
| ) | ||
| and: | ||
| def executor = Spy(K8sExecutor) | ||
| executor.getK8sConfig() >> CONFIG | ||
| // use a short-lived cache for the test | ||
| executor.@clientCache = CacheBuilder.newBuilder() | ||
| .expireAfterWrite(100, TimeUnit.MILLISECONDS) | ||
| .build() | ||
|
|
||
| when: 'first call to getClient' | ||
| def client1 = executor.getClient() | ||
| then: 'a new K8sClient is created' | ||
| client1 instanceof K8sClient | ||
| client1.config.server == 'http://k8s-server' | ||
|
|
||
| when: 'second call within cache interval' | ||
| def client2 = executor.getClient() | ||
| then: 'returns the same cached instance' | ||
| client2.is(client1) | ||
|
|
||
| when: 'call after cache expiration' | ||
| sleep(150) | ||
| def client3 = executor.getClient() | ||
| then: 'a new K8sClient instance is created' | ||
| client3 instanceof K8sClient | ||
| !client3.is(client1) | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Took me a sec to get this, so I'll leave a comment here for future readers. The client config (including token) is cached, but the k8s client itself is recreated on every submit task. This means on a new client is created every time but it's very lightweight. While building a client, it will use the config which is refreshed every 50 minutes (default value).
This is all handled by
getClient()reaches into the Guava cache instead of getting a fresh client. Guava cache handles use-or-get logic.