#93270BroadcastMessage.fromData() is not idempotent
Description
If BroadcastMessage is recreated using BroadcastMessage.fromData() it does not retain the original object structure. This is because BroadcastMessage.fromData() nests the entrire data (which includes a payload property itself) into another wrapping payload property.
Given following JavaScript code (executable in a Browser console in a window of the TYPO3 Backend):
window.require(['TYPO3/CMS/Backend/BroadcastMessage'], ({BroadcastMessage}) => {
const bm1 = new BroadcastMessage('component', 'eventName', {foo: 'bar'})
// Create bm2 from bm1, as if bm1 has been sent via broadcastchannel
const bm2 = BroadcastMessage.fromData(bm1)
console.log('bm1', bm1.payload)
console.log('bm2', bm2.payload)
})
The expected result/output is that payload contains the same value for both BroadcastMessage instances:
bm1 {foo: "bar"}
bm2 {foo: "bar"}
While it actually is:
bm1 {foo: "bar"}
bm2 {payload: {foo: "bar"}}
BroadcastMessage.fromData() should be fixed to be idempotent, while keeping backwards compatibility (to existing event-subscribers) by doing the “additional” payload wrapping in BroadcastMessage.createCustomEvent. The “good” thing is, that BroadcastMessage isn’t used directly by subscribers, it is transformed into a CustomEvent, therefore this can be fixed without breaking BC.
Reviews 1
History 615
-
Benjamin Franzke changed description <span data-processor="relativetime" data-value="2021-01-12T07:46:13+00:00" > 01/12/21, 07:46 </span>
-
Gerrit Code Review pushed patch set 1 for master to change 67432 status
NewUnder Review <span data-processor="relativetime" data-value="2021-01-12T11:10:45+00:00" > 01/12/21, 11:10 </span> -
Gerrit Code Review pushed patch set 2 for master to change 67432 <span data-processor="relativetime" data-value="2021-01-12T14:20:50+00:00" > 01/12/21, 14:20 </span>
-
Gerrit Code Review pushed patch set 3 for master to change 67432 <span data-processor="relativetime" data-value="2021-01-14T05:36:18+00:00" > 01/14/21, 05:36 </span>
-
Gerrit Code Review pushed patch set 4 for master to change 67432 <span data-processor="relativetime" data-value="2021-01-15T13:05:05+00:00" > 01/15/21, 13:05 </span>
-
Benni Mack changed target version <span data-processor="relativetime" data-value="2021-03-03T07:26:34+00:00" > 03/03/21, 07:26 </span>
-
Gerrit Code Review pushed patch set 5 for master to change 67432 <span data-processor="relativetime" data-value="2021-03-10T21:44:35+00:00" > 03/10/21, 21:44 </span>
-
Benni Mack changed target version <span data-processor="relativetime" data-value="2021-05-07T19:37:27+00:00" > 05/07/21, 19:37 </span>
-
Benni Mack changed target version <span data-processor="relativetime" data-value="2021-07-18T15:46:32+00:00" > 07/18/21, 15:46 </span>
-
Gerrit Code Review pushed patch set 6 for master to change 67432 <span data-processor="relativetime" data-value="2021-08-31T08:18:36+00:00" > 08/31/21, 08:18 </span>
-
Benni Mack changed target version <span data-processor="relativetime" data-value="2021-09-07T07:44:17+00:00" > 09/07/21, 07:44 </span>
-
Gerrit Code Review pushed patch set 7 for master to change 67432 <span data-processor="relativetime" data-value="2021-09-17T06:18:48+00:00" > 09/17/21, 06:18 </span>
-
Gerrit Code Review pushed patch set 8 for master to change 67432 <span data-processor="relativetime" data-value="2021-09-28T16:21:21+00:00" > 09/28/21, 16:21 </span>
-
Benni Mack changed target version <span data-processor="relativetime" data-value="2021-10-07T09:25:44+00:00" > 10/07/21, 09:25 </span>
-
Gerrit Code Review pushed patch set 9 for main to change 67432 <span data-processor="relativetime" data-value="2021-11-29T14:03:34+00:00" > 11/29/21, 14:03 </span>