Merge pull request #4 from apilytics/apilytics-version

Send Apilytics version info together with metrics, create CD pipeline

Author: ruohola

.eslintrc.js

@@ -1,4 +1,3 @@
-/* eslint @typescript-eslint/no-var-requires: "off" */
 const builtins = require('module').builtinModules.join('|');
 
 module.exports = {
@@ -12,6 +11,7 @@ module.exports = {
     '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/no-empty-function': 'off',
     '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/no-var-requires': 'off',
     'no-return-await': 'error',
     'import/no-duplicates': 'error',
     'simple-import-sort/imports': [

.github/check_commits.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-head="$(git remote show origin | awk '/HEAD branch/ {print $NF}')"
+head="$GITHUB_BASE_REF"
 current="$(git rev-parse HEAD)"
 
 if ! git merge-base --is-ancestor "origin/${head}" "$current"; then

.github/workflows/cd.yml

@@ -0,0 +1,71 @@
+name: "CD"
+
+on:
+  workflow_dispatch:
+    inputs:
+      release-type:
+        description: "Type of release?"
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+jobs:
+  release:
+    name: "Release"
+    if: ${{ github.ref == 'refs/heads/master' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GH_PAT }}
+
+      - name: "Set up Node"
+        uses: actions/setup-node@v2
+        with:
+          node-version: '12'
+          cache: 'yarn'
+
+      - name: "Install dependencies"
+        run: yarn install --frozen-lockfile
+
+      - name: "Build the sources"
+        run: yarn build
+
+      - name: "Publish to npm"
+        id: publish
+        run: |
+          yarn publish:all ${{ github.event.inputs.release-type }}
+          echo "::set-output name=version::$(node --print 'require("./lerna.json").version')"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: "Update the changelog"
+        # Find the first line that starts with `###` or `## [<number>` from the CHANGELOG and insert the new version header before it.
+        run: |
+          current_date="$(date -u '+%Y-%m-%d')"
+          sed -i "0,/^\(###\|## *\[[0-9]\).*/{s//## [${{ steps.publish.outputs.version }}] - ${current_date}\n\n&/}" CHANGELOG.md
+
+      - name: "Extract version's changelog for release notes"
+        # 1. Find the lines between the first `## [<number>` and the second `## [<number>`.
+        # 2. Remove all leading and trailing newlines from the output.
+        run: sed '1,/^## *\[[0-9]/d;/^## *\[[0-9]/Q' CHANGELOG.md | sed -e :a -e '/./,$!d;/^\n*$/{$d;N;};/\n$/ba' > release_notes.txt
+
+      - name: "Commit and tag the changes"
+        uses: EndBug/add-and-commit@8c12ff729a98cfbcd3fe38b49f55eceb98a5ec02  # v7.5.0
+        with:
+          add: '["lerna.json", "*package.json", "CHANGELOG.md"]'
+          message: 'Release ${{ steps.publish.outputs.version }}'
+          tag: 'v${{ steps.publish.outputs.version }} --annotate --file /dev/null'
+          default_author: github_actions
+          pathspec_error_handling: exitImmediately
+
+      - name: "Create a GitHub release"
+        uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5  # v1
+        with:
+          tag_name: v${{ steps.publish.outputs.version }}
+          name: v${{ steps.publish.outputs.version }}
+          body_path: release_notes.txt

.github/workflows/ci.yml

@@ -26,8 +26,6 @@ jobs:
 
   linters:
     name: "Linters"
-    needs: commits
-    if: ${{ !failure() }}
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout code"
@@ -47,8 +45,6 @@ jobs:
 
   build:
     name: "Build"
-    needs: commits
-    if: ${{ !failure() }}
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout code"
@@ -68,7 +64,6 @@ jobs:
 
   tests:
     name: "Tests"
-    if: ${{ !failure() }}
     needs: [linters, build]
     strategy:
       fail-fast: true

CHANGELOG.md

@@ -7,8 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Send Apilytics version info together with metrics.
+
 ## [1.0.1] - 2022-01-12
 
+### Fixed
+
+- Improve README documentation.
+
 ## [1.0.0] - 2022-01-11
 
 ### Added

README.md

@@ -16,8 +16,8 @@ Apilytics is a service that lets you analyze operational, performance and securi
 
 2. Continue with installation directions for your specific framework:
 
-- [**Express** (`@apilytics/express`)](./packages/express/README.md#installation)
+- [**Express** (`@apilytics/express`)](./packages/express#readme)
 
-- [**Next.js** (`@apilytics/next`)](./packages/next/README.md#installation)
+- [**Next.js** (`@apilytics/next`)](./packages/next#readme)
 
-- [**Other Node.js Frameworks** (`@apilytics/core`)](./packages/core/README.md#installation)
+- [**Other Node.js Frameworks** (`@apilytics/core`)](./packages/core#readme)

lerna.json

@@ -0,0 +1,6 @@
+{
+  "version": "1.0.1",
+  "packages": ["packages/*"],
+  "npmClient": "yarn",
+  "useWorkspaces": true
+}

package.json

@@ -4,15 +4,15 @@
     "packages/*"
   ],
   "scripts": {
-    "prebuild": "yarn --cwd=packages/core build",
-    "build": "for dir in packages/*; do echo \"$dir\" && yarn --cwd=\"$dir\" build; done",
-    "clean": "for dir in packages/*; do echo \"$dir\" && yarn --cwd=\"$dir\" clean; done",
+    "build": "lerna run build",
+    "clean": "lerna run clean",
+    "publish:all": "lerna publish --force-publish='*' --exact --no-git-tag-version --yes",
     "format": "prettier --write '**/*.{ts,js,json}' && eslint --fix --max-warnings=0 --ext=.ts,.js .",
     "lint": "prettier --check '**/*.{ts,js,json}' && eslint --max-warnings=0 --ext=.ts,.js .",
     "type-check": "yarn tsc --noEmit",
     "test": "jest --verbose",
     "test:cov": "yarn test --coverage",
-    "postinstall": "yarn prebuild"
+    "postinstall": "yarn --cwd=packages/core build"
   },
   "devDependencies": {
     "@types/jest": "27.4.0",
@@ -23,6 +23,7 @@
     "eslint-plugin-import": "2.25.4",
     "eslint-plugin-simple-import-sort": "7.0.0",
     "jest": "27.4.7",
+    "lerna": "4.0.0",
     "prettier": "2.5.1",
     "supertest": "6.1.6",
     "ts-jest": "27.1.2",

packages/core/README.md

@@ -12,9 +12,9 @@ Apilytics is a service that lets you analyze operational, performance and securi
 
 Make sure to check out our out-of-the-box middleware packages first:
 
-- [**Express** (`@apilytics/express`)](../express/README.md#installation)
+- [**Express** (`@apilytics/express`)](../express#readme)
 
-- [**Next.js** (`@apilytics/next`)](../next/README.md#installation)
+- [**Next.js** (`@apilytics/next`)](../next#readme)
 
 ## Installation
 

packages/core/__tests__/index.test.ts

@@ -3,18 +3,22 @@ import type http from 'http';
 
 import { milliSecondTimer, sendApilyticsMetrics } from '../src';
 
+const APILYTICS_VERSION = require('../package.json').version;
+
 describe('sendApilyticsMetrics()', () => {
   const OLD_ENV = process.env;
+  const apiKey = 'dummy-key';
 
   const params = {
-    apiKey: 'dummy-key',
+    apiKey,
     path: '/',
     method: 'GET',
     statusCode: 200,
     timeMillis: 10,
   };
 
   let consoleErrorSpy: jest.SpyInstance;
+  let requestSpy: jest.SpyInstance;
 
   const clientRequestMock = {
     on: jest.fn().mockImplementation((event, handler) => {
@@ -28,7 +32,7 @@ describe('sendApilyticsMetrics()', () => {
     jest.resetModules();
     process.env = { ...OLD_ENV };
 
-    jest
+    requestSpy = jest
       .spyOn(https, 'request')
       .mockImplementation(
         () => clientRequestMock as unknown as http.ClientRequest,
@@ -46,6 +50,64 @@ describe('sendApilyticsMetrics()', () => {
     process.env = OLD_ENV;
   });
 
+  it('should call apilytics API', async () => {
+    sendApilyticsMetrics(params);
+
+    expect(requestSpy).toHaveBeenCalledTimes(1);
+
+    expect(APILYTICS_VERSION).toBeTruthy();
+    expect(process.versions.node).toBeTruthy();
+
+    expect(requestSpy).toHaveBeenLastCalledWith({
+      hostname: 'www.apilytics.io',
+      port: 443,
+      path: '/api/v1/middleware',
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        'Content-Length': expect.any(Number),
+        'X-API-Key': apiKey,
+        'Apilytics-Version': `apilytics-node-core/${APILYTICS_VERSION};node/${process.versions.node}`,
+      },
+    });
+
+    expect(clientRequestMock.on).toHaveBeenCalledTimes(1);
+    expect(clientRequestMock.write).toHaveBeenCalledTimes(1);
+    expect(clientRequestMock.end).toHaveBeenCalledTimes(1);
+
+    const data = JSON.parse(clientRequestMock.write.mock.calls[0]);
+    expect(data).toStrictEqual({
+      path: '/',
+      method: 'GET',
+      statusCode: 200,
+      timeMillis: expect.any(Number),
+    });
+    expect(data['timeMillis']).toEqual(Math.trunc(data['timeMillis']));
+  });
+
+  it('should allow to pass optional `apilyticsIntegration` and `integratedLibrary` params', async () => {
+    sendApilyticsMetrics({
+      ...params,
+      apilyticsIntegration: 'dummy',
+      integratedLibrary: 'lib/1.2.3',
+    });
+
+    expect(requestSpy).toHaveBeenCalledTimes(1);
+
+    expect(requestSpy).toHaveBeenLastCalledWith({
+      hostname: 'www.apilytics.io',
+      port: 443,
+      path: '/api/v1/middleware',
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        'Content-Length': expect.any(Number),
+        'X-API-Key': apiKey,
+        'Apilytics-Version': `dummy/${APILYTICS_VERSION};node/${process.versions.node};lib/1.2.3`,
+      },
+    });
+  });
+
   it('should hide HTTP errors in production', async () => {
     // @ts-ignore: Assigning to a read-only property.
     process.env.NODE_ENV = 'production';