Configure asset version using FrameworkConfig

The previous approach evaluated two env vars on every web request which is not efficient

IHP/Assets/ViewFunctions.hs

@@ -5,19 +5,34 @@ Copyright: (c) digitally induced GmbH, 2021
 -}
 module IHP.Assets.ViewFunctions
 ( assetPath
+, assetVersion
 ) where
 
 import IHP.Prelude
 import IHP.Assets.Types
 import IHP.Controller.Context
+import qualified IHP.FrameworkConfig as Config
 
 -- | Adds a cache buster to a asset path
 --
 -- >>> assetPath "/keyhandlers.js"
 -- "/keyhandlers.js?v=9be8995c-7055-43d9-a1b2-43e05c210271"
 --
+-- The asset version can be configured using the
+-- @IHP_ASSET_VERSION@ environment variable.
 assetPath :: (?context :: ControllerContext) => Text -> Text
 assetPath assetPath = assetPath <> "?v=" <> assetVersion
- where
- (AssetVersion assetVersion) = fromFrozenContext @AssetVersion
-{-# INLINABLE assetPath #-}
+{-# INLINABLE assetPath #-}
+
+-- | Returns the assetVersion
+--
+-- >>> assetVersion
+-- "9be8995c-7055-43d9-a1b2-43e05c210271"
+--
+-- The asset version can be configured using the
+-- @IHP_ASSET_VERSION@ environment variable.
+assetVersion :: (?context :: ControllerContext) => Text
+assetVersion = ?context
+ |> Config.getFrameworkConfig
+ |> get #assetVersion
+{-# INLINABLE assetVersion #-}

IHP/ControllerPrelude.hs

@@ -31,7 +31,6 @@ module IHP.ControllerPrelude
  , Only (..)
  , module IHP.PageHead.ControllerFunctions
  , module IHP.WebSocket
- , module IHP.Assets.ControllerFunctions
  , module IHP.FileStorage.Types
  , module IHP.FileStorage.ControllerFunctions
  , module IHP.FileStorage.Preprocessor.ImageMagick
@@ -75,7 +74,6 @@ import IHP.LoginSupport.Helper.Controller
 import IHP.PageHead.ControllerFunctions
 
 import IHP.WebSocket
-import IHP.Assets.ControllerFunctions
 
 import IHP.FileStorage.Types
 import IHP.FileStorage.ControllerFunctions

IHP/ControllerSupport.hs

@@ -51,7 +51,6 @@ import qualified Data.Aeson as Aeson
 import qualified Network.Wai.Handler.WebSockets as WebSockets
 import qualified Network.WebSockets as WebSockets
 import qualified IHP.WebSocket as WebSockets
-import qualified IHP.Assets.ControllerFunctions as Assets
 
 type Action' = IO ResponseReceived
 
@@ -90,7 +89,6 @@ runActionWithNewContext controller = do
  let ?context = controllerContext
  Context.putContext ?application
  Context.putContext (Context.ActionType (Typeable.typeOf controller))
- Assets.initAssetVersion
 
  try (initContext @application) >>= \case
  Left exception -> do

IHP/FrameworkConfig.hs

@@ -68,6 +68,8 @@ newtype IdeBaseUrl = IdeBaseUrl Text
 -- | Postgres role to be used for making queries with Row level security enabled
 newtype RLSAuthenticatedRole = RLSAuthenticatedRole Text
 
+newtype AssetVersion = AssetVersion Text
+
 -- | Puts an option into the current configuration
 --
 -- In case an option already exists with the same type, it will not be overriden:
@@ -154,9 +156,18 @@ ihpDefaultConfig = do
  rlsAuthenticatedRole <- fromMaybe "ihp_authenticated" <$> liftIO (Environment.lookupEnv "IHP_RLS_AUTHENTICATED_ROLE")
  option $ RLSAuthenticatedRole (cs rlsAuthenticatedRole)
 
-
 {-# INLINABLE ihpDefaultConfig #-}
 
+initAssetVersion :: ConfigBuilder
+initAssetVersion = do
+ ihpCloudContainerId <- fmap cs <$> liftIO (Environment.lookupEnv "IHP_CLOUD_CONTAINER_ID")
+ ihpAssetVersion <- fmap cs <$> liftIO (Environment.lookupEnv "IHP_ASSET_VERSION")
+ let assetVersion = [ ihpCloudContainerId, ihpAssetVersion]
+ |> catMaybes
+ |> head
+ |> fromMaybe "dev"
+ option (AssetVersion assetVersion)
+
 findOption :: forall option. Typeable option => State.StateT TMap.TMap IO option
 findOption = fromMaybe (error optionNotFoundErrorMessage) <$> findOptionOrNothing @option
  where
@@ -191,6 +202,7 @@ buildFrameworkConfig appConfig = do
  parseRequestBodyOptions <- findOption @WaiParse.ParseRequestBodyOptions
  (IdeBaseUrl ideBaseUrl) <- findOption @IdeBaseUrl
  (RLSAuthenticatedRole rlsAuthenticatedRole) <- findOption @RLSAuthenticatedRole
+ (AssetVersion assetVersion) <- findOption @AssetVersion
 
  appConfig <- State.get
 
@@ -337,6 +349,19 @@ data FrameworkConfig = FrameworkConfig
 
  -- | See IHP.DataSync.Role
  , rlsAuthenticatedRole :: Text
+
+ -- | The asset version is used for cache busting
+ --
+ -- On IHP Cloud IHP automatically uses the @IHP_CLOUD_CONTAINER_ID@ env variable
+ -- as the asset version. So when running there, you don't need to do anything.
+ --
+ -- If you deploy IHP on your own, you should provide the IHP_ASSET_VERSION
+ -- env variable with e.g. the git commit hash of the production build.
+ --
+ -- If IHP cannot figure out an asset version, it will fallback to the static
+ -- string @"dev"@.
+ --
+ , assetVersion :: Text
 }
 
 class ConfigProvider a where

IHP/IDE/ToolServer.hs

@@ -41,7 +41,6 @@ import IHP.Controller.Layout
 import qualified IHP.LibDir as LibDir
 import qualified IHP.IDE.LiveReloadNotificationServer as LiveReloadNotificationServer
 import qualified IHP.Version as Version
-import qualified IHP.Assets.Types as Assets
 
 startToolServer :: (?context :: Context) => IO ()
 startToolServer = do
@@ -140,5 +139,3 @@ instance ControllerSupport.InitControllerContext ToolServerApplication where
  putContext webControllers
  putContext (AppUrl appUrl)
  setLayout Layout.toolServerLayout
-
- putContext (Assets.AssetVersion Version.ihpVersion)

ihp.cabal

@@ -265,7 +265,6 @@ library
  , IHP.PageHead.Types
  , IHP.PageHead.ViewFunctions
  , IHP.Assets.Types
- , IHP.Assets.ControllerFunctions
  , IHP.Assets.ViewFunctions
  -- Server Side Component Modules
  , IHP.ServerSideComponent.Types