Set payid metrics protocol version and server agent (#653)

* set new metrics properties for serverAgent and protocolVersion

* fix merge booboo with package.json

* change how package version is determined so that it works with docker container

* include package.json in the build so that config.ts can read the package version

* update server-metrics version
add test for new metrics

Author: nhartner

package-lock.json

@@ -16,12 +16,13 @@
   "main": "./build/src/index.js",
   "scripts": {
     "build": "run-script-os",
-    "build:default": "rm -rf build && tsc --project . && npm run copySQL && npm run copyHTML && npm run copyJSON",
-    "build:win32": "del /q /f build && tsc --project . && npm run copySQL && npm run copyHTML && npm run copyJSON",
+    "build:default": "rm -rf build && tsc --project . && npm run copySQL && npm run copyHTML && npm run copyJSON && npm run copyPackageJSON",
+    "build:win32": "del /q /f build && tsc --project . && npm run copySQL && npm run copyHTML && npm run copyJSON && npm run copyPackageJSON",
     "buildWatch": "tsc --watch --project .",
     "copyHTML": "copyfiles -u 1 src/html/* build/src",
     "copySQL": "copyfiles -u 1 **/*.sql build/src",
     "copyJSON": "copyfiles -u 1 src/**/*.json build/src",
+    "copyPackageJSON": "copyfiles package.json build",
     "lint": "eslint . --ext .ts --fix --max-warnings 0 && prettier --write '**/*.{md,json}'",
     "lintNoFix": "eslint . --ext .ts --max-warnings 0 && prettier --check '**/*.{md,json}'",
     "lintWatch": "chokidar src/**/*.ts -c \"npm run lint\" --initial --verbose",
@@ -40,7 +41,7 @@
   },
   "dependencies": {
     "@hapi/boom": "^9.1.0",
-    "@payid-org/server-metrics": "^1.0.0",
+    "@payid-org/server-metrics": "^1.1.0",
     "@xpring-eng/http-status": "^1.0.0",
     "@xpring-eng/logger": "^1.0.0",
     "express": "^4.17.1",

package.json

@@ -1,3 +1,5 @@
+import { version as packageVersion } from '../package.json'
+
 export const payIdServerVersions: readonly string[] = ['1.0', '1.1']
 export const adminApiVersions: readonly string[] = ['2020-05-28']
 
@@ -59,6 +61,10 @@ const config = {
     /** How frequently (in seconds) to refresh the PayID Count report data from the database. */
     payIdCountRefreshIntervalInSeconds:
       Number(process.env.PAYID_COUNT_REFRESH_INTERVAL) || 60,
+
+    payIdProtocolVersion: payIdServerVersions[payIdServerVersions.length - 1],
+
+    serverAgent: `@payid-org/payid:${packageVersion}`,
   },
 }
 

src/config.ts

@@ -103,6 +103,13 @@ describe('E2E - adminApiRouter - GET /metrics', function (): void {
     await assertMetrics(/actual_payid_count\{org="127.0.0.1"\} 18/u)
   })
 
+  it('Includes server version info', async function () {
+    await metrics.generatePayIdCountMetrics()
+    await assertMetrics(
+      /org="127.0.0.1",serverAgent="@payid-org\/payid:1.*.*",protocolVersion="1.*"\}/u,
+    )
+  })
+
   /**
    * A helper function that fetches PayID metrics and matches them against
    * expected metrics.