[JS] Use beforeinput event to trigger a keystroke event in the sandbox #14430

calixteman · 2022-01-08T17:02:08Z

it aims to fix issue Fix AForm Validation for fields with non-digit characters #14307;
this event has been added recently in Firefox and we can now use it;
fix few bugs in aform.js or in annotation_layer.js;
add some integration tests to test keystroke events (see AFSpecial_Keystroke);
make dispatchEvent in the quickjs sandbox async.

calixteman · 2022-01-08T17:03:09Z

/botio integrationtest

pdfjsbot · 2022-01-08T17:03:11Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/1fcbc73bff57fe0/output.txt

pdfjsbot · 2022-01-08T17:03:11Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/fb1d6a2ea91bd76/output.txt

pdfjsbot · 2022-01-08T17:08:08Z

From: Bot.io (Linux m4)

Failed

Full output at http://54.241.84.105:8877/1fcbc73bff57fe0/output.txt

Total script time: 4.94 mins

Integration Tests: FAILED

pdfjsbot · 2022-01-08T17:10:10Z

From: Bot.io (Windows)

Failed

Full output at http://54.193.163.58:8877/fb1d6a2ea91bd76/output.txt

Total script time: 6.98 mins

Integration Tests: FAILED

Snuffleupagus · 2022-01-14T19:08:27Z

/botio integrationtest

pdfjsbot · 2022-01-14T19:08:28Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @Snuffleupagus received. Current queue size: 0

Live output at: http://54.241.84.105:8877/da1f3d0d2f08a99/output.txt

pdfjsbot · 2022-01-14T19:08:28Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @Snuffleupagus received. Current queue size: 0

Live output at: http://54.193.163.58:8877/1952160057b40c5/output.txt

pdfjsbot · 2022-01-14T19:13:19Z

From: Bot.io (Linux m4)

Failed

Full output at http://54.241.84.105:8877/da1f3d0d2f08a99/output.txt

Total script time: 4.83 mins

Integration Tests: FAILED

pdfjsbot · 2022-01-14T19:14:30Z

From: Bot.io (Windows)

Success

Full output at http://54.193.163.58:8877/1952160057b40c5/output.txt

Total script time: 6.01 mins

Integration Tests: Passed

calixteman · 2022-01-14T19:15:02Z

There is definitely something wrong on linux. I wrote the tests under windows...
I'll investigate.

calixteman · 2022-01-15T11:27:20Z

And of course I can't reproduce the issue locally on debian...

calixteman · 2022-01-15T18:12:02Z

/botio integrationtest

pdfjsbot · 2022-01-15T18:12:04Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/68d25f9889a1b82/output.txt

pdfjsbot · 2022-01-15T18:12:04Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/6a641ac014484ae/output.txt

pdfjsbot · 2022-01-15T18:16:01Z

From: Bot.io (Linux m4)

Success

Full output at http://54.241.84.105:8877/68d25f9889a1b82/output.txt

Total script time: 3.95 mins

Integration Tests: Passed

pdfjsbot · 2022-01-15T18:18:17Z

From: Bot.io (Windows)

Success

Full output at http://54.193.163.58:8877/6a641ac014484ae/output.txt

Total script time: 6.21 mins

Integration Tests: Passed

calixteman · 2022-01-15T18:25:36Z

/botio integrationtest

pdfjsbot · 2022-01-15T18:25:37Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/2d21e467c69e720/output.txt

pdfjsbot · 2022-01-15T18:25:38Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/da1d48865993413/output.txt

pdfjsbot · 2022-01-15T18:29:35Z

From: Bot.io (Linux m4)

Success

Full output at http://54.241.84.105:8877/da1d48865993413/output.txt

Total script time: 3.94 mins

Integration Tests: Passed

pdfjsbot · 2022-01-15T18:29:54Z

From: Bot.io (Windows)

Failed

Full output at http://54.193.163.58:8877/2d21e467c69e720/output.txt

Total script time: 4.27 mins

Integration Tests: FAILED

calixteman · 2022-01-15T18:44:42Z

/botio integrationtest

pdfjsbot · 2022-01-15T18:44:43Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/94f044bd3bc0128/output.txt

pdfjsbot · 2022-01-15T18:44:43Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/f7e81367f97af77/output.txt

pdfjsbot · 2022-01-15T18:48:46Z

From: Bot.io (Linux m4)

Success

Full output at http://54.241.84.105:8877/94f044bd3bc0128/output.txt

Total script time: 4.03 mins

Integration Tests: Passed

pdfjsbot · 2022-01-22T13:52:16Z

From: Bot.io (Windows)

Success

Full output at http://54.193.163.58:8877/f1bad878264b381/output.txt

Total script time: 6.61 mins

Integration Tests: Passed

calixteman · 2022-01-22T14:09:52Z

/botio integrationtest

pdfjsbot · 2022-01-22T14:09:53Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/f836e3a1eb57785/output.txt

pdfjsbot · 2022-01-22T14:09:53Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/34d3a4f209a3eb1/output.txt

pdfjsbot · 2022-01-22T14:13:47Z

From: Bot.io (Linux m4)

Success

Full output at http://54.241.84.105:8877/f836e3a1eb57785/output.txt

Total script time: 3.89 mins

Integration Tests: Passed

pdfjsbot · 2022-01-22T14:16:37Z

From: Bot.io (Windows)

Failed

Full output at http://54.193.163.58:8877/34d3a4f209a3eb1/output.txt

Total script time: 6.73 mins

Integration Tests: FAILED

Snuffleupagus

r=me, with one final comment/question addressed; thank you!

Snuffleupagus · 2022-01-23T16:31:47Z

web/generic_scripting.js

@@ -56,7 +56,7 @@ class GenericScripting {

  async dispatchEventInSandbox(event) {
    const sandbox = await this._ready;
-    sandbox.dispatchEvent(event);
+    setTimeout(() => sandbox.dispatchEvent(event), 0);


OK, that was just a bit surprising since naively I'd have assumed that the previous line (where we await a Promise) already introduces asynchronicity in the event dispatching.

Anyway, if we're adding this additional "delay" to the event dispatching there's potentially a slightly larger risk than before that we're now attempting to dispatch an event after destruction have started.
Given all the various dispatchEventInSandbox call-sites it's difficult to easily tell what an error could lead to, so how about also changing

pdf.js/src/pdf.sandbox.js

Line 106 in 23b6fde

this.support.callSandboxFunction("dispatchEvent", event);

into the following to prevent any future errors elsewhere:

this.support?.callSandboxFunction("dispatchEvent", event);

calixteman · 2022-01-23T17:58:33Z

When entering 123A in the second field in the test file, when entering the A, I get (in Chrome):

BEFOREINPUT 123
dispatchEventInSandbox
<<< alert >>>
VALUE 123 (field value is set from the sandbox)
INPUT 123A (input event which should come after the above BEFOREINPUT)

and in Firefox:

BEFOREINPUT 123
INPUT 123A
dispatchEventInSandbox
<<< alert >>>
VALUE 123

When adding the setTimeout, in Chrome, the INPUT event is triggered before the alert.
I think when I release the key for A then a beforeinput is triggered (but the A is not added yet in the field), ...etc and once the sandbox stuff is done + alert... then the A is finally added to the field and input is triggered. So the setTimeout likely helps to let the input stuff be done before triggering an event in the sandbox.

calixteman · 2022-01-23T18:11:27Z

/botio integrationtest

pdfjsbot · 2022-01-23T18:11:28Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/1048d0bbcb832f1/output.txt

pdfjsbot · 2022-01-23T18:11:28Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/6e5f1496d99f3b8/output.txt

pdfjsbot · 2022-01-23T18:16:20Z

From: Bot.io (Linux m4)

Failed

Full output at http://54.241.84.105:8877/1048d0bbcb832f1/output.txt

Total script time: 4.86 mins

Integration Tests: FAILED

pdfjsbot · 2022-01-23T18:17:10Z

From: Bot.io (Windows)

Success

Full output at http://54.193.163.58:8877/6e5f1496d99f3b8/output.txt

Total script time: 5.68 mins

Integration Tests: Passed

- it aims to fix issue mozilla#14307; - this event has been added recently in Firefox and we can now use it; - fix few bugs in aform.js or in annotation_layer.js; - add some integration tests to test keystroke events (see `AFSpecial_Keystroke`); - make dispatchEvent in the quickjs sandbox async.

calixteman · 2022-01-23T18:53:31Z

/botio integrationtest

pdfjsbot · 2022-01-23T18:53:32Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/3c60402e66e9e4f/output.txt

pdfjsbot · 2022-01-23T18:53:32Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/46ae0a192453b60/output.txt

pdfjsbot · 2022-01-23T18:57:28Z

From: Bot.io (Linux m4)

Success

Full output at http://54.241.84.105:8877/3c60402e66e9e4f/output.txt

Total script time: 3.92 mins

Integration Tests: Passed

pdfjsbot · 2022-01-23T19:00:12Z

From: Bot.io (Windows)

Success

Full output at http://54.193.163.58:8877/46ae0a192453b60/output.txt

Total script time: 6.66 mins

Integration Tests: Passed

calixteman · 2022-01-23T19:09:12Z

/botio integrationtest

pdfjsbot · 2022-01-23T19:09:13Z

From: Bot.io (Linux m4)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.241.84.105:8877/8f38bba25094c54/output.txt

pdfjsbot · 2022-01-23T19:09:14Z

From: Bot.io (Windows)

Received

Command cmd_integrationtest from @calixteman received. Current queue size: 0

Live output at: http://54.193.163.58:8877/000ddaae2924129/output.txt

pdfjsbot · 2022-01-23T19:13:14Z

From: Bot.io (Linux m4)

Success

Full output at http://54.241.84.105:8877/8f38bba25094c54/output.txt

Total script time: 3.99 mins

Integration Tests: Passed

pdfjsbot · 2022-01-23T19:15:52Z

From: Bot.io (Windows)

Success

Full output at http://54.193.163.58:8877/000ddaae2924129/output.txt

Total script time: 6.62 mins

Integration Tests: Passed

calixteman added the form-js label Jan 8, 2022

marco-c linked an issue Jan 10, 2022 that may be closed by this pull request

AForm validation rejects valid fields #14306

Closed

calixteman force-pushed the beforeinput branch 2 times, most recently from c5c539d to b3ad48c Compare January 15, 2022 18:11

Snuffleupagus approved these changes Jan 23, 2022

View reviewed changes

calixteman force-pushed the beforeinput branch from 94b4715 to 51a64b3 Compare January 23, 2022 18:04

calixteman force-pushed the beforeinput branch from 51a64b3 to 6ac296e Compare January 23, 2022 18:53

calixteman merged commit 88236e1 into mozilla:master Jan 23, 2022

calixteman deleted the beforeinput branch January 23, 2022 19:42

Snuffleupagus mentioned this pull request Jan 24, 2022

Unit-test "should validate a phone number on a keystroke event" fails after PR 14430 #14488

Closed

timvandermeij mentioned this pull request Feb 13, 2022

error in validating Telephone number entry in pdf text field stephanrauh/ngx-extended-pdf-viewer#1146

Closed

[JS] Use beforeinput event to trigger a keystroke event in the sandbox #14430

[JS] Use beforeinput event to trigger a keystroke event in the sandbox #14430

Conversation

calixteman commented Jan 8, 2022 • edited

calixteman commented Jan 8, 2022

pdfjsbot commented Jan 8, 2022

From: Bot.io (Linux m4)

Received

pdfjsbot commented Jan 8, 2022

From: Bot.io (Windows)

Received

pdfjsbot commented Jan 8, 2022

From: Bot.io (Linux m4)

Failed

pdfjsbot commented Jan 8, 2022

From: Bot.io (Windows)

Failed

Snuffleupagus commented Jan 14, 2022

pdfjsbot commented Jan 14, 2022

From: Bot.io (Linux m4)

Received

pdfjsbot commented Jan 14, 2022

From: Bot.io (Windows)

Received

pdfjsbot commented Jan 14, 2022

From: Bot.io (Linux m4)

Failed

pdfjsbot commented Jan 14, 2022

From: Bot.io (Windows)

Success

calixteman commented Jan 14, 2022

calixteman commented Jan 15, 2022

calixteman commented Jan 15, 2022

pdfjsbot commented Jan 15, 2022

From: Bot.io (Linux m4)

Received

pdfjsbot commented Jan 15, 2022

From: Bot.io (Windows)

Received

pdfjsbot commented Jan 15, 2022

From: Bot.io (Linux m4)

Success

pdfjsbot commented Jan 15, 2022

From: Bot.io (Windows)

Success

calixteman commented Jan 15, 2022

pdfjsbot commented Jan 15, 2022

From: Bot.io (Windows)

Received

pdfjsbot commented Jan 15, 2022

From: Bot.io (Linux m4)

Received

pdfjsbot commented Jan 15, 2022

From: Bot.io (Linux m4)

Success

pdfjsbot commented Jan 15, 2022

From: Bot.io (Windows)

Failed

calixteman commented Jan 15, 2022

pdfjsbot commented Jan 15, 2022

From: Bot.io (Linux m4)

Received

pdfjsbot commented Jan 15, 2022

From: Bot.io (Windows)

Received

pdfjsbot commented Jan 15, 2022

From: Bot.io (Linux m4)

Success

pdfjsbot commented Jan 22, 2022

From: Bot.io (Windows)

Success

calixteman commented Jan 22, 2022

pdfjsbot commented Jan 22, 2022

From: Bot.io (Linux m4)

Received

pdfjsbot commented Jan 22, 2022

From: Bot.io (Windows)

Received

pdfjsbot commented Jan 22, 2022

From: Bot.io (Linux m4)

calixteman commented Jan 8, 2022 •

edited