generalize file to Constants.java, put more constants into it

stanley-cheung · stanley-cheung · commit ac902270ac2d · 2024-03-28T21:00:12.000Z
diff --git a/build.gradle b/build.gradle
@@ -72,17 +72,17 @@ ext {
     buildRevision = versioning.info.commit
 }
 
-task createVersionsFile(type: Copy) {
-    from("grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Versions.java.template") {
-        rename "Versions.java.template", "Versions.java"
+task createConstantsFile(type: Copy) {
+    from("grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Constants.java.template") {
+        rename "Constants.java.template", "Constants.java"
         filter(org.apache.tools.ant.filters.ReplaceTokens, tokens: [
             versionStringPlaceholder: "v${projectVersion}".toString(),
         ])
     }
     into "grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util"
 }
 clean.doFirst {
-    delete "grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Versions.java"
+    delete "grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Constants.java"
 }
 
 allprojects {
@@ -147,11 +147,11 @@ allprojects {
             include 'LICENSE'
             into 'META-INF'
         }
-        dependsOn createVersionsFile
+        dependsOn createConstantsFile
     }
 
-    compileJava.dependsOn createVersionsFile
-    spotlessJava.dependsOn createVersionsFile
+    compileJava.dependsOn createConstantsFile
+    spotlessJava.dependsOn createConstantsFile
 
     // Generate MANIFEST.MF
     jar {
@@ -242,7 +242,7 @@ allprojects { project ->
         }
 
         delombok {
-            dependsOn createVersionsFile
+            dependsOn createConstantsFile
         }
 
         // Javadoc Task
diff --git a/grpc-client-spring-boot-starter/src/main/java/net/devh/boot/grpc/client/metrics/MetricsClientStreamTracers.java b/grpc-client-spring-boot-starter/src/main/java/net/devh/boot/grpc/client/metrics/MetricsClientStreamTracers.java
@@ -35,7 +35,7 @@
 import io.grpc.Status;
 import io.grpc.Status.Code;
 import io.micrometer.core.instrument.Tags;
-import net.devh.boot.grpc.common.util.Versions;
+import net.devh.boot.grpc.common.util.Constants;
 
 /**
  * Provides factories for {@link io.grpc.StreamTracer} that records metrics.
@@ -130,8 +130,8 @@ void recordFinishedAttempt() {
             Tags attemptMetricTags =
                     Tags.of("grpc.method", fullMethodName,
                             "grpc.status", statusCode.toString(),
-                            "instrumentation_source", "grpc-spring",
-                            "instrumentation_version", Versions.PROJECT_VERSION);
+                            "instrumentation_source", Constants.INSTRUMENTATION_SOURCE_TAG_VALUE,
+                            "instrumentation_version", Constants.PROJECT_VERSION);
             this.metricsClientMeters.getClientAttemptDuration()
                     .withTags(attemptMetricTags)
                     .record(attemptNanos, TimeUnit.NANOSECONDS);
@@ -173,8 +173,8 @@ static final class CallAttemptsTracerFactory extends ClientStreamTracer.Factory
             // Record here in case newClientStreamTracer() would never be called.
             this.metricsClientMeters.getAttemptCounter()
                     .withTags(Tags.of("grpc.method", fullMethodName,
-                                      "instrumentation_source", "grpc-spring",
-                                      "instrumentation_version", Versions.PROJECT_VERSION))
+                                      "instrumentation_source", Constants.INSTRUMENTATION_SOURCE_TAG_VALUE,
+                                      "instrumentation_version", Constants.PROJECT_VERSION))
                     .increment();
         }
 
@@ -195,8 +195,8 @@ public ClientStreamTracer newClientStreamTracer(StreamInfo info, Metadata metada
             if (attemptsPerCall.get() > 0) {
                 this.metricsClientMeters.getAttemptCounter()
                         .withTags((Tags.of("grpc.method", fullMethodName,
-                                           "instrumentation_source", "grpc-spring",
-                                           "instrumentation_version", Versions.PROJECT_VERSION)))
+                                           "instrumentation_source", Constants.INSTRUMENTATION_SOURCE_TAG_VALUE,
+                                           "instrumentation_version", Constants.PROJECT_VERSION)))
                         .increment();
             }
             if (!info.isTransparentRetry()) {
@@ -258,8 +258,8 @@ void recordFinishedCall() {
             Tags clientCallMetricTags =
                     Tags.of("grpc.method", this.fullMethodName,
                             "grpc.status", status.getCode().toString(),
-                            "instrumentation_source", "grpc-spring",
-                            "instrumentation_version", Versions.PROJECT_VERSION);
+                            "instrumentation_source", Constants.INSTRUMENTATION_SOURCE_TAG_VALUE,
+                            "instrumentation_version", Constants.PROJECT_VERSION);
             this.metricsClientMeters.getClientCallDuration()
                     .withTags(clientCallMetricTags)
                     .record(callLatencyNanos, TimeUnit.NANOSECONDS);
diff --git a/grpc-client-spring-boot-starter/src/test/java/net/devh/boot/grpc/client/metrics/MetricsClientStreamTracersTest.java b/grpc-client-spring-boot-starter/src/test/java/net/devh/boot/grpc/client/metrics/MetricsClientStreamTracersTest.java
@@ -37,7 +37,7 @@
 import io.micrometer.core.instrument.distribution.HistogramSnapshot;
 import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
 import net.devh.boot.grpc.client.metrics.MetricsClientStreamTracers.CallAttemptsTracerFactory;
-import net.devh.boot.grpc.common.util.Versions;
+import net.devh.boot.grpc.common.util.Constants;
 
 /**
  * Tests for {@link MetricsClientStreamTracers}.
@@ -63,9 +63,9 @@ class MetricsClientStreamTracersTest {
     private static final String GRPC_STATUS_TAG_KEY = "grpc.status";
     private static final String FULL_METHOD_NAME = "package1.service1/method1";
     private static final String INSTRUMENTATION_SOURCE_TAG_KEY = "instrumentation_source";
-    private static final String INSTRUMENTATION_SOURCE_TAG_VALUE = "grpc-spring";
+    private static final String INSTRUMENTATION_SOURCE_TAG_VALUE = Constants.INSTRUMENTATION_SOURCE_TAG_VALUE;
     private static final String INSTRUMENTATION_VERSION_TAG_KEY = "instrumentation_version";
-    private static final String INSTRUMENTATION_VERSION_TAG_VALUE = Versions.PROJECT_VERSION;
+    private static final String INSTRUMENTATION_VERSION_TAG_VALUE = Constants.PROJECT_VERSION;
 
     private static class StringInputStream extends InputStream {
         final String string;
diff --git a/grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Constants.java.template b/grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Constants.java.template
@@ -17,15 +17,22 @@
 package net.devh.boot.grpc.common.util;
 
 /**
- * Class that contains version strings
+ * Class that contains shared constants
  */
-public final class Versions {
+public final class Constants {
 
     /**
-     * A constant that defines, the current version of the library.
+     * A constant that defines the current version of the library.
      */
     public static final String PROJECT_VERSION = "@versionStringPlaceholder@";
 
-    private Versions() {}
+
+    /**
+     * A constant that defines the instrumentation_source metric tag value
+     */
+	public static final String INSTRUMENTATION_SOURCE_TAG_VALUE = "grpc-spring";
+
+
+    private Constants() {}
 
 }
diff --git a/grpc-server-spring-boot-starter/src/main/java/net/devh/boot/grpc/server/metrics/MetricsServerStreamTracers.java b/grpc-server-spring-boot-starter/src/main/java/net/devh/boot/grpc/server/metrics/MetricsServerStreamTracers.java
@@ -30,7 +30,7 @@
 import io.grpc.Status;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tags;
-import net.devh.boot.grpc.common.util.Versions;
+import net.devh.boot.grpc.common.util.Constants;
 
 /**
  * Provides factories for {@link io.grpc.StreamTracer} that records metrics.
@@ -102,8 +102,8 @@ private static final class ServerTracer extends ServerStreamTracer {
         public void serverCallStarted(ServerCallInfo<?, ?> callInfo) {
             this.metricsServerMeters.getServerCallCounter()
                     .withTags(Tags.of("grpc.method", this.fullMethodName,
-                                      "instrumentation_source", "grpc-spring",
-                                      "instrumentation_version", Versions.PROJECT_VERSION))
+                                      "instrumentation_source", Constants.INSTRUMENTATION_SOURCE_TAG_VALUE,
+                                      "instrumentation_version", Constants.PROJECT_VERSION))
                     .increment();
         }
 
@@ -127,8 +127,8 @@ public void streamClosed(Status status) {
             Tags serverMetricTags =
                     Tags.of("grpc.method", this.fullMethodName,
                             "grpc.status", status.getCode().toString(),
-                            "instrumentation_source", "grpc-spring",
-                            "instrumentation_version", Versions.PROJECT_VERSION);
+                            "instrumentation_source", Constants.INSTRUMENTATION_SOURCE_TAG_VALUE,
+                            "instrumentation_version", Constants.PROJECT_VERSION);
             this.metricsServerMeters.getServerCallDuration()
                     .withTags(serverMetricTags)
                     .record(callLatencyNanos, TimeUnit.NANOSECONDS);
diff --git a/grpc-server-spring-boot-starter/src/test/java/net/devh/boot/grpc/server/metrics/MetricsServerStreamTracersTest.java b/grpc-server-spring-boot-starter/src/test/java/net/devh/boot/grpc/server/metrics/MetricsServerStreamTracersTest.java
@@ -38,7 +38,7 @@
 import io.micrometer.core.instrument.distribution.CountAtBucket;
 import io.micrometer.core.instrument.distribution.HistogramSnapshot;
 import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
-import net.devh.boot.grpc.common.util.Versions;
+import net.devh.boot.grpc.common.util.Constants;
 
 /**
  * Tests for {@link MetricsServerStreamTracers}.
@@ -56,9 +56,9 @@ class MetricsServerStreamTracersTest {
     private static final String GRPC_METHOD_TAG_KEY = "grpc.method";
     private static final String GRPC_STATUS_TAG_KEY = "grpc.status";
     private static final String INSTRUMENTATION_SOURCE_TAG_KEY = "instrumentation_source";
-    private static final String INSTRUMENTATION_SOURCE_TAG_VALUE = "grpc-spring";
+    private static final String INSTRUMENTATION_SOURCE_TAG_VALUE = Constants.INSTRUMENTATION_SOURCE_TAG_VALUE;
     private static final String INSTRUMENTATION_VERSION_TAG_KEY = "instrumentation_version";
-    private static final String INSTRUMENTATION_VERSION_TAG_VALUE = Versions.PROJECT_VERSION;
+    private static final String INSTRUMENTATION_VERSION_TAG_VALUE = Constants.PROJECT_VERSION;
 
 
     private static class StringInputStream extends InputStream {

Original file line number	Diff line number	Diff line change
`@@ -72,17 +72,17 @@ ext {`
`72`	`72`	`buildRevision = versioning.info.commit`
`73`	`73`	`}`
`74`	`74`
`75`		`-task createVersionsFile(type: Copy) {`
`76`		`- from("grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Versions.java.template") {`
`77`		`- rename "Versions.java.template", "Versions.java"`
	`75`	`+task createConstantsFile(type: Copy) {`
	`76`	`+ from("grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Constants.java.template") {`
	`77`	`+ rename "Constants.java.template", "Constants.java"`
`78`	`78`	`filter(org.apache.tools.ant.filters.ReplaceTokens, tokens: [`
`79`	`79`	`versionStringPlaceholder: "v${projectVersion}".toString(),`
`80`	`80`	`])`
`81`	`81`	`}`
`82`	`82`	`into "grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util"`
`83`	`83`	`}`
`84`	`84`	`clean.doFirst {`
`85`		`- delete "grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Versions.java"`
	`85`	`+ delete "grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/Constants.java"`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`allprojects {`
`@@ -147,11 +147,11 @@ allprojects {`
`147`	`147`	`include 'LICENSE'`
`148`	`148`	`into 'META-INF'`
`149`	`149`	`}`
`150`		`- dependsOn createVersionsFile`
	`150`	`+ dependsOn createConstantsFile`
`151`	`151`	`}`
`152`	`152`
`153`		`- compileJava.dependsOn createVersionsFile`
`154`		`- spotlessJava.dependsOn createVersionsFile`
	`153`	`+ compileJava.dependsOn createConstantsFile`
	`154`	`+ spotlessJava.dependsOn createConstantsFile`
`155`	`155`
`156`	`156`	`// Generate MANIFEST.MF`
`157`	`157`	`jar {`
`@@ -242,7 +242,7 @@ allprojects { project ->`
`242`	`242`	`}`
`243`	`243`
`244`	`244`	`delombok {`
`245`		`- dependsOn createVersionsFile`
	`245`	`+ dependsOn createConstantsFile`
`246`	`246`	`}`
`247`	`247`
`248`	`248`	`// Javadoc Task`