@systemfsoftware/stryker-js-html-reporter 4.0.4 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @systemfsoftware/stryker-js-html-reporter
 
+## 5.0.0
+
+### Major Changes
+
+- Each package's main entry point now groups its exports into namespaces named after a capability, such as `Plugin`, `TestRunner` and `Report`.
+
+  - Import the namespace and qualify each name, for example `Plugin.TestRunnerRpcs` after importing `Plugin` from the plugin interface.
+  - Import instrumenter schemas such as `Location` and `MutantStatus` from the instrumenter's `Mutant` namespace, and plugin-interface names from the plugin interface, instead of through another package's entry point.
+  - The engine's `/config`, `/events` and `/promises` entry points are unchanged.
+
+### Minor Changes
+
+- Each run stage, checker call, report write and test-runner mutant run now records an OpenTelemetry span named after its cell. The span has `.read` and `.write` child spans and an `app.<name>.decision` or `app.<name>.failure` attribute holding the outcome. It also feeds an `app.<name>.duration` histogram labelled `result_class`.
+
+- `makeHtmlReporter` can now be called with the reporter options alone, `makeHtmlReporter(options)`, and handed the reporter init when the run starts. The existing two-argument call, `makeHtmlReporter(options, init)`, keeps working exactly as before and remains the form the engine calls.
+
+### Patch Changes
+
+- The HTML report opens in the browser again. A cut-off logo image left the page markup unfinished, so the report never loaded and the page stayed blank.
+
+- Updated dependencies:
+  - @systemfsoftware/stryker-js-instrumenter@9.0.0
+  - @systemfsoftware/stryker-js-plugin-interface@8.0.0
+
+## 4.0.5
+
+### Patch Changes
+
+- Exported declarations that previously took `unknown` now take a defaulted type parameter: calls that omit the type argument are unchanged, and calls that were previously rejected for passing an unconstrained value are accepted. No runtime behaviour changes.
+
 ## 4.0.4
 
 ### Patch Changes

package/README.md

@@ -12,12 +12,14 @@ in-process reporter. The reporter exists so a programmatic consumer can assemble
 its own host:
 
 ```ts
-import { makeHtmlReporter } from '@systemfsoftware/stryker-js-html-reporter'
+import { HtmlReporter } from '@systemfsoftware/stryker-js-html-reporter'
+
+HtmlReporter.makeHtmlReporter
 ```
 
 ## Related
 
-- [`@systemfsoftware/stryker-js`][engine] — the run engine that emits the events this reporter presents, and the binary that binds `makeHtmlReporter` as a built-in reporter
+- [`@systemfsoftware/stryker-js`][engine] — the run engine that emits the events this reporter presents, and the binary that binds `HtmlReporter.makeHtmlReporter` as a built-in reporter
 
 ## License
 

package/dist/index.d.mts

@@ -1,5 +1,14 @@
-import { ReporterFactory } from '@systemfsoftware/stryker-js-plugin-interface';
-
-export declare const makeHtmlReporter: ReporterFactory;
-
-export { }
+import { Sandwich, Workflow } from "@systemfsoftware/effect-cell-types";
+import { Options, Reporter } from "@systemfsoftware/stryker-js-plugin-interface";
+import * as Effect from "effect/Effect";
+import "effect/FileSystem";
+import "effect/Path";
+import "effect/Schema";
+import { Schema } from "effect";
+//#region src/write-html-report.cell.d.ts
+declare const makeHtmlReporter: ((options: Options.StrykerOptions) => (init: Reporter.ReporterInit) => (events: AsyncIterable<Reporter.ReporterEvent>) => Effect.Effect<void, Reporter.ReporterFailed>) & ((options: Options.StrykerOptions, init: Reporter.ReporterInit) => (events: AsyncIterable<Reporter.ReporterEvent>) => Effect.Effect<void, Reporter.ReporterFailed>);
+declare namespace mod_d_exports {
+  export { makeHtmlReporter };
+}
+//#endregion
+export { mod_d_exports as HtmlReporter };

package/dist/index.mjs

@@ -1,30 +1,48 @@
+import { t as __exportAll } from "./rolldown-runtime-D7D4PA-g.mjs";
 import * as NodeFileSystem from "@effect/platform-node-shared/NodeFileSystem";
 import * as NodePath from "@effect/platform-node-shared/NodePath";
