pdf.js/test/unit/util_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.
 */

import {
  bytesToString, createPromiseCapability, createValidAbsoluteUrl, isArrayBuffer,
  isBool, isEmptyObj, isNum, isSameOrigin, isSpace, isString, log2,
  ReadableStream, removeNullCharacters, string32, stringToBytes,
  stringToPDFString
} from '../../src/shared/util';

describe('util', function() {
  describe('bytesToString', function() {
    it('handles non-array arguments', function() {
      expect(function() {
        bytesToString(null);
      }).toThrow(new Error('Invalid argument for bytesToString'));
    });

    it('handles array arguments with a length not exceeding the maximum',
        function() {
      expect(bytesToString(new Uint8Array([]))).toEqual('');
      expect(bytesToString(new Uint8Array([102, 111, 111]))).toEqual('foo');
    });

    it('handles array arguments with a length exceeding the maximum',
        function() {
      const length = 10000; // Larger than MAX_ARGUMENT_COUNT = 8192.

      // Create an array with `length` 'a' character codes.
      let bytes = new Uint8Array(length);
      for (let i = 0; i < length; i++) {
        bytes[i] = 'a'.charCodeAt(0);
      }

      // Create a string with `length` 'a' characters. We need an array of size
      // `length + 1` since `join` puts the argument between the array elements.
      let string = Array(length + 1).join('a');

      expect(bytesToString(bytes)).toEqual(string);
    });
  });

  describe('isArrayBuffer', function() {
    it('handles array buffer values', function() {
      expect(isArrayBuffer(new ArrayBuffer(0))).toEqual(true);
      expect(isArrayBuffer(new Uint8Array(0))).toEqual(true);
    });

    it('handles non-array buffer values', function() {
      expect(isArrayBuffer('true')).toEqual(false);
      expect(isArrayBuffer(1)).toEqual(false);
      expect(isArrayBuffer(null)).toEqual(false);
      expect(isArrayBuffer(undefined)).toEqual(false);
    });
  });

  describe('isBool', function() {
    it('handles boolean values', function() {
      expect(isBool(true)).toEqual(true);
      expect(isBool(false)).toEqual(true);
    });

    it('handles non-boolean values', function() {
      expect(isBool('true')).toEqual(false);
      expect(isBool('false')).toEqual(false);
      expect(isBool(1)).toEqual(false);
      expect(isBool(0)).toEqual(false);
      expect(isBool(null)).toEqual(false);
      expect(isBool(undefined)).toEqual(false);
    });
  });

  describe('isEmptyObj', function() {
    it('handles empty objects', function() {
      expect(isEmptyObj({})).toEqual(true);
    });

    it('handles non-empty objects', function() {
      expect(isEmptyObj({ foo: 'bar', })).toEqual(false);
    });
  });

  describe('isNum', function() {
    it('handles numeric values', function() {
      expect(isNum(1)).toEqual(true);
      expect(isNum(0)).toEqual(true);
      expect(isNum(-1)).toEqual(true);
      expect(isNum(1000000000000000000)).toEqual(true);
      expect(isNum(12.34)).toEqual(true);
    });

    it('handles non-numeric values', function() {
      expect(isNum('true')).toEqual(false);
      expect(isNum(true)).toEqual(false);
      expect(isNum(null)).toEqual(false);
      expect(isNum(undefined)).toEqual(false);
    });
  });

  describe('isSpace', function() {
    it('handles space characters', function() {
      expect(isSpace(0x20)).toEqual(true);
      expect(isSpace(0x09)).toEqual(true);
      expect(isSpace(0x0D)).toEqual(true);
      expect(isSpace(0x0A)).toEqual(true);
    });

    it('handles non-space characters', function() {
      expect(isSpace(0x0B)).toEqual(false);
      expect(isSpace(null)).toEqual(false);
      expect(isSpace(undefined)).toEqual(false);
    });
  });

  describe('isString', function() {
    it('handles string values', function() {
      expect(isString('foo')).toEqual(true);
      expect(isString('')).toEqual(true);
    });

    it('handles non-string values', function() {
      expect(isString(true)).toEqual(false);
      expect(isString(1)).toEqual(false);
      expect(isString(null)).toEqual(false);
      expect(isString(undefined)).toEqual(false);
    });
  });

  describe('log2', function() {
    it('handles values smaller than/equal to zero', function() {
      expect(log2(0)).toEqual(0);
      expect(log2(-1)).toEqual(0);
    });

    it('handles values larger than zero', function() {
      expect(log2(1)).toEqual(0);
      expect(log2(2)).toEqual(1);
      expect(log2(3)).toEqual(2);
      expect(log2(3.14)).toEqual(2);
    });
  });

  describe('string32', function() {
    it('converts unsigned 32-bit integers to strings', function() {
      expect(string32(0x74727565)).toEqual('true');
      expect(string32(0x74797031)).toEqual('typ1');
      expect(string32(0x4F54544F)).toEqual('OTTO');
    });
  });

  describe('stringToBytes', function() {
    it('handles non-string arguments', function() {
      expect(function() {
        stringToBytes(null);
      }).toThrow(new Error('Invalid argument for stringToBytes'));
    });

    it('handles string arguments', function() {
      expect(stringToBytes('')).toEqual(new Uint8Array([]));
      expect(stringToBytes('foo')).toEqual(new Uint8Array([102, 111, 111]));
    });
  });

  describe('stringToPDFString', function() {
    it('handles ISO Latin 1 strings', function() {
      let str = '\x8Dstring\x8E';
      expect(stringToPDFString(str)).toEqual('\u201Cstring\u201D');
    });

    it('handles UTF-16 big-endian strings', function() {
      let str = '\xFE\xFF\x00\x73\x00\x74\x00\x72\x00\x69\x00\x6E\x00\x67';
      expect(stringToPDFString(str)).toEqual('string');
    });

    it('handles UTF-16 little-endian strings', function() {
      let str = '\xFF\xFE\x73\x00\x74\x00\x72\x00\x69\x00\x6E\x00\x67\x00';
      expect(stringToPDFString(str)).toEqual('string');
    });

    it('handles empty strings', function() {
      // ISO Latin 1
      let str1 = '';
      expect(stringToPDFString(str1)).toEqual('');

      // UTF-16BE
      let str2 = '\xFE\xFF';
      expect(stringToPDFString(str2)).toEqual('');

      // UTF-16LE
      let str3 = '\xFF\xFE';
      expect(stringToPDFString(str3)).toEqual('');
    });
  });

  describe('removeNullCharacters', function() {
    it('should not modify string without null characters', function() {
      let str = 'string without null chars';
      expect(removeNullCharacters(str)).toEqual('string without null chars');
    });

    it('should modify string with null characters', function() {
      let str = 'string\x00With\x00Null\x00Chars';
      expect(removeNullCharacters(str)).toEqual('stringWithNullChars');
    });
  });

  describe('ReadableStream', function() {
    it('should return an Object', function () {
      let readable = new ReadableStream();
      expect(typeof readable).toEqual('object');
    });

    it('should have property getReader', function () {
      let readable = new ReadableStream();
      expect(typeof readable.getReader).toEqual('function');
    });
  });

  describe('URL', function() {
    it('should return an Object', function() {
      const url = new URL('https://example.com');
      expect(typeof url).toEqual('object');
    });

    it('should have property `href`', function() {
      const url = new URL('https://example.com');
      expect(typeof url.href).toEqual('string');
    });
  });

  describe('isSameOrigin', function() {
    it('handles invalid base URLs', function() {
      // The base URL is not valid.
      expect(isSameOrigin('/foo', '/bar')).toEqual(false);

      // The base URL has no origin.
      expect(isSameOrigin('blob:foo', '/bar')).toEqual(false);
    });

    it('correctly checks if the origin of both URLs matches', function() {
      expect(isSameOrigin('https://www.mozilla.org/foo',
                          'https://www.mozilla.org/bar')).toEqual(true);
      expect(isSameOrigin('https://www.mozilla.org/foo',
                          'https://www.example.com/bar')).toEqual(false);
    });
  });

  describe('createValidAbsoluteUrl', function() {
    it('handles invalid URLs', function() {
      expect(createValidAbsoluteUrl(undefined, undefined)).toEqual(null);
      expect(createValidAbsoluteUrl(null, null)).toEqual(null);
      expect(createValidAbsoluteUrl('/foo', '/bar')).toEqual(null);
    });

    it('handles URLs that do not use a whitelisted protocol', function() {
      expect(createValidAbsoluteUrl('magnet:?foo', null)).toEqual(null);
    });

    it('correctly creates a valid URL for whitelisted protocols', function() {
      // `http` protocol
      expect(createValidAbsoluteUrl('http://www.mozilla.org/foo', null))
        .toEqual(new URL('http://www.mozilla.org/foo'));
      expect(createValidAbsoluteUrl('/foo', 'http://www.mozilla.org'))
        .toEqual(new URL('http://www.mozilla.org/foo'));

      // `https` protocol
      expect(createValidAbsoluteUrl('https://www.mozilla.org/foo', null))
        .toEqual(new URL('https://www.mozilla.org/foo'));
      expect(createValidAbsoluteUrl('/foo', 'https://www.mozilla.org'))
        .toEqual(new URL('https://www.mozilla.org/foo'));

      // `ftp` protocol
      expect(createValidAbsoluteUrl('ftp://www.mozilla.org/foo', null))
        .toEqual(new URL('ftp://www.mozilla.org/foo'));
      expect(createValidAbsoluteUrl('/foo', 'ftp://www.mozilla.org'))
        .toEqual(new URL('ftp://www.mozilla.org/foo'));

      // `mailto` protocol (base URLs have no meaning and should yield `null`)
      expect(createValidAbsoluteUrl('mailto:foo@bar.baz', null))
        .toEqual(new URL('mailto:foo@bar.baz'));
      expect(createValidAbsoluteUrl('/foo', 'mailto:foo@bar.baz'))
        .toEqual(null);

      // `tel` protocol (base URLs have no meaning and should yield `null`)
      expect(createValidAbsoluteUrl('tel:+0123456789', null))
        .toEqual(new URL('tel:+0123456789'));
      expect(createValidAbsoluteUrl('/foo', 'tel:0123456789'))
        .toEqual(null);
    });
  });

  describe('createPromiseCapability', function() {
    it('should resolve with correct data', function(done) {
      const promiseCapability = createPromiseCapability();
      expect(promiseCapability.settled).toEqual(false);

      promiseCapability.resolve({ test: 'abc', });

      promiseCapability.promise.then(function(data) {
        expect(promiseCapability.settled).toEqual(true);

        expect(data).toEqual({ test: 'abc', });
        done();
      }, done.fail);
    });

    it('should reject with correct reason', function(done) {
      const promiseCapability = createPromiseCapability();
      expect(promiseCapability.settled).toEqual(false);

      promiseCapability.reject(new Error('reason'));

      promiseCapability.promise.then(done.fail, function(reason) {
        expect(promiseCapability.settled).toEqual(true);

        expect(reason instanceof Error).toEqual(true);
        expect(reason.message).toEqual('reason');
        done();
      });
    });
  });
});