graphql-engine/server/src-lib/Hasura/Server/Version.hs
Auke Booij 99f7a0fb87 Amend console assets versioning scheme for CE
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5628
GitOrigin-RevId: 550cc987a7142f46f4c380d8217fe6ad8ce53fe9
2022-08-26 12:39:16 +00:00

102 lines
3.6 KiB
Haskell

{-# LANGUAGE TemplateHaskell #-}
module Hasura.Server.Version
( Version (..),
currentVersion,
consoleAssetsVersion,
versionToAssetsVersion,
)
where
import Control.Exception
import Control.Lens ((^.), (^?))
import Data.Aeson (FromJSON (..), ToJSON (..))
import Data.FileEmbed (makeRelativeToProject)
import Data.SemVer qualified as V
import Data.Text qualified as T
import Data.Text.Conversions (FromText (..), ToText (..))
import Hasura.Prelude
import Language.Haskell.TH
import Language.Haskell.TH.Syntax
import Text.Regex.TDFA ((=~~))
data Version
= VersionDev Text
| VersionRelease V.Version
| VersionCE Text
deriving (Show, Eq)
instance ToText Version where
toText = \case
VersionDev txt -> txt
VersionRelease version -> "v" <> V.toText version
VersionCE txt -> txt
instance FromText Version where
-- Ensure that a -ce suffix is *not* interpreted as the release type of a
-- Data.SemVer-style semantic version
fromText txt | T.takeEnd 3 txt == "-ce" = VersionCE txt
fromText txt = case V.fromText $ T.dropWhile (== 'v') txt of
Left _ -> VersionDev txt
Right version -> VersionRelease version
instance ToJSON Version where
toJSON = toJSON . toText
instance FromJSON Version where
parseJSON = fmap fromText . parseJSON
currentVersion :: Version
currentVersion =
fromText $
T.dropWhileEnd (== '\n') $
T.pack $
-- NOTE: This must work correctly in the presence of a caching! See
-- graphql-engine.cabal (search for “CURRENT_VERSION”) for details
-- about our approach here. We could use embedFile but want a nice
-- error message
$( do
versionFileName <- makeRelativeToProject "CURRENT_VERSION"
addDependentFile versionFileName
let noFileErr =
"\n==========================================================================="
<> "\n>>> DEAR HASURIAN: The way we bake versions into the server has "
<> "\n>>> changed; You'll need to run the following once in your repo to proceed: "
<> "\n>>> $ echo 12345 > \"$(git rev-parse --show-toplevel)/server/CURRENT_VERSION\""
<> "\n===========================================================================\n"
runIO (readFile versionFileName `onException` error noFileErr) >>= stringE
)
versionToAssetsVersion :: Version -> Text
versionToAssetsVersion = \case
VersionDev txt -> "versioned/" <> txt
VersionRelease v -> case getReleaseChannel v of
Nothing -> "versioned/" <> vMajMin
Just c -> "channel/" <> c <> "/" <> vMajMin
where
vMajMin = T.pack ("v" <> show (v ^. V.major) <> "." <> show (v ^. V.minor))
VersionCE txt -> "channel/versioned/" <> txt
where
getReleaseChannel :: V.Version -> Maybe Text
getReleaseChannel sv = case sv ^. V.release of
[] -> Just "stable"
(mr : _) -> case getTextFromId mr of
Nothing -> Nothing
Just r ->
if
| T.null r -> Nothing
| otherwise -> T.pack <$> getChannelFromPreRelease (T.unpack r)
getChannelFromPreRelease :: String -> Maybe String
getChannelFromPreRelease sv = sv =~~ ("^([a-z]+)" :: String)
getTextFromId :: V.Identifier -> Maybe Text
getTextFromId i = Just i ^? (toTextualM . V._Textual)
where
toTextualM _ Nothing = pure Nothing
toTextualM f (Just a) = f a
-- | A version-based string used to form the CDN URL for fetching console assets.
consoleAssetsVersion :: Text
consoleAssetsVersion = versionToAssetsVersion currentVersion