@systemfsoftware/stryker-js-plugin-interface 4.0.0 → 5.0.0

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @systemfsoftware/stryker-js-plugin-interface
+
+## 5.0.0
+
+### Major Changes
+
+- The plugin system now runs each configured TestRunner/Checker/Reporter plugin in its own spawned process over an @effect/rpc wire: plugins load from the project's config-declared specifiers (no glob discovery), boundary failures are typed errors, and plugin spans link into the host trace. Breaking: the in-process plugin Layer contract is removed.
+
+- `@systemfsoftware/stryker-js` is renamed to `@systemfsoftware/stryker-js-language`, and the plugin boundary now ships as the two packages `@systemfsoftware/stryker-js-plugin-interface` and `@systemfsoftware/stryker-js-plugin-runtime`.
+
+  `@systemfsoftware/stryker-js-plugin-interface` owns the contract both sides of the process split agree on: the per-kind `@effect/rpc` groups (`TestRunnerRpcs`, `CheckerRpcs`, `ReporterRpcs`), the boundary payload schemas, the typed boundary errors (`BoundaryPayloadRejected`, `BoundaryUnrecognizedSignal`), the spawn contract (`WorkerPluginKind`, `WorkerPluginSpawnSchema`, `WorkerEntryUrl`), and the trace-context contract (`TraceContextMiddleware`, `PropagatedTrace`, `TracedRpc`, `formatTraceparent`, `parseTraceparent`, `TraceContextReference`, `TRACEPARENT_HEADER`, `TRACESTATE_HEADER`).
+
+  `@systemfsoftware/stryker-js-plugin-runtime` owns what a plugin process actually runs: the worker server layer a plugin's `main.ts` launches (`workerServerLayer`, `nodeModuleLayer`), the worker and host OTel bootstraps (`startWorkerTelemetry`, `startHostTelemetry`), the worker-options wire codec (`encodeWorkerOptions`, `decodeWorkerOptions`, `readWorkerOptionsFromEnv`), and the trace-context middleware implementations (`layerTraceContextClient`, `layerTraceContextServer`, `withLinkedSpan`, `tracePartsOf`).
+
+  To migrate, update the package name on every import that is not a plugin symbol to `@systemfsoftware/stryker-js-language`; install `@systemfsoftware/stryker-js-plugin-interface` and import the contract symbols listed above from it, and install `@systemfsoftware/stryker-js-plugin-runtime` for the worker-side symbols. The former in-process surface (`declarePlugin`, `composePlugins`, `PluginContribution`, `PluginLayerContribution`, `PluginKind`, `PluginEnvironment`, `RunConfiguration`, `SandboxDirectory`) no longer exists: a plugin now declares `strykerPlugins: readonly { kind, name }[]` and a worker entry exported under `./worker` (or a `bin`) that serves the per-kind `RpcServer`.
+
+### Patch Changes
+
+- Maintenance release. Every published entry point, export, option, and behaviour is exactly as it was.

package/dist/index.d.mts

@@ -1,108 +1,170 @@
-import { CheckResultSchema, CheckerFailed, CheckerFailed as CheckerFailed$1, DryRunResultSchema, DryRunResultSchema as DryRunResultSchema$1, Mutant, MutantRunResultSchema, MutantRunResultSchema as MutantRunResultSchema$1, ReporterEventUnion, ReporterFailed, ReporterFailed as ReporterFailed$1, TestRunnerCapabilitiesSchema, TestRunnerCapabilitiesSchema as TestRunnerCapabilitiesSchema$1, TestRunnerFailed, TestRunnerFailed as TestRunnerFailed$1 } from "@systemfsoftware/stryker-js-language";
-import * as Rpc from "effect/unstable/rpc/Rpc";
-import * as RpcGroup from "effect/unstable/rpc/RpcGroup";
-import * as S from "effect/Schema";
-import * as Context from "effect/Context";
-import * as RpcMiddleware from "effect/unstable/rpc/RpcMiddleware";
-import * as Option from "effect/Option";
-import { Schema } from "effect";
-//#region src/Plugin.schema.d.ts
-export declare const WorkerPluginKind: S.Literals<readonly ["TestRunner", "Checker", "Reporter"]>;
-export type WorkerPluginKind = typeof WorkerPluginKind.Type;
-export declare const TestRunnerDryRunRequest: S.Struct<{
-  readonly options: S.Struct<{
-    readonly timeout: S.Finite;
-    readonly disableBail: S.Boolean;
-    readonly coverageAnalysis: S.Literals<readonly ["off", "all", "perTest"]>;
-    readonly files: S.optionalKey<S.$Array<S.String>>;
-    readonly testFiles: S.optionalKey<S.$Array<S.String>>;
-  }>;
-}>;
-export type TestRunnerDryRunRequest = typeof TestRunnerDryRunRequest.Type;
-export declare const TestRunnerMutantRunRequest: S.Struct<{
-  readonly options: S.Struct<{
-    readonly timeout: S.Finite;
-    readonly disableBail: S.Boolean;
-    readonly activeMutant: typeof Mutant;
-    readonly sandboxFileName: S.String;
-    readonly mutantActivation: S.Literals<readonly ["runtime", "static"]>;
-    readonly reloadEnvironment: S.Boolean;
-    readonly testFilter: S.optionalKey<S.$Array<S.String>>;
-    readonly hitLimit: S.optionalKey<S.Finite>;
-  }>;
-}>;
-export type TestRunnerMutantRunRequest = typeof TestRunnerMutantRunRequest.Type;
-export declare const CheckerRequest: S.Struct<{
-  readonly checkerName: S.String;
-  readonly mutants: S.$Array<typeof Mutant>;
-}>;
-export type CheckerRequest = typeof CheckerRequest.Type;
-export declare const CheckerCheckResult: S.$Record<S.String, S.Union<readonly [S.Struct<{
-  readonly status: S.Literal<"passed">;
-}>, S.Struct<{
-  readonly status: S.Literal<"compileError">;
-  readonly reason: S.String;
-}>]>>;
-export declare const CheckerGroupResult: S.$Array<S.$Array<S.String>>;
-export declare const ReporterInitOptions: S.Struct<{
-  readonly traceparent: S.optionalKey<S.String>;
-  readonly tracestate: S.optionalKey<S.String>;
-}>;
-export type ReporterInitOptions = typeof ReporterInitOptions.Type;
-export declare const ReporterEventBatch: S.$Array<S.Union<readonly [typeof import("@systemfsoftware/stryker-js-language").DryRunCompleted, typeof import("@systemfsoftware/stryker-js-language").MutationTestingPlanReady, typeof import("@systemfsoftware/stryker-js-language").MutantTested, typeof import("@systemfsoftware/stryker-js-language").MutationTestReportReady]>>;
-export type ReporterEventBatch = typeof ReporterEventBatch.Type;
-export declare const ReporterAck: S.Void;
-export declare const ReporterDrained: S.Void;
-declare const BoundaryPayloadRejected_base: S.Class<BoundaryPayloadRejected, S.TaggedStruct<"BoundaryPayloadRejected", {
-  readonly pluginName: S.String;
-  readonly method: S.String;
-  readonly cause: S.String;
-}>, import("effect/Cause").YieldableError>;
-export declare class BoundaryPayloadRejected extends BoundaryPayloadRejected_base {}
-declare const BoundaryUnrecognizedSignal_base: S.Class<BoundaryUnrecognizedSignal, S.TaggedStruct<"BoundaryUnrecognizedSignal", {
-  readonly pluginName: S.String;
-  readonly method: S.String;
-  readonly signal: S.String;
-}>, import("effect/Cause").YieldableError>;
-export declare class BoundaryUnrecognizedSignal extends BoundaryUnrecognizedSignal_base {}
-export declare const BoundaryErrorSchema: S.Union<readonly [typeof BoundaryPayloadRejected, typeof BoundaryUnrecognizedSignal, typeof TestRunnerFailed$1, typeof CheckerFailed$1, typeof ReporterFailed$1]>;
-type BoundaryError = typeof BoundaryErrorSchema.Type;
-export declare const WorkerEntryUrl: S.String;
-export type WorkerEntryUrl = typeof WorkerEntryUrl.Type;
-export declare const WorkerPluginSpawnSchema: S.Struct<{
-  readonly kind: S.Literals<readonly ["TestRunner", "Checker", "Reporter"]>;
-  readonly entrypoint: S.String;
-}>;
-type WorkerPluginSpawn = typeof WorkerPluginSpawnSchema.Type;
-//#endregion
-//#region src/TraceContext.schema.d.ts
-declare const Traceparent: S.String;
-type Traceparent = typeof Traceparent.Type;
-//#endregion
-//#region src/TraceContext.d.ts
-export declare const TRACEPARENT_HEADER = "traceparent";
-export declare const TRACESTATE_HEADER = "tracestate";
-interface TraceContextParts {
-  readonly version: string;
-  readonly traceId: string;
-  readonly spanId: string;
-  readonly traceFlags: number;
-  readonly traceState?: string | undefined;
-}
-export declare const formatTraceparent: (parts: TraceContextParts) => Traceparent;
-export declare const parseTraceparent: (value: string) => Option.Option<TraceContextParts>;
-export declare const TraceContextReference: Context.Reference<Option.Option<TraceContextParts>>;
-//#endregion
-//#region src/TraceContextRpc.d.ts
-declare const PropagatedTrace_base: Context.ServiceClass<PropagatedTrace, "@systemfsoftware/stryker-js-plugin-interface/TraceContextRpc/PropagatedTrace", Option.Option<TraceContextParts>>;
-export declare class PropagatedTrace extends PropagatedTrace_base {}
-declare const TraceContextMiddleware_base: RpcMiddleware.ServiceClass<TraceContextMiddleware, "@systemfsoftware/stryker-js-plugin-interface/TraceContextMiddleware", typeof PropagatedTrace, Schema.Never, never, never, true>;
-export declare class TraceContextMiddleware extends TraceContextMiddleware_base {}
-type TracedRpc<Tag extends string, Payload extends Schema.Top = Schema.Void, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never> = Rpc.Rpc<Tag, Payload, Success, Error, typeof TraceContextMiddleware, RpcMiddleware.ApplyServices<typeof TraceContextMiddleware['Identifier'], never>>;
-//#endregion
-//#region src/Plugin.d.ts
-export declare const TestRunnerRpcs: RpcGroup.RpcGroup<TracedRpc<'capabilities', Schema.Void, typeof TestRunnerCapabilitiesSchema$1, typeof TestRunnerFailed$1> | TracedRpc<'dryRun', typeof TestRunnerDryRunRequest, typeof DryRunResultSchema$1, typeof TestRunnerFailed$1> | TracedRpc<'mutantRun', typeof TestRunnerMutantRunRequest, typeof MutantRunResultSchema$1, typeof TestRunnerFailed$1>>;
-export declare const CheckerRpcs: RpcGroup.RpcGroup<TracedRpc<'check', typeof CheckerRequest, typeof CheckerCheckResult, typeof CheckerFailed$1> | TracedRpc<'group', typeof CheckerRequest, typeof CheckerGroupResult, typeof CheckerFailed$1>>;
-export declare const ReporterRpcs: RpcGroup.RpcGroup<TracedRpc<'init', typeof ReporterInitOptions, typeof ReporterAck, typeof ReporterFailed$1> | TracedRpc<'onEventBatch', typeof ReporterEventBatch, typeof ReporterAck, typeof ReporterFailed$1> | TracedRpc<'flush', Schema.Void, typeof ReporterDrained, typeof ReporterFailed$1>>;
-//#endregion
-export { type BoundaryError, CheckResultSchema, CheckerFailed, DryRunResultSchema, MutantRunResultSchema, ReporterEventUnion, ReporterFailed, TestRunnerCapabilitiesSchema, TestRunnerFailed, type TraceContextParts, type TracedRpc, type Traceparent, type WorkerPluginSpawn };
+import { CheckerFailed } from '@systemfsoftware/stryker-js-language';
+import { CheckResultSchema } from '@systemfsoftware/stryker-js-language';
+import * as Context from 'effect/Context';
+import { DryRunCompleted } from '@systemfsoftware/stryker-js-language';
+import { DryRunResultSchema } from '@systemfsoftware/stryker-js-language';
+import { Mutant } from '@systemfsoftware/stryker-js-language';
+import { MutantRunResultSchema } from '@systemfsoftware/stryker-js-language';
+import { MutantTested } from '@systemfsoftware/stryker-js-language';
+import { MutationTestingPlanReady } from '@systemfsoftware/stryker-js-language';
+import { MutationTestReportReady } from '@systemfsoftware/stryker-js-language';
+import * as Option from 'effect/Option';
+import { ReporterEventUnion } from '@systemfsoftware/stryker-js-language';
+import { ReporterFailed } from '@systemfsoftware/stryker-js-language';
+import * as Rpc from 'effect/unstable/rpc/Rpc';
+import * as RpcGroup from 'effect/unstable/rpc/RpcGroup';
+import * as RpcMiddleware from 'effect/unstable/rpc/RpcMiddleware';
+import * as S from 'effect/Schema';
+import { Schema } from 'effect';
+import { TestRunnerCapabilitiesSchema } from '@systemfsoftware/stryker-js-language';
+import { TestRunnerFailed } from '@systemfsoftware/stryker-js-language';
+import { YieldableError } from 'effect/Cause';
+
+export declare type BoundaryError = typeof BoundaryErrorSchema.Type;
+
+export declare const BoundaryErrorSchema: S.Union<readonly [typeof BoundaryPayloadRejected, typeof BoundaryUnrecognizedSignal, typeof TestRunnerFailed, typeof CheckerFailed, typeof ReporterFailed]>;
+
+export declare class BoundaryPayloadRejected extends BoundaryPayloadRejected_base {}
+
+declare const BoundaryPayloadRejected_base: S.Class<BoundaryPayloadRejected, S.TaggedStruct<"BoundaryPayloadRejected", {
+    readonly pluginName: S.String;
+    readonly method: S.String;
+    readonly cause: S.String;
+}>, YieldableError>;
+
+export declare class BoundaryUnrecognizedSignal extends BoundaryUnrecognizedSignal_base {}
+
+declare const BoundaryUnrecognizedSignal_base: S.Class<BoundaryUnrecognizedSignal, S.TaggedStruct<"BoundaryUnrecognizedSignal", {
+    readonly pluginName: S.String;
+    readonly method: S.String;
+    readonly signal: S.String;
+}>, YieldableError>;
+
+export declare const CheckerCheckResult: S.$Record<S.String, S.Union<readonly [S.Struct<{
+    readonly status: S.Literal<"passed">;
+}>, S.Struct<{
+    readonly status: S.Literal<"compileError">;
+    readonly reason: S.String;
+}>]>>;
+
+export { CheckerFailed }
+
+export declare const CheckerGroupResult: S.$Array<S.$Array<S.String>>;
+
+export declare const CheckerRequest: S.Struct<{
+    readonly checkerName: S.String;
+    readonly mutants: S.$Array<typeof Mutant>;
+}>;
+
+export declare type CheckerRequest = typeof CheckerRequest.Type;
+
+export declare const CheckerRpcs: RpcGroup.RpcGroup<TracedRpc<'check', typeof CheckerRequest, typeof CheckerCheckResult, typeof CheckerFailed> | TracedRpc<'group', typeof CheckerRequest, typeof CheckerGroupResult, typeof CheckerFailed>>;
+
+export { CheckResultSchema }
+
+export { DryRunResultSchema }
+
+export declare const formatTraceparent: (parts: TraceContextParts) => Traceparent;
+
+export { MutantRunResultSchema }
+
+export declare const parseTraceparent: (value: string) => Option.Option<TraceContextParts>;
+
+export declare class PropagatedTrace extends PropagatedTrace_base {}
+
+declare const PropagatedTrace_base: Context.ServiceClass<PropagatedTrace, "@systemfsoftware/stryker-js-plugin-interface/TraceContextRpc/PropagatedTrace", Option.Option<TraceContextParts>>;
+
+export declare const ReporterAck: S.Void;
+
+export declare const ReporterDrained: S.Void;
+
+export declare const ReporterEventBatch: S.$Array<S.Union<readonly [DryRunCompleted, MutationTestingPlanReady, MutantTested, MutationTestReportReady]>>;
+
+export declare type ReporterEventBatch = typeof ReporterEventBatch.Type;
+
+export { ReporterEventUnion }
+
+export { ReporterFailed }
+
+export declare const ReporterInitOptions: S.Struct<{
+    readonly traceparent: S.optionalKey<S.String>;
+    readonly tracestate: S.optionalKey<S.String>;
+}>;
+
+export declare type ReporterInitOptions = typeof ReporterInitOptions.Type;
+
+export declare const ReporterRpcs: RpcGroup.RpcGroup<TracedRpc<'init', typeof ReporterInitOptions, typeof ReporterAck, typeof ReporterFailed> | TracedRpc<'onEventBatch', typeof ReporterEventBatch, typeof ReporterAck, typeof ReporterFailed> | TracedRpc<'flush', Schema.Void, typeof ReporterDrained, typeof ReporterFailed>>;
+
+export { TestRunnerCapabilitiesSchema }
+
+export declare const TestRunnerDryRunRequest: S.Struct<{
+    readonly options: S.Struct<{
+        readonly timeout: S.Finite;
+        readonly disableBail: S.Boolean;
+        readonly coverageAnalysis: S.Literals<readonly ["off", "all", "perTest"]>;
+        readonly files: S.optionalKey<S.$Array<S.String>>;
+        readonly testFiles: S.optionalKey<S.$Array<S.String>>;
+    }>;
+}>;
+
+export declare type TestRunnerDryRunRequest = typeof TestRunnerDryRunRequest.Type;
+
+export { TestRunnerFailed }
+
+export declare const TestRunnerMutantRunRequest: S.Struct<{
+    readonly options: S.Struct<{
+        readonly timeout: S.Finite;
+        readonly disableBail: S.Boolean;
+        readonly activeMutant: typeof Mutant;
+        readonly sandboxFileName: S.String;
+        readonly mutantActivation: S.Literals<readonly ["runtime", "static"]>;
+        readonly reloadEnvironment: S.Boolean;
+        readonly testFilter: S.optionalKey<S.$Array<S.String>>;
+        readonly hitLimit: S.optionalKey<S.Finite>;
+    }>;
+}>;
+
+export declare type TestRunnerMutantRunRequest = typeof TestRunnerMutantRunRequest.Type;
+
+export declare const TestRunnerRpcs: RpcGroup.RpcGroup<TracedRpc<'capabilities', Schema.Void, typeof TestRunnerCapabilitiesSchema, typeof TestRunnerFailed> | TracedRpc<'dryRun', typeof TestRunnerDryRunRequest, typeof DryRunResultSchema, typeof TestRunnerFailed> | TracedRpc<'mutantRun', typeof TestRunnerMutantRunRequest, typeof MutantRunResultSchema, typeof TestRunnerFailed>>;
+
+export declare class TraceContextMiddleware extends TraceContextMiddleware_base {}
+
+declare const TraceContextMiddleware_base: RpcMiddleware.ServiceClass<TraceContextMiddleware, "@systemfsoftware/stryker-js-plugin-interface/TraceContextMiddleware", typeof PropagatedTrace, Schema.Never, never, never, true>;
+
+export declare interface TraceContextParts {
+    readonly version: string;
+    readonly traceId: string;
+    readonly spanId: string;
+    readonly traceFlags: number;
+    readonly traceState?: string | undefined;
+}
+
+export declare const TraceContextReference: Context.Reference<Option.Option<TraceContextParts>>;
+
+export declare type TracedRpc<Tag extends string, Payload extends Schema.Top = Schema.Void, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never> = Rpc.Rpc<Tag, Payload, Success, Error, typeof TraceContextMiddleware, RpcMiddleware.ApplyServices<typeof TraceContextMiddleware['Identifier'], never>>;
+
+export declare const Traceparent: S.String;
+
+export declare type Traceparent = typeof Traceparent.Type;
+
+export declare const TRACEPARENT_HEADER = "traceparent";
+
+export declare const TRACESTATE_HEADER = "tracestate";
+
+export declare const WorkerEntryUrl: S.String;
+
+export declare type WorkerEntryUrl = typeof WorkerEntryUrl.Type;
+
+export declare const WorkerPluginKind: S.Literals<readonly ["TestRunner", "Checker", "Reporter"]>;
+
+export declare type WorkerPluginKind = typeof WorkerPluginKind.Type;
+
+export declare type WorkerPluginSpawn = typeof WorkerPluginSpawnSchema.Type;
+
+export declare const WorkerPluginSpawnSchema: S.Struct<{
+    readonly kind: S.Literals<readonly ["TestRunner", "Checker", "Reporter"]>;
+    readonly entrypoint: S.String;
+}>;
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@systemfsoftware/stryker-js-plugin-interface",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/stryker-js-effect.git",
@@ -19,9 +19,10 @@
   },
   "dependencies": {
     "effect": "4.0.0-rc.112",
-    "@systemfsoftware/stryker-js-language": "^4.0.0"
+    "@systemfsoftware/stryker-js-language": "^5.0.0"
   },
   "devDependencies": {
+    "@effect/tsgo": "^0.45.0",
     "@microsoft/api-extractor": "^7",
     "@systemfsoftware/all": "^2",
     "@systemfsoftware/arethetypeswrong-cli": "^4",
@@ -35,9 +36,8 @@
     "tsdown": "^0.23.0",
     "typescript": "^7",
     "vitest": "^4",
-    "@effect/tsgo": "^0.45.0",
-    "@systemfsoftware/vitest-config": "^0.1.0",
-    "@systemfsoftware/tsdown-config": "^0.1.0"
+    "@systemfsoftware/tsdown-config": "^0.1.0",
+    "@systemfsoftware/vitest-config": "^0.1.0"
   },
   "publishConfig": {
     "access": "public",