epugh commented on code in PR #2470:
URL: https://github.com/apache/solr/pull/2470#discussion_r1607425946
##########
solr/core/src/java/org/apache/solr/filestore/FileStoreAPI.java:
##########
Review Comment:
I sort of thought maybe `FileStoreAPI.java` would be totally removed in
favour of the new classes?
##########
solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java:
##########
@@ -217,7 +217,7 @@ private boolean fetchFileFromNodeAndPersist(String
fromNode) {
}
boolean fetchFromAnyNode() {
- ArrayList<String> l = coreContainer.getFileStoreAPI().shuffledNodes();
+ ArrayList<String> l = FileStoreUtils.shuffledNodes(coreContainer);
Review Comment:
i know you are worried about scope, but maybe not `l`? `liveNodes`?
##########
solr/core/src/java/org/apache/solr/pkg/PackageAPI.java:
##########
@@ -254,7 +250,7 @@ public void refresh(PayloadObj<String> payload) {
}
// first refresh my own
packageLoader.notifyListeners(p);
- for (String s : coreContainer.getFileStoreAPI().shuffledNodes()) {
+ for (String s : FileStoreUtils.shuffledNodes(coreContainer)) {
Review Comment:
better name on what is returned...?
##########
solr/core/src/java/org/apache/solr/filestore/FileStoreUtils.java:
##########
@@ -0,0 +1,145 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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
+ *
+ * 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.apache.solr.filestore;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.lang.invoke.MethodHandles;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.core.BlobRepository;
+import org.apache.solr.core.CoreContainer;
+import org.apache.solr.util.CryptoKeys;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/** Common utilities used by filestore-related code. */
+public class FileStoreUtils {
+ private static final Logger log =
LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+ /** get a list of nodes randomly shuffled * @lucene.internal */
+ public static ArrayList<String> shuffledNodes(CoreContainer coreContainer) {
+ Set<String> liveNodes =
+
coreContainer.getZkController().getZkStateReader().getClusterState().getLiveNodes();
+ ArrayList<String> l = new ArrayList<>(liveNodes);
+ l.remove(coreContainer.getZkController().getNodeName());
+ Collections.shuffle(l, BlobRepository.RANDOM);
+ return l;
+ }
+
+ public static void validateFiles(
+ FileStore fileStore, List<String> files, boolean validateSignatures,
Consumer<String> errs) {
+ for (String path : files) {
+ try {
+ FileStore.FileType type = fileStore.getType(path, true);
+ if (type != FileStore.FileType.FILE) {
+ errs.accept("No such file: " + path);
+ continue;
+ }
+
+ fileStore.get(
+ path,
+ entry -> {
+ if (entry.getMetaData().signatures == null
+ || entry.getMetaData().signatures.isEmpty()) {
+ errs.accept(path + " has no signature");
+ return;
+ }
+ if (validateSignatures) {
+ try {
+ fileStore.refresh(ClusterFileStore.KEYS_DIR);
+ validate(fileStore, entry.meta.signatures, entry, false);
+ } catch (Exception e) {
+ log.error("Error validating package artifact", e);
+ errs.accept(e.getMessage());
+ }
+ }
+ },
+ false);
+ } catch (Exception e) {
+ log.error("Error reading file ", e);
+ errs.accept("Error reading file " + path + " " + e.getMessage());
+ }
+ }
+ }
+
+ /**
+ * Validate a file for signature
+ *
+ * @param sigs the signatures. atleast one should succeed
Review Comment:
`@param signatures The Signatures, at least one should succeed` ?
##########
solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java:
##########
@@ -634,7 +635,7 @@ public Map<String, byte[]> getKeys() throws IOException {
// reads local keys file
private static Map<String, byte[]> _getKeys(Path solrHome) throws
IOException {
Map<String, byte[]> result = new HashMap<>();
- Path keysDir = _getRealPath(FileStoreAPI.KEYS_DIR, solrHome);
+ Path keysDir = _getRealPath(ClusterFileStore.KEYS_DIR, solrHome);
Review Comment:
Sigh I hate you `_` methods and objects!
##########
solr/api/src/java/org/apache/solr/client/api/endpoint/ClusterFileStoreApis.java:
##########
@@ -0,0 +1,56 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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
+ *
+ * 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.apache.solr.client.api.endpoint;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.PUT;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.QueryParam;
+import java.io.InputStream;
+import java.util.List;
+import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.UploadToFileStoreResponse;
+
+@Path("/cluster")
+public interface ClusterFileStoreApis {
+ // TODO Better understand the purpose of the 'sig' parameter and improve
docs here.
Review Comment:
Yeah... There is some signing of stuff, and it probably should be a more
global capability for managing uploading things. Maybe you "sign" a configset
for example. Or treat a file the same ways we treat a configset?
##########
solr/api/src/java/org/apache/solr/client/api/endpoint/ClusterFileStoreApis.java:
##########
@@ -0,0 +1,56 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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
+ *
+ * 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.apache.solr.client.api.endpoint;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.PUT;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.QueryParam;
+import java.io.InputStream;
+import java.util.List;
+import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.UploadToFileStoreResponse;
+
+@Path("/cluster")
+public interface ClusterFileStoreApis {
+ // TODO Better understand the purpose of the 'sig' parameter and improve
docs here.
+ @PUT
+ @Operation(
+ summary = "Upload a file to the filestore.",
+ tags = {"file-store"})
+ @Path("/files{filePath:.+}")
+ UploadToFileStoreResponse uploadFile(
+ @Parameter(description = "File store path") @PathParam("filePath")
String filePath,
+ @Parameter(description = "Signature(s) for the file being uploaded")
@QueryParam("sig")
Review Comment:
Should `sig` be `signature` ?
##########
solr/core/src/java/org/apache/solr/filestore/FileStoreUtils.java:
##########
@@ -0,0 +1,145 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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
+ *
+ * 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.apache.solr.filestore;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.lang.invoke.MethodHandles;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.core.BlobRepository;
+import org.apache.solr.core.CoreContainer;
+import org.apache.solr.util.CryptoKeys;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/** Common utilities used by filestore-related code. */
+public class FileStoreUtils {
+ private static final Logger log =
LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+ /** get a list of nodes randomly shuffled * @lucene.internal */
Review Comment:
why `lucene.internal`?
##########
solr/core/src/java/org/apache/solr/packagemanager/PackageUtils.java:
##########
@@ -302,7 +303,7 @@ public static String getCollectionParamsPath(String
collection) {
}
public static void uploadKey(byte[] bytes, String path, Path home) throws
IOException {
- FileStoreAPI.MetaData meta = FileStoreAPI._createJsonMetaData(bytes, null);
+ FileStoreAPI.MetaData meta = ClusterFileStore._createJsonMetaData(bytes,
null);
Review Comment:
guessing minimizing change, ubt maybe we can remove `_` ?
##########
solr/core/src/java/org/apache/solr/pkg/PackageAPI.java:
##########
@@ -426,7 +422,7 @@ private void syncToVersion(int expectedVersion) {
}
void notifyAllNodesToSync(int expected) {
- for (String s : coreContainer.getFileStoreAPI().shuffledNodes()) {
+ for (String s : FileStoreUtils.shuffledNodes(coreContainer)) {
Review Comment:
LIke wise? what is the string...
##########
solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java:
##########
Review Comment:
Do we need DistribFileStore when we have ClusterFileStore?
##########
solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java:
##########
@@ -217,7 +217,7 @@ private boolean fetchFileFromNodeAndPersist(String
fromNode) {
}
boolean fetchFromAnyNode() {
- ArrayList<String> l = coreContainer.getFileStoreAPI().shuffledNodes();
+ ArrayList<String> l = FileStoreUtils.shuffledNodes(coreContainer);
Review Comment:
or `nodes`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
