Bug 235661 – [Web Inspector] Update return value name for Animation.requestEffectTarget()

• Status: RESOLVED
• Resolution: FIXED
• Component: Web Inspector

[Antoine Quint]

[Web Inspector] Update return value name for Animation.requestEffectTarget()

[Antoine Quint]

Created attachment 450047 [details]
Patch

[EWS Watchlist]

This patch modifies the inspector protocol. Please ensure that any frontend changes appropriately use feature checks for new protocol features.

[Antoine Quint]

Created attachment 450049 [details]
Patch

[Devin Rousso]

Comment on attachment 450049 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=450049&action=review

r=me thanks for fixing :)

> Source/WebInspectorUI/UserInterface/Models/Animation.js:213
>              // COMPATIBILITY (iOS 15): effectTarget changed from DOM.NodeId to DOM.Styleable.

NIT: Please adjust this comment to also indicate that the name of the parameter changed.  This is important because if one does not provide a callback to a protocol command, the response is encoded into an object that's used as the resolved value of a returned promise (e.g. `let {effectTarget} = await target.AnimationAgent.requestEffectTarget(this._animationId);`), so the property name in the protocol could affect that.
```
    // COMPATIBILITY (iOS 15): nodeId was renamed to effectTarget and changed from DOM.NodeId to DOM.Styleable.
```

Also, you could/should remove the comment above on :194 since it's a duplicate (and it's also not really accurate, because `WI.Animation.prototype.requestEffectTarget` will always return a `WI.DOMStyleable` regardless of the protocol).  It's only the `if (!isNaN(effectTarget))` line that matters for compatibility.

[Antoine Quint]

Committed r288668 (246474@trunk): <https://commits.webkit.org/246474@trunk>

[Radar WebKit Bug Importer]

<rdar://problem/88116899>

[Patrick Angle]

Comment on attachment 450049 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=450049&action=review

>> Source/WebInspectorUI/UserInterface/Models/Animation.js:213
>>              // COMPATIBILITY (iOS 15): effectTarget changed from DOM.NodeId to DOM.Styleable.
> 
> NIT: Please adjust this comment to also indicate that the name of the parameter changed.  This is important because if one does not provide a callback to a protocol command, the response is encoded into an object that's used as the resolved value of a returned promise (e.g. `let {effectTarget} = await target.AnimationAgent.requestEffectTarget(this._animationId);`), so the property name in the protocol could affect that.
> ```
>     // COMPATIBILITY (iOS 15): nodeId was renamed to effectTarget and changed from DOM.NodeId to DOM.Styleable.
> ```
> 
> Also, you could/should remove the comment above on :194 since it's a duplicate (and it's also not really accurate, because `WI.Animation.prototype.requestEffectTarget` will always return a `WI.DOMStyleable` regardless of the protocol).  It's only the `if (!isNaN(effectTarget))` line that matters for compatibility.

FYI this will actually need to be `// COMPATIBILITY (iOS 15.4)`, the protocol definition for which is in Bug 235741.