Pass correct arguments to onFinished in Modal

[aviraldg]

Fixes element-hq/element-web#1169

Works, and I couldn't find a case where this breaks existing behaviour, but since there are no tests to verify I can't be sure.

[ara4n]

This doesn't look right - i assume someone passed in closeDialog's arguments to the onFinished prop for a reason... What is the rationale for switching from apply() to call()?

[aviraldg]

Exactly, I did some searching but couldn't find a case where that was actually used (the event that caused the dialog to be closed)

[aviraldg]

UserSettings.onEmailDialogFinished is a similar onFinished callback and expects its first argument to be whether the dialog was accepted or dismissed. It should probably have the same bug (as leave room)

[aviraldg]

Looks like that code was added in d938ba7, which also carries this bug (and does not use arguments in any way)

[dbkr]

Looks like this has been the case every since Modal.js was first written in element-hq/element-web@1b43586

Either way, your fix always passes false to onFinished which means the user won't leave then room even if they click OK. The correct fix here is to explicitly call closeDialog(false) in the background div onClick handler rather than using it as the onClick handler directly (since the event handler will be passed an event as an argument which, when it propagates down to the onFinished handler, will evaluate to true.

[aviraldg]

Right, @dbkr, just did not notice that (or test it.) Is there any plan to add e2e tests for situations like this?

[dbkr]

Yeah, we need tests in general in vector.

[ara4n]

I tried to dig into this last night as part of element-hq/element-web#1121 and got completely stuck - the Modal.js API seems entirely confused here in terms of how it handles onFinished(). @aviraldg: looks like you picked one of the most tangled bits of the codebase for a quick fix - sorry! am working through it IRL with @dbkr now.

[ara4n]

Okay - so there were two confusions here:

1. mx_Dialog_background's onClick needs to pass false through to onFinished() rather than an object. The right place to do this is at the onClick - see deaa5c3#diff-3ddc036af206541151e86f03cfc0c0eeR54. This is because closeDialog() can be called from multiple places (the .close() method on the returned dialog object; the onFinished() of the wrapped Element) and still needs to pass through whatever arguments it takes to onFinished() - we can't just have it always pass through false. This is correctly using apply(null, arguments) in case there are more than one arguments to be passed.
2. Modal.createDialogWithElement()'s onFinished semantics were completely broken, and has been remove entirely.

I've fixed both in #232.

Huge thanks for doing the initial digging on this, and sorry that Modal.js is such a mess. Totally agreed that we urgently need UI-layer tests on vector, via karma or selenium or whatever. Patches welcome...