flowstride 1.0.18 → 1.0.20-rc.2

package/dist/runner/flow_worker.js

@@ -353,7 +353,6 @@ class FlowWorker extends events_1.EventEmitter {
         this.isAborted = true;
     }
     async runBatch(filesToProcess) {
-        // this.config.headless = true;
         const isCliHeadless = process.argv.includes("--headless");
         if (isCliHeadless) {
             this.config.headless = true;
@@ -365,6 +364,10 @@ class FlowWorker extends events_1.EventEmitter {
         this.isAborted = false;
         this.isDebugHalted = false;
         const sigintHandler = async () => {
+            if (this.config.ci) {
+                this.abort();
+                return;
+            }
             if (!this.isSilent) {
                 console.log(chalk_1.default.yellow("\n[Flowstride]: Process interrupted. Gracefully shutting down..."));
             }
@@ -374,7 +377,8 @@ class FlowWorker extends events_1.EventEmitter {
                 await this.web.shutdown();
             }
             catch (e) { }
-            process.exit(0);
+            if (!this.config.ci)
+                process.exit(0);
         };
         process.once("SIGINT", sigintHandler);
         try {
@@ -398,6 +402,7 @@ class FlowWorker extends events_1.EventEmitter {
                 try {
                     const fileName = path.basename(filePath);
                     this.currentFileName = fileName;
+                    this.config.testFile = fileName;
                     this.localVariables = {};
                     this.localBrowserSessions = {};
                     this.api.resetState();
@@ -472,20 +477,24 @@ class FlowWorker extends events_1.EventEmitter {
                                 .getPage()
                                 .waitForLoadState("networkidle", { timeout: 4000 })
                                 .catch(() => { });
-                            await new Promise((resolve) => setTimeout(resolve, 2000));
+                            if (!this.config.ci)
+                                await new Promise((resolve) => setTimeout(resolve, 2000));
                         }
                     }
                     if (this.isAborted)
                         break;
                     if (!this.isSilent)
                         console.log(chalk_1.default.gray("\n[Execution]: Finalizing browser actions..."));
-                    await new Promise((resolve) => setTimeout(resolve, 2000));
+                    if (!this.config.ci)
+                        await new Promise((resolve) => setTimeout(resolve, 2000));
                     try {
                         const baseName = this.currentFileName.replace(".flow", "");
                         const mockCloudDir = path.join(process.cwd(), ".flowstride", "mock-cloud");
                         if (!fs.existsSync(mockCloudDir))
                             fs.mkdirSync(mockCloudDir, { recursive: true });
                         const targetVideoPath = path.join(mockCloudDir, `${baseName}.webm`);
+                        for (const message of this.web.pageErrors || [])
+                            this.broadcast('BROWSER_ERROR', { message, fileName: this.currentFileName });
                         await this.web.shutdown(targetVideoPath);
                         if (!this.isSilent)
                             console.log(chalk_1.default.gray(`      [Cloud Sync]: Video safely encoded and preserved for ${this.currentFileName}`));
@@ -507,6 +516,8 @@ class FlowWorker extends events_1.EventEmitter {
                         if (!fs.existsSync(mockCloudDir))
                             fs.mkdirSync(mockCloudDir, { recursive: true });
                         const targetVideoPath = path.join(mockCloudDir, `${baseName}.webm`);
+                        for (const message of this.web.pageErrors || [])
+                            this.broadcast('BROWSER_ERROR', { message, fileName: this.currentFileName });
                         await this.web.shutdown(targetVideoPath);
                         if (!this.isSilent)
                             console.log(chalk_1.default.gray(`      [Cloud Sync]: Video safely encoded and preserved for ${this.currentFileName}`));
@@ -519,7 +530,7 @@ class FlowWorker extends events_1.EventEmitter {
                     });
                 }
             }
-            if (!this.isSilent && !this.isAborted) {
+            if (!this.config.ci && !this.isSilent && !this.isAborted) {
                 if (this.isDebugHalted) {
                     console.log(chalk_1.default.cyan("\n[Execution]: Test suite halted by debug flag."));
                 }
@@ -529,6 +540,16 @@ class FlowWorker extends events_1.EventEmitter {
             }
         }
         finally {
+            if (this.config.ci && this.isAborted) {
+                try {
+                    const directory = path.join(process.cwd(), '.flowstride', 'artifacts');
+                    fs.mkdirSync(directory, { recursive: true });
+                    await this.web.shutdown(path.join(directory, this.currentFileName.replace(/\.flow$/, '') + '.webm'));
+                }
+                catch (error) {
+                    this.broadcast('WORKER_ERROR', { message: error.message });
+                }
+            }
             process.removeListener("SIGINT", sigintHandler);
         }
     }
@@ -722,14 +743,35 @@ class FlowWorker extends events_1.EventEmitter {
         }
         switch (action) {
             case "extract":
-                this.processExtractions([
-                    {
-                        target: payload.target,
-                        jsonPath: payload.jsonPath,
-                        variableName: payload.variableName,
-                        isGlobal: payload.isGlobal,
-                    },
-                ]);
+                if (["resBody", "resHeader", "cookie"].includes(payload.target)) {
+                    this.processExtractions([
+                        {
+                            target: payload.target,
+                            jsonPath: payload.jsonPath,
+                            variableName: payload.variableName,
+                            isGlobal: payload.isGlobal,
+                        },
+                    ]);
+                }
+                else {
+                    let extractedString = "";
+                    if (payload.target === "text") {
+                        extractedString = await this.web.extractText(payload.selector, payload.elementType);
+                    }
+                    else if (payload.target === "value") {
+                        extractedString = await this.web.extractValue(payload.selector, payload.elementType);
+                    }
+                    else if (payload.target === "attribute") {
+                        const val = await this.web.getAttribute(payload.selector, payload.attribute, payload.elementType);
+                        extractedString = val || "";
+                    }
+                    if (payload.isGlobal) {
+                        FlowWorker.globalVariables[payload.variableName] = extractedString;
+                    }
+                    else {
+                        this.localVariables[payload.variableName] = extractedString;
+                    }
+                }
                 break;
             case "getOtp":
                 if (!this.isSilent) {
@@ -1176,6 +1218,8 @@ class FlowWorker extends events_1.EventEmitter {
         });
     }
     async startStreaming() {
+        if (this.config.ci)
+            return;
         const page = this.web.getPage();
         if (this.currentCdpSession) {
             await this.currentCdpSession.detach().catch(() => { });

package/dist/runner/plugin_manager.d.ts

@@ -8,6 +8,7 @@ export declare class PluginManager {
     private store;
     private apiProxy;
     private dbProxy;
+    private game;
     constructor(config: FlowstrideConfig, web: WebAdapter, store: TemporaryStore, apiProxy: ApiProxy);
     execute(actionName: string, args: any, saveAs?: string): Promise<any>;
 }

package/dist/runner/plugin_manager.js

@@ -32,8 +32,14 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluginManager = void 0;
+const deadline_1 = require("../ci/deadline");
+const node_fs_1 = __importDefault(require("node:fs"));
+const sdk_1 = require("../game/sdk");
 const path = __importStar(require("path"));
 const db_proxy_1 = require("../sdk/db_proxy");
 class PluginManager {
@@ -42,12 +48,14 @@ class PluginManager {
     store;
     apiProxy;
     dbProxy;
+    game;
     constructor(config, web, store, apiProxy) {
         this.config = config;
         this.web = web;
         this.store = store;
         this.apiProxy = apiProxy;
         this.dbProxy = new db_proxy_1.DbProxy();
+        this.game = new sdk_1.GameSDK(() => this.web.getPage(), this.config);
     }
     async execute(actionName, args, saveAs) {
         const lastDotIndex = actionName.lastIndexOf(".");
@@ -56,6 +64,16 @@ class PluginManager {
         }
         const pluginFile = actionName.substring(0, lastDotIndex);
         const functionName = actionName.substring(lastDotIndex + 1);
+        if (pluginFile === 'flowstride:game') {
+            const actions = ['tap', 'drag', 'swipe', 'key', 'checkpoint', 'snapshot', 'expectVisual', 'state', 'expectState', 'snapshotState', 'expectPreserved', 'fixture', 'select'];
+            if (!actions.includes(functionName))
+                throw new Error(`Unknown native game action: ${functionName}`);
+            const operation = this.game[functionName](args);
+            const result = this.config.ci ? await (0, deadline_1.withDeadline)(operation, this.config.timeout) : await operation;
+            if (saveAs)
+                this.store.set(saveAs, result);
+            return result;
+        }
         let fullPath;
         if (pluginFile.includes("/") || pluginFile.includes("\\")) {
             fullPath = path.resolve(process.cwd(), `${pluginFile}.ts`);
@@ -84,6 +102,19 @@ class PluginManager {
                 throw new Error(`Plugin function "${functionName}" not found in ${fullPath}`);
             }
             const sdk = {
+                game: this.game,
+                browser: { page: () => this.web.getPage() },
+                run: { device: this.config.device || 'desktop', artifactsDir: this.config.artifactsDir || path.resolve('flowstride-artifacts'),
+                    attach: (name, data) => {
+                        if (!/^[a-zA-Z0-9_.-]+$/.test(name) || name === '.' || name === '..')
+                            throw new Error('Attachment name must be a simple filename.');
+                        const directory = this.config.artifactsDir || path.resolve('flowstride-artifacts');
+                        node_fs_1.default.mkdirSync(directory, { recursive: true });
+                        const prefix = this.config.testFile ? this.config.testFile.replace(/[^a-zA-Z0-9_.-]/g, '_') + '-' : '';
+                        const file = path.join(directory, prefix + name);
+                        node_fs_1.default.writeFileSync(file, data);
+                        return file;
+                    } },
                 api: {
                     get: (url, headers) => this.apiProxy.get(url, headers),
                     post: (url, body, headers) => this.apiProxy.post(url, body, headers),
@@ -150,7 +181,8 @@ class PluginManager {
                         .substring(2, 2 + length),
                 },
             };
-            const result = await action(sdk, args);
+            const operation = action(sdk, args);
+            const result = this.config.ci ? await (0, deadline_1.withDeadline)(operation, this.config.timeout) : await operation;
             if (saveAs) {
                 this.store.set(saveAs, result);
             }

package/dist/types/index.d.ts

@@ -1,4 +1,31 @@
 export interface FlowstrideConfig {
+    ci?: boolean;
+    device?: 'desktop' | 'phone' | 'landscape';
+    viewport?: {
+        width: number;
+        height: number;
+    };
+    testDir?: string;
+    artifactsDir?: string;
+    recordVideo?: boolean;
+    browserErrors?: 'fail' | 'record';
+    webServer?: {
+        command: string;
+        url: string;
+        cwd?: string;
+        timeout?: number;
+    };
+    testFile?: string;
+    onRunEvent?: (event: any) => void;
+    bail?: boolean;
+    isCloudSyncActive?: boolean;
+    machineToken?: string | null;
+    workspaceId?: string | null;
+    manifest?: {
+        plan?: string;
+        maxWorkers?: number | 'unlimited';
+        [key: string]: any;
+    } | null;
     baseUrl?: string;
     timeout: number;
     headless: boolean;
@@ -46,6 +73,15 @@ export interface SessionDefinition {
     };
 }
 export interface FlowstrideSDK {
+    game: import('../game/sdk').GameSDK;
+    browser: {
+        page: () => import('playwright').Page;
+    };
+    run: {
+        device: string;
+        artifactsDir: string;
+        attach: (name: string, data: string | Buffer) => string;
+    };
     api: {
         get: (url: string, headers?: Record<string, string>) => Promise<any>;
         post: (url: string, body: any, headers?: Record<string, string>) => Promise<any>;

package/examples/native-game/flows/canvas.flow

@@ -0,0 +1,13 @@
+Feature: Native canvas game testing
+let game = "flowstride:game"
+Scenario: A tap changes game state and rendering
+Given "The game is ready"
+  flow.open "http://127.0.0.1:5189"
+  game.fixture {"name":"reset"}
+  game.snapshot {"name":"before","canvas":"#game"}
+When "The player taps the game"
+  game.tap {"canvas":"#game","x":0.5,"y":0.5}
+Then "The score and scene change"
+  game.expectState {"path":"score","equals":1}
+  game.expectVisual {"name":"before","canvas":"#game","minChange":0.9}
+  game.checkpoint {"name":"game-result","canvas":"#game"}

package/examples/native-game/flowstride.config.json

@@ -0,0 +1,12 @@
+{
+  "testDir": "flows",
+  "device": "phone",
+  "timeout": 5000,
+  "artifactsDir": "flowstride-artifacts",
+  "recordVideo": true,
+  "webServer": {
+    "command": "node server.mjs",
+    "url": "http://127.0.0.1:5189",
+    "timeout": 10000
+  }
+}

package/examples/native-game/server.mjs

@@ -0,0 +1,12 @@
+import http from 'node:http';
+import { registerGame } from 'flowstride/dist/game/bridge.js';
+const html = `<!doctype html><html><head><title>Flowstride native game fixture</title></head><body>
+<canvas id="game" width="300" height="200" style="touch-action:none"></canvas>
+<script>
+const canvas=document.querySelector('canvas'),context=canvas.getContext('2d');
+const state={score:0};
+function draw(){context.fillStyle=state.score?'blue':'red';context.fillRect(0,0,canvas.width,canvas.height);}
+canvas.onpointerdown=()=>{state.score++;draw();};draw();
+const register=${registerGame.toString()};register({readState:()=>state,testMode:true,fixtures:{reset:()=>{state.score=0;draw();}}});
+</script></body></html>`;
+http.createServer((_request,response)=>{response.setHeader('Content-Type','text/html');response.end(html);}).listen(5189,'127.0.0.1');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowstride",
-  "version": "1.0.18",
+  "version": "1.0.20-rc.2",
   "description": "An opensource flowfirst test automation framework",
   "workspaces": [
     "packages/flowstride_report"
@@ -9,7 +9,10 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist",
-    "src/ui/dist"
+    "src/ui/dist",
+    "NATIVE_CI.md",
+    "examples/native-game",
+    "RELEASE_NOTES.md"
   ],
   "bin": {
     "flowstride": "dist/cli/index.js"
@@ -18,7 +21,8 @@
     "build": "tsc",
     "flowstride": "node ./dist/cli/index.js",
     "test": "echo 'Test script to be configured'",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "test:native": "node --test --test-concurrency=1 tests/native/*.test.cjs"
   },
   "keywords": [
     "automation",
@@ -29,7 +33,7 @@
   "author": "Samuel Okolo",
   "license": "MIT",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=22.12.0"
   },
   "dependencies": {
     "@inquirer/prompts": "^7.10.1",
@@ -39,7 +43,7 @@
     "dotenv": "^17.4.2",
     "open": "^11.0.0",
     "ora": "^5.4.1",
-    "playwright": "^1.59.1",
+    "playwright": "1.59.1",
     "playwright-extra": "^4.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "tar": "^7.5.16",
@@ -54,5 +58,10 @@
   },
   "optionalDependencies": {
     "@rolldown/binding-darwin-arm64": "^0.15.1"
+  },
+  "publishConfig": {
+    "tag": "next",
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   }
 }