#102 into [email protected] 🐘 add logger support #131

RiceWithMeat · 2023-11-21T11:27:11Z

Resolves #102

# Conflicts: # src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.test.ts # src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.ts # src/core/middlewares/notFoundMiddleware/notFoundMiddleware.test.ts # src/core/rest/createRestRoutes/createRestRoutes.test.ts # src/core/rest/createRestRoutes/createRestRoutes.ts # src/server/createGraphQLMockServer/createGraphQLMockServer.ts # src/server/createMockServer/createMockServer.ts # src/server/createRestMockServer/createRestMockServer.ts

…, update logger logic in createGraphQLRoutes

src/utils/types/logger.ts

src/utils/helpers/logger/helpers/coloredString/getRestMethodColoredString.ts

src/utils/helpers/logger/callRequestLogger/callRequestLogger.ts

src/utils/helpers/date/formatUnixTimestamp/formatUnixTimestamp.ts

.eslintrc.js

src/core/middlewares/requestInfoMiddleware/requestInfoMiddleware.ts

src/core/rest/createRestRoutes/createRestRoutes.ts

src/utils/types/logger.ts

src/utils/helpers/logger/helpers/formatLogMessage.ts

MiaInturi · 2023-12-12T14:34:11Z

src/utils/helpers/logger/callResponseLogger/callResponseLogger.ts

+  if (logger.tokens?.meta?.url) {
+    console.info(`${metaPrefix}[${c.yellow('url')}] ${url}`);
+  }
+  if (logger.tokens?.meta?.method) {
+    console.info(`${metaPrefix}[${c.red('method')}] ${getRestMethodColoredString(method)}`);
+  }
+  if (logger.tokens?.meta?.graphQLOperationType) {
+    console.info(`${metaPrefix}[${c.blue('graphQLOperationType')}] ${graphQLOperationType}`);
+  }
+  if (logger.tokens?.meta?.graphQLOperationName) {
+    console.info(`${metaPrefix}[${c.green('graphQLOperationName')}] ${graphQLOperationName}`);
+  }
+  if (logger.tokens?.meta?.statusCode) {
+    console.info(
+      `${metaPrefix}[${c.yellowBright('statusCode')}] ${getStatusCodeColoredString(statusCode)}`
+    );
+  }
+  if (logger.tokens?.meta?.id) {
+    console.info(`${metaPrefix}[${c.greenBright('id')}] ${id}`);
+  }
+  if (logger.tokens?.meta?.unixTimestamp) {
+    console.info(`${metaPrefix}[${c.blue('timestamp')}] ${formatUnixTimestamp(unixTimestamp)}`);
+  }
+
+  if (logger.tokens?.entities?.headers) {
+    console.info(`${entitiesPrefix}[${c.cyan('headers')}]\n${JSON.stringify(headers, null, 2)}`);
+  }
+  if (logger.tokens?.entities?.cookies) {
+    console.info(`${entitiesPrefix}[${c.magenta('cookies')}]\n${JSON.stringify(cookies, null, 2)}`);
+  }
+  if (logger.tokens?.entities?.query) {
+    console.info(`${entitiesPrefix}[${c.cyanBright('query')}]\n${JSON.stringify(query, null, 2)}`);
+  }
+  if (logger.tokens?.entities?.params) {
+    console.info(`${entitiesPrefix}[${c.red('params')}]\n${JSON.stringify(params, null, 2)}`);
+  }
+  if (logger.tokens?.entities?.variables) {
+    console.info(
+      `${entitiesPrefix}[${c.yellow('variables')}]\n${JSON.stringify(variables, null, 2)}`
+    );
+  }
+  if (logger.tokens?.entities?.body) {
+    console.info(`${entitiesPrefix}[${c.green('body')}]\n${JSON.stringify(body, null, 2)}`);
+  }
+
+  if (logger.tokens?.data) {
+    console.info(`${prefix}[${c.yellow('data')}]\n${JSON.stringify(data, null, 2)}`);
+  }
+
+  console.info('\n\n');
+};


У console есть методы group и groupEnd. Можно их использовать, чтобы объединять сущности одного уровня (например entities)

переписал логику так, что теперь эта функция возвращает объект с токенами, который потом мы один раз console.dir-им

