appium-session-recorder 0.0.2 → 0.0.4

package/src/server/interaction-recorder.ts

@@ -1,74 +0,0 @@
-import type { Interaction, ServerEvent } from './types';
-
-export class InteractionRecorder {
-    private history: Interaction[] = [];
-    private interactionId = 0;
-    private listeners: Set<(event: ServerEvent) => void> = new Set();
-
-    shouldRecord(method: string, path: string): boolean {
-        if (method === 'POST') {
-            return true;
-        }
-        return false;
-    }
-
-    isActionEndpoint(method: string, path: string): boolean {
-        const actionPatterns = [
-            /\/element\/[^/]+\/click$/,
-            /\/element\/[^/]+\/value$/,
-            /\/element\/[^/]+\/clear$/,
-            /\/element$/,
-            /\/elements$/,
-            /\/touch\/perform$/,
-            /\/actions$/,
-            /\/back$/,
-            /\/forward$/,
-            /\/refresh$/,
-        ];
-
-        if (method === 'POST' || method === 'DELETE') {
-            return actionPatterns.some(pattern => pattern.test(path));
-        }
-        return false;
-    }
-
-    recordInteraction(interaction: Omit<Interaction, 'id' | 'timestamp'>): Interaction {
-        const fullInteraction: Interaction = {
-            id: ++this.interactionId,
-            timestamp: new Date().toISOString(),
-            ...interaction,
-        };
-
-        this.history.push(fullInteraction);
-        this.emit({ type: 'interaction', data: fullInteraction });
-
-        return fullInteraction;
-    }
-
-    updateInteraction(id: number, updates: Partial<Interaction>): void {
-        const interaction = this.history.find(i => i.id === id);
-        if (interaction) {
-            Object.assign(interaction, updates);
-            this.emit({ type: 'interaction', data: interaction });
-        }
-    }
-
-    getHistory(): Interaction[] {
-        return this.history;
-    }
-
-    clearHistory(): void {
-        this.history = [];
-        this.interactionId = 0;
-        this.emit({ type: 'clear', data: null });
-    }
-
-    on(listener: (event: ServerEvent) => void): () => void {
-        this.listeners.add(listener);
-        return () => this.listeners.delete(listener);
-    }
-
-    private emit(event: ServerEvent): void {
-        this.listeners.forEach(listener => listener(event));
-    }
-}

package/src/server/proxy-middleware.ts

@@ -1,68 +0,0 @@
-import { Request, Response, NextFunction } from 'express';
-import { createProxyMiddleware, fixRequestBody } from 'http-proxy-middleware';
-import type { Interaction } from './types';
-import { AppiumClient } from './appium-client';
-import { InteractionRecorder } from './interaction-recorder';
-
-export function createSessionMiddleware(
-    recorder: InteractionRecorder,
-    appiumClient: AppiumClient,
-) {
-    return async (req: Request, res: Response, next: NextFunction) => {
-        const { sessionId } = req.params;
-
-        // Skip ignored endpoints
-        if (!recorder.shouldRecord(req.method, req.originalUrl)) {
-            return next();
-        }
-
-        const isAction = recorder.isActionEndpoint(req.method, req.path);
-
-        // Create interaction record
-        const interactionData: Omit<Interaction, 'id' | 'timestamp'> = {
-            method: req.method,
-            path: req.originalUrl,
-            body: req.body && Object.keys(req.body).length > 0 ? req.body : undefined,
-        };
-
-        // Extract element info for find operations
-        if (req.body?.using && req.body?.value) {
-            interactionData.elementInfo = {
-                using: req.body.using,
-                value: req.body.value,
-            };
-        }
-
-        const interaction = recorder.recordInteraction(interactionData);
-
-        console.log(`[${interaction.id}] ${req.method} ${req.originalUrl}`);
-        if (interaction.body) {
-            console.log('Body:', JSON.stringify(interaction.body, null, 2));
-        }
-
-        // For actions, capture state after the action completes
-        if (isAction) {
-            res.on('finish', async () => {
-                const state = await appiumClient.captureState(sessionId);
-                recorder.updateInteraction(interaction.id, {
-                    screenshot: state.screenshot,
-                    source: state.source,
-                });
-                console.log(`[${interaction.id}] State captured (screenshot + source)`);
-            });
-        }
-
-        next();
-    };
-}
-
-export function createAppiumProxy(appiumUrl: string) {
-    return createProxyMiddleware({
-        target: appiumUrl,
-        changeOrigin: true,
-        ws: true,
-        on: {
-            proxyReq: fixRequestBody,
-        },
-    });
-}

