fix: avoid leaking winston types (#932)

The winston instrumentation needs the winston types only internaly.
Move them into an internal file to avoid leaking it to end user.

Author: Flarna

plugins/node/opentelemetry-instrumentation-winston/src/instrumentation.ts

@@ -29,13 +29,13 @@ import {
   isWrapped,
   safeExecuteInTheMiddle,
 } from '@opentelemetry/instrumentation';
-import {
-  WinstonInstrumentationConfig,
+import type { WinstonInstrumentationConfig } from './types';
+import type {
   Winston2LogMethod,
   Winston2LoggerModule,
   Winston3LogMethod,
   Winston3Logger,
-} from './types';
+} from './internal-types';
 import { VERSION } from './version';
 
 const winston3Versions = ['>=3 <4'];

plugins/node/opentelemetry-instrumentation-winston/src/internal-types.ts

@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+
+import type { Logger as Winston3Logger } from 'winston';
+import type {
+  LoggerInstance as Winston2Logger,
+  LogMethod as Winston2LogMethod,
+} from 'winston2';
+export type Winston3LogMethod = Winston3Logger['write'];
+export type { Winston3Logger };
+
+export type { Winston2LogMethod };
+export type Winston2LoggerModule = {
+  Logger: Winston2Logger & { prototype: { log: Winston2LogMethod } };
+};
+export type { Winston2Logger };

plugins/node/opentelemetry-instrumentation-winston/src/types.ts

@@ -16,24 +16,10 @@
 
 import { Span } from '@opentelemetry/api';
 import { InstrumentationConfig } from '@opentelemetry/instrumentation';
-import type { Logger as Winston3Logger } from 'winston';
-import type {
-  LoggerInstance as Winston2Logger,
-  LogMethod as Winston2LogMethod,
-} from 'winston2';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type LogHookFunction = (span: Span, record: Record<string, any>) => void;
 
 export interface WinstonInstrumentationConfig extends InstrumentationConfig {
   logHook?: LogHookFunction;
 }
-
-export type Winston3LogMethod = Winston3Logger['write'];
-export type { Winston3Logger };
-
-export type { Winston2LogMethod };
-export type Winston2LoggerModule = {
-  Logger: Winston2Logger & { prototype: { log: Winston2LogMethod } };
-};
-export type { Winston2Logger };

plugins/node/opentelemetry-instrumentation-winston/test/winston.test.ts

@@ -25,7 +25,7 @@ import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
 import * as assert from 'assert';
 import * as sinon from 'sinon';
 import { Writable } from 'stream';
-import type { Winston2Logger, Winston3Logger } from '../src/types';
+import type { Winston2Logger, Winston3Logger } from '../src/internal-types';
 import { WinstonInstrumentation } from '../src';
 
 const memoryExporter = new InMemorySpanExporter();