@lokalise/playwright-reporters 1.6.0 → 1.7.0

package/dist/analytics/transform.d.ts

@@ -15,7 +15,7 @@ export declare const formFailedTestData: (test: TestCase, result: TestResult, te
     name: string;
     team: string | null;
     testRunId: string;
-    status: import("playwright/types/test").TestStatus;
+    status: "failed" | "interrupted" | "passed" | "timedOut" | "skipped";
     hooksDuration: number;
     beforeHookDuration: number;
     afterHookDuration: number;
@@ -32,7 +32,7 @@ export declare const formFlakyTestData: (test: TestCase, result: TestResult, tes
     name: string;
     team: string | null;
     testRunId: string;
-    status: import("playwright/types/test").TestStatus;
+    status: "failed" | "interrupted" | "passed" | "timedOut" | "skipped";
     hooksDuration: number;
     beforeHookDuration: number;
     afterHookDuration: number;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import AnalyticsReporter, { defineAnalyticsReporterConfig } from './analytics/reporter';
+import PermissionsReporter, { definePermissionsReporterConfig } from './permissions/reporter';
 import RetryReporter, { defineRetryReporterConfig } from './retry/reporter';
 import StepDurationReporter, { defineStepDurationReporterConfig } from './stepDuration/reporter';
 import TimelineReporter, { defineTimelineReporterConfig } from './timeline/reporter';
-export { AnalyticsReporter, defineAnalyticsReporterConfig, RetryReporter, defineRetryReporterConfig, TimelineReporter, defineTimelineReporterConfig, StepDurationReporter, defineStepDurationReporterConfig, };
+export { AnalyticsReporter, defineAnalyticsReporterConfig, RetryReporter, defineRetryReporterConfig, TimelineReporter, defineTimelineReporterConfig, StepDurationReporter, defineStepDurationReporterConfig, PermissionsReporter, definePermissionsReporterConfig };

package/dist/index.js

@@ -23,16 +23,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineStepDurationReporterConfig = exports.StepDurationReporter = exports.defineTimelineReporterConfig = exports.TimelineReporter = exports.defineRetryReporterConfig = exports.RetryReporter = exports.defineAnalyticsReporterConfig = exports.AnalyticsReporter = void 0;
+exports.definePermissionsReporterConfig = exports.PermissionsReporter = exports.defineStepDurationReporterConfig = exports.StepDurationReporter = exports.defineTimelineReporterConfig = exports.TimelineReporter = exports.defineRetryReporterConfig = exports.RetryReporter = exports.defineAnalyticsReporterConfig = exports.AnalyticsReporter = void 0;
 const reporter_1 = __importStar(require("./analytics/reporter"));
 exports.AnalyticsReporter = reporter_1.default;
 Object.defineProperty(exports, "defineAnalyticsReporterConfig", { enumerable: true, get: function () { return reporter_1.defineAnalyticsReporterConfig; } });
-const reporter_2 = __importStar(require("./retry/reporter"));
-exports.RetryReporter = reporter_2.default;
-Object.defineProperty(exports, "defineRetryReporterConfig", { enumerable: true, get: function () { return reporter_2.defineRetryReporterConfig; } });
-const reporter_3 = __importStar(require("./stepDuration/reporter"));
-exports.StepDurationReporter = reporter_3.default;
-Object.defineProperty(exports, "defineStepDurationReporterConfig", { enumerable: true, get: function () { return reporter_3.defineStepDurationReporterConfig; } });
-const reporter_4 = __importStar(require("./timeline/reporter"));
-exports.TimelineReporter = reporter_4.default;
-Object.defineProperty(exports, "defineTimelineReporterConfig", { enumerable: true, get: function () { return reporter_4.defineTimelineReporterConfig; } });
+const reporter_2 = __importStar(require("./permissions/reporter"));
+exports.PermissionsReporter = reporter_2.default;
+Object.defineProperty(exports, "definePermissionsReporterConfig", { enumerable: true, get: function () { return reporter_2.definePermissionsReporterConfig; } });
+const reporter_3 = __importStar(require("./retry/reporter"));
+exports.RetryReporter = reporter_3.default;
+Object.defineProperty(exports, "defineRetryReporterConfig", { enumerable: true, get: function () { return reporter_3.defineRetryReporterConfig; } });
+const reporter_4 = __importStar(require("./stepDuration/reporter"));
+exports.StepDurationReporter = reporter_4.default;
+Object.defineProperty(exports, "defineStepDurationReporterConfig", { enumerable: true, get: function () { return reporter_4.defineStepDurationReporterConfig; } });
+const reporter_5 = __importStar(require("./timeline/reporter"));
+exports.TimelineReporter = reporter_5.default;
+Object.defineProperty(exports, "defineTimelineReporterConfig", { enumerable: true, get: function () { return reporter_5.defineTimelineReporterConfig; } });

package/dist/permissions/elastic.d.ts

@@ -0,0 +1,13 @@
+import type { PermissionsReportData } from "./reporter";
+export type ElasticOptions = {
+    permissionsIndex: string;
+    elasticUrl: string;
+    elasticToken: string;
+};
+export declare class Elastic {
+    private readonly options;
+    private request;
+    constructor(options: ElasticOptions);
+    setRequestContext(): Promise<void>;
+    savePermissionsData(testData: PermissionsReportData): Promise<void>;
+}

package/dist/permissions/elastic.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Elastic = void 0;
+const test_1 = require("@playwright/test");
+class Elastic {
+    constructor(options) {
+        this.options = options;
+    }
+    async setRequestContext() {
+        this.request = await test_1.request.newContext({
+            baseURL: this.options.elasticUrl,
+            ignoreHTTPSErrors: true,
+            ...(this.options.elasticToken && {
+                extraHTTPHeaders: { Authorization: `ApiKey ${this.options.elasticToken}` },
+            }),
+        });
+    }
+    async savePermissionsData(testData) {
+        try {
+            await this.request.post(`/${this.options.permissionsIndex}/_doc`, { data: testData });
+        }
+        catch (error) {
+            console.error("Failed to save permissions data");
+            console.error(error);
+        }
+    }
+}
+exports.Elastic = Elastic;

package/dist/permissions/reporter.d.ts

@@ -0,0 +1,25 @@
+import type { TestCase, TestResult, Reporter, TestStep } from '@playwright/test/reporter';
+import { type ElasticOptions } from './elastic';
+type ReporterOptions = {
+    annotationName: string;
+    stepName: string;
+    debug: boolean;
+} & ElasticOptions;
+export type PermissionsReportData = {
+    title: string;
+    permissions: Record<string, boolean>;
+    failedStep: string;
+    timestamp: number;
+};
+export default class PermissionsReporter implements Reporter {
+    private readonly options;
+    private readonly elastic;
+    private readonly debugLogging;
+    private failedTestData;
+    constructor(options: ReporterOptions);
+    onBegin(): Promise<void>;
+    onTestEnd(test: TestCase): Promise<void>;
+    onStepEnd(test: TestCase, _result: TestResult, step: TestStep): void;
+}
+export declare const definePermissionsReporterConfig: (options: ConstructorParameters<typeof PermissionsReporter>[0]) => ReporterOptions;
+export {};

package/dist/permissions/reporter.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.definePermissionsReporterConfig = void 0;
+const elastic_1 = require("./elastic");
+// eslint-disable-next-line import/no-default-export
+class PermissionsReporter {
+    constructor(options) {
+        this.elastic = new elastic_1.Elastic(options);
+        this.options = options;
+        this.failedTestData = {};
+        this.debugLogging = options.debug ? console.info : () => { };
+    }
+    async onBegin() {
+        await this.elastic.setRequestContext();
+    }
+    async onTestEnd(test) {
+        // Omit the results if the test is passing
+        if (test.outcome() === 'expected') {
+            this.debugLogging('Not reporting test - test passed');
+            return;
+        }
+        // Omit the results if the test does not contain the annotation
+        if (!test.annotations.find((annotation) => annotation.type === this.options.annotationName)) {
+            this.debugLogging('Not reporting test - no permission annotation');
+            return;
+        }
+        // Test Title
+        const testTitle = test.title;
+        // Permissions as object
+        const testPermissions = test.annotations.find((annotation) => annotation.type === this.options.annotationName);
+        const permissionContents = testPermissions?.description ? JSON.parse(testPermissions.description) : {};
+        // Which step failed
+        const failedStep = this.failedTestData[test.id];
+        // Send payload body
+        const reportData = {
+            title: testTitle,
+            permissions: permissionContents,
+            failedStep,
+            timestamp: Date.now()
+        };
+        await this.elastic.savePermissionsData(reportData);
+    }
+    onStepEnd(test, _result, step) {
+        if (!step.title.includes(this.options.stepName)) {
+            this.debugLogging('Not reporting step - no step annotation', step.title);
+            return;
+        }
+        if (!step.error) {
+            this.debugLogging("Not reporting step - no error");
+            return;
+        }
+        this.debugLogging('Captured step name with error:', step.title);
+        this.failedTestData[test.id] = step.title;
+    }
+}
+exports.default = PermissionsReporter;
+const definePermissionsReporterConfig = (options) => options;
+exports.definePermissionsReporterConfig = definePermissionsReporterConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@lokalise/playwright-reporters",
-	"version": "1.6.0",
+	"version": "1.7.0",
 	"scripts": {
 		"lint:eslint": "eslint --cache . --ext .js,.cjs,.ts",
 		"lint:ts": "tsc --noEmit",
@@ -41,35 +41,39 @@
 		"./testSimilarity": {
 			"import": "./dist/testSimilarity/reporter.js",
 			"require": "./dist/testSimilarity/reporter.js"
+		},
+		"./permissions": {
+			"import": "./dist/permissions/reporter.js",
+			"require": "./dist/permissions/reporter.js"
 		}
 	},
 	"publishConfig": {
 		"access": "public"
 	},
 	"devDependencies": {
-		"@commitlint/cli": "19.2.2",
+		"@commitlint/cli": "19.3.0",
 		"@commitlint/config-conventional": "19.2.2",
-		"@commitlint/prompt-cli": "19.2.2",
+		"@commitlint/prompt-cli": "19.3.1",
 		"@lokalise/eslint-config-frontend": "^4.6.0",
-		"@lokalise/prettier-config": "^1.0.0",
+		"@lokalise/prettier-config": "^1.0.1",
 		"@semantic-release/changelog": "6.0.3",
-		"@semantic-release/commit-analyzer": "12.0.0",
+		"@semantic-release/commit-analyzer": "13.0.0",
 		"@semantic-release/git": "10.0.1",
-		"@semantic-release/github": "10.0.3",
-		"@semantic-release/npm": "12.0.0",
+		"@semantic-release/github": "10.0.6",
+		"@semantic-release/npm": "12.0.1",
 		"@semantic-release/release-notes-generator": "13.0.0",
-		"@types/lodash": "^4.17.0",
-		"@types/node": "^20.12.7",
+		"@types/lodash": "^4.17.5",
+		"@types/node": "^20.14.2",
 		"eslint-config-prettier": "^9.1.0",
 		"eslint-plugin-prettier": "^5.1.3",
 		"husky": "9.0.11",
-		"prettier": "^3.2.5",
-		"semantic-release": "23.0.8",
+		"prettier": "^3.3.2",
+		"semantic-release": "23.1.1",
 		"typescript": "5.4.5"
 	},
 	"dependencies": {
 		"@faker-js/faker": "^8.4.1",
-		"@playwright/test": "^1.43.1",
+		"@playwright/test": "^1.44.1",
 		"fastest-levenshtein": "^1.0.16",
 		"lodash": "^4.17.21"
 	},