pdf.js/test/unit/node_stream_spec.js

/* Copyright 2017 Mozilla Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/* globals __non_webpack_require__ */

import { AbortException, assert } from '../../src/shared/util';
import { isNodeJS } from '../../src/shared/is_node';
import { PDFNodeStream } from '../../src/display/node_stream';

// Make sure that we only running this script is Node.js environments.
assert(isNodeJS);

let path = __non_webpack_require__('path');
let url = __non_webpack_require__('url');
let http = __non_webpack_require__('http');
let fs = __non_webpack_require__('fs');

describe('node_stream', function() {
  let server = null;
  let port = null;
  let pdf = url.parse(encodeURI('file://' + path.join(process.cwd(),
                      './test/pdfs/tracemonkey.pdf'))).href;
  let pdfLength = 1016315;

  beforeAll((done) => {
    // Create http server to serve pdf data for tests.
    server = http.createServer((request, response) => {
      let filePath = process.cwd() + '/test/pdfs' + request.url;
      fs.lstat(filePath, (error, stat) => {
        if (error) {
          response.writeHead(404);
          response.end(`File ${request.url} not found!`);
          return;
        }
        if (!request.headers['range']) {
          let contentLength = stat.size;
          let stream = fs.createReadStream(filePath);
          response.writeHead(200, {
            'Content-Type': 'application/pdf',
            'Content-Length': contentLength,
            'Accept-Ranges': 'bytes',
          });
          stream.pipe(response);
        } else {
          let [start, end] =
            request.headers['range'].split('=')[1].split('-').map((x) => {
              return Number(x);
            });
          let stream = fs.createReadStream(filePath, { start, end, });
          response.writeHead(206, {
            'Content-Type': 'application/pdf',
          });
          stream.pipe(response);
        }
      });
    }).listen(0); /* Listen on a random free port */
    port = server.address().port;
    done();
  });

  afterAll((done) => {
    // Close the server from accepting new connections after all test finishes.
    server.close();
    done();
  });

  it('read both http(s) and filesystem pdf files', function(done) {
    let stream1 = new PDFNodeStream({
      url: `http://127.0.0.1:${port}/tracemonkey.pdf`,
      rangeChunkSize: 65536,
      disableStream: true,
      disableRange: true,
    });

    let stream2 = new PDFNodeStream({
      url: pdf,
      rangeChunkSize: 65536,
      disableStream: true,
      disableRange: true,
    });

    let fullReader1 = stream1.getFullReader();
    let fullReader2 = stream2.getFullReader();

    let isStreamingSupported1, isRangeSupported1;
    let promise1 = fullReader1.headersReady.then(() => {
      isStreamingSupported1 = fullReader1.isStreamingSupported;
      isRangeSupported1 = fullReader1.isRangeSupported;
    });

    let isStreamingSupported2, isRangeSupported2;
    let promise2 = fullReader2.headersReady.then(() => {
      isStreamingSupported2 = fullReader2.isStreamingSupported;
      isRangeSupported2 = fullReader2.isRangeSupported;
    });

    let len1 = 0, len2 = 0;
    let read1 = function () {
      return fullReader1.read().then(function (result) {
        if (result.done) {
          return undefined;
        }
        len1 += result.value.byteLength;
        return read1();
      });
    };
    let read2 = function () {
      return fullReader2.read().then(function (result) {
        if (result.done) {
          return undefined;
        }
        len2 += result.value.byteLength;
        return read2();
      });
    };

    let readPromise = Promise.all([read1(), read2(), promise1, promise2]);
    readPromise.then((result) => {
      expect(isStreamingSupported1).toEqual(false);
      expect(isRangeSupported1).toEqual(false);
      expect(isStreamingSupported2).toEqual(false);
      expect(isRangeSupported2).toEqual(false);
      expect(len1).toEqual(pdfLength);
      expect(len1).toEqual(len2);
      done();
    }).catch((reason) => {
      done.fail(reason);
    });
  });

  it('read custom ranges for both http(s) and filesystem urls',
      function(done) {
    let rangeSize = 32768;
    let stream1 = new PDFNodeStream({
      url: `http://127.0.0.1:${port}/tracemonkey.pdf`,
      length: pdfLength,
      rangeChunkSize: rangeSize,
      disableStream: true,
      disableRange: false,
    });
    let stream2 = new PDFNodeStream({
      url: pdf,
      length: pdfLength,
      rangeChunkSize: rangeSize,
      disableStream: true,
      disableRange: false,
    });

    let fullReader1 = stream1.getFullReader();
    let fullReader2 = stream2.getFullReader();

    let isStreamingSupported1, isRangeSupported1, fullReaderCancelled1;
    let isStreamingSupported2, isRangeSupported2, fullReaderCancelled2;

    let promise1 = fullReader1.headersReady.then(function () {
      isStreamingSupported1 = fullReader1.isStreamingSupported;
      isRangeSupported1 = fullReader1.isRangeSupported;
      // we shall be able to close the full reader without issues
      fullReader1.cancel(new AbortException('Don\'t need fullReader1.'));
      fullReaderCancelled1 = true;
    });

    let promise2 = fullReader2.headersReady.then(function () {
      isStreamingSupported2 = fullReader2.isStreamingSupported;
      isRangeSupported2 = fullReader2.isRangeSupported;
      fullReader2.cancel(new AbortException('Don\'t need fullReader2.'));
      fullReaderCancelled2 = true;
    });

    // Skipping fullReader results, requesting something from the PDF end.
    let tailSize = (pdfLength % rangeSize) || rangeSize;

    let range11Reader = stream1.getRangeReader(pdfLength - tailSize - rangeSize,
                                             pdfLength - tailSize);
    let range12Reader = stream1.getRangeReader(pdfLength - tailSize, pdfLength);

    let range21Reader = stream2.getRangeReader(pdfLength - tailSize - rangeSize,
                                             pdfLength - tailSize);
    let range22Reader = stream2.getRangeReader(pdfLength - tailSize, pdfLength);

    let result11 = { value: 0, }, result12 = { value: 0, };
    let result21 = { value: 0, }, result22 = { value: 0, };

    let read = function (reader, lenResult) {
      return reader.read().then(function (result) {
        if (result.done) {
          return undefined;
        }
        lenResult.value += result.value.byteLength;
        return read(reader, lenResult);
      });
    };

    let readPromises = Promise.all([read(range11Reader, result11),
                                    read(range12Reader, result12),
                                    read(range21Reader, result21),
                                    read(range22Reader, result22),
                                    promise1, promise2]);

    readPromises.then(function () {
      expect(result11.value).toEqual(rangeSize);
      expect(result12.value).toEqual(tailSize);
      expect(result21.value).toEqual(rangeSize);
      expect(result22.value).toEqual(tailSize);
      expect(isStreamingSupported1).toEqual(false);
      expect(isRangeSupported1).toEqual(true);
      expect(fullReaderCancelled1).toEqual(true);
      expect(isStreamingSupported2).toEqual(false);
      expect(isRangeSupported2).toEqual(true);
      expect(fullReaderCancelled2).toEqual(true);
      done();
    }).catch(function (reason) {
      done.fail(reason);
    });
  });
});