Introduce deterministic random (#178)

slinkydeveloper · web-flow · commit b715d5b2b1a3 · 2023-12-22T16:53:33.000+01:00
* Introduce deterministic random
* Improve random seed generation
* Introduce Restate random in sdk-api
* Add inside side effect guard
* Add test for Random
* Introduce similar RestateRandom to Kotlin API
diff --git a/sdk-api-kotlin/src/main/kotlin/dev/restate/sdk/kotlin/RestateContextImpl.kt b/sdk-api-kotlin/src/main/kotlin/dev/restate/sdk/kotlin/RestateContextImpl.kt
@@ -9,6 +9,7 @@
 package dev.restate.sdk.kotlin
 
 import com.google.protobuf.ByteString
+import dev.restate.sdk.common.InvocationId
 import dev.restate.sdk.common.Serde
 import dev.restate.sdk.common.StateKey
 import dev.restate.sdk.common.TerminalException
@@ -184,4 +185,8 @@ internal class RestateContextImpl internal constructor(private val syscalls: Sys
   override fun awakeableHandle(id: String): AwakeableHandle {
     return AwakeableHandleImpl(syscalls, id)
   }
+
+  override fun random(): RestateRandom {
+    return RestateRandom(InvocationId.current().toRandomSeed(), syscalls)
+  }
 }
diff --git a/sdk-api-kotlin/src/main/kotlin/dev/restate/sdk/kotlin/api.kt b/sdk-api-kotlin/src/main/kotlin/dev/restate/sdk/kotlin/api.kt
@@ -15,6 +15,7 @@ import dev.restate.sdk.common.StateKey
 import dev.restate.sdk.common.syscalls.Syscalls
 import io.grpc.MethodDescriptor
 import java.util.*
+import kotlin.random.Random
 import kotlin.time.Duration
 
 /**
@@ -198,6 +199,33 @@ sealed interface RestateContext {
    * @see Awakeable
    */
   fun awakeableHandle(id: String): AwakeableHandle
+
+  /**
+   * Create a [RestateRandom] instance inherently predictable, seeded on the
+   * [dev.restate.sdk.common.InvocationId], which is not secret.
+   *
+   * This instance is useful to generate identifiers, idempotency keys, and for uniform sampling
+   * from a set of options. If a cryptographically secure value is needed, please generate that
+   * externally using [sideEffect].
+   *
+   * You MUST NOT use this [Random] instance inside a [sideEffect].
+   *
+   * @return the [Random] instance.
+   */
+  fun random(): RestateRandom
+}
+
+class RestateRandom(seed: Long, private val syscalls: Syscalls) : Random() {
+  private val r = Random(seed)
+
+  override fun nextBits(bitCount: Int): Int {
+    check(!syscalls.isInsideSideEffect) { "You can't use RestateRandom inside a side effect!" }
+    return r.nextBits(bitCount)
+  }
+
+  fun nextUUID(): UUID {
+    return UUID(this.nextLong(), this.nextLong())
+  }
 }
 
 /**
diff --git a/sdk-api-kotlin/src/test/kotlin/dev/restate/sdk/kotlin/KotlinCoroutinesTests.kt b/sdk-api-kotlin/src/test/kotlin/dev/restate/sdk/kotlin/KotlinCoroutinesTests.kt
@@ -20,7 +20,7 @@ class KotlinCoroutinesTests : TestRunner() {
     return Stream.of(MockSingleThread.INSTANCE, MockMultiThreaded.INSTANCE)
   }
 
-  override fun definitions(): Stream<TestDefinitions.TestSuite> {
+  public override fun definitions(): Stream<TestDefinitions.TestSuite> {
     return Stream.of(
         AwakeableIdTest(),
         DeferredTest(),
@@ -31,6 +31,7 @@ class KotlinCoroutinesTests : TestRunner() {
         SideEffectTest(),
         SleepTest(),
         StateMachineFailuresTest(),
-        UserFailuresTest())
+        UserFailuresTest(),
+        RandomTest())
   }
 }
diff --git a/sdk-api-kotlin/src/test/kotlin/dev/restate/sdk/kotlin/RandomTest.kt b/sdk-api-kotlin/src/test/kotlin/dev/restate/sdk/kotlin/RandomTest.kt
@@ -0,0 +1,50 @@
+// Copyright (c) 2023 - Restate Software, Inc., Restate GmbH
+//
+// This file is part of the Restate Java SDK,
+// which is released under the MIT license.
+//
+// You can find a copy of the license in file LICENSE in the root
+// directory of this repository or package, or at
+// https://github.com/restatedev/sdk-java/blob/main/LICENSE
+package dev.restate.sdk.kotlin
+
+import dev.restate.sdk.core.RandomTestSuite
+import dev.restate.sdk.core.testservices.GreeterGrpcKt
+import dev.restate.sdk.core.testservices.GreetingRequest
+import dev.restate.sdk.core.testservices.GreetingResponse
+import dev.restate.sdk.core.testservices.greetingResponse
+import io.grpc.BindableService
+import kotlin.random.Random
+import kotlinx.coroutines.Dispatchers
+
+class RandomTest : RandomTestSuite() {
+  private class RandomShouldBeDeterministic :
+      GreeterGrpcKt.GreeterCoroutineImplBase(Dispatchers.Unconfined), RestateKtService {
+
+    override suspend fun greet(request: GreetingRequest): GreetingResponse {
+      val number = restateContext().random().nextInt()
+      return greetingResponse { message = number.toString() }
+    }
+  }
+
+  override fun randomShouldBeDeterministic(): BindableService {
+    return RandomShouldBeDeterministic()
+  }
+
+  private class RandomInsideSideEffect :
+      GreeterGrpcKt.GreeterCoroutineImplBase(Dispatchers.Unconfined), RestateKtService {
+    override suspend fun greet(request: GreetingRequest): GreetingResponse {
+      val ctx = restateContext()
+      ctx.sideEffect { ctx.random().nextInt() }
+      throw IllegalStateException("This should not unreachable")
+    }
+  }
+
+  override fun randomInsideSideEffect(): BindableService {
+    return RandomInsideSideEffect()
+  }
+
+  override fun getExpectedInt(seed: Long): Int {
+    return Random(seed).nextInt()
+  }
+}
diff --git a/sdk-api/src/main/java/dev/restate/sdk/RestateContext.java b/sdk-api/src/main/java/dev/restate/sdk/RestateContext.java
@@ -207,6 +207,11 @@ default void sideEffect(ThrowingRunnable runnable) throws TerminalException {
    */
   AwakeableHandle awakeableHandle(String id);
 
