Changes for OpenDream support

src/ApiClient/ByondClient.ts → src/ApiClient/EngineClient.ts

@@ -1,28 +1,29 @@
 import { ApiClient } from "./_base";
 import {
-    ByondInstallResponse,
-    ByondResponse,
+    EngineInstallResponse,
+    EngineResponse,
+    EngineVersion,
     ErrorMessageResponse,
     JobResponse,
-    PaginatedByondResponse
+    PaginatedEngineResponse
 } from "./generatedcode/generated";
 import InternalError, { ErrorCode, GenericErrors } from "./models/InternalComms/InternalError";
 import InternalStatus, { StatusCode } from "./models/InternalComms/InternalStatus";
 import ServerClient from "./ServerClient";
 import TransferClient, { UploadErrors } from "./TransferClient";
 import configOptions from "./util/config";
 
-export type DeleteErrors = GenericErrors | ErrorCode.BYOND_VERSION_NOT_FOUND;
+export type DeleteErrors = GenericErrors | ErrorCode.ENGINE_VERSION_NOT_FOUND;
 
-export default new (class ByondClient extends ApiClient {
+export default new (class EngineClient extends ApiClient {
     public async getActiveVersion(
         instance: number
-    ): Promise<InternalStatus<ByondResponse, GenericErrors>> {
+    ): Promise<InternalStatus<EngineResponse, GenericErrors>> {
         await ServerClient.wait4Init();
 
         let response;
         try {
-            response = await ServerClient.apiClient!.byond.byondControllerRead({
+            response = await ServerClient.apiClient!.engine.engineControllerRead({
                 headers: {
                     Instance: instance.toString()
                 }
@@ -38,7 +39,7 @@ export default new (class ByondClient extends ApiClient {
             case 200: {
                 return new InternalStatus({
                     code: StatusCode.OK,
-                    payload: response.data as ByondResponse
+                    payload: response.data as EngineResponse
                 });
             }
             default: {
@@ -57,12 +58,12 @@ export default new (class ByondClient extends ApiClient {
     public async listAllVersions(
         instance: number,
         { page = 1, pageSize = configOptions.itemsperpage.value as number }
-    ): Promise<InternalStatus<PaginatedByondResponse, GenericErrors>> {
+    ): Promise<InternalStatus<PaginatedEngineResponse, GenericErrors>> {
         await ServerClient.wait4Init();
 
         let response;
         try {
-            response = await ServerClient.apiClient!.byond.byondControllerList(
+            response = await ServerClient.apiClient!.engine.engineControllerList(
                 {
                     page: page,
                     pageSize: pageSize
@@ -84,7 +85,7 @@ export default new (class ByondClient extends ApiClient {
             case 200: {
                 return new InternalStatus({
                     code: StatusCode.OK,
-                    payload: response.data as PaginatedByondResponse
+                    payload: response.data as PaginatedEngineResponse
                 });
             }
             default: {
@@ -102,15 +103,15 @@ export default new (class ByondClient extends ApiClient {
 
     public async deleteVersion(
         instance: number,
-        version: string
+        engineVersion: EngineVersion
     ): Promise<InternalStatus<JobResponse, DeleteErrors>> {
         await ServerClient.wait4Init();
 
         let response;
         try {
-            response = await ServerClient.apiClient!.byond.byondControllerDelete(
+            response = await ServerClient.apiClient!.engine.engineControllerDelete(
                 {
-                    version
+                    engineVersion
                 },
                 {
                     headers: {
@@ -144,7 +145,7 @@ export default new (class ByondClient extends ApiClient {
                 return new InternalStatus({
                     code: StatusCode.ERROR,
                     error: new InternalError(
-                        ErrorCode.BYOND_VERSION_NOT_FOUND,
+                        ErrorCode.ENGINE_VERSION_NOT_FOUND,
                         {
                             errorMessage: response.data as ErrorMessageResponse
                         },
@@ -167,16 +168,16 @@ export default new (class ByondClient extends ApiClient {
 
     public async switchActive(
         instance: number,
-        version: string,
+        engineVersion: EngineVersion,
         file?: ArrayBuffer
-    ): Promise<InternalStatus<ByondInstallResponse, UploadErrors>> {
+    ): Promise<InternalStatus<EngineInstallResponse, UploadErrors>> {
         await ServerClient.wait4Init();
 
         let response;
         try {
-            response = await ServerClient.apiClient!.byond.byondControllerUpdate(
+            response = await ServerClient.apiClient!.engine.engineControllerUpdate(
                 {
-                    version: version,
+                    engineVersion,
                     uploadCustomZip: !!file
                 },
                 {
@@ -195,7 +196,7 @@ export default new (class ByondClient extends ApiClient {
         switch (response.status) {
             case 200:
             case 202: {
-                const responseData = response.data as ByondInstallResponse;
+                const responseData = response.data as EngineInstallResponse;
                 if (responseData.fileTicket) {
                     if (file) {
                         const response2 = await TransferClient.Upload(

src/ApiClient/models/InternalComms/InternalError.ts

@@ -72,8 +72,8 @@ export enum ErrorCode {
     //Watchdog errors
     NO_DB_ENTITY = "error.no_db_entity", //errmessage
 
-    //BYOND errors
-    BYOND_VERSION_NOT_FOUND = "error.no_byond_version",
+    //Engine errors
+    ENGINE_VERSION_NOT_FOUND = "error.no_engine_version",
 
     //DreamMaker errors
     COMPILE_JOB_NOT_FOUND = "error.compile_job_not_found", //errmessage

src/ApiClient/util/JobsController.ts

@@ -4,11 +4,11 @@ import { TypedEmitter } from "tiny-typed-emitter";
 import { resolvePermissionSet } from "../../utils/misc";
 import {
     AdministrationRights,
-    ByondRights,
     ChatBotRights,
     ConfigurationRights,
     DreamDaemonRights,
     DreamMakerRights,
+    EngineRights,
     ErrorCode as TGSErrorCode,
     InstanceManagerRights,
     InstancePermissionSetRights,
@@ -415,13 +415,13 @@ export default new (class JobsController extends TypedEmitter<IEvents> {
                     return false;
                 }
             }
-            case RightsType.Byond: {
+            case RightsType.Engine: {
                 const InstancePermissionSet = await InstancePermissionSetClient.getCurrentInstancePermissionSet(
                     job.instanceid
                 );
                 if (InstancePermissionSet.code === StatusCode.OK) {
-                    const required = job.cancelRight as ByondRights;
-                    return !!(InstancePermissionSet.payload.byondRights & required);
+                    const required = job.cancelRight as EngineRights;
+                    return !!(InstancePermissionSet.payload.engineRights & required);
                 } else {
                     errors.push(InstancePermissionSet.error);
                     return false;

src/components/utils/DeploymentViewer.tsx

@@ -11,6 +11,7 @@ import { lt as SemverLessThan } from "semver";
 
 import { CompileJobResponse, DreamDaemonSecurity } from "../../ApiClient/generatedcode/generated";
 import { InstanceEditContext } from "../../contexts/InstanceEditContext";
+import Engine from "../views/Instance/Edit/Engine";
 import { DebugJsonViewer } from "./JsonViewer";
 import Loading from "./Loading";
 import PageHelper from "./PageHelper";
@@ -214,12 +215,7 @@ class DeploymentViewer extends React.Component<IProps, IState> {
     }
 
     private renderCompileJob(compileJob: CompileJobResponse) {
-        let correctedByondVersion = compileJob.byondVersion;
-        if (correctedByondVersion.endsWith(".0"))
-            correctedByondVersion = correctedByondVersion.substring(
-                0,
-                correctedByondVersion.length - 2
-            );
+        const engineVersion = Engine.friendlyVersion(compileJob.engineVersion);
 
         // we use en-GB so we get the fucking SANE DD/MM/YYYY
         const dateFormatter: Intl.DateTimeFormatOptions = {
@@ -324,7 +320,7 @@ class DeploymentViewer extends React.Component<IProps, IState> {
                         ) : null}
                     </td>
                     <td>{compileJob.id}</td>
-                    <td>{correctedByondVersion}</td>
+                    <td>{engineVersion}</td>
                     <td>
                         {new Date(compileJob.job.startedAt).toLocaleString("en-CA", dateFormatter)}
                     </td>

src/components/views/Instance/Create.tsx

@@ -8,11 +8,15 @@ import { FormattedMessage } from "react-intl";
 import { RouteComponentProps, withRouter } from "react-router-dom";
 import YAML from "yaml";
 
-import ByondClient from "../../../ApiClient/ByondClient";
 import ConfigurationFileClient from "../../../ApiClient/ConfigurationFileClient";
 import DreamDaemonClient from "../../../ApiClient/DreamDaemonClient";
 import DreamMakerClient from "../../../ApiClient/DreamMakerClient";
-import { ConfigurationType, DreamDaemonSecurity } from "../../../ApiClient/generatedcode/generated";
+import EngineClient from "../../../ApiClient/EngineClient";
+import {
+    ConfigurationType,
+    DreamDaemonSecurity,
+    EngineType
+} from "../../../ApiClient/generatedcode/generated";
 import InstanceClient from "../../../ApiClient/InstanceClient";
 import InternalError, { ErrorCode } from "../../../ApiClient/models/InternalComms/InternalError";
 import { StatusCode } from "../../../ApiClient/models/InternalComms/InternalStatus";
@@ -541,18 +545,21 @@ class InstanceCreate extends React.Component<IProps, IState> {
                         values={{ version: yml.byond }}
                     />
                 );
-                const byondResult = await ByondClient.switchActive(instanceId, yml.byond);
+                const engineResult = await EngineClient.switchActive(instanceId, {
+                    version: yml.byond,
+                    engine: EngineType.Byond
+                });
 
-                if (byondResult.code === StatusCode.ERROR) {
-                    this.addError(byondResult.error);
+                if (engineResult.code === StatusCode.ERROR) {
+                    this.addError(engineResult.error);
                     this.setState({
                         performingQuickSetup: false
                     });
 
                     return;
                 }
 
-                JobsController.registerJob(byondResult.payload.installJob!, instanceId);
+                JobsController.registerJob(engineResult.payload.installJob!, instanceId);
             }
 
             if (secLevel != DreamDaemonSecurity.Safe) {