package/src/server/routes.ts

@@ -1,64 +0,0 @@
-import express, { Router } from 'express';
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import type { InteractionRecorder } from './interaction-recorder';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-// Resolve UI dist path: works from both source (src/server/) and bundle (dist/)
-function resolveUiDir(): string {
-    const candidates = [
-        path.join(__dirname, '../../dist/ui'),  // dev: running from src/server/
-        path.join(__dirname, 'ui'),              // prod: running from dist/
-    ];
-    return candidates.find(p => fs.existsSync(p)) || candidates[0];
-}
-
-const uiDir = resolveUiDir();
-
-export function createRoutes(recorder: InteractionRecorder) {
-    const router = Router();
-
-    // Serve the UI
-    router.get('/_recorder', (_req, res) => {
-        res.sendFile(path.join(uiDir, 'index.html'));
-    });
-
-    // Serve static assets using express.static for better performance and caching
-    router.use('/_recorder/assets', express.static(path.join(uiDir, 'assets')));
-
-    // API: Get history
-    router.get('/_recorder/api/history', (_req, res) => {
-        res.json(recorder.getHistory());
-    });
-
-    // API: Clear history
-    router.delete('/_recorder/api/history', (_req, res) => {
-        recorder.clearHistory();
-        res.json({ ok: true });
-    });
-
-    // API: Server-Sent Events for real-time updates
-    router.get('/_recorder/api/stream', (req, res) => {
-        res.setHeader('Content-Type', 'text/event-stream');
-        res.setHeader('Cache-Control', 'no-cache');
-        res.setHeader('Connection', 'keep-alive');
-
-        // Send initial history
-        res.write(`data: ${JSON.stringify({ type: 'init', data: recorder.getHistory() })}\n\n`);
-
-        // Listen for new interactions
-        const unsubscribe = recorder.on((event) => {
-            res.write(`data: ${JSON.stringify(event)}\n\n`);
-        });
-
-        // Clean up on close
-        req.on('close', () => {
-            unsubscribe();
-        });
-    });
-
-    return router;
-}

package/src/server/server.ts

@@ -1,43 +0,0 @@
-import express from 'express';
-import type { RecorderOptions } from './types';
-import { AppiumClient } from './appium-client';
-import { InteractionRecorder } from './interaction-recorder';
-import { createSessionMiddleware, createAppiumProxy } from './proxy-middleware';
-import { createRoutes } from './routes';
-
-export function createServer(options: RecorderOptions = {}) {
-    const appiumUrl = options.appiumUrl ?? 'http://127.0.0.1:4723';
-
-    const app = express();
-    const appiumClient = new AppiumClient(appiumUrl);
-    const recorder = new InteractionRecorder();
-
-    // Parse JSON bodies
-    app.use(express.json({ type: ['application/json', 'application/*+json'], limit: '10mb' }));
-    app.use(express.urlencoded({ extended: true, limit: '1mb' }));
-
-    // Register routes
-    app.use(createRoutes(recorder));
-
-    // Intercept session requests
-    app.use('/session/:sessionId', createSessionMiddleware(recorder, appiumClient));
-
-    // Proxy everything to Appium
-    app.use(createAppiumProxy(appiumUrl));
-
-    return { app, recorder };
-}
-
-export function startServer(options: RecorderOptions = {}) {
-    const host = options.host ?? '127.0.0.1';
-    const port = options.port ?? 4724;
-    const appiumUrl = options.appiumUrl ?? 'http://127.0.0.1:4723';
-
-    const { app } = createServer(options);
-
-    return app.listen(port, host, () => {
-        console.log(`\n✅ Session Recorder started:`);
-        console.log(`   Proxy:  http://${host}:${port} → ${appiumUrl}`);
-        console.log(`   Viewer: http://${host}:${port}/_recorder\n`);
-    });
-}

package/src/server/types.ts

@@ -1,34 +0,0 @@
-export type RecorderOptions = {
-    appiumUrl?: string;
-    host?: string;
-    port?: number;
-};
-
-export type ElementInfo = {
-    using: string;
-    value: string;
-};
-
-export type Interaction = {
-    id: number;
-    timestamp: string;
-    method: string;
-    path: string;
-    body?: any;
-    screenshot?: string;  // base64
-    source?: string;      // XML
-    elementInfo?: ElementInfo;
-};
-
-export type AppiumResponse = {
-    value: any;
-    sessionId?: string;
-    status?: number;
-};
-
-export type ServerEventType = 'interaction' | 'clear';
-
-export type ServerEvent = {
-    type: ServerEventType;
-    data: Interaction | null;
-};