refactor: improved integration test suite (#560)

* feat(integration): add POST method test

Right now the hapi/fastify examples are not working properly for accepting
an incoming POST body. This adds a test to expose that flaw, but does not
yet fix it.

I think this refactor makes the most sense to finish once
#459 is merged in.

* fix(php): update postData to push into text instead of params[]

* fix: rewriting how we retrieve data out of the request

* feat: adding a heap of new unit tests to the metrics integration suite

* fix: the node SDK not capturing text/plain and +json payloads

* fix: node sdk not capturing `application/x-www-url-formencoded` payloads

* fix: optionally skipping multipart tests for sdks that dont support it

* fix: stop setting postData if there's none to set

* fix: adding missing env vars

* fix(python): adding query strings to urls, dont add postData if empty

* fix(python): handling of `x-www-form-urlencoded` requests

* fix: don't crash in node or php if a json payload is corrupted

* fix: python code standards issues

* fix: replaying test improvemnts i made

* fix: moving the webhook test over to using the node protocol

* fix: removing dead code

* fix: regenerating the package lockfile

* fix: broken tests

* fix: compatibility issues with fastify and hapi

* feat: fleshing out some useful makefiles

* feat: more makefiles

* fix: no longer setting an empty `text` property on urlencoded requests

* feat: makefile targets for the .net sdk

* fix: problem where dotnet request.url didn't contain querystrings

* fix: problem where .net would send nullish postData on get requests

* fix: broken php tests

* fix: downgrading the python ci tests in docker to use node 16

* ci: docker python debugging

* fix: remove uneeded python docker workarounds for node 18

* fix(integration): exit early from tests if child process didn't start

* bug: attempt to fix python ci (#565)

* Revert "fix: remove uneeded python docker workarounds for node 18"

This reverts commit 0c9df96.

* Revert "ci: docker python debugging"

This reverts commit 067f95f.

* Revert "fix: downgrading the python ci tests in docker to use node 16"

This reverts commit af5c110.

* fix(python/integration): bump timeout of HTTPConnectionPool

I think we were hitting this timeout sometimes from within the container
This makes it pass locally at least, lets see if this works on gh

* fix(integration): disable undici on flask integration tests

* fix: try to use mocha instead of jest

* fix: add commented out experimental fetch disabling

* fix: getting tests in mocha working

* fix: re-disabling undici in node 18

* ci: attempts to get python working in docker always

* ci: disabling python flask integration in ci for now

Co-authored-by: Jon Ursenbach <[email protected]>

Co-authored-by: Dom Harrington <[email protected]>
Co-authored-by: Dom Harrington <[email protected]>

Author: erunion

.eslintrc

@@ -1,5 +1,6 @@
 {
-  "extends": [
-    "@readme/eslint-config"
-  ]
+  "extends": "@readme/eslint-config",
+  "rules": {
+    "unicorn/prefer-node-protocol": "error"
+  }
 }

.github/workflows/python.yml

@@ -40,7 +40,9 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - run: docker-compose run integration_metrics_python_flask
+    # This Flask suite is **extremely** flaky in Docker. Until we can figure out how to make it not
+    # you can run this locally with `make test-python-metrics-flask`.
+    # - run: docker-compose run integration_metrics_python_flask
     - run: docker-compose run integration_webhooks_python_flask
 
     - name: Cleanup

.vscode/settings.json

@@ -5,6 +5,7 @@
     "**/composer.lock": true,
     "packages/php/examples/laravel/bootstrap/cache/*.php": true,
     "packages/php/examples/laravel/storage/**": true,
+    "packages/python/build/**": true,
 
     // Hide test coverage directories
     "**/coverage": true,

Makefile

@@ -0,0 +1,34 @@
+.PHONY: help
+
+test-dotnet-metrics: ## Run metrics tests against the .NET SDK
+	EXAMPLE_SERVER="dotnet examples/net6.0/out/net6.0.dll" npm run test:integration-metrics
+
+test-dotnet-webhooks: ## Run webhooks tests against the .NET SDK
+	EXAMPLE_SERVER="dotnet examples/net6.0-webhook/out/net6.0-webhook.dll" npm run test:integration-webhooks
+
+test-node-metrics-express: ## Run metrics tests against the Node SDK + Express
+	EXAMPLE_SERVER="node ./packages/node/examples/express/index.js" npm run test:integration-metrics
+
+test-node-webhooks-express: ## Run webhooks tests against the Node SDK + Express
+	EXAMPLE_SERVER="node ./packages/node/examples/express/webhook.js" npm run test:integration-webhooks
+
+test-node-metrics-fastify: ## Run metrics tests against the Node SDK + Fastify
+	EXAMPLE_SERVER="node ./packages/node/examples/fastify/index.js" npm run test:integration-metrics
+
+test-node-metrics-hapi: ## Run metrics tests against the Node SDK + hapi
+	EXAMPLE_SERVER="node ./packages/node/examples/hapi/index.js" npm run test:integration-metrics
+
+test-php-metrics-laravel: ## Run metrics tests against the PHP SDK + Laravel
+	SUPPORTS_MULTIPART=true EXAMPLE_SERVER="php packages/php/examples/laravel/artisan serve" npm run test:integration-metrics
+
+test-php-webhooks-php-laravel: ## Run webhooks tests against the PHP SDK + Laravel
+	EXAMPLE_SERVER="php packages/php/examples/laravel/artisan serve" npm run test:integration-webhooks
+
+test-python-metrics-flask: ## Run Metrics tests against the Python SDK + Flask
+	EXAMPLE_SERVER="python3 packages/python/examples/flask/app.py" npm run test:integration-metrics
+
+test-python-webhooks-flask: ## Run webhooks tests against the Python SDK + Flask
+	EXAMPLE_SERVER="python3 packages/python/examples/flask/webhooks.py" npm run test:integration-webhooks
+
+help: ## Display this help screen
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

__tests__/.eslintrc

@@ -1,3 +1,8 @@
 {
-  "extends": "@readme/eslint-config/testing"
+  "extends": "@readme/eslint-config/testing-mocha",
+  "rules": {
+    "import/extensions": ["error", "ignorePackages"],
+    "no-underscore-dangle": "off",
+    "unicorn/no-unsafe-regex": "off"
+  }
 }

__tests__/__datasets__/owlbert.dataurl.json

@@ -0,0 +1 @@
+"data:image/png;name=owlbert.png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAMCAYAAABbayygAAABV0lEQVR4AWNwL/Bh0FGQ9FWUENUGsZExPz8/h5gArzmIDRZw1VfpSfeyagIJgiRBYkCg7mOl72akIt0KVwhSVB5o9SPESutJWajzquJgx/lRDganc7zNX3obq9SiKKxN8P/fmB33vybc7j+MHe1k8t9RSy4NrrA4K2Xp1k0b/peUlPzPjfL5v3bpgv9NTc3/48JD/sOsBju4JDnq6MS+3v9uLlb/pzeY/l82r+9/cIA/GNtrK2wFqQH7uDzY/gXQOrBpbemi/xO9DH4B2WCrQe4GqWHQVRDfBnLXpDTX/z3xTii4xM/if4iF5n+QGgZjZamvIIH5RT5wPKvQC0wDDQAr1FMQ/8YgK8zfAzIeqgCOp+V5gBW6Giq9A6kB+9pUXTiqINjwJ9B6uKKmBHuwW7XkhFeAYg2sMMWXQTvJh/2Uu6nciTgXvVsg7Gsp+xAkZqHPIA1SAwCKnrxJusHahgAAAABJRU5ErkJggg=="

packages/php/tests/fixtures/owlbert.png renamed to __tests__/__datasets__/owlbert.png

@@ -0,0 +1,54 @@
+import caseless from 'caseless';
+import chai from 'chai';
+
+/**
+ * Converts an array of headers like this:
+ *
+ *  [
+ *    { name: 'host', value: 'localhost:49914' },
+ *    { name: 'connection', value: 'close' },
+ *  ];
+ *
+ * To an object that can be passed in to caseless:
+ *
+ *  {
+ *    host: 'localhost:49914',
+ *    connection: 'close'
+ *  }
+ */
+function arrayToObject(array) {
+  return array.reduce((prev, next) => {
+    return Object.assign(prev, { [next.name]: next.value });
+  }, {});
+}
+
+export default function chaiPlugins(_chai, utils) {
+  /**
+   * Determine if a given HAR `headers` array has a given header matching a specific value.
+   *
+   * @example <caption>should match a value</caption>
+   * expect(request.headers).to.have.header('connection', 'close');
+   *
+   * @example <caption>should match a regex</caption>
+   * expect(response.headers).to.have.header('content-type', /application\/json(;\s?charset=utf-8)?/);
+   *
+   * @example <caption>should match one of many values</caption>
+   * expect(request.headers).to.have.header('connection', ['close', 'keep-alive']);
+   *
+   * @param {array} headers
+   * @param {string} header
+   * @param {string|RegExp} expected
+   */
+  utils.addMethod(chai.Assertion.prototype, 'header', function (header, expected) {
+    const obj = utils.flag(this, 'object');
+    const headers = caseless(arrayToObject(obj));
+
+    if (expected.constructor.name === 'RegExp') {
+      new chai.Assertion(headers.get(header)).to.match(expected);
+    } else if (Array.isArray(expected)) {
+      new chai.Assertion(headers.get(header)).to.oneOf(expected.map(e => e.toString()));
+    } else {
+      new chai.Assertion(headers.get(header)).to.equal(expected.toString());
+    }
+  });
+}