为什么Node Pdfkit偶尔会在我的代码中创建损坏的文件？

问题描述

我有一个功能，可以创建pdf文件，并使用pdfkit和nodemailer将其发送到电子邮件中，我偶尔会得到无法打开的文件。无法弄清楚为什么会发生这种情况以及为什么大多数情况下都能奏效？当它失败时，我还没有注意到任何特定的情况，其中似乎没有任何公式（文本长度等）。有人可以指出我的pdf创建代码中是否存在一些明显的问题（例如async / await）。

exports.sendTranscriptionToEmail = async (req,res) => {
  let finalText = [];
  let nickColorsArray = [];

  const doc = new PDFDocument();
  let filename = req.body.sessionName;
  let text = [];

  if (!filename || typeof filename != "string") {
    return res.status(400).send({ message: "Incorrect Information!" });
  }


// here I get the data from the database
  try {
    const rows = await knex("transcriptions").select("*").where({
      conversation_id: filename,});

    if (!rows) {
      return res.status(400).send({ message: "Transcription not found" });
    }



    // Stripping special characters
    filename = encodeURIComponent(filename) + ".pdf";

    res.setHeader(
      "Content-disposition",'attachment; filename="' + filename + '"'
    );
    res.setHeader("Content-type","application/pdf");
    doc.pipe(fs.createWriteStream(filename));

    doc.fontSize(18).fillColor("black").text("Participants:",{
      width: 410,align: "center",});

    doc.moveDown();

    nickColorsArray.forEach((n) => {
      doc.fontSize(14).fillColor(n.color).text(n.nick,{
        width: 410,});
    });

    doc.moveDown();
    doc.moveDown();

    doc.fontSize(18).fillColor("black").text("Transcription:",});

    doc.moveDown();

    finalText.forEach((f) => {
      doc
        .fontSize(14)
        .fillColor(f.color)
        .text(f.word + " ",{
          width: 410,continued: true,});
    });

    doc.end();


   } catch (err) {
     console.log("Something went wrong: ",err.message);
   }

解决方法

我也遇到过同样的问题，经过调查，我在https://github.com/foliojs/pdfkit/issues/265找到了解决方案

PDFKit实际上并不知道何时将所有数据刷新到 您要写入的任何流（文件，http响应等）。以来 PDFKit无法访问通过管道传输的实际可写流 到（PDFKit本身是可读的流，并且您将可写 部分），它仅知道何时完成将块抽出至 可能正在读书的人。可能要过一段时间才能写 流实际上将其内部缓冲区刷新到实际 目的地。

我相信这并不像聆听“完成”事件那么简单 在写流上，特别是在出现错误的情况下，所以我 实现了以下函数，该函数返回Promise。

function savePdfToFile(pdf : PDFKit.PDFDocument,fileName : string) : Promise<void> {
    return new Promise<void>((resolve,reject) => {

        // To determine when the PDF has finished being written successfully 
        // we need to confirm the following 2 conditions:
        //
        //   1. The write stream has been closed
        //   2. PDFDocument.end() was called syncronously without an error being thrown

        let pendingStepCount = 2;

        const stepFinished = () => {
            if (--pendingStepCount == 0) {
                resolve();
            }
        };

        const writeStream = fs.createWriteStream(fileName);
        writeStream.on('close',stepFinished);
        pdf.pipe(writeStream);

        pdf.end();

        stepFinished();
    }); 
}

您可以直接调用此函数并传递，而不是直接调用.end（） pdf文档和文件名。

这应该正确处理以下情况：

PDF生成成功，在pdf.end（）之前引发错误 写入流已关闭写入后在pdf.end（）中引发错误 流已关闭

所以最后，似乎服务器有时无法为您创建文件足够快，实施此解决方案后，我的响应时间确实增加了约1秒，并且摆脱了这种损坏行为