feat: exec config per map (#315)

* get rid of Tf2Map
* update configs to use the MapPoolItem
* execute per-map config

Author: garrappachc

configs/queue/6v6.json

@@ -19,16 +19,38 @@
     }
   ],
   "maps": [
-    "cp_process_final",
-    "cp_snakewater_final1",
-    "cp_sunshine",
-    "cp_granary_pro_rc8",
-    "cp_gullywash_final1",
-    "cp_reckoner_rc2",
-    "cp_prolands_rc2t"
-  ],
-  "execConfigs": [
-    "etf2l_6v6_5cp"
+    {
+      "name": "cp_process_final",
+      "configName": "5cp"
+    },
+    {
+      "name": "cp_snakewater_final1",
+      "configName": "5cp"
+    },
+    {
+      "name": "cp_sunshine",
+      "configName": "5cp"
+    },
+    {
+      "name": "cp_granary_pro_rc8",
+      "configName": "5cp"
+    },
+    {
+      "name": "cp_gullywash_final1",
+      "configName": "5cp"
+    },
+    {
+      "name": "cp_reckoner_rc2",
+      "configName": "5cp"
+    },
+    {
+      "name": "cp_prolands_rc2t",
+      "configName": "5cp"
+    }
   ],
+  "configs": {
+    "5cp": "etf2l_6v6_5cp",
+    "koth": "etf2l_6v6_koth"
+  },
   "whitelistId": "10585"
 }

configs/queue/9v9.json

@@ -39,20 +39,51 @@
     }
   ],
   "maps": [
-    "koth_product_rcx",
-    "koth_warmtic_b6",
-    "koth_coalplant_b8",
-    "pl_prowater_b6",
-    "cp_gullywash_final1",
-    "pl_upward",
-    "pl_borneo",
-    "pl_swiftwater_final1",
-    "pl_vigil_rc6",
-    "cp_propaganda_b16",
-    "pl_barnblitz_pro6"
-  ],
-  "execConfigs": [
-    "etf2l_9v9_5cp"
+    {
+      "name": "koth_product_rcx",
+      "configName": "koth"
+    },
+    {
+      "name": "koth_warmtic_b6",
+      "configName": "koth"
+    },
+    {
+      "name": "koth_coalplant_b8",
+      "configName": "koth"
+    },
+    {
+      "name": "pl_prowater_b6",
+      "configName": "stopwatch"
+    },
+    {
+      "name": "cp_gullywash_final1",
+      "configName": "5cp"
+    },
+    {
+      "name": "pl_upward",
+      "configName": "stopwatch"
+    },
+    {
+      "name": "pl_borneo",
+      "configName": "stopwatch"
+    },
+    {
+      "name": "pl_swiftwater_final1",
+      "configName": "stopwatch"
+    },
+    {
+      "name": "pl_vigil_rc6",
+      "configName": "stopwatch"
+    },
+    {
+      "name": "pl_barnblitz_pro6",
+      "configName": "stopwatch"
+    }
   ],
+  "configs": {
+    "koth": "etf2l_9v9_koth",
+    "stopwatch": "etf2l_9v9_stopwatch",
+    "5cp": "etf2l_9v9_5cp"
+  },
   "whitelistId": "10712"
 }

configs/queue/test.json

@@ -7,15 +7,16 @@
     }
   ],
   "maps": [
-    "cp_process_final",
-    "cp_snakewater_final1",
-    "cp_sunshine",
-    "cp_granary_pro_rc8",
-    "cp_gullywash_final1",
-    "cp_reckoner_rc2",
-    "cp_prolands_rc2t"
+    {
+      "name": "cp_process_final",
+      "configName": "5cp"
+    },
+    {
+      "name": "cp_gullywash_final1",
+      "configName": "5cp"
+    }
   ],
-  "execConfigs": [
-    "etf2l_6v6_5cp"
-  ]
+  "configs": {
+    "5cp": "etf2l_6v6_5cp"
+  }
 }

src/games/services/server-configurator.service.spec.ts

