chore: deprecate client utils (#22)

* chore: deprecate client utils

* fix: stray e

* ci: add snyk argument

Author: aaron-steinfeld

.github/workflows/pr-build.yml

@@ -50,6 +50,6 @@ jobs:
       - name: Setup snyk
         uses: snyk/actions/setup@0.3.0
       - name: Snyk test
-        run: snyk test --all-sub-projects --org=hypertrace --severity-threshold=low --policy-path=.snyk --configuration-matching='^runtimeClasspath$'
+        run: snyk test --all-sub-projects --org=hypertrace --severity-threshold=low --policy-path=.snyk --configuration-matching='^runtimeClasspath$' --remote-repo-url='https://github.com/hypertrace/java-grpc-utils.git'
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

grpc-client-utils/src/main/java/org/hypertrace/core/grpcutils/client/GrpcClientRequestContextUtil.java

@@ -8,20 +8,27 @@
 
 /**
  * Utility class which has methods to easily read and propagate headers from GRPC request context.
+ *
+ * @deprecated This class has been replaced by {@link RequestContext} which can run code directly
+ *     through its {@link RequestContext#call(Callable)} and {@link RequestContext#run(Runnable)}
+ *     methods.
  */
+@Deprecated
 public class GrpcClientRequestContextUtil {
   /**
-   * Utility method to execute the given {@link Callable} in the context of given tenant by
-   * setting the tenant id in the request headers.
+   * Utility method to execute the given {@link Callable} in the context of given tenant by setting
+   * the tenant id in the request headers.
    *
    * @throws RuntimeException if there was an issue in executing the request.
    */
   public static <V> V executeInTenantContext(String tenantId, Callable<V> c) {
-    return executeWithHeadersContext(Map.of(RequestContextConstants.TENANT_ID_HEADER_KEY, tenantId), c);
+    return executeWithHeadersContext(
+        Map.of(RequestContextConstants.TENANT_ID_HEADER_KEY, tenantId), c);
   }
 
   /**
-   * Same as the method above but this takes a Runnable instead of Callable. Useful when using async grpc client stubs.
+   * Same as the method above but this takes a Runnable instead of Callable. Useful when using async
+   * grpc client stubs.
    *
    * @param tenantId
    * @param r
@@ -36,19 +43,22 @@ public static void executeInTenantContext(String tenantId, Runnable r) {
    *
    * @throws RuntimeException if there was an issue in executing the request.
    */
-  public static <V> V executeWithHeadersContext(@Nonnull Map<String, String> headers, @Nonnull Callable<V> c) {
+  public static <V> V executeWithHeadersContext(
+      @Nonnull Map<String, String> headers, @Nonnull Callable<V> c) {
     RequestContext requestContext = new RequestContext();
     headers.forEach(requestContext::add);
     return requestContext.call(c);
   }
 
   /**
-   * Same as the method above but this takes a Runnable instead of Callable. Useful when using async grpc client stubs.
+   * Same as the method above but this takes a Runnable instead of Callable. Useful when using async
+   * grpc client stubs.
    *
    * @param headers
    * @param r
    */
-  public static void executeWithHeadersContext(@Nonnull Map<String, String> headers, @Nonnull Runnable r) {
+  public static void executeWithHeadersContext(
+      @Nonnull Map<String, String> headers, @Nonnull Runnable r) {
     RequestContext requestContext = new RequestContext();
     headers.forEach(requestContext::add);
     requestContext.run(r);