web: Change config to bfcacheBehavior enum (inform, restore, reload)

Author: danielhjacobs

web/packages/core/src/internal/player/inner.tsx

@@ -9,6 +9,7 @@ import {
     UnmuteOverlay,
     URLLoadOptions,
     WindowMode,
+    CacheBehavior,
 } from "../../public/config";
 import { MovieMetadata, ReadyState } from "../../public/player";
 import { ruffleShadowTemplate } from "../ui/shadow-template";
@@ -2137,10 +2138,14 @@ export class InnerPlayer {
         // Do not display the message if another one is already shown or website opted out.
         if (
             this.container.querySelector("#message-overlay") !== null ||
-            this.loadedConfig?.hideRestoredMessage
+            this.loadedConfig?.bfcacheBehavior === CacheBehavior.Restore
         ) {
             return;
         }
+        if (this.loadedConfig?.bfcacheBehavior === CacheBehavior.Reload) {
+            this.reload();
+            return;
+        }
         const message = textAsParagraphs("message-restored-from-bfcache");
         this.displayMessageOrElement(message);
 

web/packages/core/src/public/config/default.ts

@@ -10,6 +10,7 @@ import {
     UnmuteOverlay,
     WindowMode,
     ScrollingBehavior,
+    CacheBehavior,
 } from "./load-options";
 
 export const DEFAULT_CONFIG: Required<BaseLoadOptions> = {
@@ -22,7 +23,7 @@ export const DEFAULT_CONFIG: Required<BaseLoadOptions> = {
     upgradeToHttps: true,
     compatibilityRules: true,
     favorFlash: true,
-    hideRestoredMessage: false,
+    bfcacheBehavior: CacheBehavior.Inform,
     warnOnUnsupportedContent: true,
     logLevel: LogLevel.Error,
     showSwfDownload: false,

web/packages/core/src/public/config/load-options.ts

@@ -361,6 +361,26 @@ export enum GamepadButton {
     DPadRight = "dpad-right",
 }
 
+/**
+ * The behavior when the bfcache takes effect
+ */
+export enum CacheBehavior {
+    /**
+     * Inform the user that the content was restore from the bfcache.
+     */
+    Inform = "inform",
+
+    /**
+     * Restore the content from the bfcache without a message.
+     */
+    Restore = "restore",
+
+    /**
+     * Reload the content so it starts fresh if the bfcache takes effect.
+     */
+    Reload = "reload",
+}
+
 /**
  * Any options used for loading a movie.
  */
@@ -451,11 +471,11 @@ export interface BaseLoadOptions {
     favorFlash?: boolean;
 
     /**
-     * Hide the message when content is restored from the back/forward cache.
+     * Behavior when the bfcache takes effect
      *
-     * @default false
+     * @default CacheBehavior.Inform
      */
-    hideRestoredMessage?: boolean;
+    bfcacheBehavior?: CacheBehavior;
 
     /**
      * This is no longer used and does not affect anything.