chore: add api to monorepo (open-telemetry#3261)

* Add API to lerna * Update todo * Expect instead of ignore error * Add webpack test context * Block scope test variables * Fix linting * Fix lining path * Fix lint * Fix lint * Update index-webpack.worker.ts Co-authored-by: Nev <[email protected]>
weyert · Sep 22, 2022 · c268832 · c268832
1 parent 6111ae0
commit c268832
Show file tree

Hide file tree

Showing 50 changed files with 282 additions and 49 deletions.
diff --git a/api/.eslintrc.js b/api/.eslintrc.js
@@ -0,0 +1,8 @@
+module.exports = {
+    "env": {
+        "mocha": true,
+        "commonjs": true,
+        "shared-node-browser": true
+    },
+    ...require('../eslint.config.js')
+}
diff --git a/api/TODO.md b/api/TODO.md
@@ -3,9 +3,9 @@
 These tasks must be completed before the API package can be released from this repository.
 
 - [x] remove files specific to the API git repo
-- [ ] add to lerna monorepo
-  - [ ] add tsconfig files
-  - [ ] add web testing
-  - [ ] build esm versions
+- [x] add to lerna monorepo
+  - [x] add tsconfig files
+  - [x] add web testing
+  - [x] build esm versions
 - [ ] test node versions 8, 10, and 12
-- [ ] add to auto published docs
+- [x] add to auto published docs
diff --git a/api/karma.conf.js b/api/karma.conf.js
@@ -0,0 +1,24 @@
+/*!
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const karmaWebpackConfig = require('../karma.webpack');
+const karmaBaseConfig = require('../karma.base');
+
+module.exports = (config) => {
+  config.set(Object.assign({}, karmaBaseConfig, {
+    webpack: karmaWebpackConfig,
+  }))
+};
diff --git a/api/karma.worker.js b/api/karma.worker.js
@@ -0,0 +1,24 @@
+/*!
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const karmaWebpackConfig = require('../karma.webpack');
+const karmaBaseConfig = require('../karma.worker');
+
+module.exports = (config) => {
+  config.set(Object.assign({}, karmaBaseConfig, {
+    webpack: karmaWebpackConfig,
+  }))
+};
diff --git a/api/package.json b/api/package.json
@@ -12,22 +12,25 @@
   },
   "repository": "https://github.com/open-telemetry/opentelemetry-js-api.git",
   "scripts": {
-    "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json",
-    "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p .",
-    "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p .",
-    "precompile": "npm run version",
+    "clean": "tsc --build --clean",
+    "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../",
+    "codecov:webworker": "nyc report --reporter=json && codecov -f coverage/*.json -p ../",
+    "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../",
+    "precompile": "lerna run version --scope $(npm pkg get name) --include-dependencies",
     "compile": "tsc --build tsconfig.json tsconfig.esm.json",
     "docs": "typedoc",
     "docs:deploy": "gh-pages --dist docs/out",
     "docs:test": "linkinator docs/out --silent && linkinator docs/*.md *.md --markdown --silent",
-    "lint:fix": "eslint src test --ext .ts --fix",
-    "lint": "eslint src test --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "lint": "eslint . --ext .ts",
     "test:browser": "nyc karma start --single-run",
     "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts",
+    "test:webworker": "nyc karma start karma.worker.js --single-run",
     "cycle-check": "dpdm --exit-code circular:1 src/index.ts",
-    "version": "node scripts/version-update.js",
-    "prewatch": "npm run version",
-    "watch": "tsc --build --watch"
+    "version": "node ../scripts/version-update.js",
+    "prewatch": "npm run precompile",
+    "watch": "tsc --build --watch",
+    "peer-api-check": "node ../scripts/peer-api-check.js"
   },
   "keywords": [
     "opentelemetry",
@@ -57,34 +60,27 @@
     "access": "public"
   },
   "devDependencies": {
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
-    "@types/sinon": "10.0.2",
-    "@types/webpack-env": "1.16.0",
-    "@typescript-eslint/eslint-plugin": "5.0.0",
-    "@typescript-eslint/parser": "5.0.0",
-    "codecov": "3.8.2",
-    "dpdm": "3.7.1",
-    "eslint": "7.32.0",
-    "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-node": "11.1.0",
-    "gh-pages": "3.2.0",
+    "@types/mocha": "9.1.1",
+    "@types/node": "18.6.5",
+    "@types/sinon": "10.0.13",
+    "@types/webpack-env": "1.16.3",
+    "codecov": "3.8.3",
+    "dpdm": "3.10.0",
     "istanbul-instrumenter-loader": "3.0.1",
-    "karma": "5.2.3",
+    "karma": "6.3.16",
     "karma-chrome-launcher": "3.1.0",
     "karma-coverage-istanbul-reporter": "3.0.3",
     "karma-mocha": "2.0.1",
+    "karma-mocha-webworker": "1.3.0",
     "karma-spec-reporter": "0.0.32",
     "karma-webpack": "4.0.2",
-    "lerna-changelog": "1.0.1",
-    "linkinator": "2.13.6",
-    "mocha": "7.2.0",
+    "mocha": "10.0.0",
     "nyc": "15.1.0",
-    "sinon": "11.1.1",
-    "ts-loader": "8.2.0",
-    "ts-mocha": "8.0.0",
-    "typedoc": "0.21.2",
-    "typescript": "4.3.5",
+    "sinon": "14.0.0",
+    "ts-loader": "8.4.0",
+    "ts-mocha": "10.0.0",
+    "typescript": "4.4.4",
     "webpack": "4.46.0"
-  }
+  },
+  "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/api"
 }
diff --git a/api/src/platform/browser/globalThis.ts b/api/src/platform/browser/globalThis.ts
@@ -29,7 +29,7 @@
 // eslint-disable-next-line node/no-unsupported-features/es-builtins, no-undef
 export const _globalThis: typeof globalThis =
   typeof globalThis === 'object' ? globalThis :
-  typeof self === 'object' ? self :
-  typeof window === 'object' ? window :
-  typeof global === 'object' ? global :
+    typeof self === 'object' ? self :
+      typeof window === 'object' ? window :
+        typeof global === 'object' ? global :
   {} as typeof globalThis;
diff --git a/api/src/trace/NoopTracer.ts b/api/src/trace/NoopTracer.ts
@@ -24,7 +24,7 @@ import { SpanOptions } from './SpanOptions';
 import { SpanContext } from './span_context';
 import { Tracer } from './tracer';
 
-const context = ContextAPI.getInstance();
+const contextApi = ContextAPI.getInstance();
 
 /**
  * No-op implementations of {@link Tracer}.
@@ -87,11 +87,11 @@ export class NoopTracer implements Tracer {
       fn = arg4 as F;
     }
 
-    const parentContext = ctx ?? context.active();
+    const parentContext = ctx ?? contextApi.active();
     const span = this.startSpan(name, opts, parentContext);
     const contextWithSpanSet = setSpan(parentContext, span);
 
-    return context.with(contextWithSpanSet, fn, undefined, span);
+    return contextApi.with(contextWithSpanSet, fn, undefined, span);
   }
 }
 

diff --git a/api/test/api/api.test.ts b/api/test/api/api.test.ts
@@ -56,7 +56,7 @@ describe('API', () => {
     const span = new NonRecordingSpan();
     const ctx = trace.setSpan(ROOT_CONTEXT, span);
     context.setGlobalContextManager({ active: () => ctx, disable: () => {} } as any);
-    
+
     const active = trace.getActiveSpan();
     assert.strictEqual(active, span);
 

diff --git a/api/test/diag/consoleLogger.test.ts b/api/test/diag/consoleLogger.test.ts
@@ -27,14 +27,14 @@ export const diagLoggerFunctions = [
   'error',
 ] as const;
 
-const consoleFuncs: Array<keyof Console> = [
+const consoleFuncs = [
   'debug',
   'info',
   'warn',
   'error',
   'log',
   'trace',
-];
+] as const;
 
 const expectedConsoleMap: { [n: string]: keyof Console } = {
   error: 'error',
@@ -127,6 +127,7 @@ describe('DiagConsoleLogger', () => {
 
       consoleFuncs.forEach(cName => {
         it(`should log ${fName} message even when console doesn't support ${cName} call before construction`, () => {
+          // @ts-expect-error removing a console property is not allowed by types
           console[cName] = undefined;
           const consoleLogger: any = new DiagConsoleLogger();
           consoleLogger[fName](`${fName} called %s`, 'param1');
@@ -142,6 +143,7 @@ describe('DiagConsoleLogger', () => {
 
         it(`should log ${fName} message even when console doesn't support ${cName} call after construction`, () => {
           const consoleLogger: any = new DiagConsoleLogger();
+          // @ts-expect-error removing a console property is not allowed by types
           console[cName] = undefined;
           consoleLogger[fName](`${fName} called %s`, 'param1');
           if (cName !== expectedConsoleMap[fName]) {

diff --git a/api/test/index-webpack.ts b/api/test/index-webpack.ts
@@ -13,8 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const testsContext = require.context('.', true, /test$/);
-testsContext.keys().forEach(testsContext);
+{
+  const testsContext = require.context('.', true, /test$/);
+  testsContext.keys().forEach(testsContext);
+}
 
-const srcContext = require.context('.', true, /src$/);
-srcContext.keys().forEach(srcContext);
+{
+  const srcContext = require.context('.', true, /src$/);
+  srcContext.keys().forEach(srcContext);
+}
diff --git a/api/test/index-webpack.worker.ts b/api/test/index-webpack.worker.ts
@@ -0,0 +1,19 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+{
+  const testsContext = require.context('./', true, /test$/);
+  testsContext.keys().forEach(testsContext);
+}
diff --git a/api/tsconfig.all.json b/api/tsconfig.all.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig.base.json",
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.json" },
+    { "path": "./tsconfig.esm.json" },
+    { "path": "./tsconfig.esnext.json" }
+  ]
+}
diff --git a/api/tsconfig.esm.json b/api/tsconfig.esm.json
@@ -0,0 +1,11 @@
+{
+  "extends": "../tsconfig.base.esm.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build/esm",
+    "tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo"
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}
diff --git a/api/tsconfig.esnext.json b/api/tsconfig.esnext.json
@@ -0,0 +1,11 @@
+{
+  "extends": "../tsconfig.base.esnext.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build/esnext",
+    "tsBuildInfoFile": "build/esnext/tsconfig.esnext.tsbuildinfo"
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}
diff --git a/api/tsconfig.json b/api/tsconfig.json
@@ -0,0 +1,13 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "build"
+  },
+  "include": [
+    "src/**/*.ts",
+    "test/**/*.ts"
+  ],
+  "references": [
+  ]
+}
diff --git a/experimental/packages/api-logs/tsconfig.json b/experimental/packages/api-logs/tsconfig.json
@@ -7,5 +7,10 @@
   "include": [
     "src/**/*.ts",
     "test/**/*.ts"
+  ],
+  "references": [
+    {
+      "path": "../../../api"
+    }
   ]
 }
