#5 - Deprecate InsightClient.create() in favour of InsightClient.buil…

…der()
ebean-orm · Feb 8, 2023 · b84217f · b84217f
1 parent 7b1d8fa
commit b84217f
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 15 deletions.
diff --git a/client/src/main/java/io/ebean/insight/InsightClient.java b/client/src/main/java/io/ebean/insight/InsightClient.java
@@ -23,6 +23,16 @@
 /**
  * Client that collects Ebean metrics and Avaje metrics for
  * sending to the monitoring service.
+ *
+ * <pre>{@code
+ *
+ *   final InsightClient client = InsightClient.builder()
+ *       .appName("myapp")
+ *       .environment("dev")
+ *       .key("YeahNah")
+ *       .build();
+ *
+ * }</pre>
  */
 public class InsightClient {
 
@@ -51,10 +61,31 @@ public class InsightClient {
   private long collectMicros;
   private long reportMicros;
 
-  public static InsightClient.Builder create() {
+  /**
+   * Create a new builder for InsightClient.
+   *
+   * <pre>{@code
+   *
+   *   final InsightClient client = InsightClient.builder()
+   *       .appName("myapp")
+   *       .environment("dev")
+   *       .key("YeahNah")
+   *       .build();
+   *
+   * }</pre>
+   */
+  public static InsightClient.Builder builder() {
     return new InsightClient.Builder();
   }
 
+  /**
+   * Deprecated - migrate to {@link #builder()}
+   */
+  @Deprecated
+  public static InsightClient.Builder create() {
+    return builder();
+  }
+
   private InsightClient(Builder builder) {
     this.enabled = builder.enabled();
     this.ingestUri = URI.create(builder.url + "/api/ingest/metrics");

diff --git a/client/src/test/java/io/ebean/insight/InsightClientTest.java b/client/src/test/java/io/ebean/insight/InsightClientTest.java
@@ -20,7 +20,7 @@ void create() throws InterruptedException {
       .registerJvmMetrics()
       .registerLogbackMetrics();
 
-    final InsightClient client = InsightClient.create()
+    final InsightClient client = InsightClient.builder()
       //.url("http://localhost:8090")
       .periodSecs(5)
       .appName("test")
@@ -44,7 +44,7 @@ void pingFailed_expect_notStarted() throws InterruptedException {
     MetricManager.jvmMetrics()
       .registerJvmMetrics();
 
-    final InsightClient client = InsightClient.create()
+    final InsightClient client = InsightClient.builder()
       .url("http://doesNotExist:8090")
       .periodSecs(1)
       .appName("test")
@@ -65,36 +65,36 @@ void pingFailed_expect_notStarted() throws InterruptedException {
   void notEnabled_when_keyNotValid() {
 
     // not valid keys
-    assertThat(InsightClient.create().key(null).enabled()).isFalse();
-    assertThat(InsightClient.create().key("").enabled()).isFalse();
-    assertThat(InsightClient.create().key("  ").enabled()).isFalse();
-    assertThat(InsightClient.create().key("none").enabled()).isFalse();
+    assertThat(InsightClient.builder().key(null).enabled()).isFalse();
+    assertThat(InsightClient.builder().key("").enabled()).isFalse();
+    assertThat(InsightClient.builder().key("  ").enabled()).isFalse();
+    assertThat(InsightClient.builder().key("none").enabled()).isFalse();
 
     // valid
-    assertThat(InsightClient.create().key("foo").enabled()).isTrue();
+    assertThat(InsightClient.builder().key("foo").enabled()).isTrue();
   }
 
   @Test
   void notEnabled_when_systemPropertySet() {
-    assertThat(InsightClient.create().key("foo").enabled()).isTrue();
+    assertThat(InsightClient.builder().key("foo").enabled()).isTrue();
 
     Config.setProperty("ebean.insight.enabled", "false");
-    assertThat(InsightClient.create().key("foo").enabled()).isFalse();
+    assertThat(InsightClient.builder().key("foo").enabled()).isFalse();
 
     Config.setProperty("ebean.insight.enabled", "true");
-    assertThat(InsightClient.create().key("foo").enabled()).isTrue();
+    assertThat(InsightClient.builder().key("foo").enabled()).isTrue();
   }
 
   @Test
   void enabled() {
-    assertThat(InsightClient.create().key("foo").enabled(true).enabled()).isTrue();
-    assertThat(InsightClient.create().key("foo").enabled(false).enabled()).isFalse();
-    assertThat(InsightClient.create().key("foo").enabled()).isTrue();
+    assertThat(InsightClient.builder().key("foo").enabled(true).enabled()).isTrue();
+    assertThat(InsightClient.builder().key("foo").enabled(false).enabled()).isFalse();
+    assertThat(InsightClient.builder().key("foo").enabled()).isTrue();
   }
 
   @Test
   void buildJsonContent() {
-    InsightClient client = InsightClient.create()
+    InsightClient client = InsightClient.builder()
       .collectEbeanMetrics(false)
       .collectAvajeMetrics(false)
       .build();