serverless-python-requirements/lib/zipTree.js

Serverless Python Requirements Plugin

const BbPromise = require('bluebird');
const fse = require('fs-extra');
const path = require('path');

BbPromise.promisifyAll(fse);

/**
 * Add a directory recursively to a zip file. Files in src will be added to the top folder of zip.
 * @param {JSZip} zip a zip object in the folder you want to add files to.
 * @param {string} src the source folder.
 * @return {Promise} a promise offering the original JSZip object.
 */
function addTree(zip, src) {
  const srcN = path.normalize(src);

  return fse
    .readdirAsync(srcN)
    .map((name) => {
      const srcPath = path.join(srcN, name);

      return fse.statAsync(srcPath).then((stat) => {
        if (stat.isDirectory()) {
          return addTree(zip.folder(name), srcPath);
        } else {
          const opts = { date: stat.mtime, unixPermissions: stat.mode };
          return fse
            .readFileAsync(srcPath)
            .then((data) => zip.file(name, data, opts));
        }
      });
    })
    .then(() => zip); // Original zip for chaining.
}

/**
 * Write zip contents to a file.
 * @param {JSZip} zip the zip object
 * @param {string} targetPath path to write the zip file to.
 * @return {Promise} a promise resolving to null.
 */
function writeZip(zip, targetPath) {
  const opts = {
    platform: process.platform == 'win32' ? 'DOS' : 'UNIX',
    compression: 'DEFLATE',
    compressionOptions: {
      level: 9,
    },
  };
  return new BbPromise((resolve) =>
    zip
      .generateNodeStream(opts)
      .pipe(fse.createWriteStream(targetPath))
      .on('finish', resolve)
  ).then(() => null);
}

/**
 * Add a new file to a zip file from a buffer.
 * @param {JSZip} zip the zip object to add the file to.
 * @param {string} zipPath the target path in the zip.
 * @param {Promise} bufferPromise a promise providing a nodebuffer.
 * @return {Promise} a promise providing the JSZip object.
 * @param {object} fileOpts an object with the opts to save for the file in the zip.
 */
function zipFile(zip, zipPath, bufferPromise, fileOpts) {
  return bufferPromise
    .then((buffer) =>
      zip.file(
        zipPath,
        buffer,
        Object.assign(
          {},
          {
            // necessary to get the same hash when zipping the same content
            date: new Date(0),
          },
          fileOpts
        )
      )
    )
    .then(() => zip);
}

module.exports = { addTree, writeZip, zipFile };