Upgrade: pdf.js v2.0.550

- Upgrade to the official pdf.js 2.0 pre-release (see mozilla/pdf.js#9521)
- Upgrade minifier to Google Closure Compiler release from 2018-06-10
- Minify pdf.js assets
- Update upgrade pdf.js script to support passing in a version tag, e.g. `yarn upgrade-pdfjs v2.0.550`
- Update document viewer code to reference pdf.js the v2.0 way
- Enable rendering of e-signatures without validation

TODO:
- Fix tests

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.46.0';
 const MEDIA_STATIC_ASSETS_VERSION = '1.33.0';
 const MODEL3D_STATIC_ASSETS_VERSION = '1.12.0';
 const SWF_STATIC_ASSETS_VERSION = '0.112.0';

build/minify_pdfjs.sh

@@ -6,11 +6,11 @@ DOC_STATIC_ASSETS_VERSION=$(./build/current_version.sh)
 echo "-----------------------------------------------------------------------------------"
 echo "Minifying pdf.js files with Google Closure... Warnings are okay!"
 echo "-----------------------------------------------------------------------------------"
-java -jar build/closure-compiler-v20161201.jar --rewrite_polyfills false --language_out ECMASCRIPT5 --js src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.js --js_output_file src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.min.js
+java -jar build/closure-compiler-v20180610.jar --rewrite_polyfills false --language_out ECMASCRIPT5 --js src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.js --js_output_file src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.min.js
 
-java -jar build/closure-compiler-v20161201.jar --rewrite_polyfills false --language_out ECMASCRIPT5 --js src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.worker.js --js_output_file src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.worker.min.js
+java -jar build/closure-compiler-v20180610.jar --rewrite_polyfills false --language_out ECMASCRIPT5 --js src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.worker.js --js_output_file src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.worker.min.js
 
-java -jar build/closure-compiler-v20161201.jar --rewrite_polyfills false --language_out ECMASCRIPT5 --js src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf_viewer.js --js_output_file src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf_viewer.min.js
+java -jar build/closure-compiler-v20180610.jar --rewrite_polyfills false --language_out ECMASCRIPT5 --js src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf_viewer.js --js_output_file src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf_viewer.min.js
 echo "-----------------------------------------------------------------------------------"
 echo "Minifying pdf.js CSS with cssnano"
 echo "-----------------------------------------------------------------------------------"

build/upgrade_pdfjs.sh

@@ -1,10 +1,19 @@
+# Run ./fetch_pdfjs.sh $VERSION to upgrade to that version (e.g. ./fetch_pdfjs.sh v2.0.550) or with no arguments to
+# upgrade to the bleeding edge
+
+echo "$1";
+
 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 -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`
+    rm src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.min.js
+    rm src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.worker.min.js
+    rm src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf_viewer.min.js
+    rm src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf_viewer.min.css
     echo "Created build directory for $DOC_STATIC_ASSETS_PATH"
 fi
 
@@ -14,6 +23,15 @@ echo "--------------------------------------------------------------------------
 rm -rf ./pdfjs-dist/
 git clone https://github.com/mozilla/pdfjs-dist.git
 
+if [ ! -z "$1" ]; then
+    echo "-------------------------------------------------------------------------------"
+    echo "Checking out pdf.js $1"
+    echo "-------------------------------------------------------------------------------"
+    cd pdfjs-dist/
+    git checkout $1
+    cd ..
+fi
+
 echo "-----------------------------------------------------------------------------------"
 echo "Copying relevant files to Preview third-party dir..."
 echo "-----------------------------------------------------------------------------------"
@@ -32,6 +50,17 @@ sed -e 's/function supportsMozChunkedClosure/!\(\/Chrome\/\.test\(navigator\.use
 
 # Decreased default cached pages size to 5 on mobile web to lower memory usage
 echo "-----------------------------------------------------------------------------------"
-echo "Decreasing # of cached pages on mobile web"
+echo "Decreasing # of cached pages on mobile web..."
 echo "-----------------------------------------------------------------------------------"
 sed -e 's@var DEFAULT_CACHE_SIZE = 10;@var DEFAULT_CACHE_SIZE = /iphone|ipad|ipod|android|blackberry|bb10|mini|windows\sce|palm/i.test(navigator.userAgent) ? 5 : 10;@' -i '' src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf_viewer.js
+
+# Render e-signatures without validation
+echo "-----------------------------------------------------------------------------------"
+echo "Enabling e-signature rendering without validation..."
+echo "-----------------------------------------------------------------------------------"
+sed -e 's@_this2.setFlags(_util.AnnotationFlag.HIDDEN);@\/\/_this2.setFlags(_util.AnnotationFlag.HIDDEN);@' -i '' src/third-party/doc/$DOC_STATIC_ASSETS_VERSION/pdf.worker.js
+
+echo "-----------------------------------------------------------------------------------"
+echo "Fetched latest pdf.js!"
+echo "-----------------------------------------------------------------------------------"
+./build/minify_pdfjs.sh

package.json

@@ -118,7 +118,7 @@
     "prod": "yarn run build-rb && BABEL_ENV=production NODE_ENV=production node --max_old_space_size=4096 ./node_modules/webpack/bin/webpack.js --progress --colors --config build/webpack.config.js",
     "release": "yarn run clean && yarn run build-rb && yarn run lint && yarn run test && yarn run prod",
     "test": "yarn install && NODE_ENV=test node --max_old_space_size=4096 ./node_modules/.bin/karma start build/karma.conf.js",
-    "upgrade-pdfjs": "./build/upgrade_pdfjs.sh && ./build/minify_pdfjs.sh",
+    "upgrade-pdfjs": "./build/upgrade_pdfjs.sh",
     "upgrade-annotations": "./build/upgrade_annotations.sh",
     "watch": "yarn install && BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack --watch --progress --colors --config build/webpack.config.js",
     "major": "./build/release.sh -m",

src/lib/constants.js

@@ -97,7 +97,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.46.0';
 export const MEDIA_STATIC_ASSETS_VERSION = '1.33.0';
 export const MODEL3D_STATIC_ASSETS_VERSION = '1.12.0';
 export const SWF_STATIC_ASSETS_VERSION = '0.112.0';

src/lib/viewers/doc/DocBaseViewer.js

@@ -303,8 +303,7 @@ class DocBaseViewer extends BaseViewer {
         this.findBarEl = this.containerEl.appendChild(document.createElement('div'));
         this.findBarEl.classList.add(CLASS_BOX_PREVIEW_FIND_BAR);
 
-        /* global PDFJS */
-        this.findController = new PDFJS.PDFFindController({
+        this.findController = new this.pdfjsViewer.PDFFindController({
             pdfViewer: this.pdfViewer
         });
         this.pdfViewer.setFindController(this.findController);
@@ -571,7 +570,7 @@ class DocBaseViewer extends BaseViewer {
         }
 
         // If range requests are enabled, request the non-gzip compressed version of the representation
-        if (!PDFJS.disableRange) {
+        if (!this.pdfjsLib.disableRange) {
             docInitParams.httpHeaders = docInitParams.httpHeaders || {};
             docInitParams.httpHeaders[X_BOX_ACCEPT_ENCODING_HEADER] = X_BOX_ACCEPT_ENCODING_IDENTITY;
         }
@@ -581,13 +580,13 @@ class DocBaseViewer extends BaseViewer {
 
         // Load PDF from representation URL and set as document for pdf.js. Cache
         // the loading task so we can cancel if needed
-        this.pdfLoadingTask = PDFJS.getDocument(docInitParams);
+        this.pdfLoadingTask = this.pdfjsLib.getDocument(docInitParams);
         return this.pdfLoadingTask
             .then((doc) => {
                 this.pdfViewer.setDocument(doc);
 
                 const { linkService } = this.pdfViewer;
-                if (linkService instanceof PDFJS.PDFLinkService) {
+                if (linkService instanceof this.pdfjsViewer.PDFLinkService) {
                     linkService.setDocument(doc, pdfUrl);
                     linkService.setViewer(this.pdfViewer);
                 }
@@ -607,12 +606,12 @@ class DocBaseViewer extends BaseViewer {
      *
      * @protected
      * @override
-     * @return {PDFJS.PDFViewer} PDF viewer type
+     * @return {Object} PDF viewer type
      */
     initPdfViewer() {
-        return new PDFJS.PDFViewer({
+        return new this.pdfjsViewer.PDFViewer({
             container: this.docEl,
-            linkService: new PDFJS.PDFLinkService(),
+            linkService: new this.pdfjsViewer.PDFLinkService(),
             // Enhanced text selection uses more memory, so disable on mobile
             enhanceTextSelection: !this.isMobile
         });
@@ -652,52 +651,56 @@ class DocBaseViewer extends BaseViewer {
      * @private
      */
     setupPdfjs() {
-        // Set PDFJS worker & character maps
+        // pdf.js v2.0 no longer exposes a single global PDFJS variable
+        this.pdfjsLib = window['pdfjs-dist/build/pdf'];
+        this.pdfjsViewer = window['pdfjs-dist/web/pdf_viewer'];
+
+        // Set pdf.js worker & character maps
         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/`;
-        PDFJS.cMapPacked = true;
+        this.pdfjsLib.workerSrc = assetUrlCreator(`third-party/doc/${DOC_STATIC_ASSETS_VERSION}/pdf.worker.min.js`);
+        this.pdfjsLib.imageResourcesPath = assetUrlCreator(`third-party/doc/${DOC_STATIC_ASSETS_VERSION}/images/`);
+        this.pdfjsLib.cMapUrl = `${location.staticBaseURI}third-party/doc/${DOC_STATIC_ASSETS_VERSION}/cmaps/`;
+        this.pdfjsLib.cMapPacked = true;
 
         // Open links in new tab
-        PDFJS.externalLinkTarget = PDFJS.LinkTarget.BLANK;
+        this.pdfjsLib.externalLinkTarget = this.pdfjsLib.LinkTarget.BLANK;
 
         // Disable streaming via fetch until performance is improved
-        PDFJS.disableStream = true;
+        this.pdfjsLib.disableStream = true;
 
         // Disable font faces on IOS 10.3.X
         // @NOTE(JustinHoldstock) 2017-04-11: Check to remove this after next IOS release after 10.3.1
-        PDFJS.disableFontFace = PDFJS.disableFontFace || Browser.hasFontIssue();
+        this.pdfjsLib.disableFontFace = this.pdfjsLib.disableFontFace || Browser.hasFontIssue();
 
         // Disable range requests for files smaller than MINIMUM_RANGE_REQUEST_FILE_SIZE (25MB) for
         // previews outside of the US since the additional latency overhead per range request can be
         // more than the additional time for a continuous request. This also overrides any range request
         // disabling that may be set by pdf.js's compatibility checking since the browsers we support
         // should all be able to properly handle range requests.
-        PDFJS.disableRange = location.locale !== 'en-US' && size < MINIMUM_RANGE_REQUEST_FILE_SIZE_NON_US;
+        this.pdfjsLib.disableRange = location.locale !== 'en-US' && size < MINIMUM_RANGE_REQUEST_FILE_SIZE_NON_US;
 
         // Disable range requests for watermarked files since they are streamed
-        PDFJS.disableRange = PDFJS.disableRange || (watermarkInfo && watermarkInfo.is_watermarked);
+        this.pdfjsLib.disableRange = this.pdfjsLib.disableRange || (watermarkInfo && watermarkInfo.is_watermarked);
 
         // Disable text layer if user doesn't have download permissions
-        PDFJS.disableTextLayer =
+        this.pdfjsLib.disableTextLayer =
             !checkPermission(file, PERMISSION_DOWNLOAD) || !!this.getViewerOption('disableTextLayer');
 
         // Decrease mobile canvas size to ~3MP (1920x1536)
-        PDFJS.maxCanvasPixels = this.isMobile ? MOBILE_MAX_CANVAS_SIZE : PDFJS.maxCanvasPixels;
+        this.pdfjsLib.maxCanvasPixels = this.isMobile ? MOBILE_MAX_CANVAS_SIZE : this.pdfjsLib.maxCanvasPixels;
 
         // Do not disable create object URL in IE11 or iOS Chrome - pdf.js issues #3977 and #8081 are
         // not applicable to Box's use case and disabling causes performance issues
-        PDFJS.disableCreateObjectURL = false;
+        this.pdfjsLib.disableCreateObjectURL = false;
 
         // Customize pdf.js loading icon. We modify the prototype of PDFPageView to get around directly modifying
         // pdf_viewer.js
-        const resetFunc = PDFJS.PDFPageView.prototype.reset;
-        PDFJS.PDFPageView.prototype.reset = function reset(...args) {
+        const resetFunc = this.pdfjsViewer.PDFPageView.prototype.reset;
+        this.pdfjsViewer.PDFPageView.prototype.reset = function reset(...args) {
             resetFunc.bind(this)(args);
             this.loadingIconDiv.classList.add(CLASS_SPINNER);
             this.loadingIconDiv.innerHTML = '<div></div>';

src/lib/viewers/doc/SinglePageViewer.js

@@ -10,12 +10,12 @@ class SinglePageViewer extends DocumentViewer {
      *
      * @protected
      * @override
-     * @return {PDFJS.PDFViewer} PDF viewer type
+     * @return {Object} PDF viewer type
      */
     initPdfViewer() {
-        return new PDFJS.PDFSinglePageViewer({
+        return new this.pdfjsViewer.PDFSinglePageViewer({
             container: this.docEl,
-            linkService: new PDFJS.PDFLinkService(),
+            linkService: new this.pdfjsViewer.PDFLinkService(),
             // Enhanced text selection uses more memory, so disable on mobile
             enhanceTextSelection: !this.isMobile
         });

src/third-party/doc/1.46.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.46.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.46.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.46.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: -----------------------------------------------------------