CR-277: Change log to debug calls, log additional metadata

Author: seth-riedel

redisinsight/api/src/exceptions/global-exception.filter.ts

@@ -3,7 +3,7 @@ import { ArgumentsHost, Logger } from '@nestjs/common';
 import { Request, Response } from 'express';
 
 export class GlobalExceptionFilter extends BaseExceptionFilter {
-  private staticServerLogger = new Logger('StaticServerLogger');
+  private staticServerLogger = new Logger('GlobalExceptionFilter');
 
   catch(exception: Error, host: ArgumentsHost) {
     const ctx = host.switchToHttp();

redisinsight/api/src/modules/ai/query/ai-query.service.ts

@@ -178,7 +178,7 @@ export class AiQueryService {
 
             return cb(indexContext);
           } catch (e) {
-            this.logger.warn('Unable to create index context', e);
+            this.logger.warn('Unable to create index context', e, sessionMetadata);
             return cb(e.message);
           }
         });
@@ -191,7 +191,7 @@ export class AiQueryService {
 
             return cb(await client.sendCommand(data, { replyEncoding: 'utf8' }));
           } catch (e) {
-            this.logger.warn('Query execution error', e);
+            this.logger.warn('Query execution error', e, sessionMetadata);
             return cb(e.message);
           }
         });

redisinsight/api/src/modules/ai/query/repositories/local.ai-query.message.repository.ts

@@ -71,7 +71,7 @@ export class LocalAiQueryMessageRepository extends AiQueryMessageRepository {
       .map((entity) => classToClass(AiQueryMessage, entity));
   }
 
-  async createMany(_sessionMetadata: SessionMetadata, messages: AiQueryMessage[]): Promise<void> {
+  async createMany(sessionMetadata: SessionMetadata, messages: AiQueryMessage[]): Promise<void> {
     const entities = await Promise.all(messages.map(async (message) => {
       const entity = classToClass(AiQueryMessageEntity, message);
 
@@ -84,7 +84,7 @@ export class LocalAiQueryMessageRepository extends AiQueryMessageRepository {
     try {
       await this.cleanupDatabaseHistory(entities[0].databaseId, entities[0].accountId);
     } catch (e) {
-      this.logger.error('Error when trying to cleanup history after insert', e);
+      this.logger.error('Error when trying to cleanup history after insert', e, sessionMetadata);
     }
   }
 

redisinsight/api/src/modules/browser/browser-history/browser-history.service.ts

@@ -32,7 +32,7 @@ export class BrowserHistoryService {
       const history = plainToClass(BrowserHistory, { ...dto, databaseId: clientMetadata.databaseId });
       return this.browserHistoryRepository.create(clientMetadata.sessionMetadata, history);
     } catch (e) {
-      this.logger.error('Unable to create browser history item', e);
+      this.logger.error('Unable to create browser history item', e, clientMetadata);
 
       if (e instanceof HttpException) {
         throw e;
@@ -92,7 +92,7 @@ export class BrowserHistoryService {
     mode: BrowserHistoryMode,
     ids: string[],
   ): Promise<DeleteBrowserHistoryItemsResponse> {
-    this.logger.log(`Deleting many browser history items: ${ids}`);
+    this.logger.debug(`Deleting many browser history items: ${ids}`, sessionMetadata);
 
     return {
       affected: sum(await Promise.all(ids.map(async (id) => {

redisinsight/api/src/modules/browser/browser-history/repositories/local.browser-history.repository.ts

@@ -45,7 +45,7 @@ export class LocalBrowserHistoryRepository extends BrowserHistoryRepository {
     try {
       await this.cleanupDatabaseHistory(sessionMetadata, entity.databaseId, entity.mode);
     } catch (e) {
-      this.logger.error('Error when trying to cleanup history after insert', e);
+      this.logger.error('Error when trying to cleanup history after insert', e, sessionMetadata);
     }
 
     return classToClass(BrowserHistory, await this.modelEncryptor.decryptEntity(entity));
@@ -55,11 +55,11 @@ export class LocalBrowserHistoryRepository extends BrowserHistoryRepository {
    * Fetches entity, decrypt and return full BrowserHistory model
    * @param id
    */
-  async get(_sessionMetadata: SessionMetadata, id: string): Promise<BrowserHistory> {
+  async get(sessionMetadata: SessionMetadata, id: string): Promise<BrowserHistory> {
     const entity = await this.repository.findOneBy({ id });
 
     if (!entity) {
-      this.logger.error(`Browser history item with id:${id} was not Found`);
+      this.logger.error(`Browser history item with id:${id} was not Found`, sessionMetadata);
       throw new NotFoundException(ERROR_MESSAGES.BROWSER_HISTORY_ITEM_NOT_FOUND);
     }
 
@@ -72,11 +72,11 @@ export class LocalBrowserHistoryRepository extends BrowserHistoryRepository {
    * @param mode
    */
   async list(
-    _sessionMetadata: SessionMetadata,
+    sessionMetadata: SessionMetadata,
     databaseId: string,
     mode: BrowserHistoryMode,
   ): Promise<BrowserHistory[]> {
-    this.logger.log('Getting browser history list');
+    this.logger.debug('Getting browser history list', sessionMetadata);
     const entities = await this.repository
       .createQueryBuilder('a')
       .where({ databaseId, mode })
@@ -90,7 +90,7 @@ export class LocalBrowserHistoryRepository extends BrowserHistoryRepository {
       .limit(BROWSER_HISTORY_CONFIG.maxItemsPerModeInDb)
       .getMany();
 
-    this.logger.log('Succeed to get history list');
+    this.logger.debug('Succeed to get history list', sessionMetadata);
 
     const decryptedEntities = await Promise.all(
       entities.map<Promise<BrowserHistoryEntity>>(async (entity) => {
@@ -112,14 +112,14 @@ export class LocalBrowserHistoryRepository extends BrowserHistoryRepository {
    * @param mode
    * @param id
    */
-  async delete(_: SessionMetadata, databaseId: string, mode: BrowserHistoryMode, id: string): Promise<void> {
-    this.logger.log(`Deleting browser history item: ${id}`);
+  async delete(sessionMetadata: SessionMetadata, databaseId: string, mode: BrowserHistoryMode, id: string): Promise<void> {
+    this.logger.debug(`Deleting browser history item: ${id}`, sessionMetadata);
     try {
       await this.repository.delete({ id, databaseId, mode });
       // todo: rethink
-      this.logger.log('Succeed to delete browser history item.');
+      this.logger.debug('Succeed to delete browser history item.', sessionMetadata);
     } catch (error) {
-      this.logger.error(`Failed to delete history items: ${id}`, error);
+      this.logger.error(`Failed to delete history items: ${id}`, error, sessionMetadata);
       throw new InternalServerErrorException();
     }
   }

redisinsight/api/src/modules/browser/hash/hash.service.ts

@@ -55,7 +55,7 @@ export class HashService {
     dto: CreateHashWithExpireDto,
   ): Promise<void> {
     try {
-      this.logger.log('Creating Hash data type.');
+      this.logger.debug('Creating Hash data type.', clientMetadata);
       const { keyName, fields, expire } = dto;
       const client: RedisClient = await this.databaseClientFactory.getOrCreateClient(clientMetadata);
 
@@ -79,9 +79,9 @@ export class HashService {
       // todo: rethink
       catchMultiTransactionError(transactionResults);
 
-      this.logger.log('Succeed to create Hash data type.');
+      this.logger.debug('Succeed to create Hash data type.', clientMetadata);
     } catch (error) {
-      this.logger.error('Failed to create Hash data type.', error);
+      this.logger.error('Failed to create Hash data type.', error, clientMetadata);
       throw catchAclError(error);
     }
   }
@@ -91,7 +91,7 @@ export class HashService {
     dto: GetHashFieldsDto,
   ): Promise<GetHashFieldsResponse> {
     try {
-      this.logger.log('Getting fields of the Hash data type stored at key.');
+      this.logger.debug('Getting fields of the Hash data type stored at key.', clientMetadata);
       const { keyName, cursor, match } = dto;
       const client: RedisClient = await this.databaseClientFactory.getOrCreateClient(clientMetadata);
       let result: GetHashFieldsResponse = {
@@ -103,7 +103,7 @@ export class HashService {
 
       result.total = await client.sendCommand([BrowserToolHashCommands.HLen, keyName]) as number;
       if (!result.total) {
-        this.logger.error(`Failed to get fields of the Hash data type. Not Found key: ${keyName}.`);
+        this.logger.error(`Failed to get fields of the Hash data type. Not Found key: ${keyName}.`, clientMetadata);
         return Promise.reject(new NotFoundException(ERROR_MESSAGES.KEY_NOT_EXIST));
       }
       if (match && !isRedisGlob(match)) {
@@ -133,7 +133,7 @@ export class HashService {
           });
         }
       } catch (e) {
-        this.logger.warn('Unable to get ttl for hash fields');
+        this.logger.warn('Unable to get ttl for hash fields', e, clientMetadata);
         // ignore error
       }
 
@@ -143,10 +143,10 @@ export class HashService {
         { total: result.total, keyName },
       );
 
-      this.logger.log('Succeed to get fields of the Hash data type.');
+      this.logger.debug('Succeed to get fields of the Hash data type.', clientMetadata);
       return plainToClass(GetHashFieldsResponse, result);
     } catch (error) {
-      this.logger.error('Failed to get fields of the Hash data type.', error);
+      this.logger.error('Failed to get fields of the Hash data type.', error, clientMetadata);
       if (error.message.includes(RedisErrorCodes.WrongType)) {
         throw new BadRequestException(error.message);
       }
@@ -159,7 +159,7 @@ export class HashService {
     dto: AddFieldsToHashDto,
   ): Promise<void> {
     try {
-      this.logger.log('Adding fields to the Hash data type.');
+      this.logger.debug('Adding fields to the Hash data type.', clientMetadata);
       const { keyName, fields } = dto;
       const client: RedisClient = await this.databaseClientFactory.getOrCreateClient(clientMetadata);
 
@@ -179,9 +179,9 @@ export class HashService {
       // todo: rethink
       catchMultiTransactionError(transactionResults);
 
-      this.logger.log('Succeed to add fields to Hash data type.');
+      this.logger.debug('Succeed to add fields to Hash data type.', clientMetadata);
     } catch (error) {
-      this.logger.error('Failed to add fields to Hash data type.', error);
+      this.logger.error('Failed to add fields to Hash data type.', error, clientMetadata);
       if (error.message.includes(RedisErrorCodes.WrongType)) {
         throw new BadRequestException(error.message);
       }
@@ -194,7 +194,7 @@ export class HashService {
     dto: UpdateHashFieldsTtlDto,
   ): Promise<void> {
     try {
-      this.logger.log('Updating hash fields ttl.');
+      this.logger.debug('Updating hash fields ttl.', clientMetadata);
       const { keyName, fields } = dto;
 
       const client: RedisClient = await this.databaseClientFactory.getOrCreateClient(clientMetadata);
@@ -217,9 +217,9 @@ export class HashService {
         catchMultiTransactionError(transactionResults);
       }
 
-      this.logger.log('Successfully updated hash fields ttl');
+      this.logger.debug('Successfully updated hash fields ttl', clientMetadata);
     } catch (error) {
-      this.logger.error('Failed to update hash fields ttl.', error);
+      this.logger.error('Failed to update hash fields ttl.', error, clientMetadata);
       if (error.message.includes(RedisErrorCodes.WrongType)) {
         throw new BadRequestException(error.message);
       }
@@ -232,18 +232,18 @@ export class HashService {
     dto: DeleteFieldsFromHashDto,
   ): Promise<DeleteFieldsFromHashResponse> {
     try {
-      this.logger.log('Deleting fields from the Hash data type.');
+      this.logger.debug('Deleting fields from the Hash data type.', clientMetadata);
       const { keyName, fields } = dto;
       const client: RedisClient = await this.databaseClientFactory.getOrCreateClient(clientMetadata);
 
       await checkIfKeyNotExists(keyName, client);
 
       const result = await client.sendCommand([BrowserToolHashCommands.HDel, keyName, ...fields]) as number;
 
-      this.logger.log('Succeed to delete fields from the Hash data type.');
+      this.logger.debug('Succeed to delete fields from the Hash data type.', clientMetadata);
       return { affected: result };
     } catch (error) {
-      this.logger.error('Failed to delete fields from the Hash data type.', error);
+      this.logger.error('Failed to delete fields from the Hash data type.', error, clientMetadata);
       if (error.message.includes(RedisErrorCodes.WrongType)) {
         throw new BadRequestException(error.message);
       }

redisinsight/api/src/modules/browser/keys/key-info/strategies/graph.key-info.strategy.ts

@@ -13,7 +13,7 @@ export class GraphKeyInfoStrategy extends KeyInfoStrategy {
     key: RedisString,
     type: string,
   ): Promise<GetKeyInfoResponse> {
-    this.logger.log(`Getting ${RedisDataType.Graph} type info.`);
+    this.logger.debug(`Getting ${RedisDataType.Graph} type info.`);
     const [
       [, ttl = null],
       [, size = null],

redisinsight/api/src/modules/browser/keys/key-info/strategies/hash.key-info.strategy.ts

@@ -13,7 +13,7 @@ export class HashKeyInfoStrategy extends KeyInfoStrategy {
     key: RedisString,
     type: string,
   ): Promise<GetKeyInfoResponse> {
-    this.logger.log(`Getting ${RedisDataType.Hash} type info.`);
+    this.logger.debug(`Getting ${RedisDataType.Hash} type info.`);
 
     const [
       [, ttl = null],

redisinsight/api/src/modules/browser/keys/key-info/strategies/list.key-info.strategy.ts

@@ -13,7 +13,7 @@ export class ListKeyInfoStrategy extends KeyInfoStrategy {
     key: RedisString,
     type: string,
   ): Promise<GetKeyInfoResponse> {
-    this.logger.log(`Getting ${RedisDataType.List} type info.`);
+    this.logger.debug(`Getting ${RedisDataType.List} type info.`);
 
     const [
       [, ttl = null],

redisinsight/api/src/modules/browser/keys/key-info/strategies/rejson-rl.key-info.strategy.ts

@@ -13,7 +13,7 @@ export class RejsonRlKeyInfoStrategy extends KeyInfoStrategy {
     key: RedisString,
     type: string,
   ): Promise<GetKeyInfoResponse> {
-    this.logger.log(`Getting ${RedisDataType.JSON} type info.`);
+    this.logger.debug(`Getting ${RedisDataType.JSON} type info.`);
     const [
       [, ttl = null],
       [, size = null],