Merge branch 'master' into deprecate-http

Author: johnewart

.github/workflows/build.yml

@@ -25,11 +25,11 @@ jobs:
       GOARCH: amd64
       GOPROXY: https://proxy.golang.org
       JDK_VER: ${{ matrix.java }}
-      DAPR_CLI_VER: 1.8.0-rc.1
-      DAPR_RUNTIME_VER: 1.8.0-rc.3
+      DAPR_CLI_VER: 1.8.1
+      DAPR_RUNTIME_VER: 1.8.4
       DAPR_INSTALL_URL: https://raw.githubusercontent.com/dapr/cli/v1.8.0-rc.1/install/install.sh
       DAPR_CLI_REF:
-      DAPR_REF: 683a436ff1367e4ff2d27da2d79069c04ec2c46d
+      DAPR_REF: 0e34de1086c697d7d74ac2af14ddb11f9346b57e
     steps:
     - uses: actions/checkout@v3
     - name: Set up OpenJDK ${{ env.JDK_VER }}

.github/workflows/validate.yml

@@ -36,11 +36,11 @@ jobs:
       GOARCH: amd64
       GOPROXY: https://proxy.golang.org
       JDK_VER: ${{ matrix.java }}
-      DAPR_CLI_VER: 1.8.0-rc.1
-      DAPR_RUNTIME_VER: 1.8.0-rc.3
+      DAPR_CLI_VER: 1.8.1
+      DAPR_RUNTIME_VER: 1.8.4
       DAPR_INSTALL_URL: https://raw.githubusercontent.com/dapr/cli/v1.8.0-rc.1/install/install.sh
       DAPR_CLI_REF:
-      DAPR_REF: 683a436ff1367e4ff2d27da2d79069c04ec2c46d
+      DAPR_REF: 0e34de1086c697d7d74ac2af14ddb11f9346b57e
     steps:
       - uses: actions/checkout@v3
       - name: Set up OpenJDK ${{ env.JDK_VER }}
@@ -145,10 +145,14 @@ jobs:
         working-directory: ./examples
         run: |
           mm.py ./src/main/java/io/dapr/examples/unittesting/README.md
-      - name: Validate Configuration API example
+      - name: Validate Configuration gRPC API example
         working-directory: ./examples
         run: |
             mm.py ./src/main/java/io/dapr/examples/configuration/grpc/README.md
+      - name: Validate Configuration HTTP API example
+        working-directory: ./examples
+        run: |
+            mm.py ./src/main/java/io/dapr/examples/configuration/http/README.md
       - name: Validate query state HTTP example
         working-directory: ./examples
         run: |

examples/src/main/java/io/dapr/examples/configuration/grpc/ConfigurationClient.java

@@ -18,13 +18,16 @@
 import io.dapr.client.domain.ConfigurationItem;
 import io.dapr.client.domain.GetConfigurationRequest;
 import io.dapr.client.domain.SubscribeConfigurationRequest;
+import io.dapr.client.domain.SubscribeConfigurationResponse;
+import io.dapr.client.domain.UnsubscribeConfigurationResponse;
 import reactor.core.Disposable;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicReference;
@@ -43,41 +46,8 @@ public class ConfigurationClient {
   public static void main(String[] args) throws Exception {
     try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient()) {
       System.out.println("Using preview client...");
-      getConfigurationForaSingleKey(client);
-      getConfigurationsUsingVarargs(client);
       getConfigurations(client);
-      subscribeConfigurationRequestWithSubscribe(client);
-    }
-  }
-
-  /**
-   * Gets configuration for a single key.
-   *
-   * @param client DaprPreviewClient object
-   */
-  public static void getConfigurationForaSingleKey(DaprPreviewClient client) {
-    System.out.println("*******trying to retrieve configuration given a single key********");
-    try {
-      Mono<ConfigurationItem> item = client.getConfiguration(CONFIG_STORE_NAME, keys.get(0));
-      System.out.println("Value ->" + item.block().getValue() + " key ->" + item.block().getKey());
-    } catch (Exception ex) {
-      System.out.println(ex.getMessage());
-    }
-  }
-
-  /**
-   * Gets configurations for varibale no. of arguments.
-   *
-   * @param client DaprPreviewClient object
-   */
-  public static void getConfigurationsUsingVarargs(DaprPreviewClient client) {
-    System.out.println("*******trying to retrieve configurations for a variable no. of keys********");
-    try {
-      Mono<Map<String, ConfigurationItem>> items =
-          client.getConfiguration(CONFIG_STORE_NAME, "myconfig1", "myconfig3");
-      items.block().forEach((k,v) -> print(v, k));
-    } catch (Exception ex) {
-      System.out.println(ex.getMessage());
+      subscribeConfigurationRequest(client);
     }
   }
 
