IMN-883 Add token-generation-readmodel-checker-verifier #1119
+4,782
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion-readmodel-checker-verifier
…tion-readmodel-checker-verifier
…tion-readmodel-checker-verifier
shuyec
changed the base branch from
IMN-521_authorization-server
to
IMN-787_token-details-persister
…eration-readmodel-checker-verifier
shuyec
commented
Oct 28, 2024
Comment on lines
25
to
28
| // TODO: is exit code needed here? | ||
| if (differencesCount > 0) { | ||
| process.exit(1); | ||
| } |
There was a problem hiding this comment.
Is process.exit(1) needed for the script?
There was a problem hiding this comment.
on a second thought, despite the differences found, here the job has been completed successfully, so we can remove the process.exit(1) and let the job exit normally
shuyec
commented
Oct 28, 2024
Comment on lines
+1037
to
+1038
| // TODO: are missing token entries considered errors or not? | ||
| if (!c || (c && (!a || b?.length === 0))) { |
There was a problem hiding this comment.
Are missing token-generation-states entries considered errors or not?
There was a problem hiding this comment.
yes, they are if the rows should exist.
For each client, we expect
- if the client does not contain keys, the number of records in token-generation-states should be zero
- if the client does not contain purposes, the number of records in token-generation-states should be equal to the number of keys in the client
- if the client contains purposes, the number of records in token-generation-states should be equal to the number of keys in the client multiplied by the number of purposes
shuyec
commented
Oct 28, 2024
Comment on lines
+1121
to
+1127
| // TODO: is this correct? | ||
| if (!tokenEntries || tokenEntries.length === 0) { | ||
| return { | ||
| status: true, | ||
| data: undefined, | ||
| }; | ||
| } |
There was a problem hiding this comment.
Same question as this.
shuyec
requested review from
beetlecrunch,
galales,
AsterITA,
Carminepo2 and
taglioni-r
as code owners
galales
reviewed
Oct 31, 2024
Comment on lines
25
to
28
| // TODO: is exit code needed here? | ||
| if (differencesCount > 0) { | ||
| process.exit(1); | ||
| } |
There was a problem hiding this comment.
on a second thought, despite the differences found, here the job has been completed successfully, so we can remove the process.exit(1) and let the job exit normally
| await tokenGenerationService.readAllTokenGenerationStatesItems(); | ||
| const tokenGenerationStatesClientPurposeEntries: TokenGenerationStatesClientPurposeEntry[] = | ||
| tokenGenerationStatesEntries | ||
| .map((e) => TokenGenerationStatesClientPurposeEntry.safeParse(e)) |
There was a problem hiding this comment.
do we check also API clients?
Comment on lines
458
to
460
| dataA: PlatformStatesPurposeEntry[], | ||
| dataB: TokenGenerationStatesClientPurposeEntry[], | ||
| dataC: Purpose[] |
There was a problem hiding this comment.
any reason to not use names like
Suggested change
| dataA: PlatformStatesPurposeEntry[], | |
| dataB: TokenGenerationStatesClientPurposeEntry[], | |
| dataC: Purpose[] | |
| platformStates: PlatformStatesPurposeEntry[], | |
| tokenStates: TokenGenerationStatesClientPurposeEntry[], | |
| purposes: Purpose[] |
?
Comment on lines
186
to
194
| function getIdentificationKey<T extends { PK: string } | { id: string }>( | ||
| obj: T | ||
| ): string { | ||
| if ("PK" in obj) { | ||
| return unsafeBrandId(obj.PK.split("#")[1]); | ||
| } else { | ||
| return obj.id; | ||
| } | ||
| } |
There was a problem hiding this comment.
this is a bit over engineered, I suggest
Suggested change
| function getIdentificationKey<T extends { PK: string } | { id: string }>( | |
| obj: T | |
| ): string { | |
| if ("PK" in obj) { | |
| return unsafeBrandId(obj.PK.split("#")[1]); | |
| } else { | |
| return obj.id; | |
| } | |
| } | |
| function getIdFromPrimaryKey( | |
| record: PlatformStatesBaseEntry | |
| ): string { | |
| return unsafeBrandId(record.PK.split("#")[1]); | |
| } |
and just access directly the field when you need the id.
Comment on lines
+233
to
+258
| const parsedPurpose = PlatformStatesPurposeEntry.safeParse(e); | ||
| if (parsedPurpose.success) { | ||
| // eslint-disable-next-line functional/immutable-data | ||
| acc.platformPurposeEntries.push(parsedPurpose.data); | ||
| } else { | ||
| const parsedAgreement = PlatformStatesAgreementEntry.safeParse(e); | ||
| if (parsedAgreement.success) { | ||
| // eslint-disable-next-line functional/immutable-data | ||
| acc.platformAgreementEntries.push(parsedAgreement.data); | ||
| } else { | ||
| const parsedCatalog = PlatformStatesCatalogEntry.safeParse(e); | ||
| if (parsedCatalog.success) { | ||
| // eslint-disable-next-line functional/immutable-data | ||
| acc.platformCatalogEntries.push(parsedCatalog.data); | ||
| } else { | ||
| const parsedClient = PlatformStatesClientEntry.safeParse(e); | ||
| if (parsedClient.success) { | ||
| // eslint-disable-next-line functional/immutable-data | ||
| acc.platformClientEntries.push(parsedClient.data); | ||
| } else { | ||
| throw genericInternalError("Unknown platform-states type"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return acc; |
There was a problem hiding this comment.
same code, just generally more readable and without mutable data
Suggested change
| const parsedPurpose = PlatformStatesPurposeEntry.safeParse(e); | |
| if (parsedPurpose.success) { | |
| // eslint-disable-next-line functional/immutable-data | |
| acc.platformPurposeEntries.push(parsedPurpose.data); | |
| } else { | |
| const parsedAgreement = PlatformStatesAgreementEntry.safeParse(e); | |
| if (parsedAgreement.success) { | |
| // eslint-disable-next-line functional/immutable-data | |
| acc.platformAgreementEntries.push(parsedAgreement.data); | |
| } else { | |
| const parsedCatalog = PlatformStatesCatalogEntry.safeParse(e); | |
| if (parsedCatalog.success) { | |
| // eslint-disable-next-line functional/immutable-data | |
| acc.platformCatalogEntries.push(parsedCatalog.data); | |
| } else { | |
| const parsedClient = PlatformStatesClientEntry.safeParse(e); | |
| if (parsedClient.success) { | |
| // eslint-disable-next-line functional/immutable-data | |
| acc.platformClientEntries.push(parsedClient.data); | |
| } else { | |
| throw genericInternalError("Unknown platform-states type"); | |
| } | |
| } | |
| } | |
| } | |
| return acc; | |
| const parsedPurpose = PlatformStatesPurposeEntry.safeParse(e); | |
| if (parsedPurpose.success) { | |
| return { | |
| ...acc, | |
| platformPurposeEntries: [...acc.platformPurposeEntries, parsedPurpose.data] | |
| }; | |
| } | |
| const parsedAgreement = PlatformStatesAgreementEntry.safeParse(e); | |
| if (parsedAgreement.success) { | |
| return { | |
| ...acc, | |
| platformAgreementEntries: [...acc.platformAgreementEntries, parsedAgreement.data] | |
| }; | |
| } | |
| // Same for others | |
| throw genericInternalError("Unknown platform-states type"); |
| }; | ||
| } | ||
|
|
||
| const foundEntries = tokenEntries.filter( |
There was a problem hiding this comment.
I may have misunderstood, but isn't this evaluating as error a valid record in token generation states that has a different purpose than the current one?
| ); | ||
| } else { | ||
| throw genericInternalError( | ||
| "Unexpected error while counting purpose differences" |
There was a problem hiding this comment.
let's add more details to the error
| @@ -34,6 +34,7 @@ | |||
| "start:one-trust-notices": "turbo start --filter pagopa-interop-one-trust-notices", | |||
| "start:datalake-data-export": "turbo start --filter pagopa-interop-datalake-data-export", | |||
| "start:authorization-server": "turbo start --filter pagopa-interop-authorization-server", | |||
| "start:token-generation-readmodel-checker-verifier": "turbo start --filter pagopa-interop-token-generation-readmodel-checker-verifier", | |||
There was a problem hiding this comment.
may we rename the package to token-generation-readmodel-checker 🙏
(having both checker and verifier it's redundant)
There was a problem hiding this comment.
note: comments on purpose logics apply also to the orthers
Comment on lines
+1037
to
+1038
| // TODO: are missing token entries considered errors or not? | ||
| if (!c || (c && (!a || b?.length === 0))) { |
There was a problem hiding this comment.
yes, they are if the rows should exist.
For each client, we expect
- if the client does not contain keys, the number of records in token-generation-states should be zero
- if the client does not contain purposes, the number of records in token-generation-states should be equal to the number of keys in the client
- if the client contains purposes, the number of records in token-generation-states should be equal to the number of keys in the client multiplied by the number of purposes
…eration-readmodel-checker-verifier
…eration-readmodel-checker-verifier
…ttps://github.com/pagopa/interop-be-monorepo into IMN-883_token-generation-readmodel-checker-verifier
…eration-readmodel-checker-verifier
…eration-readmodel-checker-verifier
…eration-readmodel-checker-verifier
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes IMN-583
Merge after #1094
Added the
token-generation-readmodel-checker-verifierpackage to compare thetoken generation read modelwith theread model.