feat: remove http-server dependency and http related functionality

Makefile

@@ -18,9 +18,9 @@ test:
 ci: | build test
 
 update-interfaces-next:
-	npm install @well-known-components/interfaces@next
+	yarn add @well-known-components/interfaces@next
 
 update-interfaces-latest:
-	npm install @well-known-components/interfaces@latest
+	yarn add @well-known-components/interfaces@latest
 
-.PHONY: build test
+.PHONY: build test

etc/metrics.api.md

@@ -6,7 +6,6 @@
 
 import { IBaseComponent } from '@well-known-components/interfaces';
 import { IConfigComponent } from '@well-known-components/interfaces';
-import { IHttpServerComponent } from '@well-known-components/interfaces';
 import { IMetricsComponent } from '@well-known-components/interfaces';
 import { Registry } from 'prom-client';
 
@@ -26,18 +25,6 @@ export function createTestMetricsComponent<K extends string>(metricsDefinition:
     registry: Registry;
 };
 
-// Warning: (ae-forgotten-export) The symbol "HttpMetrics" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export function getDefaultHttpMetrics(): IMetricsComponent.MetricsRecordDefinition<HttpMetrics>;
-
-// @public
-export function instrumentHttpServerWithMetrics<K extends string>(components: {
-    metrics: IMetricsComponent<K | HttpMetrics>;
-    server: IHttpServerComponent<any>;
-    config: IConfigComponent;
-}): Promise<void>;
-
 // @public
 export function validateMetricsDeclaration<T extends string>(metricsDefinition: IMetricsComponent.MetricsRecordDefinition<T>): IMetricsComponent.MetricsRecordDefinition<T>;
 

jest.config.js

