Skip to content

Change signature of Get Repositories Response #30333

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.

Sign up for GitHub

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 4 commits into from
May 3, 2018
Merged

Change signature of Get Repositories Response #30333

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
69ad128
Change signature of Get Repositories Response
hub-cap May 2, 2018
ee6ba37
Fix precommit
hub-cap May 2, 2018
9f268f9
Cleanup signature of repositories()
hub-cap May 2, 2018
caffca8
Merge remote-tracking branch 'upstream/master' into repository_fix_re…
hub-cap May 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 15 additions & 35 deletions ...java/org/elasticsearch/action/admin/cluster/repositories/get/GetRepositoriesResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,27 @@
package org.elasticsearch.action.admin.cluster.repositories.get;

import org.elasticsearch.action.ActionResponse;
import org.elasticsearch.cluster.metadata.RepositoryMetaData;
import org.elasticsearch.cluster.metadata.RepositoriesMetaData;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.xcontent.ToXContentObject;
import org.elasticsearch.common.xcontent.XContentBuilder;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

/**
* Get repositories response
*/
public class GetRepositoriesResponse extends ActionResponse implements Iterable<RepositoryMetaData> {

private List<RepositoryMetaData> repositories = Collections.emptyList();
public class GetRepositoriesResponse extends ActionResponse implements ToXContentObject {

private RepositoriesMetaData repositories;

GetRepositoriesResponse() {
repositories = new RepositoriesMetaData(Collections.emptyList());
}

GetRepositoriesResponse(List<RepositoryMetaData> repositories) {
GetRepositoriesResponse(RepositoriesMetaData repositories) {
this.repositories = repositories;
}

Expand All @@ -51,44 +49,26 @@ public class GetRepositoriesResponse extends ActionResponse implements Iterable<
*
* @return list or repositories
*/
public List<RepositoryMetaData> repositories() {
public RepositoriesMetaData repositories() {
return repositories;
}


@Override
public void readFrom(StreamInput in) throws IOException {
super.readFrom(in);
int size = in.readVInt();
List<RepositoryMetaData> repositoryListBuilder = new ArrayList<>(size);
for (int j = 0; j < size; j++) {
repositoryListBuilder.add(new RepositoryMetaData(
in.readString(),
in.readString(),
Settings.readSettingsFromStream(in))
);
}
repositories = Collections.unmodifiableList(repositoryListBuilder);
repositories = new RepositoriesMetaData(in);
}

@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
out.writeVInt(repositories.size());
for (RepositoryMetaData repository : repositories) {
out.writeString(repository.name());
out.writeString(repository.type());
Settings.writeSettingsToStream(repository.settings(), out);
}
repositories.writeTo(out);
}

/**
* Iterator over the repositories data
*
* @return iterator over the repositories data
*/
@Override
public Iterator<RepositoryMetaData> iterator() {
return repositories.iterator();
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
repositories.toXContent(builder, params);
builder.endObject();
return builder;
}
}
6 changes: 3 additions & 3 deletions ...g/elasticsearch/action/admin/cluster/repositories/get/TransportGetRepositoriesAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ protected void masterOperation(final GetRepositoriesRequest request, ClusterStat
RepositoriesMetaData repositories = metaData.custom(RepositoriesMetaData.TYPE);
if (request.repositories().length == 0 || (request.repositories().length == 1 && "_all".equals(request.repositories()[0]))) {
if (repositories != null) {
listener.onResponse(new GetRepositoriesResponse(repositories.repositories()));
listener.onResponse(new GetRepositoriesResponse(new RepositoriesMetaData(repositories.repositories())));
Copy link
Member

@rjernst rjernst May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a new RepositoriesMetaData created instead of using the existing?

Copy link
Contributor Author

@hub-cap hub-cap May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow that was silly. good catch.

} else {
listener.onResponse(new GetRepositoriesResponse(Collections.<RepositoryMetaData>emptyList()));
listener.onResponse(new GetRepositoriesResponse(new RepositoriesMetaData(Collections.<RepositoryMetaData>emptyList())));
Copy link
Member

@rjernst rjernst May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the explicit generic needed? It should be inferred by the compiler?

}
} else {
if (repositories != null) {
Expand All @@ -102,7 +102,7 @@ protected void masterOperation(final GetRepositoriesRequest request, ClusterStat
}
repositoryListBuilder.add(repositoryMetaData);
}
listener.onResponse(new GetRepositoriesResponse(Collections.unmodifiableList(repositoryListBuilder)));
listener.onResponse(new GetRepositoriesResponse(new RepositoriesMetaData((repositoryListBuilder))));
Copy link
Member

@rjernst rjernst May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: there is an extra set of parens

} else {
listener.onFailure(new RepositoryMissingException(request.repositories()[0]));
}
Expand Down
22 changes: 3 additions & 19 deletions .../src/main/java/org/elasticsearch/rest/action/admin/cluster/RestGetRepositoriesAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,19 @@
import org.elasticsearch.action.admin.cluster.repositories.get.GetRepositoriesRequest;
import org.elasticsearch.action.admin.cluster.repositories.get.GetRepositoriesResponse;
import org.elasticsearch.client.node.NodeClient;
import org.elasticsearch.cluster.metadata.RepositoriesMetaData;
import org.elasticsearch.cluster.metadata.RepositoryMetaData;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.settings.SettingsFilter;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.rest.BaseRestHandler;
import org.elasticsearch.rest.BytesRestResponse;
import org.elasticsearch.rest.RestController;
import org.elasticsearch.rest.RestRequest;
import org.elasticsearch.rest.RestResponse;
import org.elasticsearch.rest.action.RestBuilderListener;
import org.elasticsearch.rest.action.RestToXContentListener;

import java.io.IOException;
import java.util.Set;

import static org.elasticsearch.client.Requests.getRepositoryRequest;
import static org.elasticsearch.rest.RestRequest.Method.GET;
import static org.elasticsearch.rest.RestStatus.OK;

/**
* Returns repository information
Expand Down Expand Up @@ -69,18 +63,8 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
getRepositoriesRequest.local(request.paramAsBoolean("local", getRepositoriesRequest.local()));
settingsFilter.addFilterSettingParams(request);
return channel ->
client.admin().cluster().getRepositories(getRepositoriesRequest, new RestBuilderListener<GetRepositoriesResponse>(channel) {
@Override
public RestResponse buildResponse(GetRepositoriesResponse response, XContentBuilder builder) throws Exception {
builder.startObject();
for (RepositoryMetaData repositoryMetaData : response.repositories()) {
RepositoriesMetaData.toXContent(repositoryMetaData, builder, request);
}
builder.endObject();

return new BytesRestResponse(OK, builder);
}
});
client.admin().cluster().getRepositories(getRepositoriesRequest,
new RestToXContentListener<GetRepositoriesResponse>(channel));
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/org/elasticsearch/rest/action/cat/RestRepositoriesAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ protected Table getTableWithHeader(RestRequest request) {

private Table buildTable(RestRequest req, GetRepositoriesResponse getRepositoriesResponse) {
Table table = getTableWithHeader(req);
for (RepositoryMetaData repositoryMetaData : getRepositoriesResponse.repositories()) {
for (RepositoryMetaData repositoryMetaData : getRepositoriesResponse.repositories().repositories()) {
Copy link
Member

@rjernst rjernst May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repositories().repositories() looks very confusing. Maybe the GetRepositoriesResponse.repositories() should continue to return the List, internally calling repositories.repositories()?

Copy link
Contributor Author

@hub-cap hub-cap May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was my only struggle. Everything else exposes the actual object (the constructor, etc) and so i wanted to keep it the same. My other thought was to actually use the Iterator that it was (see the removal of that in the review) and just remove both of the repositories().repositories(). its the only way this class is really used anyway. Thoughts @rjernst ?

Copy link
Member

@rjernst rjernst May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using the iterator sounds fine.

Copy link
Contributor Author

@hub-cap hub-cap May 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were a bunch of other uses in tests to check the size / contents, as a list, so i decided to revert the repositories() return value. having access to the RepositoriesMetaData is not that useful as a consumer of this call anyway.

table.startRow();

table.addCell(repositoryMetaData.name());
Expand Down
2 changes: 1 addition & 1 deletion ...src/test/java/org/elasticsearch/action/admin/cluster/repositories/RepositoryBlocksIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public void testGetRepositoryWithBlocks() {
try {
setClusterReadOnly(true);
GetRepositoriesResponse response = client().admin().cluster().prepareGetRepositories("test-repo-blocks").execute().actionGet();
assertThat(response.repositories(), hasSize(1));
assertThat(response.repositories().repositories(), hasSize(1));
} finally {
setClusterReadOnly(false);
}
Expand Down
2 changes: 1 addition & 1 deletion server/src/test/java/org/elasticsearch/snapshots/DedicatedClusterSnapshotRestoreIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ public void testRestoreCustomMetadata() throws Exception {

logger.info("--> make sure old repository wasn't restored");
assertThrows(client.admin().cluster().prepareGetRepositories("test-repo"), RepositoryMissingException.class);
assertThat(client.admin().cluster().prepareGetRepositories("test-repo-2").get().repositories().size(), equalTo(1));
assertThat(client.admin().cluster().prepareGetRepositories("test-repo-2").get().repositories().repositories().size(), equalTo(1));

logger.info("--> check that custom persistent metadata was restored");
ClusterState clusterState = client.admin().cluster().prepareState().get().getState();
Expand Down
12 changes: 6 additions & 6 deletions server/src/test/java/org/elasticsearch/snapshots/RepositoriesIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,20 +95,20 @@ public void testRepositoryCreation() throws Exception {
logger.info("--> check that both repositories can be retrieved by getRepositories query");
GetRepositoriesResponse repositoriesResponse = client.admin().cluster()
.prepareGetRepositories(randomFrom("_all", "*", "test-repo-*")).get();
assertThat(repositoriesResponse.repositories().size(), equalTo(2));
assertThat(findRepository(repositoriesResponse.repositories(), "test-repo-1"), notNullValue());
assertThat(findRepository(repositoriesResponse.repositories(), "test-repo-2"), notNullValue());
assertThat(repositoriesResponse.repositories().repositories().size(), equalTo(2));
assertThat(findRepository(repositoriesResponse.repositories().repositories(), "test-repo-1"), notNullValue());
assertThat(findRepository(repositoriesResponse.repositories().repositories(), "test-repo-2"), notNullValue());

logger.info("--> delete repository test-repo-1");
client.admin().cluster().prepareDeleteRepository("test-repo-1").get();
repositoriesResponse = client.admin().cluster().prepareGetRepositories().get();
assertThat(repositoriesResponse.repositories().size(), equalTo(1));
assertThat(findRepository(repositoriesResponse.repositories(), "test-repo-2"), notNullValue());
assertThat(repositoriesResponse.repositories().repositories().size(), equalTo(1));
assertThat(findRepository(repositoriesResponse.repositories().repositories(), "test-repo-2"), notNullValue());

logger.info("--> delete repository test-repo-2");
client.admin().cluster().prepareDeleteRepository("test-repo-2").get();
repositoriesResponse = client.admin().cluster().prepareGetRepositories().get();
assertThat(repositoriesResponse.repositories().size(), equalTo(0));
assertThat(repositoriesResponse.repositories().repositories().size(), equalTo(0));
}

private RepositoryMetaData findRepository(List<RepositoryMetaData> repositories, String name) {
Expand Down