@vnejs/plugins.scenario.fastforward 0.1.16 → 0.1.18

package/dist/modules/visits.d.ts

@@ -5,7 +5,7 @@ import type { ModuleGlobalStateFastforwardVisits } from "@vnejs/contracts.scenar
 import type { FastforwardPluginConstants, FastforwardPluginEvents, FastforwardPluginParams, FastforwardPluginSettings } from "../types.js";
 export declare class FastforwardVisits extends ModuleCore<FastforwardPluginEvents, FastforwardPluginConstants, FastforwardPluginSettings, FastforwardPluginParams, ModuleGlobalStateFastforwardVisits> {
     name: string;
-    visits: Record<string, number>;
+    visits: Set<string>;
     subscribe: () => void;
     init: () => Promise<void>;
     onExec: ({ module, block, line, args, keywords }?: ScenarioExecPayload) => Promise<void>;

package/dist/modules/visits.js

@@ -1,8 +1,9 @@
 import "@vnejs/contracts.core.scenario";
 import { ModuleCore } from "@vnejs/module.core";
+const STORAGE_VALUE = 1;
 export class FastforwardVisits extends ModuleCore {
     name = "fastforward.visits";
-    visits = {};
+    visits = new Set();
     subscribe = () => {
         this.on(this.EVENTS.SCENARIO.EXEC, this.onExec);
         this.on(this.EVENTS.FASTFORWARD.CHECK, this.onVisitCheck);
@@ -12,19 +13,22 @@ export class FastforwardVisits extends ModuleCore {
     };
     init = async () => {
         await this.emit(this.EVENTS.SETTINGS.INIT, { name: this.SETTINGS.FASTFORWARD.CHECK_VISITED, value: this.PARAMS.FASTFORWARD.DEFAULT_CHECK_VISITED });
-        this.visits = (await this.emitOne(this.EVENTS.STORAGE.GET_ALL, { module: this.name }));
+        this.visits = new Set(Object.keys((await this.emitOne(this.EVENTS.STORAGE.GET_ALL, { module: this.name }))));
     };
     onExec = async ({ module, block, line, args = {}, keywords = [] } = {}) => {
         const key = (await this.emitOne(this.EVENTS.VENDORS.HASH, this.state));
-        this.visits[key] = 1;
-        this.emit(this.EVENTS.STORAGE.SET, { module: this.name, key, value: 1 });
+        this.visits.add(key);
+        this.emit(this.EVENTS.STORAGE.SET, { module: this.name, key, value: STORAGE_VALUE });
         this.setState({ module, block, line, args, keywords, label: this.globalState.scenario.label });
     };
     onVisitCheck = async () => {
-        const isAllowed = !this.shared.settings[this.SETTINGS.FASTFORWARD.CHECK_VISITED] || Boolean(this.visits[(await this.getHash())]);
+        const isAllowed = !this.shared.settings[this.SETTINGS.FASTFORWARD.CHECK_VISITED] || this.visits.has((await this.getHash()));
         return { isAllowed, source: this.name };
     };
-    onClear = () => this.emit(this.EVENTS.STORAGE.RM_ALL, { module: this.name });
+    onClear = () => {
+        this.visits.clear();
+        return this.emit(this.EVENTS.STORAGE.RM_ALL, { module: this.name });
+    };
     getHash = () => this.emitOne(this.EVENTS.VENDORS.HASH, this.state);
     getDefaultState = () => ({ label: "", args: {}, keywords: [] });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/plugins.scenario.fastforward",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "tsconfig.json"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "npx @vnejs/monorepo test",
     "build": "npx @vnejs/monorepo package",
     "publish:major:plugin": "npm run publish:major",
     "publish:minor:plugin": "npm run publish:minor",
@@ -37,6 +37,8 @@
     "@vnejs/shared": "~0.1.0"
   },
   "devDependencies": {
-    "@vnejs/configs.ts-common": "~0.1.0"
+    "@vnejs/configs.ts-common": "~0.1.0",
+    "@vnejs/configs.vitest": "~0.1.0",
+    "@vnejs/test-utils": "~0.1.0"
   }
 }

package/src/modules/visits.ts

@@ -6,6 +6,8 @@ import type { FastforwardCheckResult, ModuleGlobalStateFastforwardVisits } from
 
 import type { FastforwardPluginConstants, FastforwardPluginEvents, FastforwardPluginParams, FastforwardPluginSettings } from "../types.js";
 
+const STORAGE_VALUE = 1;
+
 export class FastforwardVisits extends ModuleCore<
   FastforwardPluginEvents,
   FastforwardPluginConstants,
@@ -15,7 +17,7 @@ export class FastforwardVisits extends ModuleCore<
 > {
   name = "fastforward.visits";
 
-  visits: Record<string, number> = {};
+  visits = new Set<string>();
 
   subscribe = () => {
     this.on(this.EVENTS.SCENARIO.EXEC, this.onExec);
@@ -30,25 +32,29 @@ export class FastforwardVisits extends ModuleCore<
   init = async () => {
     await this.emit(this.EVENTS.SETTINGS.INIT, { name: this.SETTINGS.FASTFORWARD.CHECK_VISITED, value: this.PARAMS.FASTFORWARD.DEFAULT_CHECK_VISITED });
 
-    this.visits = (await this.emitOne(this.EVENTS.STORAGE.GET_ALL, { module: this.name })) as Record<string, number>;
+    this.visits = new Set(Object.keys((await this.emitOne(this.EVENTS.STORAGE.GET_ALL, { module: this.name })) as Record<string, number>));
   };
 
   onExec = async ({ module, block, line, args = {}, keywords = [] }: ScenarioExecPayload = {}) => {
     const key = (await this.emitOne(this.EVENTS.VENDORS.HASH, this.state)) as string;
 
-    this.visits[key] = 1;
-    this.emit(this.EVENTS.STORAGE.SET, { module: this.name, key, value: 1 });
+    this.visits.add(key);
+    this.emit(this.EVENTS.STORAGE.SET, { module: this.name, key, value: STORAGE_VALUE });
 
     this.setState({ module, block, line, args, keywords, label: this.globalState.scenario.label });
   };
 
   onVisitCheck = async () => {
-    const isAllowed = !this.shared.settings[this.SETTINGS.FASTFORWARD.CHECK_VISITED] || Boolean(this.visits[(await this.getHash()) as string]);
+    const isAllowed = !this.shared.settings[this.SETTINGS.FASTFORWARD.CHECK_VISITED] || this.visits.has((await this.getHash()) as string);
 
     return { isAllowed, source: this.name } satisfies FastforwardCheckResult;
   };
 
-  onClear = () => this.emit(this.EVENTS.STORAGE.RM_ALL, { module: this.name });
+  onClear = () => {
+    this.visits.clear();
+
+    return this.emit(this.EVENTS.STORAGE.RM_ALL, { module: this.name });
+  };
 
   getHash = () => this.emitOne(this.EVENTS.VENDORS.HASH, this.state);
 

package/src/tests/fastforward.test.ts

@@ -0,0 +1,57 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+import { SUBSCRIBE_EVENTS as INTERACT_EVENTS } from "@vnejs/contracts.core.interact";
+import { SUBSCRIBE_EVENTS as SYSTEM_EVENTS } from "@vnejs/contracts.core.system";
+import { spyEvent } from "@vnejs/test-utils";
+
+import { Fastforward } from "../modules/fastforward.js";
+import { createFastforwardTestModule, registerFastforwardPluginVne, SUBSCRIBE_EVENTS } from "./setup.js";
+
+describe("Fastforward", () => {
+  beforeEach(() => {
+    registerFastforwardPluginVne();
+    vi.useFakeTimers();
+  });
+
+  it("START enables fastforward and emits CHANGED", async () => {
+    const { observer, shared } = createFastforwardTestModule(Fastforward);
+    const changed = spyEvent(observer, SUBSCRIBE_EVENTS.CHANGED);
+
+    await observer.emit(SUBSCRIBE_EVENTS.START);
+
+    expect(shared.isFastforwardOn).toBe(true);
+    expect(changed).toHaveBeenCalledExactlyOnceWith({ value: true });
+  });
+
+  it("EMIT triggers interact when all checks pass", async () => {
+    const { observer } = createFastforwardTestModule(Fastforward);
+    const interact = spyEvent(observer, INTERACT_EVENTS.EMIT);
+
+    observer.subscribe(SUBSCRIBE_EVENTS.CHECK, () => ({ isAllowed: true, source: "test" }));
+
+    await observer.emit(SUBSCRIBE_EVENTS.EMIT);
+
+    expect(interact).toHaveBeenCalledOnce();
+  });
+
+  it("EMIT disables fastforward when a check fails", async () => {
+    const { observer, shared } = createFastforwardTestModule(Fastforward);
+
+    shared.isFastforwardOn = true;
+    observer.subscribe(SUBSCRIBE_EVENTS.CHECK, () => ({ isAllowed: false, source: "test" }));
+
+    await observer.emit(SUBSCRIBE_EVENTS.EMIT);
+
+    expect(shared.isFastforwardOn).toBe(false);
+  });
+
+  it("SYSTEM.STARTED stops fastforward", async () => {
+    const { observer, shared } = createFastforwardTestModule(Fastforward);
+
+    shared.isFastforwardOn = true;
+
+    await observer.emit(SYSTEM_EVENTS.STARTED);
+
+    expect(shared.isFastforwardOn).toBe(false);
+  });
+});

package/src/tests/setup.ts

@@ -0,0 +1,33 @@
+import { PLUGIN_NAME, PARAMS, SETTINGS_KEYS, SUBSCRIBE_EVENTS } from "@vnejs/contracts.scenario.fastforward";
+import { createTestModule as baseCreateTestModule, registerCoreVne, registerVnePlugin, stubSilentEvent } from "@vnejs/test-utils";
+import { SourcesSet } from "@vnejs/sources-set";
+
+export const registerFastforwardPluginVne = () => {
+  registerCoreVne();
+  registerVnePlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, settings: SETTINGS_KEYS, params: PARAMS });
+};
+
+export const createFastforwardTestModule = <T extends Parameters<typeof baseCreateTestModule>[0]>(
+  ModuleClass: T,
+  options: Parameters<typeof baseCreateTestModule>[1] = {},
+) => {
+  const result = baseCreateTestModule(ModuleClass, {
+    shared: {
+      settings: {
+        [SETTINGS_KEYS.ENABLED]: true,
+        [SETTINGS_KEYS.DELAY]: PARAMS.DEFAULT_DELAY,
+      },
+      isFastforwardOn: false,
+      mediaNoTimeoutSources: new SourcesSet(),
+      viewForceAnimationSources: new SourcesSet(),
+      ...(options.shared as Record<string, unknown>),
+    },
+    ...options,
+  });
+
+  stubSilentEvent(result.observer, SUBSCRIBE_EVENTS.CHANGED);
+
+  return result;
+};
+
+export { SUBSCRIBE_EVENTS, PARAMS, SETTINGS_KEYS, PLUGIN_NAME };

package/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "dist"
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["dist", "node_modules"]
+  "exclude": ["dist", "node_modules", "src/tests"]
 }