Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Forslag til standard på require og check #6643

Merged
merged 3 commits into from
Dec 18, 2024

Conversation

Watercolours
Copy link
Contributor

@Watercolours Watercolours commented Dec 17, 2024

Forslag til endret standard på "preconditions" (forutsetninger...?)

Litt endring i navnestandard her for å få et konsekvente og enklere navn på funksjonene.

Forslaget bygger videre på dagens løsning:
libs/saksbehandling-common/src/main/kotlin/feilhaandtering/Utils.kt (fra PR-ene #6297 og #6307)

Nytt forslag:
libs/saksbehandling-common/src/main/kotlin/feilhaandtering/Preconditions.kt


krev og krevIkkeNull

Skal erstatte require og requireNotNull.
krev er noe som er påkrevd av systemet, og kaster derfor InternfeilException.

sjekk og sjekkIkkeNull

Skal erstatte check og checkNotNull
sjekk er tiltenkt å bare sjekke at en tilstand er gyldig. Eks. noe saksbehandler selv kan korrigere. Derfor kaster denne UgyldigForespoerselException

Synes ikke det er hensiktsmessig å sende med code siden vi i 99% av tilfellene ikke bryr oss om den. Dersom code er nødvendig kan man heller kaste UgyldigForespoerselException "manuelt". Har derfor fjernet dette som en mulighet i forslaget.

@Watercolours Watercolours requested a review from a team as a code owner December 17, 2024 11:41
@Watercolours Watercolours changed the title Forslag til standard paa require og check Forslag til standard på require og check Dec 17, 2024
@@ -0,0 +1,63 @@
package no.nav.etterlatte.libs.common.feilhaandtering
Copy link
Contributor

@sebassonav sebassonav Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jeg tar det gjerne på engelsk jeg egentlig, men liker dokumentasjonen her.
Mitt største problem med at det er norske funksjonsnavn er at det fort blandes med domeneting.

Skal det først være på norsk burde vel filnavnet her være på norsk og?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hvis du har et godt alternativ til Preconditions er det bare å skrike ut! Jeg kalte det Preconditions for å tydeliggjøre at det skal erstatte kotlin.Preconditions, men er åpen for alternativer.

Jeg synes direkte oversatte funksjonsnavn gjør det lettere å "kopiere" formatet uten å ha masse rare pre-/suffiks på alt. Hvis vi skal ha det på engelsk burde vi i så fall bli enige om et mønster som gir mening, uten at vi ender opp med navn som checkNotNullKastUgyldigForespoerselException

Copy link
Contributor

@henrikg henrikg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tror det er lurt å få inn dette slik at vi blir konsistent på hvordan disse tingene håndteres. Navn og slike ting kan jo alltids endres i ettertid om vi ikke er happy med dem 👍

…dling into forslag-til-standard-paa-require-og-check
@Watercolours Watercolours merged commit 58fe4db into main Dec 18, 2024
19 checks passed
@Watercolours Watercolours deleted the forslag-til-standard-paa-require-og-check branch December 18, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants