mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
feat: Remove meta parameter from logging.
This commit is contained in:
parent
ce5a98b16f
commit
2c6167e0cb
@ -28,8 +28,9 @@ export class SparqlUpdateBodyParser extends BodyParser {
|
|||||||
try {
|
try {
|
||||||
algebra = translate(sparql, { quads: true, baseIRI: metadata.identifier.value }) as Algebra.Update;
|
algebra = translate(sparql, { quads: true, baseIRI: metadata.identifier.value }) as Algebra.Update;
|
||||||
} catch (error: unknown) {
|
} catch (error: unknown) {
|
||||||
this.logger.warn('Could not translate SPARQL query to SPARQL algebra', { error });
|
const message = createErrorMessage(error);
|
||||||
throw new BadRequestHttpError(createErrorMessage(error), { cause: error });
|
this.logger.warn(`Could not translate SPARQL query to SPARQL algebra: ${message}`);
|
||||||
|
throw new BadRequestHttpError(message, { cause: error });
|
||||||
}
|
}
|
||||||
|
|
||||||
// Prevent body from being requested again
|
// Prevent body from being requested again
|
||||||
|
@ -20,10 +20,10 @@ export class LazyLogger extends Logger {
|
|||||||
this.label = label;
|
this.label = label;
|
||||||
}
|
}
|
||||||
|
|
||||||
public log(level: LogLevel, message: string, meta: any): Logger {
|
public log(level: LogLevel, message: string): Logger {
|
||||||
if (!this.logger) {
|
if (!this.logger) {
|
||||||
this.logger = this.lazyLoggerFactory.loggerFactory.createLogger(this.label);
|
this.logger = this.lazyLoggerFactory.loggerFactory.createLogger(this.label);
|
||||||
}
|
}
|
||||||
return this.logger.log(level, message, meta);
|
return this.logger.log(level, message);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -13,15 +13,15 @@ export abstract class Logger {
|
|||||||
* @param message - The message to log.
|
* @param message - The message to log.
|
||||||
* @param meta - Optional metadata to include in the log message.
|
* @param meta - Optional metadata to include in the log message.
|
||||||
*/
|
*/
|
||||||
public abstract log(level: LogLevel, message: string, meta?: any): Logger;
|
public abstract log(level: LogLevel, message: string): Logger;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Log a message at the 'error' level.
|
* Log a message at the 'error' level.
|
||||||
* @param message - The message to log.
|
* @param message - The message to log.
|
||||||
* @param meta - Optional metadata to include in the log message.
|
* @param meta - Optional metadata to include in the log message.
|
||||||
*/
|
*/
|
||||||
public error(message: string, meta?: any): Logger {
|
public error(message: string): Logger {
|
||||||
return this.log('error', message, meta);
|
return this.log('error', message);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -29,8 +29,8 @@ export abstract class Logger {
|
|||||||
* @param message - The message to log.
|
* @param message - The message to log.
|
||||||
* @param meta - Optional metadata to include in the log message.
|
* @param meta - Optional metadata to include in the log message.
|
||||||
*/
|
*/
|
||||||
public warn(message: string, meta?: any): Logger {
|
public warn(message: string): Logger {
|
||||||
return this.log('warn', message, meta);
|
return this.log('warn', message);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -38,8 +38,8 @@ export abstract class Logger {
|
|||||||
* @param message - The message to log.
|
* @param message - The message to log.
|
||||||
* @param meta - Optional metadata to include in the log message.
|
* @param meta - Optional metadata to include in the log message.
|
||||||
*/
|
*/
|
||||||
public info(message: string, meta?: any): Logger {
|
public info(message: string): Logger {
|
||||||
return this.log('info', message, meta);
|
return this.log('info', message);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -47,8 +47,8 @@ export abstract class Logger {
|
|||||||
* @param message - The message to log.
|
* @param message - The message to log.
|
||||||
* @param meta - Optional metadata to include in the log message.
|
* @param meta - Optional metadata to include in the log message.
|
||||||
*/
|
*/
|
||||||
public verbose(message: string, meta?: any): Logger {
|
public verbose(message: string): Logger {
|
||||||
return this.log('verbose', message, meta);
|
return this.log('verbose', message);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -56,8 +56,8 @@ export abstract class Logger {
|
|||||||
* @param message - The message to log.
|
* @param message - The message to log.
|
||||||
* @param meta - Optional metadata to include in the log message.
|
* @param meta - Optional metadata to include in the log message.
|
||||||
*/
|
*/
|
||||||
public debug(message: string, meta?: any): Logger {
|
public debug(message: string): Logger {
|
||||||
return this.log('debug', message, meta);
|
return this.log('debug', message);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -65,7 +65,7 @@ export abstract class Logger {
|
|||||||
* @param message - The message to log.
|
* @param message - The message to log.
|
||||||
* @param meta - Optional metadata to include in the log message.
|
* @param meta - Optional metadata to include in the log message.
|
||||||
*/
|
*/
|
||||||
public silly(message: string, meta?: any): Logger {
|
public silly(message: string): Logger {
|
||||||
return this.log('silly', message, meta);
|
return this.log('silly', message);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -118,7 +118,7 @@ export class StaticAssetHandler extends HttpHandler {
|
|||||||
reject(new NotFoundHttpError(`Cannot find ${request.url}`));
|
reject(new NotFoundHttpError(`Cannot find ${request.url}`));
|
||||||
// In other cases, we might already have started writing, so just hang up
|
// In other cases, we might already have started writing, so just hang up
|
||||||
} else {
|
} else {
|
||||||
this.logger.warn(`Error reading asset ${filePath}: ${error.message}`, { error });
|
this.logger.warn(`Error reading asset ${filePath}: ${error.message}`);
|
||||||
response.end();
|
response.end();
|
||||||
asset.destroy();
|
asset.destroy();
|
||||||
resolve();
|
resolve();
|
||||||
|
@ -41,8 +41,7 @@ function guardingErrorListener(this: Guarded, error: Error): void {
|
|||||||
this[guardedErrors].push(error);
|
this[guardedErrors].push(error);
|
||||||
if (!this[guardedTimeout]) {
|
if (!this[guardedTimeout]) {
|
||||||
this[guardedTimeout] = setTimeout((): void => {
|
this[guardedTimeout] = setTimeout((): void => {
|
||||||
const message = `No error listener was attached but error was thrown: ${error.message}`;
|
logger.error(`No error listener was attached but error was thrown: ${error.message}`);
|
||||||
logger.error(message, { error });
|
|
||||||
}, 1000);
|
}, 1000);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -24,11 +24,11 @@ describe('LazyLogger', (): void => {
|
|||||||
};
|
};
|
||||||
lazyLoggerFactory.loggerFactory = dummyLoggerFactory;
|
lazyLoggerFactory.loggerFactory = dummyLoggerFactory;
|
||||||
|
|
||||||
expect(logger.log('debug', 'my message', { abc: true })).toBe(dummyLogger);
|
expect(logger.log('debug', 'my message')).toBe(dummyLogger);
|
||||||
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledTimes(1);
|
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledTimes(1);
|
||||||
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledWith('MyLabel');
|
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledWith('MyLabel');
|
||||||
expect(dummyLogger.log).toHaveBeenCalledTimes(1);
|
expect(dummyLogger.log).toHaveBeenCalledTimes(1);
|
||||||
expect(dummyLogger.log).toHaveBeenCalledWith('debug', 'my message', { abc: true });
|
expect(dummyLogger.log).toHaveBeenCalledWith('debug', 'my message');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('reuses the logger for repeated calls.', async(): Promise<void> => {
|
it('reuses the logger for repeated calls.', async(): Promise<void> => {
|
||||||
@ -40,14 +40,14 @@ describe('LazyLogger', (): void => {
|
|||||||
};
|
};
|
||||||
lazyLoggerFactory.loggerFactory = dummyLoggerFactory;
|
lazyLoggerFactory.loggerFactory = dummyLoggerFactory;
|
||||||
|
|
||||||
expect(logger.log('debug', 'my message 1', { abc: true })).toBe(dummyLogger);
|
expect(logger.log('debug', 'my message 1')).toBe(dummyLogger);
|
||||||
expect(logger.log('debug', 'my message 2', { abc: true })).toBe(dummyLogger);
|
expect(logger.log('debug', 'my message 2')).toBe(dummyLogger);
|
||||||
expect(logger.log('debug', 'my message 3', { abc: true })).toBe(dummyLogger);
|
expect(logger.log('debug', 'my message 3')).toBe(dummyLogger);
|
||||||
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledTimes(1);
|
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledTimes(1);
|
||||||
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledWith('MyLabel');
|
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledWith('MyLabel');
|
||||||
expect(dummyLogger.log).toHaveBeenCalledTimes(3);
|
expect(dummyLogger.log).toHaveBeenCalledTimes(3);
|
||||||
expect(dummyLogger.log).toHaveBeenNthCalledWith(1, 'debug', 'my message 1', { abc: true });
|
expect(dummyLogger.log).toHaveBeenNthCalledWith(1, 'debug', 'my message 1');
|
||||||
expect(dummyLogger.log).toHaveBeenNthCalledWith(2, 'debug', 'my message 2', { abc: true });
|
expect(dummyLogger.log).toHaveBeenNthCalledWith(2, 'debug', 'my message 2');
|
||||||
expect(dummyLogger.log).toHaveBeenNthCalledWith(3, 'debug', 'my message 3', { abc: true });
|
expect(dummyLogger.log).toHaveBeenNthCalledWith(3, 'debug', 'my message 3');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
@ -2,45 +2,43 @@ import { Logger } from '../../../src/logging/Logger';
|
|||||||
|
|
||||||
describe('Logger', (): void => {
|
describe('Logger', (): void => {
|
||||||
let logger: Logger;
|
let logger: Logger;
|
||||||
let meta: any;
|
|
||||||
beforeEach(async(): Promise<void> => {
|
beforeEach(async(): Promise<void> => {
|
||||||
logger = new (Logger as any)();
|
logger = new (Logger as any)();
|
||||||
logger.log = jest.fn();
|
logger.log = jest.fn();
|
||||||
meta = { abc: 123 };
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it('Error delegates to log.', async(): Promise<void> => {
|
it('Error delegates to log.', async(): Promise<void> => {
|
||||||
logger.error('my message', meta);
|
logger.error('my message');
|
||||||
expect(logger.log).toHaveBeenCalledTimes(1);
|
expect(logger.log).toHaveBeenCalledTimes(1);
|
||||||
expect(logger.log).toHaveBeenCalledWith('error', 'my message', meta);
|
expect(logger.log).toHaveBeenCalledWith('error', 'my message');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('Warn delegates to log.', async(): Promise<void> => {
|
it('Warn delegates to log.', async(): Promise<void> => {
|
||||||
logger.warn('my message', meta);
|
logger.warn('my message');
|
||||||
expect(logger.log).toHaveBeenCalledTimes(1);
|
expect(logger.log).toHaveBeenCalledTimes(1);
|
||||||
expect(logger.log).toHaveBeenCalledWith('warn', 'my message', meta);
|
expect(logger.log).toHaveBeenCalledWith('warn', 'my message');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('Info delegates to log.', async(): Promise<void> => {
|
it('Info delegates to log.', async(): Promise<void> => {
|
||||||
logger.info('my message', meta);
|
logger.info('my message');
|
||||||
expect(logger.log).toHaveBeenCalledTimes(1);
|
expect(logger.log).toHaveBeenCalledTimes(1);
|
||||||
expect(logger.log).toHaveBeenCalledWith('info', 'my message', meta);
|
expect(logger.log).toHaveBeenCalledWith('info', 'my message');
|
||||||
});
|
});
|
||||||
it('Verbose delegates to log.', async(): Promise<void> => {
|
it('Verbose delegates to log.', async(): Promise<void> => {
|
||||||
logger.verbose('my message', meta);
|
logger.verbose('my message');
|
||||||
expect(logger.log).toHaveBeenCalledTimes(1);
|
expect(logger.log).toHaveBeenCalledTimes(1);
|
||||||
expect(logger.log).toHaveBeenCalledWith('verbose', 'my message', meta);
|
expect(logger.log).toHaveBeenCalledWith('verbose', 'my message');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('Debug delegates to log.', async(): Promise<void> => {
|
it('Debug delegates to log.', async(): Promise<void> => {
|
||||||
logger.debug('my message', meta);
|
logger.debug('my message');
|
||||||
expect(logger.log).toHaveBeenCalledTimes(1);
|
expect(logger.log).toHaveBeenCalledTimes(1);
|
||||||
expect(logger.log).toHaveBeenCalledWith('debug', 'my message', meta);
|
expect(logger.log).toHaveBeenCalledWith('debug', 'my message');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('Silly delegates to log.', async(): Promise<void> => {
|
it('Silly delegates to log.', async(): Promise<void> => {
|
||||||
logger.silly('my message', meta);
|
logger.silly('my message');
|
||||||
expect(logger.log).toHaveBeenCalledTimes(1);
|
expect(logger.log).toHaveBeenCalledTimes(1);
|
||||||
expect(logger.log).toHaveBeenCalledWith('silly', 'my message', meta);
|
expect(logger.log).toHaveBeenCalledWith('silly', 'my message');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
@ -157,9 +157,7 @@ describe('GuardedStream', (): void => {
|
|||||||
// Only the first error gets logged
|
// Only the first error gets logged
|
||||||
jest.advanceTimersByTime(900);
|
jest.advanceTimersByTime(900);
|
||||||
expect(logger.error).toHaveBeenCalledTimes(1);
|
expect(logger.error).toHaveBeenCalledTimes(1);
|
||||||
expect(logger.error).toHaveBeenCalledWith(
|
expect(logger.error).toHaveBeenCalledWith('No error listener was attached but error was thrown: 0');
|
||||||
'No error listener was attached but error was thrown: 0', { error: errors[0] },
|
|
||||||
);
|
|
||||||
|
|
||||||
jest.advanceTimersByTime(1000);
|
jest.advanceTimersByTime(1000);
|
||||||
expect(logger.error).toHaveBeenCalledTimes(1);
|
expect(logger.error).toHaveBeenCalledTimes(1);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user