elm-pages 3.0.0-beta.0 → 3.0.0-beta.10

package/src/Pages/Internal/NotFoundReason.elm

@@ -44,11 +44,11 @@ type NotFoundReason
 document :
     List RoutePattern
     -> Payload
-    -> { title : String, body : Html msg }
+    -> { title : String, body : List (Html msg) }
 document pathPatterns payload =
     { title = "Page not found"
     , body =
-        Html.div
+        [ Html.div
             [ Attr.id "not-found-reason"
             , Attr.style "padding" "30px"
             ]
@@ -110,6 +110,7 @@ document pathPatterns payload =
                     , Html.text <| "TODO"
                     ]
             )
+        ]
     }
 
 

package/src/Pages/Internal/Platform/Cli.elm

@@ -1,8 +1,8 @@
-module Pages.Internal.Platform.Cli exposing (Flags, Model, Msg(..), Program, cliApplication, init, requestDecoder, update)
+module Pages.Internal.Platform.Cli exposing (Flags, Model, Msg(..), Program, cliApplication, init, requestDecoder, update, currentCompatibilityKey)
 
 {-| Exposed for internal use only (used in generated code).
 
-@docs Flags, Model, Msg, Program, cliApplication, init, requestDecoder, update
+@docs Flags, Model, Msg, Program, cliApplication, init, requestDecoder, update, currentCompatibilityKey
 
 -}
 
@@ -23,6 +23,7 @@ import PageServerResponse exposing (PageServerResponse)
 import Pages.Flags
 import Pages.Http
 import Pages.Internal.NotFoundReason as NotFoundReason exposing (NotFoundReason)
+import Pages.Internal.Platform.CompatibilityKey
 import Pages.Internal.Platform.Effect as Effect exposing (Effect)
 import Pages.Internal.Platform.StaticResponses as StaticResponses exposing (StaticResponses)
 import Pages.Internal.Platform.ToJsPayload as ToJsPayload
@@ -46,6 +47,12 @@ type alias Flags =
     Decode.Value
 
 
+{-| -}
+currentCompatibilityKey : Int
+currentCompatibilityKey =
+    Pages.Internal.Platform.CompatibilityKey.currentCompatibilityKey
+
+
 {-| -}
 type alias Model route =
     { staticResponses : StaticResponses
@@ -336,12 +343,14 @@ flagsDecoder :
     Decode.Decoder
         { staticHttpCache : RequestsAndPending
         , isDevServer : Bool
+        , compatibilityKey : Int
         }
 flagsDecoder =
-    Decode.map2
-        (\staticHttpCache isDevServer ->
+    Decode.map3
+        (\staticHttpCache isDevServer compatibilityKey ->
             { staticHttpCache = staticHttpCache
             , isDevServer = isDevServer
+            , compatibilityKey = compatibilityKey
             }
         )
         --(Decode.field "staticHttpCache"
@@ -354,6 +363,7 @@ flagsDecoder =
         -- TODO remove hardcoding and decode staticHttpCache here
         (Decode.succeed Dict.empty)
         (Decode.field "mode" Decode.string |> Decode.map (\mode -> mode == "dev-server"))
+        (Decode.field "compatibilityKey" Decode.int)
 
 
 {-| -}
@@ -365,8 +375,42 @@ init :
     -> ( Model route, Effect )
 init site renderRequest config flags =
     case Decode.decodeValue flagsDecoder flags of
-        Ok { staticHttpCache, isDevServer } ->
-            initLegacy site renderRequest { staticHttpCache = staticHttpCache, isDevServer = isDevServer } config
+        Ok { staticHttpCache, isDevServer, compatibilityKey } ->
+            if compatibilityKey == currentCompatibilityKey then
+                initLegacy site renderRequest { staticHttpCache = staticHttpCache, isDevServer = isDevServer } config
+
+            else
+                let
+                    elmPackageAheadOfNpmPackage : Bool
+                    elmPackageAheadOfNpmPackage =
+                        currentCompatibilityKey > compatibilityKey
+
+                    message : String
+                    message =
+                        "The NPM package and Elm package you have installed are incompatible. If you are updating versions, be sure to update both the elm-pages Elm and NPM package.\n\n"
+                            ++ (if elmPackageAheadOfNpmPackage then
+                                    "The elm-pages Elm package is ahead of the elm-pages NPM package. Try updating the elm-pages NPM package?"
+
+                                else
+                                    "The elm-pages NPM package is ahead of the elm-pages Elm package. Try updating the elm-pages Elm package?"
+                               )
+                in
+                updateAndSendPortIfDone
+                    site
+                    config
+                    { staticResponses = StaticResponses.empty
+                    , errors =
+                        [ { title = "Incompatible NPM and Elm package versions"
+                          , message = [ Terminal.text <| message ]
+                          , fatal = True
+                          , path = ""
+                          }
+                        ]
+                    , allRawResponses = Dict.empty
+                    , unprocessedPages = []
+                    , maybeRequestJson = renderRequest
+                    , isDevServer = False
+                    }
 
         Err error ->
             updateAndSendPortIfDone
@@ -829,13 +873,13 @@ sendSinglePageProgress site contentJson config model info =
                                                             )
                                                             |> Tuple.first
 
-                                                    viewValue : { title : String, body : Html (Pages.Msg.Msg userMsg) }
+                                                    viewValue : { title : String, body : List (Html (Pages.Msg.Msg userMsg)) }
                                                     viewValue =
                                                         (config.view Dict.empty Dict.empty Nothing currentPage Nothing sharedData pageData maybeActionData |> .view) pageModel
                                                 in
                                                 PageServerResponse.RenderPage responseInfo
                                                     { head = config.view Dict.empty Dict.empty Nothing currentPage Nothing sharedData pageData maybeActionData |> .head
-                                                    , view = viewValue.body |> HtmlPrinter.htmlToString
+                                                    , view = viewValue.body |> bodyToString
                                                     , title = viewValue.title
                                                     }
 
@@ -871,7 +915,7 @@ sendSinglePageProgress site contentJson config model info =
                                                     pageData =
                                                         config.errorPageToData error
 
-                                                    viewValue : { title : String, body : Html (Pages.Msg.Msg userMsg) }
+                                                    viewValue : { title : String, body : List (Html (Pages.Msg.Msg userMsg)) }
                                                     viewValue =
                                                         (config.view Dict.empty Dict.empty Nothing currentPage Nothing sharedData pageData Nothing |> .view) pageModel
                                                 in
@@ -880,7 +924,7 @@ sendSinglePageProgress site contentJson config model info =
                                                     , headers = record.headers
                                                     }
                                                     { head = config.view Dict.empty Dict.empty Nothing currentPage Nothing sharedData pageData Nothing |> .head
-                                                    , view = viewValue.body |> HtmlPrinter.htmlToString
+                                                    , view = viewValue.body |> List.map (HtmlPrinter.htmlToString Nothing) |> String.join "\n"
                                                     , title = viewValue.title
                                                     }
                                     )
