chore: Update a few places in the logging and error messages that had old names

TimothyJones · TimothyJones · commit eb65e32152a1 · 2025-03-05T02:00:29.000+11:00
diff --git a/packages/case-connector/src/connectors/grpc/contractDefinition.ts b/packages/case-connector/src/connectors/grpc/contractDefinition.ts
@@ -158,7 +158,7 @@ export const contractDefinition = (
         const runInteractionRequest = request.getRunInteraction();
         if (runInteractionRequest == null) {
           throw new ConnectorError(
-            'run example called with something that returned an undefined request',
+            'runInteraction called with something that returned an undefined request',
           );
         }
         if (definitionId === undefined) {
@@ -189,12 +189,12 @@ export const contractDefinition = (
           request.getRunRejectingInteraction();
         if (runRejectingInteractionRequest == null) {
           throw new ConnectorError(
-            'run rejecting example called with something that returned an undefined request',
+            'runRejectingInteraction called with something that returned an undefined request',
           );
         }
         if (definitionId === undefined) {
           throw new ConnectorError(
-            'runInteraction was called before begin definition',
+            'runRejectingInteraction was called before begin definition',
           );
         }
 
diff --git a/packages/case-connector/src/connectors/grpc/contractVerification.ts b/packages/case-connector/src/connectors/grpc/contractVerification.ts
@@ -203,7 +203,7 @@ export const contractVerification = (
           const runVerificationRequest = request.getRunVerification();
           if (runVerificationRequest == null) {
             throw new ConnectorError(
-              'run rejecting example called with something that returned an undefined request',
+              'runVerification called with something that returned an undefined request',
             );
           }
           if (verificationId === undefined) {
diff --git a/packages/case-core/src/core/ReadingCaseContract.ts b/packages/case-core/src/core/ReadingCaseContract.ts
@@ -77,7 +77,7 @@ export class ReadingCaseContract extends BaseCaseContract {
     this.currentContract.examples.forEach((example, index) => {
       if (example.result !== 'VERIFIED') {
         throw new CaseCoreError(
-          `Attempting to verify an example 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 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.`,
         );
       }
 
@@ -124,7 +124,7 @@ export class ReadingCaseContract extends BaseCaseContract {
           })
           .finally(() => {
             this.initialContext.logger.maintainerDebug(
-              `Example[${index}] completed: ${names.mockName}`,
+              `Interaction[${index}] completed: ${names.mockName}`,
             );
             exampleFinished();
           }),
@@ -173,12 +173,12 @@ export class ReadingCaseContract extends BaseCaseContract {
     );
     if (example.result === 'FAILED') {
       currentContext.logger.maintainerDebug(
-        `Example was a failure, marking verification failed (was '${this.status}')`,
+        `Interaction was a failure, marking verification failed (was '${this.status}')`,
       );
       this.status = 'FAILED';
     } else {
       currentContext.logger.maintainerDebug(
-        `Example was a success, no change to current status of '${this.status}'`,
+        `Interaction was a success, no change to current status of '${this.status}'`,
       );
     }
     return example;
diff --git a/packages/case-definition-dsl/api-extractor/case-definition-dsl.api.json b/packages/case-definition-dsl/api-extractor/case-definition-dsl.api.json
@@ -4844,7 +4844,7 @@
                     {
                       "kind": "PropertySignature",
                       "canonicalReference": "@contract-case/case-definition-dsl!mocks.base.ContractCaseCoreSetup#read:member",
-                      "docComment": "/**\n * Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type.\n */\n",
+                      "docComment": "/**\n * Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type.\n */\n",
                       "excerptTokens": [
                         {
                           "kind": "Content",
@@ -4872,7 +4872,7 @@
                     {
                       "kind": "PropertySignature",
                       "canonicalReference": "@contract-case/case-definition-dsl!mocks.base.ContractCaseCoreSetup#write:member",
-                      "docComment": "/**\n * Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type.\n */\n",
+                      "docComment": "/**\n * Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type.\n */\n",
                       "excerptTokens": [
                         {
                           "kind": "Content",
diff --git a/packages/case-definition-dsl/docs-json/java.json b/packages/case-definition-dsl/docs-json/java.json
@@ -183,7 +183,7 @@
               },
               "variadic": false,
               "docs": {
-                "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type."
+                "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type."
               }
             },
             {
@@ -205,7 +205,7 @@
               },
               "variadic": false,
               "docs": {
-                "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type."
+                "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type."
               }
             }
           ],
@@ -2913,7 +2913,7 @@
               ]
             },
             "docs": {
-              "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type."
+              "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type."
             },
             "usage": "public ContractCaseCoreBehaviour getRead();"
           },
@@ -2935,7 +2935,7 @@
               ]
             },
             "docs": {
-              "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type."
+              "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type."
             },
             "usage": "public ContractCaseCoreBehaviour getWrite();"
           }
diff --git a/packages/case-definition-dsl/docs-json/typescript.json b/packages/case-definition-dsl/docs-json/typescript.json
@@ -2749,7 +2749,7 @@
               ]
             },
             "docs": {
-              "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type."
+              "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type."
             },
             "usage": "public readonly read: ContractCaseCoreBehaviour;"
           },
@@ -2771,7 +2771,7 @@
               ]
             },
             "docs": {
-              "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type."
+              "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type."
             },
             "usage": "public readonly write: ContractCaseCoreBehaviour;"
           }
diff --git a/packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecoresetup.md b/packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecoresetup.md
@@ -43,7 +43,7 @@ Description
 
 </td><td>
 
-Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type.
+Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type.
 
 </td></tr>
 <tr><td>
@@ -60,7 +60,7 @@ Defines how the ContractCase core will behave when reading (ie, verifying) a Exa
 
 </td><td>
 
-Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type.
+Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type.
 
 </td></tr>
 </tbody></table>
diff --git a/packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecoresetup.read.md b/packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecoresetup.read.md
@@ -4,7 +4,7 @@
 
 ## mocks.base.ContractCaseCoreSetup.read property
 
-Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type.
+Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type.
 
 **Signature:**
 
diff --git a/packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecoresetup.write.md b/packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecoresetup.write.md
@@ -4,7 +4,7 @@
 
 ## mocks.base.ContractCaseCoreSetup.write property
 
-Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type.
+Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type.
 
 **Signature:**
 
diff --git a/packages/case-definition-dsl/src/interactions/base/AnyInteractionDescriptor.ts b/packages/case-definition-dsl/src/interactions/base/AnyInteractionDescriptor.ts
@@ -55,11 +55,11 @@ export interface ContractCaseCoreBehaviour {
  */
 export interface ContractCaseCoreSetup {
   /**
-   * Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type.
+   * Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type.
    */
   readonly write: ContractCaseCoreBehaviour;
   /**
-   * Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type.
+   * Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type.
    */
   readonly read: ContractCaseCoreBehaviour;
 }
diff --git a/packages/case-plugin-base/src/context/context.ts b/packages/case-plugin-base/src/context/context.ts
@@ -89,7 +89,7 @@ const combineWithRoot = (
     ...runConfig,
     '_case:currentRun:context:location': [
       ...context['_case:currentRun:context:location'],
-      `Example[${exampleId}]`,
+      `Interaction[${exampleId}]`,
     ],
   };
   exampleId += 1;

Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,7 @@ export const contractVerification = (`
`203`	`203`	`const runVerificationRequest = request.getRunVerification();`
`204`	`204`	`if (runVerificationRequest == null) {`
`205`	`205`	`throw new ConnectorError(`
`206`		`- 'run rejecting example called with something that returned an undefined request',`
	`206`	`+ 'runVerification called with something that returned an undefined request',`
`207`	`207`	`);`
`208`	`208`	`}`
`209`	`209`	`if (verificationId === undefined) {`
Original file line number	Diff line number	Diff line change
`@@ -4844,7 +4844,7 @@`
`4844`	`4844`	`{`
`4845`	`4845`	`"kind": "PropertySignature",`
`4846`	`4846`	`"canonicalReference": "@contract-case/case-definition-dsl!mocks.base.ContractCaseCoreSetup#read:member",`
`4847`		`- "docComment": "/*\n Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type.\n */\n",`
	`4847`	`+ "docComment": "/*\n Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type.\n */\n",`
`4848`	`4848`	`"excerptTokens": [`
`4849`	`4849`	`{`
`4850`	`4850`	`"kind": "Content",`
`@@ -4872,7 +4872,7 @@`
`4872`	`4872`	`{`
`4873`	`4873`	`"kind": "PropertySignature",`
`4874`	`4874`	`"canonicalReference": "@contract-case/case-definition-dsl!mocks.base.ContractCaseCoreSetup#write:member",`
`4875`		`- "docComment": "/*\n Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type.\n */\n",`
	`4875`	`+ "docComment": "/*\n Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type.\n */\n",`
`4876`	`4876`	`"excerptTokens": [`
`4877`	`4877`	`{`
`4878`	`4878`	`"kind": "Content",`
Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@`
`183`	`183`	`},`
`184`	`184`	`"variadic": false,`
`185`	`185`	`"docs": {`
`186`		`- "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type."`
	`186`	`+ "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type."`
`187`	`187`	`}`
`188`	`188`	`},`
`189`	`189`	`{`
`@@ -205,7 +205,7 @@`
`205`	`205`	`},`
`206`	`206`	`"variadic": false,`
`207`	`207`	`"docs": {`
`208`		`- "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type."`
	`208`	`+ "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type."`
`209`	`209`	`}`
`210`	`210`	`}`
`211`	`211`	`],`
`@@ -2913,7 +2913,7 @@`
`2913`	`2913`	`]`
`2914`	`2914`	`},`
`2915`	`2915`	`"docs": {`
`2916`		`- "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type."`
	`2916`	`+ "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type."`
`2917`	`2917`	`},`
`2918`	`2918`	`"usage": "public ContractCaseCoreBehaviour getRead();"`
`2919`	`2919`	`},`
`@@ -2935,7 +2935,7 @@`
`2935`	`2935`	`]`
`2936`	`2936`	`},`
`2937`	`2937`	`"docs": {`
`2938`		`- "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type."`
	`2938`	`+ "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type."`
`2939`	`2939`	`},`
`2940`	`2940`	`"usage": "public ContractCaseCoreBehaviour getWrite();"`
`2941`	`2941`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2749,7 +2749,7 @@`
`2749`	`2749`	`]`
`2750`	`2750`	`},`
`2751`	`2751`	`"docs": {`
`2752`		`- "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a Example of this type."`
	`2752`	`+ "summary": "Defines how the ContractCase core will behave when reading (ie, verifying) a interaction of this type."`
`2753`	`2753`	`},`
`2754`	`2754`	`"usage": "public readonly read: ContractCaseCoreBehaviour;"`
`2755`	`2755`	`},`
`@@ -2771,7 +2771,7 @@`
`2771`	`2771`	`]`
`2772`	`2772`	`},`
`2773`	`2773`	`"docs": {`
`2774`		`- "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an Example of this type."`
	`2774`	`+ "summary": "Defines how the ContractCase core will behave when writing (ie, defining) an interaction of this type."`
`2775`	`2775`	`},`
`2776`	`2776`	`"usage": "public readonly write: ContractCaseCoreBehaviour;"`
`2777`	`2777`	`}`