[JENKINS-69135] Add a "Versions to include" field to the Global Library Cache feature #16

AnishaGharat · 2022-08-16T20:40:10Z

You can now specify versions to be included for caching. This allows only those specific versions to be cached. This feature can be very useful when there are many versions and you want only one or more of them to be cached. It has the same working mechanism as that of the "Versions to exclude". One thing to be noted is that "Versions to exclude" will always take precedence over "Versions to include" for similar substrings mentioned in both at the same time.

This is pertaining to the Jenkins feature request: JENKINS-69135

This PR pertains to an elaborate documentation of the cache retrieval mechanism with the updated feature that current PR caters to.

Another important feature as per the PR: #4, to delete only a specific version from cache, was tested in collaboration with "Versions to include". The branch for the same: Versions to include + delete specific version.

Bonus Points: The cache deletion method for a specific version can be invoked remotely such that:
final cacheControl = new LibraryCachingConfiguration.DescriptorImpl();
cacheControl.doClearCache(libraryName, branchName, false);

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

…-version-remotely Updated code for deleting specific cache version

…fic-cache-version-remotely Revert "Updated code for deleting specific cache version"

AnishaGharat · 2022-08-16T21:13:32Z

I will be further making changes to handle the scenario if the versions to include is null or " ", but the cache is enabled.

AnishaGharat · 2022-09-02T18:40:16Z

I have updated the changes mentioned in the previous comment in the latest commit.
I have updated the documentation for the plugin that can viewed in the PR : jenkins-infra/jenkins.io#5375

sboardwell · 2022-09-28T13:01:43Z

src/test/java/org/jenkinsci/plugins/workflow/libs/LibraryAdderTest.java

@@ -493,7 +493,7 @@ public void parallelBuildsDontInterfereWithExpiredCache() throws Throwable {
                new SCMSourceRetriever(new GitSCMSource(null, sampleRepo.toString(), "", "*", "", true)));
        config.setDefaultVersion("master");
        config.setImplicit(true);
-        config.setCachingConfiguration(new LibraryCachingConfiguration(30, null));
+        config.setCachingConfiguration(new LibraryCachingConfiguration(30, null,null));


Suggested change

config.setCachingConfiguration(new LibraryCachingConfiguration(30, null,null));

config.setCachingConfiguration(new LibraryCachingConfiguration(30, null, null));

Updated in e0a2432

sboardwell · 2022-09-28T13:04:51Z

src/test/java/org/jenkinsci/plugins/workflow/libs/ResourceStepTest.java

