Merge logbook message trip gear and gear type in Backend

MTES-MCT · Mar 27, 2024 · 80e90d4 · 80e90d4
1 parent e876c2e
commit 80e90d4
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 110 deletions.
diff --git a/backend/src/main/kotlin/fr/gouv/cnsp/monitorfish/domain/entities/logbook/LogbookMessage.kt b/backend/src/main/kotlin/fr/gouv/cnsp/monitorfish/domain/entities/logbook/LogbookMessage.kt
@@ -34,6 +34,6 @@ data class LogbookMessage(
     val transmissionFormat: LogbookTransmissionFormat,
     val software: String? = null,
     var isSentByFailoverSoftware: Boolean = false,
-    val tripGears: List<LogbookTripGear>? = listOf(),
+    val tripGears: List<Gear>? = listOf(),
     val tripSegments: List<LogbookTripSegment>? = listOf(),
 )
diff --git a/backend/src/main/kotlin/fr/gouv/cnsp/monitorfish/domain/entities/logbook/LogbookTripGear.kt b/backend/src/main/kotlin/fr/gouv/cnsp/monitorfish/domain/entities/logbook/LogbookTripGear.kt
diff --git a/...otlin/fr/gouv/cnsp/monitorfish/infrastructure/api/outputs/LogbookMessageGearDataOutput.kt b/...otlin/fr/gouv/cnsp/monitorfish/infrastructure/api/outputs/LogbookMessageGearDataOutput.kt
@@ -0,0 +1,23 @@
+package fr.gouv.cnsp.monitorfish.infrastructure.api.outputs
+
+import fr.gouv.cnsp.monitorfish.domain.entities.logbook.Gear
+
+class LogbookMessageGearDataOutput(
+    val gear: String,
+    val gearName: String?,
+    val mesh: Double?,
+    val dimensions: String?,
+) {
+    companion object {
+        fun fromGear(gear: Gear): LogbookMessageGearDataOutput? {
+            return gear.gear?.let { gearCode ->
+                LogbookMessageGearDataOutput(
+                    gear = gearCode,
+                    gearName = gear.gearName,
+                    mesh = gear.mesh,
+                    dimensions = gear.dimensions,
+                )
+            }
+        }
+    }
+}
diff --git a/...n/fr/gouv/cnsp/monitorfish/infrastructure/api/outputs/LogbookMessageTripGearDataOutput.kt b/...n/fr/gouv/cnsp/monitorfish/infrastructure/api/outputs/LogbookMessageTripGearDataOutput.kt
diff --git a/...kotlin/fr/gouv/cnsp/monitorfish/infrastructure/api/outputs/PriorNotificationDataOutput.kt b/...kotlin/fr/gouv/cnsp/monitorfish/infrastructure/api/outputs/PriorNotificationDataOutput.kt
@@ -16,7 +16,7 @@ class PriorNotificationDataOutput(
     val reportingsCount: Int?,
     val seaFront: String?,
     val sentAt: String?,
-    val tripGears: List<LogbookMessageTripGearDataOutput>,
+    val tripGears: List<LogbookMessageGearDataOutput>,
     val tripSegments: List<LogbookMessageTripSegmentDataOutput>,
     val types: List<PriorNotificationTypeDataOutput>,
     val vesselId: Int?,
@@ -38,8 +38,8 @@ class PriorNotificationDataOutput(
             val message = priorNotification.logbookMessage.message as PNO
 
             val onBoardCatches = message.catchOnboard.map { LogbookMessageCatchDataOutput.fromCatch(it) }
-            val tripGears = priorNotification.logbookMessage.tripGears?.map {
-                LogbookMessageTripGearDataOutput.fromLogbookTripGear(it)
+            val tripGears = priorNotification.logbookMessage.tripGears?.mapNotNull {
+                LogbookMessageGearDataOutput.fromGear(it)
             } ?: emptyList()
             val tripSegments = priorNotification.logbookMessage.tripSegments?.map {
                 LogbookMessageTripSegmentDataOutput.fromLogbookTripSegment(it)

diff --git a/...n/kotlin/fr/gouv/cnsp/monitorfish/infrastructure/database/entities/LogbookReportEntity.kt b/...n/kotlin/fr/gouv/cnsp/monitorfish/infrastructure/database/entities/LogbookReportEntity.kt
@@ -113,7 +113,7 @@ data class LogbookReportEntity(
 
     fun toLogbookMessage(mapper: ObjectMapper): LogbookMessage {
         val message = getERSMessageValueFromJSON(mapper, message, messageType, operationType)
-        val tripGears = deserializeJSONList(mapper, tripGears, LogbookTripGear::class.java)
+        val tripGears = deserializeJSONList(mapper, tripGears, Gear::class.java)
         val tripSegments = deserializeJSONList(mapper, tripSegments, LogbookTripSegment::class.java)
 
         return LogbookMessage(

diff --git a/frontend/src/features/Logbook/Logbook.types.ts b/frontend/src/features/Logbook/Logbook.types.ts
@@ -16,6 +16,7 @@ export type FishingActivities = {
 }
 
 // TODO Replace with `LogbookMessage.LogbookMessage`.
+// Can be done after using RTK in `getVesselLogbookFromAPI()` since undefined !== null.
 export type LogbookMessage = {
   acknowledge: {
     dateTime: string | null
@@ -66,6 +67,7 @@ export type PNOAndLANWeightToleranceAlertValue = {
 }
 
 // TODO Replace this type with `LogbookMessage.Catch`.
+// Can be done after using RTK in `getVesselLogbookFromAPI()` since undefined !== null.
 export type LogbookCatch = {
   conversionFactor: number | null
   economicZone: string | null
@@ -82,12 +84,14 @@ export type LogbookCatch = {
   weight: number | null
 }
 
-// TODO Duplicate with `LogbookMessage.TripGear`?
+// TODO Replace this type with `LogbookMessage.Gear`.
+// Can be done after using RTK in `getVesselLogbookFromAPI()` since undefined !== null.
 export type Gear = {
-  dimensions: string
-  gear: string
-  gearName: string
-  mesh: number
+  dimensions: string | null
+  /** Gear code. */
+  gear: string | null
+  gearName: string | null
+  mesh: number | null
 }
 
 export type PNOAndLANWeightToleranceAlertValueCatches = {

diff --git a/frontend/src/features/Logbook/LogbookMessage.types.ts b/frontend/src/features/Logbook/LogbookMessage.types.ts
@@ -87,9 +87,8 @@ export namespace LogbookMessage {
     pnoTypeName: string
   }
 
-  export type TripGear = {
+  export type Gear = {
     dimensions: string
-    /** Gear code. */
     gear: string
     mesh: number
   }

diff --git a/frontend/src/features/Logbook/api.ts b/frontend/src/features/Logbook/api.ts
@@ -33,9 +33,9 @@ export async function getVesselLogbookFromAPI(
   voyageRequest: NavigateTo | undefined,
   tripNumber: number | undefined
 ) {
-  const internalReferenceNumber = vesselIdentity.internalReferenceNumber || ''
-  const nextTripNumber = tripNumber || ''
-  const nextVoyageRequest = voyageRequest || ''
+  const internalReferenceNumber = vesselIdentity.internalReferenceNumber ?? ''
+  const nextTripNumber = tripNumber ?? ''
+  const nextVoyageRequest = voyageRequest ?? ''
 
   try {
     return await monitorfishApiKy

diff --git a/...end/src/features/Logbook/components/VesselLogbook/LogbookMessages/messages/DEPMessage.tsx b/...end/src/features/Logbook/components/VesselLogbook/LogbookMessages/messages/DEPMessage.tsx
@@ -6,9 +6,9 @@ import { NoValue, Table, TableBody, TableKey, TableRow, TableValue, Zone } from
 
 import type { DEPMessageValue } from '../../../../Logbook.types'
 
-type DEPMessageProps = {
+type DEPMessageProps = Readonly<{
   message: DEPMessageValue
-}
+}>
 export function DEPMessage({ message }: DEPMessageProps) {
   return (
     <>

diff --git a/frontend/src/features/Logbook/components/VesselLogbook/LogbookMessages/messages/utils.tsx b/frontend/src/features/Logbook/components/VesselLogbook/LogbookMessages/messages/utils.tsx
@@ -27,7 +27,7 @@ export function getDatetimeOrDash(dateTimeUtc?: string) {
   )
 }
 
-export function getCodeWithNameOrDash(code?: string, codeName?: string) {
+export function getCodeWithNameOrDash(code?: string | null, codeName?: string | null) {
   if (!code && !codeName) {
     return <NoValue>-</NoValue>
   }

diff --git a/...c/features/Logbook/components/VesselLogbook/LogbookSummary/summaries/DEPMessageResume.tsx b/...c/features/Logbook/components/VesselLogbook/LogbookSummary/summaries/DEPMessageResume.tsx
@@ -9,14 +9,14 @@ import { LogbookMessageResumeHeader } from '../LogbookMessageResumeHeader'
 import type { DEPMessageValue } from '../../../../Logbook.types'
 import type { Promisable } from 'type-fest'
 
-type DEPMessageResumeProps = {
+type DEPMessageResumeProps = Readonly<{
   depMessage: DEPMessageValue
   hasNoMessage?: boolean
   isDeleted: boolean
   isNotAcknowledged: boolean
   rejectionCause: string | undefined
   showLogbookMessages: (messageType: string) => Promisable<void>
-}
+}>
 export function DEPMessageResume({
   depMessage,
   hasNoMessage = false,
@@ -48,69 +48,67 @@ export function DEPMessageResume({
   )
 
   return (
-    <>
-      <Wrapper>
-        <LogbookMessageResumeHeader
-          hasNoMessage={hasNoMessage}
-          isDeleted={isDeleted}
-          isNotAcknowledged={isNotAcknowledged}
-          isOpen={isOpen}
-          messageType={LogbookMessageTypeEnum.DEP.code.toString()}
-          onHoverText={hasNoMessage ? null : getDEPMessageResumeTitleText()}
-          rejectionCause={rejectionCause}
-          setIsOpen={setIsOpen}
-          showLogbookMessages={showLogbookMessages}
-          title={hasNoMessage ? null : getDEPMessageResumeTitle()}
-        />
-        {!hasNoMessage && (
-          <LogbookMessageContent
-            $gearOnboard={depMessage.gearOnboard ? depMessage.gearOnboard.length : 1}
-            $isOpen={isOpen}
-            speciesOnboard={depMessage.speciesOnboard?.length > 0 ? depMessage.speciesOnboard.length : 1}
-          >
-            <Zone>
-              {depMessage.gearOnboard?.length ? (
-                depMessage.gearOnboard.map((gear, index) => (
-                  // eslint-disable-next-line react/no-array-index-key
-                  <Gear key={gear.gear + index}>
-                    <SubKey>Engin à bord {index + 1}</SubKey>{' '}
-                    <SubValue>{getCodeWithNameOrDash(gear.gear, gear.gearName)}</SubValue>
-                    <br />
-                    <SubKey>Maillage</SubKey>
-                    <SubValue>{gear.mesh ? <>{gear.mesh} mm</> : <NoValue>-</NoValue>}</SubValue>
-                    <SubKey>Dimensions</SubKey>
-                    <SubValue>{gear.dimensions ? <>{gear.dimensions} m</> : <NoValue>-</NoValue>}</SubValue>
-                    <br />
-                  </Gear>
-                ))
-              ) : (
-                <NoValue>Pas d&apos;engins à bord</NoValue>
-              )}
-              <Fields>
-                <TableBody>
-                  <Field>
-                    <Key>Captures à bord</Key>
-                    <Value>
-                      {depMessage.speciesOnboard?.length ? (
-                        depMessage.speciesOnboard.map(speciesCatch => (
-                          <span key={speciesCatch.species}>
-                            {getCodeWithNameOrDash(speciesCatch.species, speciesCatch.speciesName)}-{' '}
-                            {speciesCatch.weight} kg
-                            <br />
-                          </span>
-                        ))
-                      ) : (
-                        <NoValue>aucune</NoValue>
-                      )}
-                    </Value>
-                  </Field>
-                </TableBody>
-              </Fields>
-            </Zone>
-          </LogbookMessageContent>
-        )}
-      </Wrapper>
-    </>
+    <Wrapper>
+      <LogbookMessageResumeHeader
+        hasNoMessage={hasNoMessage}
+        isDeleted={isDeleted}
+        isNotAcknowledged={isNotAcknowledged}
+        isOpen={isOpen}
+        messageType={LogbookMessageTypeEnum.DEP.code.toString()}
+        onHoverText={hasNoMessage ? null : getDEPMessageResumeTitleText()}
+        rejectionCause={rejectionCause}
+        setIsOpen={setIsOpen}
+        showLogbookMessages={showLogbookMessages}
+        title={hasNoMessage ? null : getDEPMessageResumeTitle()}
+      />
+      {!hasNoMessage && (
+        <LogbookMessageContent
+          $gearOnboard={depMessage.gearOnboard ? depMessage.gearOnboard.length : 1}
+          $isOpen={isOpen}
+          speciesOnboard={depMessage.speciesOnboard?.length > 0 ? depMessage.speciesOnboard.length : 1}
+        >
+          <Zone>
+            {depMessage.gearOnboard?.length ? (
+              depMessage.gearOnboard.map((gear, index) => (
+                // eslint-disable-next-line react/no-array-index-key
+                <Gear key={`${gear.gear}-${index}`}>
+                  <SubKey>Engin à bord {index + 1}</SubKey>{' '}
+                  <SubValue>{getCodeWithNameOrDash(gear.gear, gear.gearName)}</SubValue>
+                  <br />
+                  <SubKey>Maillage</SubKey>
+                  <SubValue>{gear.mesh ? <>{gear.mesh} mm</> : <NoValue>-</NoValue>}</SubValue>
+                  <SubKey>Dimensions</SubKey>
+                  <SubValue>{gear.dimensions ? <>{gear.dimensions} m</> : <NoValue>-</NoValue>}</SubValue>
+                  <br />
+                </Gear>
+              ))
+            ) : (
+              <NoValue>Pas d&apos;engins à bord</NoValue>
+            )}
+            <Fields>
+              <TableBody>
+                <Field>
+                  <Key>Captures à bord</Key>
+                  <Value>
+                    {depMessage.speciesOnboard?.length ? (
+                      depMessage.speciesOnboard.map(speciesCatch => (
+                        <span key={speciesCatch.species}>
+                          {getCodeWithNameOrDash(speciesCatch.species, speciesCatch.speciesName)}- {speciesCatch.weight}{' '}
+                          kg
+                          <br />
+                        </span>
+                      ))
+                    ) : (
+                      <NoValue>aucune</NoValue>
+                    )}
+                  </Value>
+                </Field>
+              </TableBody>
+            </Fields>
+          </Zone>
+        </LogbookMessageContent>
+      )}
+    </Wrapper>
   )
 }
 

diff --git a/frontend/src/features/PriorNotification/PriorNotification.types.ts b/frontend/src/features/PriorNotification/PriorNotification.types.ts
@@ -15,7 +15,7 @@ export namespace PriorNotification {
     reportingsCount: number
     seaFront: SeaFront | undefined
     sentAt: string | undefined
-    tripGears: LogbookMessage.TripGear[]
+    tripGears: LogbookMessage.Gear[]
     tripSegments: LogbookMessage.TripSegment[]
     types: Type[]
     vesselExternalReferenceNumber: string | undefined