@seleniumhq/side-runtime 4.0.0-alpha.0

package/dist/playback.d.ts

@@ -0,0 +1,167 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+import { Fn } from '@seleniumhq/side-commons';
+import { PlaybackTree } from './playback-tree';
+import Callstack, { Caller } from './callstack';
+import Variables from './variables';
+import { WebDriverExecutor } from '.';
+import { CommandShape, TestShape } from '@seleniumhq/side-model';
+import { CommandNode, CommandType } from './playback-tree/command-node';
+declare const EE = "event-emitter";
+declare const state = "state";
+export interface PlaybackConstructorArgs {
+    baseUrl: string;
+    executor: WebDriverExecutor;
+    getTestByName: (name: string) => TestShape;
+    logger: Console;
+    options?: Partial<PlaybackConstructorOptions>;
+    variables: Variables;
+}
+export interface PlaybackConstructorOptions {
+    pauseOnExceptions: boolean;
+    ignoreBreakpoints: boolean;
+    delay: number;
+}
+export interface ExtendedEventEmitter extends EventEmitter {
+    emitCommandStateChange: (state: PlaybackEventShapes['COMMAND_STATE_CHANGED']) => void;
+    emitControlFlowChange: (state: PlaybackEventShapes['CONTROL_FLOW_CHANGED']) => void;
+}
+export declare type RunningPromise = Promise<any>;
+export declare type VaguePromise = (v?: unknown) => void;
+export declare type VaguePromiseWrapper = {
+    res: VaguePromise;
+    rej: VaguePromise;
+};
+export interface PlayOptions {
+    pauseImmediately?: boolean;
+    startingCommandIndex?: number;
+}
+export declare type PlayTo = VaguePromiseWrapper & {
+    command: string;
+};
+export default class Playback {
+    constructor({ baseUrl, executor, getTestByName, logger, options, variables, }: PlaybackConstructorArgs);
+    baseUrl: string;
+    executor: WebDriverExecutor;
+    getTestByName: PlaybackConstructorArgs['getTestByName'];
+    logger: Console;
+    options: PlaybackConstructorOptions;
+    variables: Variables;
+    [state]: {
+        aborting: boolean;
+        callstack?: Callstack;
+        exitCondition?: keyof typeof PlaybackStatesPriorities;
+        initialized: boolean;
+        isPlaying: boolean;
+        lastSentCommandState?: PlaybackEventShapes['COMMAND_STATE_CHANGED'];
+        pausing: boolean;
+        pausingResolve?: (v?: unknown) => void;
+        playPromise?: RunningPromise;
+        playTo?: PlayTo;
+        resumeResolve?: VaguePromise;
+        steps?: number;
+        stepPromise?: VaguePromiseWrapper;
+        stopping: boolean;
+    };
+    [EE]: ExtendedEventEmitter;
+    initialized?: boolean;
+    commands?: CommandShape[];
+    playbackTree?: PlaybackTree;
+    currentExecutingNode?: CommandNode;
+    init(): Promise<void>;
+    play(test: TestShape, { pauseImmediately, startingCommandIndex }?: PlayOptions): Promise<() => RunningPromise | undefined>;
+    playTo(test: TestShape, stopIndex: number, startIndex: number): Promise<() => RunningPromise | undefined>;
+    playFrom(test: TestShape, commandToStart: CommandShape): Promise<() => RunningPromise | undefined>;
+    playSingleCommand(command: CommandShape): Promise<void>;
+    step(steps?: number): Promise<void>;
+    pause({ graceful }?: {
+        graceful: boolean;
+    }): Promise<void>;
+    resume(): void;
+    stop(): Promise<void>;
+    abort(): Promise<void>;
+    cleanup(): Promise<void>;
+    _prepareToPlay(): Promise<void>;
+    _beforePlay(): Promise<void>;
+    _play(): Promise<() => RunningPromise | undefined>;
+    _resume(): void;
+    _executionLoop({ ignoreBreakpoint }?: {
+        ignoreBreakpoint: boolean;
+    }): Promise<void>;
+    _playSingleCommand(command: CommandShape): Promise<void>;
+    _executeCommand(commandNode: CommandNode): Promise<{
+        next: Fn | CommandNode | undefined;
+        skipped: boolean | undefined;
+    }>;
+    _run(testName: string): Promise<void>;
+    _finishPlaying(): Promise<void>;
+    _pause(): Promise<void>;
+    _break(): Promise<void>;
+    __pause(): Promise<void>;
+    _handleException(unhandledBahaviorFn: Fn): Promise<any>;
+    _delay(): Promise<void>;
+    _unwind(): void;
+    _setExitCondition(condition: keyof typeof PlaybackStatesPriorities): void;
+}
+export interface PlaybackEventShapes {
+    COMMAND_STATE_CHANGED: {
+        id: string;
+        callstackIndex?: number;
+        state: typeof CommandStates[keyof typeof CommandStates];
+        message?: string;
+    };
+    PLAYBACK_STATE_CHANGED: {
+        state: typeof PlaybackStates[keyof typeof PlaybackStates];
+    };
+    CALL_STACK_CHANGED: {
+        change: typeof CallstackChange[keyof typeof CallstackChange];
+        callee: Pick<TestShape, 'commands'>;
+        caller: Caller;
+    };
+    CONTROL_FLOW_CHANGED: {
+        commandId: string;
+        type: typeof CommandType[];
+        end: boolean;
+    };
+}
+export declare const PlaybackEvents: {
+    readonly COMMAND_STATE_CHANGED: "command-state-changed";
+    readonly PLAYBACK_STATE_CHANGED: "playback-state-changed";
+    readonly CALL_STACK_CHANGED: "call-stack-changed";
+    readonly CONTROL_FLOW_CHANGED: "control-flow-changed";
+};
+export declare const PlaybackStates: {
+    readonly PREPARATION: "prep";
+    readonly PLAYING: "playing";
+    readonly FINISHED: "finished";
+    readonly FAILED: "failed";
+    readonly ERRORED: "errored";
+    readonly PAUSED: "paused";
+    readonly BREAKPOINT: "breakpoint";
+    readonly STOPPED: "stopped";
+    readonly ABORTED: "aborted";
+};
+export declare type PlaybackState = typeof PlaybackStates[keyof typeof PlaybackStates];
+declare const PlaybackStatesPriorities: {
+    readonly finished: 0;
+    readonly failed: 1;
+    readonly errored: 2;
+    readonly stopped: 3;
+    readonly aborted: 4;
+};
+export declare const CommandStates: {
+    readonly EXECUTING: "executing";
+    readonly PENDING: "pending";
+    readonly SKIPPED: "skipped";
+    readonly PASSED: "passed";
+    readonly UNDETERMINED: "undetermined";
+    readonly FAILED: "failed";
+    readonly ERRORED: "errored";
+};
+export declare type CommandState = typeof CommandStates[keyof typeof CommandStates];
+export declare const CallstackChange: {
+    readonly CALLED: "called";
+    readonly UNWINDED: "unwinded";
+};
+export {};
+//# sourceMappingURL=playback.d.ts.map

