Upgrade: pdf.js 2.0.363 (#659)

- pdf.js 2.x updated the way workers are used. We can no longer prefetch the worker and instead must preload it
- Latest patch also respects `PDFJS.workerSrc` over any internal overrides, which previously could cause issues with RequireJS
- Fix upgrade_pdfjs.sh patch to properly list last pdf.js version

build/karma.conf.js

@@ -3,7 +3,7 @@ const webpackConfig = require('./webpack.karma.config');
 
 // These should be updated to match the Preview version in package.json whenever a file in that third party directory
 // is updated. Also, update the matching configuration in constants.js, which is needed for main preview functionality
-const DOC_STATIC_ASSETS_VERSION = '1.17.0';
+const DOC_STATIC_ASSETS_VERSION = '1.30.0';
 const MEDIA_STATIC_ASSETS_VERSION = '1.30.0';
 const MODEL3D_STATIC_ASSETS_VERSION = '1.12.0';
 const SWF_STATIC_ASSETS_VERSION = '0.112.0';

build/upgrade_pdfjs.sh

@@ -2,7 +2,7 @@ DOC_STATIC_ASSETS_VERSION=$(./build/current_version.sh)
 DOC_STATIC_ASSETS_PATH="src/third-party/doc/$DOC_STATIC_ASSETS_VERSION"
 
 if [ ! -d $DOC_STATIC_ASSETS_PATH ]; then
-    DOC_LATEST_STATIC_ASSETS=`ls src/third-party/doc | sort -nr | head -1`
+    DOC_LATEST_STATIC_ASSETS=`ls src/third-party/doc | sort -t "." -k1,1n -k2,2n -k3,3n | tail -1`
     echo "Latest version is $DOC_LATEST_STATIC_ASSETS"
     `cp -R src/third-party/doc/$DOC_LATEST_STATIC_ASSETS $DOC_STATIC_ASSETS_PATH`
     echo "Created build directory for $DOC_STATIC_ASSETS_PATH"

src/lib/__tests__/util-test.js

@@ -204,6 +204,16 @@ describe('lib/util', () => {
             expect(linkEl.rel).to.equal('prefetch');
             expect(linkEl.href.indexOf(url) !== -1).to.be.true;
         });
+
+        it('should return a preload link element when a url is provided and preload is true', () => {
+            const url = 'foo.js';
+            const linkEl = util.createPrefetch(url, true);
+            expect(linkEl instanceof HTMLElement).to.be.true;
+            expect(linkEl.tagName).to.equal('LINK');
+            expect(linkEl.rel).to.equal('preload');
+            expect(linkEl.as).to.equal('script');
+            expect(linkEl.href.indexOf(url) !== -1).to.be.true;
+        });
     });
 
     describe('createStylesheet()', () => {
@@ -362,6 +372,12 @@ describe('lib/util', () => {
                 assert.ok(head.querySelector('link[rel="prefetch"][href="foo"]') instanceof HTMLLinkElement);
                 assert.ok(head.querySelector('link[rel="prefetch"][href="bar"]') instanceof HTMLLinkElement);
             });
+
+            it('should insert links with preload if specified', () => {
+                util.prefetchAssets(['foo'], true);
+                const head = document.head;
+                assert.ok(head.querySelector('link[rel="preload"][href="foo"]') instanceof HTMLLinkElement);
+            })
         });
 
         describe('loadStylesheets()', () => {

src/lib/constants.js

@@ -93,7 +93,7 @@ export const PDFJS_HEIGHT_PADDING_PX = 5; // Should match VERTICAL_PADDING in pd
 
 // These should be updated to match the Preview version in package.json whenever a file in that third party directory
 // is updated. Also, update the matching configuration in karma.conf.js, which is needed for tests
-export const DOC_STATIC_ASSETS_VERSION = '1.17.0';
+export const DOC_STATIC_ASSETS_VERSION = '1.30.0';
 export const MEDIA_STATIC_ASSETS_VERSION = '1.30.0';
 export const MODEL3D_STATIC_ASSETS_VERSION = '1.12.0';
 export const SWF_STATIC_ASSETS_VERSION = '0.112.0';

src/lib/util.js

@@ -277,12 +277,18 @@ export function createScript(url) {
  *
  * @public
  * @param {string} url - Asset urls
+ * @param {boolean} preload - Whether or not to use preload, default false
  * @return {HTMLElement} Prefetch link element
  */
-export function createPrefetch(url) {
+export function createPrefetch(url, preload = false) {
     const link = document.createElement('link');
-    link.rel = 'prefetch';
+    link.rel = preload ? 'preload' : 'prefetch';
     link.href = url;
+
+    if (preload) {
+        link.as = url.indexOf('.js') !== -1 ? 'script' : 'style';
+    }
+
     return link;
 }
 
@@ -433,14 +439,16 @@ export function createAssetUrlCreator(location) {
  *
  * @public
  * @param {Array} urls - Asset urls
+ * @param {boolean} preload - Use preload instead of prefetch, default false
  * @return {void}
  */
-export function prefetchAssets(urls) {
+export function prefetchAssets(urls, preload = false) {
     const { head } = document;
+    const rel = preload ? 'preload' : 'prefetch';
 
     urls.forEach((url) => {
-        if (!head.querySelector(`link[rel="prefetch"][href="${url}"]`)) {
-            head.appendChild(createPrefetch(url));
+        if (!head.querySelector(`link[rel="${rel}"][href="${url}"]`)) {
+            head.appendChild(createPrefetch(url, preload));
         }
     });
 }

src/lib/viewers/BaseViewer.js

@@ -627,18 +627,19 @@ class BaseViewer extends EventEmitter {
      * @protected
      * @param {Array} [js] - js assets
      * @param {Array} [css] - css assets
+     * @param {boolean} preload - Use preload instead of prefetch, default false
      * @return {void}
      */
-    prefetchAssets(js, css) {
+    prefetchAssets(js, css, preload = false) {
         // Create an asset path creator function
         const { location } = this.options;
         const assetUrlCreator = createAssetUrlCreator(location);
 
         // Prefetch the stylesheets needed for this preview
-        prefetchAssets((css || []).map(assetUrlCreator));
+        prefetchAssets((css || []).map(assetUrlCreator), preload);
 
         // Prefetch the scripts needed for this preview
-        prefetchAssets((js || []).map(assetUrlCreator));
+        prefetchAssets((js || []).map(assetUrlCreator), preload);
     }
 
     /**

src/lib/viewers/__tests__/BaseViewer-test.js

@@ -747,6 +747,16 @@ describe('lib/viewers/BaseViewer', () => {
             expect(util.createAssetUrlCreator).to.be.calledWith(base.options.location);
             expect(util.prefetchAssets).to.be.calledTwice;
         });
+
+        it('should create an asset URL and preload the relevant stylesheets and scripts if preload is true', () => {
+            base.options.location = {};
+
+            sandbox.stub(util, 'createAssetUrlCreator').returns(() => {});
+            sandbox.stub(util, 'prefetchAssets');
+
+            base.prefetchAssets([], [], true);
+            expect(util.prefetchAssets).to.be.calledWith(sinon.match.any, true);
+        });
     });
 
     describe('getRepStatus()', () => {

src/lib/viewers/doc/DocBaseViewer.js

@@ -21,7 +21,7 @@ import {
 import { checkPermission, getRepresentation } from '../../file';
 import { get, createAssetUrlCreator, getMidpoint, getDistance, getClosestPageToPinch } from '../../util';
 import { ICON_PRINT_CHECKMARK } from '../../icons/icons';
-import { JS, CSS } from './docAssets';
+import { JS, PRELOAD_JS, CSS } from './docAssets';
 import { VIEWER_EVENT } from '../../events';
 
 const CURRENT_PAGE_MAP_KEY = 'doc-current-page-map';
@@ -167,6 +167,7 @@ class DocBaseViewer extends BaseViewer {
 
         if (assets) {
             this.prefetchAssets(JS, CSS);
+            this.prefetchAssets(PRELOAD_JS, [], true);
         }
 
         if (preload && !isWatermarked) {
@@ -610,6 +611,8 @@ class DocBaseViewer extends BaseViewer {
         const { file, location } = this.options;
         const { size, watermark_info: watermarkInfo } = file;
         const assetUrlCreator = createAssetUrlCreator(location);
+
+        // Set pdf.js worker, image, and character map locations
         PDFJS.workerSrc = assetUrlCreator(`third-party/doc/${DOC_STATIC_ASSETS_VERSION}/pdf.worker.min.js`);
         PDFJS.imageResourcesPath = assetUrlCreator(`third-party/doc/${DOC_STATIC_ASSETS_VERSION}/images/`);
         PDFJS.cMapUrl = `${location.staticBaseURI}third-party/doc/${DOC_STATIC_ASSETS_VERSION}/cmaps/`;

src/lib/viewers/doc/docAssets.js

@@ -1,10 +1,6 @@
 import { DOC_STATIC_ASSETS_VERSION } from '../../constants';
 
 const STATIC_URI = `third-party/doc/${DOC_STATIC_ASSETS_VERSION}/`;
-export const JS = [
-    `${STATIC_URI}pdf.min.js`,
-    `${STATIC_URI}pdf_viewer.min.js`,
-    `${STATIC_URI}pdf.worker.min.js`,
-    `${STATIC_URI}exif.min.js`
-];
+export const JS = [`${STATIC_URI}pdf.min.js`, `${STATIC_URI}pdf_viewer.min.js`, `${STATIC_URI}exif.min.js`];
+export const PRELOAD_JS = [`${STATIC_URI}pdf.worker.min.js`];
 export const CSS = [`${STATIC_URI}pdf_viewer.min.css`];

src/third-party/doc/1.30.0/cmaps/CNS2-V.bcmap

@@ -0,0 +1,3 @@
+�RCopyright 1990-2009 Adobe Systems Incorporated.
+All rights reserved.
+See ./LICENSE�CNS2-H

src/third-party/doc/1.30.0/cmaps/ETenms-B5-H.bcmap

@@ -0,0 +1,3 @@
+�RCopyright 1990-2009 Adobe Systems Incorporated.
+All rights reserved.
+See ./LICENSE�	ETen-B5-H`
 ^

src/third-party/doc/1.30.0/cmaps/GB-H.bcmap

@@ -0,0 +1,4 @@
+�RCopyright 1990-2009 Adobe Systems Incorporated.
+All rights reserved.
+See ./LICENSE

!!��]aX!!]`�21�>	�p�z�$]��"R�d�-U�7�*�4�%�+ �Z �{�/�%�<�9K�b�1]�.�"��`]�,�"]�
+�"]�h�"]�F�"]�$�"]��"]�`�"]�>�"]��"]�z�"]�X�"]�6�"]��"]�r�"]�P�"]�.�"]��"]�j�"]�H�"]�&�"]��"]�b�"]�@�"]��"]�|�"]�Z�"]�8�"]��"]�t�"]�R�"]�0�"]��"]�l�"]�J�"]�(�"]��"]�d�"]�B�"]� �"X�~�']�W�"]�5�"]��"]�q�"]�O�"]�-�"]��"]�i�"]�G�"]�%�"]��"]�a�"]�?�"]��"]�{�"]�Y�"]�7�"]��"]�s�"]�Q�"]�/�"]��"]�k�"]�I�"]�'�"]��"]�c�"]�A�"]��"]�}�"]�[�"]�9

src/third-party/doc/1.30.0/cmaps/LICENSE

@@ -0,0 +1,36 @@
+%%Copyright: -----------------------------------------------------------
+%%Copyright: Copyright 1990-2009 Adobe Systems Incorporated.
+%%Copyright: All rights reserved.
+%%Copyright:
+%%Copyright: Redistribution and use in source and binary forms, with or
+%%Copyright: without modification, are permitted provided that the
+%%Copyright: following conditions are met:
+%%Copyright:
+%%Copyright: Redistributions of source code must retain the above
+%%Copyright: copyright notice, this list of conditions and the following
+%%Copyright: disclaimer.
+%%Copyright:
+%%Copyright: Redistributions in binary form must reproduce the above
+%%Copyright: copyright notice, this list of conditions and the following
+%%Copyright: disclaimer in the documentation and/or other materials
+%%Copyright: provided with the distribution. 
+%%Copyright:
+%%Copyright: Neither the name of Adobe Systems Incorporated nor the names
+%%Copyright: of its contributors may be used to endorse or promote
+%%Copyright: products derived from this software without specific prior
+%%Copyright: written permission. 
+%%Copyright:
+%%Copyright: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+%%Copyright: CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+%%Copyright: INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+%%Copyright: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+%%Copyright: DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+%%Copyright: CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+%%Copyright: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+%%Copyright: NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+%%Copyright: LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+%%Copyright: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+%%Copyright: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+%%Copyright: OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+%%Copyright: SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+%%Copyright: -----------------------------------------------------------