chore: consolidate tracked map into metrics part of interfaces

libp2p · Jun 17, 2023 · db5f99c · db5f99c
1 parent b5a6240
commit db5f99c
Show file tree

Hide file tree

Showing 18 changed files with 30 additions and 327 deletions.
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -18,7 +18,6 @@
   "packages/peer-record":"5.0.4",
   "packages/peer-store":"8.2.1",
   "packages/stream-multiplexer-mplex":"8.0.4",
-  "packages/tracked-map":"3.0.3",
   "packages/transport-tcp":"7.0.3",
   "packages/transport-webrtc":"2.0.10",
   "packages/transport-websockets":"6.0.3",

diff --git a/.release-please.json b/.release-please.json
@@ -23,7 +23,6 @@
     "packages/peer-record": {},
     "packages/peer-store": {},
     "packages/stream-multiplexer-mplex": {},
-    "packages/tracked-map": {},
     "packages/transport-tcp": {},
     "packages/transport-webrtc": {},
     "packages/transport-websockets": {},

diff --git a/packages/interface-compliance-tests/package.json b/packages/interface-compliance-tests/package.json
@@ -87,7 +87,14 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
-    "build": "aegir build"
+    "build": "aegir build",
+    "test": "aegir test",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
     "@libp2p/interface": "^0.0.1",

diff --git a/packages/interface/package.json b/packages/interface/package.json
@@ -84,6 +84,10 @@
       "types": "./dist/src/metrics/index.d.ts",
       "import": "./dist/src/metrics/index.js"
     },
+    "./metrics/tracked-map": {
+      "types": "./dist/src/metrics/tracked-map.d.ts",
+      "import": "./dist/src/metrics/tracked-map.js"
+    },
     "./peer-discovery": {
       "types": "./dist/src/peer-discovery/index.d.ts",
       "import": "./dist/src/peer-discovery/index.js"
@@ -143,7 +147,14 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
-    "build": "aegir build"
+    "build": "aegir build",
+    "test": "aegir test",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
     "@multiformats/multiaddr": "^12.1.3",
@@ -155,7 +166,10 @@
     "uint8arraylist": "^2.4.3"
   },
   "devDependencies": {
-    "aegir": "^39.0.10"
+    "@types/sinon": "^10.0.15",
+    "aegir": "^39.0.10",
+    "sinon": "^15.1.2",
+    "sinon-ts": "^1.0.0"
   },
   "typedoc": {
     "entryPoint": "./src/index.ts"

diff --git a/packages/tracked-map/src/index.ts → ...ages/interface/src/metrics/tracked-map.ts b/packages/tracked-map/src/index.ts → ...ages/interface/src/metrics/tracked-map.ts
@@ -1,4 +1,4 @@
-import type { Metric, Metrics } from '@libp2p/interface/metrics'
+import type { Metric, Metrics } from './index.js'
 
 export interface TrackedMapInit {
   name: string

diff --git a/packages/tracked-map/test/index.spec.ts → ...nterface/test/metrics/tracked-map.spec.ts b/packages/tracked-map/test/index.spec.ts → ...nterface/test/metrics/tracked-map.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from 'aegir/chai'
 import { stubInterface } from 'sinon-ts'
-import { trackedMap } from '../src/index.js'
-import type { Metric, Metrics } from '@libp2p/interface/metrics'
+import { trackedMap } from '../../src/metrics/tracked-map.js'
+import type { Metric, Metrics } from '../../src/metrics/index.js'
 import type { SinonStubbedInstance } from 'sinon'
 
 describe('tracked-map', () => {

diff --git a/packages/interface/tsconfig.json b/packages/interface/tsconfig.json
@@ -4,6 +4,7 @@
     "outDir": "dist"
   },
   "include": [
-    "src"
+    "src",
+    "test"
   ]
 }
diff --git a/packages/libp2p/package.json b/packages/libp2p/package.json
@@ -126,7 +126,6 @@
     "@libp2p/peer-id-factory": "^2.0.0",
     "@libp2p/peer-record": "^5.0.0",
     "@libp2p/peer-store": "^8.0.0",
-    "@libp2p/tracked-map": "^3.0.0",
     "@libp2p/utils": "^3.0.0",
     "@multiformats/mafmt": "^12.1.2",
     "@multiformats/multiaddr": "^12.1.3",

diff --git a/packages/libp2p/src/transport-manager.ts b/packages/libp2p/src/transport-manager.ts
@@ -1,7 +1,7 @@
 import { CodeError } from '@libp2p/interface/errors'
 import { FaultTolerance } from '@libp2p/interface/transport'
 import { logger } from '@libp2p/logger'
-import { trackedMap } from '@libp2p/tracked-map'
+import { trackedMap } from '@libp2p/interface/metrics/tracked-map'
 import { codes } from './errors.js'
 import type { Libp2pEvents, AbortOptions } from '@libp2p/interface'
 import type { Connection } from '@libp2p/interface/connection'

diff --git a/packages/libp2p/tsconfig.json b/packages/libp2p/tsconfig.json
@@ -56,9 +56,6 @@
     {
       "path": "../stream-multiplexer-mplex"
     },
-    {
-      "path": "../tracked-map"
-    },
     {
       "path": "../transport-tcp"
     },

diff --git a/packages/tracked-map/.gitignore b/packages/tracked-map/.gitignore
diff --git a/packages/tracked-map/CHANGELOG.md b/packages/tracked-map/CHANGELOG.md
diff --git a/packages/tracked-map/LICENSE b/packages/tracked-map/LICENSE
diff --git a/packages/tracked-map/LICENSE-APACHE b/packages/tracked-map/LICENSE-APACHE
diff --git a/packages/tracked-map/LICENSE-MIT b/packages/tracked-map/LICENSE-MIT
diff --git a/packages/tracked-map/README.md b/packages/tracked-map/README.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ @@
         "outDir": "dist"
       },
       "include": [
-        "src"
+        "src",
+        "test"
       ]
     }