Automatic TGS DMAPI Update (#5293)

This pull request updates the TGS DMAPI to the latest version. Please note any breaking or unimplemented changes before merging. Co-authored-by: tgstation-server <[email protected]>
cmss13-devs · Jan 6, 2024 · 1440738 · 1440738
1 parent b55e89c
commit 1440738
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 21 deletions.
diff --git a/code/__DEFINES/tgs.dm b/code/__DEFINES/tgs.dm
@@ -1,6 +1,6 @@
 // tgstation-server DMAPI
 
-#define TGS_DMAPI_VERSION "6.7.0"
+#define TGS_DMAPI_VERSION "7.0.1"
 
 // All functions and datums outside this document are subject to change with any version and should not be relied on.
 
@@ -73,12 +73,12 @@
 #define TGS_EVENT_REPO_MERGE_PULL_REQUEST 3
 /// Before the repository makes a sychronize operation. Parameters: Absolute repostiory path.
 #define TGS_EVENT_REPO_PRE_SYNCHRONIZE 4
-/// Before a BYOND install operation begins. Parameters: [/datum/tgs_version] of the installing BYOND.
-#define TGS_EVENT_BYOND_INSTALL_START 5
-/// When a BYOND install operation fails. Parameters: Error message
-#define TGS_EVENT_BYOND_INSTALL_FAIL 6
-/// When the active BYOND version changes.  Parameters: (Nullable) [/datum/tgs_version] of the current BYOND, [/datum/tgs_version] of the new BYOND.
-#define TGS_EVENT_BYOND_ACTIVE_VERSION_CHANGE 7
+/// Before a engine install operation begins. Parameters: Version string of the installing engine.
+#define TGS_EVENT_ENGINE_INSTALL_START 5
+/// When a engine install operation fails. Parameters: Error message
+#define TGS_EVENT_ENGINE_INSTALL_FAIL 6
+/// When the active engine version changes. Parameters: (Nullable) Version string of the current engine, version string of the new engine.
+#define TGS_EVENT_ENGINE_ACTIVE_VERSION_CHANGE 7
 /// When the compiler starts running. Parameters: Game directory path, origin commit SHA.
 #define TGS_EVENT_COMPILE_START 8
 /// When a compile is cancelled. No parameters.
@@ -108,7 +108,7 @@
 // #define TGS_EVENT_DREAM_DAEMON_LAUNCH 22
 /// After a single submodule update is performed. Parameters: Updated submodule name.
 #define TGS_EVENT_REPO_SUBMODULE_UPDATE 23
-/// After CodeModifications are applied, before DreamMaker is run. Parameters: Game directory path, origin commit sha, byond version.
+/// After CodeModifications are applied, before DreamMaker is run. Parameters: Game directory path, origin commit sha, version string of the used engine.
 #define TGS_EVENT_PRE_DREAM_MAKER 24
 /// Whenever a deployment folder is deleted from disk. Parameters: Game directory path.
 #define TGS_EVENT_DEPLOYMENT_CLEANUP 25
@@ -122,6 +122,7 @@
 /// The watchdog will restart on reboot.
 #define TGS_REBOOT_MODE_RESTART 2
 
+// Note that security levels are currently meaningless in OpenDream
 /// DreamDaemon Trusted security level.
 #define TGS_SECURITY_TRUSTED 0
 /// DreamDaemon Safe security level.
@@ -136,6 +137,11 @@
 /// DreamDaemon invisible visibility level.
 #define TGS_VISIBILITY_INVISIBLE 2
 
+/// The Build Your Own Net Dream engine.
+#define TGS_ENGINE_TYPE_BYOND 0
+/// The OpenDream engine.
+#define TGS_ENGINE_TYPE_OPENDREAM 1
+
 //REQUIRED HOOKS
 
 /**
@@ -449,6 +455,10 @@
 /world/proc/TgsVersion()
 	return
 
+/// Returns the running engine type
+/world/proc/TgsEngine()
+	return
+
 /// Returns the current [/datum/tgs_version] of the DMAPI being used if it was activated, null otherwise. This function may sleep if the call to [/world/proc/TgsNew] is sleeping!
 /world/proc/TgsApiVersion()
 	return

diff --git a/code/modules/tgs/core/core.dm b/code/modules/tgs/core/core.dm
@@ -42,11 +42,11 @@
 
 	var/datum/tgs_version/max_api_version = TgsMaximumApiVersion();
 	if(version.suite != null && version.minor != null && version.patch != null && version.deprecated_patch != null && version.deprefixed_parameter > max_api_version.deprefixed_parameter)
-		TGS_ERROR_LOG("Detected unknown API version! Defaulting to latest. Update the DMAPI to fix this problem.")
+		TGS_ERROR_LOG("Detected unknown Interop API version! Defaulting to latest. Update the DMAPI to fix this problem.")
 		api_datum = /datum/tgs_api/latest
 
 	if(!api_datum)
-		TGS_ERROR_LOG("Found unsupported API version: [raw_parameter]. If this is a valid version please report this, backporting is done on demand.")
+		TGS_ERROR_LOG("Found unsupported Interop API version: [raw_parameter]. If this is a valid version please report this, backporting is done on demand.")
 		return
 
 	TGS_INFO_LOG("Activating API for version [version.deprefixed_parameter]")
@@ -107,6 +107,13 @@
 	if(api)
 		return api.ApiVersion()
 
+/world/TgsEngine()
+#ifdef OPENDREAM
+	return TGS_ENGINE_TYPE_OPENDREAM
+#else
+	return TGS_ENGINE_TYPE_BYOND
+#endif
+
 /world/TgsInstanceName()
 	var/datum/tgs_api/api = TGS_READ_GLOBAL(tgs)
 	if(api)

diff --git a/code/modules/tgs/v5/__interop_version.dm b/code/modules/tgs/v5/__interop_version.dm
@@ -1 +1 @@
-"5.7.0"
+"5.8.0"
diff --git a/code/modules/tgs/v5/_defines.dm b/code/modules/tgs/v5/_defines.dm
@@ -8,7 +8,6 @@
 #define DMAPI5_TOPIC_REQUEST_LIMIT 65528
 #define DMAPI5_TOPIC_RESPONSE_LIMIT 65529
 
-#define DMAPI5_BRIDGE_COMMAND_PORT_UPDATE 0
 #define DMAPI5_BRIDGE_COMMAND_STARTUP 1
 #define DMAPI5_BRIDGE_COMMAND_PRIME 2
 #define DMAPI5_BRIDGE_COMMAND_REBOOT 3
@@ -18,6 +17,7 @@
 
 #define DMAPI5_PARAMETER_ACCESS_IDENTIFIER "accessIdentifier"
 #define DMAPI5_PARAMETER_CUSTOM_COMMANDS "customCommands"
+#define DMAPI5_PARAMETER_TOPIC_PORT "topicPort"
 
 #define DMAPI5_CHUNK "chunk"
 #define DMAPI5_CHUNK_PAYLOAD "payload"

diff --git a/code/modules/tgs/v5/api.dm b/code/modules/tgs/v5/api.dm
@@ -17,6 +17,8 @@
 	var/list/chat_channels
 
 	var/initialized = FALSE
+	var/initial_bridge_request_received = FALSE
+	var/datum/tgs_version/interop_version
 
 	var/chunked_requests = 0
 	var/list/chunked_topics = list()
@@ -25,7 +27,8 @@
 
 /datum/tgs_api/v5/New()
 	. = ..()
-	TGS_DEBUG_LOG("V5 API created")
+	interop_version = version
+	TGS_DEBUG_LOG("V5 API created: [json_encode(args)]")
 
 /datum/tgs_api/v5/ApiVersion()
 	return new /datum/tgs_version(
@@ -38,8 +41,8 @@
 	access_identifier = world.params[DMAPI5_PARAM_ACCESS_IDENTIFIER]
 
 	var/datum/tgs_version/api_version = ApiVersion()
-	version = null
-	var/list/bridge_response = Bridge(DMAPI5_BRIDGE_COMMAND_STARTUP, list(DMAPI5_BRIDGE_PARAMETER_MINIMUM_SECURITY_LEVEL = minimum_required_security_level, DMAPI5_BRIDGE_PARAMETER_VERSION = api_version.raw_parameter, DMAPI5_PARAMETER_CUSTOM_COMMANDS = ListCustomCommands()))
+	version = null // we want this to be the TGS version, not the interop version
+	var/list/bridge_response = Bridge(DMAPI5_BRIDGE_COMMAND_STARTUP, list(DMAPI5_BRIDGE_PARAMETER_MINIMUM_SECURITY_LEVEL = minimum_required_security_level, DMAPI5_BRIDGE_PARAMETER_VERSION = api_version.raw_parameter, DMAPI5_PARAMETER_CUSTOM_COMMANDS = ListCustomCommands(), DMAPI5_PARAMETER_TOPIC_PORT = GetTopicPort()))
 	if(!istype(bridge_response))
 		TGS_ERROR_LOG("Failed initial bridge request!")
 		return FALSE
@@ -53,7 +56,8 @@
 		TGS_INFO_LOG("DMAPI validation, exiting...")
 		TerminateWorld()
 
-	version = new /datum/tgs_version(runtime_information[DMAPI5_RUNTIME_INFORMATION_SERVER_VERSION])
+	initial_bridge_request_received = TRUE
+	version = new /datum/tgs_version(runtime_information[DMAPI5_RUNTIME_INFORMATION_SERVER_VERSION]) // reassigning this because it can change if TGS updates
 	security_level = runtime_information[DMAPI5_RUNTIME_INFORMATION_SECURITY_LEVEL]
 	visibility = runtime_information[DMAPI5_RUNTIME_INFORMATION_VISIBILITY]
 	instance_name = runtime_information[DMAPI5_RUNTIME_INFORMATION_INSTANCE_NAME]
@@ -102,10 +106,17 @@
 	initialized = TRUE
 	return TRUE
 
+/datum/tgs_api/v5/proc/GetTopicPort()
+#if defined(OPENDREAM) && defined(OPENDREAM_TOPIC_PORT_EXISTS)
+	return "[world.opendream_topic_port]"
+#else
+	return null
+#endif
+
 /datum/tgs_api/v5/proc/RequireInitialBridgeResponse()
 	TGS_DEBUG_LOG("RequireInitialBridgeResponse()")
 	var/logged = FALSE
-	while(!version)
+	while(!initial_bridge_request_received)
 		if(!logged)
 			TGS_DEBUG_LOG("RequireInitialBridgeResponse: Starting sleep")
 			logged = TRUE

diff --git a/code/modules/tgs/v5/bridge.dm b/code/modules/tgs/v5/bridge.dm
@@ -48,7 +48,9 @@
 	var/json = CreateBridgeData(command, data, TRUE)
 	var/encoded_json = url_encode(json)
 
-	var/url = "http://127.0.0.1:[server_port]/Bridge?[DMAPI5_BRIDGE_DATA]=[encoded_json]"
+	var/api_prefix = interop_version.minor >= 8 ? "api/" : ""
+
+	var/url = "http://127.0.0.1:[server_port]/[api_prefix]Bridge?[DMAPI5_BRIDGE_DATA]=[encoded_json]"
 	return url
 
 /datum/tgs_api/v5/proc/CreateBridgeData(command, list/data, needs_auth)
@@ -81,11 +83,16 @@
 		TGS_ERROR_LOG("Failed bridge request: [bridge_request]")
 		return
 
-	var/response_json = file2text(export_response["CONTENT"])
-	if(!response_json)
+	var/content = export_response["CONTENT"]
+	if(!content)
 		TGS_ERROR_LOG("Failed bridge request, missing content!")
 		return
 
+	var/response_json = file2text(content)
+	if(!response_json)
+		TGS_ERROR_LOG("Failed bridge request, failed to load content!")
+		return
+
 	var/list/bridge_response = json_decode(response_json)
 	if(!bridge_response)
 		TGS_ERROR_LOG("Failed bridge request, bad json: [response_json]")

diff --git a/code/modules/tgs/v5/topic.dm b/code/modules/tgs/v5/topic.dm
@@ -175,6 +175,7 @@
 
 			var/list/reattach_response = TopicResponse(error_message)
 			reattach_response[DMAPI5_PARAMETER_CUSTOM_COMMANDS] = ListCustomCommands()
+			reattach_response[DMAPI5_PARAMETER_TOPIC_PORT] = GetTopicPort()
 			return reattach_response
 
 		if(DMAPI5_TOPIC_COMMAND_SEND_CHUNK)

diff --git a/code/modules/tgs/v5/undefs.dm b/code/modules/tgs/v5/undefs.dm
@@ -8,7 +8,6 @@
 #undef DMAPI5_TOPIC_REQUEST_LIMIT
 #undef DMAPI5_TOPIC_RESPONSE_LIMIT
 
-#undef DMAPI5_BRIDGE_COMMAND_PORT_UPDATE
 #undef DMAPI5_BRIDGE_COMMAND_STARTUP
 #undef DMAPI5_BRIDGE_COMMAND_PRIME
 #undef DMAPI5_BRIDGE_COMMAND_REBOOT
@@ -18,6 +17,7 @@
 
 #undef DMAPI5_PARAMETER_ACCESS_IDENTIFIER
 #undef DMAPI5_PARAMETER_CUSTOM_COMMANDS
+#undef DMAPI5_PARAMETER_TOPIC_PORT
 
 #undef DMAPI5_CHUNK
 #undef DMAPI5_CHUNK_PAYLOAD