diff --git a/experimental/packages/exporter-trace-otlp-grpc/tsconfig.json b/experimental/packages/exporter-trace-otlp-grpc/tsconfig.json
@@ -9,6 +9,9 @@
     "test/**/*.ts"
   ],
   "references": [
+    {
+      "path": "../../../api"
+    },
     {
       "path": "../../../packages/opentelemetry-core"
     },

diff --git a/experimental/packages/exporter-trace-otlp-http/tsconfig.json b/experimental/packages/exporter-trace-otlp-http/tsconfig.json
@@ -9,6 +9,9 @@
     "test/**/*.ts"
   ],
   "references": [
+    {
+      "path": "../../../api"
+    },
     {
       "path": "../../../packages/opentelemetry-core"
     },

diff --git a/experimental/packages/exporter-trace-otlp-proto/tsconfig.json b/experimental/packages/exporter-trace-otlp-proto/tsconfig.json
@@ -9,6 +9,9 @@
     "test/**/*.ts"
   ],
   "references": [
+    {
+      "path": "../../../api"
+    },
     {
       "path": "../../../packages/opentelemetry-core"
     },

diff --git a/experimental/packages/opentelemetry-api-metrics/tsconfig.json b/experimental/packages/opentelemetry-api-metrics/tsconfig.json
@@ -7,5 +7,10 @@
   "include": [
     "src/**/*.ts",
     "test/**/*.ts"
+  ],
+  "references": [
+    {
+      "path": "../../../api"
+    }
   ]
 }
diff --git a/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/tsconfig.json b/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/tsconfig.json
@@ -9,6 +9,9 @@
     "test/**/*.ts"
   ],
   "references": [
+    {
+      "path": "../../../api"
+    },
     {
       "path": "../../../packages/opentelemetry-core"
     },

diff --git a/experimental/packages/opentelemetry-exporter-metrics-otlp-http/tsconfig.json b/experimental/packages/opentelemetry-exporter-metrics-otlp-http/tsconfig.json
@@ -9,6 +9,9 @@
     "test/**/*.ts"
   ],
   "references": [
+    {
+      "path": "../../../api"
+    },
     {
       "path": "../../../packages/opentelemetry-core"
     },