@@ -957,42 +1001,49 @@ sendSinglePageProgress site contentJson config model info =
                     case maybeNotFoundReason of
                         Nothing ->
                             let
-                                byteEncodedPageData : Bytes
-                                byteEncodedPageData =
+                                ( actionHeaders, byteEncodedPageData ) =
                                     case pageDataResult of
                                         Ok pageServerResponse ->
                                             case pageServerResponse of
-                                                PageServerResponse.RenderPage _ pageData ->
+                                                PageServerResponse.RenderPage ignored1 pageData ->
                                                     -- TODO want to encode both shared and page data in dev server and HTML-embedded data
                                                     -- but not for writing out the content.dat files - would be good to optimize this redundant data out
                                                     --if model.isDevServer then
                                                     case isAction of
                                                         Just actionRequestKind ->
                                                             case actionDataResult of
-                                                                Ok (PageServerResponse.RenderPage _ actionData) ->
+                                                                Ok (PageServerResponse.RenderPage ignored2 actionData) ->
                                                                     case actionRequestKind of
                                                                         ActionResponseRequest ->
-                                                                            sharedDataResult
+                                                                            ( ignored2.headers
+                                                                            , sharedDataResult
                                                                                 |> Result.map (\sharedData -> ResponseSketch.HotUpdate pageData sharedData (Just actionData))
                                                                                 |> Result.withDefault (ResponseSketch.RenderPage pageData (Just actionData))
                                                                                 |> config.encodeResponse
                                                                                 |> Bytes.Encode.encode
+                                                                            )
 
                                                                         ActionOnlyRequest ->
                                                                             ---- TODO need to encode action data when only that is requested (not ResponseSketch?)
-                                                                            actionData
+                                                                            ( ignored2.headers
+                                                                            , actionData
                                                                                 |> config.encodeAction
                                                                                 |> Bytes.Encode.encode
+                                                                            )
 
                                                                 _ ->
-                                                                    Bytes.Encode.encode (Bytes.Encode.unsignedInt8 0)
+                                                                    ( ignored1.headers
+                                                                    , Bytes.Encode.encode (Bytes.Encode.unsignedInt8 0)
+                                                                    )
 
                                                         Nothing ->
-                                                            sharedDataResult
+                                                            ( ignored1.headers
+                                                            , sharedDataResult
                                                                 |> Result.map (\something -> ResponseSketch.HotUpdate pageData something Nothing)
                                                                 |> Result.withDefault (ResponseSketch.RenderPage pageData Nothing)
                                                                 |> config.encodeResponse
                                                                 |> Bytes.Encode.encode
+                                                            )
 
                                                 --else
                                                 --    pageData
