Adds/modifies examples for node.js and webpack. #6785

yurydelendik · 2015-12-20T14:54:43Z

Modifies and cleans up node.js examples to use pdfjs-dist bundle instead of pdf.combined.js

Introduces webpack example to demonstrate proper way to disconnect worker part from display modules. See examples/webpack/README.md for details.

yurydelendik · 2015-12-20T14:57:22Z

src/display/api.js

-      warn('Setting up fake worker.');
-      globalScope.PDFJS.disableWorker = true;
+      if (!globalScope.PDFJS.disableWorker) {
+        warn('Setting up fake worker.');


Making this warning appear only when PDF.js decides to fall back (and not when user explicitly sets the option).

timvandermeij · 2015-12-21T15:29:17Z

examples/node/getinfo.js

 global.DOMParser = require('./domparsermock.js').DOMParserMock;

-require('../../build/singlefile/build/pdf.combined.js');
+// Run `node make dist` to generate 'pdfjs-dist' npm package.


Nit: let's keep this the same as in the other example file and add "files" after "package", i.e., make it "Run node make dist to generate 'pdfjs-dist' npm package files."

timvandermeij · 2015-12-21T15:39:22Z

We need to adjust https://github.com/mozilla/pdf.js/wiki/Setup-PDF.js-in-a-website after this lands. We can probably remove the information about webpack and just point to the examples.

timvandermeij · 2015-12-21T21:06:52Z

/botio-linux preview

pdfjsbot · 2015-12-21T21:06:54Z

From: Bot.io (Linux)

Received

Command cmd_preview from @timvandermeij received. Current queue size: 0

Live output at: http://107.21.233.14:8877/36e378baee529f4/output.txt

pdfjsbot · 2015-12-21T21:07:42Z

From: Bot.io (Linux)

Success

Full output at http://107.21.233.14:8877/36e378baee529f4/output.txt

Total script time: 0.81 mins

Published

timvandermeij · 2015-12-21T21:08:03Z

/botio test

pdfjsbot · 2015-12-21T21:08:04Z

From: Bot.io (Windows)

Received

Command cmd_test from @timvandermeij received. Current queue size: 0

Live output at: http://107.22.172.223:8877/1e10f8a981e3843/output.txt

pdfjsbot · 2015-12-21T21:08:05Z

From: Bot.io (Linux)

Received

Command cmd_test from @timvandermeij received. Current queue size: 0

Live output at: http://107.21.233.14:8877/1a9c9bc2e480cef/output.txt

pdfjsbot · 2015-12-21T21:28:22Z

From: Bot.io (Windows)

Success

Full output at http://107.22.172.223:8877/1e10f8a981e3843/output.txt

Total script time: 20.29 mins

Font tests: Passed
Unit tests: Passed
Regression tests: Passed

pdfjsbot · 2015-12-21T21:28:43Z

From: Bot.io (Linux)

Success

Full output at http://107.21.233.14:8877/1a9c9bc2e480cef/output.txt

Total script time: 20.64 mins

Font tests: Passed
Unit tests: Passed
Regression tests: Passed

Adds/modifies examples for node.js and webpack.

timvandermeij · 2015-12-21T21:45:04Z

Looks good, thank you!

Vanuan · 2015-12-22T16:09:16Z

This caused a regression. node-ensure is loaded from root:

Request URL:http://localhost/node-ensure.js
Request Method:GET
Status Code:404 Not Found

Vanuan · 2015-12-22T16:10:18Z

package.json

@@ -5,6 +5,7 @@
    "jsdoc": "^3.3.0-alpha9",
    "jshint": "~2.8.0",
    "wintersmith": "^2.0.0",
+    "node-ensure": "^0.0.0",


What is it and why it's needed?

it's needed for webpack to properly split bundles

Maybe the problem is that this is in devDependencies, not runtime dependencies?

yurydelendik · 2015-12-22T16:13:43Z

This caused a regression.

@Vanuan Please be more specific. Can you provide examples (preferably online)?

Vanuan · 2015-12-22T16:18:40Z

Previously, pdf-dist worked fine in browser. Now it tries to load non-existing file "node-ensure.js".

Vanuan · 2015-12-22T16:19:25Z

https://manual-form-digitizing-vanuan.c9users.io/

Vanuan · 2015-12-22T16:21:52Z

node-ensure documentation reads:

NOTE: This module is not compatible with Browserify.

yurydelendik · 2015-12-22T16:26:42Z

@Vanuan there is no support of SystemJS or Browserify for PDF.js yet. (It's coincidence that it worked before) Please file issues and provide short examples -- that will speed up resolution of the issues.

https://manual-form-digitizing-vanuan.c9users.io/

Looks like at https://manual-form-digitizing-vanuan.c9users.io/ systemjs was used. For some reason it provides (?) module and module.require object and that confuses our frameworks.js code.

This module is not compatible with Browserify.

You can skip 'node-ensure' in the Browserify during build step. (We don't have example or docs for that yet)

Vanuan · 2015-12-22T16:28:01Z

Ok, I'll probably submit my own npm module

yurydelendik · 2015-12-22T16:32:12Z

Ok, I'll probably submit my own npm module

It's your choice, but we would prefer that somebody else would add support of those frameworks to the core. Notice that most of PDF.js contributors have no stakes in supporting (integration or testing) other frameworks.

Vanuan · 2015-12-22T16:38:17Z

So, would it be ok to remove node-ensure and replace it with something else?

yurydelendik · 2015-12-22T16:39:46Z

So, would it be ok to remove node-ensure and replace it with something else?

Only if will not regress webpack example

Vanuan · 2015-12-22T16:45:35Z

src/frameworks.js

+'use strict';
+
+var useRequireEnsure = false;
+if (typeof module !== 'undefined' && module.require) {


what about typeof window === 'undefined' ?

I see conflict in node examples we have (due to DOM mock)

typeof module !== 'undefined' && module.require can be changed to something else that will identify only node (preferably in less hacky way)

Hm... maybe it's better to use System.import polyfill instead of require.ensure?
https://github.com/ModuleLoader/es6-module-loader
I believe, pdf.js is used more on browser side, so using ES6 modules seems more logical.

Using require.ensure is the only way to make it work for webpack, and require.ensure = require('node-ensure) is only way to make it work on node.js as well.

Adding a proper node.js detection (that will not be true for systemjs) will solve your issue

Vanuan · 2015-12-22T18:01:37Z

For some reason it provides (?) module and module.require object

Yes, System.js is a universal loader, so it provides all kinds of loaders, no matter which you choose. Apparently, require.ensure is not among loaders, supported by System.js

yurydelendik · 2015-12-22T18:29:59Z

Yes, System.js is a universal loader,...

The PDF.js contributors might not be familiar with System.js -- can you create a small example to demonstrate the intended usage?

Vanuan · 2015-12-22T18:44:00Z

See #6791

yurydelendik reviewed Dec 20, 2015
View reviewed changes

yurydelendik force-pushed the frameworks branch 2 times, most recently from 174c5ec to 0f095a1 Compare December 20, 2015 19:21

timvandermeij added core other labels Dec 20, 2015

timvandermeij reviewed Dec 21, 2015
View reviewed changes

yurydelendik mentioned this pull request Dec 21, 2015

Specify main #6729

Closed

Adds/modifies examples for node.js and webpack.

79c2f69

yurydelendik force-pushed the frameworks branch from 0f095a1 to 79c2f69 Compare December 21, 2015 19:47

timvandermeij added a commit that referenced this pull request Dec 21, 2015

Merge pull request #6785 from yurydelendik/frameworks

05b9d37

Adds/modifies examples for node.js and webpack.

timvandermeij merged commit 05b9d37 into mozilla:master Dec 21, 2015

Vanuan reviewed Dec 22, 2015
View reviewed changes

yurydelendik mentioned this pull request Sep 9, 2016

Webpack instructions still cause 'fake worker' to load #7612

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds/modifies examples for node.js and webpack. #6785

Adds/modifies examples for node.js and webpack. #6785

yurydelendik commented Dec 20, 2015

yurydelendik Dec 20, 2015

timvandermeij Dec 21, 2015

timvandermeij commented Dec 21, 2015

timvandermeij commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

timvandermeij commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

timvandermeij commented Dec 21, 2015

Vanuan commented Dec 22, 2015

Vanuan Dec 22, 2015

yurydelendik Dec 22, 2015

Vanuan Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015

Vanuan commented Dec 22, 2015

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan Dec 22, 2015

yurydelendik Dec 22, 2015

yurydelendik Dec 22, 2015

Vanuan Dec 22, 2015

yurydelendik Dec 22, 2015

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015

Adds/modifies examples for node.js and webpack. #6785

Adds/modifies examples for node.js and webpack. #6785

Conversation

yurydelendik commented Dec 20, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timvandermeij commented Dec 21, 2015

timvandermeij commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

From: Bot.io (Linux)

Received

pdfjsbot commented Dec 21, 2015

From: Bot.io (Linux)

Success

Published

timvandermeij commented Dec 21, 2015

pdfjsbot commented Dec 21, 2015

From: Bot.io (Windows)

Received

pdfjsbot commented Dec 21, 2015

From: Bot.io (Linux)

Received

pdfjsbot commented Dec 21, 2015

From: Bot.io (Windows)

Success

pdfjsbot commented Dec 21, 2015

From: Bot.io (Linux)

Success

timvandermeij commented Dec 21, 2015

Vanuan commented Dec 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015

Vanuan commented Dec 22, 2015

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vanuan commented Dec 22, 2015

yurydelendik commented Dec 22, 2015

Vanuan commented Dec 22, 2015