Improve readability by renaming to 'WebServer'

+ Rename the Elm module representing the platform interface to 'ElmWebServer' and update names in that module accordingly. + Move C# code for the WebServer platform into namespace 'Platform.WebServer'. + Change the default name for the configuration file in web server apps to 'elm-web-server.json'. Support smooth migration of projects with backward compatibility here: Support the name used before 2023 as an alternative. + Update some of the example apps to demo the new interface.
pine-vm · Feb 16, 2023 · f0d6ce0 · f0d6ce0
1 parent 3b68091
commit f0d6ce0
Show file tree

Hide file tree

Showing 25 changed files with 1,136 additions and 263 deletions.
diff --git a/implement/elm-time/ElmTime/compile-elm-program/src/CompileBackendApp.elm b/implement/elm-time/ElmTime/compile-elm-program/src/CompileBackendApp.elm
diff --git a/implement/elm-time/ElmTime/compile-elm-program/src/Main.elm b/implement/elm-time/ElmTime/compile-elm-program/src/Main.elm
@@ -27,20 +27,7 @@ lowerSerialized argumentsJson =
 defaultEntryPoints : Dict.Dict String EntryPointType
 defaultEntryPoints =
     CompileFullstackApp.defaultEntryPoints
-        |> Dict.union
-            (Dict.fromList
-                [ ( "backendMain"
-                  , \entryPointConfig ->
-                        CompileBackendApp.loweredForBackendApp entryPointConfig
-                            >> Result.map
-                                (\( compiledFiles, entryPoint ) ->
-                                    { compiledFiles = compiledFiles
-                                    , rootModuleEntryPointKind = ClassicMakeEntryPoint entryPoint
-                                    }
-                                )
-                  )
-                ]
-            )
+        |> Dict.union CompileBackendApp.entryPoints
 
 
 jsonEncodeLowerForSourceFilesResponse : CompilationResponse -> Json.Encode.Value

