@capillarytech/cap-ui-dev-tools 1.0.0 → 1.2.0

package/src/capvision-recorder/adapters/WebdriverIOAdapter.js

@@ -0,0 +1,312 @@
+const { CapVisionRecorder } = require('../core/CapVisionRecorder');
+const { ReportEnhancer } = require('../core/ReportEnhancer');
+
+/**
+ * WebdriverIO Browser Executor Adapter
+ * Adapts WebdriverIO's browser object to the BrowserExecutor interface
+ * @class
+ */
+class WebdriverIOBrowserExecutor {
+  /**
+   * Create a new WebdriverIO Browser Executor
+   * @param {Object} browser - WebdriverIO browser instance
+   */
+  constructor(browser) {
+    /** @type {Object} */
+    this.browser = browser;
+  }
+
+  /**
+   * Execute script in browser context
+   * @template T
+   * @param {string|Function} script - Script to execute
+   * @param {...*} args - Arguments to pass to script
+   * @returns {Promise<T>} Result of script execution
+   */
+  async execute(script, ...args) {
+    return this.browser.execute(script, ...args);
+  }
+
+  /**
+   * Pause execution for specified milliseconds
+   * @param {number} ms - Milliseconds to pause
+   * @returns {Promise<void>}
+   */
+  async pause(ms) {
+    return this.browser.pause(ms);
+  }
+}
+
+/**
+ * WebdriverIO CapVision Recorder Adapter
+ * Provides WebdriverIO-specific helpers and integration
+ * @class
+ */
+class WebdriverIOCapVisionRecorder {
+  /**
+   * Create a new WebdriverIO CapVision Recorder
+   * @param {import('../core/CapVisionRecorder').CapVisionRecorderConfig} [recorderConfig={}] - Recorder configuration
+   * @param {import('../core/ReportEnhancer').ReportEnhancerConfig} [enhancerConfig={}] - Enhancer configuration
+   */
+  constructor(recorderConfig = {}, enhancerConfig = {}) {
+    /** @type {import('../core/CapVisionRecorder').CapVisionRecorder} */
+    this.recorder = new CapVisionRecorder(recorderConfig);
+    
+    /** @type {import('../core/ReportEnhancer').ReportEnhancer} */
+    this.enhancer = new ReportEnhancer(enhancerConfig);
+    
+    /** @type {WebdriverIOBrowserExecutor|null} */
+    this.browserExecutor = null;
+  }
+
+  /**
+   * Initialize with browser object
+   * Call this in beforeTest or beforeSuite hook
+   * @param {Object} browser - WebdriverIO browser instance
+   */
+  init(browser) {
+    this.browserExecutor = new WebdriverIOBrowserExecutor(browser);
+    this.recorder.setBrowserExecutor(this.browserExecutor);
+  }
+
+  /**
+   * Get recorder instance
+   * @returns {import('../core/CapVisionRecorder').CapVisionRecorder} Recorder instance
+   */
+  getRecorder() {
+    return this.recorder;
+  }
+
+  /**
+   * Get enhancer instance
+   * @returns {import('../core/ReportEnhancer').ReportEnhancer} Enhancer instance
+   */
+  getEnhancer() {
+    return this.enhancer;
+  }
+
+  /**
+   * Update recorder configuration
+   * @param {Partial<import('../core/CapVisionRecorder').CapVisionRecorderConfig>} config - Configuration updates
+   */
+  updateRecorderConfig(config) {
+    this.recorder.updateConfig(config);
+  }
+
+  /**
+   * Update enhancer configuration
+   * @param {Partial<import('../core/ReportEnhancer').ReportEnhancerConfig>} config - Configuration updates
+   */
+  updateEnhancerConfig(config) {
+    this.enhancer.updateConfig(config);
+  }
+
+  /**
+   * Set test type from test file path
+   * @param {string} testFilePath - Path to test file
+   * @returns {string|null} Detected test type or null
+   */
+  setTestTypeFromPath(testFilePath) {
+    return this.recorder.setTestTypeFromPath(testFilePath);
+  }
+
+  /**
+   * Check if recording is enabled
+   * @param {string} [cluster] - Override cluster check
+   * @param {string} [module] - Override module check
+   * @returns {boolean} True if recording enabled
+   */
+  isCapVisionEnabled(cluster, module) {
+    return this.recorder.isCapVisionEnabled(cluster, module);
+  }
+
+  /**
+   * Clear recordings folder
+   */
+  clearRecordingsFolder() {
+    this.recorder.clearRecordingsFolder();
+  }
+
+  /**
+   * Start recording
+   * @async
+   * @returns {Promise<void>}
+   * @throws {Error} If browser executor not initialized
+   */
+  async startRecording() {
+    if (!this.browserExecutor) {
+      throw new Error('Browser executor not initialized. Call init(browser) first.');
+    }
+    return this.recorder.startRecording();
+  }
+
+  /**
+   * Stop recording and save
+   * @async
+   * @param {string} [testName='test'] - Name of the test
+   * @param {boolean} [testPassed=true] - Whether the test passed. If true, recording is not saved permanently but temp file is still deleted
+   * @returns {Promise<import('../core/CapVisionRecorder').RecordingMetadata>} Recording metadata
+   * @throws {Error} If browser executor not initialized
+   */
+  async stopRecordingAndSave(testName = 'test', testPassed = true) {
+    if (!this.browserExecutor) {
+      throw new Error('Browser executor not initialized. Call init(browser) first.');
+    }
+    return this.recorder.stopRecordingAndSave(testName, testPassed);
+  }
+
+  /**
+   * Ensure CapVision is active after page refresh
+   * @async
+   * @returns {Promise<void>}
+   * @throws {Error} If browser executor not initialized
+   */
+  async ensureCapVisionIsActive() {
+    if (!this.browserExecutor) {
+      throw new Error('Browser executor not initialized. Call init(browser) first.');
+    }
+    return this.recorder.ensureCapVisionIsActive();
+  }
+
+  /**
+   * Enhance all reports
+   * @async
+   * @returns {Promise<void>}
+   */
+  async enhanceAllReports() {
+    return this.enhancer.enhanceAllReports();
+  }
+
+  /**
+   * Enhance a specific report
+   * @async
+   * @param {string} reportPath - Path to HTML report file
+   * @returns {Promise<void>}
+   */
+  async enhanceReport(reportPath) {
+    return this.enhancer.enhanceReport(reportPath);
+  }
+}
+
+/**
+ * Create WebdriverIO hooks for easy integration
+ * Usage: Add these hooks to your wdio.conf.js
+ * 
+ * @param {import('../core/CapVisionRecorder').CapVisionRecorderConfig} [recorderConfig={}] - Recorder configuration
+ * @param {import('../core/ReportEnhancer').ReportEnhancerConfig} [enhancerConfig={}] - Enhancer configuration
+ * @returns {Object} Hooks object with onPrepare, beforeTest, afterTest, onComplete, and getRecorder methods
+ * 
+ * @example
+ * const { createWDIOCapVisionHooks } = require('@capillarytech/cap-ui-dev-tools/capvision');
+ * 
+ * const hooks = createWDIOCapVisionHooks({
+ *   enabledClusters: ['staging'],
+ *   recordingsOutputDir: './reports/recordings'
+ * });
+ * 
+ * exports.config = {
+ *   onPrepare: hooks.onPrepare,
+ *   beforeTest: hooks.beforeTest,
+ *   afterTest: hooks.afterTest,
+ *   onComplete: hooks.onComplete
+ * };
+ */
+function createWDIOCapVisionHooks(recorderConfig = {}, enhancerConfig = {}) {
+  const capVisionRecorder = new WebdriverIOCapVisionRecorder(recorderConfig, enhancerConfig);
+
+  return {
+    /**
+     * Call in onPrepare hook to clear old recordings
+     * @returns {void}
+     */
+    onPrepare: () => {
+      capVisionRecorder.clearRecordingsFolder();
+    },
+
+    /**
+     * Call in beforeTest hook to start recording
+     * @async
+     * @param {Object} test - Test object
+     * @param {Object} context - Test context
+     * @param {Object} browser - WebdriverIO browser instance
+     * @returns {Promise<void>}
+     */
+    beforeTest: async (test, context, browser) => {
+      // Initialize browser executor
+      capVisionRecorder.init(browser);
+
+      // Detect test type from file path
+      if (test.file) {
+        capVisionRecorder.setTestTypeFromPath(test.file);
+      }
+
+      // Start recording if enabled
+      if (capVisionRecorder.isCapVisionEnabled()) {
+        try {
+          console.log('🟡 Starting CapVision recording for test:', test.title);
+          await capVisionRecorder.startRecording();
+        } catch (error) {
+          console.error('🔴 Failed to start CapVision recording:', error.message);
+        }
+      }
+    },
+
+    /**
+     * Call in afterTest hook to stop recording and save
+     * @async
+     * @param {Object} test - Test object
+     * @param {Object} context - Test context
+     * @param {Object} result - Test result object
+     * @returns {Promise<void>}
+     */
+    afterTest: async (test, context, result) => {
+      if (capVisionRecorder.isCapVisionEnabled()) {
+        try {
+          const testName = test.title || 'unknown_test';
+          console.log('🟡 Test result:', result.passed);
+          const testPassed = result.passed !== false; // Default to true if not specified
+          const metadata = await capVisionRecorder.stopRecordingAndSave(testName, testPassed);
+
+          if (metadata && metadata.totalEvents > 0) {
+            if (metadata.filename) {
+              console.log(`🟢 CapVision recording saved: ${metadata.totalEvents} events -> ${metadata.filename}`);
+            } else {
+              console.log(`🟡 CapVision recording discarded (test passed): ${metadata.totalEvents} events`);
+            }
+          } else {
+            console.log('🟨 No CapVision events were captured during test execution');
+          }
+        } catch (error) {
+          console.error('🔴 Failed to save CapVision recording:', error.message);
+        }
+      }
+    },
+
+    /**
+     * Call in onComplete hook to enhance reports
+     * @async
+     * @returns {Promise<void>}
+     */
+    onComplete: async () => {
+      try {
+        await capVisionRecorder.enhanceAllReports();
+      } catch (error) {
+        console.error('🔴 Failed to enhance reports:', error.message);
+      }
+    },
+
+    /**
+     * Get recorder instance for manual control
+     * @returns {WebdriverIOCapVisionRecorder} Recorder instance
+     */
+    getRecorder: () => capVisionRecorder
+  };
+}
+
+// Export all components
+module.exports = {
+  WebdriverIOBrowserExecutor,
+  WebdriverIOCapVisionRecorder,
+  createWDIOCapVisionHooks
+};
+

