Schedule output has been added into CurrentIterationMetadata (#5025)

Author: KhraksMamtsov

.changeset/fuzzy-horses-invent.md

@@ -0,0 +1,5 @@
+---
+"effect": minor
+---
+
+Schedule output has been added into `CurrentIterationMetadata`

packages/effect/src/Schedule.ts

@@ -2201,6 +2201,7 @@ export interface CurrentIterationMetadata {
  */
 export interface IterationMetadata {
   readonly input: unknown
+  readonly output: unknown
   readonly recurrence: number
   readonly start: number
   readonly now: number

packages/effect/src/internal/schedule.ts

@@ -53,6 +53,7 @@ const defaultIterationMetadata: Schedule.IterationMetadata = {
   start: 0,
   now: 0,
   input: undefined,
+  output: undefined,
   elapsed: Duration.zero,
   elapsedSincePrevious: Duration.zero,
   recurrence: 0
@@ -103,13 +104,15 @@ class ScheduleImpl<S, Out, In, R> implements Schedule.Schedule<Out, In, R> {
 const updateInfo = (
   iterationMetaRef: Ref.Ref<Schedule.IterationMetadata>,
   now: number,
-  input: unknown
+  input: unknown,
+  output: unknown
 ) =>
   ref.update(iterationMetaRef, (prev) =>
     (prev.recurrence === 0) ?
       {
         now,
         input,
+        output,
         recurrence: prev.recurrence + 1,
         elapsed: Duration.zero,
         elapsedSincePrevious: Duration.zero,
@@ -118,6 +121,7 @@ const updateInfo = (
       {
         now,
         input,
+        output,
         recurrence: prev.recurrence + 1,
         elapsed: Duration.millis(now - prev.start),
         elapsedSincePrevious: Duration.millis(now - prev.now),
@@ -177,14 +181,14 @@ class ScheduleDriverImpl<Out, In, R> implements Schedule.ScheduleDriver<Out, In,
                 const millis = Intervals.start(decision.intervals) - now
                 if (millis <= 0) {
                   return setState.pipe(
-                    core.zipRight(updateInfo(this.iterationMeta, now, input)),
+                    core.zipRight(updateInfo(this.iterationMeta, now, input, out)),
                     core.as(out)
                   )
                 }
                 const duration = Duration.millis(millis)
                 return pipe(
                   setState,
-                  core.zipRight(updateInfo(this.iterationMeta, now, input)),
+                  core.zipRight(updateInfo(this.iterationMeta, now, input, out)),
                   core.zipRight(effect.sleep(duration)),
                   core.as(out)
                 )

packages/effect/test/Effect/repeating.test.ts

@@ -121,7 +121,7 @@ describe("Effect", () => {
       strictEqual(result, 4)
     }))
 
-  it.effect("repeat/schedule - IterationMetadata", () =>
+  it.effect("repeat/schedule - CurrentIterationMetadata", () =>
     Effect.gen(function*() {
       const ref = yield* Ref.make<Array<undefined | Schedule.IterationMetadata>>([])
       yield* Effect.gen(function*() {
@@ -141,6 +141,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.zero,
           recurrence: 0,
           input: undefined,
+          output: undefined,
           now: 0,
           start: 0
         },
@@ -149,6 +150,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.zero,
           recurrence: 1,
           input: undefined,
+          output: [0, 0],
           now: 0,
           start: 0
         },
@@ -157,6 +159,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.seconds(1),
           recurrence: 2,
           input: undefined,
+          output: [1, 1],
           now: 1000,
           start: 0
         }

packages/effect/test/Effect/retrying.test.ts

@@ -99,7 +99,7 @@ describe("Effect", () => {
       const result = yield* (Ref.get(ref))
       strictEqual(result, 4)
     }))
-  it.effect("retry/schedule - LastIterationInfo", () =>
+  it.effect("retry/schedule - CurrentIterationMetadata", () =>
     Effect.gen(function*() {
       const ref = yield* Ref.make<Array<undefined | Schedule.IterationMetadata>>([])
       yield* pipe(
@@ -116,6 +116,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.zero,
           recurrence: 0,
           input: undefined,
+          output: undefined,
           now: 0,
           start: 0
         },
@@ -124,6 +125,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.zero,
           recurrence: 1,
           input: undefined,
+          output: 0,
           now: 0,
           start: 0
         },
@@ -132,6 +134,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.zero,
           recurrence: 2,
           input: undefined,
+          output: 1,
           now: 0,
           start: 0
         },
@@ -140,6 +143,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.zero,
           recurrence: 3,
           input: undefined,
+          output: 2,
           now: 0,
           start: 0
         }

packages/effect/test/Effect/scheduling.test.ts

@@ -24,7 +24,7 @@ describe("Effect", () => {
       deepStrictEqual(value, expected)
     }))
 
-  it.effect("schedule - Schedule.LastIterationInfo", () =>
+  it.effect("schedule - Schedule.CurrentIterationMetadata", () =>
     Effect.gen(function*() {
       const ref = yield* Ref.make<Array<undefined | Schedule.IterationMetadata>>([])
       const effect = Effect.gen(function*() {
@@ -43,6 +43,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.zero,
           recurrence: 1,
           input: undefined,
+          output: [Duration.millis(1000), 0],
           now: 0,
           start: 0
         },
@@ -51,6 +52,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.seconds(1),
           recurrence: 2,
           input: undefined,
+          output: [Duration.millis(1000), 1],
           now: 1000,
           start: 0
         },
@@ -59,6 +61,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.seconds(1),
           recurrence: 3,
           input: undefined,
+          output: [Duration.millis(2000), 2],
           now: 2000,
           start: 0
         },
@@ -67,6 +70,7 @@ describe("Effect", () => {
           elapsedSincePrevious: Duration.seconds(2),
           recurrence: 4,
           input: undefined,
+          output: [Duration.millis(3000), 3],
           now: 4000,
           start: 0
         }

packages/effect/test/Stream/repeating.test.ts

@@ -89,6 +89,7 @@ describe("Stream", () => {
           elapsed: Duration.zero,
           elapsedSincePrevious: Duration.zero,
           input: undefined,
+          output: undefined,
           now: 0,
           recurrence: 0,
           start: 0
@@ -97,6 +98,7 @@ describe("Stream", () => {
           elapsed: Duration.zero,
           elapsedSincePrevious: Duration.zero,
           input: undefined,
+          output: Duration.millis(10),
           now: 0,
           recurrence: 1,
           start: 0
@@ -105,6 +107,7 @@ describe("Stream", () => {
           elapsed: Duration.millis(10),
           elapsedSincePrevious: Duration.millis(10),
           input: undefined,
+          output: Duration.millis(20),
           now: 10,
           recurrence: 2,
           start: 0
@@ -113,6 +116,7 @@ describe("Stream", () => {
           elapsed: Duration.millis(30),
           elapsedSincePrevious: Duration.millis(20),
           input: undefined,
+          output: Duration.millis(40),
           now: 30,
           recurrence: 3,
           start: 0

packages/effect/test/Stream/retrying.test.ts

@@ -139,6 +139,7 @@ describe("Stream", () => {
           elapsed: Duration.zero,
           elapsedSincePrevious: Duration.zero,
           input: undefined,
+          output: undefined,
           now: 0,
           recurrence: 0,
           start: 0
@@ -147,6 +148,7 @@ describe("Stream", () => {
           elapsed: Duration.zero,
           elapsedSincePrevious: Duration.zero,
           input: 1,
+          output: Duration.millis(1000),
           now: 0,
           recurrence: 1,
           start: 0
@@ -155,6 +157,7 @@ describe("Stream", () => {
           elapsed: Duration.seconds(1),
           elapsedSincePrevious: Duration.seconds(1),
           input: 1,
+          output: Duration.millis(2000),
           now: 1000,
           recurrence: 2,
           start: 0
@@ -163,6 +166,7 @@ describe("Stream", () => {
           elapsed: Duration.seconds(3),
           elapsedSincePrevious: Duration.seconds(2),
           input: 1,
+          output: Duration.millis(4000),
           now: 3000,
           recurrence: 3,
           start: 0