@pact-foundation/pact 10.2.2 → 10.3.1

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [10.3.1](https://github.com/pact-foundation/pact-js/compare/v10.3.0...v10.3.1) (2022-11-30)
+
+
+### Fixes and Improvements
+
+* PactV4 feature flag check was causing import errors for all imports ([8897da7](https://github.com/pact-foundation/pact-js/commit/8897da76bdf145f0d3ffb53f7fca14cde2f659a9))
+
+## [10.3.0](https://github.com/pact-foundation/pact-js/compare/v10.2.2...v10.3.0) (2022-11-29)
+
+
+### Features
+
+* expose V4 public interface ([047b61d](https://github.com/pact-foundation/pact-js/commit/047b61d79227ce19629140b90fa2e02edc201f66))
+
+
+### Fixes and Improvements
+
+* add --detectOpenHandles to provider state tests ([9f14582](https://github.com/pact-foundation/pact-js/commit/9f145825829950da23af36f54e5a353d53fd3762))
+* update to latest pact-core 13.12.2 ([e54aa7a](https://github.com/pact-foundation/pact-js/commit/e54aa7ae421e1651c982cada82a7602f7920317a))
+
 ### [10.2.2](https://github.com/pact-foundation/pact-js/compare/v10.2.1...v10.2.2) (2022-11-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pact-foundation/pact",
-  "version": "10.2.2",
+  "version": "10.3.1",
   "description": "Pact for all things Javascript",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -17,7 +17,8 @@
     "postdist": "npm test",
     "predist": "npm run clean && npm run format:check && npm run lint",
     "release": "standard-version",
-    "test": "nyc --check-coverage --reporter=html --reporter=text-summary mocha -t 120000"
+    "test": "nyc --check-coverage --reporter=html --reporter=text-summary mocha -t 120000",
+    "pretest": "bash scripts/install-plugins.sh"
   },
   "repository": {
     "type": "git",
@@ -94,7 +95,7 @@
     ]
   },
   "dependencies": {
-    "@pact-foundation/pact-core": "^13.12.0",
+    "@pact-foundation/pact-core": "^13.12.2",
     "@types/bluebird": "^3.5.20",
     "@types/express": "^4.17.11",
     "axios": "^0.27.2",
@@ -132,7 +133,7 @@
     "@types/mocha": "^8.0.4",
     "@types/mockery": "^1.4.29",
     "@types/nock": "^9.1.2",
-    "@types/node": "^8.0.24",
+    "@types/node": "^18.11.9",
     "@types/ramda": "^0.26.43",
     "@types/sinon": "^7.0.6",
     "@types/sinon-chai": "^2.7.29",

package/scripts/ci/build-and-test.ps1

@@ -0,0 +1,64 @@
+npm ci
+npm run dist
+npm run build:v3
+Copy-Item "package.json" -Destination "dist"
+Copy-Item "package-lock.json" -Destination "dist"
+Copy-Item -Path "native" -Destination "dist" -Recurse
+pushd dist
+npm link
+popd
+
+Push-Location dist
+npm link
+Pop-Location
+
+Get-ChildItem ".\examples" -Directory | ForEach-Object {
+  if ($_.Name -ne "v3") {
+    Write-Output "Running examples in $($_.Name)"
+    pushd $_.FullName
+    npm i
+    npm link @pact-foundation/pact
+    npm t
+    if ($LastExitCode -ne 0) {
+      Write-Output "Non-zero exit code!"
+      $host.SetShouldExit($LastExitCode)
+    }
+    popd
+  }
+}
+
+Write-Output "Done with V2 tests"
+
+Get-ChildItem ".\examples\v3" -Directory | ForEach-Object {
+  Write-Output "Running V3 examples in $($_.Name)"
+  pushd $_.FullName
+  npm i
+  Remove-Item -LiteralPath "node_modules\@pact-foundation\pact" -Force -Recurse
+
+  npm link @pact-foundation/pact
+  npm t
+  if ($LastExitCode -ne 0) {
+    Write-Output "Non-zero exit code!"
+    $host.SetShouldExit($LastExitCode)
+  }
+  popd
+}
+
+Write-Output "Done with V3 tests"
+
+Get-ChildItem ".\examples\v4" -Directory | ForEach-Object {
+  Write-Output "Running V4 examples in $($_.Name)"
+  pushd $_.FullName
+  npm i
+  Remove-Item -LiteralPath "node_modules\@pact-foundation\pact" -Force -Recurse
+
+  npm link @pact-foundation/pact
+  npm t
+  if ($LastExitCode -ne 0) {
+    Write-Output "Non-zero exit code!"
+    $host.SetShouldExit($LastExitCode)
+  }
+  popd
+}
+
+Write-Output "Done with V4 tests"

package/scripts/ci/build-and-test.sh

@@ -0,0 +1,29 @@
+#!/bin/bash -eu
+set -e
+set -u
+set -x
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/lib/robust-bash.sh
+
+require_env_var GIT_REF
+
+npm ci
+
+npm run dist
+cp package.json ./dist
+
+export GIT_BRANCH=${GITHUB_HEAD_REF:-${GIT_REF#refs/heads/}}
+
+export PACT_BROKER_USERNAME="dXfltyFMgNOFZAxr8io9wJ37iUpY42M"
+export PACT_BROKER_PASSWORD="O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1"
+
+"${SCRIPT_DIR}"/lib/prepare-release.sh
+
+cp package-lock.json dist
+cp -r scripts dist
+echo "This will be version '$(npx absolute-version)'"
+
+# Link the build so that the examples are always testing the
+# current build, in it's properly exported format
+(cd dist && npm ci)

package/scripts/ci/lib/create_npmrc_file.sh

@@ -0,0 +1,16 @@
+#!/bin/bash -e
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/robust-bash.sh
+
+require_env_var NODE_AUTH_TOKEN
+
+set +x #Don't echo the NPM key
+
+NPMRC_FILE=.npmrc
+echo  "@pact-foundation:registry=https://registry.npmjs.org/" > $NPMRC_FILE
+echo "//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}" >> $NPMRC_FILE
+echo "//registry.npmjs.org/:username=pact-foundation" >> $NPMRC_FILE
+echo "//registry.npmjs.org/:email=pact-foundation@googlegroups.com" >> $NPMRC_FILE
+echo "//registry.npmjs.org/:always-auth=true" >> $NPMRC_FILE
+
+set -x

package/scripts/ci/lib/get-version.sh

@@ -0,0 +1,8 @@
+#!/bin/bash -eu
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/robust-bash.sh
+
+require_binary grep
+
+VERSION="$(grep '\"version\"' package.json | grep -E -o "([0-9\.]+(-[a-z\.0-9]+)?)")"
+echo "$VERSION"

package/scripts/ci/lib/prepare-release.sh

@@ -0,0 +1,19 @@
+#!/bin/bash -eu
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/robust-bash.sh
+
+require_binary grep
+require_binary sed
+require_binary find
+
+VERSION="$("$SCRIPT_DIR/get-version.sh")"
+
+echo "--> Preparing release version ${VERSION}"
+
+echo "--> Copy key artifacts into pact distribution"
+artifacts=(LICENSE *md package.json)
+
+for artifact in "${artifacts[@]}"; do
+  echo "    Copying ${artifact} => ./dist/${artifact}"
+  cp "${artifact}" "./dist/${artifact}"
+done

package/scripts/ci/lib/publish-9x.sh

@@ -0,0 +1,18 @@
+#!/bin/bash -eu
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/robust-bash.sh
+
+require_binary npm
+
+"${SCRIPT_DIR}"/prepare-release.sh
+VERSION="$("$SCRIPT_DIR/get-version.sh")"
+
+echo "--> Preparing npmrc file"
+"$SCRIPT_DIR"/create_npmrc_file.sh
+
+echo "--> Releasing version ${VERSION}"
+
+echo "--> Releasing artifacts"
+echo "    Publishing pact@${VERSION}..."
+npm publish dist --access public
+echo "    done!"

package/scripts/ci/lib/publish.sh

@@ -0,0 +1,17 @@
+#!/bin/bash -eu
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/robust-bash.sh
+
+require_binary npm
+
+"${SCRIPT_DIR}"/prepare-release.sh
+VERSION="$("$SCRIPT_DIR/get-version.sh")"
+
+echo "--> Preparing npmrc file"
+"$SCRIPT_DIR"/create_npmrc_file.sh
+
+echo "--> Releasing version ${VERSION}"
+echo "--> Releasing artifacts"
+echo "    Publishing pact@${VERSION}..."
+npm publish ./dist --access public --tag latest
+echo "    done!"

package/scripts/ci/lib/robust-bash.sh

@@ -0,0 +1,36 @@
+#!/bin/bash -eu
+if [ -z "${LIB_ROBUST_BASH_SH:-}" ]; then
+  LIB_ROBUST_BASH_SH=included
+  
+  function error {
+    echo "❌  ${1:-}"
+  }
+
+  function log {
+    echo "🔵  ${1:-}"
+  }
+
+  # Check to see that we have a required binary on the path
+  function require_binary {
+    if [ -z "${1:-}" ]; then
+      error "${FUNCNAME[0]} requires an argument"
+      exit 1
+    fi
+
+    if ! [ -x "$(command -v "$1")" ]; then
+      error "The required executable '$1' is not on the path."
+      exit 1
+    fi
+  }
+
+  function require_env_var {
+    var_name="${1:-}"
+    if [ -z "${!var_name:-}" ]; then
+      error "The required environment variable ${var_name} is empty"
+      if [ ! -z "${2:-}" ]; then
+        echo "  - $2"
+      fi
+      exit 1
+    fi
+  }
+fi

package/scripts/ci/release-9x.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+set -e
+set -u
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/lib/robust-bash.sh
+
+require_env_var CI "This script must be run from CI. If you are running locally, note that it stamps your repo git settings."
+require_env_var GITHUB_ACTOR
+require_env_var NODE_AUTH_TOKEN
+
+# Setup git for github actions
+git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+git config user.name "${GITHUB_ACTOR}"
+
+# It's easier to read the release notes 
+# from the standard version tool before it runs
+RELEASE_NOTES="$(npx standard-version --dry-run | awk 'BEGIN { flag=0 } /^---$/ { if (flag == 0) { flag=1 } else { flag=2 }; next } flag == 1')"
+# Don't release if there are no changes
+if [ "$(echo "$RELEASE_NOTES" | wc -l)" -eq 1 ] ; then
+    echo "ERROR: This release would have no release notes. Does it include changes?"
+    echo "   - You must have at least one fix / feat commit to generate release notes"
+    echo "*** STOPPING RELEASE PROCESS ***"
+    exit 1
+fi
+# This is github actions' method for emitting multi-line values
+RELEASE_NOTES="${RELEASE_NOTES//'%'/'%25'}"
+RELEASE_NOTES="${RELEASE_NOTES//$'\n'/'%0A'}"
+RELEASE_NOTES="${RELEASE_NOTES//$'\r'/'%0D'}"
+echo "::set-output name=notes::$RELEASE_NOTES"
+
+npm ci
+"$SCRIPT_DIR"/build-and-test.sh
+npm run release
+
+# Emit version to next step
+VERSION="$("$SCRIPT_DIR/lib/get-version.sh")"
+echo "::set-output name=version::$VERSION"
+
+"$SCRIPT_DIR"/lib/publish-9x.sh
+
+# Push the new commit back to the repo.
+git push --follow-tags

package/scripts/ci/release.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+set -e
+set -u
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd)" # Figure out where the script is running
+. "$SCRIPT_DIR"/lib/robust-bash.sh
+
+require_env_var CI "This script must be run from CI. If you are running locally, note that it stamps your repo git settings."
+require_env_var GITHUB_ACTOR
+require_env_var NODE_AUTH_TOKEN
+
+# Setup git for github actions
+git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+git config user.name "${GITHUB_ACTOR}"
+
+# It's easier to read the release notes
+# from the standard version tool before it runs
+RELEASE_NOTES="$(npx standard-version --dry-run | awk 'BEGIN { flag=0 } /^---$/ { if (flag == 0) { flag=1 } else { flag=2 }; next } flag == 1')"
+# Don't release if there are no changes
+if [ "$(echo "$RELEASE_NOTES" | wc -l)" -eq 1 ] ; then
+    echo "ERROR: This release would have no release notes. Does it include changes?"
+    echo "   - You must have at least one fix / feat commit to generate release notes"
+    echo "*** STOPPING RELEASE PROCESS ***"
+    exit 1
+fi
+# This is github actions' method for emitting multi-line values
+RELEASE_NOTES="${RELEASE_NOTES//'%'/'%25'}"
+RELEASE_NOTES="${RELEASE_NOTES//$'\n'/'%0A'}"
+RELEASE_NOTES="${RELEASE_NOTES//$'\r'/'%0D'}"
+echo "::set-output name=notes::$RELEASE_NOTES"
+
+npm ci
+"$SCRIPT_DIR"/build-and-test.sh
+
+npm run release
+
+# Emit version to next step
+VERSION="$("$SCRIPT_DIR/lib/get-version.sh")"
+echo "::set-output name=version::$VERSION"
+
+"$SCRIPT_DIR"/lib/publish.sh
+
+# Push the new commit back to the repo.
+git push --follow-tags

package/scripts/deploy.ps1

@@ -0,0 +1,12 @@
+Set-PSDebug -Trace 1
+dir env:
+
+if ($env:APPVEYOR_REPO_TAG -eq "true") {
+  Write-Output "Running deploy (APPVEYOR_REPO_TAG) is $env:APPVEYOR_REPO_TAG"
+  npm install node-pre-gyp node-pre-gyp-github
+  npm run build:v3
+  Remove-Item 'native\target' -Recurse -Force
+  npm run upload-binary
+} else {
+  Write-Output "Skipping deploy (APPVEYOR_REPO_TAG) is $env:APPVEYOR_REPO_TAG"
+}

package/scripts/install-plugins.sh

@@ -0,0 +1,49 @@
+#!/bin/bash -e
+#
+# Usage:
+#   $ curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-plugins/master/install-cli.sh | bash
+# or
+#   $ wget -q https://raw.githubusercontent.com/pact-foundation/pact-plugins/master/install-cli.sh -O- | bash
+#
+
+function detect_osarch() {
+    case $(uname -sm) in
+        'Linux x86_64')
+            os='linux'
+            arch='x86_64'
+            ;;
+        'Darwin x86' | 'Darwin x86_64')
+            os='osx'
+            arch='x86_64'
+            ;;
+        'Darwin arm64')
+            os='osx'
+            arch='aarch64'
+            ;;
+        CYGWIN*|MINGW32*|MSYS*|MINGW*)
+            os="windows"
+            arch='x86_64'
+            ext='.exe'
+            ;;
+        *)
+        echo "Sorry, you'll need to install the plugin CLI manually."
+        exit 1
+            ;;
+    esac
+}
+
+VERSION=$(curl -s https://api.github.com/repos/pact-foundation/pact-plugins/releases | grep pact-plugin-cli | grep tag_name | head -n1 | egrep -o "[0-9\.]+")
+detect_osarch
+
+if [ ! -f ~/.pact/bin/pact-plugin-cli ]; then
+    echo "--- 🐿  Installing plugins CLI version ${VERSION}"
+    mkdir -p ~/.pact/bin
+    curl -L -o ~/.pact/bin/pact-plugin-cli-${os}-${arch}.gz https://github.com/pact-foundation/pact-plugins/releases/download/pact-plugin-cli-v${VERSION}/pact-plugin-cli-${os}-${arch}${ext}.gz
+    gunzip -N -f ~/.pact/bin/pact-plugin-cli-${os}-${arch}.gz
+    chmod +x ~/.pact/bin/pact-plugin-cli
+fi
+
+if [ ! -d ~/.pact/plugins/matt-0.0.3 ]; then
+    echo "--- 🐿  Installing MATT plugin"
+  ~/.pact/bin/pact-plugin-cli -y -d install https://github.com/mefellows/pact-matt-plugin/releases/tag/v0.0.4
+fi

package/scripts/run-audit-fix-on-examples.sh

@@ -0,0 +1,13 @@
+#!/bin/bash -eu
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+for i in examples/*; do
+  [ -e "$i" ] || continue # prevent failure if there are no examples
+  echo "--> running npm audit fix on: $i"
+  if [ -z "${1:-}" ]; then
+    (cd "$i" && npm i && npm audit fix)
+  else 
+    (cd "$i" && npm i && npm audit fix "$1")
+  fi
+done

package/scripts/trigger-9x-release.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# Script to trigger release of the repository
+# Requires a Github API token with repo scope stored in the
+# environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES
+# Borrowed from Beth Skurrie's excellent script at
+# https://github.com/pact-foundation/pact-ruby/blob/master/script/trigger-release.sh
+
+: "${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES:?Please set environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}"
+
+repository_slug=$(git remote get-url $(git remote show) | cut -d':' -f2 | sed 's/\.git//' | sed 's://::' | sed 's:github.com/::')
+
+output=$(curl -v -X POST https://api.github.com/repos/${repository_slug}/dispatches \
+      -H 'Accept: application/vnd.github.everest-preview+json' \
+      -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
+      -d "{\"event_type\": \"release-9x-triggered\"}" 2>&1)
+
+if  ! echo "${output}" | grep "HTTP\/2 204" > /dev/null; then
+  echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
+  echo "Failed to trigger release"
+  exit 1
+else
+  echo "9.x.x Release workflow triggered"
+fi

package/scripts/trigger-release.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# Script to trigger release of the repository
+# Requires a Github API token with repo scope stored in the
+# environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES
+# Borrowed from Beth Skurrie's excellent script at
+# https://github.com/pact-foundation/pact-ruby/blob/master/script/trigger-release.sh
+
+: "${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES:?Please set environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}"
+
+repository_slug=$(git remote get-url $(git remote show) | cut -d':' -f2 | sed 's/\.git//' | sed 's://::' | sed 's:github.com/::')
+
+output=$(curl -v -X POST https://api.github.com/repos/${repository_slug}/dispatches \
+      -H 'Accept: application/vnd.github.everest-preview+json' \
+      -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
+      -d "{\"event_type\": \"release-triggered\"}" 2>&1)
+
+if  ! echo "${output}" | grep "HTTP\/2 204" > /dev/null; then
+  echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
+  echo "Failed to trigger release"
+  exit 1
+else
+  echo "10.x.x release workflow triggered"
+fi

package/src/asynchronousMessagePact.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @module Message
+ */
+/// <reference types="node" />
+import { AnyJson } from './common/jsonTypes';
+import { AnyTemplate } from './dsl/matchers';
+import { Metadata, Message, MessageConsumer, ProviderState } from './dsl/message';
+import { MessageConsumerOptions } from './dsl/options';
+/**
+ * A Message Consumer is analagous to a Provider in the HTTP Interaction model.
+ * It is the receiver of an interaction, and needs to be able to handle whatever
+ * request was provided.
+ */
+export declare class AsynchronousMessagePact {
+    private config;
+    private state;
+    private pact;
+    private message;
+    constructor(config: MessageConsumerOptions);
+    /**
+     * Gives a state the provider should be in for this Message.
+     *
+     * @param {string} state - The state of the provider.
+     * @returns {Message} MessageConsumer
+     */
+    given(state: string | ProviderState): MessageConsumerPact;
+    /**
+     * A free style description of the Message.
+     *
+     * @param {string} description - A description of the Message to be received
+     * @returns {Message} MessageConsumer
+     */
+    expectsToReceive(description: string): MessageConsumerPact;
+    /**
+     * The JSON object to be received by the message consumer.
+     *
+     * May be a JSON object or JSON primitive. The contents must be able to be properly
+     * stringified and parse (i.e. via JSON.stringify and JSON.parse).
+     *
+     * @param {string} content - A description of the Message to be received
+     * @returns {Message} MessageConsumer
+     */
+    withContent(content: AnyTemplate): MessageConsumerPact;
+    /**
+     * The text content to be received by the message consumer.
+     *
+     * May be any text
+     *
+     * @param {string} content - A description of the Message to be received
+     * @returns {Message} MessageConsumer
+     */
+    withTextContent(content: string, contentType: string): MessageConsumerPact;
+    /**
+     * The binary content to be received by the message consumer.
+     *
+     * Content will be stored in base64 in the resulting pact file.
+     *
+     * @param {Buffer} content - A buffer containing the binary content
+     * @param {String} contenttype - The mime type of the content to expect
+     * @returns {Message} MessageConsumer
+     */
+    withBinaryContent(content: Buffer, contentType: string): MessageConsumerPact;
+    /**
+     * Message metadata.
+     *
+     * @param {string} metadata -
+     * @returns {Message} MessageConsumer
+     */
+    withMetadata(metadata: Metadata): MessageConsumerPact;
+    /**
+     * Creates a new Pact _message_ interaction to build a testable interaction.
+     *
+     * @param handler A message handler, that must be able to consume the given Message
+     * @returns {Promise}
+     */
+    verify(handler: MessageConsumer): Promise<unknown>;
+    private reifiedContent;
+    /**
+     * Returns the Message object created.
+     *
+     * @returns {Message}
+     */
+    json(): Message;
+}
+declare type MessageConsumerPact = AsynchronousMessagePact;
+export declare function synchronousBodyHandler<R>(handler: (body: AnyJson | Buffer) => R): MessageConsumer;
+export declare function asynchronousBodyHandler<R>(handler: (body: AnyJson | Buffer) => Promise<R>): MessageConsumer;
+export {};