Bagaimana untuk menyenyapkan log dalam ujian buat sementara waktu

Pakej logger dalam kod sumber Changesets menyediakan dokumentasi tentang menyenyapkan mesej log dalam ujian. Ini membuatkan saya tertanya-tanya bagaimana Changesets melakukannya dan membuatkan saya melihat ke dalam kod sumbernya.

Menukar carian repositori untuk menyenyapkan log

Saya mencari sementaraSilenceLogs merentas repo Changesets menggunakan carian Github.

Apa yang membuatkan saya memilih untuk mencari sementaraSilenceLogs ialah hakikat bahawa ia disebut dalam Logger

pakej 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");

Apabila anda cuba memahami kod sumber, anda boleh menggunakan dokumentasi sebagai titik permulaan anda dan mencari pembolehubah dan fungsi untuk menetapkan arah penerokaan anda apabila anda berurusan dengan projek besar seperti Changesets.

Sementara Senyap Log

Kod di bawah dipilih daripada kod sumber Changesets.

Fungsi ini menerima fungsi sebagai hujah dan kemudian menyenyapkan log menggunakan fungsi bernama createLogSilencer.

Beri perhatian kepada fungsi persediaan di sini:

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

buatLogSilencer

Kod di bawah dipilih daripada Changesets

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;
      };
    },
  };
};

Apa yang berlaku di sini?

1. Tugasan

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. Mengembalikan persediaan

Jika anda perasan di atas, persediaan dipanggil di dalam sementaraSilenceLogs, ini dikembalikan oleh 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;
      };
    },
  };

Apakah yang berlaku dalam fungsi persediaan?

2.1 Pembalak dan API konsol dimulakan kepada 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();

Ini cukup menyenyapkan log sejak jest.fn() dipanggil apabila anda menggunakan mana-mana pembalak, oleh itu ini dianggap sebagai persediaan, satu langkah penting untuk menyenyapkan log anda.

2.2 setUp mengembalikan pembalak asal

Jika anda perasan, urutan panggilan fungsi adalah

a. const silencer = createLogSilencer();

b. const dispose = silencer.setup();

c. Dalam blok akhirnya.

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

buang dikembalikan oleh fungsi persediaan yang dikembalikan oleh createLogSilencer. Langkah ini memulihkan mekanisme pengelogan selepas melaksanakan fungsi ujian anda.

Tentang kami:

Di Thinkthroo, kami mengkaji projek sumber terbuka yang besar dan menyediakan panduan seni bina. Kami telah membangunkan Komponen boleh guna semula, dibina dengan tailwind, yang boleh anda gunakan dalam projek anda. Kami menawarkan perkhidmatan pembangunan Next.js, React dan Node.

Tempah mesyuarat dengan kami untuk membincangkan projek anda.

Rujukan:

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

Atas ialah kandungan terperinci Bagaimana untuk menyenyapkan log dalam ujian buat sementara waktu. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!