Rename VeryExperimentalWorkflow opt-in annotation to ExperimentalWorkflow.

workflow-core/api/workflow-core.api

@@ -11,6 +11,9 @@ public final class com/squareup/workflow/EventHandlerKt {
 	public static final fun invoke (Lcom/squareup/workflow/EventHandler;)V
 }
 
+public abstract interface annotation class com/squareup/workflow/ExperimentalWorkflow : java/lang/annotation/Annotation {
+}
+
 public abstract class com/squareup/workflow/LifecycleWorker : com/squareup/workflow/Worker {
 	public fun <init> ()V
 	public fun doesSameWorkAs (Lcom/squareup/workflow/Worker;)Z
@@ -144,9 +147,6 @@ public final class com/squareup/workflow/TypedWorker : com/squareup/workflow/Wor
 	public fun toString ()Ljava/lang/String;
 }
 
-public abstract interface annotation class com/squareup/workflow/VeryExperimentalWorkflow : java/lang/annotation/Annotation {
-}
-
 public abstract interface class com/squareup/workflow/Worker {
 	public static final field Companion Lcom/squareup/workflow/Worker$Companion;
 	public abstract fun doesSameWorkAs (Lcom/squareup/workflow/Worker;)Z

workflow-core/src/main/java/com/squareup/workflow/VeryExperimentalWorkflow.kt → workflow-core/src/main/java/com/squareup/workflow/ExperimentalWorkflow.kt

@@ -20,10 +20,11 @@ import kotlin.annotation.AnnotationRetention.BINARY
 
 /**
  * Marks Workflow APIs that are extremely likely to change in future versions, rely themselves on
- * other unstable, experimental APIs, and SHOULD NOT be used in production code. Proceed with
- * caution, and be ready to have the rug pulled out from under you.
+ * other unstable, experimental APIs, and SHOULD NOT be used in library code or app code that you
+ * are not prepared to update when changing even minor workflow versions. Proceed with caution, and
+ * be ready to have the rug pulled out from under you.
  */
 @MustBeDocumented
 @Retention(value = BINARY)
 @RequiresOptIn(level = ERROR)
-annotation class VeryExperimentalWorkflow
+annotation class ExperimentalWorkflow

workflow-runtime/src/main/java/com/squareup/workflow/LaunchWorkflow.kt

@@ -209,7 +209,7 @@ fun <PropsT, OutputT : Any, RenderingT, RunnerT> launchWorkflowIn(
  * A [StateFlow] of [RenderingAndSnapshot]s that will emit any time the root workflow creates a new
  * rendering.
  */
-@OptIn(ExperimentalCoroutinesApi::class, VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalCoroutinesApi::class, ExperimentalWorkflow::class)
 fun <PropsT, OutputT : Any, RenderingT> renderWorkflowIn(
   workflow: Workflow<PropsT, OutputT, RenderingT>,
   scope: CoroutineScope,
@@ -268,7 +268,7 @@ fun <PropsT, OutputT : Any, RenderingT> renderWorkflowIn(
 @OptIn(
     ExperimentalCoroutinesApi::class,
     FlowPreview::class,
-    VeryExperimentalWorkflow::class
+    ExperimentalWorkflow::class
 )
 @Suppress("LongParameterList")
 internal fun <PropsT, StateT, OutputT : Any, RenderingT, RunnerT> launchWorkflowImpl(

workflow-runtime/src/main/java/com/squareup/workflow/diagnostic/ChainedDiagnosticListener.kt

@@ -15,7 +15,7 @@
  */
 package com.squareup.workflow.diagnostic
 
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.WorkflowAction
 import kotlinx.coroutines.CoroutineScope
 
@@ -31,7 +31,7 @@ fun WorkflowDiagnosticListener.andThen(
       .apply { addVisitor(next) }
 }
 
-@OptIn(VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalWorkflow::class)
 @Suppress("TooManyFunctions")
 internal class ChainedDiagnosticListener(
   listener: WorkflowDiagnosticListener

workflow-runtime/src/main/java/com/squareup/workflow/diagnostic/DebugSnapshotRecordingListener.kt

@@ -15,7 +15,7 @@
  */
 package com.squareup.workflow.diagnostic
 
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.WorkflowAction
 import com.squareup.workflow.diagnostic.WorkflowHierarchyDebugSnapshot.ChildWorker
 import com.squareup.workflow.diagnostic.WorkflowHierarchyDebugSnapshot.ChildWorkflow
@@ -29,7 +29,7 @@ import com.squareup.workflow.diagnostic.WorkflowUpdateDebugInfo.Source.Worker
  * A [WorkflowDiagnosticListener] that records [WorkflowHierarchyDebugSnapshot]s and
  * [WorkflowUpdateDebugInfo]s and sends them to [debugger] after each render pass.
  */
-@VeryExperimentalWorkflow
+@ExperimentalWorkflow
 @Suppress("TooManyFunctions")
 class DebugSnapshotRecordingListener(
   private val debugger: (WorkflowHierarchyDebugSnapshot, WorkflowUpdateDebugInfo?) -> Unit

workflow-runtime/src/main/java/com/squareup/workflow/diagnostic/SimpleLoggingDiagnosticListener.kt

@@ -15,14 +15,14 @@
  */
 package com.squareup.workflow.diagnostic
 
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.WorkflowAction
 import kotlinx.coroutines.CoroutineScope
 
 /**
  * A [WorkflowDiagnosticListener] that just prints all events using [println].
  */
-@OptIn(VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalWorkflow::class)
 @Suppress("TooManyFunctions")
 open class SimpleLoggingDiagnosticListener : WorkflowDiagnosticListener {
 

workflow-runtime/src/main/java/com/squareup/workflow/diagnostic/WorkflowDiagnosticListener.kt

@@ -15,7 +15,7 @@
  */
 package com.squareup.workflow.diagnostic
 
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.WorkflowAction
 import kotlinx.coroutines.CoroutineScope
 
@@ -76,7 +76,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onAfterRenderPass].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onBeforeRenderPass(props: Any?) = Unit
 
   /**
@@ -85,7 +85,7 @@ interface WorkflowDiagnosticListener {
    * @param workflowId The ID of the workflow for this event. If null, the props for the root
    * workflow changed. [oldState] and [newState] will always be null in that case.
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onPropsChanged(
     workflowId: Long?,
     oldProps: Any?,
@@ -99,7 +99,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onAfterWorkflowRendered].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onBeforeWorkflowRendered(
     workflowId: Long,
     props: Any?,
@@ -111,7 +111,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onBeforeWorkflowRendered].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onAfterWorkflowRendered(
     workflowId: Long,
     rendering: Any?
@@ -122,7 +122,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onBeforeRenderPass].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onAfterRenderPass(rendering: Any?) = Unit
 
   /**
@@ -131,7 +131,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onAfterSnapshotPass].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onBeforeSnapshotPass() = Unit
 
   /**
@@ -140,7 +140,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onBeforeSnapshotPass].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onAfterSnapshotPass() = Unit
 
   // endregion
@@ -154,7 +154,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onRuntimeStopped].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onRuntimeStarted(
     workflowScope: CoroutineScope,
     rootWorkflowType: String
@@ -166,7 +166,7 @@ interface WorkflowDiagnosticListener {
    *
    * Corresponds to [onRuntimeStarted].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onRuntimeStopped() = Unit
 
   /**
@@ -185,7 +185,7 @@ interface WorkflowDiagnosticListener {
    * [initialState][com.squareup.workflow.StatefulWorkflow.initialState].
    * @param restoredFromSnapshot True iff the snapshot parameter to `initialState` was non-null.
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   @Suppress("LongParameterList")
   fun onWorkflowStarted(
     workflowId: Long,
@@ -204,7 +204,7 @@ interface WorkflowDiagnosticListener {
    *
    * @param workflowId The ID of the workflow that stopped.
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onWorkflowStopped(workflowId: Long) = Unit
 
   /**
@@ -218,7 +218,7 @@ interface WorkflowDiagnosticListener {
    * @param key The key passed to `runningWorker` by [parentWorkflowId].
    * @param description A string description of the worker. Contains the worker's `toString`.
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onWorkerStarted(
     workerId: Long,
     parentWorkflowId: Long,
@@ -235,7 +235,7 @@ interface WorkflowDiagnosticListener {
    * @param workerId The ID of the worker that stopped.
    * @param parentWorkflowId The ID of the workflow that was running this worker.
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onWorkerStopped(
     workerId: Long,
     parentWorkflowId: Long
@@ -255,7 +255,7 @@ interface WorkflowDiagnosticListener {
    * receive the output.
    * @param output The value that the worker output.
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onWorkerOutput(
     workerId: Long,
     parentWorkflowId: Long,
@@ -271,7 +271,7 @@ interface WorkflowDiagnosticListener {
    * corresponding [WorkflowAction].
    * @param action The [WorkflowAction] that will be executed by [workflowId].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onSinkReceived(
     workflowId: Long,
     action: WorkflowAction<*, *>
@@ -290,7 +290,7 @@ interface WorkflowDiagnosticListener {
    * the state, this will be the same value as [oldState].
    * @param output The output value returned from [action].
    */
-  @VeryExperimentalWorkflow
+  @ExperimentalWorkflow
   fun onWorkflowAction(
     workflowId: Long,
     action: WorkflowAction<*, *>,

workflow-runtime/src/main/java/com/squareup/workflow/internal/Workers.kt

@@ -15,7 +15,7 @@
  */
 package com.squareup.workflow.internal
 
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.Worker
 import com.squareup.workflow.diagnostic.WorkflowDiagnosticListener
 import kotlinx.coroutines.CoroutineName
@@ -79,7 +79,7 @@ private fun <T> Worker<T>.runWithNullCheck(): Flow<T> =
           "If this is a test mock, make sure you mock the run() method!"
   )
 
-@OptIn(VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalWorkflow::class)
 private fun <T> Flow<T>.wireUpDebugger(
   workerDiagnosticId: Long,
   workflowDiagnosticId: Long,

workflow-runtime/src/main/java/com/squareup/workflow/internal/WorkflowLoop.kt

@@ -18,7 +18,7 @@ package com.squareup.workflow.internal
 import com.squareup.workflow.RenderingAndSnapshot
 import com.squareup.workflow.Snapshot
 import com.squareup.workflow.StatefulWorkflow
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.diagnostic.IdCounter
 import com.squareup.workflow.diagnostic.WorkflowDiagnosticListener
 import kotlinx.coroutines.channels.consume
@@ -53,7 +53,7 @@ internal interface WorkflowLoop {
   ): Nothing
 }
 
-@OptIn(VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalWorkflow::class)
 internal open class RealWorkflowLoop : WorkflowLoop {
 
   @Suppress("LongMethod")

workflow-runtime/src/main/java/com/squareup/workflow/internal/WorkflowNode.kt

@@ -17,7 +17,7 @@ package com.squareup.workflow.internal
 
 import com.squareup.workflow.Snapshot
 import com.squareup.workflow.StatefulWorkflow
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.Worker
 import com.squareup.workflow.Workflow
 import com.squareup.workflow.WorkflowAction
@@ -50,7 +50,7 @@ import kotlin.coroutines.EmptyCoroutineContext
  * hard-coded values added to worker contexts. It must not contain a [Job] element (it would violate
  * structured concurrency).
  */
-@OptIn(VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalWorkflow::class)
 internal class WorkflowNode<PropsT, StateT, OutputT : Any, RenderingT>(
   val id: WorkflowId<PropsT, OutputT, RenderingT>,
   workflow: StatefulWorkflow<PropsT, StateT, OutputT, RenderingT>,

workflow-runtime/src/main/java/com/squareup/workflow/internal/WorkflowRunner.kt

@@ -18,7 +18,7 @@ package com.squareup.workflow.internal
 import com.squareup.workflow.RenderingAndSnapshot
 import com.squareup.workflow.Snapshot
 import com.squareup.workflow.StatefulWorkflow
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.Workflow
 import com.squareup.workflow.diagnostic.IdCounter
 import com.squareup.workflow.diagnostic.WorkflowDiagnosticListener
@@ -32,7 +32,7 @@ import kotlinx.coroutines.flow.produceIn
 import kotlinx.coroutines.selects.select
 import kotlin.coroutines.EmptyCoroutineContext
 
-@OptIn(ExperimentalCoroutinesApi::class, VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalCoroutinesApi::class, ExperimentalWorkflow::class)
 internal class WorkflowRunner<PropsT, OutputT : Any, RenderingT>(
   scope: CoroutineScope,
   protoWorkflow: Workflow<PropsT, OutputT, RenderingT>,

workflow-runtime/src/test/java/com/squareup/workflow/diagnostic/DebugSnapshotRecordingListenerTest.kt

@@ -15,7 +15,7 @@
  */
 package com.squareup.workflow.diagnostic
 
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.WorkflowAction.Companion.noAction
 import com.squareup.workflow.diagnostic.WorkflowHierarchyDebugSnapshot.ChildWorker
 import com.squareup.workflow.diagnostic.WorkflowHierarchyDebugSnapshot.ChildWorkflow
@@ -24,7 +24,7 @@ import com.squareup.workflow.diagnostic.WorkflowUpdateDebugInfo.Source
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
-@OptIn(VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalWorkflow::class)
 class DebugSnapshotRecordingListenerTest {
 
   private var snapshot: WorkflowHierarchyDebugSnapshot? = null

workflow-tracing/src/main/java/com/squareup/workflow/diagnostic/tracing/TracingDiagnosticListener.kt

@@ -28,7 +28,7 @@ import com.squareup.tracing.TraceEvent.ObjectCreated
 import com.squareup.tracing.TraceEvent.ObjectDestroyed
 import com.squareup.tracing.TraceEvent.ObjectSnapshot
 import com.squareup.tracing.TraceLogger
-import com.squareup.workflow.VeryExperimentalWorkflow
+import com.squareup.workflow.ExperimentalWorkflow
 import com.squareup.workflow.WorkflowAction
 import com.squareup.workflow.diagnostic.WorkflowDiagnosticListener
 import kotlinx.coroutines.CoroutineScope
@@ -95,7 +95,7 @@ internal fun provideLogger(
  *
  * @constructor The primary constructor is internal so that it can inject [GcDetector] for tests.
  */
-@OptIn(VeryExperimentalWorkflow::class)
+@OptIn(ExperimentalWorkflow::class)
 class TracingDiagnosticListener internal constructor(
   private val memoryStats: MemoryStats,
   private val gcDetectorConstructor: GcDetectorConstructor,