@@ -71,7 +71,7 @@ public class ResourceStepTest {
        initFixedContentLibrary();

        LibraryConfiguration libraryConfig =  new LibraryConfiguration("stuff", new SCMSourceRetriever(new GitSCMSource(null, sampleRepo.toString(), "", "*", "", true)));
-        libraryConfig.setCachingConfiguration(new LibraryCachingConfiguration(0, ""));
+        libraryConfig.setCachingConfiguration(new LibraryCachingConfiguration(0, "",""));


Suggested change

libraryConfig.setCachingConfiguration(new LibraryCachingConfiguration(0, "",""));

libraryConfig.setCachingConfiguration(new LibraryCachingConfiguration(0, "", ""));

Updated in e0a2432

sboardwell · 2022-09-28T13:08:09Z

Looks good. Hoping someone can find time to review this.

AnishaGharat · 2022-09-28T18:00:11Z

Looks good. Hoping someone can find time to review this.

Thank you so much @sboardwell for the review.
Please do let us know if anything more has to be done from our end.

rsandell · 2023-08-25T14:07:33Z

src/main/java/org/jenkinsci/plugins/workflow/libs/LibraryCachingConfiguration.java


    private static final String VERSIONS_SEPARATOR = " ";
    public static final String GLOBAL_LIBRARIES_DIR = "global-libraries-cache";
    public static final String LAST_READ_FILE = "last_read";

-    @DataBoundConstructor public LibraryCachingConfiguration(int refreshTimeMinutes, String excludedVersionsStr) {
+    @DataBoundConstructor public LibraryCachingConfiguration(int refreshTimeMinutes, String excludedVersionsStr, String includedVersionsStr) {


To keep backwards binary compatibility the old constructor signature should be kept and @Deprecated and call the new constructor with default values.

Maybe even a better approach would be to instead just add a @DataboundSetter for the new field, so that it signals that it is optional and doesn't need to be provided unless needed.

rsandell · 2023-08-28T12:13:19Z

This change has been here for a year, so perhaps there is no one able to pick this back up, if that is the case I could try to get it over the finish line, unless anybody objects?

…gin into feature/include-versions-caching

car-roll · 2023-08-29T23:20:36Z

src/main/java/org/jenkinsci/plugins/workflow/libs/LibraryCachingConfiguration.java

@@ -54,6 +70,17 @@ public Boolean isRefreshEnabled() {
    public String getExcludedVersionsStr() {
        return excludedVersionsStr;
    }
+    public String getIncludedVersionsStr() {


do we want a @CheckForNull here?

There isn't any such annotations on the other one?
It I add one here I feel like I would need to add it everywhere :/

Fair point, you can disregard my comment :)

sboardwell

lgtm

KINAXIS\agharat and others added 6 commits August 15, 2022 15:40

Add include versions to enable caching

f2ae5b7

Updated code for deleting specific cache version

f29d6cd

Merge pull request #1 from AnishaGharat/feature/delete-specific-cache…

433d676

…-version-remotely Updated code for deleting specific cache version

Revert "Updated code for deleting specific cache version"

006be8f

Merge pull request #2 from AnishaGharat/revert-1-feature/delete-speci…

e2f1c6d

…fic-cache-version-remotely Revert "Updated code for deleting specific cache version"

Modified caching configuration, unit tests

a0d1dfe

Handling case for empty versions to include

e5374aa

sboardwell reviewed Sep 28, 2022

View reviewed changes

KINAXIS\agharat added 2 commits September 28, 2022 11:38

Refactoring for indentations

e0a2432

Updated comments for include versions

b1b6712

car-roll requested a review from a team December 12, 2022 16:42

car-roll added the enhancement New feature or request label Dec 12, 2022

rsandell reviewed Aug 25, 2023

View reviewed changes

rsandell added 2 commits August 28, 2023 16:39

Merge branch 'master' of github.com:jenkinsci/pipeline-groovy-lib-plu…

884f777

…gin into feature/include-versions-caching

[JENKINS-69135] Use DataboundSetter

4d79950

car-roll reviewed Aug 29, 2023

View reviewed changes

car-roll approved these changes Aug 29, 2023

View reviewed changes

sboardwell approved these changes Aug 30, 2023

View reviewed changes

rsandell merged commit 8ee9ed9 into jenkinsci:master Aug 31, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-69135] Add a "Versions to include" field to the Global Library Cache feature #16

[JENKINS-69135] Add a "Versions to include" field to the Global Library Cache feature #16

AnishaGharat commented Aug 16, 2022 •

edited

Loading

AnishaGharat commented Aug 16, 2022

AnishaGharat commented Sep 2, 2022

sboardwell Sep 28, 2022

sboardwell Sep 28, 2022

AnishaGharat Sep 28, 2022

sboardwell Sep 28, 2022

sboardwell Sep 28, 2022

AnishaGharat Sep 28, 2022

sboardwell commented Sep 28, 2022

AnishaGharat commented Sep 28, 2022

rsandell Aug 25, 2023

rsandell Aug 28, 2023

rsandell commented Aug 28, 2023

car-roll Aug 29, 2023

rsandell Aug 30, 2023

car-roll Aug 30, 2023

sboardwell left a comment

	config.setCachingConfiguration(new LibraryCachingConfiguration(30, null,null));
	config.setCachingConfiguration(new LibraryCachingConfiguration(30, null, null));

	libraryConfig.setCachingConfiguration(new LibraryCachingConfiguration(0, "",""));
	libraryConfig.setCachingConfiguration(new LibraryCachingConfiguration(0, "", ""));

[JENKINS-69135] Add a "Versions to include" field to the Global Library Cache feature #16

[JENKINS-69135] Add a "Versions to include" field to the Global Library Cache feature #16

Conversation

AnishaGharat commented Aug 16, 2022 • edited Loading

AnishaGharat commented Aug 16, 2022

AnishaGharat commented Sep 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sboardwell commented Sep 28, 2022

AnishaGharat commented Sep 28, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rsandell commented Aug 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sboardwell left a comment

Choose a reason for hiding this comment

AnishaGharat commented Aug 16, 2022 •

edited

Loading