Changeset 467 for TFP-WebServer/WebServer/src/WebAPI/APIs

Timestamp:

Aug 18, 2023, 12:08:10 PM (15 months ago)

Author:

alloc

Message:

21.1.16.2 WebServer release
Added "id"s to messages in log API / event
Added "baseUrl" to mods API for WebMods

Location:

TFP-WebServer/WebServer/src/WebAPI/APIs

Files:

• GameData/Mods.cs (modified) (3 diffs)
• GameData/Mods.openapi.yaml (modified) (1 diff)
• Log.openapi.yaml (modified) (2 diffs)
• LogApi.cs (modified) (3 diffs)

TFP-WebServer/WebServer/src/WebAPI/APIs/GameData/Mods.cs

@@ -19 +19 @@
                                 }
                                 
-                                writer.WriteBeginObject ();
-
                                 writeModJson (ref writer, webMod);
-
-                                if (webMod.ReactBundle != null || webMod.CssPath != null) {
-                                        writer.WriteValueSeparator ();
-
-                                        writer.WritePropertyName ("web");
-                                        writer.WriteBeginObject ();
-                                        
-                                        string webModReactBundle = webMod.ReactBundle;
-                                        if (webModReactBundle != null) {
-                                                writer.WritePropertyName ("bundle");
-                                                writer.WriteString (webModReactBundle);
-                                        }
-
-                                        string webModCssFile = webMod.CssPath;
-                                        if (webModCssFile != null) {
-                                                if (webModReactBundle != null) {
-                                                        writer.WriteValueSeparator ();
-                                                }
-
-                                                writer.WritePropertyName ("css");
-                                                writer.WriteString (webModCssFile);
-                                        }
-                                        
-                                        writer.WriteEndObject ();
-                                }
-
-                                writer.WriteEndObject ();
                         }
 
@@ -56 +27 @@
                 }
 
-                private void writeModJson (ref JsonWriter _writer, WebMod _webMod) {
+                private static void writeModJson (ref JsonWriter _writer, WebMod _webMod) {
+                        _writer.WriteBeginObject ();
+
                         _writer.WritePropertyName ("name");
                         _writer.WriteString (_webMod.ParentMod.Name);
@@ -79 +52 @@
                         _writer.WritePropertyName ("website");
                         _writer.WriteString (_webMod.ParentMod.Website);
+                        
+                        writeWebModJson (ref _writer, _webMod);
+
+                        _writer.WriteEndObject ();
+                }
+
+                private static void writeWebModJson (ref JsonWriter _writer, WebMod _webMod) {
+                        if (_webMod.ModUrl != null) {
+                                _writer.WriteValueSeparator ();
+
+                                _writer.WritePropertyName ("web");
+                                _writer.WriteBeginObject ();
+                                
+                                _writer.WritePropertyName ("baseUrl");
+                                _writer.WriteString (_webMod.ModUrl);
+
+                                string webModReactBundle = _webMod.ReactBundle;
+                                if (webModReactBundle != null) {
+                                        _writer.WriteValueSeparator ();
+                                        _writer.WritePropertyName ("bundle");
+                                        _writer.WriteString (webModReactBundle);
+                                }
+
+                                string webModCssFile = _webMod.CssPath;
+                                if (webModCssFile != null) {
+                                        _writer.WriteValueSeparator ();
+                                        _writer.WritePropertyName ("css");
+                                        _writer.WriteString (webModCssFile);
+                                }
+
+                                _writer.WriteEndObject ();
+                        }
                 }
 

TFP-WebServer/WebServer/src/WebAPI/APIs/GameData/Mods.openapi.yaml

@@ -37 +37 @@
           type: object
           properties:
+            baseUrl:
+              type: string
+              examples:
+                - /webmods/TFP_MarkersExample/
+              description: Base URL of the WebMod folder of this mod. Always ends with a forward slash '/'.
             bundle:
               type: string
               examples:
-                - /webmods/Xample_MarkersMod/bundle.js
+                - /webmods/TFP_MarkersExample/bundle.js
+              description: URL of the React bundle if the mod has one.
             css:
               type: string
               examples:
-                - /webmods/Xample_MarkersMod/styling.css
+                - /webmods/TFP_MarkersExample/styling.css
+              description: URL of a styling CSS file if the mod has one.
+          required:
+            - baseUrl
       required:
         - name

TFP-WebServer/WebServer/src/WebAPI/APIs/Log.openapi.yaml

@@ -8 +8 @@
     LogEntry:
       type: object
-      properties: 
+      properties:
+        id:
+          type: integer
+          minimum: 0
+          description: Consecutive ID/number of this log line
         msg:
           type: string
@@ -33 +37 @@
           examples:
             - '87123'
-          description: Time since server was started in milliseconds.
+          description: Time since server was started in milliseconds
       required:
+        - id
         - msg
         - type

TFP-WebServer/WebServer/src/WebAPI/APIs/LogApi.cs

@@ -12 +12 @@
                 private static readonly byte[] jsonKeyLastLine = JsonWriter.GetEncodedPropertyNameWithPrefixValueSeparator ("lastLine");
 
-                private static readonly byte[] jsonMsgKey = JsonWriter.GetEncodedPropertyNameWithBeginObject ("msg");
+                private static readonly byte[] jsonIdKey = JsonWriter.GetEncodedPropertyNameWithBeginObject ("id");
+                private static readonly byte[] jsonMsgKey = JsonWriter.GetEncodedPropertyNameWithPrefixValueSeparator ("msg");
                 private static readonly byte[] jsonTypeKey = JsonWriter.GetEncodedPropertyNameWithPrefixValueSeparator ("type");
                 private static readonly byte[] jsonTraceKey = JsonWriter.GetEncodedPropertyNameWithPrefixValueSeparator ("trace");
@@ -57 +58 @@
                                 }
 
-                                writer.WriteRaw (jsonMsgKey);
-                                writer.WriteString (logEntry.Message);
-
-                                writer.WriteRaw (jsonTypeKey);
-                                writer.WriteString (logEntry.Type.ToStringCached ());
-
-                                writer.WriteRaw (jsonTraceKey);
-                                writer.WriteString (logEntry.Trace);
-
-                                writer.WriteRaw (jsonIsotimeKey);
-                                writer.WriteString (logEntry.IsoTime);
-
-                                writer.WriteRaw (jsonUptimeKey);
-                                writer.WriteString (logEntry.Uptime.ToString ());
-
-                                writer.WriteEndObject ();
+                                WriteLogMessageObject (ref writer, logEntry);
                         }
 
@@ -87 +73 @@
                         SendEnvelopedResult (_context, ref writer);
                 }
+
+                public static void WriteLogMessageObject (ref JsonWriter _writer, LogBuffer.LogEntry _logEntry) {
+                        _writer.WriteRaw (jsonIdKey);
+                        _writer.WriteInt32 (_logEntry.MessageId);
+                        
+                        _writer.WriteRaw (jsonMsgKey);
+                        _writer.WriteString (_logEntry.Message);
+
+                        _writer.WriteRaw (jsonTypeKey);
+                        _writer.WriteString (_logEntry.Type.ToStringCached ());
+
+                        _writer.WriteRaw (jsonTraceKey);
+                        _writer.WriteString (_logEntry.Trace);
+
+                        _writer.WriteRaw (jsonIsotimeKey);
+                        _writer.WriteString (_logEntry.IsoTime);
+
+                        _writer.WriteRaw (jsonUptimeKey);
+                        _writer.WriteString (_logEntry.Uptime.ToString ());
+
+                        _writer.WriteEndObject ();
+                }
         }
 }