refactor: use service factory abstraction for container (#129)

* refactor: use service factory abstraction for container

* chore: remove snapshots after publish

* fix: update config resolution for integration tests

* chore: update snyk ignore for unpatched dep

Author: aaron-steinfeld

.snyk

@@ -5,5 +5,5 @@ ignore:
   SNYK-JAVA-IONETTY-1042268:
     - '*':
         reason: No replacement available
-        expires: 2022-05-30T00:00:00.000Z
+        expires: 2022-08-31T00:00:00.000Z
 patch: {}

attribute-service-factory/build.gradle.kts

@@ -0,0 +1,12 @@
+plugins {
+  `java-library`
+}
+
+dependencies {
+  api("org.hypertrace.core.serviceframework:platform-grpc-service-framework:0.1.35")
+
+  // Only required because AttributeService constructor test overload uses a doc store API
+  compileOnly("org.hypertrace.core.documentstore:document-store:0.6.15")
+
+  implementation(project(":attribute-service-impl"))
+}

attribute-service-factory/src/main/java/org/hypertrace/core/attribute/service/AttributeServiceFactory.java

@@ -0,0 +1,16 @@
+package org.hypertrace.core.attribute.service;
+
+import java.util.List;
+import org.hypertrace.core.serviceframework.grpc.GrpcPlatformService;
+import org.hypertrace.core.serviceframework.grpc.GrpcPlatformServiceFactory;
+import org.hypertrace.core.serviceframework.grpc.GrpcServiceContainerEnvironment;
+
+public class AttributeServiceFactory implements GrpcPlatformServiceFactory {
+  private static final String SERVICE_NAME = "attribute-service";
+
+  @Override
+  public List<GrpcPlatformService> buildServices(GrpcServiceContainerEnvironment environment) {
+    return List.of(
+        new GrpcPlatformService(new AttributeServiceImpl(environment.getConfig(SERVICE_NAME))));
+  }
+}

attribute-service/build.gradle.kts

@@ -54,30 +54,16 @@ tasks.integrationTest {
 }
 
 dependencies {
-  implementation(project(":attribute-service-impl"))
-
-  implementation("org.hypertrace.core.serviceframework:platform-service-framework:0.1.33")
-  implementation("org.hypertrace.core.grpcutils:grpc-server-utils:0.7.2")
-  implementation("org.hypertrace.core.grpcutils:grpc-client-utils:0.7.2")
-  implementation("org.hypertrace.core.documentstore:document-store:0.6.15")
-  implementation("io.grpc:grpc-services")
-
-  // Logging
-  implementation("org.slf4j:slf4j-api:1.7.32")
+  implementation(project(":attribute-service-factory"))
+  implementation("org.hypertrace.core.serviceframework:platform-grpc-service-framework:0.1.35")
   runtimeOnly("org.apache.logging.log4j:log4j-slf4j-impl:2.17.1")
   runtimeOnly("io.grpc:grpc-netty")
-  constraints {
-    runtimeOnly("io.netty:netty-codec-http2:4.1.77.Final")
-  }
-
-  // Config
-  implementation("com.typesafe:config:1.4.1")
 
   // Integration test dependencies
   integrationTestImplementation("org.junit.jupiter:junit-jupiter:5.8.2")
   integrationTestImplementation("com.google.guava:guava:31.1-jre")
   integrationTestImplementation(project(":attribute-service-client"))
-  integrationTestImplementation("org.hypertrace.core.serviceframework:integrationtest-service-framework:0.1.33")
+  integrationTestImplementation("org.hypertrace.core.serviceframework:integrationtest-service-framework:0.1.35")
 }
 
 application {
@@ -86,7 +72,7 @@ application {
 
 // Config for gw run to be able to run this locally. Just execute gw run here on Intellij or on the console.
 tasks.run<JavaExec> {
-  jvmArgs = listOf("-Dbootstrap.config.uri=file:$projectDir/src/main/resources/configs", "-Dservice.name=${project.name}")
+  jvmArgs = listOf("-Dservice.name=${project.name}")
 }
 
 tasks.jacocoIntegrationTestReport {

attribute-service/src/main/java/org/hypertrace/core/attribute/service/AttributeServiceEntry.java

@@ -1,94 +1,23 @@
 package org.hypertrace.core.attribute.service;
 
-import static java.util.concurrent.TimeUnit.MINUTES;
-import static java.util.concurrent.TimeUnit.SECONDS;
-
-import io.grpc.Deadline;
-import io.grpc.Server;
-import io.grpc.ServerBuilder;
-import io.grpc.health.v1.HealthCheckRequest;
-import io.grpc.health.v1.HealthCheckResponse.ServingStatus;
-import io.grpc.health.v1.HealthGrpc;
-import io.grpc.health.v1.HealthGrpc.HealthBlockingStub;
-import io.grpc.protobuf.services.HealthStatusManager;
-import java.io.IOException;
-import org.hypertrace.core.grpcutils.client.GrpcChannelRegistry;
-import org.hypertrace.core.grpcutils.server.InterceptorUtil;
-import org.hypertrace.core.grpcutils.server.ServerManagementUtil;
-import org.hypertrace.core.serviceframework.PlatformService;
 import org.hypertrace.core.serviceframework.config.ConfigClient;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.hypertrace.core.serviceframework.grpc.GrpcPlatformServiceFactory;
+import org.hypertrace.core.serviceframework.grpc.StandAloneGrpcPlatformServiceContainer;
 
-public class AttributeServiceEntry extends PlatformService {
-  private static final String SERVICE_NAME_CONFIG = "service.name";
-  private static final Logger LOGGER = LoggerFactory.getLogger(AttributeServiceEntry.class);
+public class AttributeServiceEntry extends StandAloneGrpcPlatformServiceContainer {
   static final String PORT_PATH = "attributes.type.server.port";
 
-  private String serviceName;
-  private Server server;
-  private HealthBlockingStub healthClient;
-  private final HealthStatusManager healthStatusManager = new HealthStatusManager();
-  private final GrpcChannelRegistry grpcChannelRegistry = new GrpcChannelRegistry();
-
   public AttributeServiceEntry(ConfigClient configClient) {
     super(configClient);
   }
 
   @Override
-  protected void doInit() {
-    serviceName = getAppConfig().getString(SERVICE_NAME_CONFIG);
-    int port = getAppConfig().getInt(PORT_PATH);
-    server =
-        ServerBuilder.forPort(port)
-            .addService(InterceptorUtil.wrapInterceptors(new AttributeServiceImpl(getAppConfig())))
-            .addService(healthStatusManager.getHealthService())
-            .build();
-    healthClient =
-        HealthGrpc.newBlockingStub(this.grpcChannelRegistry.forPlaintextAddress("localhost", port));
-  }
-
-  @Override
-  protected void doStart() {
-    try {
-      try {
-        server.start();
-      } catch (IOException e) {
-        LOGGER.error("Unable to start server");
-        throw new RuntimeException(e);
-      }
-      server.awaitTermination();
-    } catch (InterruptedException e) {
-      Thread.currentThread().interrupt();
-      throw new RuntimeException(e);
-    }
-  }
-
-  @Override
-  protected void doStop() {
-    healthStatusManager.enterTerminalState();
-    grpcChannelRegistry.shutdown(Deadline.after(10, SECONDS));
-    ServerManagementUtil.shutdownServer(
-        this.server, this.getServiceName(), Deadline.after(1, MINUTES));
-  }
-
-  @Override
-  public boolean healthCheck() {
-    try {
-      // Intentionally using overly generous deadline to respect health check timeout from config
-      return healthClient
-          .withDeadlineAfter(10, SECONDS)
-          .check(HealthCheckRequest.getDefaultInstance())
-          .getStatus()
-          .equals(ServingStatus.SERVING);
-    } catch (Exception e) {
-      LOGGER.debug("health check error", e);
-      return false;
-    }
+  public GrpcPlatformServiceFactory getServiceFactory() {
+    return new AttributeServiceFactory();
   }
 
   @Override
-  public String getServiceName() {
-    return serviceName;
+  protected int getServicePort() {
+    return getAppConfig().getInt(PORT_PATH);
   }
 }

settings.gradle.kts

@@ -16,6 +16,7 @@ include(":attribute-service-api")
 include(":attribute-service-client")
 include(":attribute-service-impl")
 include(":attribute-service")
+include(":attribute-service-factory")
 include(":attribute-service-tenant-api")
 include(":caching-attribute-service-client")
 include(":attribute-projection-functions")