Switch from id to uuid in locale

Author: vknaisl

registry-public/src/RegistryLib/Api/Resource/Locale/LocaleDTO.hs

@@ -1,12 +1,13 @@
 module RegistryLib.Api.Resource.Locale.LocaleDTO where
 
 import Data.Time
+import qualified Data.UUID as U
 import GHC.Generics
 
 import RegistryLib.Model.Organization.OrganizationSimple
 
 data LocaleDTO = LocaleDTO
-  { lId :: String
+  { uuid :: U.UUID
   , name :: String
   , description :: String
   , code :: String

registry-server/src/Registry/Api/Handler/Locale/Detail_Bundle_GET.hs

@@ -10,22 +10,24 @@ import Registry.Model.Context.BaseContext
 import Registry.Service.Locale.Bundle.LocaleBundleService
 import Shared.Common.Api.Handler.Common
 import Shared.Common.Model.Context.TransactionState
+import Shared.Coordinate.Api.Resource.Coordinate.CoordinateJM ()
+import Shared.Coordinate.Model.Coordinate.Coordinate
 
 type Detail_Bundle_GET =
   Header "Authorization" String
     :> "locales"
-    :> Capture "documentTemplateId" String
+    :> Capture "id" Coordinate
     :> "bundle"
     :> Get '[OctetStream] (Headers '[Header "x-trace-uuid" String, Header "Content-Disposition" String] FileStreamLazy)
 
 detail_bundle_GET
   :: Maybe String
-  -> String
+  -> Coordinate
   -> BaseContextM (Headers '[Header "x-trace-uuid" String, Header "Content-Disposition" String] FileStreamLazy)
-detail_bundle_GET mTokenHeader tmlId =
+detail_bundle_GET mTokenHeader coordinate =
   getAuthServiceExecutor mTokenHeader $ \runInAuthService ->
     runInAuthService NoTransaction $ do
-      zipFile <- exportBundle tmlId
+      zipFile <- exportBundle coordinate
       let cdHeader = "attachment;filename=\"locale.zip\""
       traceUuid <- asks traceUuid
       return . addHeader (U.toString traceUuid) . addHeader cdHeader . FileStreamLazy $ zipFile

registry-server/src/Registry/Api/Handler/Locale/Detail_GET.hs

@@ -10,11 +10,13 @@ import Registry.Model.Context.ContextLenses ()
 import Registry.Service.Locale.LocaleService
 import Shared.Common.Api.Handler.Common
 import Shared.Common.Model.Context.TransactionState
+import Shared.Coordinate.Api.Resource.Coordinate.CoordinateJM ()
+import Shared.Coordinate.Model.Coordinate.Coordinate
 
 type Detail_GET =
   "locales"
-    :> Capture "documentTemplateId" String
+    :> Capture "id" Coordinate
     :> Get '[SafeJSON] (Headers '[Header "x-trace-uuid" String] LocaleDetailDTO)
 
-detail_GET :: String -> BaseContextM (Headers '[Header "x-trace-uuid" String] LocaleDetailDTO)
-detail_GET tmlId = runInUnauthService NoTransaction $ addTraceUuidHeader =<< getLocaleById tmlId
+detail_GET :: Coordinate -> BaseContextM (Headers '[Header "x-trace-uuid" String] LocaleDetailDTO)
+detail_GET coordinate = runInUnauthService NoTransaction $ addTraceUuidHeader =<< getLocaleByCoordinate coordinate

registry-server/src/Registry/Api/Handler/Swagger/Api.hs

@@ -24,6 +24,7 @@ import Shared.Common.Api.Resource.Common.FileSM ()
 import Shared.Common.Api.Resource.Common.SemVer2TupleSM ()
 import Shared.Common.Api.Resource.Info.InfoSM ()
 import Shared.Component.Api.Resource.Component.ComponentSM ()
+import Shared.Coordinate.Api.Resource.Coordinate.CoordinateSM ()
 import Shared.DocumentTemplate.Api.Resource.DocumentTemplate.DocumentTemplateSM ()
 import Shared.DocumentTemplate.Api.Resource.DocumentTemplateBundle.DocumentTemplateBundleSM ()
 import Shared.KnowledgeModel.Api.Resource.KnowledgeModel.Bundle.KnowledgeModelBundlePackageSM ()

registry-server/src/Registry/Api/Resource/Locale/LocaleDTO.hs

@@ -1,12 +1,13 @@
 module Registry.Api.Resource.Locale.LocaleDTO where
 
 import Data.Time
+import qualified Data.UUID as U
 import GHC.Generics
 
 import RegistryLib.Model.Organization.OrganizationSimple
 
 data LocaleDTO = LocaleDTO
-  { lId :: String
+  { uuid :: U.UUID
   , name :: String
   , description :: String
   , code :: String

registry-server/src/Registry/Api/Resource/Locale/LocaleDetailDTO.hs

@@ -1,12 +1,13 @@
 module Registry.Api.Resource.Locale.LocaleDetailDTO where
 
 import Data.Time
+import qualified Data.UUID as U
 import GHC.Generics
 
 import RegistryLib.Model.Organization.OrganizationSimple
 
 data LocaleDetailDTO = LocaleDetailDTO
-  { lId :: String
+  { uuid :: U.UUID
   , name :: String
   , description :: String
   , code :: String

registry-server/src/Registry/Database/Migration/Development/Locale/LocaleMigration.hs

@@ -17,6 +17,6 @@ runMigration = do
 
 runS3Migration :: AppContextM ()
 runS3Migration = do
-  _ <- putLocale localeNl.lId "wizard.json" localeNlContent
-  _ <- putLocale localeNl.lId "mail.po" localeNlContent
+  _ <- putLocale localeNl.uuid "wizard.json" localeNlContent
+  _ <- putLocale localeNl.uuid "mail.po" localeNlContent
   return ()

registry-server/src/Registry/Database/Migration/Development/Locale/LocaleSchemaMigration.hs

@@ -21,7 +21,7 @@ createTables = do
   let sql =
         "CREATE TABLE locale \
         \( \
-        \    id                      varchar     NOT NULL, \
+        \    uuid                    uuid        NOT NULL, \
         \    name                    varchar     NOT NULL, \
         \    description             varchar     NOT NULL, \
         \    code                    varchar     NOT NULL, \
@@ -36,9 +36,9 @@ createTables = do
         \    tenant_uuid             uuid        NOT NULL, \
         \    created_at              timestamptz NOT NULL, \
         \    updated_at              timestamptz NOT NULL, \
-        \    CONSTRAINT locale_pk PRIMARY KEY (id) \
+        \    CONSTRAINT locale_pk PRIMARY KEY (uuid) \
         \); \
         \ \
-        \CREATE UNIQUE INDEX locale_uuid_uindex ON locale (id);"
+        \CREATE UNIQUE INDEX locale_organization_id_locale_id_version_uindex ON locale (organization_id, locale_id, version);"
   let action conn = execute_ conn sql
   runDB action

registry-server/src/Registry/Database/Migration/Production/Migration.hs

@@ -18,6 +18,7 @@ import qualified Registry.Database.Migration.Production.Migration_0013_jsonb.Mig
 import qualified Registry.Database.Migration.Production.Migration_0014_documentTemplateMetamodel.Migration as M_0014
 import qualified Registry.Database.Migration.Production.Migration_0015_knowledgeModelRefactor.Migration as M_0015
 import qualified Registry.Database.Migration.Production.Migration_0016_project.Migration as M_0016
+import qualified Registry.Database.Migration.Production.Migration_0017_locale.Migration as M_0017
 
 migrationDefinitions :: [MigrationDefinition]
 migrationDefinitions =
@@ -37,4 +38,5 @@ migrationDefinitions =
   , M_0014.definition
   , M_0015.definition
   , M_0016.definition
+  , M_0017.definition
   ]

registry-server/src/Registry/Database/Migration/Production/Migration_0017_locale/Migration.hs

@@ -0,0 +1,26 @@
+module Registry.Database.Migration.Production.Migration_0017_locale.Migration (
+  definition,
+) where
+
+import Control.Monad.Logger
+import Control.Monad.Reader (liftIO)
+import Data.Pool (Pool, withResource)
+import Database.PostgreSQL.Migration.Entity
+import Database.PostgreSQL.Simple
+
+definition = (meta, migrate)
+
+meta = MigrationMeta {mmNumber = 17, mmName = "Locale Refactor", mmDescription = "Switch from id to uuid"}
+
+migrate :: Pool Connection -> LoggingT IO (Maybe Error)
+migrate dbPool = do
+  let sql =
+        "DROP INDEX locale_uuid_uindex; \
+        \ALTER TABLE locale DROP CONSTRAINT locale_pk; \
+        \ALTER TABLE locale RENAME COLUMN id TO uuid; \
+        \ALTER TABLE locale ALTER COLUMN uuid TYPE uuid USING gen_random_uuid(); \
+        \ALTER TABLE locale ADD CONSTRAINT locale_pk PRIMARY KEY (uuid); \
+        \CREATE UNIQUE INDEX locale_organization_id_locale_id_version_uindex ON locale (organization_id, locale_id, version);"
+  let action conn = execute_ conn sql
+  liftIO $ withResource dbPool action
+  return Nothing