@@ -1001,7 +1052,8 @@ sendSinglePageProgress site contentJson config model info =
                                                 --        |> Bytes.Encode.encode
                                                 PageServerResponse.ServerResponse serverResponse ->
                                                     -- TODO handle error?
-                                                    PageServerResponse.toRedirect serverResponse
+                                                    ( serverResponse.headers
+                                                    , PageServerResponse.toRedirect serverResponse
                                                         |> Maybe.map
                                                             (\{ location } ->
                                                                 location
@@ -1011,10 +1063,12 @@ sendSinglePageProgress site contentJson config model info =
                                                         -- TODO handle other cases besides redirects?
                                                         |> Maybe.withDefault (Bytes.Encode.unsignedInt8 0)
                                                         |> Bytes.Encode.encode
+                                                    )
 
-                                                PageServerResponse.ErrorPage error _ ->
+                                                PageServerResponse.ErrorPage error { headers } ->
                                                     -- TODO this case should never happen
-                                                    sharedDataResult
+                                                    ( headers
+                                                    , sharedDataResult
                                                         |> Result.map
                                                             (\sharedData ->
                                                                 ResponseSketch.HotUpdate (config.errorPageToData error)
@@ -1024,10 +1078,13 @@ sendSinglePageProgress site contentJson config model info =
                                                         |> Result.map config.encodeResponse
                                                         |> Result.map Bytes.Encode.encode
                                                         |> Result.withDefault (Bytes.Encode.encode (Bytes.Encode.unsignedInt8 0))
+                                                    )
 
                                         _ ->
                                             -- TODO handle error?
-                                            Bytes.Encode.encode (Bytes.Encode.unsignedInt8 0)
+                                            ( []
+                                            , Bytes.Encode.encode (Bytes.Encode.unsignedInt8 0)
+                                            )
                             in
                             case renderedOrApiResponse of
                                 PageServerResponse.RenderPage responseInfo rendered ->
@@ -1040,7 +1097,9 @@ sendSinglePageProgress site contentJson config model info =
                                     , staticHttpCache = Dict.empty
                                     , is404 = False
                                     , statusCode = responseInfo.statusCode
-                                    , headers = responseInfo.headers
+                                    , headers =
+                                        -- TODO should `responseInfo.headers` be used? Is there a problem in the case where there is both an action and data response in one? Do we need to make sure it is performed as two separate HTTP requests to ensure that the cookies are set correctly in that case?
+                                        actionHeaders
                                     }
                                         |> ToJsPayload.PageProgress
                                         |> Effect.SendSinglePageNew byteEncodedPageData
@@ -1143,7 +1202,7 @@ render404Page config sharedData model path notFoundReason =
                 pathAndRoute =
                     { path = path, route = config.notFoundRoute }
 
-                viewValue : { title : String, body : Html (Pages.Msg.Msg userMsg) }
+                viewValue : { title : String, body : List (Html (Pages.Msg.Msg userMsg)) }
                 viewValue =
                     (config.view Dict.empty
                         Dict.empty
@@ -1159,7 +1218,7 @@ render404Page config sharedData model path notFoundReason =
             in
             { route = Path.toAbsolute path
             , contentJson = Dict.empty
-            , html = viewValue.body |> HtmlPrinter.htmlToString
+            , html = viewValue.body |> bodyToString
             , errors = []
             , head = config.view Dict.empty Dict.empty Nothing pathAndRoute Nothing justSharedData pageData Nothing |> .head
             , title = viewValue.title
@@ -1179,7 +1238,7 @@ render404Page config sharedData model path notFoundReason =
                         |> config.encodeResponse
                         |> Bytes.Encode.encode
 
-                notFoundDocument : { title : String, body : Html msg }
+                notFoundDocument : { title : String, body : List (Html msg) }
                 notFoundDocument =
                     { path = path
                     , reason = notFoundReason
@@ -1188,7 +1247,7 @@ render404Page config sharedData model path notFoundReason =
             in
             { route = Path.toAbsolute path
             , contentJson = Dict.empty
-            , html = HtmlPrinter.htmlToString notFoundDocument.body
+            , html = bodyToString notFoundDocument.body
             , errors = []
             , head = []
             , title = notFoundDocument.title
@@ -1204,6 +1263,11 @@ render404Page config sharedData model path notFoundReason =
                 |> Effect.SendSinglePageNew byteEncodedPageData
 
 
+bodyToString : List (Html msg) -> String
+bodyToString body =
+    body |> List.map (HtmlPrinter.htmlToString Nothing) |> String.join "\n"
+
+
 urlToRoute : ProgramConfig userMsg userModel route pageData actionData sharedData effect mappedMsg errorPage -> Url -> route
 urlToRoute config url =
     if url.path |> String.startsWith "/____elm-pages-internal____" then