package/src/capvision-recorder/assets/capvision-player.css

@@ -0,0 +1 @@
+.replayer-wrapper{position:relative}.replayer-mouse{position:absolute;width:20px;height:20px;transition:left .05s linear,top .05s linear;background-size:contain;background-position:50%;background-repeat:no-repeat;background-image:url("data:image/svg+xml;base64,PHN2ZyBoZWlnaHQ9IjMwMCIgd2lkdGg9IjMwMCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBkYXRhLW5hbWU9IkxheWVyIDEiIHZpZXdCb3g9IjAgMCA1MCA1MCI+PHBhdGggZD0iTTQ4LjcxIDQyLjkxTDM0LjA4IDI4LjI5IDQ0LjMzIDE4YTEgMSAwIDAwLS4zMy0xLjYxTDIuMzUgMS4wNmExIDEgMCAwMC0xLjI5IDEuMjlMMTYuMzkgNDRhMSAxIDAgMDAxLjY1LjM2bDEwLjI1LTEwLjI4IDE0LjYyIDE0LjYzYTEgMSAwIDAwMS40MSAwbDQuMzgtNC4zOGExIDEgMCAwMC4wMS0xLjQyem0tNS4wOSAzLjY3TDI5IDMyYTEgMSAwIDAwLTEuNDEgMGwtOS44NSA5Ljg1TDMuNjkgMy42OWwzOC4xMiAxNEwzMiAyNy41OEExIDEgMCAwMDMyIDI5bDE0LjU5IDE0LjYyeiIvPjwvc3ZnPg==");border-color:transparent}.replayer-mouse:after{content:"";display:inline-block;width:20px;height:20px;background:#4950f6;border-radius:100%;transform:translate(-50%,-50%);opacity:.3}.replayer-mouse.active:after{animation:click .2s ease-in-out 1}.replayer-mouse.touch-device{background-image:none;width:70px;height:70px;border-radius:100%;margin-left:-37px;margin-top:-37px;border:4px solid rgba(73,80,246,0);transition:left 0s linear,top 0s linear,border-color .2s ease-in-out}.replayer-mouse.touch-device.touch-active{border-color:#4950f6;transition:left .25s linear,top .25s linear,border-color .2s ease-in-out}.replayer-mouse.touch-device:after{opacity:0}.replayer-mouse.touch-device.active:after{animation:touch-click .2s ease-in-out 1}.replayer-mouse-tail{position:absolute;pointer-events:none}@keyframes click{0%{opacity:.3;width:20px;height:20px}50%{opacity:.5;width:10px;height:10px}}@keyframes touch-click{0%{opacity:0;width:20px;height:20px}50%{opacity:.5;width:10px;height:10px}}.rr-player{position:relative;background:white;float:left;border-radius:5px;box-shadow:0 24px 48px rgba(17, 16, 62, 0.12)}.rr-player__frame{overflow:hidden}.replayer-wrapper{float:left;clear:both;transform-origin:top left;left:50%;top:50%}.replayer-wrapper>iframe{border:none}.rr-controller.svelte-19ke1iv.svelte-19ke1iv{width:100%;height:80px;background:#fff;display:flex;flex-direction:column;justify-content:space-around;align-items:center;border-radius:0 0 5px 5px}.rr-timeline.svelte-19ke1iv.svelte-19ke1iv{width:80%;display:flex;align-items:center}.rr-timeline__time.svelte-19ke1iv.svelte-19ke1iv{display:inline-block;width:100px;text-align:center;color:#11103e}.rr-progress.svelte-19ke1iv.svelte-19ke1iv{flex:1;height:12px;background:#eee;position:relative;border-radius:3px;cursor:pointer;box-sizing:border-box;border-top:solid 4px #fff;border-bottom:solid 4px #fff}.rr-progress.disabled.svelte-19ke1iv.svelte-19ke1iv{cursor:not-allowed}.rr-progress__step.svelte-19ke1iv.svelte-19ke1iv{height:100%;position:absolute;left:0;top:0;background:#e0e1fe}.rr-progress__handler.svelte-19ke1iv.svelte-19ke1iv{width:20px;height:20px;border-radius:10px;position:absolute;top:2px;transform:translate(-50%, -50%);background:rgb(73, 80, 246)}.rr-controller__btns.svelte-19ke1iv.svelte-19ke1iv{display:flex;align-items:center;justify-content:center;font-size:13px}.rr-controller__btns.svelte-19ke1iv button.svelte-19ke1iv{width:32px;height:32px;display:flex;padding:0;align-items:center;justify-content:center;background:none;border:none;border-radius:50%;cursor:pointer}.rr-controller__btns.svelte-19ke1iv button.svelte-19ke1iv:active{background:#e0e1fe}.rr-controller__btns.svelte-19ke1iv button.active.svelte-19ke1iv{color:#fff;background:rgb(73, 80, 246)}.rr-controller__btns.svelte-19ke1iv button.svelte-19ke1iv:disabled{cursor:not-allowed}.switch.svelte-9brlez.svelte-9brlez.svelte-9brlez{height:1em;display:flex;align-items:center}.switch.disabled.svelte-9brlez.svelte-9brlez.svelte-9brlez{opacity:0.5}.label.svelte-9brlez.svelte-9brlez.svelte-9brlez{margin:0 8px}.switch.svelte-9brlez input[type='checkbox'].svelte-9brlez.svelte-9brlez{position:absolute;opacity:0}.switch.svelte-9brlez label.svelte-9brlez.svelte-9brlez{width:2em;height:1em;position:relative;cursor:pointer;display:block}.switch.disabled.svelte-9brlez label.svelte-9brlez.svelte-9brlez{cursor:not-allowed}.switch.svelte-9brlez label.svelte-9brlez.svelte-9brlez:before{content:'';position:absolute;width:2em;height:1em;left:0.1em;transition:background 0.1s ease;background:rgba(73, 80, 246, 0.5);border-radius:50px}.switch.svelte-9brlez label.svelte-9brlez.svelte-9brlez:after{content:'';position:absolute;width:1em;height:1em;border-radius:50px;left:0;transition:all 0.2s ease;box-shadow:0px 2px 5px 0px rgba(0, 0, 0, 0.3);background:#fcfff4;animation:switch-off 0.2s ease-out;z-index:2}.switch.svelte-9brlez input[type='checkbox'].svelte-9brlez:checked+label.svelte-9brlez:before{background:rgb(73, 80, 246)}.switch.svelte-9brlez input[type='checkbox'].svelte-9brlez:checked+label.svelte-9brlez:after{animation:switch-on 0.2s ease-out;left:1.1em}