feat(core): Now contract verification is guaranteed to run contracts in order, instead of interleaving interactions

Author: TimothyJones

packages/case-core/src/connectors/contract/ContractVerifierConnector.ts

@@ -181,32 +181,44 @@ export class ContractVerifierConnector {
 
     if (contractsToVerify.length > 1) {
       this.context.logger.debug(
-        '*** Multiple contracts are being verified ***',
-      );
-      this.context.logger.debug(
-        'Note that the following debug log may contain interactions from any contract in any order',
+        `*** There are ${contractsToVerify.length} contracts are being verified ***`,
       );
+      this.context.logger.debug(`Take note of the contract number in the log`);
     }
-    const results = contractsToVerify.map((contractLink, index) => {
-      this.context.logger.debug(
-        `Verifying contract from file '${contractLink.filePath}'`,
-      );
-      const contractVerifier = new ReadingCaseContract(
-        contractLink.contents,
-        this.dependencies,
-        {
-          ...mergedConfig,
-          coreLogContextPrefix:
-            contractsToVerify.length > 1 ? `Contract[${index}]` : '',
-        },
-        this.parentVersions,
-        this.mutex,
-      );
-      Object.entries(invokeableFns).forEach(([key, value]) => {
-        contractVerifier.registerFunction(key, value);
-      });
-      return contractVerifier.verifyContract(invoker, this.callback);
-    });
+    const results = contractsToVerify.map((contractLink, index) =>
+      this.mutex.runExclusive(() => {
+        if (!contractLink?.contents?.description?.consumerName) {
+          this.context.logger.error(
+            `Contract in file '${contractLink.filePath}' appears to have no consumer name! It might not be a case contract`,
+          );
+        }
+
+        if (!contractLink?.contents?.description?.providerName) {
+          this.context.logger.error(
+            `Contract in file '${contractLink.filePath}' appears to have no provider name! It might not be a case contract`,
+          );
+        }
+
+        this.context.logger.debug(
+          `*** Verifying contract: '${contractLink.contents.description.consumerName}' -> '${contractLink.contents.description.consumerName}'`,
+        );
+        this.context.logger.debug(`Contract File: ${contractLink.filePath}`);
+        const contractVerifier = new ReadingCaseContract(
+          contractLink.contents,
+          this.dependencies,
+          {
+            ...mergedConfig,
+            coreLogContextPrefix:
+              contractsToVerify.length > 1 ? `Contract[${index}]` : '',
+          },
+          this.parentVersions,
+        );
+        Object.entries(invokeableFns).forEach(([key, value]) => {
+          contractVerifier.registerFunction(key, value);
+        });
+        return contractVerifier.verifyContract(invoker, this.callback);
+      }),
+    );
     if (mergedConfig.internals.asyncVerification) {
       this.context.logger.maintainerDebug(`Awaiting async verification`);
       return Promise.all(results).then(

packages/case-core/src/core/ReadingCaseContract.ts

@@ -51,7 +51,6 @@ export class ReadingCaseContract extends BaseCaseContract {
     }: ReaderDependencies,
     config: CaseConfig,
     parentVersions: string[],
-    mutex: Mutex,
   ) {
     super(
       contractFile.description,
@@ -65,7 +64,7 @@ export class ReadingCaseContract extends BaseCaseContract {
     this.makeBrokerService = makeBrokerService;
     this.links = contractFile;
     this.status = 'UNKNOWN';
-    this.mutex = mutex;
+    this.mutex = new Mutex();
   }
 
   /**
@@ -83,15 +82,18 @@ export class ReadingCaseContract extends BaseCaseContract {
     runTestCb: RunTestCallback,
   ): Promise<void> | undefined {
     this.initialContext.logger.maintainerDebug(
-      `Verifying contract between '${this.currentContract.description.consumerName}' and '${this.currentContract.description.providerName}'. There are '${this.currentContract.examples.length}' examples`,
+      `Verifying contract: '${this.currentContract.description.consumerName}' -> '${this.currentContract.description.providerName}'`,
+    );
+    this.initialContext.logger.maintainerDebug(
+      `This contract has ${this.currentContract.examples.length} interactions`,
     );
     const interactionFinishedIndicators: Promise<unknown>[] = [];
     const interactionFinishers: Array<() => void> = [];
 
     this.currentContract.examples.forEach((example, index) => {
       if (example.result !== 'VERIFIED') {
         throw new CaseCoreError(
-          `Attempting to verify an interaction which was '${example.result}'. This should never happen in normal operation, and might be the result of a corrupted ContractCase file, a file that was not written by ContractCase, or a bug.`,
+          `Attempting to verify an interaction which didn't pass the consumer test ('${example.result}'). This should never happen in normal operation, and might be the result of a corrupted ContractCase file, a file that was not written by ContractCase, or a bug.`,
         );
       }
 

packages/case-core/src/index.http.request.verification.misconfigured.spec.ts

@@ -1,7 +1,6 @@
 import type * as http from 'node:http';
 
 import { CaseConfigurationError } from '@contract-case/case-plugin-base';
-import { Mutex } from 'async-mutex';
 import type { RunTestCallback } from './core/executeExample/types';
 import type { StateHandlers } from './entities/states/types';
 
@@ -46,7 +45,6 @@ describe('Server verification', () => {
       publish: false,
     },
     ['tests'],
-    new Mutex(),
   );
   beforeAll(async () => {
     server = await start(port, serverDependencies);