Merge pull request #1183 from pact-foundation/fix/update-message-pact…

…-matchers

chore: allow v3 matchers in message metadata

.github/workflows/build-and-test.yml

@@ -9,6 +9,7 @@ on:
 env:
   GIT_COMMIT: ${{ github.sha }}
   GIT_REF: ${{ github.ref }}
+  GIT_BRANCH: ${{ github.head_ref || github.ref_name }}
   LOG_LEVEL: info
 
 jobs:

examples/messages/consumer/message-consumer.spec.ts

@@ -35,7 +35,7 @@ describe('Message consumer tests', () => {
           }),
         })
         .withMetadata({
-          queue: 'animals',
+          queue: like('animals'),
         })
         .verify(synchronousBodyHandler(dogApiHandler));
     });
@@ -53,7 +53,7 @@ describe('Message consumer tests', () => {
           }),
         })
         .withMetadata({
-          queue: 'animals',
+          queue: like('animals'),
         })
         .verify(synchronousBodyHandler(dogApiHandler));
     });

package.json

@@ -95,7 +95,7 @@
     ]
   },
   "dependencies": {
-    "@pact-foundation/pact-core": "^14.1.1",
+    "@pact-foundation/pact-core": "^14.3.0",
     "@types/express": "^4.17.11",
     "axios": "^1.6.1",
     "body-parser": "^1.20.0",

scripts/ci/build-and-test.sh

@@ -11,7 +11,7 @@ npm ci --ignore-scripts
 npm run dist
 cp package.json ./dist
 
-export GIT_BRANCH=master
+export GIT_BRANCH=${GITHUB_HEAD_REF:-${GIT_REF#refs/heads/}}
 
 export PACT_BROKER_USERNAME="dXfltyFMgNOFZAxr8io9wJ37iUpY42M"
 export PACT_BROKER_PASSWORD="O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1"

src/dsl/matchers.ts

@@ -40,7 +40,7 @@ export interface ArrayMatcher<T> extends Matcher<T> {
   max?: number;
 }
 
-export function isMatcher(x: AnyTemplate): x is Matcher<AnyTemplate> {
+export function isMatcher(x: unknown): x is Matcher<AnyTemplate> {
   return x != null && (x as Matcher<AnyTemplate>).getValue !== undefined;
 }
 

src/dsl/message.ts

@@ -1,5 +1,6 @@
 import { AnyJson } from '../common/jsonTypes';
 import { Matcher } from './matchers';
+import { Matcher as MatcherV3 } from '../v3/matchers';
 
 /**
  * Metadata is a map containing message context,
@@ -8,7 +9,7 @@ import { Matcher } from './matchers';
  * @module Message
  */
 export interface Metadata {
-  [name: string]: string | Matcher<string>;
+  [name: string]: string | Matcher<string> | MatcherV3<string>;
 }
 
 /**

src/messageConsumerPact.ts

@@ -169,10 +169,7 @@ export class MessageConsumerPact {
     }
 
     forEachObjIndexed((v, k) => {
-      this.message.withMetadata(
-        `${k}`,
-        typeof v === 'string' ? v : v.getValue()
-      );
+      this.message.withMetadata(`${k}`, JSON.stringify(v));
     }, metadata);
 
     return this;

src/v4/message/index.ts

@@ -28,6 +28,7 @@ import {
   generateMockServerError,
 } from '../../v3/display';
 import logger from '../../common/logger';
+import { isMatcher as isV3Matcher } from '../../v3/matchers';
 
 const defaultPactDir = './pacts';
 
@@ -188,10 +189,7 @@ export class SynchronousMessageWithResponseBuilder
     }
 
     forEachObjIndexed((v, k) => {
-      this.interaction.withMetadata(
-        `${k}`,
-        typeof v === 'string' ? v : v.getValue()
-      );
+      this.interaction.withMetadata(`${k}`, JSON.stringify(v));
     }, metadata);
 
     return this;