generate pact contract on consumer side (nextjs)

Author: selimyanat

package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "@pact-foundation/pact": "13.2.0"
+  }
+}

webapp/__tests__/pact/pacts/NextJS-ShortenerApp-NestJS-ShortenerAPI.json

@@ -0,0 +1,55 @@
+{
+  "consumer": {
+    "name": "NextJS-ShortenerApp"
+  },
+  "interactions": [
+    {
+      "description": "a POST request to shorten a url",
+      "providerState": "provider can shorten urls",
+      "request": {
+        "body": {
+          "url": "https://example.com/page1/page2/page3"
+        },
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "matchingRules": {
+          "$.body.url": {
+            "match": "type"
+          }
+        },
+        "method": "POST",
+        "path": "/shorten-url"
+      },
+      "response": {
+        "body": {
+          "shortenedUrl": "http://localhost:1234/abc123"
+        },
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "matchingRules": {
+          "$.body.shortenedUrl": {
+            "match": "type"
+          }
+        },
+        "status": 200
+      }
+    }
+  ],
+  "metadata": {
+    "pact-js": {
+      "version": "13.2.0"
+    },
+    "pactRust": {
+      "ffi": "0.4.22",
+      "models": "1.2.3"
+    },
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  },
+  "provider": {
+    "name": "NestJS-ShortenerAPI"
+  }
+}

webapp/__tests__/pact/shorten-url-consumer.pact.test.ts

@@ -0,0 +1,66 @@
+import path from 'path';
+import { Pact, Matchers } from '@pact-foundation/pact';
+import fetch from 'node-fetch';
+
+const { like } = Matchers;
+
+const provider = new Pact({
+  consumer: 'NextJS-ShortenerApp',
+  provider: 'NestJS-ShortenerAPI',
+  port: 1234,
+  log: path.resolve(__dirname, '../pact/logs', 'pact.log'),
+  dir: path.resolve(__dirname, '../pact/pacts'),
+  logLevel: 'info',
+});
+
+describe('Pact with NestJS shorten-url provider', () => {
+  beforeAll(async () => await provider.setup());
+  afterAll(async () => await provider.finalize());
+  afterEach(async () => await provider.verify());
+
+  describe('POST /shorten-url', () => {
+    beforeEach(() => {
+      return provider.addInteraction({
+        state: 'provider can shorten urls',
+        uponReceiving: 'a POST request to shorten a url',
+        withRequest: {
+          method: 'POST',
+          path: '/shorten-url',
+          headers: {
+            'Content-Type': 'application/json',
+          },
+          body: {
+            url: like('https://example.com/page1/page2/page3'),
+          },
+        },
+        willRespondWith: {
+          status: 200,
+          headers: {
+            'Content-Type': 'application/json',
+          },
+          body: {
+            shortenedUrl: like('http://localhost:1234/abc123'),
+          },
+        },
+      });
+    });
+
+    it('sends POST /shorten-url and receives shortened URL', async () => {
+      const baseUrl = provider.mockService.baseUrl;
+      const response = await fetch(`${baseUrl}/shorten-url`, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({ url: 'https://example.com/page1/page2/page3' }),
+      });
+
+      const body = await response.json();
+
+      expect(response.status).toBe(200);
+      expect(body).toEqual({
+        shortenedUrl: 'http://localhost:1234/abc123',
+      });
+    });
+  });
+});

webapp/package.json

@@ -26,6 +26,7 @@
     "@testing-library/react": "14.1.2",
     "@types/jest": "29.5.11",
     "@types/node": "20",
+    "@types/node-fetch": "2",
     "@types/react": "19",
     "@types/react-dom": "19",
     "@typescript-eslint/eslint-plugin": "8.18.0",
@@ -37,6 +38,7 @@
     "eslint-plugin-react": "7.37.2",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
+    "node-fetch": "2",
     "prettier": "3.4.2",
     "ts-jest": "29.2.5",
     "ts-node": "10.9.2",

webapp/yarn.lock

@@ -1231,6 +1231,14 @@
   resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee"
   integrity sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==
 
+"@types/node-fetch@2":
+  version "2.6.12"
+  resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.6.12.tgz#8ab5c3ef8330f13100a7479e2cd56d3386830a03"
+  integrity sha512-8nneRWKCg3rMtF69nLQJnOYUcbafYeFSjqkw3jCRLsqkWFlHaoQrr5mXmofFGOx3DKn7UfmBMyov8ySvLRVldA==
+  dependencies:
+    "@types/node" "*"
+    form-data "^4.0.0"
+
 "@types/node@*":
   version "22.10.2"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-22.10.2.tgz#a485426e6d1fdafc7b0d4c7b24e2c78182ddabb9"
@@ -4024,6 +4032,13 @@ [email protected]:
     "@next/swc-win32-x64-msvc" "15.1.0"
     sharp "^0.33.5"
 
+node-fetch@2:
+  version "2.7.0"
+  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.7.0.tgz#d0f0fa6e3e2dc1d27efcd8ad99d550bda94d187d"
+  integrity sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==
+  dependencies:
+    whatwg-url "^5.0.0"
+
 node-int64@^0.4.0:
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b"
@@ -4925,6 +4940,11 @@ tr46@^3.0.0:
   dependencies:
     punycode "^2.1.1"
 
+tr46@~0.0.3:
+  version "0.0.3"
+  resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a"
+  integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==
+
 ts-api-utils@^1.3.0:
   version "1.4.3"
   resolved "https://registry.yarnpkg.com/ts-api-utils/-/ts-api-utils-1.4.3.tgz#bfc2215fe6528fecab2b0fba570a2e8a4263b064"
@@ -5122,6 +5142,11 @@ walker@^1.0.8:
   dependencies:
     makeerror "1.0.12"
 
+webidl-conversions@^3.0.0:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871"
+  integrity sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==
+
 webidl-conversions@^7.0.0:
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-7.0.0.tgz#256b4e1882be7debbf01d05f0aa2039778ea080a"
@@ -5147,6 +5172,14 @@ whatwg-url@^11.0.0:
     tr46 "^3.0.0"
     webidl-conversions "^7.0.0"
 
+whatwg-url@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-5.0.0.tgz#966454e8765462e37644d3626f6742ce8b70965d"
+  integrity sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==
+  dependencies:
+    tr46 "~0.0.3"
+    webidl-conversions "^3.0.0"
+
 which-boxed-primitive@^1.0.2, which-boxed-primitive@^1.1.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/which-boxed-primitive/-/which-boxed-primitive-1.1.0.tgz#2d850d6c4ac37b95441a67890e19f3fda8b6c6d9"