Merge pull request #1666 from tgstation/OpenDream

Add OpenDream support

Closes #1577

.github/workflows/ci-pipeline.yml

@@ -39,6 +39,7 @@ on:
 
 env:
   TGS_DOTNET_VERSION: 8
+  OD_DOTNET_VERSION: 7
   TGS_DOTNET_QUALITY: ga
   TGS_TEST_GITHUB_TOKEN: ${{ secrets.LIVE_TESTS_TOKEN }}
   TGS_RELEASE_NOTES_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
@@ -164,6 +165,50 @@ jobs:
         fi
         exit $retval
 
+  opendream-build:
+    name: Build DMAPI (OpenDream)
+    needs: start-ci-run-gate
+    if: (!(cancelled() || failure()) && needs.start-ci-run-gate.result == 'success')
+    strategy:
+      fail-fast: false
+      matrix:
+        committish: [ 'master', 'tgs-min-compat' ]
+    runs-on: ubuntu-latest
+    steps:
+    - name: Setup dotnet
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: '${{ env.OD_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
+
+    - name: Checkout (Branch)
+      uses: actions/checkout@v3
+      if: github.event_name == 'push' || github.event_name == 'schedule'
+
+    - name: Checkout (PR Merge)
+      uses: actions/checkout@v3
+      if: github.event_name != 'push' && github.event_name != 'schedule'
+      with:
+        ref: "refs/pull/${{ github.event.number }}/merge"
+
+    - name: Checkout OpenDream
+      run: |
+        cd $HOME
+        git clone https://github.com/OpenDreamProject/OpenDream
+        cd OpenDream
+        git checkout ${{ matrix.committish }}
+        git submodule update --init --recursive
+
+    - name: Create TGS Deployment
+      run: |
+        cd $HOME/OpenDream
+        dotnet run -c Release --project OpenDreamPackageTool -- --tgs -o tgs_deploy
+
+    - name: Build DMAPI
+      run: |
+        cd tests/DMAPI/BasicOperation
+        $HOME/OpenDream/tgs_deploy/bin/compiler/DMCompiler --verbose --notices-enabled basic_operation_test.dme
+
   pages-build:
     name: Build gh-pages
     runs-on: ubuntu-latest
@@ -173,7 +218,8 @@ jobs:
     - name: Setup dotnet
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: ${{ env.TGS_DOTNET_VERSION }}
+        dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout (Branch)
       uses: actions/checkout@v3
@@ -275,6 +321,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout (Branch)
       uses: actions/checkout@v3
@@ -325,6 +372,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout (Branch)
       uses: actions/checkout@v3
@@ -360,8 +408,8 @@ jobs:
 
   windows-integration-test:
     name: Windows Live Tests
-    needs: dmapi-build
-    if: (!(cancelled() || failure()) && needs.dmapi-build.result == 'success')
+    needs: [dmapi-build, opendream-build]
+    if: (!(cancelled() || failure()) && needs.dmapi-build.result == 'success' && needs.opendream-build.result == 'success')
     strategy:
       fail-fast: false
       matrix:
@@ -380,7 +428,10 @@ jobs:
     - name: Setup dotnet
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-version: |
+          ${{ env.TGS_DOTNET_VERSION }}.0.x
+          ${{ env.OD_DOTNET_VERSION }}.0.x
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Set TGS_TEST_DUMP_API_SPEC
       if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'Advanced' && matrix.database-type == 'SqlServer' }}
@@ -538,8 +589,8 @@ jobs:
 
   linux-integration-tests:
     name: Linux Live Tests
-    needs: dmapi-build
-    if: (!(cancelled() || failure()) && needs.dmapi-build.result == 'success')
+    needs: [dmapi-build, opendream-build]
+    if: (!(cancelled() || failure()) && needs.dmapi-build.result == 'success' && needs.opendream-build.result == 'success')
     services: # We start all dbs here so we can just code the stuff once
       mssql:
         image: mcr.microsoft.com/mssql/server:2019-latest
@@ -601,7 +652,10 @@ jobs:
     - name: Setup dotnet
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-version: |
+          ${{ env.TGS_DOTNET_VERSION }}.0.x
+          ${{ env.OD_DOTNET_VERSION }}.0.x
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Set Sqlite Connection Info
       if: ${{ matrix.database-type == 'Sqlite' }}
@@ -1105,6 +1159,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout (Branch)
       uses: actions/checkout@v3
@@ -1230,6 +1285,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Retrieve Latest winget-pkgs PULL_REQUEST_TEMPLATE commit SHA from GitHub API
       id: get-sha
@@ -1283,7 +1339,8 @@ jobs:
     - name: Setup dotnet
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: ${{ env.TGS_DOTNET_VERSION }}
+        dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout
       uses: actions/checkout@v3
@@ -1346,7 +1403,8 @@ jobs:
     - name: Setup dotnet
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: ${{ env.TGS_DOTNET_VERSION }}
+        dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout
       uses: actions/checkout@v3
