feat: add ability to sort by duration and start time (#623)

* feat: add ability to sort by duration and start time

* fix: display average time, use duration field for testplane tests

* test: implement unit tests for tree sorting

* test: fix tests after modifying tree builder helpers and fix review issues

Author: shadowusr

lib/adapters/test-result/index.ts

@@ -21,6 +21,9 @@ export interface ReporterTestResult {
     readonly state: { name: string };
     readonly status: TestStatus;
     readonly testPath: string[];
+    /** Test start timestamp in ms */
     readonly timestamp: number | undefined;
     readonly url?: string;
+    /** Test duration in ms */
+    readonly duration: number;
 }

lib/adapters/test-result/playwright.ts

@@ -364,4 +364,8 @@ export class PlaywrightTestResultAdapter implements ReporterTestResult {
 
         return _.groupBy(imageAttachments, a => a.name.replace(ANY_IMAGE_ENDING_REGEXP, ''));
     }
+
+    get duration(): number {
+        return this._testResult.duration;
+    }
 }

lib/adapters/test-result/reporter.ts

@@ -107,4 +107,8 @@ export class ReporterTestAdapter implements ReporterTestResult {
     get url(): string | undefined {
         return this._testResult.url;
     }
+
+    get duration(): number {
+        return this._testResult.duration;
+    }
 }

lib/adapters/test-result/sqlite.ts

@@ -151,4 +151,8 @@ export class SqliteTestResultAdapter implements ReporterTestResult {
     get url(): string | undefined {
         return this._testResult[DB_COLUMN_INDEXES.suiteUrl];
     }
+
+    get duration(): number {
+        return this._testResult[DB_COLUMN_INDEXES.duration];
+    }
 }

lib/adapters/test-result/testplane.ts

@@ -73,14 +73,16 @@ const getHistory = (history?: TestplaneTestResult['history']): TestStepCompresse
 export interface TestplaneTestResultAdapterOptions {
     attempt: number;
     status: TestStatus;
+    duration: number;
 }
 
 export class TestplaneTestResultAdapter implements ReporterTestResult {
     private _testResult: TestplaneTest | TestplaneTestResult;
     private _errorDetails: ErrorDetails | null;
-    private _timestamp: number | undefined;
+    private _timestamp: number;
     private _attempt: number;
     private _status: TestStatus;
+    private _duration: number;
 
     static create(
         this: new (testResult: TestplaneTest | TestplaneTestResult, options: TestplaneTestResultAdapterOptions) => TestplaneTestResultAdapter,
@@ -90,18 +92,20 @@ export class TestplaneTestResultAdapter implements ReporterTestResult {
         return new this(testResult, options);
     }
 
-    constructor(testResult: TestplaneTest | TestplaneTestResult, {attempt, status}: TestplaneTestResultAdapterOptions) {
+    constructor(testResult: TestplaneTest | TestplaneTestResult, {attempt, status, duration}: TestplaneTestResultAdapterOptions) {
         this._testResult = testResult;
         this._errorDetails = null;
-        this._timestamp = (this._testResult as TestplaneTestResult).timestamp ??
-            (this._testResult as TestplaneTestResult).startTime ?? Date.now();
+        this._timestamp = (this._testResult as TestplaneTestResult).startTime
+            ?? (this._testResult as TestplaneTestResult).timestamp
+            ?? Date.now();
         this._status = status;
 
         const browserVersion = _.get(this._testResult, 'meta.browserVersion', this._testResult.browserVersion);
 
         _.set(this._testResult, 'meta.browserVersion', browserVersion);
 
         this._attempt = attempt;
+        this._duration = duration;
     }
 
     get fullName(): string {
@@ -259,7 +263,11 @@ export class TestplaneTestResultAdapter implements ReporterTestResult {
 
     set timestamp(timestamp) {
         if (!_.isNumber(this._timestamp)) {
-            this._timestamp = timestamp;
+            this._timestamp = timestamp ?? 0;
         }
     }
+
+    get duration(): number {
+        return this._duration;
+    }
 }

lib/adapters/test-result/transformers/db.ts

@@ -38,7 +38,8 @@ export class DbTestResultTransformer {
             screenshot: Boolean(testResult.screenshot),
             multipleTabs: testResult.multipleTabs,
             status: testResult.status,
-            timestamp: testResult.timestamp ?? Date.now()
+            timestamp: testResult.timestamp ?? Date.now(),
+            duration: testResult.duration
         };
     }
 }

lib/adapters/test-result/utils/index.ts

@@ -31,7 +31,8 @@ export const copyAndUpdate = (
         'status',
         'testPath',
         'timestamp',
-        'url'
+        'url',
+        'duration'
     ] as const;
 
     // Type-level check that we didn't forget to include any keys

lib/adapters/test/index.ts

@@ -10,7 +10,8 @@ export interface CreateTestResultOpts {
     sessionId?: string;
     meta?: {
         url?: string;
-    }
+    };
+    duration: number;
 }
 
 export interface TestAdapter {

lib/adapters/test/testplane.ts

@@ -53,7 +53,7 @@ export class TestplaneTestAdapter implements TestAdapter {
     }
 
     createTestResult(opts: CreateTestResultOpts): ReporterTestResult {
-        const {status, assertViewResults, error, sessionId, meta, attempt = UNKNOWN_ATTEMPT} = opts;
+        const {status, assertViewResults, error, sessionId, meta, attempt = UNKNOWN_ATTEMPT, duration} = opts;
         const test = this._test.clone();
 
         [
@@ -68,7 +68,7 @@ export class TestplaneTestAdapter implements TestAdapter {
             }
         });
 
-        return TestplaneTestResultAdapter.create(test, {attempt, status});
+        return TestplaneTestResultAdapter.create(test, {attempt, status, duration});
     }
 }
 

lib/constants/database.ts

@@ -14,7 +14,8 @@ export const DB_COLUMNS = {
     SCREENSHOT: 'screenshot',
     MULTIPLE_TABS: 'multipleTabs',
     STATUS: 'status',
-    TIMESTAMP: 'timestamp'
+    TIMESTAMP: 'timestamp',
+    DURATION: 'duration'
 } as const;
 
 export const SUITES_TABLE_COLUMNS = [
@@ -31,7 +32,8 @@ export const SUITES_TABLE_COLUMNS = [
     {name: DB_COLUMNS.SCREENSHOT, type: DB_TYPES.int}, //boolean - 0 or 1
     {name: DB_COLUMNS.MULTIPLE_TABS, type: DB_TYPES.int}, //boolean - 0 or 1
     {name: DB_COLUMNS.STATUS, type: DB_TYPES.text},
-    {name: DB_COLUMNS.TIMESTAMP, type: DB_TYPES.int}
+    {name: DB_COLUMNS.TIMESTAMP, type: DB_TYPES.int},
+    {name: DB_COLUMNS.DURATION, type: DB_TYPES.int}
 ] as const;
 
 export const DB_MAX_AVAILABLE_PAGE_SIZE = 65536; // helps to speed up queries
@@ -55,7 +57,7 @@ interface DbColumnIndexes {
     [DB_COLUMNS.MULTIPLE_TABS]: 11,
     [DB_COLUMNS.STATUS]: 12,
     [DB_COLUMNS.TIMESTAMP]: 13,
-
+    [DB_COLUMNS.DURATION]: 14,
 }
 
 export const DB_COLUMN_INDEXES = SUITES_TABLE_COLUMNS.reduce((acc: Record<string, number>, {name}, index) => {