Clean up workflow query handling (#582)

* Allow user to set QueryRejectCondition through WorkflowClientOptions
* Introduce WorkflowQueryRejectedException and deprecate QueryResult

Author: meiliang86

src/main/java/com/uber/cadence/client/WorkflowClientOptions.java

@@ -17,6 +17,7 @@
 
 package com.uber.cadence.client;
 
+import com.uber.cadence.QueryRejectCondition;
 import com.uber.cadence.context.ContextPropagator;
 import com.uber.cadence.converter.DataConverter;
 import com.uber.cadence.converter.JsonDataConverter;
@@ -60,6 +61,7 @@ public static final class Builder {
     private Scope metricsScope = NoopScope.getInstance();
     private String identity = ManagementFactory.getRuntimeMXBean().getName();;
     private List<ContextPropagator> contextPropagators = EMPTY_CONTEXT_PROPAGATORS;
+    private QueryRejectCondition queryRejectCondition;
 
     private Builder() {}
 
@@ -69,6 +71,7 @@ private Builder(WorkflowClientOptions options) {
       interceptors = options.getInterceptors();
       metricsScope = options.getMetricsScope();
       identity = options.getIdentity();
+      queryRejectCondition = options.getQueryRejectCondition();
     }
 
     public Builder setDomain(String domain) {
@@ -123,33 +126,55 @@ public Builder setContextPropagators(List<ContextPropagator> contextPropagators)
       return this;
     }
 
+    /**
+     * QueryRejectCondition is an optional field used to reject queries based on workflow state.
+     * QueryRejectConditionNotOpen will reject queries to workflows that are not open.
+     * QueryRejectConditionNotCompletedCleanly will reject queries to workflows that are not
+     * completed successfully. (e.g. terminated, canceled timeout etc...)
+     *
+     * <p>Default is null, which means that queries will not be rejected based on workflow state.
+     */
+    public Builder setQueryRejectCondition(QueryRejectCondition queryRejectCondition) {
+      this.queryRejectCondition = queryRejectCondition;
+      return this;
+    }
+
     public WorkflowClientOptions build() {
       metricsScope = metricsScope.tagged(ImmutableMap.of(MetricsTag.DOMAIN, domain));
       return new WorkflowClientOptions(
-          domain, dataConverter, interceptors, metricsScope, identity, contextPropagators);
+          domain,
+          dataConverter,
+          interceptors,
+          metricsScope,
+          identity,
+          contextPropagators,
+          queryRejectCondition);
     }
   }
 
   private final String domain;
   private final DataConverter dataConverter;
   private final WorkflowClientInterceptor[] interceptors;
   private final Scope metricsScope;
