fix(api): allow for different api versions of File (#2042)

Customize the way we serialize files to make sure different versions of `stryker-api` can be mixed and matched (although not recommended).

Fixes #2025

Co-authored-by: Simon de Lang <simondelang@gmail.com>

packages/api/package.json

@@ -40,11 +40,11 @@
   },
   "dependencies": {
     "mutation-testing-report-schema": "^1.1.0",
+    "surrial": "^2.0.1",
     "tslib": "~1.10.0"
   },
   "devDependencies": {
     "@types/node": "^13.7.1",
-    "surrial": "~1.0.0",
     "typed-inject": "~2.1.1"
   }
 }

packages/api/src/core/File.ts

@@ -1,7 +1,9 @@
+import { Surrializable, surrial } from 'surrial';
+
 /**
  * Represents a file within Stryker. Could be a strictly in-memory file.
  */
-export default class File {
+export default class File implements Surrializable {
   private _textContent: string | undefined;
   private readonly _content: Buffer;
 
@@ -35,4 +37,12 @@ export default class File {
     }
     return this._textContent;
   }
+
+  /**
+   * This fixes the issue of different File versions not being compatible.
+   * @see https://github.com/stryker-mutator/stryker/issues/2025
+   */
+  public surrialize(): string {
+    return surrial`new File(${this.name}, ${this.content})`;
+  }
 }

packages/api/test/unit/core/File.spec.ts

@@ -19,5 +19,13 @@ describe('File', () => {
     const serialized = serialize(expected);
     const actual = deserialize(serialized, [File]);
     expect(actual).deep.eq(expected);
+    expect(actual).instanceOf(File);
+  });
+
+  /**
+   * @see https://github.com/stryker-mutator/stryker/issues/2025
+   */
+  it('should customize serialization to allow different instances of the class file to be compatible', () => {
+    expect(new File('foo', Buffer.from('bar')).surrialize()).eq('new File("foo", Buffer.from("bar", "binary"))');
   });
 });

packages/core/package.json

@@ -72,7 +72,7 @@
     "rimraf": "~3.0.0",
     "rxjs": "~6.5.1",
     "source-map": "~0.7.3",
-    "surrial": "~1.0.0",
+    "surrial": "^2.0.1",
     "tree-kill": "~1.2.0",
     "tslib": "~1.10.0",
     "typed-inject": "~2.1.1",

workspace.code-workspace

@@ -117,7 +117,12 @@
     "task.autoDetect": "off",
     "editor.codeActionsOnSave": {
       "source.fixAll.eslint": true
-    }
+    },
+    "cSpell.words": [
+      "Surrializable",
+      "serializable",
+      "surrialize"
+    ]
   },
   "extensions": {
     "recommendations": [