А отличается ли console.dir от console.info(JSON.stringify()) если мы говорим о NodeJs?

MiaInturi · 2023-12-12T14:41:10Z

src/core/middlewares/requestInfoMiddleware/requestInfoMiddleware.ts

+    const isValidGraphQLRequest =
+      graphQLInput &&
+      graphQLInput.query &&
+      graphQLQuery?.operationType &&
+      graphQLQuery.operationName;
+    request.graphQL = isValidGraphQLRequest
+      ? {
+          operationType: graphQLQuery.operationType as GraphQLOperationType,
+          operationName: graphQLQuery.operationName,
+          variables: graphQLInput.variables
+        }
+      : null;


operationType и operationName в типе ResponseLogFunctionParams могут быть undefined, хотя по сути не могут

почему не могут? request.graphQL?.operationType будет undefined т.к. graphQL === null

MiaInturi · 2023-12-12T14:44:21Z

src/core/middlewares/notFoundMiddleware/notFoundMiddleware.ts

+      const requestLogger = mockServerConfig.loggers?.request;
+      if (requestLogger) {
+        await callRequestLogger({ request, logger: requestLogger });
+      }


Получается, что requestLogger вызывается независимо от того, был найден нужный конфиг или нет. Мб тогда вызывать его в одном месте, а не в двух?

от этого дублирования не уйти, если вынести вызов callRequestLogger из createRestRoutes, createGraphQLRoutes и notFoundMiddleware, то придётся добавлять одинаковый интерцептор в createMockServer, createRestMockServer и createGraphQLMockServer

Да, но тогда у нас хотя бы будут все вызовы подобных вещей в одном месте - те же interceptor-ы вызываются как раз в create... функциях

src/static/views/features/scheme/index.js

# Conflicts: # .eslintrc.js # src/core/graphql/createGraphQLRoutes/createGraphQLRoutes.ts # src/core/middlewares/notFoundMiddleware/notFoundMiddleware.ts # src/core/rest/createRestRoutes/createRestRoutes.ts # src/server/createGraphQLMockServer/createGraphQLMockServer.ts # src/server/createMockServer/createMockServer.ts # src/server/createRestMockServer/createRestMockServer.ts # src/utils/helpers/interceptors/callRequestInterceptor/callRequestInterceptor.test.ts # src/utils/types/graphql.ts # src/utils/types/rest.ts # src/utils/types/utils.ts

MiaInturi · 2024-06-01T08:47:51Z

bin/run.ts

+// TODO: add loggers validation
+// import { validateMockServerConfig } from './validateMockServerConfig/validateMockServerConfig';


А что с этим?

MiaInturi · 2024-06-01T08:52:48Z

src/utils/types/values.ts

+import type { ParamsDictionary } from 'express-serve-static-core';
+import type { IncomingHttpHeaders } from 'http';
+import type { ParsedQs } from 'qs';


У express-serve-static-core есть тип Query - я думаю более наглядно будет использовать его, нежели тип из qs, который является подзависимостью express

MiaInturi · 2024-06-01T08:54:25Z

src/utils/types/server.ts

  rest?: RestConfig;
  graphql?: GraphqlConfig;
  database?: DatabaseConfig;
+  loggers?: Loggers;
 }

 export interface RestMockServerConfig extends BaseMockServerConfig {
  configs?: RestRequestConfig[];
  database?: DatabaseConfig;
+  loggers?: Loggers<'rest'>;
 }

 export interface GraphQLMockServerConfig extends BaseMockServerConfig {
  configs?: GraphQLRequestConfig[];
  database?: DatabaseConfig;
+  loggers?: Loggers<'graphql'>;
 }


А для database логгера не будет?

MiaInturi · 2024-06-01T09:04:05Z

src/utils/types/logger.ts

+export interface LoggerTokenFlags<
+  Type extends LoggerType = LoggerType,
+  API extends LoggerAPI = LoggerAPI
+> {
+  meta?: {
+    unixTimestamp?: boolean;
+    id?: boolean;
+    method?: boolean;
+    graphQLOperationType?: API extends 'graphql' ? boolean : never;
+    graphQLOperationName?: API extends 'graphql' ? boolean : never;
+    url?: boolean;
+    statusCode?: Type extends 'response' ? boolean : never;
+  };
+  entities?: {
+    headers?: boolean;
+    cookies?: any;
+    query?: boolean;
+    params?: boolean;
+    variables?: API extends 'graphql' ? boolean : never;
+    body?: boolean;
+  };
+  data?: Type extends 'response' ? boolean : never;
+}