@@ -1,8 +1,6 @@
 module.exports = {
-  globals: {
-    'ts-jest': {
-      tsconfig: 'test/tsconfig.json'
-    }
+  transform: {
+    "^.+\\.(ts|tsx)$": ["ts-jest", {tsconfig: "test/tsconfig.json"}]
   },
   moduleFileExtensions: ['ts', 'js'],
   transform: {

package.json

@@ -4,7 +4,10 @@
   "description": "metrics component",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
-  "scripts": {},
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "jest --forceExit --detectOpenHandles --coverage --verbose"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/well-known-components/metrics.git"
@@ -17,19 +20,22 @@
   },
   "prettier": {
     "printWidth": 120,
-    "semi": false
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "tabWidth": 2
   },
   "homepage": "https://github.com/well-known-components/metrics#readme",
   "devDependencies": {
     "@microsoft/api-extractor": "^7.18.5",
     "@well-known-components/env-config-provider": "^1.1.0",
-    "@well-known-components/http-server": "^2.0.0",
-    "@well-known-components/interfaces": "^1.1.1",
+    "@well-known-components/interfaces": "^1.4.3",
     "@well-known-components/logger": "^3.1.2",
     "@well-known-components/test-helpers": "^1.5.1",
     "typescript": "^5.1.3"
   },
   "dependencies": {
+    "@well-known-components/http-server": "^2.0.1-20240313124908.commit-80c33da",
     "prom-client": "^14.1.0"
   },
   "files": [

src/index.ts

@@ -1,27 +1,21 @@
-import {
-  IBaseComponent,
-  IConfigComponent,
-  IHttpServerComponent,
-  IMetricsComponent,
-} from "@well-known-components/interfaces"
+import { IBaseComponent, IConfigComponent, IMetricsComponent } from '@well-known-components/interfaces'
 
-import { collectDefaultMetrics } from "prom-client"
-import { HttpMetrics, instrumentHttpServerWithPromClientRegistry, getDefaultHttpMetrics } from "./http"
-import { createTestMetricsComponent } from "./base"
+import { collectDefaultMetrics } from 'prom-client'
+import { createTestMetricsComponent } from './base'
 
-export { createTestMetricsComponent, getDefaultHttpMetrics }
+export { createTestMetricsComponent }
 
 /**
  * Metrics configuration prefix.
  * @public
  */
-export const CONFIG_PREFIX = "WKC_METRICS" as const
+export const CONFIG_PREFIX = 'WKC_METRICS' as const
 
 /**
  * @internal
  */
 export function _configKey(key: Uppercase<string>): string {
-  return `${CONFIG_PREFIX}_${key.toUpperCase().replace(/^(_*)/, "")}`
+  return `${CONFIG_PREFIX}_${key.toUpperCase().replace(/^(_*)/, '')}`
 }
 
 /**
@@ -40,36 +34,13 @@ export async function createMetricsComponent<K extends string, V extends object
     ...basePort,
     // IBaseComponent
     start: async () => {
-      if ((await config.getString(_configKey("COLLECT_DEFAULT"))) != "false") {
+      if ((await config.getString(_configKey('COLLECT_DEFAULT'))) != 'false') {
         collectDefaultMetrics({ register: basePort.registry })
       }
-    },
+    }
   }
 }
 
-/**
- * Instruments an HTTP server with a IMetricsComponent created by this library
- *
- * @public
- */
-export async function instrumentHttpServerWithMetrics<K extends string>(components: {
-  metrics: IMetricsComponent<K | HttpMetrics>
-  server: IHttpServerComponent<any>
-  config: IConfigComponent
-}) {
-  const metricsPath = (await components.config.getString(_configKey("PUBLIC_PATH"))) || "/metrics"
-  const bearerToken = await components.config.getString(_configKey("BEARER_TOKEN"))
-  const rotateMetrics = await components.config.getString(_configKey("RESET_AT_NIGHT")) == 'true'
-
-  instrumentHttpServerWithPromClientRegistry<K>({
-    server: components.server,
-    metrics: components.metrics,
-    metricsPath,
-    bearerToken,
-    resetEveryNight: rotateMetrics
-  })
-}
-
 /**
  * This function only validates the types.
  * In the future it may perform real runtime assertions.

test/harness/defaultMetrics.ts

@@ -1,35 +1,36 @@
-import { IMetricsComponent } from "@well-known-components/interfaces"
-import { validateMetricsDeclaration, getDefaultHttpMetrics } from "../../src"
-import { metricDeclarations as logMetricDeclarations } from "@well-known-components/logger"
+import { IMetricsComponent } from '@well-known-components/interfaces'
+import { validateMetricsDeclaration } from '../../src'
+import { metricDeclarations as logMetricDeclarations } from '@well-known-components/logger'
+import { getDefaultHttpMetrics } from '@well-known-components/http-server'
 
 export const metricDeclarations = {
   ...logMetricDeclarations,
+  ...getDefaultHttpMetrics(),
   test_counter: {
     type: IMetricsComponent.CounterType,
-    help: "Count calls to ping",
-    labelNames: ["pathname"],
+    help: 'Count calls to ping',
+    labelNames: ['pathname']
   },
   test_gauge: {
     type: IMetricsComponent.GaugeType,
-    help: "Gauges calls to ping (?)",
-    labelNames: ["pathname"],
+    help: 'Gauges calls to ping (?)',
+    labelNames: ['pathname']
   },
   test_histogram: {
     type: IMetricsComponent.HistogramType,
-    help: "Histograms calls to ping (?)",
-    labelNames: ["pathname"],
+    help: 'Histograms calls to ping (?)',
+    labelNames: ['pathname']
   },
   test_summary: {
     type: IMetricsComponent.SummaryType,
-    help: "Summaries calls to ping (?)",
-    labelNames: ["pathname"],
+    help: 'Summaries calls to ping (?)',
+    labelNames: ['pathname']
   },
   user_counter: {
     type: IMetricsComponent.CounterType,
-    help: "Count calls to /user/:userId",
-    labelNames: ["userId"],
-  },
-  ...getDefaultHttpMetrics()
+    help: 'Count calls to /user/:userId',
+    labelNames: ['userId']
+  }
 }
 
 // type assertions

test/harness/test-e2e-express-server.ts

@@ -1,12 +1,13 @@
-import { createConfigComponent } from "@well-known-components/env-config-provider"
-import { createServerComponent, IFetchComponent } from "@well-known-components/http-server"
-import { createLogComponent } from "@well-known-components/logger"
-import { createRunner } from "@well-known-components/test-helpers"
-import nodeFetch from "node-fetch"
-import { createMetricsComponent, instrumentHttpServerWithMetrics } from "../../src"
-import { metricDeclarations } from "./defaultMetrics"
-import { mockedRouter } from "./mockedServer"
-import { TestComponents } from "./test-helpers"
+import { createConfigComponent } from '@well-known-components/env-config-provider'
+import { createServerComponent, instrumentHttpServerWithPromClientRegistry } from '@well-known-components/http-server'
+import { createLogComponent } from '@well-known-components/logger'
+import { createRunner } from '@well-known-components/test-helpers'
+import nodeFetch from 'node-fetch'
+import { createMetricsComponent } from '../../src'
+import { metricDeclarations } from './defaultMetrics'
+import { mockedRouter } from './mockedServer'
+import { TestComponents } from './test-helpers'
+import { IFetchComponent } from '@well-known-components/interfaces'
 
 let currentPort = 19000
 
@@ -17,15 +18,14 @@ export const describeE2E = createRunner({
     components.server.setContext({ components })
     await startComponents()
   },
-  initComponents,
+  initComponents
 })
 
 async function initComponents(): Promise<TestComponents> {
-
   const config = createConfigComponent(
     {
       HTTP_SERVER_PORT: (currentPort + 1).toString(),
-      HTTP_SERVER_HOST: "0.0.0.0",
+      HTTP_SERVER_HOST: '0.0.0.0'
     },
     process.env
   )
@@ -34,18 +34,18 @@ async function initComponents(): Promise<TestComponents> {
   const logs = await createLogComponent({ metrics })
 
   const protocolHostAndProtocol = `http://${await config.requireString(
-    "HTTP_SERVER_HOST"
-  )}:${await config.requireNumber("HTTP_SERVER_PORT")}`
+    'HTTP_SERVER_HOST'
+  )}:${await config.requireNumber('HTTP_SERVER_PORT')}`
 
   const server = await createServerComponent<any>({ logs, config }, {})
 
   const fetch: IFetchComponent = {
     async fetch(url, initRequest?) {
-      return nodeFetch(protocolHostAndProtocol + url, { ...initRequest })
-    },
+      return nodeFetch(protocolHostAndProtocol + url, initRequest ? initRequest : {})
+    }
   }
 
-  await instrumentHttpServerWithMetrics({ metrics, server, config })
+  await instrumentHttpServerWithPromClientRegistry({ metrics, server, config, registry: metrics.registry! })
 
   return { logs, config, server, fetch, metrics }
 }