package/dist/playback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playback.d.ts","sourceRoot":"","sources":["../src/playback.ts"],"names":[],"mappings":";AAiBA,OAAO,YAAY,MAAM,QAAQ,CAAA;AACjC,OAAO,EAAU,EAAE,EAAE,MAAM,0BAA0B,CAAA;AACrD,OAAO,EAAsB,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAElE,OAAO,SAAS,EAAE,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAEvE,QAAA,MAAM,EAAE,kBAAkB,CAAA;AAC1B,QAAA,MAAM,KAAK,UAAU,CAAA;AAGrB,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,SAAS,CAAA;IAC1C,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAA;IAC7C,SAAS,EAAE,SAAS,CAAA;CACrB;AACD,MAAM,WAAW,0BAA0B;IACzC,iBAAiB,EAAE,OAAO,CAAA;IAC1B,iBAAiB,EAAE,OAAO,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,sBAAsB,EAAE,CACtB,KAAK,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,KAChD,IAAI,CAAA;IACT,qBAAqB,EAAE,CACrB,KAAK,EAAE,mBAAmB,CAAC,sBAAsB,CAAC,KAC/C,IAAI,CAAA;CACV;AAED,oBAAY,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;AACzC,oBAAY,YAAY,GAAG,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;AAChD,oBAAY,mBAAmB,GAAG;IAChC,GAAG,EAAE,YAAY,CAAA;IACjB,GAAG,EAAE,YAAY,CAAA;CAClB,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED,oBAAY,MAAM,GAAG,mBAAmB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAE9D,MAAM,CAAC,OAAO,OAAO,QAAQ;gBACf,EACV,OAAO,EACP,QAAQ,EACR,aAAa,EACb,MAAM,EACN,OAAY,EACZ,SAAS,GACV,EAAE,uBAAuB;IAiC1B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,aAAa,EAAE,uBAAuB,CAAC,eAAe,CAAC,CAAA;IACvD,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,EAAE,0BAA0B,CAAA;IACnC,SAAS,EAAE,SAAS,CAAC;IACrB,CAAC,KAAK,CAAC,EAAE;QACP,QAAQ,EAAE,OAAO,CAAA;QACjB,SAAS,CAAC,EAAE,SAAS,CAAA;QACrB,aAAa,CAAC,EAAE,MAAM,OAAO,wBAAwB,CAAA;QACrD,WAAW,EAAE,OAAO,CAAA;QACpB,SAAS,EAAE,OAAO,CAAA;QAClB,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,CAAA;QACnE,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;QACtC,WAAW,CAAC,EAAE,cAAc,CAAA;QAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,aAAa,CAAC,EAAE,YAAY,CAAA;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,WAAW,CAAC,EAAE,mBAAmB,CAAA;QACjC,QAAQ,EAAE,OAAO,CAAA;KAClB,CAAC;IACF,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAA;IAC1B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,oBAAoB,CAAC,EAAE,WAAW,CAAA;IAE5B,IAAI;IAKJ,IAAI,CACR,IAAI,EAAE,SAAS,EACf,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,GAAE,WAAgB;IAsBxD,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAsB7D,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY;IAStD,iBAAiB,CAAC,OAAO,EAAE,YAAY;IAqCvC,IAAI,CAAC,KAAK,SAAI;IAgBd,KAAK,CAAC,EAAE,QAAQ,EAAE;;KAAsB;IAW9C,MAAM;IAKA,IAAI;IAiBJ,KAAK;IAoBL,OAAO;IAKP,cAAc;IAWd,WAAW;IAaX,KAAK;IAwBX,OAAO;IAWD,cAAc,CAClB,EAAE,gBAAgB,EAAE,GAAE;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAEhD,GACA,OAAO,CAAC,IAAI,CAAC;IAmHV,kBAAkB,CAAC,OAAO,EAAE,YAAY;IAyCxC,eAAe,CAAC,WAAW,EAAE,WAAW;;;;IAoBxC,IAAI,CAAC,QAAQ,EAAE,MAAM;IAgCrB,cAAc;IAqCd,MAAM;IAON,MAAM;IAON,OAAO;IAsBP,gBAAgB,CAAC,mBAAmB,EAAE,EAAE;IASxC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB7B,OAAO;IAcP,iBAAiB,CAAC,SAAS,EAAE,MAAM,OAAO,wBAAwB;CAYnE;AAED,MAAM,WAAW,mBAAmB;IAClC,qBAAqB,EAAE;QACrB,EAAE,EAAE,MAAM,CAAA;QACV,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,KAAK,EAAE,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;QACvD,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,sBAAsB,EAAE;QACtB,KAAK,EAAE,OAAO,cAAc,CAAC,MAAM,OAAO,cAAc,CAAC,CAAA;KAC1D,CAAA;IACD,kBAAkB,EAAE;QAClB,MAAM,EAAE,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAA;QAC5D,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;QACnC,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,oBAAoB,EAAE;QACpB,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,EAAE,OAAO,WAAW,EAAE,CAAA;QAC1B,GAAG,EAAE,OAAO,CAAA;KACb,CAAA;CACF;AAED,eAAO,MAAM,cAAc;;;;;CAKjB,CAAA;AAEV,eAAO,MAAM,cAAc;;;;;;;;;;CAUjB,CAAA;AAEV,oBAAY,aAAa,GAAG,OAAO,cAAc,CAAC,MAAM,OAAO,cAAc,CAAC,CAAA;AAE9E,QAAA,MAAM,wBAAwB;;;;;;CAMpB,CAAA;AAEV,eAAO,MAAM,aAAa;;;;;;;;CAQhB,CAAA;AAEV,oBAAY,YAAY,GAAG,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE3E,eAAO,MAAM,eAAe;;;CAGlB,CAAA"}