🐛 Better interrupt between multiple versions

fast-check was badly behaving on cloning method, custom toString and assertions linked to pre when several versions of it were running at the same time. One of the case for that issue is ES module and CommonJS being mixed in the same test and leading fast-check to be loaded once in ESM and once in CJS. Another case is that user relies on two versions of fast-check due to a dependency forcing a version that is not the same as the one requested by the user or by another dependency (not the same meaning not compatible semver ranges). Fixes #4845
dubzzz · May 14, 2024 · 405e813 · 405e813
1 parent 8f9103d
commit 405e813
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/packages/fast-check/src/check/precondition/PreconditionFailure.ts b/packages/fast-check/src/check/precondition/PreconditionFailure.ts
@@ -5,7 +5,7 @@
  */
 export class PreconditionFailure extends Error {
  /** @internal */
- private static readonly SharedFootPrint: symbol = Symbol('fast-check/PreconditionFailure');
+ private static readonly SharedFootPrint: symbol = Symbol.for('fast-check/PreconditionFailure');
  /** @internal */
  private readonly footprint: symbol;
  constructor(readonly interruptExecution: boolean = false) {

diff --git a/packages/fast-check/src/check/symbols.ts b/packages/fast-check/src/check/symbols.ts
@@ -11,7 +11,7 @@
  * @remarks Since 1.8.0
  * @public
  */
-export const cloneMethod = Symbol('fast-check/cloneMethod');
+export const cloneMethod = Symbol.for('fast-check/cloneMethod');
 
 /**
  * Object instance that should be cloned from one generation/shrink to another

diff --git a/packages/fast-check/src/utils/stringify.ts b/packages/fast-check/src/utils/stringify.ts
@@ -28,7 +28,7 @@ const safePositiveInfinity = Number.POSITIVE_INFINITY;
  * @remarks Since 2.17.0
  * @public
  */
-export const toStringMethod = Symbol('fast-check/toStringMethod');
+export const toStringMethod = Symbol.for('fast-check/toStringMethod');
 /**
  * Interface to implement for {@link toStringMethod}
  *
@@ -62,7 +62,7 @@ export function hasToStringMethod<T>(instance: T): instance is T & WithToStringM
  * @remarks Since 2.17.0
  * @public
  */
-export const asyncToStringMethod = Symbol('fast-check/asyncToStringMethod');
+export const asyncToStringMethod = Symbol.for('fast-check/asyncToStringMethod');
 /**
  * Interface to implement for {@link asyncToStringMethod}
  *

diff --git a/packages/fast-check/test/unit/utils/stringify.spec.ts b/packages/fast-check/test/unit/utils/stringify.spec.ts
@@ -423,7 +423,7 @@ describe('stringify', () => {
  const instance3 = { [toStringMethod]: () => { throw new Error('hello3'); } };
  const stringified3 = stringify(instance3);
  expect(stringified3.replace(/[\s\n]+/g, ' ')).toEqual(
- '{[Symbol("fast-check/toStringMethod")]:() => { throw new Error("hello3"); }}',
+ '{[Symbol.for("fast-check/toStringMethod")]:() => { throw new Error("hello3"); }}',
  ); // fallbacking to default
 
  class InProto {
@@ -435,11 +435,11 @@ describe('stringify', () => {
  expect(stringify(instance4)).toEqual('hello4');
 
  const instance5 = { [toStringMethod]: 1 }; // not callable
- expect(stringify(instance5)).toEqual('{[Symbol("fast-check/toStringMethod")]:1}');
+ expect(stringify(instance5)).toEqual('{[Symbol.for("fast-check/toStringMethod")]:1}');
  });
  it('Should not be able to rely on the output of [asyncToStringMethod] in sync mode', () => {
  const instance1 = { [asyncToStringMethod]: () => 'hello1' }; // not even async there
- expect(stringify(instance1)).toEqual('{[Symbol("fast-check/asyncToStringMethod")]:() => "hello1"}'); // fallbacking to default
+ expect(stringify(instance1)).toEqual('{[Symbol.for("fast-check/asyncToStringMethod")]:() => "hello1"}'); // fallbacking to default
 
  const instance2 = { [asyncToStringMethod]: () => 'hello2', [toStringMethod]: () => 'world' };
  expect(stringify(instance2)).toEqual('world'); // fallbacking to [toStringMethod]
@@ -560,7 +560,7 @@ describe('asyncStringify', () => {
  const instance4 = { [asyncToStringMethod]: async () => { throw new Error('hello4'); } };
  const stringified4 = await asyncStringify(instance4);
  expect(stringified4.replace(/[\s\n]+/g, ' ')).toEqual(
- '{[Symbol("fast-check/asyncToStringMethod")]:async () => { throw new Error("hello4"); }}',
+ '{[Symbol.for("fast-check/asyncToStringMethod")]:async () => { throw new Error("hello4"); }}',
  ); // fallbacking to default
 
  // prettier-ignore
@@ -571,7 +571,7 @@ describe('asyncStringify', () => {
  const instance6 = { [asyncToStringMethod]: () => { throw new Error('hello6'); } }; // throw is sync
  const stringified6 = await asyncStringify(instance6);
  expect(stringified6.replace(/[\s\n]+/g, ' ')).toEqual(
- '{[Symbol("fast-check/asyncToStringMethod")]:() => { throw new Error("hello6"); }}',
+ '{[Symbol.for("fast-check/asyncToStringMethod")]:() => { throw new Error("hello6"); }}',
  ); // fallbacking to default
 
  class InProto {
@@ -583,7 +583,7 @@ describe('asyncStringify', () => {
  expect(await asyncStringify(instance7)).toEqual('hello7');
 
  const instance8 = { [asyncToStringMethod]: 1 }; // not callable
- expect(await asyncStringify(instance8)).toEqual('{[Symbol("fast-check/asyncToStringMethod")]:1}');
+ expect(await asyncStringify(instance8)).toEqual('{[Symbol.for("fast-check/asyncToStringMethod")]:1}');
 
  const instance9 = {
  [asyncToStringMethod]: async () => {