Bug 182065 - Web Inspector: Include an inspector protocol version number
Summary: Web Inspector: Include an inspector protocol version number
Status: NEW
Alias: None
Product: WebKit
Classification: Unclassified
Component: Web Inspector (show other bugs)
Version: WebKit Nightly Build
Hardware: All All
: P2 Normal
Assignee: Nobody
Depends on:
Reported: 2018-01-24 14:45 PST by Joseph Pecoraro
Modified: 2018-01-30 11:21 PST (History)
3 users (show)

See Also:

[PATCH] iOS Version Number Approach (16.50 KB, patch)
2018-01-24 14:54 PST, Joseph Pecoraro
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Joseph Pecoraro 2018-01-24 14:45:42 PST
Include an inspector protocol version number

It is possible that the backend can change the values it sends, but the protocol itself stays the same. In order to detect such changes, and react to them in the frontend, there would need to be something that could be checked.

• So far we've been relying on "check for something else in the protocol changing and use that as an indicator" but that is not always perfect.
• We've also done "check the value and change behavior based on the type / appearance of the value" but that is not always perfect.

Adding a version number to the protocol would make this simpler, we could just check against the version number.
Comment 1 Joseph Pecoraro 2018-01-24 14:54:42 PST
Created attachment 332201 [details]
[PATCH] iOS Version Number Approach

I can see a few possible approaches.

1. Give a version number to iOS backend commands targets



    We can generate a version number:

        InspectorBackend.version = 9.3;

    - These version numbers are not linear with time.
    - What if we have non-iOS targets, their version numbers wouldn't map the same.
    - Requires a default value of something like Infinity

2. Bump a version number whenever we need it.

    This could be a:


    That contains a number:


    We would include this in the Combined.json:

        { "version: 1234, "domains": [...] }

    We can generate a version number:

        InspectorBackend.version = 1234;

    - When do we decide to bump the version number? Any protocol change? As needed?


This attachment implemented (1) just to see what it would be like.
I think (2) is real way to go.
Comment 2 Brian Burg 2018-01-30 11:21:18 PST
I don't like the iOS version approach. It doesn't work for Automation protocol, or make sense for other ports or other platforms that run JSContext.

The most simple thing to do is to increment a number whenever the protocol changes. It would be easiest to maintain this in a separate file rather than trying to extract it from domain JSON files.

A more sophisticated approach would be something like SemVer (https://semver.org). This would allow us to warn downstream projects whenever we make a backwards-incompatible change (changing required arguments, deleting anything). Most changes do not affect backwards compatibility. We can then gate relevant code paths on a major or minor version number depending on the need.