@@ -23,7 +23,13 @@ class PlayersServiceStub {
 
 class QueueConfigServiceStub {
   queueConfig = {
-    execConfigs: [ 'etf2l_6v6_5cp' ],
+    maps: [
+      { name: 'cp_badlands', configName: '5cp' },
+    ],
+    configs: {
+      '5cp': 'etf2l_6v6_5cp',
+    },
+    execConfigs: [ 'test' ],
   } as Partial<QueueConfig>;
 }
 
@@ -100,6 +106,7 @@ describe('ServerConfiguratorService', () => {
       expect(spy).toHaveBeenCalledWith(kickAll());
       expect(spy).toHaveBeenCalledWith(changelevel('cp_badlands'));
       expect(spy).toHaveBeenCalledWith(execConfig('etf2l_6v6_5cp'));
+      expect(spy).toHaveBeenCalledWith(execConfig('test'));
       expect(spy).toHaveBeenCalledWith(jasmine.stringMatching(/^sv_password\s.+$/));
       expect(spy).toHaveBeenCalledWith(addGamePlayer('PLAYER_1_STEAMID', 'PLAYER_1_NAME', 2, 'soldier'));
       expect(spy).toHaveBeenCalledWith(addGamePlayer('PLAYER_2_STEAMID', 'PLAYER_2_NAME', 3, 'soldier'));

src/games/services/server-configurator.service.ts

@@ -41,9 +41,16 @@ export class ServerConfiguratorService {
       this.logger.debug(`[${server.name}] changing map to ${game.map}...`);
       await rcon.send(changelevel(game.map));
 
-      for (const configName of this.queueConfigService.queueConfig.execConfigs) {
-        this.logger.debug(`[${server.name}] executing ${configName}...`);
-        await rcon.send(execConfig(configName));
+      const configName = this.queueConfigService.queueConfig.maps.find(m => m.name === game.map)?.configName;
+      const config = this.queueConfigService.queueConfig.configs[configName];
+      if (config) {
+        this.logger.debug(`[${server.name}] executing ${config}...`);
+        await rcon.send(execConfig(config));
+      }
+
+      for (const c of this.queueConfigService.queueConfig.execConfigs) {
+        this.logger.debug(`[${server.name}] executing ${c}...`);
+        await rcon.send(execConfig(c));
       }
 
       if (this.queueConfigService.queueConfig.whitelistId) {

src/queue/gateways/queue.gateway.ts

@@ -2,7 +2,6 @@ import { SubscribeMessage, WebSocketGateway, OnGatewayInit } from '@nestjs/webso
 import { QueueService } from '../services/queue.service';
 import { WsAuthorized } from '@/auth/decorators/ws-authorized.decorator';
 import { Socket } from 'socket.io';
-import { Tf2Map } from '../tf2-map';
 import { MapVoteService } from '../services/map-vote.service';
 import { QueueSlot } from '../queue-slot';
 import { QueueState } from '../queue-state';
@@ -49,7 +48,7 @@ export class QueueGateway implements OnGatewayInit {
 
   @WsAuthorized()
   @SubscribeMessage('vote for map')
-  voteForMap(client: any, payload: { map: Tf2Map }) {
+  voteForMap(client: any, payload: { map: string }) {
     this.mapVoteService.voteForMap(client.request.user.id, payload.map);
     return payload.map;
   }

src/queue/map-pool-item.ts

@@ -0,0 +1,4 @@
+export interface MapPoolItem {
+  name: string;
+  configName: string;
+}

src/queue/map-vote-result.ts

@@ -1,6 +1,4 @@
-import { Tf2Map } from './tf2-map';
-
 export interface MapVoteResult {
-  map: Tf2Map;
+  map: string;
   voteCount: number;
 }

src/queue/queue-config.ts

@@ -1,5 +1,5 @@
 import { GameClass } from './game-class';
-import { Tf2Map } from './tf2-map';
+import { MapPoolItem } from './map-pool-item';
 
 export interface QueueConfig {
   /* This is always 2 */
@@ -9,11 +9,13 @@ export interface QueueConfig {
   classes: GameClass[];
 
   /* Map pool */
-  maps: Tf2Map[];
+  maps: MapPoolItem[];
 
-  /* What configs to execute */
-  // fixme make this per-map instead of per-gamemode
-  execConfigs: string[];
+  /* Configs */
+  configs: { [configName: string]: string };
+
+  /* List of configs to execute */
+  execConfigs?: string[];
 
   /* Whitelist ID (http://whitelist.tf/) */
   whitelistId: string;

src/queue/queue.module.ts

@@ -11,6 +11,10 @@ import { DiscordModule } from '@/discord/discord.module';
 import { AutoGameLauncherService } from './services/auto-game-launcher.service';
 import { QueueAnnouncementsService } from './services/queue-announcements.service';
 import { FriendsService } from './services/friends.service';
+import { Environment } from '@/environment/environment';
+import { join } from 'path';
+import { readFile } from 'fs';
+import { promisify } from 'util';
 
 @Module({
   imports: [
@@ -27,6 +31,14 @@ import { FriendsService } from './services/friends.service';
     AutoGameLauncherService,
     QueueAnnouncementsService,
     FriendsService,
+    {
+      provide: 'QUEUE_CONFIG_JSON',
+      useFactory: async (environment: Environment) => {
+        const configFileName = join('configs', 'queue', `${environment.queueConfig}.json`);
+        return promisify(readFile)(configFileName, 'utf-8');
+      },
+      inject: [ Environment ],
+    },
   ],
   exports: [
     QueueService,

src/queue/services/map-vote.service.ts

@@ -1,23 +1,22 @@
 import { Injectable, OnModuleInit, Inject, forwardRef } from '@nestjs/common';
-import { Tf2Map } from '../tf2-map';
 import { QueueConfigService } from './queue-config.service';
 import { QueueService } from './queue.service';
 import { maxBy, shuffle } from 'lodash';
-import { BehaviorSubject, Observable } from 'rxjs';
+import { BehaviorSubject } from 'rxjs';
 import { MapVoteResult } from '../map-vote-result';
 import { QueueGateway } from '../gateways/queue.gateway';
 
 interface MapVote {
   playerId: string;
-  map: Tf2Map;
+  map: string;
 }
 
 @Injectable()
 export class MapVoteService implements OnModuleInit {
 
   private _results = new BehaviorSubject<MapVoteResult[]>([]);
 
-  public mapOptions: Tf2Map[];
+  public mapOptions: string[];
 
   get results(): MapVoteResult[] {
     return this._results.value;
@@ -40,11 +39,11 @@ export class MapVoteService implements OnModuleInit {
     this._results.subscribe(results => this.queueGateway.emitVoteResultsUpdate(results));
   }
 
-  voteCountForMap(map: Tf2Map): number {
+  voteCountForMap(map: string): number {
     return this.votes.filter(v => v.map === map).length;
   }
 
-  voteForMap(playerId: string, map: Tf2Map) {
+  voteForMap(playerId: string, map: string) {
     if (!this.mapOptions.includes(map)) {
       throw new Error('this map is not an option in the vote');
     }
@@ -61,7 +60,7 @@ export class MapVoteService implements OnModuleInit {
     this._results.next(this.getResults());
   }
 
-  playerVote(playerId: string): Tf2Map {
+  playerVote(playerId: string): string {
     return this.votes.find(v => v.playerId === playerId)?.map;
   }
 
@@ -78,8 +77,11 @@ export class MapVoteService implements OnModuleInit {
   }
 
   private reset() {
-    this.mapOptions = shuffle(this.queueConfigService.queueConfig.maps.filter(m => m !== this.lastPlayedMap))
-      .slice(0, this.mapVoteOptionCount);
+    this.mapOptions = shuffle(
+        this.queueConfigService.queueConfig.maps
+          .filter(m => m.name !== this.lastPlayedMap)
+          .map(m => m.name)
+    ).slice(0, this.mapVoteOptionCount);
     this.votes = [];
     this._results.next(this.getResults());
   }

src/queue/services/queue-config.service.spec.ts

@@ -1,26 +1,46 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { QueueConfigService } from './queue-config.service';
-import { Environment } from '@/environment/environment';
-
-class EnvironmentStub {
-  queueConfig = '6v6';
-}
 
 describe('QueueConfigService', () => {
-  let service: QueueConfigService;
-
-  beforeEach(async () => {
-    const module: TestingModule = await Test.createTestingModule({
-      providers: [
-        QueueConfigService,
-        { provide: Environment, useClass: EnvironmentStub },
+  describe('with a valid config', () => {
+    const config = `{
+      "teamCount": 2,
+      "classes": [
+        {
+          "name": "soldier",
+          "count": 1
+        }
+      ],
+      "maps": [
+        {
+          "name": "cp_process_final",
+          "configName": "5cp"
+        },
+        {
+          "name": "cp_gullywash_final1",
+          "configName": "5cp"
+        }
       ],
-    }).compile();
+      "configs": {
+        "5cp": "etf2l_6v6_5cp"
+      }
+    }`;
 
-    service = module.get<QueueConfigService>(QueueConfigService);
-  });
+    let service: QueueConfigService;
+
+    beforeEach(async () => {
+      const module: TestingModule = await Test.createTestingModule({
+        providers: [
+          QueueConfigService,
+          { provide: 'QUEUE_CONFIG_JSON', useValue: config },
+        ],
+      }).compile();
+
+      service = module.get<QueueConfigService>(QueueConfigService);
+    });
 
-  it('should be defined', () => {
-    expect(service).toBeDefined();
+    it('should be defined', () => {
+      expect(service).toBeDefined();
+    });
   });
 });