feat: initial commit

Author: Valiantsin2021

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: ci
+on: push
+permissions:
+  contents: write
+jobs:
+  check-and-test:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+
+      - name: Install everything 📦
+        run: npm ci
+
+      - name: Format and lint code ☑️
+        run: npm run prepublishOnly
+
+      - name: Run Playwright tests 🧪
+        run: npm run test
+        
+  release:
+    needs: [check-and-test]
+    runs-on: ubuntu-24.04
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+
+      - name: Semantic Release 🚀
+        uses: cycjimmy/semantic-release-action@v4
+        with:
+          branch: main
+          tag_format: v${version}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+.env
+test-results
+.hooks

.npmignore

@@ -0,0 +1,11 @@
+src
+tests
+.gitignore
+eslint.config.js
+.prettierignore
+.prettier.json
+tsconfig.json
+*.log
+test-results
+.hooks
+playwright.config.js

.prettierignore

@@ -0,0 +1,8 @@
+node_modules/
+report
+allure-report
+allure-results
+postman_collections
+playwright-report
+package-lock.json
+Readme.md

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "useTabs": false,
+  "tabWidth": 2,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "trailingComma": "none",
+  "printWidth": 200,
+  "endOfLine": "lf"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Valentin Lutchanka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Readme.md

@@ -0,0 +1,103 @@
+# Playwright Performance Metrics
+
+A comprehensive performance metrics collector for Playwright tests. Collect and analyze web vital metrics, network timing, and resource usage in your Playwright tests.
+
+## Features
+
+- Collect Web Vitals (LCP, FID, CLS)
+- Network timing metrics (TTFB, resource timing)
+- Network condition emulation (3G, 4G, WiFi)
+- Resource usage tracking
+- TypeScript support
+- Easy integration with Playwright tests
+
+## Installation
+
+```bash
+npm install -D playwright-performance-metrics
+```
+
+## Usage
+
+Basic usage:
+
+```typescript
+import { test } from '@playwright/test';
+import { PerformanceMetricsCollector } from 'playwright-performance-metrics';
+
+test('measure page performance', async ({ page }) => {
+  const collector = new PerformanceMetricsCollector(page);
+  
+  await page.goto('https://example.com');
+  
+  const metrics = await collector.collectMetrics({
+    timeout: 10000,
+    initialDelay: 1000
+  });
+  
+  console.log('Performance metrics:', {
+    'First Paint': metrics.paint?.firstPaint,
+    'First Contentful Paint': metrics.paint?.firstContentfulPaint,
+    'Largest Contentful Paint': metrics.largestContentfulPaint,
+    'Cumulative Layout Shift': metrics.cumulativeLayoutShift
+  });
+});
+```
+
+With network emulation:
+
+```typescript
+import { DefaultNetworkPresets } from 'playwright-performance-metrics';
+
+test('measure performance with slow 3G', async ({ page }) => {
+  const collector = new PerformanceMetricsCollector(page);
+  
+  const metrics = await collector.collectMetrics({
+    networkConditions: DefaultNetworkPresets.SLOW_3G,
+    timeout: 30000
+  });
+  
+  console.log('Slow 3G metrics:', metrics);
+});
+```
+
+## API Reference
+
+### PerformanceMetricsCollector
+
+Main class for collecting performance metrics.
+
+#### Constructor
+
+```typescript
+constructor(page: Page)
+```
+
+#### Methods
+
+##### collectMetrics(options?: PerformanceOptions): Promise<PerformanceMetrics>
+
+Collects performance metrics from the page.
+
+Options:
+- `startMark`: Performance mark to use as start time
+- `endMark`: Performance mark to use as end time
+- `timeout`: Collection timeout in milliseconds
+- `initialDelay`: Initial delay before starting collection
+- `retryTimeout`: Maximum time to retry collecting metrics
+- `networkConditions`: Network conditions to emulate
+
+### Network Presets
+
+Available network presets:
+- `REGULAR_4G`
+- `SLOW_3G`
+- `FAST_WIFI`
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License - see LICENSE file for details

dist/index.d.ts

@@ -0,0 +1,2 @@
+export { PerformanceMetricsCollector, DefaultNetworkPresets } from './performance-metrics'
+export * from './types'

dist/index.js

@@ -0,0 +1,42 @@
+'use strict'
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k
+        var desc = Object.getOwnPropertyDescriptor(m, k)
+        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k]
+            }
+          }
+        }
+        Object.defineProperty(o, k2, desc)
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k
+        o[k2] = m[k]
+      })
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m) if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p)
+  }
+Object.defineProperty(exports, '__esModule', { value: true })
+exports.DefaultNetworkPresets = exports.PerformanceMetricsCollector = void 0
+var performance_metrics_1 = require('./performance-metrics')
+Object.defineProperty(exports, 'PerformanceMetricsCollector', {
+  enumerable: true,
+  get: function () {
+    return performance_metrics_1.PerformanceMetricsCollector
+  }
+})
+Object.defineProperty(exports, 'DefaultNetworkPresets', {
+  enumerable: true,
+  get: function () {
+    return performance_metrics_1.DefaultNetworkPresets
+  }
+})
+__exportStar(require('./types'), exports)

dist/performance-metrics.d.ts

@@ -0,0 +1,40 @@
+import { Page } from '@playwright/test'
+import { IPerformanceMetricsCollector, NetworkConditions, NetworkPresets, PerformanceMetrics, PerformanceOptions } from './types'
+/**
+ * Default network condition presets for performance testing
+ */
+export declare const DefaultNetworkPresets: NetworkPresets
+/**
+ * Collector for gathering web performance metrics using Playwright.
+ */
+export declare class PerformanceMetricsCollector implements IPerformanceMetricsCollector {
+  private page
+  private cdpSession
+  /**
+   * Create a new PerformanceMetricsCollector.
+   * @param page - Playwright Page instance to collect metrics from.
+   */
+  constructor(page: Page)
+  /**
+   * Initialize the collector with optional network conditions.
+   * @param networkConditions - Network conditions to emulate.
+   * @throws Error if CDP session creation fails.
+   */
+  initialize(networkConditions?: NetworkConditions): Promise<void>
+  /**
+   * Clean up collector resources.
+   */
+  cleanup(): Promise<void>
+  /**
+   * Collect performance metrics from the page.
+   * @param options - Options for metric collection.
+   * @returns Collected performance metrics.
+   */
+  collectMetrics(options?: PerformanceOptions): Promise<PerformanceMetrics>
+  /**
+   * Validate collected metrics to ensure completeness.
+   * @param results - Collected performance metrics.
+   * @returns True if metrics are valid, otherwise false.
+   */
+  private hasValidMetrics
+}