diff --git a/implement/elm-time/ElmTime/compile-elm-program/tests/Tests.elm b/implement/elm-time/ElmTime/compile-elm-program/tests/Tests.elm
@@ -95,10 +95,12 @@ subscriptions _ =
     }
 """
       , Ok
-            ( CompileFullstackApp.RecordElmType
-                { fields = [ ( "field_name", CompileFullstackApp.LeafElmType CompileFullstackApp.IntLeaf ) ] }
-            , Dict.empty
-            )
+            { stateTypeAnnotation =
+                CompileFullstackApp.RecordElmType
+                    { fields = [ ( "field_name", CompileFullstackApp.LeafElmType CompileFullstackApp.IntLeaf ) ] }
+            , dependencies = Dict.empty
+            , instantiatedConfigTypeName = [ "ElmFullstack", "BackendConfig" ]
+            }
       )
     ]
         |> List.map

diff --git a/implement/elm-time/WebHost/Asp.cs → implement/elm-time/Platform/WebServer/Asp.cs b/implement/elm-time/WebHost/Asp.cs → implement/elm-time/Platform/WebServer/Asp.cs
@@ -9,7 +9,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Pine;
 
-namespace ElmTime.WebHost;
+namespace ElmTime.Platform.WebServer;
 
 static public class Asp
 {

diff --git a/...ebHost/BuildConfigurationFromArguments.cs → ...Server/BuildConfigurationFromArguments.cs b/...ebHost/BuildConfigurationFromArguments.cs → ...Server/BuildConfigurationFromArguments.cs
@@ -3,7 +3,7 @@
 using System.Linq;
 using Pine;
 
-namespace ElmTime.WebHost;
+namespace ElmTime.Platform.WebServer;
 
 static public class BuildConfigurationFromArguments
 {

diff --git a/implement/elm-time/WebHost/Configuration.cs → ...-time/Platform/WebServer/Configuration.cs b/implement/elm-time/WebHost/Configuration.cs → ...-time/Platform/WebServer/Configuration.cs
@@ -6,7 +6,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Pine;
 
-namespace ElmTime.WebHost;
+namespace ElmTime.Platform.WebServer;
 
 static public class Configuration
 {

diff --git a/...ement/elm-time/WebHost/InterfaceToHost.cs → ...Server/InterfaceToHost/InterfaceToHost.cs b/...ement/elm-time/WebHost/InterfaceToHost.cs → ...Server/InterfaceToHost/InterfaceToHost.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace ElmTime.WebHost.InterfaceToHost;
+namespace ElmTime.Platform.WebServer.InterfaceToHost;
 
 public record AppEventStructure(
     ArrivedAtTimeEventStructure? ArrivedAtTimeEvent = null,

diff --git a/...st/PersistentProcessLiveRepresentation.cs → ...er/PersistentProcessLiveRepresentation.cs b/...st/PersistentProcessLiveRepresentation.cs → ...er/PersistentProcessLiveRepresentation.cs
@@ -5,10 +5,10 @@
 using System.Linq;
 using System.Text;
 using System.Text.Json;
-using ElmTime.WebHost.ProcessStoreSupportingMigrations;
+using ElmTime.Platform.WebServer.ProcessStoreSupportingMigrations;
 using Pine;
 
-namespace ElmTime.WebHost.PersistentProcess;
+namespace ElmTime.Platform.WebServer;
 
 public interface IPersistentProcess
 {
@@ -195,7 +195,7 @@ static public (PersistentProcessLiveRepresentation? process, InterfaceToHost.App
             compositionEventsFromLatestReduction,
             overrideElmAppInterfaceConfig);
 
-        logger?.Invoke("Restored the process state in " + ((int)restoreStopwatch.Elapsed.TotalSeconds) + " seconds.");
+        logger?.Invoke("Restored the process state in " + (int)restoreStopwatch.Elapsed.TotalSeconds + " seconds.");
 
         return processLiveRepresentation;
     }

diff --git a/...bHost/ProcessStoreSupportingMigrations.cs → ...tions/ProcessStoreSupportingMigrations.cs b/...bHost/ProcessStoreSupportingMigrations.cs → ...tions/ProcessStoreSupportingMigrations.cs
@@ -7,7 +7,7 @@
 using System.Text.Json.Serialization;
 using Pine;
 
-namespace ElmTime.WebHost.ProcessStoreSupportingMigrations;
+namespace ElmTime.Platform.WebServer.ProcessStoreSupportingMigrations;
 
 public record FileStoreReaderProjectionResult(
     IEnumerable<(IImmutableList<string> filePath, IReadOnlyList<byte> fileContent)> projectedFiles,

diff --git a/implement/elm-time/WebHost/PublicAppState.cs → ...time/Platform/WebServer/PublicAppState.cs b/implement/elm-time/WebHost/PublicAppState.cs → ...time/Platform/WebServer/PublicAppState.cs
@@ -11,7 +11,7 @@
 using Microsoft.Extensions.Logging;
 using Pine;
 
-namespace ElmTime.WebHost;
+namespace ElmTime.Platform.WebServer;
 
 public class PublicAppState
 {
@@ -75,7 +75,7 @@ public PublicAppState(
                 }
 
                 if (!lastAppEventTimeHasArrived.HasValue ||
-                    NotifyTimeHasArrivedMaximumDistance <= (getDateTimeOffset() - lastAppEventTimeHasArrived.Value))
+                    NotifyTimeHasArrivedMaximumDistance <= getDateTimeOffset() - lastAppEventTimeHasArrived.Value)
                 {
                     ProcessEventTimeHasArrived();
                 }

diff --git a/implement/elm-time/WebHost/RateLimit.cs → .../elm-time/Platform/WebServer/RateLimit.cs b/implement/elm-time/WebHost/RateLimit.cs → .../elm-time/Platform/WebServer/RateLimit.cs
@@ -1,7 +1,7 @@
 using System.Collections.Immutable;
 using System.Linq;
 
-namespace ElmTime.WebHost;
+namespace ElmTime.Platform.WebServer;
 
 public interface IRateLimit
 {

diff --git a/...elm-time/WebHost/StartupAdminInterface.cs → ...atform/WebServer/StartupAdminInterface.cs b/...elm-time/WebHost/StartupAdminInterface.cs → ...atform/WebServer/StartupAdminInterface.cs
@@ -5,7 +5,7 @@
 using System.Linq;
 using System.Net.Http.Headers;
 using System.Text;
-using ElmTime.WebHost.ProcessStoreSupportingMigrations;
+using ElmTime.Platform.WebServer.ProcessStoreSupportingMigrations;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Http;
@@ -15,7 +15,7 @@
 using Microsoft.Extensions.Logging;
 using Pine;
 
-namespace ElmTime.WebHost;
+namespace ElmTime.Platform.WebServer;
 
 public class StartupAdminInterface
 {
@@ -39,9 +39,17 @@ public class StartupAdminInterface
 
     static public string PathApiProcessHistoryFileStoreListFilesInDirectory => PathApiProcessHistoryFileStore + "/list-files-in-directory";
 
-    static public string JsonFileName => "elm-fullstack.json";
+    static public IImmutableList<string> JsonFilePathDefault => ImmutableList.Create("elm-web-server.json");
 
-    static public IImmutableList<string> JsonFilePath => ImmutableList.Create(JsonFileName);
+    static public IImmutableList<IImmutableList<string>> JsonFilePathAlternatives =
+        ImmutableList.Create(
+            JsonFilePathDefault,
+
+            /*
+             * Support smooth migration of projects with backwards compatibility here:
+             * Support the name used before 2023 as alternative.
+             * */
+            ImmutableList.Create("elm-fullstack.json"));
 
     private readonly ILogger<StartupAdminInterface> logger;
 
@@ -64,7 +72,7 @@ public static void ConfigureServices(IServiceCollection services)
     }
 
     record PublicHostConfiguration(
-        PersistentProcess.PersistentProcessLiveRepresentation processLiveRepresentation,
+        PersistentProcessLiveRepresentation processLiveRepresentation,
         IHost webHost);
 
     public void Configure(
@@ -122,7 +130,7 @@ void startPublicApp()
                 logger.LogInformation("Begin to build the process live representation.");
 
                 var restoreProcessResult =
-                    PersistentProcess.PersistentProcessLiveRepresentation.LoadFromStoreAndRestoreProcess(
+                    PersistentProcessLiveRepresentation.LoadFromStoreAndRestoreProcess(
                         new ProcessStoreReaderInFileStore(processStoreFileStore),
                         logger: logEntry => logger.LogInformation(logEntry));
 
@@ -169,7 +177,7 @@ void maintainStoreReductions()
                 }
 
                 IHost buildWebHost(
-                    PersistentProcess.ProcessAppConfig processAppConfig,
+                    ProcessAppConfig processAppConfig,
                     IReadOnlyList<string> publicWebHostUrls)
                 {
                     var appConfigTree =
@@ -181,7 +189,7 @@ IHost buildWebHost(
 
                     var webAppConfigurationFile =
                         appConfigFilesNamesAndContents
-                        .Where(filePathAndContent => filePathAndContent.path.SequenceEqual(JsonFilePath))
+                        .Where(filePathAndContent => JsonFilePathAlternatives.Any(configFilePath => filePathAndContent.path.SequenceEqual(configFilePath)))
                         .Select(filePathAndContent => filePathAndContent.blobContent)
                         .Cast<ReadOnlyMemory<byte>?>()
                         .FirstOrDefault();
@@ -611,7 +619,7 @@ TruncateProcessHistoryReport truncateProcessHistory(TimeSpan productionBlockDura
                         var getFilesForRestoreStopwatch = System.Diagnostics.Stopwatch.StartNew();
 
                         var filesForRestore =
-                            PersistentProcess.PersistentProcessLiveRepresentation.GetFilesForRestoreProcess(
+                            PersistentProcessLiveRepresentation.GetFilesForRestoreProcess(
                                 processStoreFileStore).files
                             .Select(filePathAndContent => filePathAndContent.Key)
                             .ToImmutableHashSet(EnumerableExtension.EqualityComparer<IReadOnlyList<string>>());
@@ -846,7 +854,7 @@ static public (int statusCode, AttemptContinueWithCompositionEventReport respons
 
         var totalStopwatch = System.Diagnostics.Stopwatch.StartNew();
 
-        var testContinueResult = PersistentProcess.PersistentProcessLiveRepresentation.TestContinueWithCompositionEvent(
+        var testContinueResult = PersistentProcessLiveRepresentation.TestContinueWithCompositionEvent(
             compositionLogEvent: compositionLogEvent,
             fileStoreReader: processStoreFileStore,
             logger: testContinueLogger);
@@ -890,7 +898,7 @@ static public (int statusCode, AttemptContinueWithCompositionEventReport respons
 public record AttemptContinueWithCompositionEventReport(
     string beginTime,
     CompositionLogRecordInFile.CompositionEvent compositionEvent,
-    PersistentProcess.StoreProvisionalReductionReport? storeReductionReport,
+    StoreProvisionalReductionReport? storeReductionReport,
     int? storeReductionTimeSpentMilli,
     int totalTimeSpentMilli,
     Result<string, string> result);
@@ -903,6 +911,6 @@ public record TruncateProcessHistoryReport(
     int lockedTimeSpentMilli,
     int totalTimeSpentMilli,
     int storeReductionTimeSpentMilli,
-    PersistentProcess.StoreProvisionalReductionReport? storeReductionReport,
+    StoreProvisionalReductionReport? storeReductionReport,
     int getFilesForRestoreTimeSpentMilli,
     int deleteFilesTimeSpentMilli);
diff --git a/...bHost/WebAppConfigurationJsonStructure.cs → ...erver/WebAppConfigurationJsonStructure.cs b/...bHost/WebAppConfigurationJsonStructure.cs → ...erver/WebAppConfigurationJsonStructure.cs
@@ -1,4 +1,4 @@
-namespace ElmTime;
+namespace ElmTime.Platform.WebServer;
 
 public record WebAppConfigurationJsonStructure(
     RateLimitWindow? singleRateLimitWindowPerClientIPv4Address = null,