Surface when we encounter invalid sequences of events

Refs #2100
PREreview · Nov 22, 2024 · 7a696a8 · 7a696a8
1 parent 9adb976
commit 7a696a8
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 13 deletions.
diff --git a/src/Comments/Queries.ts b/src/Comments/Queries.ts
@@ -1,4 +1,4 @@
-import { Array, Either, Equal, Option, pipe, Record } from 'effect'
+import { Array, Data, Either, Equal, Option, pipe, Record } from 'effect'
 import type { Orcid } from 'orcid-id-ts'
 import type { Uuid } from '../types/index.js'
 import type { InputForCommentZenodoRecord } from './Context.js'
@@ -161,12 +161,17 @@ const buildInputForCommentZenodoRecord = (
   return Option.all({ authorId, prereviewId, persona, comment, competingInterests })
 }
 
+class UnexpectedSequenceOfEvents extends Data.TaggedError('UnexpectedSequenceOfEvents') {}
+
 export const GetACommentInNeedOfADoi = (
   events: ReadonlyArray<{ readonly event: CommentEvent; readonly resourceId: Uuid.Uuid }>,
-): Option.Option<{
-  commentId: Uuid.Uuid
-  inputForCommentZenodoRecord: InputForCommentZenodoRecord
-}> => {
+): Either.Either<
+  Option.Option<{
+    commentId: Uuid.Uuid
+    inputForCommentZenodoRecord: InputForCommentZenodoRecord
+  }>,
+  UnexpectedSequenceOfEvents
+> => {
   const hasADoi = new Set()
 
   for (const { event, resourceId } of events.toReversed()) {
@@ -176,12 +181,21 @@ export const GetACommentInNeedOfADoi = (
     }
 
     if (event._tag === 'CommentPublicationWasRequested' && !hasADoi.has(resourceId)) {
-      return Option.all({
-        commentId: Option.some(resourceId),
-        inputForCommentZenodoRecord: buildInputForCommentZenodoRecord(events, resourceId),
-      })
+      return pipe(
+        buildInputForCommentZenodoRecord(events, resourceId),
+        Option.match({
+          onNone: () => Either.left(new UnexpectedSequenceOfEvents()),
+          onSome: inputForCommentZenodoRecord =>
+            Either.right(
+              Option.some({
+                commentId: resourceId,
+                inputForCommentZenodoRecord,
+              }),
+            ),
+        }),
+      )
     }
   }
 
-  return Option.none()
+  return Either.right(Option.none())
 }
diff --git a/src/Comments/index.ts b/src/Comments/index.ts
@@ -138,6 +138,7 @@ export const ReactToCommentEvents: Layer.Layer<
           pipe(
             eventStore.getAllEvents,
             Effect.andThen(events => Queries.GetACommentInNeedOfADoi(events)),
+            Effect.flatten,
             Effect.andThen(
               flow(
                 React.AssignCommentADoiWhenPublicationWasRequested,
@@ -165,6 +166,7 @@ export const ReactToCommentEvents: Layer.Layer<
                 pipe(
                   eventStore.getAllEvents,
                   Effect.andThen(events => Queries.GetACommentInNeedOfADoi(events)),
+                  Effect.flatten,
                   Effect.andThen(React.AssignCommentADoiWhenPublicationWasRequested),
                   Effect.tapError(() =>
                     Effect.annotateLogs(Effect.logError('ReactToCommentEvents failed'), { commentId }),

diff --git a/test/Comments/Queries.test.ts b/test/Comments/Queries.test.ts
@@ -346,7 +346,9 @@ describe('GetACommentInNeedOfADoi', () => {
     const actual = _.GetACommentInNeedOfADoi(Array.map(events, event => ({ event, resourceId })))
 
     expect(actual).toStrictEqual(
-      Option.some({ commentId: resourceId, inputForCommentZenodoRecord: expectedInputForCommentZenodoRecord }),
+      Either.right(
+        Option.some({ commentId: resourceId, inputForCommentZenodoRecord: expectedInputForCommentZenodoRecord }),
+      ),
     )
   })
 
@@ -357,14 +359,14 @@ describe('GetACommentInNeedOfADoi', () => {
 
     const actual = _.GetACommentInNeedOfADoi(Array.map(events, event => ({ event, resourceId })))
 
-    expect(actual).toStrictEqual(Option.none())
+    expect(actual).toStrictEqual(Either.right(Option.none()))
   })
 
   test('ignores comments for which publication has not been requested', () => {
     const actual = _.GetACommentInNeedOfADoi(
       Array.map(eventsNeededToRequestPublication, event => ({ event, resourceId })),
     )
 
-    expect(actual).toStrictEqual(Option.none())
+    expect(actual).toStrictEqual(Either.right(Option.none()))
   })
 })