chore: move api into peer dependency (#522)

* chore: move api into peer dependency * fix peer-api-check script
open-telemetry · Jun 7, 2021 · 2a30f62 · 2a30f62
1 parent 5d73dc2
commit 2a30f62
Show file tree

Hide file tree

Showing 32 changed files with 174 additions and 34 deletions.
diff --git a/.github/workflows/peer-api.yaml b/.github/workflows/peer-api.yaml
@@ -0,0 +1,22 @@
+name: Ensure API Peer Dependency
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  peer-api-check:
+    runs-on: ubuntu-latest
+    container:
+      image: node:14
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install lerna
+        run: npm install -g lerna
+
+      - name: Check API dependency semantics
+        run: lerna exec "node \$LERNA_ROOT_PATH/scripts/peer-api-check.js"
diff --git a/detectors/node/opentelemetry-resource-detector-github/package.json b/detectors/node/opentelemetry-resource-detector-github/package.json
@@ -42,7 +42,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@types/mocha": "8.2.2",
     "@types/node": "14.17.2",
     "@types/sinon": "9.0.11",
@@ -56,7 +60,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/resources": "^0.20.0"
   }
 }
diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json
@@ -26,7 +26,11 @@
   "bugs": {
     "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@types/mocha": "7.0.2",
     "@types/node": "14.17.2",
     "@types/sinon": "9.0.11",
@@ -40,7 +44,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/instrumentation-dns": "^0.20.0",
     "@opentelemetry/instrumentation-express": "^0.20.0",

diff --git a/metapackages/auto-instrumentations-web/package.json b/metapackages/auto-instrumentations-web/package.json
@@ -27,8 +27,12 @@
   "bugs": {
     "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
     "@babel/core": "7.14.3",
+    "@opentelemetry/api": "0.20.0",
     "@types/mocha": "8.2.2",
     "@types/node": "14.17.2",
     "@types/sinon": "9.0.11",
@@ -55,7 +59,6 @@
     "webpack-merge": "5.7.3"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/instrumentation-document-load": "^0.20.0",
     "@opentelemetry/instrumentation-fetch": "^0.20.0",

diff --git a/packages/opentelemetry-host-metrics/package.json b/packages/opentelemetry-host-metrics/package.json
@@ -41,7 +41,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@types/mocha": "8.2.2",
     "@types/node": "14.17.2",
     "@types/sinon": "9.0.11",
@@ -55,7 +59,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/api-metrics": "^0.20.0",
     "@opentelemetry/core": "^0.20.0",
     "@opentelemetry/metrics": "^0.20.0",

diff --git a/packages/opentelemetry-id-generator-aws-xray/package.json b/packages/opentelemetry-id-generator-aws-xray/package.json
@@ -51,7 +51,11 @@
     "LICENSE",
     "README.md"
   ],
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@types/mocha": "8.2.2",
     "@types/node": "14.17.2",
     "@types/sinon": "9.0.11",
@@ -75,7 +79,6 @@
     "webpack": "4.46.0"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/core": "^0.20.0"
   }
 }
diff --git a/packages/opentelemetry-test-utils/package.json b/packages/opentelemetry-test-utils/package.json
@@ -23,14 +23,17 @@
     "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme",
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@types/node": "14.17.2",
     "gts": "3.1.0",
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "0.20.0",
-    "@opentelemetry/core": "0.20.0",
-    "@opentelemetry/tracing": "0.20.0"
+    "@opentelemetry/core": "^0.20.0",
+    "@opentelemetry/tracing": "^0.20.0"
   }
 }
diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json b/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json
@@ -40,7 +40,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/core": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@types/mocha": "7.0.2",
@@ -54,7 +58,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/propagator-aws-xray": "^0.20.0",
     "@opentelemetry/resources": "^0.20.0",

diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/package.json b/plugins/node/opentelemetry-instrumentation-bunyan/package.json
@@ -41,7 +41,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -59,7 +63,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@types/bunyan": "1.8.6"
   }

diff --git a/plugins/node/opentelemetry-instrumentation-dns/package.json b/plugins/node/opentelemetry-instrumentation-dns/package.json
@@ -40,7 +40,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/core": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -59,7 +63,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",
     "semver": "^7.3.2"

diff --git a/plugins/node/opentelemetry-instrumentation-express/package.json b/plugins/node/opentelemetry-instrumentation-express/package.json
@@ -41,7 +41,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -57,7 +61,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/core": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",

diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/package.json b/plugins/node/opentelemetry-instrumentation-generic-pool/package.json
@@ -40,7 +40,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -58,7 +62,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",
     "@types/generic-pool": "^3.1.9"

diff --git a/plugins/node/opentelemetry-instrumentation-graphql/package.json b/plugins/node/opentelemetry-instrumentation-graphql/package.json
@@ -42,7 +42,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
     "@types/mocha": "8.2.2",
     "@types/node": "14.17.2",
@@ -56,7 +60,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@types/graphql": "14.5.0"
   }

diff --git a/plugins/node/opentelemetry-instrumentation-hapi/package.json b/plugins/node/opentelemetry-instrumentation-hapi/package.json
@@ -40,8 +40,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
     "@hapi/hapi": "20.1.3",
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -57,7 +61,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",
     "@types/hapi__hapi": "20.0.8"

diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json
@@ -43,7 +43,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/test-utils": "^0.20.0",
@@ -61,7 +65,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",
     "@types/ioredis": "4.26.4"

diff --git a/plugins/node/opentelemetry-instrumentation-koa/package.json b/plugins/node/opentelemetry-instrumentation-koa/package.json
@@ -42,8 +42,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
     "@koa/router": "9.4.0",
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -59,7 +63,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/core": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",

diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/package.json b/plugins/node/opentelemetry-instrumentation-mongodb/package.json
@@ -42,7 +42,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -58,7 +62,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",
     "@types/mongodb": "3.6.17"

diff --git a/plugins/node/opentelemetry-instrumentation-mysql/package.json b/plugins/node/opentelemetry-instrumentation-mysql/package.json
@@ -40,7 +40,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/context-async-hooks": "0.20.0",
     "@opentelemetry/test-utils": "^0.20.0",
     "@opentelemetry/tracing": "0.20.0",
@@ -56,7 +60,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0",
     "@types/mysql": "2.15.18"

diff --git a/plugins/node/opentelemetry-instrumentation-net/package.json b/plugins/node/opentelemetry-instrumentation-net/package.json
@@ -41,7 +41,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@opentelemetry/api": "^0.20.0"
+  },
   "devDependencies": {
+    "@opentelemetry/api": "0.20.0",
     "@opentelemetry/node": "0.20.0",
     "@opentelemetry/tracing": "0.20.0",
     "@types/mocha": "7.0.2",
@@ -57,7 +61,6 @@
     "typescript": "4.3.2"
   },
   "dependencies": {
-    "@opentelemetry/api": "^0.20.0",
     "@opentelemetry/instrumentation": "^0.20.0",
     "@opentelemetry/semantic-conventions": "^0.20.0"
   }