open-telemetry
/
opentelemetry-js
mirror of https://github.com/open-telemetry/opentelemetry-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: add api to monorepo (#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 <54870357+MSNev@users.noreply.github.com>
This commit is contained in:
Daniel Dyla 2022-09-22 05:29:00 -04:00 committed by GitHub
parent 6111ae0181
commit c268832689
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
50 changed files with 282 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/.eslintrc.js Normal file
View File

@ -0,0 +1,8 @@
module.exports = {
"env": {
"mocha": true,
"commonjs": true,
"shared-node-browser": true
},
...require('../eslint.config.js')
}

10
api/TODO.md
View File

@ -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

24
api/karma.conf.js Normal file
View File

@ -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,
}))
};

24
api/karma.worker.js Normal file
View File

@ -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,
}))
};

58
api/package.json
View File

@ -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"
}

6
api/src/platform/browser/globalThis.ts
View File

@ -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;

6
api/src/trace/NoopTracer.ts
View File

@ -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);
}
}

2
api/test/api/api.test.ts
View File

@ -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);

6
api/test/diag/consoleLogger.test.ts
View File

@ -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]) {

12
api/test/index-webpack.ts
View File

@ -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);
}

19
api/test/index-webpack.worker.ts Normal file
View File

@ -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);
}

9
api/tsconfig.all.json Normal file
View File

@ -0,0 +1,9 @@
{
"extends": "../tsconfig.base.json",
"files": [],
"references": [
{ "path": "./tsconfig.json" },
{ "path": "./tsconfig.esm.json" },
{ "path": "./tsconfig.esnext.json" }
]
}

11
api/tsconfig.esm.json Normal file
View File

@ -0,0 +1,11 @@
{
"extends": "../tsconfig.base.esm.json",
"compilerOptions": {
"rootDir": "src",
"outDir": "build/esm",
"tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo"
},
"include": [
"src/**/*.ts"
]
}

11
api/tsconfig.esnext.json Normal file
View File

@ -0,0 +1,11 @@
{
"extends": "../tsconfig.base.esnext.json",
"compilerOptions": {
"rootDir": "src",
"outDir": "build/esnext",
"tsBuildInfoFile": "build/esnext/tsconfig.esnext.tsbuildinfo"
},
"include": [
"src/**/*.ts"
]
}

13
api/tsconfig.json Normal file
View File

@ -0,0 +1,13 @@
{
"extends": "../tsconfig.base.json",
"compilerOptions": {
"rootDir": ".",
"outDir": "build"
},
"include": [
"src/**/*.ts",
"test/**/*.ts"
],
"references": [
]
}

5
experimental/packages/api-logs/tsconfig.json
View File

@ -7,5 +7,10 @@
"include": [
"src/**/*.ts",
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
}
]
}

3
experimental/packages/exporter-trace-otlp-grpc/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/exporter-trace-otlp-http/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/exporter-trace-otlp-proto/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

5
experimental/packages/opentelemetry-api-metrics/tsconfig.json
View File

@ -7,5 +7,10 @@
"include": [
"src/**/*.ts",
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
}
]
}

3
experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/opentelemetry-exporter-metrics-otlp-http/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/opentelemetry-exporter-metrics-otlp-proto/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/opentelemetry-exporter-prometheus/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/opentelemetry-instrumentation-fetch/tsconfig.json
View File

@ -10,6 +10,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-context-zone"
},

3
experimental/packages/opentelemetry-instrumentation-grpc/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-context-async-hooks"
},

3
experimental/packages/opentelemetry-instrumentation-http/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-context-async-hooks"
},

3
experimental/packages/opentelemetry-instrumentation-xml-http-request/tsconfig.json
View File

@ -10,6 +10,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-context-zone"
},

3
experimental/packages/opentelemetry-instrumentation/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../opentelemetry-api-metrics"
}

3
experimental/packages/opentelemetry-sdk-metrics/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/opentelemetry-sdk-node/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-context-async-hooks"
},

3
experimental/packages/otlp-exporter-base/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
}

3
experimental/packages/otlp-grpc-exporter-base/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/otlp-proto-exporter-base/tsconfig.json
View File

@ -11,6 +11,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
experimental/packages/otlp-transformer/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../../api"
},
{
"path": "../../../packages/opentelemetry-core"
},

3
integration-tests/propagation-validation-server/tsconfig.json
View File

@ -6,6 +6,9 @@
},
"include": [],
"references": [
{
"path": "../../api"
},
{
"path": "../../packages/opentelemetry-context-async-hooks"
},

1
lerna.json
View File

@ -2,6 +2,7 @@
"version": "independent",
"npmClient": "npm",
"packages": [
"api",
"packages/*",
"experimental/packages/*",
"experimental/backwards-compatability/*",

5
packages/opentelemetry-context-async-hooks/tsconfig.json
View File

@ -7,5 +7,10 @@
"include": [
"src/**/*.ts",
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
}
]
}

5
packages/opentelemetry-context-zone-peer-dep/tsconfig.json
View File

@ -11,5 +11,10 @@
"include": [
"src/**/*.ts",
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
}
]
}

3
packages/opentelemetry-core/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-semantic-conventions"
}

3
packages/opentelemetry-exporter-jaeger/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-core"
},

3
packages/opentelemetry-exporter-zipkin/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-core"
},

3
packages/opentelemetry-propagator-b3/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-core"
}

3
packages/opentelemetry-propagator-jaeger/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-core"
}

3
packages/opentelemetry-resources/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-core"
},

3
packages/opentelemetry-sdk-trace-base/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-core"
},

3
packages/opentelemetry-sdk-trace-node/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-context-async-hooks"
},

3
packages/opentelemetry-sdk-trace-web/tsconfig.json
View File

@ -10,6 +10,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-context-zone"
},

3
packages/opentelemetry-shim-opentracing/tsconfig.json
View File

@ -9,6 +9,9 @@
"test/**/*.ts"
],
"references": [
{
"path": "../../api"
},
{
"path": "../opentelemetry-core"
},

4
tsconfig.json
View File

@ -4,6 +4,7 @@
"typedocOptions": {
"entryPointStrategy": "packages",
"entryPoints": [
"api",
"experimental/packages/exporter-trace-otlp-grpc",
"experimental/packages/exporter-trace-otlp-http",
"experimental/packages/exporter-trace-otlp-proto",
@ -49,6 +50,9 @@
"excludePrivate": true
},
"references": [
{
"path": "api"
},
{
"path": "packages/opentelemetry-context-async-hooks"
},