samza-core/src/main/java/org/apache/samza/table/batching/TableBatchHandler.java

/*
 * 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.samza.table.batching;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import com.google.common.base.Preconditions;
import java.util.stream.Collectors;
import org.apache.samza.storage.kv.Entry;
import org.apache.samza.table.AsyncReadWriteTable;


/**
 * Defines how table performs batch operations.
 *
 * @param <K> The key type of the operation.
 * @param <V> The value type of the operation.
 */
public class TableBatchHandler<K, V> implements BatchHandler<K, V> {
  private final AsyncReadWriteTable<K, V> table;

  public TableBatchHandler(AsyncReadWriteTable<K, V> table) {
    Preconditions.checkNotNull(table);

    this.table = table;
  }

  /**
   * Define how batch get should be done.
   *
   * @param operations The batch get operations.
   * @return A CompletableFuture to represent the status of the batch operation.
   */
  private CompletableFuture<?> handleBatchGet(Collection<Operation<K, V>> operations) {
    Preconditions.checkNotNull(operations);
    final List<K> gets = getOperationKeys(operations);
    if (gets.isEmpty()) {
      return CompletableFuture.completedFuture(Collections.EMPTY_MAP);
    }

    final Object[] args = getOperationArgs(operations);
    final CompletableFuture<Map<K, V>> getsFuture = args == null ?
        table.getAllAsync(gets) : table.getAllAsync(gets, args);

    getsFuture.whenComplete((map, throwable) -> {
      operations.forEach(operation -> {
        GetOperation<K, V> getOperation = (GetOperation<K, V>) operation;
        if (throwable != null) {
          getOperation.completeExceptionally(throwable);
        } else {
          getOperation.complete(map.get(operation.getKey()));
        }
      });
    });
    return getsFuture;
  }

  /**
   * Define how batch put should be done.
   *
   * @param operations The batch get operations.
   * @return A CompletableFuture to represent the status of the batch operation.
   */
  private CompletableFuture<?> handleBatchPut(Collection<Operation<K, V>> operations) {
    Preconditions.checkNotNull(operations);

    final List<Entry<K, V>> puts = operations.stream()
        .map(op -> new Entry<>(op.getKey(), op.getValue()))
        .collect(Collectors.toList());
    if (puts.isEmpty()) {
      return CompletableFuture.completedFuture(Collections.EMPTY_MAP);
    }

    final Object[] args = getOperationArgs(operations);
    return args == null ? table.putAllAsync(puts) : table.putAllAsync(puts, args);
  }

  /**
   * Define how batch delete should be done.
   *
   * @param operations The batch get operations.
   * @return A CompletableFuture to represent the status of the batch operation.
   */
  private CompletableFuture<?> handleBatchDelete(Collection<Operation<K, V>> operations) {
    Preconditions.checkNotNull(operations);

    final List<K> deletes = getOperationKeys(operations);
    if (deletes.isEmpty()) {
      return CompletableFuture.completedFuture(Collections.EMPTY_MAP);
    }
    final Object[] args = getOperationArgs(operations);
    return args == null ? table.deleteAllAsync(deletes) : table.deleteAllAsync(deletes, args);
  }

  private List<K> getOperationKeys(Collection<Operation<K, V>> operations) {
    return operations.stream().map(op -> op.getKey()).collect(Collectors.toList());
  }

  private Object[] getOperationArgs(Collection<Operation<K, V>> operations) {
    if (!operations.stream().anyMatch(operation -> operation.getArgs() != null && operation.getArgs().length > 0)) {
      return null;
    }
    final List<Object[]> argsList = new ArrayList<>(operations.size());
    operations.forEach(operation -> argsList.add(operation.getArgs()));
    return argsList.toArray();
  }

  private List<Operation<K, V>> getQueryOperations(Batch<K, V> batch) {
    return batch.getOperations().stream().filter(op -> op instanceof GetOperation)
        .collect(Collectors.toList());
  }

  private List<Operation<K, V>> getPutOperations(Batch<K, V> batch) {
    return batch.getOperations().stream().filter(op -> op instanceof PutOperation)
        .collect(Collectors.toList());
  }

  private List<Operation<K, V>> getDeleteOperations(Batch<K, V> batch) {
    return batch.getOperations().stream().filter(op -> op instanceof DeleteOperation)
        .collect(Collectors.toList());
  }

  /**
   * Perform batch operations.
   */
  @Override
  public CompletableFuture<Void> handle(Batch<K, V> batch) {
    return CompletableFuture.allOf(
        handleBatchPut(getPutOperations(batch)),
        handleBatchDelete(getDeleteOperations(batch)),
        handleBatchGet(getQueryOperations(batch)))
        .whenComplete((val, throwable) -> {
          if (throwable != null) {
            batch.completeExceptionally(throwable);
          } else {
            batch.complete();
          }
        });
  }
}