Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaces RequireJS to SystemJS. #8050

Merged
merged 1 commit into from
Feb 27, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@

globals: {
"PDFJSDev": false,
"require": false,
"exports": false,
"SystemJS": false,
},

"rules": {
Expand Down
8 changes: 5 additions & 3 deletions examples/helloworld/hello.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
'use strict';

// In production, the bundled pdf.js shall be used instead of RequireJS.
require.config({paths: {'pdfjs': '../../src'}});
require(['pdfjs/display/api', 'pdfjs/display/global'], function (api, global) {
// In production, the bundled pdf.js shall be used instead of SystemJS.
Promise.all([SystemJS.import('pdfjs/display/api'),
SystemJS.import('pdfjs/display/global')])
.then(function (modules) {
var api = modules[0], global = modules[1];
// In production, change this to point to the built `pdf.worker.js` file.
global.PDFJS.workerSrc = '../../src/worker_loader.js';

Expand Down
3 changes: 2 additions & 1 deletion examples/helloworld/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
<html>

<head>
<script src="../../node_modules/requirejs/require.js"></script>
<script src="../../node_modules/systemjs/dist/system.js"></script>
<script src="../../systemjs.config.js"></script>
<script src="hello.js"></script>
</head>

Expand Down
3 changes: 2 additions & 1 deletion examples/svgviewer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

<title>PDF.js SVG viewer example</title>

<script src="../../node_modules/requirejs/require.js"></script>
<script src="../../node_modules/systemjs/dist/system.js"></script>
<script src="../../systemjs.config.js"></script>
<script src="viewer.js"></script>

<style>
Expand Down
9 changes: 5 additions & 4 deletions examples/svgviewer/viewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,11 @@ function renderDocument(pdf, svgLib) {
}
}

// In production, the bundled pdf.js shall be used instead of RequireJS.
require.config({paths: {'pdfjs': '../../src'}});
require(['pdfjs/display/api', 'pdfjs/display/svg', 'pdfjs/display/global'],
function (api, svg, global) {
Promise.all([SystemJS.import('pdfjs/display/api'),
SystemJS.import('pdfjs/display/svg'),
SystemJS.import('pdfjs/display/global')])
.then(function (modules) {
var api = modules[0], svg = modules[1], global = modules[2];
// In production, change this to point to the built `pdf.worker.js` file.
global.PDFJS.workerSrc = '../../src/worker_loader.js';

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
"merge-stream": "^1.0.1",
"mkdirp": "^0.5.1",
"node-ensure": "^0.0.0",
"requirejs": "^2.1.22",
"rimraf": "^2.4.1",
"run-sequence": "^1.2.2",
"shelljs": "~0.4.0",
"streamqueue": "^1.1.1",
"systemjs": "^0.20.7",
"typogr": "~0.6.5",
"uglify-js": "^2.6.1",
"webpack": "^2.2.1",
Expand Down
27 changes: 13 additions & 14 deletions src/worker_loader.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,20 @@

'use strict';

if (typeof PDFJSDev === 'undefined' || !PDFJSDev.test('PRODUCTION')) {
// Patch importScripts to work around a bug in WebKit and Chrome 48-.
// See https://crbug.com/572225 and https://webkit.org/b/153317.
self.importScripts = (function (importScripts) {
return function() {
setTimeout(function () {}, 0);
return importScripts.apply(this, arguments);
};
})(importScripts);
}
// Patch importScripts to work around a bug in WebKit and Chrome 48-.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this change necessary? Shouldn't this block be moved to compatibility.js?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's needed only for requirejs (and probably for SystemJS as well) -- our tests were failing without it. Since we are not using src/worker_loader.js in the production anyway, I decided to remove the pre-processor from here.

// See https://crbug.com/572225 and https://webkit.org/b/153317.
self.importScripts = (function (importScripts) {
return function() {
setTimeout(function () {}, 0);
return importScripts.apply(this, arguments);
};
})(importScripts);

importScripts('../node_modules/requirejs/require.js');
importScripts('./shared/compatibility.js');
importScripts('../node_modules/systemjs/dist/system.js');
importScripts('../systemjs.config.js');

require.config({paths: {'pdfjs': '.'}});
require(['pdfjs/core/network', 'pdfjs/core/worker'],
function (network, worker) {
Promise.all([SystemJS.import('pdfjs/core/network'),
SystemJS.import('pdfjs/core/worker')]).then(function () {
// Worker is loaded at this point.
});
45 changes: 45 additions & 0 deletions systemjs.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/* 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.
*/

'use strict';

(function () {
var baseLocation;
if (typeof document !== 'undefined') {
baseLocation = new URL('./', document.currentScript.src);
} else if (typeof location !== 'undefined') {
// Probably worker -- walking subfolders until we will reach root.
baseLocation = location;
while (baseLocation.href.includes('/src/')) {
baseLocation = new URL('..', baseLocation);
}
} else {
throw new Error('Cannot configure SystemJS');
}

SystemJS.config({
packages: {
'': {
format: 'amd',
defaultExtension: 'js',
}
},
paths: {
'pdfjs': new URL('src', baseLocation).href,
'pdfjs-web': new URL('web', baseLocation).href,
'pdfjs-test': new URL('test', baseLocation).href,
}
});
})();
3 changes: 2 additions & 1 deletion test/font/font_test.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@

<link rel="stylesheet" type="text/css" href="../../node_modules/jasmine-core/lib/jasmine-core/jasmine.css">

<script src="../../node_modules/requirejs/require.js"></script>
<script src="../../node_modules/systemjs/dist/system.js"></script>
<script src="../../systemjs.config.js"></script>
<script src="../../node_modules/jasmine-core/lib/jasmine-core/jasmine.js"></script>
<script src="../../node_modules/jasmine-core/lib/jasmine-core/jasmine-html.js"></script>
<script src="../unit/testreporter.js"></script>
Expand Down
10 changes: 7 additions & 3 deletions test/font/jasmine-boot.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,13 @@
'use strict';

function initializePDFJS(callback) {
require.config({paths: {'pdfjs': '../../src'}});
require(['pdfjs/core/fonts', 'pdfjs/core/stream', 'pdfjs/core/primitives',
'pdfjs/core/cmap'], function (fonts, stream, primitives, cmap) {
Promise.all([SystemJS.import('pdfjs/core/fonts'),
SystemJS.import('pdfjs/core/stream'),
SystemJS.import('pdfjs/core/primitives'),
SystemJS.import('pdfjs/core/cmap')])
.then(function (modules) {
var fonts = modules[0], stream = modules[1],
primitives = modules[2], cmap = modules[3];
// Expose some of the PDFJS members to global scope for tests.
window.Font = fonts.Font;
window.ToUnicodeMap = fonts.ToUnicodeMap;
Expand Down
16 changes: 9 additions & 7 deletions test/test_slave.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
<head>
<title>PDF.js test slave</title>
<meta charset="utf-8">
<script src="../node_modules/requirejs/require.js"></script>
<script src="../node_modules/systemjs/dist/system.js"></script>
<script src="../systemjs.config.js"></script>
<script src="driver.js"></script>
</head>
<body>
Expand All @@ -31,12 +32,13 @@
<div id="end"></div>
</body>
<script>
require.config({paths: {'pdfjs': '../src'}});
require(['pdfjs/display/api', 'pdfjs/display/text_layer',
'pdfjs/display/annotation_layer', 'pdfjs/display/global',
'pdfjs/shared/util'],
function (api, textLayer, annotationLayer, global, pdfjsSharedUtil) {
window.pdfjsSharedUtil = pdfjsSharedUtil;
Promise.all([SystemJS.import('pdfjs/display/api'),
SystemJS.import('pdfjs/display/text_layer'),
SystemJS.import('pdfjs/display/annotation_layer'),
SystemJS.import('pdfjs/display/global'),
SystemJS.import('pdfjs/shared/util')])
.then(function (modules) {
window.pdfjsSharedUtil = modules[4];

var driver = new Driver({
disableScrolling: document.getElementById('disableScrolling'),
Expand Down
38 changes: 16 additions & 22 deletions test/unit/jasmine-boot.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,28 +41,22 @@
'use strict';

function initializePDFJS(callback) {
require.config({paths: {'pdfjs': '../../src', 'pdfjs-web': '../../web',
'pdfjs-test': '..'}});
require(['pdfjs/display/global', 'pdfjs-test/unit/annotation_spec',
'pdfjs-test/unit/api_spec', 'pdfjs-test/unit/bidi_spec',
'pdfjs-test/unit/cff_parser_spec', 'pdfjs-test/unit/cmap_spec',
'pdfjs-test/unit/crypto_spec', 'pdfjs-test/unit/document_spec',
'pdfjs-test/unit/dom_utils_spec', 'pdfjs-test/unit/evaluator_spec',
'pdfjs-test/unit/fonts_spec', 'pdfjs-test/unit/function_spec',
'pdfjs-test/unit/metadata_spec', 'pdfjs-test/unit/murmurhash3_spec',
'pdfjs-test/unit/network_spec', 'pdfjs-test/unit/parser_spec',
'pdfjs-test/unit/primitives_spec', 'pdfjs-test/unit/stream_spec',
'pdfjs-test/unit/type1_parser_spec',
'pdfjs-test/unit/ui_utils_spec', 'pdfjs-test/unit/unicode_spec',
'pdfjs-test/unit/util_spec'],
function (displayGlobal, testUnitAnnotationSpec, testUnitApiSpec,
testUnitBidiSpec, testUnitCFFParserSpec, testUnitCMapSpec,
testUnitCryptoSpec, testUnitDocumentSpec, testUnitDOMUtilsSpec,
testUnitEvaluatorSpec, testUnitFontsSpec, testUnitFunctionSpec,
testUnitMetadataSpec, testUnitMurmurHash3Spec,
testUnitNetworkSpec, testUnitParserSpec, testUnitPrimitivesSpec,
testUnitStreamSpec, testUnitType1ParserSpec, testUnitUiUtilsSpec,
testUnitUnicodeSpec, testUnitUtilSpec) {
Promise.all([
'pdfjs/display/global', 'pdfjs-test/unit/annotation_spec',
'pdfjs-test/unit/api_spec', 'pdfjs-test/unit/bidi_spec',
'pdfjs-test/unit/cff_parser_spec', 'pdfjs-test/unit/cmap_spec',
'pdfjs-test/unit/crypto_spec', 'pdfjs-test/unit/document_spec',
'pdfjs-test/unit/dom_utils_spec', 'pdfjs-test/unit/evaluator_spec',
'pdfjs-test/unit/fonts_spec', 'pdfjs-test/unit/function_spec',
'pdfjs-test/unit/metadata_spec', 'pdfjs-test/unit/murmurhash3_spec',
'pdfjs-test/unit/network_spec', 'pdfjs-test/unit/parser_spec',
'pdfjs-test/unit/primitives_spec', 'pdfjs-test/unit/stream_spec',
'pdfjs-test/unit/type1_parser_spec', 'pdfjs-test/unit/ui_utils_spec',
'pdfjs-test/unit/unicode_spec', 'pdfjs-test/unit/util_spec'
].map(function (moduleName) {
return SystemJS.import(moduleName);
})).then(function (modules) {
var displayGlobal = modules[0];

// Configure the worker.
displayGlobal.PDFJS.workerSrc = '../../src/worker_loader.js';
Expand Down
3 changes: 2 additions & 1 deletion test/unit/unit_test.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@

<link rel="stylesheet" type="text/css" href="../../node_modules/jasmine-core/lib/jasmine-core/jasmine.css">

<script src="../../node_modules/requirejs/require.js"></script>
<script src="../../node_modules/systemjs/dist/system.js"></script>
<script src="../../systemjs.config.js"></script>
<script src="../../node_modules/jasmine-core/lib/jasmine-core/jasmine.js"></script>
<script src="../../node_modules/jasmine-core/lib/jasmine-core/jasmine-html.js"></script>
<script src="testreporter.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion web/viewer.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@
<!--#endif-->

<!--#if !PRODUCTION-->
<script src="../node_modules/requirejs/require.js"></script>
<script src="../node_modules/systemjs/dist/system.js"></script>
<script src="../systemjs.config.js"></script>
<!--#endif-->

<!--#if (GENERIC && !MINIFIED) -->
Expand Down
10 changes: 6 additions & 4 deletions web/viewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,12 @@ function getViewerConfiguration() {
function webViewerLoad() {
var config = getViewerConfiguration();
if (typeof PDFJSDev === 'undefined' || !PDFJSDev.test('PRODUCTION')) {
require.config({paths: {'pdfjs': '../src', 'pdfjs-web': '.'}});
require(['pdfjs-web/app', 'pdfjs-web/pdf_print_service'], function (web) {
window.PDFViewerApplication = web.PDFViewerApplication;
web.PDFViewerApplication.run(config);
Promise.all([SystemJS.import('pdfjs-web/app'),
SystemJS.import('pdfjs-web/pdf_print_service')])
.then(function (modules) {
var app = modules[0];
window.PDFViewerApplication = app.PDFViewerApplication;
app.PDFViewerApplication.run(config);
});
} else {
window.PDFViewerApplication = pdfjsWebApp.PDFViewerApplication;
Expand Down