@@ -1409,6 +1467,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout
       uses: actions/checkout@v3
@@ -1459,6 +1518,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout
       uses: actions/checkout@v3
@@ -1482,6 +1542,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout
       uses: actions/checkout@v3
@@ -1690,9 +1751,10 @@ jobs:
     if: (!(cancelled() || failure()) && needs.deploy-tgs.result == 'success')
     steps:
     - name: Setup dotnet
-      uses: actions/setup-dotnet@v2
+      uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: ${{ env.TGS_DOTNET_VERSION }}
+        dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Checkout
       uses: actions/checkout@v3
@@ -1780,6 +1842,7 @@ jobs:
       uses: actions/setup-dotnet@v3
       with:
         dotnet-version: '${{ env.TGS_DOTNET_VERSION }}.0.x'
+        dotnet-quality: ${{ env.TGS_DOTNET_QUALITY }}
 
     - name: Install winget
       uses: Cyberboss/install-winget@v1

README.md

@@ -385,7 +385,7 @@ Exposing the builtin Kestrel server to the internet directly over HTTP is highly
 
 System administrators will most likely have their own configuration plans, but here are some basic guides for beginners.
 
-Once complete, test that your configuration worked by visiting your proxy site from a browser on a different computer. You should recieve a 401 Unauthorized response.
+Once complete, test that your configuration worked by visiting your proxy site from a browser on a different computer. You should receive a 401 Unauthorized response.
 
 _NOTE: Your reverse proxy setup may interfere with SSE (Server-Sent Events) which is used for real-time job updates. If you find this to be the case, please open an issue describing what you did to fix it as there may be a way for us to bypass the need for a workaround from our end._
 

build/Version.props

@@ -9,7 +9,7 @@
     <TgsCommonLibraryVersion>7.0.0</TgsCommonLibraryVersion>
     <TgsApiLibraryVersion>13.0.0</TgsApiLibraryVersion>
     <TgsClientVersion>15.0.0</TgsClientVersion>
-    <TgsDmapiVersion>6.7.1</TgsDmapiVersion>
+    <TgsDmapiVersion>7.0.0</TgsDmapiVersion>
     <TgsInteropVersion>5.7.0</TgsInteropVersion>
     <TgsHostWatchdogVersion>1.4.0</TgsHostWatchdogVersion>
     <TgsContainerScriptVersion>1.2.1</TgsContainerScriptVersion>

docs/API.dox

@@ -114,13 +114,13 @@ If the provided credentials are valid and your user account is enabled you will
 }
 @endcode
 
-If your account is disabled, you will recieve a 403 response.
+If your account is disabled, you will receive a 403 response.
 
 You may recognize the bearer value as a <a href="https://jwt.io">Json Web Token</a>. This is a secure representation of your identity to the server. It expires after a set period of time or until your password changes. It must be present for requests made to all other APIs. To do so add the following header to your other requests
 
 - Authorization:Bearer `<your bearer token>`
 
-Continue to use this token until you begin to recieve 401 responses from the API. Then repeat the process to get a new one if your credentials are still valid
+Continue to use this token until you begin to receive 401 responses from the API. Then repeat the process to get a new one if your credentials are still valid
 
 @subsection api_auth_o OAuth 2.0
 
@@ -467,7 +467,7 @@ I POST "/Config" @ref Tgstation.Server.Api.Models.ConfigurationFile => @ref Tgst
 
 When creating a file, only @ref Tgstation.Server.Api.Models.ConfigurationFile.Path and @ref Tgstation.Server.Api.Models.ConfigurationFile.Content should be specified
 
-If the file already exists, the @ref Tgstation.Server.Api.Models.ConfigurationFile.LastReadHash field must also be present with the last version recieved from the server for that file. If this does not match at the time of the request, 409 will be returned, indicating the file has changed since it was last viewed by the client.
+If the file already exists, the @ref Tgstation.Server.Api.Models.ConfigurationFile.LastReadHash field must also be present with the last version received from the server for that file. If this does not match at the time of the request, 409 will be returned, indicating the file has changed since it was last viewed by the client.
 
 To delete a file set @ref Tgstation.Server.Api.Models.ConfigurationFile.Content to null in the request.
 

src/DMAPI/tgs.dm

@@ -1,6 +1,6 @@
 // tgstation-server DMAPI
 
-#define TGS_DMAPI_VERSION "6.7.1"
+#define TGS_DMAPI_VERSION "7.0.0"
 
 // 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

src/DMAPI/tgs/core/core.dm

@@ -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)

src/DMAPI/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"

src/DMAPI/tgs/v5/api.dm

@@ -42,7 +42,7 @@
 
 	var/datum/tgs_version/api_version = ApiVersion()
 	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()))
+	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
@@ -106,6 +106,13 @@
 	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

src/DMAPI/tgs/v5/bridge.dm

@@ -83,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]")