Jackie-Jiang commented on code in PR #13176: URL: https://github.com/apache/pinot/pull/13176#discussion_r1607693151
########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); Review Comment: Since there are only 3 modes, we can make it a boolean array with 3 elements and use enum ordinal to set whether the mode is enabled ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); + inputs.add(_timestampExpression); + inputs.addAll(_stepExpressions); + return inputs; + } + + @Override + public AggregationResultHolder createAggregationResultHolder() { + return new ObjectAggregationResultHolder(); + } + + @Override + public GroupByResultHolder createGroupByResultHolder(int initialCapacity, int maxCapacity) { + return new ObjectGroupByResultHolder(initialCapacity, maxCapacity); + } + + @Override + public void aggregate(int length, AggregationResultHolder aggregationResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + PriorityQueue<FunnelStepEvent> stepEvents = + new PriorityQueue<>(length, new FunnelStepEvent.FunnelStepEventComparator()); + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + break; + } + } + } + aggregationResultHolder.setValue(stepEvents); + } + + @Override + public void aggregateGroupBySV(int length, int[] groupKeyArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int groupKey = groupKeyArray[i]; + PriorityQueue<FunnelStepEvent> stepEvents = groupByResultHolder.getResult(groupKey); + if (stepEvents == null) { + stepEvents = new PriorityQueue<>(new FunnelStepEvent.FunnelStepEventComparator()); + } + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + groupByResultHolder.setValueForKey(groupKey, stepEvents); + } + } + } + } + + @Override + public void aggregateGroupByMV(int length, int[][] groupKeysArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int[] groupKeys = groupKeysArray[i]; Review Comment: Take the group key logic out of the `j` loop ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); Review Comment: ```suggestion List<ExpressionContext> inputs = new ArrayList<>(1 + _numSteps); ``` ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) Review Comment: Is this a bug? Why do we get different expression in intermediate stage? ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelStepEvent.java: ########## @@ -0,0 +1,97 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import java.util.Comparator; + + +public class FunnelStepEvent { + private long _timestamp; + private int _step; + + public FunnelStepEvent(long timestamp, int step) { + _timestamp = timestamp; + _step = step; + } + + public long getTimestamp() { + return _timestamp; + } + + public int getStep() { + return _step; + } + + public void setTimestamp(long timestamp) { + _timestamp = timestamp; + } + + public void setStep(int step) { + _step = step; + } + + @Override + public String toString() { + return "StepEvent{" + + "timestamp=" + _timestamp + + ", step=" + _step + + '}'; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + + FunnelStepEvent stepEvent = (FunnelStepEvent) o; + + if (_timestamp != stepEvent._timestamp) { + return false; + } + return _step == stepEvent._step; + } + + @Override + public int hashCode() { + int result = Long.hashCode(_timestamp); + result = 31 * result + _step; + return result; + } + + public int compareTo(FunnelStepEvent o) { + if (_timestamp < o._timestamp) { + return -1; + } else if (_timestamp > o._timestamp) { + return 1; + } else { + return Integer.compare(_step, o._step); + } + } + + static class FunnelStepEventComparator implements Comparator<FunnelStepEvent> { Review Comment: No need to add this comparator. You may make `FunnelStepEvent` implements `Comparable` ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); + inputs.add(_timestampExpression); + inputs.addAll(_stepExpressions); + return inputs; + } + + @Override + public AggregationResultHolder createAggregationResultHolder() { + return new ObjectAggregationResultHolder(); + } + + @Override + public GroupByResultHolder createGroupByResultHolder(int initialCapacity, int maxCapacity) { + return new ObjectGroupByResultHolder(initialCapacity, maxCapacity); + } + + @Override + public void aggregate(int length, AggregationResultHolder aggregationResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + PriorityQueue<FunnelStepEvent> stepEvents = + new PriorityQueue<>(length, new FunnelStepEvent.FunnelStepEventComparator()); + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + break; + } + } + } + aggregationResultHolder.setValue(stepEvents); + } + + @Override + public void aggregateGroupBySV(int length, int[] groupKeyArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int groupKey = groupKeyArray[i]; + PriorityQueue<FunnelStepEvent> stepEvents = groupByResultHolder.getResult(groupKey); + if (stepEvents == null) { + stepEvents = new PriorityQueue<>(new FunnelStepEvent.FunnelStepEventComparator()); + } + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + groupByResultHolder.setValueForKey(groupKey, stepEvents); + } + } + } + } + + @Override + public void aggregateGroupByMV(int length, int[][] groupKeysArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int[] groupKeys = groupKeysArray[i]; + for (int groupKey : groupKeys) { + PriorityQueue<FunnelStepEvent> stepEvents = groupByResultHolder.getResult(groupKey); + if (stepEvents == null) { + stepEvents = new PriorityQueue<>(new FunnelStepEvent.FunnelStepEventComparator()); + } + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + groupByResultHolder.setValueForKey(groupKey, stepEvents); + } + } + } + } + } + + @Override + public PriorityQueue<FunnelStepEvent> extractAggregationResult(AggregationResultHolder aggregationResultHolder) { + return aggregationResultHolder.getResult(); + } + + @Override + public PriorityQueue<FunnelStepEvent> extractGroupByResult(GroupByResultHolder groupByResultHolder, int groupKey) { + return groupByResultHolder.getResult(groupKey); + } + + @Override + public PriorityQueue<FunnelStepEvent> merge(PriorityQueue<FunnelStepEvent> intermediateResult1, + PriorityQueue<FunnelStepEvent> intermediateResult2) { + if (intermediateResult1 == null) { + return intermediateResult2; + } + if (intermediateResult2 == null) { + return intermediateResult1; + } + intermediateResult1.addAll(intermediateResult2); + return intermediateResult1; + } + + @Override + public DataSchema.ColumnDataType getIntermediateResultColumnType() { + return DataSchema.ColumnDataType.OBJECT; + } + + @Override + public DataSchema.ColumnDataType getFinalResultColumnType() { + return DataSchema.ColumnDataType.LONG; + } + + @Override + public Long extractFinalResult(PriorityQueue<FunnelStepEvent> stepEvents) { + long finalMaxStep = 0; + if (stepEvents == null || stepEvents.isEmpty()) { + return finalMaxStep; + } + ArrayDeque<FunnelStepEvent> slidingWindow = new ArrayDeque<>(); + while (!stepEvents.isEmpty()) { + fillWindow(stepEvents, slidingWindow); + if (slidingWindow.isEmpty()) { + break; + } + int maxSteps = processWindow(slidingWindow); + finalMaxStep = Math.max(finalMaxStep, maxSteps); + if (finalMaxStep == _numSteps) { + break; + } + long windowStart = slidingWindow.peek().getTimestamp(); + while (!slidingWindow.isEmpty() && slidingWindow.peek().getTimestamp() == windowStart) { + slidingWindow.pollFirst(); + } + } + return finalMaxStep; + } + + private void fillWindow(PriorityQueue<FunnelStepEvent> stepEvents, ArrayDeque<FunnelStepEvent> slidingWindow) { + // Ensure for the sliding window, the first event is the first step + while ((!slidingWindow.isEmpty()) && slidingWindow.peek().getStep() != 0) { + slidingWindow.pollFirst(); + } + if (slidingWindow.isEmpty()) { + while (!stepEvents.isEmpty() && stepEvents.peek().getStep() != 0) { + stepEvents.poll(); + } + if (stepEvents.isEmpty()) { + return; + } + slidingWindow.addLast(stepEvents.poll()); + } + // SlidingWindow is not empty + long windowStart = slidingWindow.peek().getTimestamp(); + while (!stepEvents.isEmpty() && (stepEvents.peek().getTimestamp() <= windowStart + _windowSize)) { + slidingWindow.addLast(stepEvents.poll()); + } + } + + private int processWindow(ArrayDeque<FunnelStepEvent> slidingWindow) { + int maxStep = 0; + long previousTimestamp = -1; + for (FunnelStepEvent event : slidingWindow) { + int currentEventStep = event.getStep(); + // If the same condition holds for the sequence of events, then such repeating event interrupts further + // processing. + if (_modes.contains(Mode.strict_deduplication)) { + if (currentEventStep == maxStep - 1) { + return maxStep; + } + } + // Don't allow interventions of other events. E.g. in the case of A->B->D->C, it stops finding A->B->C at the D + // and the max event level is 2. + if (_modes.contains(Mode.strict_order)) { + if (currentEventStep != maxStep) { + return maxStep; + } + } + // Apply conditions only to events with strictly increasing timestamps. + if (_modes.contains(Mode.strict_increase)) { + if (previousTimestamp == event.getTimestamp()) { + continue; + } + } + previousTimestamp = event.getTimestamp(); + if (maxStep == currentEventStep) { + maxStep++; + } + if (maxStep == _numSteps) { + break; + } + } + return maxStep; + } + + @Override + public String toExplainString() { + return "WindowFunnelAggregationFunction{" + + "_timestampExpression=" + _timestampExpression + + ", _windowSize=" + _windowSize + + ", _stepExpressions=" + _stepExpressions + + ", _numSteps=" + _numSteps + + '}'; + } + + enum Mode { Review Comment: Is this private access only? We usually define enum using all capital letters. When reading it, we should convert value to upper case to match different cases ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelStepEvent.java: ########## @@ -0,0 +1,97 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import java.util.Comparator; + + +public class FunnelStepEvent { + private long _timestamp; + private int _step; Review Comment: Do we ever need to modify these 2 fields? Should we make them `final` and remove the setters? ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); + inputs.add(_timestampExpression); + inputs.addAll(_stepExpressions); + return inputs; + } + + @Override + public AggregationResultHolder createAggregationResultHolder() { + return new ObjectAggregationResultHolder(); + } + + @Override + public GroupByResultHolder createGroupByResultHolder(int initialCapacity, int maxCapacity) { + return new ObjectGroupByResultHolder(initialCapacity, maxCapacity); + } + + @Override + public void aggregate(int length, AggregationResultHolder aggregationResultHolder, Review Comment: What is the expected behavior when there are `null` values? ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); + inputs.add(_timestampExpression); + inputs.addAll(_stepExpressions); + return inputs; + } + + @Override + public AggregationResultHolder createAggregationResultHolder() { + return new ObjectAggregationResultHolder(); + } + + @Override + public GroupByResultHolder createGroupByResultHolder(int initialCapacity, int maxCapacity) { + return new ObjectGroupByResultHolder(initialCapacity, maxCapacity); + } + + @Override + public void aggregate(int length, AggregationResultHolder aggregationResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + PriorityQueue<FunnelStepEvent> stepEvents = + new PriorityQueue<>(length, new FunnelStepEvent.FunnelStepEventComparator()); + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + break; + } + } + } + aggregationResultHolder.setValue(stepEvents); + } + + @Override + public void aggregateGroupBySV(int length, int[] groupKeyArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int groupKey = groupKeyArray[i]; Review Comment: Take the group key logic out of the `j` loop ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); + inputs.add(_timestampExpression); + inputs.addAll(_stepExpressions); + return inputs; + } + + @Override + public AggregationResultHolder createAggregationResultHolder() { + return new ObjectAggregationResultHolder(); + } + + @Override + public GroupByResultHolder createGroupByResultHolder(int initialCapacity, int maxCapacity) { + return new ObjectGroupByResultHolder(initialCapacity, maxCapacity); + } + + @Override + public void aggregate(int length, AggregationResultHolder aggregationResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + PriorityQueue<FunnelStepEvent> stepEvents = + new PriorityQueue<>(length, new FunnelStepEvent.FunnelStepEventComparator()); + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + break; + } + } + } + aggregationResultHolder.setValue(stepEvents); + } + + @Override + public void aggregateGroupBySV(int length, int[] groupKeyArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { Review Comment: Stop after the first match ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); + inputs.add(_timestampExpression); + inputs.addAll(_stepExpressions); + return inputs; + } + + @Override + public AggregationResultHolder createAggregationResultHolder() { + return new ObjectAggregationResultHolder(); + } + + @Override + public GroupByResultHolder createGroupByResultHolder(int initialCapacity, int maxCapacity) { + return new ObjectGroupByResultHolder(initialCapacity, maxCapacity); + } + + @Override + public void aggregate(int length, AggregationResultHolder aggregationResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + PriorityQueue<FunnelStepEvent> stepEvents = + new PriorityQueue<>(length, new FunnelStepEvent.FunnelStepEventComparator()); + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + break; + } + } + } + aggregationResultHolder.setValue(stepEvents); + } + + @Override + public void aggregateGroupBySV(int length, int[] groupKeyArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int groupKey = groupKeyArray[i]; + PriorityQueue<FunnelStepEvent> stepEvents = groupByResultHolder.getResult(groupKey); + if (stepEvents == null) { + stepEvents = new PriorityQueue<>(new FunnelStepEvent.FunnelStepEventComparator()); + } + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + groupByResultHolder.setValueForKey(groupKey, stepEvents); + } + } + } + } + + @Override + public void aggregateGroupByMV(int length, int[][] groupKeysArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { Review Comment: Stop after the first match ########## pinot-core/src/main/java/org/apache/pinot/core/query/aggregation/function/funnel/FunnelMaxStepAggregationFunction.java: ########## @@ -0,0 +1,302 @@ +/** + * 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.pinot.core.query.aggregation.function.funnel; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.PriorityQueue; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.pinot.common.request.context.ExpressionContext; +import org.apache.pinot.common.utils.DataSchema; +import org.apache.pinot.core.common.BlockValSet; +import org.apache.pinot.core.query.aggregation.AggregationResultHolder; +import org.apache.pinot.core.query.aggregation.ObjectAggregationResultHolder; +import org.apache.pinot.core.query.aggregation.function.AggregationFunction; +import org.apache.pinot.core.query.aggregation.groupby.GroupByResultHolder; +import org.apache.pinot.core.query.aggregation.groupby.ObjectGroupByResultHolder; +import org.apache.pinot.segment.spi.AggregationFunctionType; + + +public class FunnelMaxStepAggregationFunction + implements AggregationFunction<PriorityQueue<FunnelStepEvent>, Long> { + private final ExpressionContext _timestampExpression; + private final long _windowSize; + private final List<ExpressionContext> _stepExpressions; + private final Set<Mode> _modes = new HashSet<>(); + private final int _numSteps; + + public FunnelMaxStepAggregationFunction(List<ExpressionContext> arguments) { + int numArguments = arguments.size(); + Preconditions.checkArgument(numArguments > 2, + "FUNNELMAXSTEP expects >= 3 arguments, got: %s. The function can be used as " + + "funnelMaxStep(timestampExpression, windowSize, ARRAY[stepExpression, ..], [mode, [mode, ... ]])", + numArguments); + _timestampExpression = arguments.get(0); + _windowSize = arguments.get(1).getLiteral().getLongValue(); + Preconditions.checkArgument(_windowSize > 0, "Window size must be > 0"); + ExpressionContext stepExpressionContext = arguments.get(2); + if (stepExpressionContext.getFunction() != null) { + // LEAF stage init this function like funnelmaxstep($1,'1000',arrayValueConstructor($2,$3,$4,...)) + _stepExpressions = stepExpressionContext.getFunction().getArguments(); + } else { + // Intermediate Stage init this function like funnelmaxstep($1,'1000',__PLACEHOLDER__) + _stepExpressions = ImmutableList.of(); + } + if (numArguments > 3) { + arguments.subList(3, numArguments).forEach(arg -> _modes.add(Mode.valueOf(arg.getLiteral().getStringValue()))); + } + _numSteps = _stepExpressions.size(); + } + + @Override + public AggregationFunctionType getType() { + return AggregationFunctionType.FUNNELMAXSTEP; + } + + @Override + public String getResultColumnName() { + return getType().getName().toLowerCase() + "(" + _windowSize + ") (" + _timestampExpression.toString() + ", " + + _stepExpressions.stream().map(ExpressionContext::toString) + .collect(Collectors.joining(",")) + ")"; + } + + @Override + public List<ExpressionContext> getInputExpressions() { + final List<ExpressionContext> inputs = new ArrayList<>(); + inputs.add(_timestampExpression); + inputs.addAll(_stepExpressions); + return inputs; + } + + @Override + public AggregationResultHolder createAggregationResultHolder() { + return new ObjectAggregationResultHolder(); + } + + @Override + public GroupByResultHolder createGroupByResultHolder(int initialCapacity, int maxCapacity) { + return new ObjectGroupByResultHolder(initialCapacity, maxCapacity); + } + + @Override + public void aggregate(int length, AggregationResultHolder aggregationResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + PriorityQueue<FunnelStepEvent> stepEvents = + new PriorityQueue<>(length, new FunnelStepEvent.FunnelStepEventComparator()); + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + break; + } + } + } + aggregationResultHolder.setValue(stepEvents); + } + + @Override + public void aggregateGroupBySV(int length, int[] groupKeyArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int groupKey = groupKeyArray[i]; + PriorityQueue<FunnelStepEvent> stepEvents = groupByResultHolder.getResult(groupKey); + if (stepEvents == null) { + stepEvents = new PriorityQueue<>(new FunnelStepEvent.FunnelStepEventComparator()); + } + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + groupByResultHolder.setValueForKey(groupKey, stepEvents); + } + } + } + } + + @Override + public void aggregateGroupByMV(int length, int[][] groupKeysArray, GroupByResultHolder groupByResultHolder, + Map<ExpressionContext, BlockValSet> blockValSetMap) { + long[] timestampBlock = blockValSetMap.get(_timestampExpression).getLongValuesSV(); + List<int[]> stepBlocks = new ArrayList<>(); + for (ExpressionContext stepExpression : _stepExpressions) { + stepBlocks.add(blockValSetMap.get(stepExpression).getIntValuesSV()); + } + for (int i = 0; i < length; i++) { + for (int j = 0; j < _numSteps; j++) { + if (stepBlocks.get(j)[i] == 1) { + int[] groupKeys = groupKeysArray[i]; + for (int groupKey : groupKeys) { + PriorityQueue<FunnelStepEvent> stepEvents = groupByResultHolder.getResult(groupKey); + if (stepEvents == null) { + stepEvents = new PriorityQueue<>(new FunnelStepEvent.FunnelStepEventComparator()); + } + stepEvents.add(new FunnelStepEvent(timestampBlock[i], j)); + groupByResultHolder.setValueForKey(groupKey, stepEvents); + } + } + } + } + } + + @Override + public PriorityQueue<FunnelStepEvent> extractAggregationResult(AggregationResultHolder aggregationResultHolder) { + return aggregationResultHolder.getResult(); + } + + @Override + public PriorityQueue<FunnelStepEvent> extractGroupByResult(GroupByResultHolder groupByResultHolder, int groupKey) { + return groupByResultHolder.getResult(groupKey); + } + + @Override + public PriorityQueue<FunnelStepEvent> merge(PriorityQueue<FunnelStepEvent> intermediateResult1, + PriorityQueue<FunnelStepEvent> intermediateResult2) { + if (intermediateResult1 == null) { + return intermediateResult2; + } + if (intermediateResult2 == null) { + return intermediateResult1; + } + intermediateResult1.addAll(intermediateResult2); + return intermediateResult1; + } + + @Override + public DataSchema.ColumnDataType getIntermediateResultColumnType() { + return DataSchema.ColumnDataType.OBJECT; + } + + @Override + public DataSchema.ColumnDataType getFinalResultColumnType() { + return DataSchema.ColumnDataType.LONG; + } + + @Override + public Long extractFinalResult(PriorityQueue<FunnelStepEvent> stepEvents) { + long finalMaxStep = 0; + if (stepEvents == null || stepEvents.isEmpty()) { + return finalMaxStep; + } + ArrayDeque<FunnelStepEvent> slidingWindow = new ArrayDeque<>(); + while (!stepEvents.isEmpty()) { + fillWindow(stepEvents, slidingWindow); + if (slidingWindow.isEmpty()) { + break; + } + int maxSteps = processWindow(slidingWindow); + finalMaxStep = Math.max(finalMaxStep, maxSteps); + if (finalMaxStep == _numSteps) { + break; + } + long windowStart = slidingWindow.peek().getTimestamp(); + while (!slidingWindow.isEmpty() && slidingWindow.peek().getTimestamp() == windowStart) { + slidingWindow.pollFirst(); + } + } + return finalMaxStep; + } + + private void fillWindow(PriorityQueue<FunnelStepEvent> stepEvents, ArrayDeque<FunnelStepEvent> slidingWindow) { Review Comment: Is this algorithm correct? Do we need to calculate all windows starts with step 0? Currently we will miss all step 0 falling in the window with the previous step 0 -- 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]
