@loadstrike/loadstrike-sdk 0.1.0

package/dist/types/cluster.d.ts

@@ -0,0 +1,112 @@
+export interface ClusterScenarioDispatch {
+    scenarioNames: string[];
+}
+export interface ClusterNodeResult {
+    nodeId: string;
+    success: boolean;
+    allRequestCount: number;
+    allOkCount: number;
+    allFailCount: number;
+    error?: string;
+    stats?: ClusterNodeStatsPayload;
+}
+export interface ClusterAgent {
+    nodeId: string;
+    execute: (dispatch: ClusterScenarioDispatch) => Promise<ClusterNodeResult>;
+}
+export interface ClusterCoordinatorOptions {
+    commandTimeoutMs?: number;
+    retryCount?: number;
+}
+export declare class LocalClusterCoordinator {
+    private readonly options;
+    constructor(options?: ClusterCoordinatorOptions);
+    dispatch(agents: ClusterAgent[], scenarioNames: string[], assignmentOptions?: ClusterAssignmentOptions): Promise<{
+        nodeResults: ClusterNodeResult[];
+        allRequestCount: number;
+        allOkCount: number;
+        allFailCount: number;
+        failedNodes: number;
+    }>;
+    private executeWithRetry;
+    private withTimeout;
+}
+export interface ClusterAssignmentOptions {
+    explicitAssignments?: string[][];
+    selectedScenarioNames?: string[];
+    agentTargets?: Array<string[] | undefined>;
+    agentWeights?: number[];
+}
+export declare function planAgentScenarioAssignments(scenarioNames: string[], agentCount: number, options?: ClusterAssignmentOptions): string[][];
+export interface ClusterRunCommandMessage {
+    commandId: string;
+    sessionId: string;
+    testSuite: string;
+    testName: string;
+    agentIndex: number;
+    agentCount: number;
+    targetScenarios: string[];
+    replySubject?: string;
+}
+export interface ClusterNodeStatsPayload {
+    allBytes?: number;
+    allRequestCount: number;
+    allOkCount: number;
+    allFailCount: number;
+    durationMs?: number;
+    metrics?: Record<string, unknown>;
+    scenarioStats?: unknown[];
+    thresholds?: unknown[];
+    pluginsData?: unknown[];
+    nodeInfo?: Record<string, unknown>;
+    testInfo?: Record<string, unknown>;
+}
+export interface ClusterRunResultMessage {
+    commandId: string;
+    agentId: string;
+    isSuccess: boolean;
+    errorMessage?: string;
+    stats?: ClusterNodeStatsPayload;
+}
+export interface DistributedClusterCoordinatorOptions {
+    clusterId: string;
+    sessionId: string;
+    testSuite: string;
+    testName: string;
+    expectedAgentResults: number;
+    agentGroup?: string;
+    commandTimeoutMs?: number;
+    nats?: Record<string, unknown>;
+}
+export interface DistributedClusterDispatchResult {
+    nodeResults: ClusterNodeResult[];
+    allRequestCount: number;
+    allOkCount: number;
+    allFailCount: number;
+    failedNodes: number;
+    missingNodes: number;
+    runSubject: string;
+    replySubject: string;
+}
+export declare class DistributedClusterCoordinator {
+    private readonly options;
+    constructor(options: DistributedClusterCoordinatorOptions);
+    dispatch(assignments: string[][]): Promise<DistributedClusterDispatchResult>;
+    private buildRunSubject;
+    private buildReplySubject;
+    private natsEndpoint;
+}
+export interface DistributedClusterAgentOptions {
+    clusterId: string;
+    sessionId: string;
+    agentId: string;
+    agentGroup?: string;
+    nats?: Record<string, unknown>;
+}
+export declare class DistributedClusterAgent {
+    private readonly options;
+    private commandConsumer;
+    constructor(options: DistributedClusterAgentOptions);
+    dispose(): Promise<void>;
+    pollAndExecuteOnce(execute: (dispatch: ClusterScenarioDispatch) => Promise<ClusterNodeResult> | ClusterNodeResult): Promise<boolean>;
+}

package/dist/types/contracts.d.ts