-  private String identity;
-  private List<ContextPropagator> contextPropagators;
+  private final String identity;
+  private final List<ContextPropagator> contextPropagators;
+  private final QueryRejectCondition queryRejectCondition;
 
   private WorkflowClientOptions(
       String domain,
       DataConverter dataConverter,
       WorkflowClientInterceptor[] interceptors,
       Scope metricsScope,
       String identity,
-      List<ContextPropagator> contextPropagators) {
+      List<ContextPropagator> contextPropagators,
+      QueryRejectCondition queryRejectCondition) {
     this.domain = domain;
     this.dataConverter = dataConverter;
     this.interceptors = interceptors;
     this.metricsScope = metricsScope;
     this.identity = identity;
     this.contextPropagators = contextPropagators;
+    this.queryRejectCondition = queryRejectCondition;
   }
 
   public String getDomain() {
@@ -175,4 +200,52 @@ public String getIdentity() {
   public List<ContextPropagator> getContextPropagators() {
     return contextPropagators;
   }
+
+  public QueryRejectCondition getQueryRejectCondition() {
+    return queryRejectCondition;
+  }
+
+  @Override
+  public String toString() {
+    return "WorkflowClientOptions{"
+        + "domain='"
+        + domain
+        + '\''
+        + ", dataConverter="
+        + dataConverter
+        + ", interceptors="
+        + Arrays.toString(interceptors)
+        + ", identity='"
+        + identity
+        + '\''
+        + ", contextPropagators="
+        + contextPropagators
+        + ", queryRejectCondition="
+        + queryRejectCondition
+        + '}';
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+    WorkflowClientOptions that = (WorkflowClientOptions) o;
+    return com.google.common.base.Objects.equal(domain, that.domain)
+        && com.google.common.base.Objects.equal(dataConverter, that.dataConverter)
+        && Arrays.equals(interceptors, that.interceptors)
+        && com.google.common.base.Objects.equal(identity, that.identity)
+        && com.google.common.base.Objects.equal(contextPropagators, that.contextPropagators)
+        && queryRejectCondition == that.queryRejectCondition;
+  }
+
+  @Override
+  public int hashCode() {
+    return com.google.common.base.Objects.hashCode(
+        domain,
+        dataConverter,
+        Arrays.hashCode(interceptors),
+        identity,
+        contextPropagators,
+        queryRejectCondition);
+  }
 }

src/main/java/com/uber/cadence/client/WorkflowQueryException.java

@@ -20,7 +20,7 @@
 import com.uber.cadence.WorkflowExecution;
 import java.util.Optional;
 
-public final class WorkflowQueryException extends WorkflowException {
+public class WorkflowQueryException extends WorkflowException {
 
   public WorkflowQueryException(WorkflowExecution execution, String message) {
     super(message, execution, Optional.empty(), null);

src/main/java/com/uber/cadence/client/WorkflowQueryRejectedException.java

@@ -0,0 +1,50 @@
+/*
+ *  Modifications Copyright (c) 2017-2020 Uber Technologies Inc.
+ *  Portions of the Software are attributed to Copyright (c) 2020 Temporal Technologies Inc.
+ *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
+ *  use this file except in compliance with the License. A copy of the License is
+ *  located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ *  or in the "license" file accompanying this file. This file 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 com.uber.cadence.client;
+
+import com.uber.cadence.QueryRejectCondition;
+import com.uber.cadence.WorkflowExecution;
+import com.uber.cadence.WorkflowExecutionCloseStatus;
+
+public final class WorkflowQueryRejectedException extends WorkflowQueryException {
+
+  private final QueryRejectCondition queryRejectCondition;
+  private final WorkflowExecutionCloseStatus workflowExecutionStatus;
+
+  public WorkflowQueryRejectedException(
+      WorkflowExecution execution,
+      QueryRejectCondition queryRejectCondition,
+      WorkflowExecutionCloseStatus workflowExecutionStatus) {
+    super(
+        execution,
+        "Query invoked with "
+            + queryRejectCondition
+            + " reject condition. The workflow execution status is "
+            + workflowExecutionStatus);
+    this.queryRejectCondition = queryRejectCondition;
+    this.workflowExecutionStatus = workflowExecutionStatus;
+  }
+
+  public QueryRejectCondition getQueryRejectCondition() {
+    return queryRejectCondition;
+  }
+
+  public WorkflowExecutionCloseStatus getWorkflowExecutionStatus() {
+    return workflowExecutionStatus;
+  }
+}

src/main/java/com/uber/cadence/client/WorkflowStub.java

@@ -1,8 +1,8 @@
 /*
+ *  Modifications Copyright (c) 2017-2021 Uber Technologies Inc.
+ *  Portions of the Software are attributed to Copyright (c) 2020 Temporal Technologies Inc.
  *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
- *  Modifications copyright (C) 2017 Uber Technologies, Inc.
- *
  *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
  *  use this file except in compliance with the License. A copy of the License is
  *  located at
@@ -19,7 +19,6 @@
 
 import com.uber.cadence.QueryRejectCondition;
 import com.uber.cadence.WorkflowExecution;
-import com.uber.cadence.internal.common.QueryResponse;
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.Proxy;
 import java.lang.reflect.Type;
@@ -142,17 +141,29 @@ <R> CompletableFuture<R> getResultAsync(
 
   <R> CompletableFuture<R> getResultAsync(long timeout, TimeUnit unit, Class<R> resultClass);
 
+  /**
+   * Query workflow by invoking its query handler. A query handler is a method annotated with {@link
+   * com.uber.cadence.workflow.QueryMethod}.
+   *
+   * @see WorkflowClientOptions.Builder#setQueryRejectCondition(QueryRejectCondition)
+   * @param queryType name of the query handler. Usually it is a method name.
+   * @param resultClass class of the query result type
+   * @param args optional query arguments
+   * @param <R> type of the query result
+   * @return query result
+   * @throws WorkflowQueryException if query failed for any reason.
+   */
   <R> R query(String queryType, Class<R> resultClass, Object... args);
 
   <R> R query(String queryType, Class<R> resultClass, Type resultType, Object... args);
 
-  <R> QueryResponse<R> query(
+  <R> R query(
       String queryType,
       Class<R> resultClass,
       QueryRejectCondition queryRejectCondition,
       Object... args);
 
-  <R> QueryResponse<R> query(
+  <R> R query(
       String queryType,
       Class<R> resultClass,
       Type resultType,

src/main/java/com/uber/cadence/internal/common/QueryResponse.java

@@ -89,7 +89,6 @@
 import com.uber.cadence.client.WorkflowClientOptions;
 import com.uber.cadence.client.WorkflowOptions;
 import com.uber.cadence.client.WorkflowStub;
-import com.uber.cadence.internal.common.QueryResponse;
 import com.uber.cadence.internal.testservice.TestWorkflowService;
 import com.uber.cadence.serviceclient.IWorkflowService;
 import com.uber.cadence.testing.TestEnvironmentOptions;
@@ -965,7 +964,7 @@ public <R> R query(String queryType, Class<R> resultClass, Type resultType, Obje
       }
 
       @Override
-      public <R> QueryResponse<R> query(
+      public <R> R query(
           String queryType,
           Class<R> resultClass,
           QueryRejectCondition queryRejectCondition,
@@ -974,7 +973,7 @@ public <R> QueryResponse<R> query(
       }
 
       @Override
-      public <R> QueryResponse<R> query(
+      public <R> R query(
           String queryType,
           Class<R> resultClass,
           Type resultType,