dsmiley commented on code in PR #4263: URL: https://github.com/apache/solr/pull/4263#discussion_r3068995998
########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessor.java: ########## @@ -0,0 +1,205 @@ +/* + * 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.update.processor; + +import java.io.IOException; +import java.lang.invoke.MethodHandles; +import java.nio.ByteBuffer; +import java.util.Arrays; +import java.util.Collection; +import java.util.Optional; +import java.util.Set; +import java.util.function.Predicate; +import org.apache.lucene.util.BytesRef; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.SolrInputDocument; +import org.apache.solr.core.SolrCore; +import org.apache.solr.handler.component.RealTimeGetComponent; +import org.apache.solr.handler.component.RealTimeGetComponent.Resolution; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.schema.BinaryField; +import org.apache.solr.schema.SchemaField; +import org.apache.solr.update.AddUpdateCommand; +import org.apache.solr.update.UpdateCommand; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link UpdateRequestProcessor} which computes a hash of field values, and + * uses this hash to reject/accept document updates. + * + * <ul> + * <li>When no corresponding document with same id exists (create), the computed hash is added to + * the document. + * <li>When a previous document exists (update), a new hash is computed from the incoming field + * values and compared with the stored hash. + * </ul> + * + * <p>Depending on {#dropSameDocuments} value, this processor may drop or accept document updates. + * This implementation can be used for monitoring or dropping no-op updates (updates that do not + * change the Solr document content). + * + * <p>Note: the hash is computed using {@link Lookup3Signature} and must be stored in a field with + * docValues enabled for retrieval. + * + * @see Lookup3Signature + */ +public class ContentHashVersionProcessor extends UpdateRequestProcessor { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final SchemaField hashField; + private final SolrQueryResponse rsp; + private final SolrCore core; + private final Predicate<String> includedFields; // Matcher for included fields in hash + private final Predicate<String> excludedFields; // Matcher for excluded fields from hash + private boolean dropSameDocuments; + private int sameCount = 0; + private int differentCount = 0; + + public ContentHashVersionProcessor( + Predicate<String> hashIncludedFields, + Predicate<String> hashExcludedFields, + String hashFieldName, + SolrQueryRequest req, + SolrQueryResponse rsp, + UpdateRequestProcessor next) { + super(next); + this.core = req.getCore(); + this.hashField = new SchemaField(hashFieldName, new BinaryField()); + this.rsp = rsp; + this.includedFields = hashIncludedFields; + this.excludedFields = hashExcludedFields; + } + + @Override + public void processAdd(AddUpdateCommand cmd) throws IOException { + SolrInputDocument newDoc = cmd.getSolrInputDocument(); + byte[] newHash = computeDocHash(newDoc); + newDoc.setField(hashField.getName(), newHash); + + if (!isHashAcceptable(cmd.getIndexedId(), newHash)) { + return; + } + + for (int i = 0; ; i++) { + logOverlyFailedRetries(i, cmd); + try { + super.processAdd(cmd); + return; + } catch (SolrException e) { + if (e.code() != 409) { + throw e; + } + ++i; + } + } + } + + @Override + public void finish() throws IOException { + try { + super.finish(); + } finally { + // Only log when there are updates to existing documents + int totalUpdates = sameCount + differentCount; + if (totalUpdates > 0) { + if (dropSameDocuments) { + rsp.addToLog("contentHash.duplicatesDropped", sameCount); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } else { + rsp.addToLog("contentHash.duplicatesDropped", 0); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } + rsp.addToLog("contentHash.changed", differentCount); Review Comment: In your opinion, is this useful? ########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessor.java: ########## @@ -0,0 +1,205 @@ +/* + * 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.update.processor; + +import java.io.IOException; +import java.lang.invoke.MethodHandles; +import java.nio.ByteBuffer; +import java.util.Arrays; +import java.util.Collection; +import java.util.Optional; +import java.util.Set; +import java.util.function.Predicate; +import org.apache.lucene.util.BytesRef; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.SolrInputDocument; +import org.apache.solr.core.SolrCore; +import org.apache.solr.handler.component.RealTimeGetComponent; +import org.apache.solr.handler.component.RealTimeGetComponent.Resolution; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.schema.BinaryField; +import org.apache.solr.schema.SchemaField; +import org.apache.solr.update.AddUpdateCommand; +import org.apache.solr.update.UpdateCommand; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link UpdateRequestProcessor} which computes a hash of field values, and + * uses this hash to reject/accept document updates. + * + * <ul> + * <li>When no corresponding document with same id exists (create), the computed hash is added to + * the document. + * <li>When a previous document exists (update), a new hash is computed from the incoming field + * values and compared with the stored hash. + * </ul> + * + * <p>Depending on {#dropSameDocuments} value, this processor may drop or accept document updates. + * This implementation can be used for monitoring or dropping no-op updates (updates that do not + * change the Solr document content). + * + * <p>Note: the hash is computed using {@link Lookup3Signature} and must be stored in a field with + * docValues enabled for retrieval. + * + * @see Lookup3Signature + */ +public class ContentHashVersionProcessor extends UpdateRequestProcessor { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final SchemaField hashField; + private final SolrQueryResponse rsp; + private final SolrCore core; + private final Predicate<String> includedFields; // Matcher for included fields in hash + private final Predicate<String> excludedFields; // Matcher for excluded fields from hash + private boolean dropSameDocuments; + private int sameCount = 0; + private int differentCount = 0; + + public ContentHashVersionProcessor( + Predicate<String> hashIncludedFields, + Predicate<String> hashExcludedFields, + String hashFieldName, + SolrQueryRequest req, + SolrQueryResponse rsp, + UpdateRequestProcessor next) { + super(next); + this.core = req.getCore(); + this.hashField = new SchemaField(hashFieldName, new BinaryField()); + this.rsp = rsp; + this.includedFields = hashIncludedFields; + this.excludedFields = hashExcludedFields; + } + + @Override + public void processAdd(AddUpdateCommand cmd) throws IOException { + SolrInputDocument newDoc = cmd.getSolrInputDocument(); + byte[] newHash = computeDocHash(newDoc); + newDoc.setField(hashField.getName(), newHash); + + if (!isHashAcceptable(cmd.getIndexedId(), newHash)) { + return; + } + + for (int i = 0; ; i++) { + logOverlyFailedRetries(i, cmd); + try { + super.processAdd(cmd); + return; + } catch (SolrException e) { + if (e.code() != 409) { + throw e; + } + ++i; + } + } + } + + @Override + public void finish() throws IOException { + try { + super.finish(); + } finally { + // Only log when there are updates to existing documents + int totalUpdates = sameCount + differentCount; + if (totalUpdates > 0) { + if (dropSameDocuments) { + rsp.addToLog("contentHash.duplicatesDropped", sameCount); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } else { + rsp.addToLog("contentHash.duplicatesDropped", 0); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } + rsp.addToLog("contentHash.changed", differentCount); + } else { + rsp.addToLog("contentHash.duplicatesDropped", 0); + rsp.addToLog("contentHash.duplicatesDetected", 0); + rsp.addToLog("contentHash.changed", 0); + } + } + } + + private static void logOverlyFailedRetries(int i, UpdateCommand cmd) { + if ((i & 255) == 255) { + log.warn("Unusual number of optimistic concurrency retries: retries={} cmd={}", i, cmd); + } + } + + void setDropSameDocuments(boolean dropSameDocuments) { + this.dropSameDocuments = dropSameDocuments; + } + + private boolean isHashAcceptable(BytesRef indexedDocId, byte[] newHash) throws IOException { + assert null != indexedDocId; + + Optional<byte[]> oldDocHash = getOldDocHash(indexedDocId); + if (oldDocHash.isPresent()) { + if (Arrays.equals(newHash, oldDocHash.get())) { + sameCount++; + return !dropSameDocuments; + } else { + differentCount++; + return true; + } + } + return true; // Doc not found + } + + /** Retrieves the hash value from the old document identified by the given ID. */ + private Optional<byte[]> getOldDocHash(BytesRef indexedDocId) throws IOException { + SolrInputDocument oldDoc = + RealTimeGetComponent.getInputDocument( + core, indexedDocId, indexedDocId, null, Set.of(hashField.getName()), Resolution.DOC); + if (oldDoc == null) { + return Optional.empty(); + } + Object o = oldDoc.getFieldValue(hashField.getName()); + if (o instanceof byte[] bytes) { + return Optional.of(bytes); + } else if (o instanceof ByteBuffer buf) { + byte[] bytes = new byte[buf.remaining()]; + buf.duplicate().get(bytes); + return Optional.of(bytes); + } + return Optional.empty(); + } + + byte[] computeDocHash(SolrInputDocument doc) { + final Signature sig = new Lookup3Signature(); + + // Stream field names, filter, sort, and process in a single pass + doc.getFieldNames().stream() + .filter(includedFields) // Keep fields that match 'included fields' matcher + .filter(excludedFields.negate()) // Exclude fields that match 'excluded fields' matcher + .sorted() // Sort to ensure consistent field order across different doc field orders + .forEach( + fieldName -> { + sig.add(fieldName); + Object o = doc.getFieldValue(fieldName); Review Comment: If we streamed SolrInputField instead of the field names, we wouldn't have to do this lookup. It's also not a big deal. ########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessorFactory.java: ########## @@ -0,0 +1,169 @@ +/* + * 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.update.processor; + +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.function.Predicate; +import java.util.stream.Collectors; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.util.NamedList; +import org.apache.solr.common.util.StrUtils; +import org.apache.solr.core.SolrCore; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.util.plugin.SolrCoreAware; + +/** Factory for {@link ContentHashVersionProcessor} instances. */ Review Comment: Another thing worth documenting is that this URP should be configured to exclude fields updated with [in-place updates](https://solr.apache.org/guide/solr/latest/indexing-guide/partial-document-updates.html#in-place-updates). ########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessorFactory.java: ########## @@ -0,0 +1,169 @@ +/* + * 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.update.processor; + +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.function.Predicate; +import java.util.stream.Collectors; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.util.NamedList; +import org.apache.solr.common.util.StrUtils; +import org.apache.solr.core.SolrCore; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.util.plugin.SolrCoreAware; + +/** Factory for {@link ContentHashVersionProcessor} instances. */ Review Comment: This cool new URP should be documented here: solr/solr-ref-guide/modules/configuration-guide/pages/update-request-processors.adoc which will basically be a link to these javadocs. But these javadocs are looking sparse... ########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessor.java: ########## @@ -0,0 +1,205 @@ +/* + * 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.update.processor; + +import java.io.IOException; +import java.lang.invoke.MethodHandles; +import java.nio.ByteBuffer; +import java.util.Arrays; +import java.util.Collection; +import java.util.Optional; +import java.util.Set; +import java.util.function.Predicate; +import org.apache.lucene.util.BytesRef; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.SolrInputDocument; +import org.apache.solr.core.SolrCore; +import org.apache.solr.handler.component.RealTimeGetComponent; +import org.apache.solr.handler.component.RealTimeGetComponent.Resolution; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.schema.BinaryField; +import org.apache.solr.schema.SchemaField; +import org.apache.solr.update.AddUpdateCommand; +import org.apache.solr.update.UpdateCommand; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link UpdateRequestProcessor} which computes a hash of field values, and + * uses this hash to reject/accept document updates. + * + * <ul> + * <li>When no corresponding document with same id exists (create), the computed hash is added to + * the document. + * <li>When a previous document exists (update), a new hash is computed from the incoming field + * values and compared with the stored hash. + * </ul> + * + * <p>Depending on {#dropSameDocuments} value, this processor may drop or accept document updates. + * This implementation can be used for monitoring or dropping no-op updates (updates that do not + * change the Solr document content). + * + * <p>Note: the hash is computed using {@link Lookup3Signature} and must be stored in a field with + * docValues enabled for retrieval. + * + * @see Lookup3Signature + */ +public class ContentHashVersionProcessor extends UpdateRequestProcessor { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final SchemaField hashField; + private final SolrQueryResponse rsp; + private final SolrCore core; + private final Predicate<String> includedFields; // Matcher for included fields in hash + private final Predicate<String> excludedFields; // Matcher for excluded fields from hash + private boolean dropSameDocuments; + private int sameCount = 0; + private int differentCount = 0; + + public ContentHashVersionProcessor( + Predicate<String> hashIncludedFields, + Predicate<String> hashExcludedFields, + String hashFieldName, + SolrQueryRequest req, + SolrQueryResponse rsp, + UpdateRequestProcessor next) { + super(next); + this.core = req.getCore(); + this.hashField = new SchemaField(hashFieldName, new BinaryField()); + this.rsp = rsp; + this.includedFields = hashIncludedFields; + this.excludedFields = hashExcludedFields; + } + + @Override + public void processAdd(AddUpdateCommand cmd) throws IOException { + SolrInputDocument newDoc = cmd.getSolrInputDocument(); + byte[] newHash = computeDocHash(newDoc); + newDoc.setField(hashField.getName(), newHash); + + if (!isHashAcceptable(cmd.getIndexedId(), newHash)) { + return; + } + + for (int i = 0; ; i++) { + logOverlyFailedRetries(i, cmd); + try { + super.processAdd(cmd); + return; + } catch (SolrException e) { + if (e.code() != 409) { Review Comment: Why would we get a 409? I'm guessing you were taking inspiration from DocBasedVersionConstraintsProcessor but that guy is using optimistic concurrency [by setting the internal version](https://github.com/apache/solr/blob/6d52d5fbf2fd46ef7e6333a956f105a29adfaa24/solr/core/src/java/org/apache/solr/update/processor/DocBasedVersionConstraintsProcessor.java#L431), which this new URP here doesn't do. And we don't need to, as we are merely avoiding a redundant operation (an add of a doc that is identical to one already present) whereas DBVCP is potentially adding a document with a new version conditionally based on that it saw an existing doc with an old version. ########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessor.java: ########## @@ -0,0 +1,205 @@ +/* + * 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.update.processor; + +import java.io.IOException; +import java.lang.invoke.MethodHandles; +import java.nio.ByteBuffer; +import java.util.Arrays; +import java.util.Collection; +import java.util.Optional; +import java.util.Set; +import java.util.function.Predicate; +import org.apache.lucene.util.BytesRef; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.SolrInputDocument; +import org.apache.solr.core.SolrCore; +import org.apache.solr.handler.component.RealTimeGetComponent; +import org.apache.solr.handler.component.RealTimeGetComponent.Resolution; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.schema.BinaryField; +import org.apache.solr.schema.SchemaField; +import org.apache.solr.update.AddUpdateCommand; +import org.apache.solr.update.UpdateCommand; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link UpdateRequestProcessor} which computes a hash of field values, and + * uses this hash to reject/accept document updates. + * + * <ul> + * <li>When no corresponding document with same id exists (create), the computed hash is added to + * the document. + * <li>When a previous document exists (update), a new hash is computed from the incoming field + * values and compared with the stored hash. + * </ul> + * + * <p>Depending on {#dropSameDocuments} value, this processor may drop or accept document updates. + * This implementation can be used for monitoring or dropping no-op updates (updates that do not + * change the Solr document content). + * + * <p>Note: the hash is computed using {@link Lookup3Signature} and must be stored in a field with + * docValues enabled for retrieval. + * + * @see Lookup3Signature + */ +public class ContentHashVersionProcessor extends UpdateRequestProcessor { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final SchemaField hashField; + private final SolrQueryResponse rsp; + private final SolrCore core; + private final Predicate<String> includedFields; // Matcher for included fields in hash + private final Predicate<String> excludedFields; // Matcher for excluded fields from hash + private boolean dropSameDocuments; + private int sameCount = 0; + private int differentCount = 0; + + public ContentHashVersionProcessor( + Predicate<String> hashIncludedFields, + Predicate<String> hashExcludedFields, + String hashFieldName, + SolrQueryRequest req, + SolrQueryResponse rsp, + UpdateRequestProcessor next) { + super(next); + this.core = req.getCore(); + this.hashField = new SchemaField(hashFieldName, new BinaryField()); + this.rsp = rsp; + this.includedFields = hashIncludedFields; + this.excludedFields = hashExcludedFields; + } + + @Override + public void processAdd(AddUpdateCommand cmd) throws IOException { + SolrInputDocument newDoc = cmd.getSolrInputDocument(); + byte[] newHash = computeDocHash(newDoc); + newDoc.setField(hashField.getName(), newHash); + + if (!isHashAcceptable(cmd.getIndexedId(), newHash)) { + return; + } + + for (int i = 0; ; i++) { + logOverlyFailedRetries(i, cmd); + try { + super.processAdd(cmd); + return; + } catch (SolrException e) { + if (e.code() != 409) { + throw e; + } + ++i; + } + } + } + + @Override + public void finish() throws IOException { + try { + super.finish(); + } finally { + // Only log when there are updates to existing documents + int totalUpdates = sameCount + differentCount; + if (totalUpdates > 0) { + if (dropSameDocuments) { + rsp.addToLog("contentHash.duplicatesDropped", sameCount); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } else { + rsp.addToLog("contentHash.duplicatesDropped", 0); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } + rsp.addToLog("contentHash.changed", differentCount); + } else { + rsp.addToLog("contentHash.duplicatesDropped", 0); + rsp.addToLog("contentHash.duplicatesDetected", 0); + rsp.addToLog("contentHash.changed", 0); + } + } + } + + private static void logOverlyFailedRetries(int i, UpdateCommand cmd) { + if ((i & 255) == 255) { + log.warn("Unusual number of optimistic concurrency retries: retries={} cmd={}", i, cmd); + } + } + + void setDropSameDocuments(boolean dropSameDocuments) { Review Comment: who calls this? A setter is surprising. ########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessor.java: ########## @@ -0,0 +1,205 @@ +/* + * 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.update.processor; + +import java.io.IOException; +import java.lang.invoke.MethodHandles; +import java.nio.ByteBuffer; +import java.util.Arrays; +import java.util.Collection; +import java.util.Optional; +import java.util.Set; +import java.util.function.Predicate; +import org.apache.lucene.util.BytesRef; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.SolrInputDocument; +import org.apache.solr.core.SolrCore; +import org.apache.solr.handler.component.RealTimeGetComponent; +import org.apache.solr.handler.component.RealTimeGetComponent.Resolution; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.schema.BinaryField; +import org.apache.solr.schema.SchemaField; +import org.apache.solr.update.AddUpdateCommand; +import org.apache.solr.update.UpdateCommand; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link UpdateRequestProcessor} which computes a hash of field values, and + * uses this hash to reject/accept document updates. + * + * <ul> + * <li>When no corresponding document with same id exists (create), the computed hash is added to + * the document. + * <li>When a previous document exists (update), a new hash is computed from the incoming field + * values and compared with the stored hash. + * </ul> + * + * <p>Depending on {#dropSameDocuments} value, this processor may drop or accept document updates. + * This implementation can be used for monitoring or dropping no-op updates (updates that do not + * change the Solr document content). + * + * <p>Note: the hash is computed using {@link Lookup3Signature} and must be stored in a field with + * docValues enabled for retrieval. + * + * @see Lookup3Signature + */ +public class ContentHashVersionProcessor extends UpdateRequestProcessor { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final SchemaField hashField; + private final SolrQueryResponse rsp; + private final SolrCore core; + private final Predicate<String> includedFields; // Matcher for included fields in hash + private final Predicate<String> excludedFields; // Matcher for excluded fields from hash + private boolean dropSameDocuments; + private int sameCount = 0; + private int differentCount = 0; + + public ContentHashVersionProcessor( + Predicate<String> hashIncludedFields, + Predicate<String> hashExcludedFields, + String hashFieldName, + SolrQueryRequest req, + SolrQueryResponse rsp, + UpdateRequestProcessor next) { + super(next); + this.core = req.getCore(); + this.hashField = new SchemaField(hashFieldName, new BinaryField()); + this.rsp = rsp; + this.includedFields = hashIncludedFields; + this.excludedFields = hashExcludedFields; + } + + @Override + public void processAdd(AddUpdateCommand cmd) throws IOException { + SolrInputDocument newDoc = cmd.getSolrInputDocument(); + byte[] newHash = computeDocHash(newDoc); + newDoc.setField(hashField.getName(), newHash); + + if (!isHashAcceptable(cmd.getIndexedId(), newHash)) { + return; + } + + for (int i = 0; ; i++) { + logOverlyFailedRetries(i, cmd); + try { + super.processAdd(cmd); + return; + } catch (SolrException e) { + if (e.code() != 409) { + throw e; + } + ++i; + } + } + } + + @Override + public void finish() throws IOException { + try { + super.finish(); + } finally { + // Only log when there are updates to existing documents + int totalUpdates = sameCount + differentCount; + if (totalUpdates > 0) { + if (dropSameDocuments) { + rsp.addToLog("contentHash.duplicatesDropped", sameCount); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } else { + rsp.addToLog("contentHash.duplicatesDropped", 0); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } + rsp.addToLog("contentHash.changed", differentCount); + } else { Review Comment: It's not uncommon for update batches to have no documents -- the ones that merely send a "commit", for example, or maybe just deletes. IMO we shouldn't bother logging if there were no documents in the batch. ########## solr/core/src/java/org/apache/solr/update/processor/ContentHashVersionProcessor.java: ########## @@ -0,0 +1,205 @@ +/* + * 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.update.processor; + +import java.io.IOException; +import java.lang.invoke.MethodHandles; +import java.nio.ByteBuffer; +import java.util.Arrays; +import java.util.Collection; +import java.util.Optional; +import java.util.Set; +import java.util.function.Predicate; +import org.apache.lucene.util.BytesRef; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.SolrInputDocument; +import org.apache.solr.core.SolrCore; +import org.apache.solr.handler.component.RealTimeGetComponent; +import org.apache.solr.handler.component.RealTimeGetComponent.Resolution; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.apache.solr.schema.BinaryField; +import org.apache.solr.schema.SchemaField; +import org.apache.solr.update.AddUpdateCommand; +import org.apache.solr.update.UpdateCommand; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An implementation of {@link UpdateRequestProcessor} which computes a hash of field values, and + * uses this hash to reject/accept document updates. + * + * <ul> + * <li>When no corresponding document with same id exists (create), the computed hash is added to + * the document. + * <li>When a previous document exists (update), a new hash is computed from the incoming field + * values and compared with the stored hash. + * </ul> + * + * <p>Depending on {#dropSameDocuments} value, this processor may drop or accept document updates. + * This implementation can be used for monitoring or dropping no-op updates (updates that do not + * change the Solr document content). + * + * <p>Note: the hash is computed using {@link Lookup3Signature} and must be stored in a field with + * docValues enabled for retrieval. + * + * @see Lookup3Signature + */ +public class ContentHashVersionProcessor extends UpdateRequestProcessor { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final SchemaField hashField; + private final SolrQueryResponse rsp; + private final SolrCore core; + private final Predicate<String> includedFields; // Matcher for included fields in hash + private final Predicate<String> excludedFields; // Matcher for excluded fields from hash + private boolean dropSameDocuments; + private int sameCount = 0; + private int differentCount = 0; + + public ContentHashVersionProcessor( + Predicate<String> hashIncludedFields, + Predicate<String> hashExcludedFields, + String hashFieldName, + SolrQueryRequest req, + SolrQueryResponse rsp, + UpdateRequestProcessor next) { + super(next); + this.core = req.getCore(); + this.hashField = new SchemaField(hashFieldName, new BinaryField()); + this.rsp = rsp; + this.includedFields = hashIncludedFields; + this.excludedFields = hashExcludedFields; + } + + @Override + public void processAdd(AddUpdateCommand cmd) throws IOException { + SolrInputDocument newDoc = cmd.getSolrInputDocument(); + byte[] newHash = computeDocHash(newDoc); + newDoc.setField(hashField.getName(), newHash); + + if (!isHashAcceptable(cmd.getIndexedId(), newHash)) { + return; + } + + for (int i = 0; ; i++) { + logOverlyFailedRetries(i, cmd); + try { + super.processAdd(cmd); + return; + } catch (SolrException e) { + if (e.code() != 409) { + throw e; + } + ++i; + } + } + } + + @Override + public void finish() throws IOException { + try { + super.finish(); + } finally { + // Only log when there are updates to existing documents + int totalUpdates = sameCount + differentCount; + if (totalUpdates > 0) { + if (dropSameDocuments) { + rsp.addToLog("contentHash.duplicatesDropped", sameCount); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } else { + rsp.addToLog("contentHash.duplicatesDropped", 0); + rsp.addToLog("contentHash.duplicatesDetected", sameCount); + } Review Comment: I propose that we *either* log duplicatesDropped or duplicatesDetected as appropriate. Doing both doesn't add information. -- 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]
