8000 feat(api-logs)!: Marked private methods as "conventionally private". … · open-telemetry/opentelemetry-js@549e0a6 · GitHub
[go: up one dir, main page]
Skip to content

Commit 549e0a6

Browse files
svetlanabrennansvetlanabrennan
authored
feat(api-logs)!: Marked private methods as "conventionally private". (#5789)
1 parent bd3f265 commit 549e0a6

File tree

7 files changed

+25
-13
lines changed

7 files changed

+25
-13
lines changed

‎experimental/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
88

99
### :boom: Breaking Changes
1010

11+
* feat(api-logs)!: Marked private methods as "conventionally private". [#5789](https://github.com/open-telemetry/opentelemetry-js/pull/5789)
12+
1113
### :rocket: Features
1214

1315
### :bug: Bug Fixes

‎experimental/packages/api-logs/src/ProxyLogger.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export class ProxyLogger implements Logger {
4747
if (this._delegate) {
4848
return this._delegate;
4949
}
50-
const logger = this._provider.getDelegateLogger(
50+
const logger = this._provider._getDelegateLogger(
5151
this.name,
5252
this.version,
5353
this.options
@@ -61,7 +61,7 @@ export class ProxyLogger implements Logger {
6161
}
6262

6363
export interface LoggerDelegator {
64-
getDelegateLogger(
64+
_getDelegateLogger(
6565
name: string,
6666
version?: string,
6767
options?: LoggerOptions

‎experimental/packages/api-logs/src/ProxyLoggerProvider.ts‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,32 @@ export class ProxyLoggerProvider implements LoggerProvider {
2929
options?: LoggerOptions | undefined
3030
): Logger {
3131
return (
32-
this.getDelegateLogger(name, version, options) ??
32+
this._getDelegateLogger(name, version, options) ??
3333
new ProxyLogger(this, name, version, options)
3434
);
3535
}
3636

37-
getDelegate(): LoggerProvider {
37+
/**
38+
* Get the delegate logger provider.
39+
* Used by tests only.
40+
* @internal
41+
*/
42+
_getDelegate(): LoggerProvider {
3843
return this._delegate ?? NOOP_LOGGER_PROVIDER;
3944
}
4045

4146
/**
4247
* Set the delegate logger provider
48+
* @internal
4349
*/
44-
setDelegate(delegate: LoggerProvider) {
50+
_setDelegate(delegate: LoggerProvider) {
4551
this._delegate = delegate;
4652
}
4753

48-
getDelegateLogger(
54+
/**
55+
* @internal
56+
*/
57+
_getDelegateLogger(
4958
name: string,
5059
version?: string | undefined,
5160
options?: LoggerOptions | undefined

‎experimental/packages/api-logs/src/api/logs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export class LogsAPI {
5151
provider,
5252
NOOP_LOGGER_PROVIDER
5353
);
54-
this._proxyLoggerProvider.setDelegate(provider);
54+
this._proxyLoggerProvider._setDelegate(provider);
5555

5656
return provider;
5757
}

‎experimental/packages/api-logs/test/api/api.test.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ describe('API', () => {
2525
it('should expose a logger provider via getLoggerProvider', () => {
2626
assert.ok(logs.getLoggerProvider() instanceof ProxyLoggerProvider);
2727
assert.ok(
28-
(logs.getLoggerProvider() as ProxyLoggerProvider).getDelegate() instanceof
29-
NoopLoggerProvider
28+
(
29+
logs.getLoggerProvider() as ProxyLoggerProvider
30+
)._getDelegate() instanceof NoopLoggerProvider
3031
);
3132
});
3233

‎experimental/packages/api-logs/test/proxy-implementations/proxy-logger.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ describe('ProxyLogger', () => {
5252
delegate = {
5353
getLogger: getLoggerStub,
5454
};
55-
provider.setDelegate(delegate);
55+
provider._setDelegate(delegate);
5656
});
5757

5858
it('should return loggers directly from the delegate', () => {
@@ -104,7 +104,7 @@ describe('ProxyLogger', () => {
104104
return delegateLogger;
105105
},
106106
};
107-
provider.setDelegate(delegateProvider);
107+
provider._setDelegate(delegateProvider);
108108
});
109109

110110
it('should emit from the delegate logger', () => {

‎experimental/packages/opentelemetry-sdk-node/test/sdk.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ describe('Node SDK', () => {
105105
delegate = (trace.getTracerProvider() as ProxyTracerProvider).getDelegate();
106106
logsDelegate = (
107107
logs.getLoggerProvider() as ProxyLoggerProvider
108-
).getDelegate();
108+
)._getDelegate();
109109
});
110110

111111
afterEach(() => {
@@ -142,7 +142,7 @@ describe('Node SDK', () => {
142142
);
143143
assert.ok(!(metrics.getMeterProvider() instanceof MeterProvider));
144144
assert.strictEqual(
145-
(logs.getLoggerProvider() as ProxyLoggerProvider).getDelegate(),
145+
(logs.getLoggerProvider() as ProxyLoggerProvider)._getDelegate(),
146146
logsDelegate,
147147
'logger provider should not have changed'
148148
);

0 commit comments

Comments
 (0)
0