Update handling of dev and beta modes

- Replace the `start` command in `package.json`
with `start:prod` and `start:beta`, which run the game
in "production" and "beta" mode respectively

Previously, `start` would run the game in "development" mode
just like `start:dev` due to the `vite` command running in
"development" mode by default if no `--mode` arg was passed

- Add `IS_DEV` global constant that checks for "development" mode

- Remove `Api#isLocal` and replace its uses with `BYPASS_LOGIN`

- Add " (Beta)" to window title and game version displayed
on the title screen when in "development" or "beta" mode

- Replace `.then()` pattern with `await` in `main.ts`

- Remove obsolete commented code in `game-data.ts`

Author: DayKev

package.json

@@ -4,7 +4,8 @@
   "version": "0.1.0",
   "type": "module",
   "scripts": {
-    "start": "vite",
+    "start:prod": "vite --mode production",
+    "start:beta": "vite --mode beta",
     "start:dev": "vite --mode development",
     "build": "vite build",
     "build:beta": "vite build --mode beta",

src/constants/app-constants.ts

@@ -64,5 +64,16 @@ export const RUN_HISTORY_LIMIT: number = 25;
 /** The number of save slots available to players. */
 export const SAVE_SLOT_LIMIT: number = 5;
 
-/** Whether the app is running in beta (or development) mode. */
+/**
+ * `true` if running in "beta" mode via either of:
+ * - `pnpm start:beta` (which runs `vite --mode beta`)
+ * - A build created via `pnpm build:beta`
+ */
 export const IS_BETA = import.meta.env.MODE === "beta";
+
+/**
+ * `true` if running in "development" mode via either of:
+ * - `pnpm start:dev` (which runs `vite --mode development`)
+ * - A build created via `pnpm build:dev`
+ */
+export const IS_DEV = import.meta.env.MODE === "development";

src/main.ts

@@ -1,20 +1,20 @@
 import "#app/polyfills"; // polyfills must be first
 import "#app/phaser-extensions";
 
-// Catch global errors and display them in an alert so users can report the issue.
+import { IS_BETA, IS_DEV } from "#constants/app-constants";
+
+if (IS_DEV || IS_BETA) {
+  document.title += " (Beta)";
+}
+
 window.onerror = (_message, _source, _lineno, _colno, error) => {
   console.error(error);
-  // const errorString = `Received unhandled error. Open browser console and click OK to see details.\nError: ${message}\nSource: ${source}\nLine: ${lineno}\nColumn: ${colno}\nStack: ${error.stack}`;
-  //alert(errorString);
   // Avoids logging the error a second time.
   return true;
 };
 
-// Catch global promise rejections and display them in an alert so users can report the issue.
 window.addEventListener("unhandledrejection", (event) => {
-  // const errorString = `Received unhandled promise rejection. Open browser console and click OK to see details.\nReason: ${event.reason}`;
   console.error(event.reason);
-  //alert(errorString);
 });
 
 document.fonts.load("16px emerald").then(() => document.fonts.load("10px pkmnems"));
@@ -36,17 +36,14 @@ const startGame = async (manifest?: any) => {
   }
 };
 
-fetch("/manifest.json")
-  .then((res) => res.json())
-  .then((jsonResponse) => {
-    startGame(jsonResponse.manifest);
-  })
-  .catch(() => {
-    // Manifest not found (likely local build)
-    startGame();
-  })
-  .finally(() => {
-    if (import.meta.env.MODE === "development") {
-      import("./dev");
-    }
-  });
+try {
+  const json = await (await fetch("/manifest.json")).json();
+  await startGame(json.manifest);
+} catch {
+  // The manifest wasn't found, likely due to running locally
+  await startGame();
+}
+
+if (IS_DEV) {
+  await import("./dev");
+}

src/phases/game-over-phase.ts

@@ -1,6 +1,7 @@
 import { api } from "#api/api";
 import { clientSessionId } from "#app/account";
 import { globalScene } from "#app/global-scene";
+import { BYPASS_LOGIN } from "#constants/app-constants";
 import { getCharVariantFromDialogue } from "#data/dialogue";
 import type { PokemonSpecies } from "#data/pokemon-species";
 import { AchvCategory } from "#enums/achv-category";
@@ -200,12 +201,9 @@ export class GameOverPhase extends BattlePhase {
       });
     };
 
-    /**
-     * Check to see if the game is running offline
-     * If Online, execute apiFetch as intended
-     * If Offline, execute offlineNewClear() only for victory, a localStorage implementation of newClear daily run checks
-     */
-    if (!api.isLocal || api.isConnected) {
+    // If Online, execute `apiFetch` as intended
+    // If Offline, execute `offlineNewClear()` only for victory, a localStorage implementation of `newClear` daily run checks
+    if (!BYPASS_LOGIN || api.isConnected) {
       api.savedata.session
         .newclear({ slot: globalScene.sessionSlotId, isVictory: this.isVictory, clientSessionId })
         .then((success) => doGameOver(success));

src/phases/title-phase.ts

@@ -3,6 +3,7 @@ import { loggedInUser } from "#app/account";
 import { getGameMode, getModeName } from "#app/game-mode";
 import { globalScene } from "#app/global-scene";
 import { Phase } from "#app/phase";
+import { BYPASS_LOGIN } from "#constants/app-constants";
 import { fetchDailyRunSeed, getDailyRunStarters } from "#data/daily-run";
 import { GameModes } from "#enums/game-modes";
 import { ModifierPoolType } from "#enums/modifier-pool-type";
@@ -247,8 +248,9 @@ export class TitlePhase extends Phase {
         });
       };
 
