Burroughs Rift stager (#525)

* Add Burroughs Rift stage tests

* Add Burroughs Rift stager

src/scripts/main.js

@@ -1174,7 +1174,6 @@ import * as detailingFuncs from './modules/details/legacy';
 
     /** @type {Object <string, Function>} */
     const location_stage_lookup = {
-        "Burroughs Rift": stagingFuncs.addBurroughsRiftStage,
         "Festive Comet": stagingFuncs.addFestiveCometStage,
         "Frozen Vacant Lot": stagingFuncs.addFestiveCometStage,
         "Foreword Farm": stagingFuncs.addForewordFarmStage,

src/scripts/modules/stages/environments/burroughsRift.ts

@@ -0,0 +1,36 @@
+import {type User} from '@scripts/types/hg';
+import {IntakeMessage} from '@scripts/types/mhct';
+import {MistTier, MistTiers} from '@scripts/types/quests';
+import {type IStager} from '../stages.types';
+
+export class BurroughsRiftStager implements IStager {
+    readonly environment: string = 'Burroughs Rift';
+
+    readonly tierToStage: Record<MistTier, string> = {
+        'tier_0': 'Mist 0',
+        'tier_1': 'Mist 1-5',
+        'tier_2': 'Mist 6-18',
+        'tier_3': 'Mist 19-20',
+    };
+
+    /**
+     * Report the misting state
+     */
+    addStage(message: IntakeMessage, userPre: User, userPost: User, journal: unknown): void {
+        const quest = userPre.quests.QuestRiftBurroughs;
+
+        if (!quest) {
+            throw new Error('QuestRiftBurroughs is undefined');
+        }
+
+        if (!this.isValidMistTier(quest.mist_tier)) {
+            throw new Error('Skipping unknown Burroughs Rift mist state');
+        }
+
+        message.stage = this.tierToStage[quest.mist_tier];
+    }
+
+    private isValidMistTier(value: unknown): value is MistTier {
+        return typeof value === 'string' && MistTiers.includes(value as MistTier);
+    }
+}

src/scripts/modules/stages/index.ts

@@ -2,6 +2,7 @@ import {type IStager} from './stages.types';
 import {BalacksCoveStager} from './environments/balacksCove';
 import {BountifulBeanstalkStager} from './environments/bountifulBeanstalk';
 import {BristleWoodsRiftStager} from './environments/bristleWoodsRift';
+import {BurroughsRiftStager} from './environments/burroughsRift';
 import {ClawShotCityStager} from './environments/clawShotCity';
 import {CursedCityStager} from './environments/cursedCity';
 import {FieryWarpathStager} from './environments/fieryWarpath';
@@ -31,6 +32,7 @@ const stageModules: IStager[]  = [
     new BalacksCoveStager(),
     new BountifulBeanstalkStager(),
     new BristleWoodsRiftStager(),
+    new BurroughsRiftStager(),
     new ClawShotCityStager(),
     new CursedCityStager(),
     new FieryWarpathStager(),

src/scripts/modules/stages/legacy.js

@@ -151,26 +151,6 @@ export function addToxicSpillStage(message, user, user_post, hunt) {
     }
 }
 
-/**
- * Report the misting state
- * @param {Object <string, any>} message The message to be sent.
- * @param {Object <string, any>} user The user state object, when the hunt was invoked (pre-hunt).
- * @param {Object <string, any>} user_post The user state object, after the hunt.
- * @param {Object <string, any>} hunt The journal entry corresponding to the active hunt.
- */
-export function addBurroughsRiftStage(message, user, user_post, hunt) {
-    const quest = user.quests.QuestRiftBurroughs;
-    message.stage = (({
-        "tier_0": "Mist 0",
-        "tier_1": "Mist 1-5",
-        "tier_2": "Mist 6-18",
-        "tier_3": "Mist 19-20",
-    })[quest.mist_tier]);
-    if (!message.stage) {
-        message.location = null;
-    }
-}
-
 /**
  * Report on the unique minigames in each sub-location. Reject hunts for which the train
  * moved / updated / departed, as the hunt stage is ambiguous.

src/scripts/types/hg.ts

@@ -59,7 +59,7 @@ export interface Quests {
     QuestQuesoGeyser?: quests.QuestQuesoGeyser
     QuestRelicHunter?: unknown
     QuestRiftBristleWoods?: quests.QuestRiftBristleWoods
-    QuestRiftBurroughs?: unknown
+    QuestRiftBurroughs?: quests.QuestRiftBurroughs
     QuestRiftFuroma?: unknown
     QuestRiftWhiskerWoods?: quests.QuestRiftWhiskerWoods
     QuestSandDunes?: quests.QuestSandDunes

src/scripts/types/quests/burroughsRift.ts

@@ -0,0 +1,7 @@
+export interface QuestRiftBurroughs {
+    mist_tier: string // MistTier
+}
+
+export const MistTiers = ['tier_0', 'tier_1', 'tier_2', 'tier_3'] as const;
+
+export type MistTier = typeof MistTiers[number];

src/scripts/types/quests/index.ts

@@ -1,6 +1,7 @@
 export * from '@scripts/types/quests/balacksCove';
 export * from '@scripts/types/quests/bountifulBeanstalk';
 export * from '@scripts/types/quests/bristleWoodsRift';
+export * from '@scripts/types/quests/burroughsRift';
 export * from '@scripts/types/quests/clawShotCity';
 export * from '@scripts/types/quests/floatingIslands';
 export * from '@scripts/types/quests/forbiddenGrove';

tests/scripts/modules/stages/environments/burroughsRift.spec.ts

@@ -0,0 +1,57 @@
+import {BurroughsRiftStager} from "@scripts/modules/stages/environments/burroughsRift";
+import {IStager} from "@scripts/modules/stages/stages.types";
+import {User} from "@scripts/types/hg";
+import {IntakeMessage} from "@scripts/types/mhct";
+
+describe('Burroughs Rift stages', () => {
+    let stager: IStager;
+    let message: IntakeMessage;
+    let preUser: User;
+    let postUser: User;
+    const journal = {};
+
+    beforeEach(() => {
+        stager = new BurroughsRiftStager();
+        message = {} as IntakeMessage;
+        preUser = {} as User;
+        postUser = {} as User;
+    });
+
+    it('should be for the Burroughs Rift environment', () => {
+        expect(stager.environment).toBe('Burroughs Rift');
+    });
+
+    it('should throw when QuestRiftBurroughs is undefined', () => {
+        preUser.quests = {};
+
+        expect(() => stager.addStage(message, preUser, postUser, journal))
+            .toThrow('QuestRiftBurroughs is undefined');
+    });
+
+    it.each`
+        level       | expected
+        ${'tier_0'} | ${'Mist 0'}
+        ${'tier_1'} | ${'Mist 1-5'}
+        ${'tier_2'} | ${'Mist 6-18'}
+        ${'tier_3'} | ${'Mist 19-20'}
+    `('should set stage to $expected when mist is at $level', ({level, expected}) => {
+
+        preUser.quests = {QuestRiftBurroughs: {
+            mist_tier: level,
+        }};
+
+        stager.addStage(message, preUser, postUser, journal);
+
+        expect(message.stage).toBe(expected);
+    });
+
+    it('should throw when mist level is unknown', () => {
+        message.location = {id: 0, name: ''};
+        preUser.quests = {QuestRiftBurroughs: {
+            mist_tier: 'tier_42',
+        }};
+
+        expect(() => stager.addStage(message, preUser, postUser, journal))
+            .toThrow('Skipping unknown Burroughs Rift mist state');
+    });
+});