+  /**
+   * @see RestateRandom
+   */
+  RestateRandom random();
+
   /**
    * Build a RestateContext from the underlying {@link Syscalls} object.
    *
diff --git a/sdk-api/src/main/java/dev/restate/sdk/RestateContextImpl.java b/sdk-api/src/main/java/dev/restate/sdk/RestateContextImpl.java
@@ -9,10 +9,7 @@
 package dev.restate.sdk;
 
 import com.google.protobuf.ByteString;
-import dev.restate.sdk.common.AbortedExecutionException;
-import dev.restate.sdk.common.Serde;
-import dev.restate.sdk.common.StateKey;
-import dev.restate.sdk.common.TerminalException;
+import dev.restate.sdk.common.*;
 import dev.restate.sdk.common.function.ThrowingSupplier;
 import dev.restate.sdk.common.syscalls.DeferredResult;
 import dev.restate.sdk.common.syscalls.EnterSideEffectSyscallCallback;
@@ -186,4 +183,9 @@ public void reject(String reason) {
       }
     };
   }
+
+  @Override
+  public RestateRandom random() {
+    return new RestateRandom(InvocationId.current().toRandomSeed(), this.syscalls);
+  }
 }
diff --git a/sdk-api/src/main/java/dev/restate/sdk/RestateRandom.java b/sdk-api/src/main/java/dev/restate/sdk/RestateRandom.java
@@ -0,0 +1,66 @@
+// Copyright (c) 2023 - Restate Software, Inc., Restate GmbH
+//
+// This file is part of the Restate Java SDK,
+// which is released under the MIT license.
+//
+// You can find a copy of the license in file LICENSE in the root
+// directory of this repository or package, or at
+// https://github.com/restatedev/sdk-java/blob/main/LICENSE
+package dev.restate.sdk;
+
+import dev.restate.sdk.common.InvocationId;
+import dev.restate.sdk.common.Serde;
+import dev.restate.sdk.common.function.ThrowingSupplier;
+import dev.restate.sdk.common.syscalls.Syscalls;
+import java.util.Random;
+import java.util.UUID;
+
+/**
+ * Subclass of {@link Random} inherently predictable, seeded on the {@link InvocationId}, which is
+ * not secret.
+ *
+ * <p>This instance is useful to generate identifiers, idempotency keys, and for uniform sampling
+ * from a set of options. If a cryptographically secure value is needed, please generate that
+ * externally using {@link RestateContext#sideEffect(Serde, ThrowingSupplier)}.
+ *
+ * <p>You MUST NOT use this object inside a {@link RestateContext#sideEffect(Serde,
+ * ThrowingSupplier)}.
+ */
+public class RestateRandom extends Random {
+
+  private final Syscalls syscalls;
+  private boolean seedInitialized = false;
+
+  RestateRandom(long randomSeed, Syscalls syscalls) {
+    super(randomSeed);
+    this.syscalls = syscalls;
+  }
+
+  /**
+   * @throws UnsupportedOperationException You cannot set the seed on RestateRandom
+   */
+  @Override
+  public synchronized void setSeed(long seed) {
+    if (seedInitialized) {
+      throw new UnsupportedOperationException("You cannot set the seed on RestateRandom");
+    }
+    super.setSeed(seed);
+    this.seedInitialized = true;
+  }
+
+  /**
+   * @return a UUID generated using this RNG.
+   */
+  public UUID nextUUID() {
+    return new UUID(this.nextLong(), this.nextLong());
+  }
+
+  @Override
+  protected int next(int bits) {
+    if (this.syscalls.isInsideSideEffect()) {
+      throw new IllegalStateException("You can't use RestateRandom inside a side effect!");
+    }
+
+    return super.next(bits);
+  }
+}
diff --git a/sdk-api/src/test/java/dev/restate/sdk/JavaBlockingTests.java b/sdk-api/src/test/java/dev/restate/sdk/JavaBlockingTests.java
@@ -23,7 +23,7 @@ protected Stream<TestExecutor> executors() {
   }
 
   @Override
