[api-major] Remove deprecated code #8982

timvandermeij · 2017-10-01T13:20:36Z

This code has been deprecated with a visible message for two years, so we can safely remove it now.

timvandermeij · 2017-10-01T13:28:49Z

/botio-linux preview

timvandermeij · 2017-10-01T13:31:39Z

/botio test

Snuffleupagus

Looks good to me, with the comment addressed (and sign-off from other devs).

@yurydelendik Are you OK with removing these deprecated API methods at this point?

Snuffleupagus · 2017-10-02T09:19:39Z

src/display/api.js

@@ -933,12 +933,6 @@ var PDFPageProxy = (function PDFPageProxyClosure() {
      intentState.renderTasks.push(internalRenderTask);
      var renderTask = internalRenderTask.task;

-      // Obsolete parameter support
-      if (params.continueCallback) {


If this code is removed, then the following JSDoc comment should also be removed:

pdf.js/src/display/api.js

Lines 759 to 762 in 50b1a91

* @property {function} continueCallback - (deprecated) A function that will be

* called each time the rendering is paused. To continue

* rendering call the function that is the first argument

* to the callback.

Done in the new commit.

yurydelendik · 2017-10-02T12:50:26Z

Since we are trying to stick to the http://semver.org/, it's actually "[api-major]" label. Means, we need to start planning 2.0. Can we open "2.0 release" project and place this there (along with removal typed array stubs)?

timvandermeij · 2017-10-02T19:54:12Z

I changed the title to include [api-major]. Should we create a separate branch for 2.0 or can we just merge this in the current master?

yurydelendik · 2017-10-02T19:56:22Z

Oh, branch is a good idea.

…e API This is deprecated since January 2015 with a visible message, so we can safely remove this now.

This is deprecated since October 2015 with a visible message, so we can safely remove this now.

This is deprecated since November 2015 with a visible message, so we can safely remove this now.

This is deprecated since May 2017 with a visible message, so we can safely remove this now.

This is deprecated since October 2015 with a visible message, so we can safely remove this now.

timvandermeij · 2017-10-02T21:12:31Z

/botio-linux preview

pdfjsbot · 2017-10-02T21:12:32Z

From: Bot.io (Linux m4)

Received

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

Live output at: http://54.67.70.0:8877/11e55bdff1bcd9f/output.txt

pdfjsbot · 2017-10-02T21:14:57Z

From: Bot.io (Linux m4)

Success

Full output at http://54.67.70.0:8877/11e55bdff1bcd9f/output.txt

Total script time: 2.41 mins

Published

timvandermeij · 2017-10-02T21:15:18Z

/botio test

pdfjsbot · 2017-10-02T21:15:19Z

From: Bot.io (Windows)

Received

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

Live output at: http://54.215.176.217:8877/4519ba80065dc7c/output.txt

pdfjsbot · 2017-10-02T21:15:19Z

From: Bot.io (Linux m4)

Received

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

Live output at: http://54.67.70.0:8877/4abf3680e54d897/output.txt

pdfjsbot · 2017-10-02T21:32:02Z

From: Bot.io (Linux m4)

Success

Full output at http://54.67.70.0:8877/4abf3680e54d897/output.txt

Total script time: 16.71 mins

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

pdfjsbot · 2017-10-02T21:38:04Z

From: Bot.io (Windows)

Success

Full output at http://54.215.176.217:8877/4519ba80065dc7c/output.txt

Total script time: 22.74 mins

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

Snuffleupagus

Looks good to me (just one perhaps off-topic question); nice code-removal, thank you!

Snuffleupagus · 2017-10-03T12:57:59Z

src/display/api.js

  params.nativeImageDecoderSupport = params.nativeImageDecoderSupport ||
-    (params.disableNativeImageDecoder === true ? NativeImageDecoding.NONE :
-      NativeImageDecoding.DECODE);
+                                     NativeImageDecoding.DECODE;
  if (params.nativeImageDecoderSupport !== NativeImageDecoding.DECODE &&


This could probably be considered slightly out of scope, but I have to ask.

Do we really need to print a warning message for this particular API parameter, considering that we don't do that for any other ones (and doing it everywhere would require adding a lot of code all over the place)?

Hence I'm wondering if it wouldn't suffice to just replace the current code with something along the following lines?

if (!params.nativeImageDecoderSupport || !(params.nativeImageDecoderSupport === NativeImageDecoding.DECODE || params.nativeImageDecoderSupport === NativeImageDecoding.NONE || params.nativeImageDecoderSupport === NativeImageDecoding.DISPLAY)) { params.nativeImageDecoderSupport = NativeImageDecoding.DECODE; }

I would personally be fine with that, but let's do that in a different PR because I'd like to keep this one limited to only removing deprecated code. Nevertheless, this is a good point and can be picked up later!

[api-major] Remove deprecated code

timvandermeij added the core label Oct 1, 2017

timvandermeij force-pushed the remove-deprecated branch from e63e525 to 9babd1f Compare October 1, 2017 13:22

Snuffleupagus approved these changes Oct 2, 2017

View reviewed changes

timvandermeij changed the title ~~[api-minor] Remove deprecated code~~ [api-major] Remove deprecated code Oct 2, 2017

timvandermeij added this to In progress in Version 2.0 Oct 2, 2017

timvandermeij changed the base branch from master to version-2.0 October 2, 2017 20:46

timvandermeij force-pushed the remove-deprecated branch from 9babd1f to 3b82f12 Compare October 2, 2017 20:49

timvandermeij added 3 commits October 2, 2017 22:54

Remove the deprecated parameter handling in the render method of th…

9b353ef

…e API This is deprecated since January 2015 with a visible message, so we can safely remove this now.

Remove the deprecated destroy method of the API

918bd98

This is deprecated since October 2015 with a visible message, so we can safely remove this now.

Remove the deprecated UnsupportedManager class of the API

b651cfb

This is deprecated since November 2015 with a visible message, so we can safely remove this now.

timvandermeij force-pushed the remove-deprecated branch from 3b82f12 to b651cfb Compare October 2, 2017 20:55

timvandermeij added 2 commits October 2, 2017 23:01

Remove the deprecated disableNativeImageDecoder parameter of the API

0817375

This is deprecated since May 2017 with a visible message, so we can safely remove this now.

Remove the deprecated parameters for getDocument of the API

ee9b5a1

This is deprecated since October 2015 with a visible message, so we can safely remove this now.

mozilla deleted a comment from pdfjsbot Oct 2, 2017

Snuffleupagus approved these changes Oct 3, 2017

View reviewed changes

timvandermeij merged commit f28a4b0 into mozilla:version-2.0 Oct 3, 2017

timvandermeij deleted the remove-deprecated branch October 3, 2017 20:45

timvandermeij moved this from In progress to Done in Version 2.0 Oct 3, 2017

Snuffleupagus mentioned this pull request Oct 15, 2017

Simplify the check, and remove the warning, for the nativeImageDecoderSupport API parameter #9032

Merged

1 task

Snuffleupagus mentioned this pull request Mar 25, 2018

Extracting images with node.js "Warning: Native JPEG decoding failed -- trying to recover: Image is not defined" #9603

Closed

movsb pushed a commit to movsb/pdf.js that referenced this pull request Jul 14, 2018

Merge pull request mozilla#8982 from timvandermeij/remove-deprecated

8706064

[api-major] Remove deprecated code

Snuffleupagus mentioned this pull request Jan 9, 2023

[api-minor] Add a new transferPdfData option to allow transferring more data to the worker-thread (bug 1809164) #15908

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[api-major] Remove deprecated code #8982

[api-major] Remove deprecated code #8982

timvandermeij commented Oct 1, 2017 •

edited

timvandermeij commented Oct 1, 2017

timvandermeij commented Oct 1, 2017

Snuffleupagus left a comment •

edited

Snuffleupagus Oct 2, 2017 •

edited

timvandermeij Oct 2, 2017

yurydelendik commented Oct 2, 2017 •

edited

timvandermeij commented Oct 2, 2017

yurydelendik commented Oct 2, 2017

timvandermeij commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

timvandermeij commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

Snuffleupagus left a comment •

edited

Snuffleupagus Oct 3, 2017 •

edited

timvandermeij Oct 3, 2017

	* @property {function} continueCallback - (deprecated) A function that will be
	* called each time the rendering is paused. To continue
	* rendering call the function that is the first argument
	* to the callback.

[api-major] Remove deprecated code #8982

[api-major] Remove deprecated code #8982

Conversation

timvandermeij commented Oct 1, 2017 • edited

timvandermeij commented Oct 1, 2017

timvandermeij commented Oct 1, 2017

Snuffleupagus left a comment • edited

Choose a reason for hiding this comment

Snuffleupagus Oct 2, 2017 • edited

Choose a reason for hiding this comment

timvandermeij Oct 2, 2017

Choose a reason for hiding this comment

yurydelendik commented Oct 2, 2017 • edited

timvandermeij commented Oct 2, 2017

yurydelendik commented Oct 2, 2017

timvandermeij commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

From: Bot.io (Linux m4)

Received

pdfjsbot commented Oct 2, 2017

From: Bot.io (Linux m4)

Success

Published

timvandermeij commented Oct 2, 2017

pdfjsbot commented Oct 2, 2017

From: Bot.io (Windows)

Received

pdfjsbot commented Oct 2, 2017

From: Bot.io (Linux m4)

Received

pdfjsbot commented Oct 2, 2017

From: Bot.io (Linux m4)

Success

pdfjsbot commented Oct 2, 2017

From: Bot.io (Windows)

Success

Snuffleupagus left a comment • edited

Choose a reason for hiding this comment

Snuffleupagus Oct 3, 2017 • edited

Choose a reason for hiding this comment

timvandermeij Oct 3, 2017

Choose a reason for hiding this comment

timvandermeij commented Oct 1, 2017 •

edited

Snuffleupagus left a comment •

edited

Snuffleupagus Oct 2, 2017 •

edited

yurydelendik commented Oct 2, 2017 •

edited

Snuffleupagus left a comment •

edited

Snuffleupagus Oct 3, 2017 •

edited