wdio-lambdatest-service-sdk 5.1.2 → 5.1.4

package/README.md

@@ -26,16 +26,20 @@ WebdriverIO service and CLI for running Appium and browser tests on [LambdaTest]
 - **Authentication**: Pass `username` and `accessKey` in the service options or via the CLI.
 - **Test Status Updates**: Automatically marks tests as Passed/Failed on the LambdaTest dashboard using Lambda Hooks.
 - **Logs**: Clean, colorful status logs in the terminal.
-- **CLI**: Interactive config generator and setup tool (Commander, Chalk, Inquirer; runs with Bun or Node.js).
+- **CLI**: Interactive config generator and setup tool (Commander, Chalk, Inquirer; runs with Node.js or Bun).
 - **Multi-select**: Choose multiple test types, device types, platforms, and app/website targets in one config.
 
 ---
 
 ## Installation
 
+Works with **Node.js** (≥18) or **Bun** (≥1.0). No Bun required.
+
 ```bash
+# With npm (Node.js)
 npm install wdio-lambdatest-service --save-dev
-# or with Bun
+
+# With Bun (optional)
 bun add wdio-lambdatest-service --dev
 ```
 
@@ -207,11 +211,11 @@ npm install wdio-lambdatest-service --save-dev
 ### 2. Run the Config Generator
 
 ```bash
-# With Bun (recommended)
-bun wdio-lt generate
-
 # With Node.js
 npx wdio-lt generate
+
+# With Bun (optional)
+bunx wdio-lt generate
 ```
 
 ### 3. Follow the Prompts
@@ -270,19 +274,21 @@ wdio-lt setup
 wdio-lt generate
 ```
 
-### Running with Bun
+### Running the CLI
+
+**With Node.js** (default; no extra install):
 
 ```bash
-curl -fsSL https://bun.sh/install | bash   # Install Bun
-bun wdio-lt setup ./android-sample
-bun wdio-lt generate
+npx wdio-lt setup ./android-sample
+npx wdio-lt generate
 ```
 
-### Running with Node.js
+**With Bun** (optional; faster):
 
 ```bash
-npx wdio-lt setup ./android-sample
-npx wdio-lt generate
+curl -fsSL https://bun.sh/install | bash   # Install Bun
+bunx wdio-lt setup ./android-sample
+bunx wdio-lt generate
 ```
 
 ### Legacy Commands (backward compatible)
@@ -391,8 +397,8 @@ wdio-lambdatest-service/
 
 ### Requirements
 
-- **Node.js**: >= 18.0.0
-- **Bun**: >= 1.0.0 (optional, for faster CLI)
+- **Node.js**: >= 18.0.0 (required for npm install and default CLI run)
+- **Bun**: >= 1.0.0 (optional; use `bun add` / `bunx wdio-lt` for faster install and run)
 
 ---
 

package/bin/cli.js

@@ -1,8 +1,8 @@
-#!/usr/bin/env bun
+#!/usr/bin/env node
 /**
  * LambdaTest WDIO CLI - Unified command-line interface.
  * Powered by Commander, Chalk, and Inquirer.
- * Runs with Bun (fast) or Node.js.
+ * Runs with Node.js or Bun.
  */
 const { Command } = require('commander');
 const chalk = require('chalk');

package/bin/generate-config.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env bun
+#!/usr/bin/env node
 /**
  * LambdaTest WDIO Config Generator - Backward-compatible entry point.
  * Delegates to lib/cli/generate.js

package/bin/setup.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env bun
+#!/usr/bin/env node
 /**
  * LambdaTest WDIO Setup - Backward-compatible entry point.
  * Delegates to lib/cli/setup.js

package/index.js

@@ -1,10 +1,17 @@
 /**
  * WDIO LambdaTest service entry point.
  * Exposes the service class and launcher for WebdriverIO.
+ * Export shape supports both CommonJS and WDIO plugin resolution (default + launcher).
  */
 const LambdaTestService = require('./src/service');
 const LambdaTestLauncher = require('./src/launcher');
 
-module.exports = LambdaTestService;
-module.exports.default = LambdaTestService;
-module.exports.launcher = LambdaTestLauncher;
+// Primary export: the worker service class (used by WDIO in worker process)
+const Service = LambdaTestService;
+
+// Attach launcher so WDIO can read plugin.launcher (main process)
+Service.launcher = LambdaTestLauncher;
+// ESM interop: some loaders expect plugin.default
+Service.default = Service;
+
+module.exports = Service;

package/lib/cli/generate.js

@@ -163,19 +163,41 @@ function buildCapabilitiesMulti(config) {
     return capabilities;
 }
 
+/**
+ * Resolve LambdaTest service path: try package name first (npm install), then sibling (reference repo).
+ * Reference repo layout: LT_Test/ (configs) and wdio-lambdatest-service/ as siblings.
+ */
+function getServicePathSnippet() {
+    return `(function () {
+    try { return require.resolve('wdio-lambdatest-service'); } catch (e) {}
+    return path.join(__dirname, '../wdio-lambdatest-service');
+})()`;
+}
+
 /**
  * Build config file template string.
+ * Reference: LT_Test/ for configs, ../specs/ for specs, ../wdio-lambdatest-service or npm package for SDK.
  */
 function buildConfigTemplate(config, commonCaps, capabilities) {
+    const servicePathExpr = getServicePathSnippet();
+    const safeSpecPath = config.specPath.replace(/\\/g, '/');
+    const mergeSnippet = capabilities.length > 0
+        ? `
+// Merge commonCapabilities into each capability
+exports.config.capabilities.forEach(function (caps) {
+    for (const i in exports.config.commonCapabilities) {
+        caps[i] = caps[i] || exports.config.commonCapabilities[i];
+    }
+});
+`
+        : '';
+
     return `const path = require('path');
 
+// LambdaTest WDIO config (generated). Layout: LT_Test/ for configs, ../specs/ for specs (see LT-appium-nodejs-webdriverio).
 exports.config = {
-    // Authentication handled by SDK
-    // user: "${config.username}",
-    // key: "${config.key}",
-
     updateJob: false,
-    specs: ["${config.specPath}"],
+    specs: ["${safeSpecPath}"],
     exclude: [],
 
     maxInstances: ${config.parallel > 0 ? config.parallel : 1},
@@ -196,9 +218,9 @@ exports.config = {
     port: 80,
 
     services: [
-        [path.join(__dirname, '../wdio-lambdatest-service'), {
-            user: "${config.username}",
-            key: "${config.key}"
+        [${servicePathExpr}, {
+            user: "${(config.username || '').replace(/"/g, '\\"')}",
+            key: "${(config.key || '').replace(/"/g, '\\"')}"
         }]
     ],
 
@@ -208,14 +230,7 @@ exports.config = {
         timeout: 20000,
     },
 };
-
-// Merge commonCapabilities into each capability
-exports.config.capabilities.forEach(function (caps) {
-    for (const i in exports.config.commonCapabilities) {
-        caps[i] = caps[i] || exports.config.commonCapabilities[i];
-    }
-});
-`;
+${mergeSnippet}`;
 }
 
 function printBanner() {
@@ -425,34 +440,33 @@ async function runGenerate() {
     ]);
     config.parallel = parallelAnswer.parallel || 0;
 
-    // Spec file path
+    // Spec file path (reference repo: LT_Test and specs/ are siblings, so ../specs/ from LT_Test)
+    const defaultSpecPath = '../specs/android-test.js';
     const specAnswer = await inquirer.default.prompt([
         {
             type: 'input',
             name: 'specPath',
-            message: 'Spec file path:',
-            default: './specs/test.js'
+            message: 'Spec file path (relative to config dir, e.g. ../specs/android-test.js):',
+            default: defaultSpecPath
         }
     ]);
 
-    let rawSpec = specAnswer.specPath.trim() || './specs/test.js';
+    let rawSpec = specAnswer.specPath.trim() || defaultSpecPath;
 
-    // Smart resolve spec path relative to LT_Test
-    if (fs.existsSync(path.resolve(outputDir, rawSpec))) {
-        config.specPath = rawSpec;
+    // Resolve spec path relative to outputDir (LT_Test). Reference: specs/ at repo root = ../specs/ from LT_Test.
+    const fromOutputDir = path.resolve(outputDir, rawSpec);
+    if (fs.existsSync(fromOutputDir)) {
+        config.specPath = path.relative(outputDir, fromOutputDir).replace(/\\/g, '/') || rawSpec;
     } else {
         const rootPath = path.resolve(outputDir, '..');
         const relativeToRoot = rawSpec.replace(/^\.\//, '');
         const pathFromRoot = path.join(rootPath, relativeToRoot);
-
         if (fs.existsSync(pathFromRoot)) {
             config.specPath = path.relative(outputDir, pathFromRoot).replace(/\\/g, '/');
         } else {
-            if (!path.isAbsolute(rawSpec) && !rawSpec.startsWith('../')) {
-                config.specPath = '../' + relativeToRoot;
-            } else {
-                config.specPath = rawSpec;
-            }
+            config.specPath = !path.isAbsolute(rawSpec) && !rawSpec.startsWith('../')
+                ? '../' + relativeToRoot
+                : rawSpec;
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wdio-lambdatest-service-sdk",
-  "version": "5.1.2",
+  "version": "5.1.4",
   "description": "WebdriverIO service and CLI for LambdaTest Appium & browser automation",
   "main": "index.js",
   "repository": {

package/src/launcher.js

@@ -47,22 +47,21 @@ function applyCredentialsToCapabilities(capabilities, credentials) {
 module.exports = class LambdaTestLauncher {
     constructor(serviceOptions, capabilities, config) {
         this.options = serviceOptions || {};
-        console.log('[LambdaTest Service] Launcher initialized with options:', JSON.stringify(this.options));
     }
 
     onPrepare(config, capabilities) {
-        console.log('[LambdaTest Service] Processing credentials...');
+        if (!config) return;
+        const capsList = Array.isArray(capabilities) ? capabilities : capabilities ? [capabilities] : [];
+        if (capsList.length === 0) return;
 
         const credentials = resolveCredentials(this.options, config);
         applyCredentialsToConfig(config, credentials);
-
-        const capsList = Array.isArray(capabilities) ? capabilities : [capabilities];
         applyCredentialsToCapabilities(capsList, credentials);
 
         if (credentials.user && credentials.key) {
             console.log('[LambdaTest Service] Credentials injected into config and capabilities.');
         } else {
-            console.error('[LambdaTest Service] Credentials not found! Please check service options or env vars.');
+            console.warn('[LambdaTest Service] Credentials not set. Use service options or LT_USERNAME / LT_ACCESS_KEY.');
         }
     }
 };