-      // If Online, calls seed fetch from db to generate daily run. If Offline, generates a daily run based on current date.
-      if (!api.isLocal || api.isConnected) {
+      // If Online, calls seed fetch from db to generate daily run.
+      // If Offline, generates a daily run based on current date.
+      if (!BYPASS_LOGIN || api.isConnected) {
         fetchDailyRunSeed()
           .then((seed) => {
             if (seed) {

src/plugins/api/api.ts

@@ -18,8 +18,6 @@ class Api extends ApiBase {
   public readonly admin: AdminApi;
   public readonly savedata: SavedataApi;
 
-  /** Wheter the hostname is 'localhost' or an IP address, and ensure a port is specified. */
-  private readonly _isLocal: boolean;
   /** Whether the server/api is connected. By default we assume `true`. */
   private _isConnected: boolean;
 
@@ -31,22 +29,13 @@ class Api extends ApiBase {
     this.daily = new DailyApi(base);
     this.admin = new AdminApi(base);
     this.savedata = new SavedataApi(base);
-    this._isLocal =
-      ((window.location.hostname === "localhost" || /^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$/.test(window.location.hostname))
-        && window.location.port !== "")
-      || window.location.hostname === "";
   }
 
   /** Whether the server/api is connected. By default we assume `true`. */
   public get isConnected() {
     return this._isConnected;
   }
 
-  /** Wheter the hostname is 'localhost' or an IP address, and ensure a port is specified. */
-  public get isLocal() {
-    return this._isLocal;
-  }
-
   /**
    * Request game title-stats.
    */
@@ -129,7 +118,7 @@ class Api extends ApiBase {
       }
     }
     if (import.meta.env.VITE_API_DEBUG === "1") {
-      console.log("isLocalServerConnected:", this.isConnected);
+      console.log("`Api#isConnected`:", this.isConnected);
     }
   }
 

src/system/game-data.ts

@@ -88,7 +88,7 @@ import { randInt } from "#utils/random-utils";
 import { AES, enc } from "crypto-js";
 import i18next from "i18next";
 
-const saveKey = "x0i2O7WRiANTqPmZ"; // Temporary; secure encryption is not yet necessary
+const saveKey = "x0i2O7WRiANTqPmZ";
 
 function encrypt(data: string, bypassLogin: boolean): string {
   if (bypassLogin) {
@@ -415,42 +415,12 @@ export class GameData {
    * At the moment, only retrievable from locale cache
    */
   async getRunHistoryData(): Promise<RunHistoryData> {
-    if (!api.isLocal) {
-      /**
-       * Networking Code DO NOT DELETE!
-       * Note: Might have to be migrated to `api.ts`
-       *
-      const response = await Utils.apiFetch("savedata/runHistory", true);
-      const data = await response.json();
-      */
-      const lsItemKey = getLocalStorageKey(GameDataType.RUN_HISTORY);
-      const lsItem = localStorage.getItem(lsItemKey);
-      if (lsItem) {
-        const cachedResponse = lsItem;
-        if (cachedResponse) {
-          const runHistory = JSON.parse(decrypt(cachedResponse, BYPASS_LOGIN));
-          return runHistory;
-        }
-        return {};
-        // check to see whether cachedData or serverData is more up-to-date
-        /**
-       * Networking Code DO NOT DELETE!
-       *
-        if ( Object.keys(cachedRHData).length >= Object.keys(data).length ) {
-          return cachedRHData;
-        }
-        */
-      }
-      localStorage.setItem(lsItemKey, "");
-      return {};
-    }
     const lsItemKey = getLocalStorageKey(GameDataType.RUN_HISTORY);
     const lsItem = localStorage.getItem(lsItemKey);
     if (lsItem) {
       const cachedResponse = lsItem;
       if (cachedResponse) {
-        const runHistory: RunHistoryData = JSON.parse(decrypt(cachedResponse, BYPASS_LOGIN));
-        return runHistory;
+        return JSON.parse(decrypt(cachedResponse, BYPASS_LOGIN));
       }
       return {};
     }
@@ -460,9 +430,10 @@ export class GameData {
 
   /**
    * Saves a new entry to Run History
-   * @param runEntry: most recent SessionSaveData of the run
-   * @param isVictory: result of the run
-   * Arbitrary limit of 25 runs per player - Will delete runs, starting with the oldest one, if needed
+   * @param runEntry - Most recent SessionSaveData of the run
+   * @param isVictory - Result of the run
+   * @remarks
+   * Currently limited to 25 runs. If a 26th run would be saved, the oldest is deleted.
    */
   async saveRunHistory(runEntry: SessionSaveData, isVictory: boolean): Promise<boolean> {
     const runHistoryData = await this.getRunHistoryData();
@@ -487,20 +458,6 @@ export class GameData {
       getLocalStorageKey(GameDataType.RUN_HISTORY),
       encrypt(JSON.stringify(runHistoryData), BYPASS_LOGIN),
     );
-    /**
-     * Networking Code DO NOT DELETE
-     *
-    if (!Utils.isLocal) {
-      try {
-        await Utils.apiPost("savedata/runHistory", JSON.stringify(runHistoryData), undefined, true);
-        return true;
-      } catch (err) {
-        console.log("savedata/runHistory POST failed : ", err);
-        return false;
-      }
-    }
-    NOTE: should be adopted to `api.ts`
-    */
     return true;
   }
 

src/ui/handlers/menu-ui-handler.ts

@@ -2,7 +2,7 @@ import { api } from "#api/api";
 import { loggedInUser, updateUserInfo } from "#app/account";
 import { globalScene } from "#app/global-scene";
 import { handleTutorial } from "#app/tutorial";
-import { BYPASS_LOGIN, IS_BETA, SAVE_SLOT_LIMIT, SESSION_ID_COOKIE } from "#constants/app-constants";
+import { BYPASS_LOGIN, IS_BETA, IS_DEV, SAVE_SLOT_LIMIT, SESSION_ID_COOKIE } from "#constants/app-constants";
 import { GAME_HEIGHT, GAME_WIDTH } from "#constants/ui-constants";
 import { AdminMode } from "#enums/admin-mode";
 import { Button } from "#enums/button";
@@ -223,7 +223,7 @@ export class MenuUiHandler extends OptionSelectUiHandler {
       });
     };
     // Import Session
-    if (api.isLocal || IS_BETA) {
+    if (IS_DEV || IS_BETA) {
       manageDataOptions.push({
         label: i18next.t("menuUiHandler:importSession"),
         handler: () => {
@@ -281,7 +281,7 @@ export class MenuUiHandler extends OptionSelectUiHandler {
       keepOpen: true,
     });
     // Import Data
-    if (api.isLocal || IS_BETA) {
+    if (IS_DEV || IS_BETA) {
       manageDataOptions.push({
         label: i18next.t("menuUiHandler:importData"),
         handler: () => {
@@ -320,8 +320,7 @@ export class MenuUiHandler extends OptionSelectUiHandler {
     );
 
     // TODO: fully remove test dialogue option and related handlers
-    if (api.isLocal || IS_BETA) {
-      // this should make sure we don't have this option in live
+    if (IS_DEV || IS_BETA) {
       manageDataOptions.push({
         label: "Test Dialogue",
         handler: () => {

src/ui/handlers/save-slot-select-ui-handler.ts

@@ -1,6 +1,6 @@
 import { getModeName } from "#app/game-mode";
 import { globalScene } from "#app/global-scene";
-import { SAVE_SLOT_LIMIT } from "#constants/app-constants";
+import { IS_BETA, IS_DEV, SAVE_SLOT_LIMIT } from "#constants/app-constants";
 import { GAME_HEIGHT, GAME_WIDTH } from "#constants/ui-constants";
 import { Button } from "#enums/button";
 import { RunDisplayMode } from "#enums/run-display-mode";
@@ -138,7 +138,7 @@ export class SaveSlotSelectUiHandler extends MessageUiHandler {
                   },
                   canBypassInputDelay: true,
                   yOffset: 28,
-                  inputDelay: import.meta.env.DEV ? 300 : 2000,
+                  inputDelay: IS_DEV || IS_BETA ? 300 : 2000,
                 };
                 ui.showText(i18next.t("saveSlotSelectUiHandler:overwriteData"), {
                   callback: () => ui.setOverlayMode<ConfirmUiHandler>(UiMode.CONFIRM, overwriteDataOptions),

src/ui/handlers/title-ui-handler.ts

@@ -1,6 +1,7 @@
 import { api } from "#api/api";
 import { globalScene } from "#app/global-scene";
 import { timedEventManager } from "#app/timed-event-manager";
+import { IS_BETA, IS_DEV } from "#constants/app-constants";
 import { GAME_HEIGHT, GAME_WIDTH } from "#constants/ui-constants";
 import { getSplashMessages } from "#data/splash-messages";
 import { TextStyle } from "#enums/text-style";
@@ -110,7 +111,8 @@ export class TitleUiHandler extends OptionSelectUiHandler {
       this.splashMessage = randItem(getSplashMessages());
       this.splashMessageText.setText(i18next.t(this.splashMessage, { count: TitleUiHandler.BATTLES_WON_FALLBACK }));
 
-      this.appVersionText.setText("v" + version);
+      const betaText = IS_DEV || IS_BETA ? " (Beta)" : "";
+      this.appVersionText.setText("v" + version + betaText);
 
       const ui = this.getUi();