Add hot reload for the watch command (#627) #629
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -218,16 +218,46 @@ type internal DocContent(outputDirectory, previous: Map<_,_>, lineNumbers, fsiEv | |
|
|
||
| /// Processes and runs Suave server to host them on localhost | ||
| module Serve = | ||
| //not sure what this was needed for | ||
| //let refreshEvent = new Event<_>() | ||
|
|
||
| /// generate the script to inject into html to enable hot reload during development | ||
| let generateWatchScript (port:int) = | ||
| let tag = """ | ||
| <script type="text/javascript"> | ||
| var wsUri = "ws://localhost:{{PORT}}/websocket"; | ||
| function init() | ||
| { | ||
| websocket = new WebSocket(wsUri); | ||
| websocket.onclose = function(evt) { onClose(evt) }; | ||
| } | ||
| function onClose(evt) | ||
| { | ||
| console.log('closing'); | ||
| websocket.close(); | ||
| document.location.reload(); | ||
| } | ||
| window.addEventListener("load", init, false); | ||
| </script> | ||
| """ | ||
| tag.Replace("{{PORT}}", string port) | ||
|
|
||
|
|
||
| let mutable signalHotReload = false | ||
|
|
||
| let socketHandler (webSocket : WebSocket) _ = socket { | ||
| while true do | ||
| let emptyResponse = [||] |> ByteSegment | ||
| //not sure what this was needed for | ||
| //do! | ||
| // refreshEvent.Publish | ||
| // |> Control.Async.AwaitEvent | ||
| // |> Suave.Sockets.SocketOp.ofAsync | ||
| //do! webSocket.send Text (ByteSegment (Encoding.UTF8.GetBytes "refreshed")) true | ||
| if signalHotReload then | ||
| printfn "Triggering hot reload on the client" | ||
| do! webSocket.send Close emptyResponse true | ||
| signalHotReload <- false | ||
| } | ||
|
|
||
| let startWebServer outputDirectory localPort = | ||
|
|
@@ -487,6 +517,16 @@ type CoreBuildOptions(watch) = | |
| let indxTxt = System.Text.Json.JsonSerializer.Serialize index | ||
| File.WriteAllText(Path.Combine(output, "index.json"), indxTxt) | ||
|
|
||
| /// get the hot reload script if running in watch mode | ||
| let getLatestWatchScript() = | ||
| if watch then | ||
| // if running in watch mode, inject hot reload script | ||
| [ParamKeys.``fsdocs-watch-script``, Serve.generateWatchScript this.port_option] | ||
| else | ||
| // otherwise, inject empty replacement string | ||
| [ParamKeys.``fsdocs-watch-script``, ""] | ||
|
|
||
|
|
||
| // Incrementally convert content | ||
| let runDocContentPhase1 () = | ||
| protect (fun () -> | ||
|
|
@@ -528,7 +568,7 @@ type CoreBuildOptions(watch) = | |
|
|
||
| let runDocContentPhase2 () = | ||
| protect (fun () -> | ||
| let globals = getLatestWatchScript() @ getLatestGlobalParameters() | ||
| latestDocContentPhase2 globals | ||
| ) | ||
|
|
||
|
|
@@ -581,7 +621,7 @@ type CoreBuildOptions(watch) = | |
| protect (fun () -> | ||
| printfn "" | ||
| printfn "Write API Docs:" | ||
| let globals = getLatestWatchScript() @ getLatestGlobalParameters() | ||
| latestApiDocPhase2 globals | ||
| regenerateSearchIndex() | ||
| ) | ||
|
|
@@ -643,33 +683,40 @@ type CoreBuildOptions(watch) = | |
| if not docsQueued then | ||
| docsQueued <- true | ||
| printfn "Detected change in '%s', scheduling rebuild of docs..." this.input | ||
| async { | ||
| do! Async.Sleep(300) | ||
| lock monitor (fun () -> | ||
| docsQueued <- false | ||
| if runDocContentPhase1() then | ||
| if runDocContentPhase2() then | ||
| regenerateSearchIndex() | ||
| ) | ||
| } | ||
| |> Async.RunSynchronously | ||
|
There was a problem hiding this comment. This has changed from Start to RunSynchronously. If it's RunSynchronously then no async is needed? There was a problem hiding this comment. You are right, this is unnecessary. I was kind of thrown off by the 'fire and forget' nature of Async.Start (via this) and ditched it without second thought thinking i have to wait until the computation is finished. I missed that the hot reload trigger does not have to happen after the whole block but just after the last function call inside it, so i moved it inside the block now using the original Async.start version again. |
||
| Serve.signalHotReload <- true | ||
| ) | ||
|
|
||
| let apiDocsDependenciesChanged = Event<_>() | ||
| apiDocsDependenciesChanged.Publish.Add(fun () -> | ||
| if not generateQueued then | ||
| generateQueued <- true | ||
| printfn "Detected change in built outputs, scheduling rebuild of API docs..." | ||
| async { | ||
| do! Async.Sleep(300) | ||
| lock monitor (fun () -> | ||
| generateQueued <- false | ||
| if runGeneratePhase1() then | ||
| if runGeneratePhase2() then | ||
| regenerateSearchIndex()) | ||
| } | ||
| |> Async.RunSynchronously | ||
|
|
||
| Serve.signalHotReload <- true | ||
| ) | ||
|
|
||
| // Listen to changes in any input under docs | ||
| docsWatcher.IncludeSubdirectories <- true | ||
| docsWatcher.NotifyFilter <- NotifyFilters.LastWrite | ||
| docsWatcher.Changed.Add (fun _ -> docsDependenciesChanged.Trigger()) | ||
|
|
||
| // When _template.* change rebuild everything | ||
| templateWatcher.IncludeSubdirectories <- true | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Capital "T" at start of line.
Also there is a table of substitutions in content.md I believe, this should be added there