-  protected Stream<TestSuite> definitions() {
+  public Stream<TestSuite> definitions() {
     return Stream.of(
         new AwakeableIdTest(),
         new DeferredTest(),
@@ -36,6 +36,7 @@ protected Stream<TestSuite> definitions() {
         new StateMachineFailuresTest(),
         new UserFailuresTest(),
         new GrpcChannelAdapterTest(),
-        new RestateCodegenTest());
+        new RestateCodegenTest(),
+        new RandomTest());
   }
 }
diff --git a/sdk-api/src/test/java/dev/restate/sdk/RandomTest.java b/sdk-api/src/test/java/dev/restate/sdk/RandomTest.java
@@ -0,0 +1,54 @@
+// Copyright (c) 2023 - Restate Software, Inc., Restate GmbH
+//
+// This file is part of the Restate Java SDK,
+// which is released under the MIT license.
+//
+// You can find a copy of the license in file LICENSE in the root
+// directory of this repository or package, or at
+// https://github.com/restatedev/sdk-java/blob/main/LICENSE
+package dev.restate.sdk;
+
+import dev.restate.sdk.common.TerminalException;
+import dev.restate.sdk.core.RandomTestSuite;
+import dev.restate.sdk.core.testservices.GreeterRestate;
+import dev.restate.sdk.core.testservices.GreetingRequest;
+import dev.restate.sdk.core.testservices.GreetingResponse;
+import io.grpc.BindableService;
+import java.util.Random;
+
+public class RandomTest extends RandomTestSuite {
+
+  private static class RandomShouldBeDeterministic extends GreeterRestate.GreeterRestateImplBase {
+    @Override
+    public GreetingResponse greet(RestateContext context, GreetingRequest request)
+        throws TerminalException {
+      return GreetingResponse.newBuilder()
+          .setMessage(Integer.toString(context.random().nextInt()))
+          .build();
+    }
+  }
+
+  @Override
+  protected BindableService randomShouldBeDeterministic() {
+    return new RandomShouldBeDeterministic();
+  }
+
+  private static class RandomInsideSideEffect extends GreeterRestate.GreeterRestateImplBase {
+    @Override
+    public GreetingResponse greet(RestateContext context, GreetingRequest request)
+        throws TerminalException {
+      context.sideEffect(() -> context.random().nextInt());
+      throw new IllegalStateException("This should not unreachable");
+    }
+  }
+
+  @Override
+  protected BindableService randomInsideSideEffect() {
+    return new RandomInsideSideEffect();
+  }
+
+  @Override
+  protected int getExpectedInt(long seed) {
+    return new Random(seed).nextInt();
+  }
+}
diff --git a/sdk-common/src/main/java/dev/restate/sdk/common/InvocationId.java b/sdk-common/src/main/java/dev/restate/sdk/common/InvocationId.java
@@ -28,6 +28,11 @@ static InvocationId current() {
     return INVOCATION_ID_KEY.get();
   }
 
