KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use isCLICommand method in taiko

Best JavaScript code snippet using taiko

EventsServer.ts

Source:EventsServer.ts

1import type { DollarSign } from "xpresser/types";2import XpresserRouter from "@xpresser/router";3import { loadEventServerConfig, md5, now } from "./functions";4import {5    EventHandlerFn,6    EventRoute,7    EventsArray,8    EventsControllerContext,9    SocketOrIdAndSocket10} from "./Types";11import EventsServerDb, { FailedEvent, PendingEvent } from "./EventsServerDb";12import { nanoid } from "nanoid";13import { createServer, Server } from "net";14import PlaneSocket from "./PlaneSocket";15class EventsServer {16    readonly #secretKey!: string;17    private server!: Server;18    port!: number;19    private readonly db!: EventsServerDb;20    private readonly $: DollarSign;21    private readonly $router!: XpresserRouter;22    private readonly isCliCommand: boolean;23    private retryTimeout!: NodeJS.Timeout;24    /**25     * Take xpresser instance and port.26     * Create our server.27     * @param secretKey28     * @param $29     */30    constructor(secretKey: string, $: DollarSign) {31        if ($.engineData.has("hasBooted"))32            $.logErrorAndExit(`$.boot() was called before reaching events server.`);33        if (!$.config.has("eventsServer"))34            $.logErrorAndExit(`{eventsServer} is not defined in config.`);35        const [err, eventsServerConfig] = loadEventServerConfig($, true);36        if (err) $.logErrorAndExit(`Config: ${err.message}`);37        $.config38            .set("eventsServer", eventsServerConfig)39            // remove secret key.40            .unset("eventsServer.secretKey");41        // Set SecretKey42        this.#secretKey = md5(secretKey);43        // Set Port44        this.port = $.config.get("eventsServer.port");45        // Disable expose $46        $.options.exposeDollarSign = false;47        // Set isConsole = true;48        $.options.isConsole = true;49        // set isEventsServer = true;50        $.engineData.set("isEventsServer", true);51        // Change backend path52        $.config.set("paths.backend", "base://events-server");53        // xpresser instance54        this.$ = $;55        // New Router Instance.56        this.$router = new XpresserRouter();57        // Check launch type58        this.isCliCommand = $.engineData.get("LaunchType") === "cli";59        // if launch type is cli, change controller stub path.60        if (this.isCliCommand) {61            let customControllerStubPath = __dirname + "/controller.hbs";62            /**63             * Since Tsc does not move .hbs files we have to check.64             */65            if (customControllerStubPath.indexOf("/js/src/") > 0) {66                customControllerStubPath = customControllerStubPath.replace("/js/src/", "/src/");67            }68            $.config.set("artisan.factory.controller", customControllerStubPath);69        } else {70            // Set To requireOnly71            $.options.requireOnly = true;72            // Set Db73            this.db = new EventsServerDb($);74            // Initialize Server on Start75            $.on.start((next) => this.initializeSocket() && next());76        }77    }78    /**79     * Map event to function or controller80     * @param event81     * @param fn82     */83    on(event: string, fn?: string | EventHandlerFn) {84        this.$router.any(event, fn);85        return this;86    }87    /**88     * Get all loaded events89     */90    private getAllEvents() {91        return this.$.engineData.get("EventsServerEvents") as EventsArray;92    }93    /**94     * Start Listening for events95     */96    startListening() {97        if (!this.isCliCommand) {98            // Process Routes on boot.99            this.$.on.boot((next) => this.processRoutes() && next());100            /**101             * Start listening for events102             */103            this.$.on.boot((next) => {104                this.$.logCalmly(`Waiting for authenticated connection...`);105                this.addConnectionListener().server.listen(this.port);106                return next();107            });108        }109        // Boot Xpresser110        this.$.boot();111    }112    /**113     * Initialize Socket114     * @private115     */116    private initializeSocket() {117        this.server = createServer();118        this.server.on("error", () => {119            this.$.logErrorAndExit("Events Server failed to start!");120        });121        return this;122    }123    private processRoutes() {124        // Abbreviate $;125        const $ = this.$;126        // Log current backend Folder.127        $.log(`Backend Folder: ${$.config.get("paths.backend")}`);128        // Load Xpresser Routes Loader.129        require("xpresser/dist/src/Routes/Loader");130        // Process all defined routes131        $.routerEngine.processRoutes(this.$router.routes);132        // Get all processed routes133        const routes = $.routerEngine.allProcessedRoutes() as EventRoute[];134        // Load Xpresser's own controller getter.135        const ControllerGetter = require("xpresser/dist/src/ControllerEngine") as (136            ...args: any137        ) => {138            middlewares: any[];139            $controller: any;140            method: string;141        };142        const events = [] as EventsArray;143        /**144         * Loop through routes, get commands and bind then to the appropriate functions.145         */146        for (const route of routes) {147            if (typeof route.controller === "string") {148                const { $controller, method } = ControllerGetter(route, null, true);149                if (!$controller.hasOwnProperty(method)) {150                    const nameOfController = route.controller.split("@")[0] || "UNNAMED_CONTROLLER";151                    $.logErrorAndExit(152                        `Method '${method}' does not exist in {${153                            $controller.name || nameOfController154                        }}`155                    );156                    break;157                }158                events.push({159                    event: route.url,160                    handler: this.wrapControllerFunction($controller, route.url, method),161                    controller: route.controller162                });163            } else {164                events.push({165                    event: route.url,166                    handler: this.wrapControllerFunction(route.controller, route.url),167                    controller: route.controller168                });169            }170        }171        $.engineData.set("EventsServerEvents", events);172        return this;173    }174    private addConnectionListener() {175        this.server.on("connection", (socket) => {176            const pSocket = new PlaneSocket(socket);177            pSocket.on("Authorize", (data) => {178                if (data.secretKey && data.secretKey === this.#secretKey) {179                    this.$.logCalmly(">>>>>>>>>>>>>>>>>>> LISTENING <<<<<<<<<<<<<<<<<<<<");180                    return this.listenToAllRoutes(pSocket);181                }182                return socket.emit("error", "Authorization Failed, Invalid SECRET_KEY!");183            });184            pSocket.$setupListeners();185        });186        return this;187    }188    private listenToAllRoutes(socket: PlaneSocket) {189        const events = this.getAllEvents();190        for (const event of events) {191            socket.on(event.event, (...args) => event.handler(socket, ...args));192        }193        socket.on("$retryFailedEvents", () => this.retryFailedEvents(socket, true));194        socket.on("$runPendingEvents", () => this.runPendingEvents(socket));195        socket.emit(`Authorized:${this.#secretKey}`);196        this.retryFailedEvents(socket);197        this.runPendingEvents(socket);198    }199    private triggerRetryFailedEvents(socket: PlaneSocket, secs: number = 10) {200        // Clear all old retry events201        clearTimeout(this.retryTimeout);202        this.retryTimeout = setTimeout(() => {203            this.retryFailedEvents(socket);204        }, secs * 1000);205    }206    /**207     * Wrap a function around Events Server Before and After events.208     * @param $controller209     * @param event210     * @param method211     * @private212     */213    private wrapControllerFunction($controller: any, event: string, method?: string) {214        const $ = this.$;215        const logArgs = $.config.get("eventsServer.log.args", true);216        const WrappedHandler = async (socket: SocketOrIdAndSocket, ...args: any[]) => {217            let id = nanoid(10);218            let isRetry = false;219            if (Array.isArray(socket)) {220                isRetry = true;221                id = socket[0];222                socket = socket[1];223            }224            // Log Received225            if (logArgs) {226                try {227                    $.logCalmly(228                        `RECEIVED|${now()}| ${id} | ${event} | ` + "Args:" + JSON.stringify(args)229                    );230                } catch (e: any) {231                    $.logCalmly(`Could not parse args: ${e.message}`);232                }233            } else {234                $.logCalmly(`RECEIVED|${now()}| ${id} | ${event}`);235            }236            // Run Controllers function237            try {238                if (typeof $controller === "function") {239                    await $controller(this.makeControllerContext(id, socket, event), ...args);240                } else {241                    await $controller[method!](242                        this.makeControllerContext(id, socket, event),243                        ...args244                    );245                }246                if (isRetry) {247                    this.db.markAsSuccessful(id);248                    socket.emit(`RemoveFromPending:${this.#secretKey}`, id);249                }250                // Log Completed251                $.logSuccess(`    DONE|${now()}| ${id} | ${event}`);252            } catch (e: any) {253                if (isRetry) {254                    socket.emit(`RemoveFromPending:${this.#secretKey}`, id);255                }256                this.db.recordFailedEvent(257                    {258                        event,259                        eventId: id,260                        args261                    },262                    e263                );264                this.triggerRetryFailedEvents(socket);265                $.logError(`â¼ï¸    ERROR|${now()}| ${id} | ${event} --- ${e.message}`);266            }267        };268        // Set Function name to event name.269        Object.defineProperty(WrappedHandler, "name", { value: `Wrapped_${event}` });270        return WrappedHandler;271    }272    /**273     * Make Controller Context using socket passed.274     * @param id275     * @param socket276     * @param event277     * @private278     */279    private makeControllerContext(280        id: string,281        socket: PlaneSocket,282        event: string283    ): EventsControllerContext {284        return <EventsControllerContext>{285            id,286            event,287            $: this.$,288            runEvent: (event, ...args) => {289                return this.runEvent(socket, event, ...args);290            },291            reply(severSideEvent: string, ...args: []) {292                return socket.emit(severSideEvent, ...args);293            }294        };295    }296    /**297     * Run an event.298     * @param socket299     * @param event300     * @param args301     * @private302     */303    private runEvent(socket: SocketOrIdAndSocket, event: string, ...args: any[]) {304        const events = this.getAllEvents();305        const eventData = events.find((e) => e.event === event);306        if (!eventData)307            throw Error(`RunEvent: "${event}" does not exist!, check spelling and try again.`);308        return eventData.handler(socket, ...args);309    }310    private retryFailedEvents(socket: PlaneSocket, force = false) {311        const $ = this.$;312        // Get all failed Events313        const failedEvents = this.db.failedEvents();314        // Get Ids315        const failedEventsIds = failedEvents.keys();316        if (!failedEventsIds.length) return this;317        let retried = 0;318        for (const key of failedEventsIds) {319            const { event, args, retries } = failedEvents.get(key) as FailedEvent;320            if (!force && retries.length >= 3) continue;321            $.logWarning(`RETRYING|${now()}| ${key} | ${event}`);322            retried++;323            setTimeout(() => {324                this.runEvent([key, socket], event, ...args);325            }, 1000);326        }327        if (retried) $.logWarning(`Retried (${retried}) failed events.`);328        return this;329    }330    private runPendingEvents(socket: PlaneSocket, silently = false) {331        const $ = this.$;332        const db = new EventsServerDb($, true);333        // Get all failed Events334        const pendingEvents = db.pendingEvents();335        // Get Ids336        const keys = pendingEvents.keys();337        if (!keys.length) return this;338        // log339        if (!silently) $.logWarning(`(${keys.length}) Pending Events!`);340        for (const key of keys) {341            const { event, args } = pendingEvents.get(key) as PendingEvent;342            this.runEvent([key, socket], event, ...args);343        }344        return this;345    }346}...

taiko.js

Source:taiko.js

...85        plugin.exec(options);86      });87  });88}89function isCLICommand() {90  return require.main === module;91}92if (isTaikoRunner(processArgv[1])) {93  process.env.TAIKO_ENABLE_ACTION_OUTPUT = process.env.TAIKO_ENABLE_ACTION_OUTPUT || true;94  let plugins = getExecutablePlugins();95  if (96    isCLICommand() &&97    !(seekingForHelp(processArgv) || Object.prototype.hasOwnProperty.call(plugins, processArgv[2]))98  ) {99    // append taiko sub-command as if the user has executed <taiko taiko script.js or just taiko taiko>100    processArgv.splice(2, 0, 'taiko');101  }102  let program = new Command('taiko');103  program104    .arguments('<cmd> [fileName]')105    .version(printVersion(), '-v, --version')106    .usage(107      `[options]108       taiko <file> [options]`,109    )110    .option(...

task.ts

Source:task.ts

1import { Task, TaskScope, ShellExecution, tasks } from "vscode";2import { spockeeRoot, spockeeEnvironments } from "../config/constants";3export const createTask = async (4  taskName: string,5  command: string,6  isCliCommand: boolean,7  onTaskFinish?: () => Promise<void>8  // eslint-disable-next-line max-params9) => {10  const task = new Task(11    { type: "shell" },12    TaskScope.Workspace,13    taskName,14    "Spockee extension",15    new ShellExecution(`${command} ${isCliCommand ? "--code" : ""}`, {16      cwd: spockeeRoot,17      env: spockeeEnvironments,18    }),19    []20  );21  task.presentationOptions = {22    focus: true,23  };24  const taskExecution = await tasks.executeTask(task);25  return await new Promise<void>((resolve) => {26    const disposable = tasks.onDidEndTaskProcess(async (processEndEvent) => {27      if (onTaskFinish) await onTaskFinish();28      if (processEndEvent.execution === taskExecution) {29        disposable.dispose();30        resolve();31      }32    });33  });...

Using AI Code Generation

1const { openBrowser, goto, closeBrowser, isCLICommand } = require('taiko');2(async () => {3    try {4        await openBrowser();5        await goto("google.com");6        console.log(isCLICommand());7    } catch (e) {8        console.error(e);9    } finally {10        await closeBrowser();11    }12})();13const { openBrowser, goto, closeBrowser, isCLICommand } = require('taiko');14(async () => {15    try {16        await openBrowser();17        await goto("google.com");18        console.log(isCLICommand());19    } catch (e) {20        console.error(e);21    } finally {22        await closeBrowser();23    }24})();25const { openBrowser, goto, closeBrowser, isHeadless } = require('taiko');26(async () => {27    try {28        await openBrowser({ headless: true });29        await goto("google.com");30        console.log(isHeadless());31    } catch (e) {32        console.error(e);33    } finally {34        await closeBrowser();35    }36})();37const { openBrowser, goto, closeBrowser, isHeadless } = require('taiko');38(async () => {39    try {40        await openBrowser({ headless: false });41        await goto("google.com");42        console.log(isHeadless());43    } catch (e) {44        console.error(e);45    } finally {46        await closeBrowser();47    }48})();49const { openBrowser, goto, closeBrowser, isInteractive } = require('taiko');50(async () => {51    try {52        await openBrowser();53        await goto("google.com");54        console.log(isInteractive());55    } catch (e) {56        console.error(e);57    } finally {58        await closeBrowser();59    }60})();61const { openBrowser, goto, closeBrowser, isInteractive } = require('taiko');62(async () => {63    try {

Using AI Code Generation

1const { openBrowser, goto, click, closeBrowser, isCLICommand } = require('taiko');2(async () => {3    try {4        await openBrowser();5        await goto("google.com");6        await click("Sign in");7        console.log(isCLICommand());8    } catch (e) {9        console.error(e);10    } finally {11        await closeBrowser();12    }13})();14const { openBrowser, goto, click, closeBrowser, isHeadless } = require('taiko');15(async () => {16    try {17        await openBrowser();18        await goto("google.com");19        await click("Sign in");20        console.log(isHeadless());21    } catch (e) {22        console.error(e);23    } finally {24        await closeBrowser();25    }26})();27const { openBrowser, goto, click, closeBrowser, isHeaded } = require('taiko');28(async () => {29    try {30        await openBrowser();31        await goto("google.com");32        await click("Sign in");33        console.log(isHeaded());34    } catch (e) {35        console.error(e);36    } finally {37        await closeBrowser();38    }39})();40const { openBrowser, goto, click, closeBrowser, isSafari } = require('taiko');41(async () => {42    try {43        await openBrowser();44        await goto("google.com");45        await click("Sign in");46        console.log(isSafari());47    } catch (e) {48        console.error(e);49    } finally {50        await closeBrowser();51    }52})();

Using AI Code Generation

1const { openBrowser, goto, closeBrowser, isCLICommand } = require('taiko');2(async () => {3    try {4        await openBrowser();5        await goto("google.com");6        console.log(isCLICommand('goto'));7    } catch (e) {8        console.error(e);9    } finally {10        await closeBrowser();11    }12})();13isHeadless()14const { openBrowser, goto, closeBrowser, isHeadless } = require('taiko');15(async () => {16    try {17        await openBrowser();18        await goto("google.com");19        console.log(isHeadless());20    } catch (e) {21        console.error(e);22    } finally {23        await closeBrowser();24    }25})();26isHeaded()27const { openBrowser, goto, closeBrowser, isHeaded } = require('taiko');28(async () => {29    try {30        await openBrowser();31        await goto("google.com");32        console.log(isHeaded());33    } catch (e) {34        console.error(e);35    } finally {36        await closeBrowser();37    }38})();39isPluginEnabled(pluginName)40const { openBrowser, goto, closeBrowser, isPluginEnabled } = require('taiko');41(async () => {42    try {43        await openBrowser();44        await goto("google.com");45        console.log(isPluginEnabled('screenshot'));46    } catch (e) {47        console.error(e);48    } finally {49        await closeBrowser();

Using AI Code Generation

1const { openBrowser, goto, write, click, closeBrowser, isCLICommand } = require('taiko');2(async () => {3    try {4        await openBrowser();5        await write("Taiko");6        await click("Google Search");7        console.log("isCLICommand: " + isCLICommand());8    } catch (e) {9        console.error(e);10    } finally {11        await closeBrowser();12    }13})();14isCLICommand()15const { openBrowser, goto, write, click, closeBrowser, isCLICommand } = require('taiko');16(async () => {17    try {18        await openBrowser();19        await write("Taiko");20        await click("Google Search");21        console.log("isCLICommand: " + isCLICommand());22    } catch (e) {23        console.error(e);24    } finally {25        await closeBrowser();26    }27})();28isHeadless()29const { openBrowser, goto, write, click, closeBrowser, isHeadless } = require('taiko');30(async () => {31    try {32        await openBrowser({headless: true});33        await write("Taiko");34        await click("Google Search");35        console.log("isHeadless: " + isHeadless());36    } catch (e) {37        console.error(e);38    } finally {39        await closeBrowser();40    }41})();42isHeadless()

Using AI Code Generation

1const { isCLICommand, openBrowser, goto, closeBrowser } = require('taiko');2(async () => {3    try {4        await openBrowser({ headless: false });5        await goto("google.com");6        console.log(isCLICommand);7    } catch (e) {8        console.error(e);9    } finally {10        await closeBrowser();11    }12})();13Syntax: isHeadless()14const { isHeadless, openBrowser, goto, closeBrowser } = require('taiko');15(async () => {16    try {17        await openBrowser({ headless: false });18        await goto("google.com");19        console.log(isHeadless());20    } catch (e) {21        console.error(e);22    } finally {23        await closeBrowser();24    }25})();26Syntax: isNavigationRequest()27const { isNavigationRequest, openBrowser, goto, closeBrowser } = require('taiko');28(async () => {29    try {30        await openBrowser({ headless: false });31        await goto("google.com");32        console.log(isNavigationRequest());33    } catch (e) {34        console.error(e);35    } finally {36        await closeBrowser();37    }38})();39Syntax: isTextVisible(text, options)40const { isTextVisible, openBrowser, goto

Using AI Code Generation

1const {isCLICommand} = require('taiko');2console.log(isCLICommand('openBrowser'));3console.log(isCLICommand('openBrowser', 'openTab'));4console.log(isCLICommand('openBrowser', 'openTab', 'closeTab'));5const {isCLICommand} = require('taiko');6console.log(isCLICommand('openBrowser'));7console.log(isCLICommand('openBrowser', 'openTab'));8console.log(isCLICommand('openBrowser', 'openTab', 'closeTab'));9console.log(isCLICommand('openBrowser', 'openTab', 'closeTab', 'openTab'));10const {isHeaded} = require('taiko');11console.log(isHeaded());12const {isHeadless} = require('taiko');13console.log(isHeadless());14const {isHeadlessBrowser} = require('taiko');15console.log(isHeadlessBrowser());16const {isInteractive} = require('taiko');17console.log(isInteractive());

Using AI Code Generation

1const { isCLICommand } = require('taiko');2(async () => {3    try {4        await openBrowser();5        await isCLICommand('openBrowser');6        await goto('google.com');7        await isCLICommand('goto');8        await write('Taiko');9        await isCLICommand('write');10        await press('Enter');11        await isCLICommand('press');12        await closeBrowser();13        await isCLICommand('closeBrowser');14    } catch (e) {15        console.error(e);16    } finally {17        await closeBrowser();18    }19})();20const { isSelector } = require('taiko');21(async () => {22    try {23        await openBrowser();24        await goto('google.com');25        await isSelector('input[title="Search"]');26        await write('Taiko');27        await isSelector('input[type="submit"]');28        await press('Enter');29        await closeBrowser();30    } catch (e) {31        console.error(e);32    } finally {33        await closeBrowser();34    }35})();36const { isString } = require('taiko');37(async () => {38    try {39        await openBrowser();40        await goto('google.com');41        await isString('google.com');42        await write('Taiko');43        await isString('Taiko');44        await press('Enter');45        await isString('Taiko');46        await closeBrowser();47    } catch (e) {48        console.error(e);49    } finally {50        await closeBrowser();51    }52})();53const { isNumber } = require('taiko');54(async () => {55    try {56        await openBrowser();57        await goto('google.com');58        await isNumber(1);59        await write('Taiko');60        await isNumber(1);61        await press('Enter');62        await isNumber(1);63        await closeBrowser();64    } catch (e) {65        console.error(e);66    } finally {67        await closeBrowser();68    }69})();70const { isBoolean } = require('taiko');71(async () => {72    try {

Using AI Code Generation

1const { isCLICommand } = require('taiko');2console.log(isCLICommand('openBrowser'));3console.log(isCLICommand('openBrowser', { headless: false }));4console.log(isCLICommand('goto'));5console.log(isCLICommand('goto', 'google.com'));6console.log(isCLICommand('write'));7console.log(isCLICommand('write', 'google.com', into('search')));8console.log(isCLICommand('click'));9console.log(isCLICommand('click', 'google.com'));10console.log(isCLICommand('closeBrowser'));11const { isCLICommand } = require('taiko');12console.log(isCLICommand('openBrowser'));13console.log(isCLICommand('openBrowser', { headless: false }));14console.log(isCLICommand('goto'));15console.log(isCLICommand('goto', 'google.com'));16console.log(isCLICommand('write'));17console.log(isCLICommand('write', 'google.com', into('search')));18console.log(isCLICommand('click'));19console.log(isCLICommand('click', 'google.com'));

Using AI Code Generation

1let isCLICommand = require('taiko/lib/taiko.js').isCLICommand;2let cli = require('taiko/lib/taiko.js').cli;3if (isCLICommand(args)) {4    cli(args);5}6const { openBrowser, goto, text, closeBrowser } = require('taiko');7(async () => {8    try {9        await openBrowser({ headless: true });10        await goto("google.com");11        await text("Google Search").exists();12        await text("Google Search").exists();13    } catch (e) {14        console.error(e);15    } finally {16        await closeBrowser();17    }18})();19const { openBrowser, goto, text, closeBrowser } = require('taiko');20(async () => {21    try {22        await openBrowser({ headless: true });23        await goto("google.com");24        await text("Google Search").exists();25        await text("Google Search").exists();26    } catch (e) {27        console.error(e);28    } finally {29        await closeBrowser();30    }31})();32const { openBrowser, goto, text, closeBrowser } = require('taiko');33(async () => {34    try {35        await openBrowser({ headless: true });36        await goto("google.com");37        await text("Google Search").exists();38        await text("Google Search").exists();39    } catch (e) {40        console.error(e);41    } finally {42        await closeBrowser();43    }44})();45const { openBrowser, goto, text, closeBrowser } = require('taiko');46(async () => {47    try {48        await openBrowser({ headless: true });49        await goto("google.com");50        await text("Google Search").exists();51        await text("Google Search").exists();52    } catch (e) {53        console.error(e);54    } finally {55        await closeBrowser();56    }57})();58const { openBrowser, goto, text, closeBrowser } = require('taiko');59(async () => {60    try {61        await openBrowser({ headless: true });62        await goto("google.com");63        await text("Google Search").exists();64        await text("Google Search").exists();65    } catch

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.