Provide a way to get last file revisions #1096
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -159,7 +159,26 @@ default CompletableFuture<Map<String, EntryType>> listFiles(String projectName, | |
| * @return a {@link Map} of file path and type pairs | ||
| */ | ||
| CompletableFuture<Map<String, EntryType>> listFiles(String projectName, String repositoryName, | ||
| Revision revision, PathPattern pathPattern); | ||
|
|
||
| /** | ||
| * Retrieves the list of the files matched by the given {@link PathPattern}. | ||
| * This method is equivalent to calling: | ||
| * <pre>{@code | ||
| * CentralDogma dogma = ... | ||
| * // Find the last file revision from the last 100 revisions. | ||
| * int includeLastFileRevision = 100; | ||
| * dogma.forRepo(projectName, repositoryName) | ||
| * .files(pathPattern) | ||
| * .includeLastFileRevision(includeLastFileRevision) | ||
| * .list(revision); | ||
| * }</pre> | ||
| * | ||
| * @return a {@link Map} of file path and {@link Entry} pairs | ||
| */ | ||
| CompletableFuture<Map<String, Entry<?>>> listFiles(String projectName, String repositoryName, | ||
| Revision revision, PathPattern pathPattern, | ||
| int includeLastFileRevision); | ||
|
|
||
| /** | ||
| * Retrieves the file at the specified revision and path. This method is a shortcut of | ||
|
|
@@ -220,8 +239,30 @@ default CompletableFuture<Map<String, Entry<?>>> getFiles(String projectName, St | |
| * | ||
| * @return a {@link Map} of file path and {@link Entry} pairs | ||
| */ | ||
| default CompletableFuture<Map<String, Entry<?>>> getFiles(String projectName, String repositoryName, | ||
| Revision revision, PathPattern pathPattern) { | ||
| return getFiles(projectName, repositoryName, revision, pathPattern, -1); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the files matched by the {@link PathPattern}. | ||
| * This method is equivalent to calling: | ||
| * <pre>{@code | ||
| * CentralDogma dogma = ... | ||
| * // Find the last file revision from the last 100 revisions. | ||
| * // If the last file revision is not found, the `Revision.INIT` revision is returned instead. | ||
| * int includeLastFileRevision = 100; | ||
| * dogma.forRepo(projectName, repositoryName) | ||
| * .file(pathPattern) | ||
| * .includeLastFileRevision(includeLastFileRevision) | ||
| * .get(revision); | ||
| * }</pre> | ||
| * | ||
| * @return a {@link Map} of file path and {@link Entry} pairs | ||
| */ | ||
| CompletableFuture<Map<String, Entry<?>>> getFiles(String projectName, String repositoryName, | ||
| Revision revision, PathPattern pathPattern, | ||
| int includeLastFileRevision); | ||
|
|
||
| /** | ||
| * Retrieves the merged entry of the specified {@link MergeSource}s at the specified revision. | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ | |
| */ | ||
| package com.linecorp.centraldogma.client; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkArgument; | ||
| import static java.util.Objects.requireNonNull; | ||
|
|
||
| import java.util.Map; | ||
|
|
@@ -40,6 +41,25 @@ public final class FilesRequest { | |
| this.pathPattern = pathPattern; | ||
| } | ||
|
|
||
| /** | ||
| * Includes the last revision of the file in the result. This option is disabled by default. | ||
| * If the last file revision is not found from the specified range of revisions, {@link Revision#INIT} is | ||
| * returned. | ||
| * | ||
| * <p>Note that this operation may be slow because it needs to search for the last file revisions from the | ||
| * revision history. So please use it carefully. | ||
| * | ||
| * @param includeLastFileRevision the maximum number of revisions to search for the last file revision. | ||
| * If the value is equal to 1, the head revision is | ||
| * included instead. | ||
| */ | ||
| public FilesWithRevisionRequest includeLastFileRevision(int includeLastFileRevision) { | ||
| checkArgument(includeLastFileRevision >= 1 && includeLastFileRevision <= 1000, | ||
| "includeLastFileRevision: %s (expected: 1 .. 1000)", | ||
| includeLastFileRevision); | ||
| return new FilesWithRevisionRequest(centralDogmaRepo, pathPattern, includeLastFileRevision); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the list of the files matched by the given path pattern at the {@link Revision#HEAD}. | ||
| * | ||
|
|
||
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,89 @@ | ||
| /* | ||
| * Copyright 2025 LINE Corporation | ||
| * | ||
| * LINE Corporation licenses this file to you 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: | ||
| * | ||
| * https://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 com.linecorp.centraldogma.client; | ||
|
|
||
| import static java.util.Objects.requireNonNull; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.concurrent.CompletableFuture; | ||
|
|
||
| import com.linecorp.centraldogma.common.Entry; | ||
| import com.linecorp.centraldogma.common.PathPattern; | ||
| import com.linecorp.centraldogma.common.Revision; | ||
|
|
||
| /** | ||
| * Prepares to send a {@link CentralDogma#getFiles(String, String, Revision, PathPattern, int)} or | ||
| * {@link CentralDogma#listFiles(String, String, Revision, PathPattern, int)} request to the | ||
| * Central Dogma repository. | ||
| */ | ||
| public final class FilesWithRevisionRequest { | ||
|
|
||
| private final CentralDogmaRepository centralDogmaRepo; | ||
| private final PathPattern pathPattern; | ||
| private final int includeLastFileRevision; | ||
|
|
||
| FilesWithRevisionRequest(CentralDogmaRepository centralDogmaRepo, PathPattern pathPattern, | ||
| int includeLastFileRevision) { | ||
| this.centralDogmaRepo = centralDogmaRepo; | ||
| this.pathPattern = pathPattern; | ||
| this.includeLastFileRevision = includeLastFileRevision; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the list of the files matched by the given path pattern at the {@link Revision#HEAD}. | ||
| * Note that the returned {@link Entry} does not contain the content of the file. | ||
| * | ||
| * @return a {@link Map} of file path and {@link Entry} pairs. | ||
| */ | ||
| public CompletableFuture<Map<String, Entry<?>>> list() { | ||
| return list(Revision.HEAD); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the list of the files matched by the given path pattern at the {@link Revision}. | ||
| * Note that the returned {@link Entry} does not contain the content of the file. | ||
| * | ||
| * @return a {@link Map} of file path and {@link Entry} pairs | ||
| */ | ||
| public CompletableFuture<Map<String, Entry<?>>> list(Revision revision) { | ||
| requireNonNull(revision, "revision"); | ||
| return centralDogmaRepo.centralDogma().listFiles(centralDogmaRepo.projectName(), | ||
| centralDogmaRepo.repositoryName(), | ||
| revision, pathPattern, includeLastFileRevision); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the files matched by the path pattern at the {@link Revision#HEAD}. | ||
| * | ||
| * @return a {@link Map} of file path and {@link Entry} pairs | ||
| */ | ||
| public CompletableFuture<Map<String, Entry<?>>> get() { | ||
| return get(Revision.HEAD); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the files matched by the path pattern at the {@link Revision}. | ||
| * | ||
| * @return a {@link Map} of file path and {@link Entry} pairs | ||
| */ | ||
| public CompletableFuture<Map<String, Entry<?>>> get(Revision revision) { | ||
| requireNonNull(revision, "revision"); | ||
| return centralDogmaRepo.centralDogma().getFiles(centralDogmaRepo.projectName(), | ||
| centralDogmaRepo.repositoryName(), | ||
| revision, pathPattern, includeLastFileRevision); | ||
| } | ||
| } |
Oops, something went wrong.
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.
Question) What do you think of setting the default value as
1for both client/server side since it seems like 1 represents "don't search the history"?Personally, I think it makes more sense that:
includeLastFileRevision<0The current implementation seems fine though.
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.
Good idea.
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.
If so, should 0 and 1 return the same result?
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.
I meant it feels more intuitive to me that the parameter represents the number of revisions to go backwards. (i.e.
Revision#backward(int)).I think the current implementation is fine as long as 1) the default value is well defined with validation 2) and the javadocs are clear. It might be helpful if the parameter name better represents the meaning of "check x number of revision including the head revision" as well.