@@ -0,0 +1,439 @@
+export type LoadStrikeObject = Record<string, unknown>;
+export type LoadStrikeDateValue = string | Date;
+export interface LoadStrikeRunRequest {
+    Context?: LoadStrikeRunContext | Record<string, unknown>;
+    Scenarios?: Array<LoadStrikeScenarioSpec | Record<string, unknown>>;
+    RunArgs?: string[];
+}
+export interface LoadStrikeRunContext {
+    ConsoleMetricsEnabled?: boolean;
+    LocalDevClusterEnabled?: boolean;
+    ConfigPath?: string;
+    InfraConfigPath?: string;
+    AgentGroup?: string;
+    AgentsCount?: number;
+    AgentTargetScenarios?: string[];
+    ClusterId?: string;
+    CoordinatorTargetScenarios?: string[];
+    RunnerKey?: string;
+    LicenseValidationServerUrl?: string;
+    LicenseValidationTimeoutSeconds?: number;
+    MinimumLogLevel?: string;
+    NatsServerUrl?: string;
+    NodeType?: string;
+    ReportsEnabled?: boolean;
+    ReportFileName?: string;
+    ReportFolderPath?: string;
+    ReportFormats?: string[];
+    ReportingIntervalSeconds?: number;
+    ReportingSinks?: Array<LoadStrikeReportingSinkSpec | Record<string, unknown>>;
+    ScenarioCompletionTimeoutSeconds?: number;
+    ClusterCommandTimeoutSeconds?: number;
+    RestartIterationMaxAttempts?: number;
+    SessionId?: string;
+    TargetScenarios?: string[];
+    TestName?: string;
+    TestSuite?: string;
+    WorkerPlugins?: Array<LoadStrikeWorkerPluginSpec | Record<string, unknown>>;
+}
+export interface LoadStrikeScenarioSpec {
+    Name: string;
+    MaxFailCount?: number;
+    RestartIterationOnFail?: boolean;
+    WithoutWarmUp?: boolean;
+    WarmUpDurationSeconds?: number;
+    Weight?: number;
+    LoadSimulations?: LoadStrikeLoadSimulationSpec[];
+    Thresholds?: Array<LoadStrikeThresholdSpec | Record<string, unknown>>;
+    Tracking?: LoadStrikeTrackingConfigurationSpec | Record<string, unknown>;
+}
+export interface LoadStrikeLoadSimulationSpec {
+    Kind: string;
+    Rate?: number;
+    MinRate?: number;
+    MaxRate?: number;
+    Copies?: number;
+    Iterations?: number;
+    IntervalSeconds?: number;
+    DuringSeconds?: number;
+}
+export interface LoadStrikeThresholdSpec {
+    Scope: string;
+    StepName?: string;
+    Field: string;
+    Operator: string;
+    Value?: number;
+    AbortWhenErrorCount?: number;
+    StartCheckAfterSeconds?: number;
+}
+export interface LoadStrikeTrackingConfigurationSpec {
+    Source: LoadStrikeEndpointSpec;
+    Destination?: LoadStrikeEndpointSpec;
+    RunMode?: string;
+    CorrelationTimeoutSeconds?: number;
+    TimeoutSweepIntervalSeconds?: number;
+    TimeoutBatchSize?: number;
+    TimeoutCountsAsFailure?: boolean;
+    ExecuteOriginalScenarioRun?: boolean;
+    MetricPrefix?: string;
+    CorrelationStore?: LoadStrikeCorrelationStoreSpec;
+}
+export interface LoadStrikeCorrelationStoreSpec {
+    Kind?: string;
+    Redis?: LoadStrikeRedisCorrelationStoreSpec;
+}
+export interface LoadStrikeRedisCorrelationStoreSpec {
+    ConnectionString?: string;
+    Database?: number;
+    KeyPrefix?: string;
+    EntryTtlSeconds?: number;
+}
+export interface LoadStrikeEndpointSpec {
+    Kind: string;
+    Name: string;
+    Mode: string;
+    TrackingField: string;
+    GatherByField?: string;
+    AutoGenerateTrackingIdWhenMissing?: boolean;
+    PollIntervalSeconds?: number;
+    MessageHeaders?: Record<string, string>;
+    MessagePayload?: unknown;
+    ContentType?: string;
+    Http?: LoadStrikeHttpEndpointOptions;
+    Kafka?: LoadStrikeKafkaEndpointOptions;
+    RabbitMq?: LoadStrikeRabbitMqEndpointOptions;
+    Nats?: LoadStrikeNatsEndpointOptions;
+    RedisStreams?: LoadStrikeRedisStreamsEndpointOptions;
+    AzureEventHubs?: LoadStrikeAzureEventHubsEndpointOptions;
+    DelegateStream?: LoadStrikeDelegateEndpointOptions;
+    PushDiffusion?: LoadStrikePushDiffusionEndpointOptions;
+}
+export interface LoadStrikeHttpEndpointOptions {
+    Url?: string;
+    Method?: string;
+    BodyType?: string;
+    RequestTimeoutSeconds?: number;
+    TrackingPayloadSource?: string;
+    ConsumeJsonArrayResponse?: boolean;
+    Auth?: LoadStrikeHttpAuthOptions;
+}
+export interface LoadStrikeHttpAuthOptions {
+    Type?: string;
+    Username?: string;
+    Password?: string;
+    BearerToken?: string;
+    OAuth2ClientCredentials?: LoadStrikeHttpOAuth2ClientCredentialsOptions;
+}
+export interface LoadStrikeHttpOAuth2ClientCredentialsOptions {
+    TokenEndpoint?: string;
+    ClientId?: string;
+    ClientSecret?: string;
+    Scopes?: string[];
+    AdditionalFormFields?: Record<string, string>;
+}
+export interface LoadStrikeKafkaEndpointOptions {
+    BootstrapServers?: string;
+    Topic?: string;
+    ConsumerGroupId?: string;
+    SecurityProtocol?: string;
+    Sasl?: LoadStrikeKafkaSaslOptions;
+    ConfluentSettings?: Record<string, string>;
+    StartFromEarliest?: boolean;
+}
+export interface LoadStrikeKafkaSaslOptions {
+    Mechanism?: string;
+    Username?: string;
+    Password?: string;
+    OAuthBearerTokenEndpointUrl?: string;
+    AdditionalSettings?: Record<string, string>;
+}
+export interface LoadStrikeRabbitMqEndpointOptions {
+    HostName?: string;
+    Port?: number;
+    VirtualHost?: string;
+    UserName?: string;
+    Password?: string;
+    Exchange?: string;
+    RoutingKey?: string;
+    QueueName?: string;
+    Durable?: boolean;
+    AutoAck?: boolean;
+    UseSsl?: boolean;
+    ClientProperties?: Record<string, string>;
+}
+export interface LoadStrikeNatsEndpointOptions {
+    ServerUrl?: string;
+    Subject?: string;
+    QueueGroup?: string;
+    UserName?: string;
+    Password?: string;
+    Token?: string;
+    ConnectionName?: string;
+    MaxReconnectAttempts?: number;
+}
+export interface LoadStrikeRedisStreamsEndpointOptions {
+    ConnectionString?: string;
+    StreamKey?: string;
+    ConsumerGroup?: string;
+    ConsumerName?: string;
+    StartFromEarliest?: boolean;
+    ReadCount?: number;
+    MaxLength?: number;
+}
+export interface LoadStrikeAzureEventHubsEndpointOptions {
+    ConnectionString?: string;
+    EventHubName?: string;
+    ConsumerGroup?: string;
+    StartFromEarliest?: boolean;
+    PartitionId?: string;
+}
+export interface LoadStrikeDelegateEndpointOptions {
+    ProduceCallbackUrl?: string;
+    ConsumeCallbackUrl?: string;
+    ConnectionMetadata?: Record<string, string>;
+}
+export interface LoadStrikePushDiffusionEndpointOptions {
+    ServerUrl?: string;
+    TopicPath?: string;
+    Principal?: string;
+    Password?: string;
+    ConnectionProperties?: Record<string, string>;
+    PublishCallbackUrl?: string;
+    SubscribeCallbackUrl?: string;
+}
+export interface LoadStrikeReportingSinkSpec {
+    Kind: string;
+    InfluxDb?: LoadStrikeInfluxDbSinkOptions;
+    TimescaleDb?: LoadStrikeTimescaleDbSinkOptions;
+    GrafanaLoki?: LoadStrikeGrafanaLokiSinkOptions;
+    Datadog?: LoadStrikeDatadogSinkOptions;
+    Splunk?: LoadStrikeSplunkSinkOptions;
+    OtelCollector?: LoadStrikeOtelCollectorSinkOptions;
+    Webhook?: LoadStrikeWebhookSinkOptions;
+}
+export interface LoadStrikeInfluxDbSinkOptions {
+    BaseUrl?: string;
+    WriteEndpointPath?: string;
+    Organization?: string;
+    Bucket?: string;
+    Token?: string;
+    MeasurementName?: string;
+    TimeoutSeconds?: number;
+    StaticTags?: Record<string, string>;
+}
+export interface LoadStrikeTimescaleDbSinkOptions {
+    ConnectionString?: string;
+    Schema?: string;
+    TableName?: string;
+    CreateSchemaIfMissing?: boolean;
+    EnableHypertableIfAvailable?: boolean;
+    StaticTags?: Record<string, string>;
+}
+export interface LoadStrikeGrafanaLokiSinkOptions {
+    BaseUrl?: string;
+    PushEndpointPath?: string;
+    BearerToken?: string;
+    Username?: string;
+    Password?: string;
+    TenantId?: string;
+    TimeoutSeconds?: number;
+    StaticLabels?: Record<string, string>;
+}
+export interface LoadStrikeDatadogSinkOptions {
+    BaseUrl?: string;
+    LogsEndpointPath?: string;
+    MetricsEndpointPath?: string;
+    ApiKey?: string;
+    ApplicationKey?: string;
+    Source?: string;
+    Service?: string;
+    Host?: string;
+    TimeoutSeconds?: number;
+    StaticTags?: Record<string, string>;
+    StaticAttributes?: Record<string, string>;
+}
+export interface LoadStrikeSplunkSinkOptions {
+    BaseUrl?: string;
+    EventEndpointPath?: string;
+    Token?: string;
+    Source?: string;
+    Sourcetype?: string;
+    Index?: string;
+    Host?: string;
+    TimeoutSeconds?: number;
+    StaticFields?: Record<string, string>;
+}
+export interface LoadStrikeOtelCollectorSinkOptions {
+    BaseUrl?: string;
+    LogsEndpointPath?: string;
+    MetricsEndpointPath?: string;
+    TimeoutSeconds?: number;
+    Headers?: Record<string, string>;
+    StaticResourceAttributes?: Record<string, string>;
+}
+export interface LoadStrikeWebhookSinkOptions {
+    SinkName?: string;
+    CallbackUrl?: string;
+}
+export interface LoadStrikeWorkerPluginSpec {
+    PluginName: string;
+    CallbackUrl: string;
+}
+export interface LoadStrikeRunResponse {
+    CompletedUtc: LoadStrikeDateValue;
+    Stats: LoadStrikeNodeStatsDto;
+}
+export interface LoadStrikeNodeStatsDto {
+    AllBytes?: number;
+    AllFailCount?: number;
+    AllOkCount?: number;
+    AllRequestCount?: number;
+    DurationMs?: number;
+    NodeInfo?: LoadStrikeNodeInfoDto;
+    TestInfo?: LoadStrikeTestInfoDto;
+    Metrics?: LoadStrikeMetricStatsDto;
+    Scenarios?: LoadStrikeScenarioStatsDto[];
+    Thresholds?: LoadStrikeThresholdResultDto[];
+    Plugins?: LoadStrikePluginDataDto[];
+}
+export interface LoadStrikeNodeInfoDto {
+    CoresCount?: number;
+    CurrentOperation?: string;
+    DotNetVersion?: string;
+    MachineName?: string;
+    EngineVersion?: string;
+    NodeType?: string;
+    OS?: string;
+    Processor?: string;
+}
+export interface LoadStrikeTestInfoDto {
+    ClusterId?: string;
+    CreatedUtc?: LoadStrikeDateValue;
+    SessionId?: string;
+    TestName?: string;
+    TestSuite?: string;
+}
+export interface LoadStrikeScenarioStatsDto {
+    ScenarioName?: string;
+    SortIndex?: number;
+    AllBytes?: number;
+    AllFailCount?: number;
+    AllOkCount?: number;
+    AllRequestCount?: number;
+    CurrentOperation?: string;
+    DurationMs?: number;
+    Ok?: LoadStrikeMeasurementStatsDto;
+    Fail?: LoadStrikeMeasurementStatsDto;
+    Steps?: LoadStrikeStepStatsDto[];
+}
+export interface LoadStrikeStepStatsDto {
+    StepName?: string;
+    SortIndex?: number;
+    Ok?: LoadStrikeMeasurementStatsDto;
+    Fail?: LoadStrikeMeasurementStatsDto;
+}
+export interface LoadStrikeMeasurementStatsDto {
+    Request?: LoadStrikeRequestStatsDto;
+    Latency?: LoadStrikeLatencyStatsDto;
+    DataTransfer?: LoadStrikeDataTransferStatsDto;
+    StatusCodes?: LoadStrikeStatusCodeStatsDto[];
+}
+export interface LoadStrikeRequestStatsDto {
+    Count?: number;
+    Percent?: number;
+    Rps?: number;
+}
+export interface LoadStrikeLatencyStatsDto {
+    MinMs?: number;
+    MeanMs?: number;
+    MaxMs?: number;
+    StdDev?: number;
+    Percent50?: number;
+    Percent75?: number;
+    Percent95?: number;
+    Percent99?: number;
+}
+export interface LoadStrikeDataTransferStatsDto {
+    AllBytes?: number;
+    MinBytes?: number;
+    MeanBytes?: number;
+    MaxBytes?: number;
+    StdDev?: number;
+    Percent50?: number;
+    Percent75?: number;
+    Percent95?: number;
+    Percent99?: number;
+}
+export interface LoadStrikeStatusCodeStatsDto {
+    StatusCode?: string;
+    Message?: string;
+    Count?: number;
+    Percent?: number;
+    IsError?: boolean;
+}
+export interface LoadStrikeMetricStatsDto {
+    DurationMs?: number;
+    Counters?: LoadStrikeCounterStatsDto[];
+    Gauges?: LoadStrikeGaugeStatsDto[];
+}
+export interface LoadStrikeCounterStatsDto {
+    ScenarioName?: string;
+    MetricName?: string;
+    UnitOfMeasure?: string;
+    Value?: number;
+}
+export interface LoadStrikeGaugeStatsDto {
+    ScenarioName?: string;
+    MetricName?: string;
+    UnitOfMeasure?: string;
+    Value?: number;
+}
+export interface LoadStrikeThresholdResultDto {
+    ScenarioName?: string;
+    StepName?: string;
+    CheckExpression?: string;
+    ErrorCount?: number;
+    IsFailed?: boolean;
+    ExceptionMessage?: string;
+}
+export interface LoadStrikePluginDataDto {
+    PluginName?: string;
+    Hints?: string[];
+    Tables?: LoadStrikePluginDataTableDto[];
+}
+export interface LoadStrikePluginDataTableDto {
+    TableName?: string;
+    Rows?: Array<Record<string, unknown>>;
+}
+export interface LoadStrikePayloadDto {
+    Headers?: Record<string, string>;
+    BodyUtf8?: string;
+    BodyBase64?: string;
+    ContentType?: string;
+}
+export interface LoadStrikeProducedMessageRequestDto {
+    TrackingId: string;
+    EndpointKind: string;
+    EndpointName: string;
+    Mode: string;
+    Payload: LoadStrikePayloadDto;
+}
+export interface LoadStrikeProducedMessageResultDto {
+    IsSuccess?: boolean;
+    TimestampUtc?: string;
+    ErrorMessage?: string;
+    ResponsePayload?: LoadStrikePayloadDto;
+}
+export interface LoadStrikeConsumedMessageDto {
+    TimestampUtc?: string;
+    Payload?: LoadStrikePayloadDto;
+}
+export interface LoadStrikeWebhookEnvelope {
+    EventType: string;
+    Payload?: unknown;
+}
+export interface LoadStrikePluginCallbackResponse {
+    PluginName?: string;
+    Hints?: string[];
+    Tables?: LoadStrikePluginDataTableDto[];
+}