Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 51 additions & 16 deletions web/packages/teleterm/src/services/logger/loggerService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ import split2 from 'split2';
import { Logger, LoggerService, NodeLoggerService } from './types';
import { KeepLastChunks } from './keepLastChunks';

import type { Logform } from 'winston';

import type { ChildProcess } from 'node:child_process';

/**
Expand Down Expand Up @@ -95,22 +97,12 @@ export function createFileLoggerService(
});

if (opts.dev) {
instance.add(
new transports.Console({
format: format.printf(({ level, message, context }) => {
const loggerName =
opts.loggerNameColor &&
`\x1b[${opts.loggerNameColor}m${opts.name.toUpperCase()}\x1b[0m`;

const text = stringifier(message as unknown as unknown[]);
const logMessage = opts.passThroughMode
? text
: `[${context}] ${level}: ${text}`;

return [loggerName, logMessage].filter(Boolean).join(' ');
}),
})
);
// Browser environment.
if (typeof window !== 'undefined') {
instance.add(getBrowserConsoleTransport(opts));
} else {
instance.add(getRegularConsoleTransport(opts));
}
}

return {
Expand Down Expand Up @@ -217,3 +209,46 @@ type FileLoggerOptions = {
* */
omitTimestamp?: boolean;
};

/** Does not stringify messages and logs directly using `console.*` functions. */
function getBrowserConsoleTransport(opts: FileLoggerOptions) {
return new transports.Console({
log({ level, message, context }: Logform.TransformableInfo, next) {
const loggerName = getLoggerName(opts);

const logMessage = opts.passThroughMode
? message
: [`[${context}] ${level}:`, ...message];

const toLog = [loggerName, logMessage].filter(Boolean).flat();
// We allow level to be only info, warn and error (createLoggerFromWinston).
console[level](...toLog);
next();
},
});
}

/** Stringifies log messages and logs with winston's console transport. */
function getRegularConsoleTransport(opts: FileLoggerOptions) {
return new transports.Console({
format: format.printf(({ level, message, context }) => {
const loggerName = getLoggerName(opts);

const text = stringifier(message as unknown as unknown[]);
const logMessage = opts.passThroughMode
? text
: `[${context}] ${level}: ${text}`;

return [loggerName, logMessage].filter(Boolean).join(' ');
}),
});
}

function getLoggerName(
opts: Pick<FileLoggerOptions, 'loggerNameColor' | 'name'>
) {
return (
opts.loggerNameColor &&
`\x1b[${opts.loggerNameColor}m${opts.name.toUpperCase()}\x1b[0m`
);
}
4 changes: 2 additions & 2 deletions web/packages/teleterm/src/services/tshd/interceptors.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ it('do not log sensitive info like password', () => {
service: { typeName: 'FooService' } as ServiceInfo,
} as MethodInfo,
{
passw: {},
password: {},
userData: {
login: 'admin',
password: 'admin',
Expand All @@ -50,7 +50,7 @@ it('do not log sensitive info like password', () => {
);

expect(infoLogger).toHaveBeenCalledWith(expect.any(String), {
passw: '~FILTERED~',
password: '~FILTERED~',
userData: { login: 'admin', password: '~FILTERED~' },
});
});
Expand Down
4 changes: 2 additions & 2 deletions web/packages/teleterm/src/services/tshd/interceptors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { isObject } from 'shared/utils/highbar';

import Logger from 'teleterm/logger';

const SENSITIVE_PROPERTIES = ['passw', 'authClusterId', 'pin'];
const SENSITIVE_PROPERTIES = ['password', 'authClusterId', 'pin'];

export function loggingInterceptor(logger: Logger): RpcInterceptor {
return {
Expand Down Expand Up @@ -109,7 +109,7 @@ export function filterSensitiveProperties(toFilter: object): object {
const transformer = (result: object, value: any, key: any) => {
if (
SENSITIVE_PROPERTIES.some(
sensitiveProp => typeof key === 'string' && key.includes(sensitiveProp)
sensitiveProp => typeof key === 'string' && key === sensitiveProp
)
) {
result[key] = '~FILTERED~';
Expand Down