@@ -106,36 +76,25 @@ public static void getConfigurations(DaprPreviewClient client) {
    *
    * @param client DaprPreviewClient object
    */
-  public static void subscribeConfigurationRequestWithSubscribe(DaprPreviewClient client) {
-    System.out.println("*****Subscribing to keys using subscribe method: " + keys.toString() + " *****");
-    AtomicReference<Disposable> disposableAtomicReference = new AtomicReference<>();
-    SubscribeConfigurationRequest req = new SubscribeConfigurationRequest(CONFIG_STORE_NAME, keys);
+  public static void subscribeConfigurationRequest(DaprPreviewClient client) {
+    System.out.println("Subscribing to key: myconfig1");
+    SubscribeConfigurationRequest req = new SubscribeConfigurationRequest(
+        CONFIG_STORE_NAME, Collections.singletonList("myconfig1"));
+    Flux<SubscribeConfigurationResponse> outFlux = client.subscribeConfiguration(req);
     Runnable subscribeTask = () -> {
-      Flux<Map<String, ConfigurationItem>> outFlux = client.subscribeToConfiguration(req);
-      disposableAtomicReference.set(outFlux
-          .subscribe(
-              cis -> cis.forEach((k,v) -> print(v, k))
-          ));
+      outFlux.subscribe(cis -> {
+        System.out.println("subscription ID : " + cis.getSubscriptionId());
+        System.out.println("subscribing to key myconfig1 is successful");
+      });
     };
     new Thread(subscribeTask).start();
+    // To ensure main thread does not die before outFlux subscribe gets called
+    inducingSleepTime(5000);
+  }
+
+  private static void inducingSleepTime(int timeInMillis) {
     try {
-      // To ensure that subscribeThread gets scheduled
-      Thread.sleep(0);
-    } catch (InterruptedException e) {
-      e.printStackTrace();
-    }
-    Runnable updateKeys = () -> {
-      int i = 1;
-      while (i <= 3) {
-        executeDockerCommand(i);
-        i++;
-      }
-    };
-    new Thread(updateKeys).start();
-    try {
-      // To ensure main thread does not die before outFlux subscribe gets called
-      Thread.sleep(10000);
-      disposableAtomicReference.get().dispose();
+      Thread.sleep(timeInMillis);
     } catch (InterruptedException e) {
       e.printStackTrace();
     }
@@ -144,22 +103,4 @@ public static void subscribeConfigurationRequestWithSubscribe(DaprPreviewClient
   private static void print(ConfigurationItem item, String key) {
     System.out.println(item.getValue() + " : key ->" + key);
   }
-
-  private static void executeDockerCommand(int postfix) {
-    String[] command = new String[] {
-        "docker", "exec", "dapr_redis", "redis-cli",
-        "SET",
-        "myconfig" + postfix, "update_myconfigvalue" + postfix + "||2"
-    };
-    ProcessBuilder processBuilder = new ProcessBuilder(command);
-    Process process = null;
-    try {
-      process = processBuilder.start();
-      process.waitFor();
-    } catch (IOException e) {
-      e.printStackTrace();
-    } catch (InterruptedException e) {
-      e.printStackTrace();
-    }
-  }
 }

examples/src/main/java/io/dapr/examples/configuration/grpc/README.md

@@ -7,7 +7,8 @@ This example provides the different capabilities provided by Dapr Java SDK for C
 
 The java SDK exposes several methods for this -
 * `client.getConfiguration(...)` for getting a configuration for a single/multiple keys.
-* `client.subscribeToConfigurations(...)` for subscribing to a list of keys for any change.
+* `client.subscribeConfiguration(...)` for subscribing to a list of keys for any change.
+* `client.unsubscribeConfiguration(...)` for unsubscribing to changes from subscribed items.
 
 ## Pre-requisites
 
@@ -48,6 +49,81 @@ docker exec dapr_redis redis-cli MSET myconfig1 "val1||1" myconfig2 "val2||1" my
 
 ### Running the example
 
+This example uses the Java SDK Dapr client in order to **Get, Subscribe and Unsubscribe** from configuration items and utilizes `Redis` as configuration store.
+`ConfigurationClient.java` is the example class demonstrating all 3 features.
+Kindly check [DaprPreviewClient.java](https://github.com/dapr/java-sdk/blob/master/sdk/src/main/java/io/dapr/client/DaprPreviewClient.java) for detailed description of the supported APIs.
+
+```java
+public class ConfigurationClient {
+    // ... 
+  /**
+   * Executes various methods to check the different apis.
+   * @param args arguments
+   * @throws Exception throws Exception
+   */
+  public static void main(String[] args) throws Exception {
+    try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient()) {
+      System.out.println("Using preview client...");
+      getConfigurations(client);
+      subscribeConfigurationRequestWithSubscribe(client);
+      unsubscribeConfigurationItems(client);
+    }
+  }
+
+  /**
+   * Gets configurations for a list of keys.
+   *
+   * @param client DaprPreviewClient object
+   */
+  public static void getConfigurations(DaprPreviewClient client) {
+    System.out.println("*******trying to retrieve configurations for a list of keys********");
+    List<String> keys = new ArrayList<>();
+    // ...
+    GetConfigurationRequest req = new GetConfigurationRequest(CONFIG_STORE_NAME, keys);
+    try {
+      Mono<List<ConfigurationItem>> items = client.getConfiguration(req);
+      // ..
+    } catch (Exception ex) {}
+  }
+
+  /**
+   * Subscribe to a list of keys.Optional to above iterator way of retrieving the changes
+   *
+   * @param client DaprPreviewClient object
+   */
+  public static void subscribeConfigurationRequestWithSubscribe(DaprPreviewClient client) {
+    System.out.println("Subscribing to key: myconfig1");
+    // ...
+    Runnable subscribeTask = () -> {
+      Flux<SubscribeConfigurationResponse> outFlux = client.subscribeConfiguration(req);
+      // ...
+    };
+    // ..
+  }
+
+  /**
+   * Unsubscribe using subscription id.
+   *
+   * @param client DaprPreviewClient object
+   */
+  public static void unsubscribeConfigurationItems(DaprPreviewClient client) {
+    System.out.println("Subscribing to key: myconfig2");
+    // ..
+    Runnable subscribeTask = () -> {
+      Flux<SubscribeConfigurationResponse> outFlux = client.subscribeConfiguration(CONFIG_STORE_NAME, "myconfig2");
+      // ...
+    };
+    // ...
+
+    UnsubscribeConfigurationResponse res = client.unsubscribeConfiguration(
+        subscriptionId.get(),
+        CONFIG_STORE_NAME
+    ).block();
+    // ..
+  }
+}
+```
+
 Get into the examples' directory:
 ```sh
 cd examples
@@ -59,21 +135,16 @@ Use the following command to run this example-
 name: Run ConfigurationClient example
 expected_stdout_lines:
   - "== APP == Using preview client..."
-  - "== APP == *******trying to retrieve configuration given a single key********"
-  - "== APP == Value ->val1 key ->myconfig1"
-  - "== APP == *******trying to retrieve configurations for a variable no. of keys********"
-  - "== APP == val1 : key ->myconfig1"
-  - "== APP == val3 : key ->myconfig3"
   - "== APP == *******trying to retrieve configurations for a list of keys********"
   - "== APP == val1 : key ->myconfig1"
   - "== APP == val2 : key ->myconfig2"
   - "== APP == val3 : key ->myconfig3"
-  - "== APP == *****Subscribing to keys using subscribe method: [myconfig1, myconfig3, myconfig2] *****"
-  - "== APP == update_myconfigvalue1 : key ->myconfig1"
-  - "== APP == update_myconfigvalue2 : key ->myconfig2"
-  - "== APP == update_myconfigvalue3 : key ->myconfig3"
+  - "== APP == Subscribing to key: myconfig1"
+  - "== APP == subscription ID :"
+  - "== APP == subscribing to key myconfig1 is successful"
 background: true
-sleep: 5
+output_match_mode: substring
+sleep: 10
 -->
 
 ```bash
@@ -85,19 +156,14 @@ dapr run --components-path ./components/configuration --app-id configgrpc --log-
 ### Sample output
 ```
 == APP == Using preview client...
-== APP == *******trying to retrieve configuration given a single key********
-== APP == Value ->val1 key ->myconfig1
-== APP == *******trying to retrieve configurations for a variable no. of keys********
-== APP == val1 : key ->myconfig1
-== APP == val3 : key ->myconfig3
 == APP == *******trying to retrieve configurations for a list of keys********
 == APP == val1 : key ->myconfig1
 == APP == val2 : key ->myconfig2
 == APP == val3 : key ->myconfig3
-== APP == *****Subscribing to keys using subscribe method: [myconfig1, myconfig3, myconfig2] *****
-== APP == update_myconfigvalue1 : key ->myconfig1
-== APP == update_myconfigvalue2 : key ->myconfig2
-== APP == update_myconfigvalue3 : key ->myconfig3
+== APP == Subscribing to key: myconfig1
+== APP == subscription ID : 82bb8e24-f69d-477a-9126-5ffaf995f498
+== APP == subscribing to key myconfig1 is successful
+
 
 ```
 ### Cleanup