feat(core): implement the mutation server protocol (MSP)

.vscode/launch.json

@@ -11,6 +11,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
+      "runtimeArgs": ["--experimental-strip-types", "--enable-source-maps"],
       "cwd": "${fileDirname}",
       "type": "node"
     },

packages/api/package.json

@@ -60,7 +60,7 @@
     "mutation-testing-metrics": "3.3.0",
     "mutation-testing-report-schema": "3.3.0",
     "tslib": "~2.7.0",
-    "typed-inject": "~4.0.0"
+    "typed-inject": "~5.0.0"
   },
   "devDependencies": {
     "@types/node": "20.17.9"

packages/core/package.json

@@ -79,8 +79,10 @@
     "emoji-regex": "~10.4.0",
     "execa": "~9.4.0",
     "file-url": "~4.0.0",
+    "json-rpc-2.0": "^1.7.0",
     "lodash.groupby": "~4.6.0",
     "minimatch": "~9.0.5",
+    "mutation-server-protocol": "~0.2.0",
     "mutation-testing-elements": "3.4.0",
     "mutation-testing-metrics": "3.3.0",
     "mutation-testing-report-schema": "3.3.0",
@@ -91,7 +93,7 @@
     "source-map": "~0.7.4",
     "tree-kill": "~1.2.2",
     "tslib": "2.7.0",
-    "typed-inject": "~4.0.0",
+    "typed-inject": "~5.0.0",
     "typed-rest-client": "~2.1.0"
   },
   "devDependencies": {

packages/core/src/child-proxy/child-process-proxy-worker.ts

@@ -10,7 +10,7 @@ import { coreTokens, PluginCreator } from '../di/index.js';
 import { PluginLoader } from '../di/plugin-loader.js';
 
 import { CallMessage, ParentMessage, ParentMessageKind, WorkerMessage, WorkerMessageKind, InitMessage } from './message-protocol.js';
-import { provideLogging, provideLoggingClient } from '../logging/provide-logging.js';
+import { provideLoggingClient } from '../logging/provide-logging.js';
 import { Logger } from '@stryker-mutator/api/logging';
 import { minPriority } from '../logging/priority.js';
 
@@ -68,8 +68,8 @@ export class ChildProcessProxyWorker {
       this.handlePromiseRejections();
 
       // Load plugins in the child process
-      const pluginInjector = provideLogging(
-        await provideLoggingClient(this.injector, message.loggingServerAddress, minPriority(message.options.logLevel, message.options.fileLogLevel)),
+      const pluginInjector = (
+        await provideLoggingClient(this.injector, message.loggingServerAddress, minPriority(message.options.logLevel, message.options.fileLogLevel))
       )
         .provideValue(commonTokens.options, message.options)
         .provideValue(commonTokens.fileDescriptions, message.fileDescriptions);
@@ -87,7 +87,7 @@ export class ChildProcessProxyWorker {
         this.log.debug(`Changing current working directory for this process to ${workingDir}`);
         process.chdir(workingDir);
       }
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+
       this.realSubject = injector.injectClass(RealSubjectClass);
       this.send({ kind: ParentMessageKind.Initialized });
     } catch (err) {

packages/core/src/di/core-tokens.ts

@@ -24,6 +24,7 @@ export const testRunnerFactory = 'testRunnerFactory';
 export const testRunnerPool = 'testRunnerPool';
 export const testRunnerConcurrencyTokens = 'testRunnerConcurrencyTokens';
 export const reporter = 'reporter';
+export const reporterOverride = 'reporterOverride';
 export const pluginCreator = 'pluginCreator';
 export const pluginsByKind = 'pluginsByKind';
 export const validationSchema = 'validationSchema';

packages/core/src/initializer/index.ts

@@ -12,10 +12,10 @@ import { StrykerInquirer } from './stryker-inquirer.js';
 import { createInitializers } from './custom-initializers/index.js';
 import { GitignoreWriter } from './gitignore-writer.js';
 import { createNpmRegistryClient, getRegistry } from './npm-registry.js';
-import { provideLogging, provideLoggingBackend } from '../logging/index.js';
+import { provideLoggingBackend } from '../logging/index.js';
 
 export async function initializerFactory(): Promise<StrykerInitializer> {
-  return provideLogging(await provideLoggingBackend(createInjector()))
+  return (await provideLoggingBackend(createInjector()))
     .provideValue(initializerTokens.out, console.log)
     .provideValue(coreTokens.execa, execaCommand)
     .provideValue(coreTokens.execaSync, execaCommandSync)

packages/core/src/logging/provide-logging.ts

@@ -20,29 +20,27 @@ function loggerFactory(getLogger: LoggerFactoryMethod, target: Function | undefi
 }
 loggerFactory.inject = [commonTokens.getLogger, commonTokens.target] as const;
 
-export function provideLogging<T extends { [coreTokens.loggingSink]: LoggingSink }>(injector: Injector<T>) {
-  return injector
-    .provideFactory(commonTokens.getLogger, getLoggerFactory)
-    .provideFactory(commonTokens.logger, loggerFactory, Scope.Transient)
-    .provideClass('loggingServer', LoggingServer);
+function provideLogging<T extends { [coreTokens.loggingSink]: LoggingSink }>(injector: Injector<T>) {
+  return injector.provideFactory(commonTokens.getLogger, getLoggerFactory).provideFactory(commonTokens.logger, loggerFactory, Scope.Transient);
 }
 provideLogging.inject = [coreTokens.loggingSink, commonTokens.injector] as const;
 
 export async function provideLoggingBackend(injector: Injector) {
   const out = injector.provideClass(coreTokens.loggingSink, LoggingBackend).provideClass(coreTokens.loggingServer, LoggingServer);
   const loggingServer = out.resolve(coreTokens.loggingServer);
   const loggingServerAddress = await loggingServer.listen();
-  return out.provideValue(coreTokens.loggingServerAddress, loggingServerAddress);
+  return provideLogging(out.provideValue(coreTokens.loggingServerAddress, loggingServerAddress));
 }
 provideLoggingBackend.inject = [commonTokens.injector] as const;
-
-export type LoggingProvider = ReturnType<typeof provideLogging>;
+export type LoggingBackendProvider = Awaited<ReturnType<typeof provideLoggingBackend>>;
 
 export async function provideLoggingClient(injector: Injector, loggingServerAddress: LoggingServerAddress, activeLogLevel: LogLevel) {
-  const out = injector
-    .provideValue(coreTokens.loggingServerAddress, loggingServerAddress)
-    .provideValue(coreTokens.loggerActiveLevel, activeLogLevel)
-    .provideClass(coreTokens.loggingSink, LoggingClient);
+  const out = provideLogging(
+    injector
+      .provideValue(coreTokens.loggingServerAddress, loggingServerAddress)
+      .provideValue(coreTokens.loggerActiveLevel, activeLogLevel)
+      .provideClass(coreTokens.loggingSink, LoggingClient),
+  );
   await out.resolve(coreTokens.loggingSink).openConnection();
   return out;
 }

packages/core/src/process/1-prepare-executor.ts

@@ -18,11 +18,12 @@ import { UnexpectedExitHandler } from '../unexpected-exit-handler.js';
 import { FileSystem, ProjectReader } from '../fs/index.js';
 
 import { MutantInstrumenterContext } from './index.js';
-import { LoggingBackend, LoggingServerAddress, LoggingSink } from '../logging/index.js';
+import { Reporter } from '@stryker-mutator/api/report';
+import { LoggingBackend, LoggingServerAddress } from '../logging/index.js';
 
 export interface PrepareExecutorContext extends BaseContext {
-  [coreTokens.loggingSink]: LoggingSink;
   [coreTokens.loggingServerAddress]: LoggingServerAddress;
+  [coreTokens.reporterOverride]?: Reporter;
 }
 
 export class PrepareExecutor {

packages/core/src/reporters/broadcast-reporter.ts

@@ -10,16 +10,21 @@ import { coreTokens, PluginCreator } from '../di/index.js';
 import { StrictReporter } from './strict-reporter.js';
 
 export class BroadcastReporter implements StrictReporter {
-  public static readonly inject = tokens(commonTokens.options, coreTokens.pluginCreator, commonTokens.logger);
+  public static readonly inject = tokens(commonTokens.options, coreTokens.pluginCreator, commonTokens.logger, coreTokens.reporterOverride);
 
   public readonly reporters: Record<string, Reporter>;
   constructor(
     private readonly options: StrykerOptions,
     private readonly pluginCreator: PluginCreator,
     private readonly log: Logger,
+    private readonly reporterOverride: Reporter | undefined,
   ) {
     this.reporters = {};
-    this.options.reporters.forEach((reporterName) => this.createReporter(reporterName));
+    if (this.reporterOverride) {
+      this.reporters['in-memory'] = this.reporterOverride;
+    } else {
+      this.options.reporters.forEach((reporterName) => this.createReporter(reporterName));
+    }
     this.logAboutReporters();
   }
 

packages/core/src/reporters/mutation-test-report-helper.ts

@@ -50,7 +50,7 @@ export class MutationTestReportHelper {
   ) {}
 
   public reportCheckFailed(mutant: MutantTestCoverage, checkResult: Exclude<CheckResult, PassedCheckResult>): MutantResult {
-    const location = this.toLocation(mutant.location);
+    const location = objectUtils.toSchemaLocation(mutant.location);
     return this.reportOne({
       ...mutant,
       status: this.checkStatusToResultStatus(checkResult.status),
@@ -60,7 +60,7 @@ export class MutationTestReportHelper {
   }
 
   public reportMutantStatus(mutant: MutantTestCoverage, status: MutantStatus): MutantResult {
-    const location = this.toLocation(mutant.location);
+    const location = objectUtils.toSchemaLocation(mutant.location);
     return this.reportOne({
       ...mutant,
       status,
@@ -69,7 +69,7 @@ export class MutationTestReportHelper {
   }
 
   public reportMutantRunResult(mutant: MutantTestCoverage, result: MutantRunResult): MutantResult {
-    const location = this.toLocation(mutant.location);
+    const location = objectUtils.toSchemaLocation(mutant.location);
 
     // Prune fields used for Stryker bookkeeping
     switch (result.status) {
@@ -244,7 +244,7 @@ export class MutationTestReportHelper {
     return {
       id: remapTestId(test.id),
       name: test.name,
-      location: test.startPosition ? { start: this.toPosition(test.startPosition) } : undefined,
+      location: test.startPosition ? { start: objectUtils.toSchemaPosition(test.startPosition) } : undefined,
     };
   }
 
@@ -272,20 +272,6 @@ export class MutationTestReportHelper {
     };
   }
 
-  private toLocation(location: Location): schema.Location {
-    return {
-      end: this.toPosition(location.end),
-      start: this.toPosition(location.start),
-    };
-  }
-
-  private toPosition(pos: Position): schema.Position {
-    return {
-      column: pos.column + 1, // convert from 0-based to 1-based
-      line: pos.line + 1,
-    };
-  }
-
   private discoverDependencies(): schema.Dependencies {
     const discover = (specifier: string) => {
       try {
@@ -326,7 +312,7 @@ export class MutationTestReportHelper {
   }
 }
 
-function normalizeReportFileName(fileName: string | undefined) {
+export function normalizeReportFileName(fileName: string | undefined) {
   if (fileName) {
     return normalizeFileName(path.relative(process.cwd(), fileName));
   }

packages/core/src/stryker-cli.ts

@@ -9,6 +9,7 @@ import { initializerFactory } from './initializer/index.js';
 import { Stryker } from './stryker.js';
 import { defaultOptions } from './config/index.js';
 import { strykerEngines, strykerVersion } from './stryker-package.js';
+import { StrykerServer } from './stryker-server.js';
 
 /**
  * Interpret a command line argument and add it to an object.
@@ -46,6 +47,11 @@ export class StrykerCli {
     private readonly argv: string[],
     private readonly program: Command = new Command(),
     private readonly runMutationTest = async (options: PartialStrykerOptions) => new Stryker(options).runMutationTest(),
+    private readonly runMutationTestingServer = async () => {
+      const server = new StrykerServer();
+      const port = await server.start();
+      console.log(JSON.stringify({ port }));
+    },
   ) {}
 
   public run(): void {
@@ -58,6 +64,7 @@ export class StrykerCli {
         `Possible commands:
         run: Run mutation testing
         init: Initialize Stryker for your project
+        runServer: Start the mutation testing server (implements the mutation testing server protocol)
 
         Optional location to a JSON or JavaScript config file as the last argument. If it's a JavaScript file, that file should export the config directly.`,
       )
@@ -208,6 +215,7 @@ export class StrykerCli {
     const commands = {
       init: async () => (await initializerFactory()).initialize(),
       run: () => this.runMutationTest(options),
+      runServer: () => this.runMutationTestingServer(),
     };
 
     if (Object.keys(commands).includes(this.command)) {