+  /**
+   * @return a seed to be used with {@link java.util.Random}.
+   */
+  long toRandomSeed();
+
   @Override
   String toString();
 }
diff --git a/sdk-common/src/main/java/dev/restate/sdk/common/syscalls/Syscalls.java b/sdk-common/src/main/java/dev/restate/sdk/common/syscalls/Syscalls.java
@@ -41,6 +41,11 @@ static Syscalls current() {
             + Thread.currentThread().getName());
   }
 
+  /**
+   * @return true if it's inside a side effect block.
+   */
+  boolean isInsideSideEffect();
+
   // ----- IO
   // Note: These are not supposed to be exposed to RestateContext, but they should be used through
   // gRPC APIs.
diff --git a/sdk-core/src/main/java/dev/restate/sdk/core/ExecutorSwitchingWrappers.java b/sdk-core/src/main/java/dev/restate/sdk/core/ExecutorSwitchingWrappers.java
@@ -193,6 +193,12 @@ public InvocationState getInvocationState() {
       return syscalls.getInvocationState();
     }
 
+    @Override
+    public boolean isInsideSideEffect() {
+      // We can read this from another thread
+      return syscalls.isInsideSideEffect();
+    }
+
     @Override
     public void close() {
       syscallsExecutor.execute(syscalls::close);
diff --git a/sdk-core/src/main/java/dev/restate/sdk/core/InvocationIdImpl.java b/sdk-core/src/main/java/dev/restate/sdk/core/InvocationIdImpl.java
@@ -9,14 +9,19 @@
 package dev.restate.sdk.core;
 
 import dev.restate.sdk.common.InvocationId;
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
 import java.util.Objects;
 
 final class InvocationIdImpl implements InvocationId {
 
   private final String id;
+  private Long seed;
 
   InvocationIdImpl(String debugId) {
     this.id = debugId;
+    this.seed = null;
   }
 
   @Override
@@ -32,6 +37,33 @@ public int hashCode() {
     return Objects.hash(id);
   }
 
+  @Override
+  public long toRandomSeed() {
+    if (seed == null) {
+      // Hash the seed to SHA-256 to increase entropy
+      MessageDigest md;
+      try {
+        md = MessageDigest.getInstance("SHA-256");
+      } catch (NoSuchAlgorithmException e) {
+        throw new RuntimeException(e);
+      }
+      byte[] digest = md.digest(id.getBytes(StandardCharsets.UTF_8));
+
+      // Generate the long
+      long n = 0;
+      n |= ((long) (digest[7] & 0xFF) << Byte.SIZE * 7);
+      n |= ((long) (digest[6] & 0xFF) << Byte.SIZE * 6);
+      n |= ((long) (digest[5] & 0xFF) << Byte.SIZE * 5);
+      n |= ((long) (digest[4] & 0xFF) << Byte.SIZE * 4);
+      n |= ((long) (digest[3] & 0xFF) << Byte.SIZE * 3);
+      n |= ((digest[2] & 0xFF) << Byte.SIZE * 2);
+      n |= ((digest[1] & 0xFF) << Byte.SIZE);
+      n |= (digest[0] & 0xFF);
+      seed = n;
+    }
+    return seed;
+  }
+
   @Override
   public String toString() {
     return id;
diff --git a/sdk-core/src/main/java/dev/restate/sdk/core/InvocationStateMachine.java b/sdk-core/src/main/java/dev/restate/sdk/core/InvocationStateMachine.java
diff --git a/sdk-core/src/main/java/dev/restate/sdk/core/SyscallsImpl.java b/sdk-core/src/main/java/dev/restate/sdk/core/SyscallsImpl.java
diff --git a/sdk-core/src/test/java/dev/restate/sdk/core/RandomTestSuite.java b/sdk-core/src/test/java/dev/restate/sdk/core/RandomTestSuite.java
diff --git a/sdk-http-vertx/src/test/kotlin/dev/restate/sdk/http/vertx/HttpVertxTests.kt b/sdk-http-vertx/src/test/kotlin/dev/restate/sdk/http/vertx/HttpVertxTests.kt

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class KotlinCoroutinesTests : TestRunner() {`
`20`	`20`	`return Stream.of(MockSingleThread.INSTANCE, MockMultiThreaded.INSTANCE)`
`21`	`21`	`}`
`22`	`22`
`23`		`- override fun definitions(): Stream<TestDefinitions.TestSuite> {`
	`23`	`+ public override fun definitions(): Stream<TestDefinitions.TestSuite> {`
`24`	`24`	`return Stream.of(`
`25`	`25`	`AwakeableIdTest(),`
`26`	`26`	`DeferredTest(),`
`@@ -31,6 +31,7 @@ class KotlinCoroutinesTests : TestRunner() {`
`31`	`31`	`SideEffectTest(),`
`32`	`32`	`SleepTest(),`
`33`	`33`	`StateMachineFailuresTest(),`
`34`		`- UserFailuresTest())`
	`34`	`+ UserFailuresTest(),`
	`35`	`+ RandomTest())`
`35`	`36`	`}`
`36`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ protected Stream<TestExecutor> executors() {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`@Override`
`26`		`- protected Stream<TestSuite> definitions() {`
	`26`	`+ public Stream<TestSuite> definitions() {`
`27`	`27`	`return Stream.of(`
`28`	`28`	`new AwakeableIdTest(),`
`29`	`29`	`new DeferredTest(),`
`@@ -36,6 +36,7 @@ protected Stream<TestSuite> definitions() {`
`36`	`36`	`new StateMachineFailuresTest(),`
`37`	`37`	`new UserFailuresTest(),`
`38`	`38`	`new GrpcChannelAdapterTest(),`
`39`		`- new RestateCodegenTest());`
	`39`	`+ new RestateCodegenTest(),`
	`40`	`+ new RandomTest());`
`40`	`41`	`}`
`41`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,11 @@ static InvocationId current() {`
`28`	`28`	`return INVOCATION_ID_KEY.get();`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ /**`
	`32`	`+ * @return a seed to be used with {@link java.util.Random}.`
	`33`	`+ */`
	`34`	`+ long toRandomSeed();`
	`35`	`+`
`31`	`36`	`@Override`
`32`	`37`	`String toString();`
`33`	`38`	`}`