테스트에서 로그를 일시적으로 무음으로 설정하는 방법

Changesets 소스 코드의 Logger 패키지는 테스트에서 로그 메시지를 침묵시키는 방법에 대한 문서를 제공합니다. 이로 인해 Changeset이 어떻게 작동하는지 궁금해졌고 소스 코드를 살펴보게 되었습니다.

로그 침묵을 위한 변경 세트 저장소 검색

Github 검색을 사용하여 Changesets 저장소 전체에서 일시적으로 SilenceLogs를 검색했습니다.

일시적으로 SilenceLogs를 검색하게 된 이유는 Logger에 언급되어 있다는 사실 때문입니다

패키지 Readme.

import { temporarilySilenceLogs } from "@changesets/test-utils";
import { log } from "@changesets/logger";
temporarilySilenceLogs();
// Now the logs in this test file are not actually logged to std out
log("I am not logged");
// Use console.log to log messages in tests if required
console.log("Yay, I am logged");

소스 코드를 이해하려고 할 때 문서를 출발점으로 삼을 수 있고, Changesets와 같은 대규모 프로젝트를 다룰 때 변수와 함수를 검색하여 탐색 방향을 설정할 수 있습니다.

일시적으로 SilenceLogs

아래 코드는 Changesets 소스 코드에서 선택되었습니다.

이 함수는 함수를 인수로 받아들인 다음 createLogSilencer라는 함수를 사용하여 로그를 침묵시킵니다.

여기에서 설정 기능에 주목하세요:

const dispose = silencer.setup();
try {
 await testFn();
} finally {
 dispose();
}

logSilencer 생성

아래 코드는 Changeset에서 선택되었습니다

const createLogSilencer = () => {
  const originalLoggerError = logger.error;
  const originalLoggerInfo = logger.info;
  const originalLoggerLog = logger.log;
  const originalLoggerWarn = logger.warn;
  const originalLoggerSuccess = logger.success;

  const originalConsoleError = console.error;
  const originalConsoleInfo = console.info;
  const originalConsoleLog = console.log;
  const originalConsoleWarn = console.warn;

  const originalStdoutWrite = process.stdout.write;
  const originalStderrWrite = process.stderr.write;

  return {
    setup() {
      logger.error = jest.fn();
      logger.info = jest.fn();
      logger.log = jest.fn();
      logger.warn = jest.fn();
      logger.success = jest.fn();

      console.error = jest.fn();
      console.info = jest.fn();
      console.log = jest.fn();
      console.warn = jest.fn();

      process.stdout.write = jest.fn();
      process.stderr.write = jest.fn();

      return () => {
        logger.error = originalLoggerError;
        logger.info = originalLoggerInfo;
        logger.log = originalLoggerLog;
        logger.warn = originalLoggerWarn;
        logger.success = originalLoggerSuccess;

        console.error = originalConsoleError;
        console.info = originalConsoleInfo;
        console.log = originalConsoleLog;
        console.warn = originalConsoleWarn;

        process.stdout.write = originalStdoutWrite;
        process.stderr.write = originalStderrWrite;
      };
    },
  };
};

여기서 무슨 일이 일어나고 있는 걸까요?

1. 과제

const originalLoggerError = logger.error;
const originalLoggerInfo = logger.info;
const originalLoggerLog = logger.log;
const originalLoggerWarn = logger.warn;
const originalLoggerSuccess = logger.success;
const originalConsoleError = console.error;
const originalConsoleInfo = console.info;
const originalConsoleLog = console.log;
const originalConsoleWarn = console.warn;
const originalStdoutWrite = process.stdout.write;
const originalStderrWrite = process.stderr.write;

2. 반품 설정

위에서 알아차린 경우 setup은 일시적으로 SilenceLogs 내에서 호출되며 이는 createLogSilencer에 의해 반환됩니다

return {
    setup() {
      logger.error = jest.fn();
      logger.info = jest.fn();
      logger.log = jest.fn();
      logger.warn = jest.fn();
      logger.success = jest.fn();

      console.error = jest.fn();
      console.info = jest.fn();
      console.log = jest.fn();
      console.warn = jest.fn();

      process.stdout.write = jest.fn();
      process.stderr.write = jest.fn();

      return () => {
        logger.error = originalLoggerError;
        logger.info = originalLoggerInfo;
        logger.log = originalLoggerLog;
        logger.warn = originalLoggerWarn;
        logger.success = originalLoggerSuccess;

        console.error = originalConsoleError;
        console.info = originalConsoleInfo;
        console.log = originalConsoleLog;
        console.warn = originalConsoleWarn;

        process.stdout.write = originalStdoutWrite;
        process.stderr.write = originalStderrWrite;
      };
    },
  };

설정 기능에서는 무슨 일이 일어나고 있나요?

2.1 로거 및 콘솔 API는 jest.fn()으로 초기화됩니다

logger.error = jest.fn();
logger.info = jest.fn();
logger.log = jest.fn();
logger.warn = jest.fn();
logger.success = jest.fn();
console.error = jest.fn();
console.info = jest.fn();
console.log = jest.fn();
console.warn = jest.fn();
process.stdout.write = jest.fn();
process.stderr.write = jest.fn();

이것은 로거를 사용할 때 jest.fn()이 호출되기 때문에 로그를 거의 침묵시키므로 이는 로그를 침묵시키는 중요한 단계인 설정으로 간주됩니다.

2.2 setUp은 원래 로거를 반환합니다

알고 계시다면 함수 호출 순서는 다음과 같습니다

아. const 소음기 = createLogSilencer();

비. const dispose = 소음기.setup();

기음. 마지막 블록에서.

try {
 await testFn();
} finally {
 dispose();
}

dispose는 createLogSilencer에서 반환되는 설정 함수에 의해 반환됩니다. 이 단계는 테스트 기능을 실행한 후 로깅 메커니즘을 복원합니다.

회사 소개:

Thinkthroo에서는 대규모 오픈소스 프로젝트를 연구하고 아키텍처 가이드를 제공합니다. 우리는 귀하의 프로젝트에서 사용할 수 있는 tailwind로 구축된 재사용 가능한 구성 요소를 개발했습니다. Next.js, React, Node 개발 서비스를 제공합니다.

귀하의 프로젝트에 대해 논의하려면 회의를 예약하세요.

참고자료:

1. https://github.com/changesets/changesets/tree/main/packages/logger#silencing-messages-in-tests

2. https://github.com/search?q=repo:changesets/changesets temporarySilenceLogs &type=code

3. https://github.com/changesets/changesets/blob/baf56448606e005577dbe2fb1e78ff457dcaaefd/scripts/test-utils/src/index.ts#L16

위 내용은 테스트에서 로그를 일시적으로 무음으로 설정하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!