-import { errorToString } from "@systemfsoftware/stryker-js-instrumenter";
-import { MutationTestReportReady, ReporterFailed } from "@systemfsoftware/stryker-js-plugin-interface";
+import { Sandwich, Workflow } from "@systemfsoftware/effect-cell-types";
+import { ErrorText } from "@systemfsoftware/stryker-js-instrumenter";
+import { Reporter } from "@systemfsoftware/stryker-js-plugin-interface";
 import * as Effect from "effect/Effect";
 import * as FileSystem from "effect/FileSystem";
+import { dual } from "effect/Function";
 import * as Layer from "effect/Layer";
 import * as Match from "effect/Match";
+import * as Option$1 from "effect/Option";
 import * as Path from "effect/Path";
-import * as Ref from "effect/Ref";
 import * as S from "effect/Schema";
 import * as Stream from "effect/Stream";
-//#region src/Reporter.schema.ts
-const MutationTestResultSchema = S.Unknown;
-var HtmlReportCommand = class extends S.TaggedClass()("HtmlReportCommand", {
-	report: MutationTestResultSchema,
-	scriptContent: S.String
-}) {};
-var HtmlDocument = class extends S.TaggedClass()("HtmlDocument", { html: S.String }) {};
-S.TaggedError()("HtmlReportError", { message: S.String });
+import { Option, Schema } from "effect";
+import * as Result from "effect/Result";
+//#region src/render-html-report.workflow.ts
+const RenderHtmlReportTypeId = Symbol.for("@systemfsoftware/stryker-js-html-reporter/RenderHtmlReportDecision");
+var RenderHtmlReport = class extends Schema.TaggedClass()("RenderHtmlReport", {
+	fileName: Schema.String,
+	inlinedBundle: Schema.UndefinedOr(Schema.String)
+}) {
+	static [Workflow.InstrumentationBrand] = { fileName: "stryker.html_report.file_name" };
+};
+var BundleInlined = class extends Schema.TaggedClass()("BundleInlined", { bundle: Schema.String }) {
+	[RenderHtmlReportTypeId] = RenderHtmlReportTypeId;
+};
+var BundleFromDisk = class extends Schema.TaggedClass()("BundleFromDisk", {}) {
+	[RenderHtmlReportTypeId] = RenderHtmlReportTypeId;
+};
+const RenderHtmlReportDecision = Schema.Union([BundleInlined, BundleFromDisk]);
+const renderHtmlReport = Workflow.make({
+	command: RenderHtmlReport,
+	decision: RenderHtmlReportDecision,
+	error: Schema.Never,
+	decide: ({ inlinedBundle }) => Result.succeed(Option.match(Option.fromNullishOr(inlinedBundle), {
+		onNone: () => BundleFromDisk.make({}),
+		onSome: (bundle) => BundleInlined.make({ bundle })
+	}))
+});
 //#endregion
-//#region src/Reporter.ts
-function escapeHtmlTags(json) {
-	return json.replace(/</g, "<\"+\"");
-}
-function buildReportHtml(report, scriptContent) {
-	return `<!DOCTYPE html>
+//#region src/write-html-report.cell.ts
+const escapeHtmlTags = (json) => json.replace(/</g, "<\"+\"");
+const buildReportHtml = (report, scriptContent) => `<!DOCTYPE html>
   <html>
   <head>
     <meta charset="utf-8">
@@ -33,7 +51,7 @@ function buildReportHtml(report, scriptContent) {
     <\/script>
   </head>
   <body>
-    <svg style="width: 80px; position:fixed; right:10px; bottom:10px; z-index:10" class="stryker-image" viewBox="0 0 1458 1458" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path fill="none" d="M0 0h1458v1458H0z"/><clipPath id="a"><path d="M0 0h1458v1458H0z"/></clipPath><g clip-path="url(#a)"><path d="M1458 729c0 402.655-326.345 729-729 729S0 1131.655 0 729C0 326.445 326.345 0 729 0s729 326.345 729 729" fill="#e74c3c" fill-rule="nonzero"/><path d="M778.349 1456.15L576.6 1254.401l233-105 85-78.668v-64.332l-257-257-44-187-50-208 251.806-82.793L1076.6 389.401l380.14 379.15c-19.681 367.728-311.914 663.049-678.391 687.599z" fill-opacity=".3"/><path d="M753.4 329.503c41.79 0 74.579 7.83 97…</path></g></svg>
+    <svg style="width: 80px; position:fixed; right:10px; bottom:10px; z-index:10" class="stryker-image" viewBox="0 0 1458 1458" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path fill="none" d="M0 0h1458v1458H0z"/><clipPath id="a"><path d="M0 0h1458v1458H0z"/></clipPath><g clip-path="url(#a)"><path d="M1458 729c0 402.655-326.345 729-729 729S0 1131.655 0 729C0 326.445 326.345 0 729 0s729 326.345 729 729" fill="#e74c3c" fill-rule="nonzero"/><path d="M778.349 1456.15L576.6 1254.401l233-105 85-78.668v-64.332l-257-257-44-187-50-208 251.806-82.793L1076.6 389.401l380.14 379.15c-19.681 367.728-311.914 663.049-678.391 687.599z" fill-opacity=".3"/><path d="M753.4 329.503c41.79 0 74.579 7.83 97.925 25.444 23.571 18.015 41.69 43.956 55.167 77.097l11.662 28.679 165.733-58.183-14.137-32.13c-26.688-60.655-64.896-108.61-114.191-144.011-49.329-35.423-117.458-54.302-204.859-54.302-50.78 0-95.646 7.376-134.767 21.542-40.093 14.671-74.09 34.79-102.239 60.259-28.84 26.207-50.646 57.06-65.496 92.701-14.718 35.052-22.101 72.538-22.101 112.401 0 72.536 20.667 133.294 61.165 182.704 38.624 47.255 98.346 88.037 179.861 121.291 42.257 17.475 78.715 33.125 109.227 46.994 27.193 12.361 49.294 26.124 66.157 41.751 15.309 14.186 26.497 30.584 33.63 49.258 7.721 20.214 11.16 45.69 11.16 76.402 0 28.021-4.251 51.787-13.591 71.219-8.832 18.374-20.171 33.178-34.523 44.219-14.787 11.374-31.193 19.591-49.393 24.466-19.68 5.359-39.14 7.993-58.69 7.993-29.359 0-54.387-3.407-75.182-10.747-20.112-7.013-37.144-16.144-51.259-27.486-13.618-11.009-24.971-23.766-33.744-38.279-9.64-15.8-17.272-31.924-23.032-48.408l-10.965-31.376-161.669 60.585 10.734 30.124c10.191 28.601 24.197 56.228 42.059 82.748 18.208 27.144 41.322 51.369 69.525 72.745 27.695 21.075 60.904 38.218 99.481 51.041 37.777 12.664 82.004 19.159 132.552 19.159 49.998 0 95.818-8.321 137.611-24.622 42.228-16.471 78.436-38.992 108.835-67.291 30.719-28.597 54.631-62.103 71.834-100.642 17.263-38.56 25.923-79.392 25.923-122.248 0-54.339-8.368-100.37-24.208-138.32-16.29-38.759-38.252-71.661-65.948-98.797-26.965-26.418-58.269-48.835-93.858-67.175-33.655-17.241-69.196-33.11-106.593-47.533-35.934-13.429-65.822-26.601-89.948-39.525-22.153-11.868-40.009-24.21-53.547-37.309-11.429-11.13-19.83-23.678-24.718-37.664-5.413-15.49-7.98-33.423-7.98-53.577 0-40.883 11.293-71.522 37.086-90.539 28.443-20.825 64.985-30.658 109.311-30.658z" fill="#f1c40f" fill-rule="nonzero"/><path d="M720 0h18v113h-18zM1458 738v-18h-113v18h113zM720 1345h18v113h-18zM113 738v-18H0v18h113z"/></g></svg>
     <mutation-test-report-app titlePostfix="Stryker">
       Your browser doesn't support <a href="https://caniuse.com/#search=custom%20elements">custom elements</a>.
       Please use a latest version of an evergreen browser (Firefox, Chrome, Safari, Opera, Edge, etc).
@@ -49,33 +67,46 @@ function buildReportHtml(report, scriptContent) {
     <\/script>
   </body>
   </html>`;
-}
-const buildHtmlDocument = (command) => HtmlDocument.make({ html: buildReportHtml(command.report, command.scriptContent) });
 const BUNDLE_SPECIFIER = "mutation-testing-elements/dist/mutation-test-elements.js";
-const nodeFsPathLayer = Layer.mergeAll(NodeFileSystem.layer, NodePath.layer);
 const inlinedBundle = () => Match.value(typeof __STRYKER_HTML_REPORTER_CLIENT_BUNDLE__).pipe(Match.when("undefined", () => void 0), Match.orElse(() => __STRYKER_HTML_REPORTER_CLIENT_BUNDLE__));
-const readBundleContent = Effect.suspend(() => Match.value(inlinedBundle()).pipe(Match.when(Match.string, (bundle) => Effect.succeed(bundle)), Match.orElse(() => Effect.flatMap(FileSystem.FileSystem, (fs) => Effect.flatMap(Path.Path, (path) => Effect.flatMap(path.fromFileUrl(new URL(import.meta.resolve(BUNDLE_SPECIFIER))), (bundlePath) => fs.readFileString(bundlePath)))))));
-const writeHtmlFile = (fileName, html) => Effect.flatMap(FileSystem.FileSystem, (fs) => Effect.flatMap(Path.Path, (path) => Effect.andThen(fs.makeDirectory(path.dirname(fileName), { recursive: true }), fs.writeFileString(fileName, html))));
-const loadBundle = (cached) => Effect.filterOrElse(Ref.get(cached), (hit) => hit !== void 0, () => Effect.tap(readBundleContent, (fresh) => Ref.set(cached, fresh)));
-const writeReportHtml = (fileName, event, cached) => Effect.flatMap(loadBundle(cached), (bundle) => writeHtmlFile(fileName, buildHtmlDocument(HtmlReportCommand.make({
-	report: event.report,
-	scriptContent: bundle
-})).html));
-const failAsHtmlReporter = (cause) => ReporterFailed.make({
-	reporterName: "html",
-	event: "mutationTestReportReady",
-	cause: errorToString(cause)
+const readBundleFromDisk = Effect.gen(function* () {
+	const fs = yield* FileSystem.FileSystem;
+	const bundlePath = yield* (yield* Path.Path).fromFileUrl(new URL(import.meta.resolve(BUNDLE_SPECIFIER)));
+	return yield* fs.readFileString(bundlePath);
 });
-const writeReportHtmlIfReady = (fileName, event, cached) => {
-	if (S.is(MutationTestReportReady)(event)) return writeReportHtml(fileName, event, cached).pipe(Effect.mapError(failAsHtmlReporter));
-	return Effect.void;
-};
-const streamErrorOf = (cause) => ReporterFailed.make({
+const writeHtmlFile = (fileName, html) => Effect.gen(function* () {
+	const fs = yield* FileSystem.FileSystem;
+	const path = yield* Path.Path;
+	yield* fs.makeDirectory(path.dirname(fileName), { recursive: true });
+	yield* fs.writeFileString(fileName, html);
+});
+const readRenderCommand = (input) => Effect.succeed({
+	_tag: "RenderHtmlReport",
+	fileName: input.fileName,
+	inlinedBundle: inlinedBundle(),
+	report: input.report
+});
+const writeHtmlReport = Sandwich.named("html_report.write")(readRenderCommand).decide(renderHtmlReport).write({
+	BundleInlined: ({ bundle }, command) => writeHtmlFile(command.fileName, buildReportHtml(command.report, bundle)),
+	BundleFromDisk: (_decision, command) => Effect.gen(function* () {
+		const bundle = yield* readBundleFromDisk;
+		yield* writeHtmlFile(command.fileName, buildReportHtml(command.report, bundle));
+	}),
+	CommandRejected: (rejected) => Effect.die(rejected)
+});
+const nodeFsPathLayer = Layer.mergeAll(NodeFileSystem.layer, NodePath.layer);
+const failAsHtmlReporter = (cause) => Reporter.ReporterFailed.make({
 	reporterName: "html",
 	event: "mutationTestReportReady",
-	cause: errorToString(cause)
+	cause: Option$1.getOrElse(Option$1.map(ErrorText.ErrorText.fromCause(cause), (rendered) => rendered.text), () => "")
 });
-const drainEvents = (fileName, events) => Effect.flatMap(Ref.make(void 0), (cached) => Stream.runForEach(Stream.fromAsyncIterable(events, streamErrorOf), (event) => writeReportHtmlIfReady(fileName, event, cached)));
-const makeHtmlReporter = (options, _init) => (events) => Effect.provide(drainEvents(options.htmlReporter.fileName, events), nodeFsPathLayer);
+const drainEvents = (fileName, events) => Stream.runForEach(Stream.fromAsyncIterable(events, failAsHtmlReporter).pipe(Stream.filter(S.is(Reporter.MutationTestReportReady))), (ready) => writeHtmlReport.run({
+	fileName,
+	report: ready.report
+}).pipe(Effect.mapError(failAsHtmlReporter)));
+const makeHtmlReporter = dual(2, (options, _init) => (events) => Layer.build(nodeFsPathLayer).pipe(Effect.flatMap((platform) => Effect.provideContext(drainEvents(options.htmlReporter.fileName, events), platform)), Effect.scoped));
+//#endregion
+//#region src/HtmlReporter/mod.ts
+var HtmlReporter_exports = /* @__PURE__ */ __exportAll({ makeHtmlReporter: () => makeHtmlReporter });
 //#endregion
-export { makeHtmlReporter };
+export { HtmlReporter_exports as HtmlReporter };

package/dist/rolldown-runtime-D7D4PA-g.mjs

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@systemfsoftware/stryker-js-html-reporter",
-  "version": "4.0.4",
+  "version": "5.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/stryker-js-effect.git",
@@ -14,29 +14,29 @@
     "dist"
   ],
   "dependencies": {
-    "@effect/platform-node-shared": "4.0.0-rc.116",
-    "@systemfsoftware/effect-cell-types": "^8.3.1",
-    "mutation-testing-elements": "3.7.3",
-    "@systemfsoftware/stryker-js-instrumenter": "^8.0.0",
-    "@systemfsoftware/stryker-js-plugin-interface": "^7.1.1"
+    "@effect/platform-node-shared": "4.0.0-rc.117",
+    "@systemfsoftware/effect-cell-types": "^10.1.1",
+    "mutation-testing-elements": "3.9.0",
+    "@systemfsoftware/stryker-js-instrumenter": "^9.0.0",
+    "@systemfsoftware/stryker-js-plugin-interface": "^8.0.0"
   },
   "devDependencies": {
     "@effect/tsgo": "^0.45.0",
     "@microsoft/api-extractor": "^7",
-    "@systemfsoftware/all": "^2.1.1",
     "@systemfsoftware/arethetypeswrong-cli": "^4.2.0",
-    "@systemfsoftware/effect-gherkin-spec": "^4.1.0",
-    "@systemfsoftware/tsconfig": "^1.3.5",
+    "@systemfsoftware/effect-gherkin-spec": "^4.3.1",
+    "@systemfsoftware/oxlint-config-recommended": "^2.0.2",
+    "@systemfsoftware/tsconfig": "^2.0.1",
     "@types/node": "^24",
-    "effect": "4.0.0-rc.116",
+    "effect": "4.0.0-rc.117",
     "oxlint": "^1",
     "oxlint-tsgolint": "^7",
     "rimraf": "^6.1.3",
     "tsdown": "^0.23.0",
     "typescript": "^7",
     "vitest": "^5",
-    "@systemfsoftware/vitest-config": "^0.1.0",
-    "@systemfsoftware/tsdown-config": "^0.1.0"
+    "@systemfsoftware/tsdown-config": "^0.1.0",
+    "@systemfsoftware/vitest-config": "^0.1.0"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -47,7 +47,7 @@
     "provenance": true
   },
   "peerDependencies": {
-    "effect": "4.0.0-rc.116"
+    "effect": "4.0.0-rc.117"
   },
   "exports": {
     ".": {
@@ -59,12 +59,12 @@
   "scripts": {
     "clean": "rimraf dist",
     "build": "tsdown",
-    "typecheck": "tsc --noEmit --incremental && tsc -p tsconfig.node.json --noEmit",
+    "typecheck": "tsc -b",
     "attw": "attw --pack .",
     "test": "vitest run",
     "lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint --format=${f:-default}",
     "api:check": "api-extractor run",
     "api:update": "api-extractor run --local",
-    "lint:tsgo": "effect-tsgo diagnostics --project tsconfig.json --format ${TSGO_FORMAT:-text}"
+    "lint:tsgo": "effect-tsgo diagnostics --project tsconfig.app.json --format ${TSGO_FORMAT:-text} && effect-tsgo diagnostics --project tsconfig.test.json --format ${TSGO_FORMAT:-text}"
   }
 }