Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inherit core-tracing tsconfig.json from root #5320

Merged
merged 11 commits into from
Nov 20, 2019
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export class OpenCensusSpanWrapper implements Span {
* @param name The name of the event
* @param attributes The associated attributes to add for this event
*/
addEvent(name: string, attributes?: Attributes): this {
addEvent(_name: string, _attributes?: Attributes): this {
throw new Error("Method not implemented.");
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ export class OpenCensusTraceStateWrapper implements TraceState {
this._state = state;
}

get(key: string): string | undefined {
get(_key: string): string | undefined {
throw new Error("Method not implemented.");
}

set(key: string, value: string): void {
set(_key: string, _value: string): void {
throw new Error("Method not implemented.");
}

unset(key: string): void {
unset(_key: string): void {
throw new Error("Method not implemented");
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,27 +43,27 @@ export class OpenCensusTracerWrapper implements Tracer {

/**
* Executes the given function within the context provided by a Span.
* @param span The span that provides the context.
* @param fn The function to be executed.
* @param _span The span that provides the context.
* @param _fn The function to be executed.
*/
withSpan<T extends (...args: unknown[]) => unknown>(span: Span, fn: T): ReturnType<T> {
withSpan<T extends (...args: unknown[]) => unknown>(_span: Span, _fn: T): ReturnType<T> {
throw new Error("Method not implemented.");
}

/**
* Bind a Span as the target's scope
* @param target An object to bind the scope.
* @param span A specific Span to use. Otherwise, use the current one.
* @param _span A specific Span to use. Otherwise, use the current one.
*/
bind<T>(target: T, span?: Span): T {
bind<T>(_target: T, _span?: Span): T {
throw new Error("Method not implemented.");
}

/**
* Send a pre-populated Span object to the exporter.
* @param span The span to pass along.
* @param _span The span to pass along.
*/
recordSpanData(span: Span): void {
recordSpanData(_span: Span): void {
throw new Error("Method not implemented.");
}

Expand Down
6 changes: 4 additions & 2 deletions sdk/core/core-tracing/lib/tracers/test/testTracer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,14 @@ export class TestTracer extends NoOpTracer {

private _getParentContext(options: SpanOptions): SpanContext | undefined {
const parent = options.parent;
let result: SpanContext | undefined;
if (parent) {
if ("traceId" in parent) {
return parent;
result = parent;
} else {
return parent.context();
result = parent.context();
}
}
return result;
}
}
2 changes: 2 additions & 0 deletions sdk/core/core-tracing/lib/utils/browser.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
interface Window {}
declare var self: Window & typeof globalThis;
8 changes: 4 additions & 4 deletions sdk/core/core-tracing/review/core-tracing.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export { OpenCensusSpan }
export class OpenCensusSpanWrapper implements Span {
constructor(span: OpenCensusSpan);
constructor(tracer: OpenCensusTracerWrapper, name: string, options?: SpanOptions);
addEvent(name: string, attributes?: Attributes): this;
addEvent(_name: string, _attributes?: Attributes): this;
context(): SpanContext;
end(_endTime?: number): void;
getWrappedSpan(): OpenCensusSpan;
Expand All @@ -72,14 +72,14 @@ export { OpenCensusTracer }
// @public
export class OpenCensusTracerWrapper implements Tracer {
constructor(tracer: TracerBase);
bind<T>(target: T, span?: Span): T;
bind<T>(_target: T, _span?: Span): T;
getBinaryFormat(): BinaryFormat;
getCurrentSpan(): Span | null;
getHttpTextFormat(): HttpTextFormat;
getWrappedTracer(): TracerBase;
recordSpanData(span: Span): void;
recordSpanData(_span: Span): void;
startSpan(name: string, options?: SpanOptions): Span;
withSpan<T extends (...args: unknown[]) => unknown>(span: Span, fn: T): ReturnType<T>;
withSpan<T extends (...args: unknown[]) => unknown>(_span: Span, _fn: T): ReturnType<T>;
}

// @public
Expand Down
61 changes: 4 additions & 57 deletions sdk/core/core-tracing/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,61 +1,8 @@
{
"extends": "../../../tsconfig.package",
"compilerOptions": {
/* Basic Options */
"target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
"module": "es6" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
"declaration": true /* Generates corresponding '.d.ts' file. */,
"declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */,
"declarationDir": "./types" /* Output directory for generated declaration files.*/,
"sourceMap": true /* Generates corresponding '.map' file. */,
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist-esm" /* Redirect output structure to the directory. */,
// "rootDir": "." /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
// "composite": true, /* Enable project compilation */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
"importHelpers": true /* Import emit helpers from 'tslib'. */,
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
"moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [] /* List of root folders whose combined content represents the structure of the project at runtime. */,
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
"allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */,
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
"forceConsistentCasingInFileNames": true
"target": "es5",
"declarationDir": "./types",
"outDir": "./dist-esm"
}
}
72 changes: 17 additions & 55 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,59 +1,21 @@
{
"compilerOptions": {
/* Basic Options */
"target": "ES2015", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
"lib": ["es2017"], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
"importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
"strictNullChecks": true, /* Enable strict null checks. */
"strictFunctionTypes": true, /* Enable strict checking of function types. */
"strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
"noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
"alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
"noUnusedLocals": true, /* Report errors on unused locals. */
"noUnusedParameters": true, /* Report errors on unused parameters. */
"noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
"noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
"target": "ES2015",
"module": "commonjs",
"lib": [],
"declaration": true,
"declarationMap": true,
"sourceMap": true,
"importHelpers": true,
"strict": true,
"alwaysStrict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"forceConsistentCasingInFileNames": true,
"moduleResolution": "node",
"allowSyntheticDefaultImports": true,
"esModuleInterop": true
}
}
4 changes: 4 additions & 0 deletions tsconfig.package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to have both this and tsconfig.json next to each other? What's the behavior of just folding tsconfig.json and this together? Do we even need a tsconfig.json in the repo root or could we stash the base config away in /common?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that we have CI checks that do npm install on the root (I think for the management libs) and they use gulp... which breaks if we don't use commonjs as the target because ts-gulp doesn't support this right. It always needs a tsconfig.json in the root.

Maybe this is something we can take up with eng sys at some point.

"extends": "./tsconfig",
"module": "es6"
}