entities.cookies так и должно быть any?

MiaInturi · 2024-06-01T09:15:13Z

src/core/middlewares/notFoundMiddleware/notFoundMiddleware.ts

+      const requestLogger = mockServerConfig.loggers?.request;
+      if (requestLogger) {
+        await callRequestLogger({ request, logger: requestLogger });
+      }


Да, но тогда у нас хотя бы будут все вызовы подобных вещей в одном месте - те же interceptor-ы вызываются как раз в create... функциях

MiaInturi · 2024-06-02T06:17:30Z

.eslintrc.js

@@ -16,10 +16,12 @@ module.exports = {
        '@typescript-eslint/no-unsafe-enum-comparison': 'off',
        '@typescript-eslint/no-var-requires': 'off',
        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-namespace': 'off',


'@typescript-eslint/no-namespace': ['error', { allowDeclarations: true }] - я думаю лучше сделать так, чтобы минимально снять ограничения, а не полностью отключать правило

MiaInturi · 2024-06-02T07:01:57Z

src/utils/helpers/logger/callResponseLogger/callResponseLogger.ts

+const getTokens: GetTokens<'response'> = ({ logger, tokenValues }) => {
+  const {
+    meta: {
+      unixTimestamp,
+      id,
+      statusCode,
+      url,
+      method,
+      graphQLOperationType,
+      graphQLOperationName
+    },
+    entities: { headers, cookies, query, params, variables, body },
+    data
+  } = tokenValues;
+
+  if (!logger.tokens || !Object.keys(logger.tokens).length) {
+    return {
+      type: 'response',
+      meta: {
+        timestamp: getTimestamp(unixTimestamp),
+        id,
+        statusCode
+      }
+    };
+  }
+
+  return {
+    type: 'response',
+    ...(logger.tokens.meta && {
+      meta: {
+        ...(logger.tokens.meta.unixTimestamp && { timestamp: getTimestamp(unixTimestamp) }),
+        ...(logger.tokens.meta.id && { id }),
+        ...(logger.tokens.meta.method && { method }),
+        ...(logger.tokens.meta.graphQLOperationType && { graphQLOperationType }),
+        ...(logger.tokens.meta.graphQLOperationName && { graphQLOperationName }),
+        ...(logger.tokens.meta.url && { url }),
+        ...(logger.tokens.meta.statusCode && { statusCode })
+      }
+    }),
+    ...(logger.tokens.entities && {
+      entities: {
+        ...(logger.tokens.entities.headers && { headers }),
+        ...(logger.tokens.entities.cookies && { cookies }),
+        ...(logger.tokens.entities.query && { query }),
+        ...(logger.tokens.entities.params && { params }),
+        ...(logger.tokens.entities.variables && { variables }),
+        ...(logger.tokens.entities.body && { body })
+      }
+    }),
+    ...(logger.tokens.data && {
+      data
+    })
+  };
+};


Мне кажется, что можно упростить апи этой функции - нет смысла передавать все loggerParams, если функции по сути нужны только tokenFlags и tokenValues. И так будет легче понять ее смысл

MiaInturi · 2024-06-02T07:07:16Z

src/utils/helpers/logger/callResponseLogger/callResponseLogger.ts

+    tokenValues: {
+      type: 'response',
+      meta: {
+        unixTimestamp: Date.now(),


request.timestamp?

MiaInturi · 2024-06-02T07:07:55Z

src/utils/helpers/logger/callResponseLogger/callResponseLogger.ts

+  if (logger.logFunction) {
+    await logger.logFunction(loggerParams);
+    return;
+  }
+  const tokens = await getTokens(loggerParams);
+  console.dir(tokens, { depth: null });


А нормально ли, что дефолтный console и logFunction оба сработают?

MiaInturi · 2024-06-02T07:21:09Z

src/utils/types/logger.ts

+export interface LoggerTokenValues<
+  Type extends LoggerType = LoggerType,
+  API extends LoggerAPI = LoggerAPI
+> {
+  type: Type;
+  meta: {
+    unixTimestamp: number;
+    id: number | undefined;
+    method: RestMethod;
+    graphQLOperationType: API extends 'graphql' ? GraphQLOperationType | undefined : never;
+    graphQLOperationName: API extends 'graphql' ? GraphQLOperationName | undefined : never;
+    url: string;
+    statusCode?: Type extends 'response' ? number : never;
+  };
+  entities: {
+    headers: Headers;
+    cookies: Cookies;
+    query: Query;
+    params: Params;
+    variables: API extends 'graphql' ? PlainObject | undefined : never;
+    body: any;
+  };
+  data?: Type extends 'response' ? any : never;
+}


С подобным типом автодополнение IDE не очень хорошо работает (для REST, например, он предложит graphql свойства, а для request свойства response). Т.к. мы отталкиваемся в первую очередь от удобства использования, а не удобства разработки, то предлагаю сделать 4 типа LoggerTokenValues (request,response - для каждого из них rest и graphql). А из этих 4 типов создать типы LoggerTokenFlags будет совсем просто - это по сути DeepPartial, только типами всех свойств станет boolean

RiceWithMeat added 3 commits November 19, 2023 21:25

#102 🐘 logger WIP

155955e

#102 🐘 logger WIP

da5e3f0

RiceWithMeat added the enhancement New feature or request label Nov 21, 2023

RiceWithMeat requested review from MiaInturi, anv296 and debabin November 21, 2023 11:27

RiceWithMeat self-assigned this Nov 21, 2023

#102 🐘 add logger in createRestMockServer and createGraphQLMockServer…

105cced

…, update logger logic in createGraphQLRoutes

RiceWithMeat linked an issue Nov 22, 2023 that may be closed by this pull request

Logger for rest and graphl routes #102

Open

#102 🐘 loggers rework

1251aed

RiceWithMeat commented Dec 3, 2023

View reviewed changes

src/utils/types/logger.ts Outdated Show resolved Hide resolved

src/utils/helpers/logger/helpers/coloredString/getRestMethodColoredString.ts Outdated Show resolved Hide resolved

anv296 reviewed Dec 10, 2023

View reviewed changes

src/utils/helpers/logger/callRequestLogger/callRequestLogger.ts Outdated Show resolved Hide resolved

MiaInturi requested changes Dec 12, 2023

View reviewed changes

RiceWithMeat added 2 commits April 7, 2024 03:00

#102 🐘 logger rework

c427ea0

RiceWithMeat changed the base branch from [email protected] to [email protected] April 6, 2024 20:33

RiceWithMeat changed the title ~~#102 into [email protected] 🐘 add logger support~~ #102 into [email protected] 🐘 add logger support Apr 6, 2024

MiaInturi requested changes Jun 2, 2024

View reviewed changes

MiaInturi added the [email protected] issues for [email protected] label Jul 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#102 into [email protected] 🐘 add logger support #131

#102 into [email protected] 🐘 add logger support #131

RiceWithMeat commented Nov 21, 2023

MiaInturi Dec 12, 2023

RiceWithMeat Apr 6, 2024

MiaInturi Jun 1, 2024

MiaInturi Dec 12, 2023

RiceWithMeat Apr 6, 2024

MiaInturi Dec 12, 2023

RiceWithMeat Apr 6, 2024

MiaInturi Jun 1, 2024

MiaInturi Jun 1, 2024

MiaInturi Jun 1, 2024

MiaInturi Jun 1, 2024

MiaInturi Jun 1, 2024

MiaInturi Jun 1, 2024

MiaInturi Jun 2, 2024

MiaInturi Jun 2, 2024

MiaInturi Jun 2, 2024

MiaInturi Jun 2, 2024

MiaInturi Jun 2, 2024

		// TODO: add loggers validation
		// import { validateMockServerConfig } from './validateMockServerConfig/validateMockServerConfig';

#102 into [email protected] 🐘 add logger support #131

Are you sure you want to change the base?

#102 into [email protected] 🐘 add logger support #131

Conversation

RiceWithMeat commented Nov 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment