Rename blocking module to filter and define additional evaluate methods (#89)

* Rename blocking module to filter

Signed-off-by: Pavol Loffay <[email protected]>

* Define filter interface

Signed-off-by: Pavol Loffay <[email protected]>

* Working

Signed-off-by: Pavol Loffay <[email protected]>

* Rename package

Signed-off-by: Pavol Loffay <[email protected]>

* Rename blocking module to filter

Signed-off-by: Pavol Loffay <[email protected]>

* Fix muzzle

Signed-off-by: Pavol Loffay <[email protected]>

* Simplify

Signed-off-by: Pavol Loffay <[email protected]>

* Add span to interface

Signed-off-by: Pavol Loffay <[email protected]>

Author: pavolloffay

blocking/build.gradle.kts

@@ -0,0 +1,7 @@
+plugins {
+   `java-library`
+}
+
+dependencies {
+   implementation("io.opentelemetry:opentelemetry-api:0.9.1")
+}

blocking/src/main/java/org/hypertrace/agent/blocking/BlockingProvider.java

@@ -14,23 +14,17 @@
  * limitations under the License.
  */
 
-package org.hypertrace.agent.blocking;
+package org.hypertrace.agent.filter;
 
 /** Indicates that the execution should be blocked. */
-class ExecutionBlocked implements BlockingResult {
-  private final String reason;
+class ExecutionBlocked implements FilterResult {
 
-  public ExecutionBlocked(String reason) {
-    this.reason = reason;
-  }
+  static ExecutionBlocked INSTANCE = new ExecutionBlocked();
+
+  private ExecutionBlocked() {}
 
   @Override
   public boolean blockExecution() {
     return true;
   }
-
-  @Override
-  public String getReason() {
-    return reason;
-  }
 }

filter/build.gradle.kts

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package org.hypertrace.agent.blocking;
+package org.hypertrace.agent.filter;
 
-class ExecutionNotBlocked implements BlockingResult {
+class ExecutionNotBlocked implements FilterResult {
 
   static ExecutionNotBlocked INSTANCE = new ExecutionNotBlocked();
 
@@ -26,9 +26,4 @@ private ExecutionNotBlocked() {}
   public boolean blockExecution() {
     return false;
   }
-
-  @Override
-  public String getReason() {
-    return null;
-  }
 }

blocking/src/main/java/org/hypertrace/agent/blocking/ExecutionBlocked.java renamed to filter/src/main/java/org/hypertrace/agent/filter/ExecutionBlocked.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright The Hypertrace Authors
+ *
+ * Licensed 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.hypertrace.agent.filter;
+
+import io.opentelemetry.trace.Span;
+import java.util.Map;
+
+/**
+ * {@link FilterEvaluator} evaluates given request/RPC and the result is used to block further
+ * processing of the request.
+ */
+public interface FilterEvaluator {
+
+  /**
+   * Evaluate the execution.
+   *
+   * @param headers are used for blocking evaluation.
+   * @return filter result
+   */
+  FilterResult evaluateRequestHeaders(Span span, Map<String, String> headers);
+
+  /**
+   * Evaluate the execution.
+   *
+   * @param body request body
+   * @return filter result
+   */
+  FilterResult evaluateRequestBody(Span span, String body);
+}

blocking/src/main/java/org/hypertrace/agent/blocking/ExecutionNotBlocked.java renamed to filter/src/main/java/org/hypertrace/agent/filter/ExecutionNotBlocked.java

@@ -14,18 +14,19 @@
  * limitations under the License.
  */
 
-package org.hypertrace.agent.blocking;
+package org.hypertrace.agent.filter;
 
-import java.util.Map;
+/** Returns an instance of {@link FilterEvaluator}. */
+public class FilterProvider {
 
-/** Blocking evaluator. */
-public interface BlockingEvaluator {
+  private FilterProvider() {}
 
   /**
-   * Evaluate if execution should be blocked.
+   * Get {@link FilterEvaluator}
    *
-   * @param attributes are used for blocking evaluation.
-   * @return blocking result
+   * @return the filter evaluator.
    */
-  BlockingResult evaluate(Map<String, String> attributes);
+  public static FilterEvaluator getFilterEvaluator() {
+    return MockFilterEvaluator.INSTANCE;
+  }
 }

filter/src/main/java/org/hypertrace/agent/filter/FilterEvaluator.java

@@ -14,22 +14,15 @@
  * limitations under the License.
  */
 
-package org.hypertrace.agent.blocking;
+package org.hypertrace.agent.filter;
 
-/** Result of blocking evaluation from {@link BlockingEvaluator} */
-public interface BlockingResult {
+/** Result of filter evaluation from {@link FilterEvaluator} */
+public interface FilterResult {
 
   /**
-   * Indicates that execution should be blocked.
+   * Indicates whether the execution should be blocked.
    *
-   * @return true if execution should be blocked otherwise false
+   * @return true if execution should be blocked otherwise false.
    */
   boolean blockExecution();
-
-  /**
-   * The reason why execution was blocked.
-   *
-   * @return the reason why execution was blocked.
-   */
-  String getReason();
 }

blocking/src/main/java/org/hypertrace/agent/blocking/BlockingEvaluator.java renamed to filter/src/main/java/org/hypertrace/agent/filter/FilterProvider.java

@@ -14,22 +14,29 @@
  * limitations under the License.
  */
 
-package org.hypertrace.agent.blocking;
+package org.hypertrace.agent.filter;
 
+import io.opentelemetry.trace.Span;
 import java.util.Map;
 
 /** Mock blocking evaluator, blocks execution if an attribute with "block" key is present. */
-class MockBlockingEvaluator implements BlockingEvaluator {
+class MockFilterEvaluator implements FilterEvaluator {
 
-  public static MockBlockingEvaluator INSTANCE = new MockBlockingEvaluator();
+  private MockFilterEvaluator() {}
 
-  private MockBlockingEvaluator() {}
+  public static MockFilterEvaluator INSTANCE = new MockFilterEvaluator();
 
   @Override
-  public BlockingResult evaluate(Map<String, String> attributes) {
-    if (attributes.containsKey("block")) {
-      return new ExecutionBlocked("Header 'block' found");
+  public FilterResult evaluateRequestHeaders(Span span, Map<String, String> headers) {
+    if (headers.containsKey("block")) {
+      span.setAttribute("hypertrace.mock.filter.result", "true");
+      return ExecutionBlocked.INSTANCE;
     }
     return ExecutionNotBlocked.INSTANCE;
   }
+
+  @Override
+  public FilterResult evaluateRequestBody(Span span, String body) {
+    return ExecutionNotBlocked.INSTANCE;
+  }
 }

blocking/src/main/java/org/hypertrace/agent/blocking/BlockingResult.java renamed to filter/src/main/java/org/hypertrace/agent/filter/FilterResult.java

@@ -13,7 +13,7 @@ subprojects {
         implementation("io.opentelemetry.javaagent:opentelemetry-javaagent-tooling:0.9.0")
         implementation("io.opentelemetry.instrumentation:opentelemetry-instrumentation-api:0.9.0")
         implementation(project(":javaagent-core"))
-        implementation(project(":blocking"))
+        implementation(project(":filter"))
     }
 
     // This ensures to build jars for all dependencies in instrumentation module for ByteBuddy