ci: update Unified CI configuration (libp2p#29)

Co-authored-by: web3-bot <[email protected]>
Co-authored-by: Alex Potsides <[email protected]>

Author: web3-bot

.github/workflows/js-test-and-release.yml

@@ -99,7 +99,8 @@ jobs:
   test-webkit:
     needs: check
     runs-on: ${{ matrix.os }}
-    matrix:
+    strategy:
+      matrix:
         os: [ubuntu-latest, macos-latest]
         node: [lts/*]
       fail-fast: true
@@ -114,10 +115,11 @@ jobs:
         with:
           flags: webkit
 
-  test-webkit:
+  test-webkit-webworker:
     needs: check
     runs-on: ${{ matrix.os }}
-    matrix:
+    strategy:
+      matrix:
         os: [ubuntu-latest, macos-latest]
         node: [lts/*]
       fail-fast: true

.gitignore

@@ -1,7 +1,9 @@
 node_modules
+build
 dist
 .docs
 .coverage
 node_modules
 package-lock.json
 yarn.lock
+.vscode

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package.json

@@ -13,8 +13,8 @@
     "url": "https://github.com/libp2p/js-libp2p-prometheus-metrics/issues"
   },
   "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=7.0.0"
+    "node": ">=18.0.0",
+    "npm": ">=8.6.0"
   },
   "type": "module",
   "types": "./dist/src/index.d.ts",
@@ -133,23 +133,21 @@
     "docs": "aegir docs"
   },
   "dependencies": {
-    "@libp2p/interface-connection": "^3.0.2",
+    "@libp2p/interface-connection": "^5.0.2",
     "@libp2p/interface-metrics": "^4.0.2",
     "@libp2p/logger": "^2.0.2",
-    "it-foreach": "^1.0.0",
-    "it-stream-types": "^1.0.4"
+    "it-foreach": "^2.0.3",
+    "it-stream-types": "^2.0.1"
   },
   "devDependencies": {
-    "@libp2p/interface-mocks": "^8.0.4",
-    "@libp2p/peer-id-factory": "^1.0.19",
-    "@multiformats/multiaddr": "^11.0.7",
-    "aegir": "^37.5.6",
-    "it-drain": "^2.0.0",
-    "it-pair": "^2.0.3",
-    "it-pipe": "^2.0.4",
+    "@libp2p/interface-mocks": "^12.0.1",
+    "@libp2p/peer-id-factory": "^2.0.3",
+    "@multiformats/multiaddr": "^12.1.3",
+    "aegir": "^39.0.6",
+    "it-drain": "^3.0.2",
+    "it-pipe": "^3.0.1",
     "p-defer": "^4.0.0",
-    "prom-client": "^14.1.0",
-    "uint8arraylist": "^2.3.3"
+    "prom-client": "^14.1.0"
   },
   "peerDependencies": {
     "prom-client": "^14.1.0"

src/counter-group.ts

@@ -1,7 +1,7 @@
-import type { CounterGroup, CalculateMetric } from '@libp2p/interface-metrics'
-import { Counter as PromCounter, CollectFunction } from 'prom-client'
-import { normaliseString, CalculatedMetric } from './utils.js'
+import { Counter as PromCounter, type CollectFunction } from 'prom-client'
+import { normaliseString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedMetricOptions } from './index.js'
+import type { CounterGroup, CalculateMetric } from '@libp2p/interface-metrics'
 
 export class PrometheusCounterGroup implements CounterGroup, CalculatedMetric<Record<string, number>> {
   private readonly counter: PromCounter
@@ -40,7 +40,7 @@ export class PrometheusCounterGroup implements CounterGroup, CalculatedMetric<Re
     })
   }
 
-  addCalculator (calculator: CalculateMetric<Record<string, number>>) {
+  addCalculator (calculator: CalculateMetric<Record<string, number>>): void {
     this.calculators.push(calculator)
   }
 

src/counter.ts

@@ -1,7 +1,7 @@
-import type { CalculateMetric, Counter } from '@libp2p/interface-metrics'
-import { CollectFunction, Counter as PromCounter } from 'prom-client'
+import { type CollectFunction, Counter as PromCounter } from 'prom-client'
+import { normaliseString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedMetricOptions } from './index.js'
-import { normaliseString, CalculatedMetric } from './utils.js'
+import type { CalculateMetric, Counter } from '@libp2p/interface-metrics'
 
 export class PrometheusCounter implements Counter, CalculatedMetric {
   private readonly counter: PromCounter
@@ -20,7 +20,7 @@ export class PrometheusCounter implements Counter, CalculatedMetric {
       const self = this
 
       collect = async function () {
-        const values = await Promise.all(self.calculators.map(async calculate => await calculate()))
+        const values = await Promise.all(self.calculators.map(async calculate => calculate()))
         const sum = values.reduce((acc, curr) => acc + curr, 0)
 
         this.inc(sum)
@@ -36,7 +36,7 @@ export class PrometheusCounter implements Counter, CalculatedMetric {
     })
   }
 
-  addCalculator (calculator: CalculateMetric) {
+  addCalculator (calculator: CalculateMetric): void {
     this.calculators.push(calculator)
   }
 

src/index.ts

@@ -92,19 +92,18 @@
  * const stream = await connection.newStream('/my/protocol')
  * const streams = metrics.trackProtocolStream(stream)
  * ```
- *
  */
 
-import type { CalculatedMetricOptions, Counter, CounterGroup, Metric, MetricGroup, MetricOptions, Metrics } from '@libp2p/interface-metrics'
-import { collectDefaultMetrics, DefaultMetricsCollectorConfiguration, register, Registry } from 'prom-client'
-import type { MultiaddrConnection, Stream, Connection } from '@libp2p/interface-connection'
-import type { Duplex } from 'it-stream-types'
+import { logger } from '@libp2p/logger'
 import each from 'it-foreach'
-import { PrometheusMetric } from './metric.js'
-import { PrometheusMetricGroup } from './metric-group.js'
-import { PrometheusCounter } from './counter.js'
+import { collectDefaultMetrics, type DefaultMetricsCollectorConfiguration, register, type Registry } from 'prom-client'
 import { PrometheusCounterGroup } from './counter-group.js'
-import { logger } from '@libp2p/logger'
+import { PrometheusCounter } from './counter.js'
+import { PrometheusMetricGroup } from './metric-group.js'
+import { PrometheusMetric } from './metric.js'
+import type { MultiaddrConnection, Stream, Connection } from '@libp2p/interface-connection'
+import type { CalculatedMetricOptions, Counter, CounterGroup, Metric, MetricGroup, MetricOptions, Metrics } from '@libp2p/interface-metrics'
+import type { Duplex, Source } from 'it-stream-types'
 
 const log = logger('libp2p:prometheus-metrics')
 
@@ -194,7 +193,7 @@ class PrometheusMetrics implements Metrics {
    * Increment the transfer stat for the passed key, making sure
    * it exists first
    */
-  _incrementValue (key: string, value: number) {
+  _incrementValue (key: string, value: number): void {
     const existing = this.transferStats.get(key) ?? 0
 
     this.transferStats.set(key, existing + value)
@@ -204,7 +203,7 @@ class PrometheusMetrics implements Metrics {
    * Override the sink/source of the stream to count the bytes
    * in and out
    */
-  _track (stream: Duplex<any>, name: string) {
+  _track (stream: Duplex<Source<any>>, name: string): void {
     const self = this
 
     const sink = stream.sink

src/metric-group.ts

@@ -1,7 +1,7 @@
-import type { CalculateMetric, MetricGroup, StopTimer } from '@libp2p/interface-metrics'
-import { CollectFunction, Gauge } from 'prom-client'
+import { type CollectFunction, Gauge } from 'prom-client'
+import { normaliseString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedMetricOptions } from './index.js'
-import { normaliseString, CalculatedMetric } from './utils.js'
+import type { CalculateMetric, MetricGroup, StopTimer } from '@libp2p/interface-metrics'
 
 export class PrometheusMetricGroup implements MetricGroup, CalculatedMetric<Record<string, number>> {
   private readonly gauge: Gauge
@@ -40,7 +40,7 @@ export class PrometheusMetricGroup implements MetricGroup, CalculatedMetric<Reco
     })
   }
 
-  addCalculator (calculator: CalculateMetric<Record<string, number>>) {
+  addCalculator (calculator: CalculateMetric<Record<string, number>>): void {
     this.calculators.push(calculator)
   }
 

src/metric.ts

@@ -1,7 +1,7 @@
-import type { Metric, StopTimer, CalculateMetric } from '@libp2p/interface-metrics'
-import { CollectFunction, Gauge } from 'prom-client'
-import type { PrometheusCalculatedMetricOptions } from './index.js'
+import { type CollectFunction, Gauge } from 'prom-client'
 import { normaliseString } from './utils.js'
+import type { PrometheusCalculatedMetricOptions } from './index.js'
+import type { Metric, StopTimer, CalculateMetric } from '@libp2p/interface-metrics'
 
 export class PrometheusMetric implements Metric {
   private readonly gauge: Gauge
@@ -20,7 +20,7 @@ export class PrometheusMetric implements Metric {
       const self = this
 
       collect = async function () {
-        const values = await Promise.all(self.calculators.map(async calculate => await calculate()))
+        const values = await Promise.all(self.calculators.map(async calculate => calculate()))
         const sum = values.reduce((acc, curr) => acc + curr, 0)
 
         this.set(sum)
@@ -36,7 +36,7 @@ export class PrometheusMetric implements Metric {
     })
   }
 
-  addCalculator (calculator: CalculateMetric) {
+  addCalculator (calculator: CalculateMetric): void {
     this.calculators.push(calculator)
   }
 

test/counter-groups.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from 'aegir/chai'
-import { prometheusMetrics } from '../src/index.js'
 import client from 'prom-client'
+import { prometheusMetrics } from '../src/index.js'
 import { randomMetricName } from './fixtures/random-metric-name.js'
 
 describe('counter groups', () => {

test/counters.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from 'aegir/chai'
-import { prometheusMetrics } from '../src/index.js'
 import client from 'prom-client'
+import { prometheusMetrics } from '../src/index.js'
 import { randomMetricName } from './fixtures/random-metric-name.js'
 
 describe('counters', () => {

test/custom-registry.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from 'aegir/chai'
-import { prometheusMetrics } from '../src/index.js'
 import client, { Registry } from 'prom-client'
+import { prometheusMetrics } from '../src/index.js'
 import { randomMetricName } from './fixtures/random-metric-name.js'
 
 describe('custom registry', () => {

test/fixtures/random-metric-name.ts

@@ -2,6 +2,6 @@
  * Prometheus metric names are global and can only contain
  * a limited set of, at least /a-z_0-9/i
  */
-export function randomMetricName (key = '') {
+export function randomMetricName (key = ''): string {
   return `my_metric_${key}${Math.random().toString().split('.').pop() ?? ''}`
 }

test/metric-groups.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from 'aegir/chai'
-import { prometheusMetrics } from '../src/index.js'
 import client from 'prom-client'
+import { prometheusMetrics } from '../src/index.js'
 import { randomMetricName } from './fixtures/random-metric-name.js'
 
 describe('metric groups', () => {

test/metrics.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from 'aegir/chai'
-import { prometheusMetrics } from '../src/index.js'
 import client from 'prom-client'
+import { prometheusMetrics } from '../src/index.js'
 import { randomMetricName } from './fixtures/random-metric-name.js'
 
 describe('metrics', () => {

test/streams.spec.ts

@@ -1,13 +1,13 @@
-import { expect } from 'aegir/chai'
-import { prometheusMetrics } from '../src/index.js'
-import client from 'prom-client'
-import type { Connection } from '@libp2p/interface-connection'
 import { connectionPair, mockRegistrar, mockMultiaddrConnPair } from '@libp2p/interface-mocks'
 import { createEd25519PeerId } from '@libp2p/peer-id-factory'
-import { pipe } from 'it-pipe'
+import { multiaddr } from '@multiformats/multiaddr'
+import { expect } from 'aegir/chai'
 import drain from 'it-drain'
+import { pipe } from 'it-pipe'
 import defer from 'p-defer'
-import { multiaddr } from '@multiformats/multiaddr'
+import client from 'prom-client'
+import { prometheusMetrics } from '../src/index.js'
+import type { Connection } from '@libp2p/interface-connection'
 
 describe('streams', () => {
   let connectionA: Connection