Skip to content

[REFACTORING] ID tag expand abbreviation to full name #2991

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.

Sign up for GitHub

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

Merged
battermann merged 4 commits into from
Jan 17, 2023
Merged

[REFACTORING] ID tag expand abbreviation to full name #2991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c9ea82
readable id tags
battermann Jan 16, 2023
9cacb3a
changelog
battermann Jan 16, 2023
53815d5
wip
battermann Jan 16, 2023
579fef9
hi ci
battermann Jan 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/5-internal/pr-2991
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make ID tags more readable by expanding abbreviations to full names.
58 changes: 33 additions & 25 deletions libs/types-common/src/Data/Id.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,54 +87,62 @@ import Servant (FromHttpApiData (..), ToHttpApiData (..))
import Test.QuickCheck
import Test.QuickCheck.Instances ()

data IdTag = A | C | I | U | P | S | T | STo
data IdTag
= Asset
| Conversation
| Invitation
| User
| Provider
| Service
| Team
| ScimToken

idTagName :: IdTag -> Text
idTagName A = "Asset"
idTagName C = "Conv"
idTagName I = "Invitation"
idTagName U = "User"
idTagName P = "Provider"
idTagName S = "Service"
idTagName T = "Team"
idTagName STo = "ScimToken"
idTagName Asset = "Asset"
idTagName Conversation = "Conv"
idTagName Invitation = "Invitation"
idTagName User = "User"
idTagName Provider = "Provider"
idTagName Service = "Service"
idTagName Team = "Team"
idTagName ScimToken = "ScimToken"

class KnownIdTag (t :: IdTag) where
idTagValue :: IdTag

instance KnownIdTag 'A where idTagValue = A
instance KnownIdTag 'Asset where idTagValue = Asset

instance KnownIdTag 'C where idTagValue = C
instance KnownIdTag 'Conversation where idTagValue = Conversation

instance KnownIdTag 'I where idTagValue = I
instance KnownIdTag 'Invitation where idTagValue = Invitation

instance KnownIdTag 'U where idTagValue = U
instance KnownIdTag 'User where idTagValue = User

instance KnownIdTag 'P where idTagValue = P
instance KnownIdTag 'Provider where idTagValue = Provider

instance KnownIdTag 'S where idTagValue = S
instance KnownIdTag 'Service where idTagValue = Service

instance KnownIdTag 'T where idTagValue = T
instance KnownIdTag 'Team where idTagValue = Team

instance KnownIdTag 'STo where idTagValue = STo
instance KnownIdTag 'ScimToken where idTagValue = ScimToken

type AssetId = Id 'A
type AssetId = Id 'Asset

type InvitationId = Id 'I
type InvitationId = Id 'Invitation

-- | A local conversation ID
type ConvId = Id 'C
type ConvId = Id 'Conversation

-- | A local user ID
type UserId = Id 'U
type UserId = Id 'User

type ProviderId = Id 'P
type ProviderId = Id 'Provider

type ServiceId = Id 'S
type ServiceId = Id 'Service

type TeamId = Id 'T
type TeamId = Id 'Team

type ScimTokenId = Id 'STo
type ScimTokenId = Id 'ScimToken

-- Id -------------------------------------------------------------------------

Expand Down