Copilot commented on code in PR #5224: URL: https://github.com/apache/solr/pull/5224#discussion_r4368660325
########## solr/core/src/java/org/apache/solr/search/ScriptFilterIntervalsSource.java: ########## @@ -0,0 +1,318 @@ +/* + * 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.search; + +import java.io.IOException; +import org.apache.lucene.expressions.Bindings; +import org.apache.lucene.expressions.Expression; +import org.apache.lucene.index.LeafReaderContext; +import org.apache.lucene.queries.intervals.FilteredIntervalsSource; +import org.apache.lucene.queries.intervals.IntervalFilter; +import org.apache.lucene.queries.intervals.IntervalIterator; +import org.apache.lucene.queries.intervals.IntervalMatchesIterator; +import org.apache.lucene.queries.intervals.IntervalsSource; +import org.apache.lucene.search.DoubleValues; +import org.apache.lucene.search.DoubleValuesSource; +import org.apache.lucene.search.IndexSearcher; +import org.apache.lucene.search.MatchesIterator; +import org.apache.lucene.search.Query; + +/** + * An {@link FilteredIntervalsSource} that filters intervals by evaluating a Lucene Expressions + * script against the current interval. + * + * <p>The script is bound to the pseudo-variables {@code interval.start}, {@code interval.end} and + * {@code interval.gap}, and an interval is accepted when the script evaluates to a non-zero value. + */ +public class ScriptFilterIntervalsSource extends FilteredIntervalsSource { + + /** Bindings that expose the current interval's {@code start}, {@code end} and {@code gap}. */ + public static class IntervalBindings extends Bindings { + + private static final DoubleValuesSource START = + new IntervalDoubleValuesSource("start") { + @Override + protected double value(IntervalValues interval) { + return interval.start(); + } + }; + private static final DoubleValuesSource END = + new IntervalDoubleValuesSource("end") { + @Override + protected double value(IntervalValues interval) { + return interval.end(); + } + }; + private static final DoubleValuesSource GAP = + new IntervalDoubleValuesSource("gap") { + @Override + protected double value(IntervalValues interval) { + return interval.gaps(); + } + }; + + @Override + public DoubleValuesSource getDoubleValuesSource(String name) { + return switch (name) { + case "interval.start" -> START; + case "interval.end" -> END; + case "interval.gap" -> GAP; + default -> + throw new IllegalArgumentException( + "Unknown interval variable '" + + name + + "'. Available: interval.start, interval.end, interval.gap"); + }; + } + } + + /** A {@link DoubleValuesSource} that reads a scalar property of the current interval. */ + private abstract static class IntervalDoubleValuesSource extends DoubleValuesSource { + + private final String variable; + + IntervalDoubleValuesSource(String variable) { + this.variable = variable; + } + + @Override + public final DoubleValues getValues(LeafReaderContext ctx, DoubleValues scores) + throws IOException { + throw new IOException( + "interval variable '" + variable + "' can only be evaluated within an interval filter"); + } + + @Override + public final boolean needsScores() { + return false; + } + + @Override + public final boolean isCacheable(LeafReaderContext ctx) { + return false; + } + + @Override + public final DoubleValuesSource rewrite(IndexSearcher searcher) throws IOException { + return this; + } + + @Override + public final int hashCode() { + return variable.hashCode(); + } + + @Override + public final boolean equals(Object obj) { + return obj instanceof IntervalDoubleValuesSource that && variable.equals(that.variable); + } + + @Override + public final String toString() { + return "interval." + variable; + } + + protected abstract double value(IntervalValues interval); + } + + private interface IntervalValues { + int start(); + + int end(); + + int gaps(); + } + + private static final class IteratorValues implements IntervalValues { + private final IntervalIterator iterator; + + IteratorValues(IntervalIterator iterator) { + this.iterator = iterator; + } + + @Override + public int start() { + return iterator.start(); + } + + @Override + public int end() { + return iterator.end(); + } + + @Override + public int gaps() { + return iterator.gaps(); + } + } + + private final Expression expression; + private final IntervalBindings bindings; + + /** + * Creates a script-filtered intervals source. + * + * @param in the source to filter + * @param expression a compiled expression whose variables are resolved through {@code bindings} + * @param bindings bindings exposing the interval pseudo-variables + */ + public ScriptFilterIntervalsSource( + IntervalsSource in, Expression expression, IntervalBindings bindings) { + super("SCRIPT(" + expression.sourceText + ")", in); + this.expression = expression; + this.bindings = bindings; + } + + /** Evaluates the script against the current position of one interval iterator. */ + private final class Evaluator { + private final IntervalValues interval; + private final DoubleValues[] values = new DoubleValues[expression.variables.length]; + + Evaluator(IntervalValues interval) { + this.interval = interval; + for (int i = 0; i < values.length; i++) { + DoubleValuesSource source = bindings.getDoubleValuesSource(expression.variables[i]); + values[i] = + new DoubleValues() { + @Override + public double doubleValue() { + return source instanceof IntervalDoubleValuesSource ids + ? ids.value(Evaluator.this.interval) + : Double.NaN; + } + + @Override + public boolean advanceExact(int doc) { + return true; + } + }; + } + } + + boolean accept() throws IOException { + return expression.evaluate(values) != 0; + } + } + + @Override + public IntervalIterator intervals(String field, LeafReaderContext ctx) throws IOException { + IntervalIterator in = this.in.intervals(field, ctx); + if (in == null) { + return null; + } + Evaluator evaluator = new Evaluator(new IteratorValues(in)); + return new IntervalFilter(in) { + @Override + protected boolean accept() { + try { + return evaluator.accept(); + } catch (IOException e) { + throw new RuntimeException( + "Failed to evaluate interval script '" + expression.sourceText + "'", e); + } + } + }; + } + + @Override + public IntervalMatchesIterator matches(String field, LeafReaderContext ctx, int doc) + throws IOException { + IntervalMatchesIterator source = in.matches(field, ctx, doc); + if (source == null) { + return null; + } + Evaluator evaluator = + new Evaluator( + new IntervalValues() { + @Override + public int start() { + return source.startPosition(); + } + + @Override + public int end() { + return source.endPosition(); + } + + @Override + public int gaps() { + return source.gaps(); + } + }); + return new IntervalMatchesIterator() { + @Override + public boolean next() throws IOException { Review Comment: When the source has intervals but the script rejects all of them (for example, `source: '0'`), `matches()` returns a non-null iterator instead of the required null result. This can cause `MatchedQueriesComponent` to report a rejected named SHOULD clause as matching when another clause retrieves the document. Find the first accepted interval before returning, return null if none survives, and preserve that interval for the wrapper's first `next()` call. -- 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]
