@serenity-js/core/src/events/RetryableSceneDetected.ts

The core Serenity/JS framework, providing the Screenplay Pattern interfaces, as well as the test reporting and integration infrastructure

import type { JSONObject } from 'tiny-types';
import { ensure, isDefined } from 'tiny-types';

import { CorrelationId } from '../model';
import { Timestamp } from '../screenplay';
import { DomainEvent } from './DomainEvent';

/**
 * Indicates that the test runner will retry running the test scenario upon failure.
 *
 * @group Events
 */
export class RetryableSceneDetected extends DomainEvent {

    /**
     * Deserialises the event from a JSONObject
     *
     * @param o
     */
    static fromJSON(o: JSONObject): RetryableSceneDetected {
        return new RetryableSceneDetected(
            CorrelationId.fromJSON(o.sceneId as string),
            Timestamp.fromJSON(o.timestamp as string),
        );
    }

    /**
     * @param sceneId
     * @param [timestamp]
     */
    constructor(
        public readonly sceneId: CorrelationId,
        timestamp?: Timestamp,
    ) {
        super(timestamp);
        ensure('sceneId', sceneId, isDefined());
    }
}