Auto-addition of mdn_url when multiple candidates in content inventory

[Elchi3]

What type of issue is this?

Infrastructure issue

What is the issue?

No mdn_url for:

api.Sanitizer
api.Sanitizer.Sanitizer
api.Translator
api.Summarizer

What behavior were you expecting?

Automatically added mdn_urls for:

api.Sanitizer
api.Sanitizer.Sanitizer
api.Translator
api.Summarizer

What version(s) of BCD is the issue present in?

• The current BCD release
• The current version of the main branch

Do you have anything more you want to share?

For the BCD keys where the automated addition of mdn_urls fails, the issue is that the script doesn't know which MDN page to pick from, given multiple exist in the in the MDN inventory JSON.

For example, the MDN inventory lists two pages with the matching BCD key "api.Translator": the Translator interface page and an overview page.

Can we do something about it? We should pick the reference page and not the overview page but the script doesn't know this yet.

[caugner]

Can we do something about it? We should pick the reference page and not the overview page but the script doesn't know this yet.

Yes, we should be able to ignore overview pages via their page type (e.g. web-api-overview in this case), as long as there aren't justified cases.

[Elchi3]

Thanks! That makes this problem occur less. It seems that in the case of api.Sanitizer.Sanitizer (the constructor), it will still be a problem. (Maybe it is a content issue that the compat tables is used twice, not sure).

It might be good to check if there are other issues like this and emit a warning whenever the script wasn't able to determine a single mdn_url, so contributors have a chance to fix this manually (once we manually add the correct mdn_url, all is fine for this script anyway).

[caugner]

Good catch, so api.Sanitizer.Sanitizer is referenced on these two pages:

• Web/API/Sanitizer/Sanitizer
• Web/API/SanitizerConfig

However, SanitizerConfig has two entries, so we could add heuristic to pick the page with a single entry in this case.

[caugner]

we could add heuristic to pick the page with a single entry in this case.

Implemented via a42de27.

[caugner]

The following browser-compat keys have multiple MDN pages referencing only this key:

http.headers.Cross-Origin-Embedder-Policy [
  'Web/HTTP/Reference/Headers/Cross-Origin-Embedder-Policy-Report-Only',
  'Web/HTTP/Reference/Headers/Cross-Origin-Embedder-Policy'
]
css.properties.position-area [
  'Web/CSS/Reference/Properties/position-area',
  'Web/CSS/Reference/Values/position-area_value'
]
api.MediaStreamTrack.applyConstraints.channelCount_constraint [
  'Web/API/MediaTrackSettings/channelCount',
  'Web/API/MediaTrackSupportedConstraints/channelCount',
  'Web/API/MediaTrackConstraints/channelCount'
]
api.MediaStreamTrack.applyConstraints.autoGainControl_constraint [
  'Web/API/MediaTrackSettings/autoGainControl',
  'Web/API/MediaTrackSupportedConstraints/autoGainControl',
  'Web/API/MediaTrackConstraints/autoGainControl'
]
api.MediaStreamTrack.applyConstraints.displaySurface_constraint [
  'Web/API/MediaTrackSettings/displaySurface',
  'Web/API/MediaTrackSupportedConstraints/displaySurface',
  'Web/API/MediaTrackConstraints/displaySurface'
]
api.MediaStreamTrack.applyConstraints.restrictOwnAudio_constraint [
  'Web/API/MediaTrackSettings/restrictOwnAudio',
  'Web/API/MediaTrackSupportedConstraints/restrictOwnAudio',
  'Web/API/MediaTrackConstraints/restrictOwnAudio'
]
api.MediaStreamTrack.applyConstraints.facingMode_constraint [
  'Web/API/MediaTrackSettings/facingMode',
  'Web/API/MediaTrackSupportedConstraints/facingMode',
  'Web/API/MediaTrackConstraints/facingMode'
]
api.MediaStreamTrack.applyConstraints.sampleSize_constraint [
  'Web/API/MediaTrackSettings/sampleSize',
  'Web/API/MediaTrackSupportedConstraints/sampleSize',
  'Web/API/MediaTrackConstraints/sampleSize'
]
api.MediaStreamTrack.applyConstraints.latency_constraint [
  'Web/API/MediaTrackSettings/latency',
  'Web/API/MediaTrackSupportedConstraints/latency',
  'Web/API/MediaTrackConstraints/latency'
]
api.MediaStreamTrack.applyConstraints.volume_constraint [
  'Web/API/MediaTrackSettings/volume',
  'Web/API/MediaTrackSupportedConstraints/volume',
  'Web/API/MediaTrackConstraints/volume'
]
api.MediaStreamTrack.applyConstraints.deviceId_constraint [
  'Web/API/MediaTrackSettings/deviceId',
  'Web/API/MediaTrackSupportedConstraints/deviceId',
  'Web/API/MediaTrackConstraints/deviceId'
]
api.MediaStreamTrack.applyConstraints.echoCancellation_constraint [
  'Web/API/MediaTrackSettings/echoCancellation',
  'Web/API/MediaTrackSupportedConstraints/echoCancellation',
  'Web/API/MediaTrackConstraints/echoCancellation'
]
api.MediaStreamTrack.applyConstraints.aspectRatio_constraint [
  'Web/API/MediaTrackSettings/aspectRatio',
  'Web/API/MediaTrackSupportedConstraints/aspectRatio',
  'Web/API/MediaTrackConstraints/aspectRatio'
]
api.MediaStreamTrack.applyConstraints.suppressLocalAudioPlayback_constraint [
  'Web/API/MediaTrackSettings/suppressLocalAudioPlayback',
  'Web/API/MediaTrackSupportedConstraints/suppressLocalAudioPlayback',
  'Web/API/MediaTrackConstraints/suppressLocalAudioPlayback'
]
api.MediaStreamTrack.applyConstraints.logicalSurface_constraint [
  'Web/API/MediaTrackSettings/logicalSurface',
  'Web/API/MediaTrackSupportedConstraints/logicalSurface',
  'Web/API/MediaTrackConstraints/logicalSurface'
]
api.MediaStreamTrack.applyConstraints.sampleRate_constraint [
  'Web/API/MediaTrackSettings/sampleRate',
  'Web/API/MediaTrackSupportedConstraints/sampleRate',
  'Web/API/MediaTrackConstraints/sampleRate'
]
api.MediaStreamTrack.applyConstraints.width_constraint [
  'Web/API/MediaTrackSettings/width',
  'Web/API/MediaTrackSupportedConstraints/width',
  'Web/API/MediaTrackConstraints/width'
]
api.MediaStreamTrack.applyConstraints.frameRate_constraint [
  'Web/API/MediaTrackSettings/frameRate',
  'Web/API/MediaTrackSupportedConstraints/frameRate',
  'Web/API/MediaTrackConstraints/frameRate'
]
api.MediaStreamTrack.applyConstraints.height_constraint [
  'Web/API/MediaTrackSettings/height',
  'Web/API/MediaTrackSupportedConstraints/height',
  'Web/API/MediaTrackConstraints/height'
]
api.MediaStreamTrack.applyConstraints.noiseSuppression_constraint [
  'Web/API/MediaTrackSettings/noiseSuppression',
  'Web/API/MediaTrackSupportedConstraints/noiseSuppression',
  'Web/API/MediaTrackConstraints/noiseSuppression'
]
api.MediaStreamTrack.applyConstraints.groupId_constraint [
  'Web/API/MediaTrackSettings/groupId',
  'Web/API/MediaTrackSupportedConstraints/groupId',
  'Web/API/MediaTrackConstraints/groupId'
]
api.RTCStatsReport.type_media-source.id [ 'Web/API/RTCVideoSourceStats/id', 'Web/API/RTCAudioSourceStats/id' ]
api.RTCStatsReport.type_media-source.trackIdentifier [
  'Web/API/RTCVideoSourceStats/trackIdentifier',
  'Web/API/RTCAudioSourceStats/trackIdentifier'
]
api.RTCStatsReport.type_media-source.kind [
  'Web/API/RTCVideoSourceStats/kind',
  'Web/API/RTCAudioSourceStats/kind'
]
api.RTCStatsReport.type_media-source.timestamp [
  'Web/API/RTCVideoSourceStats/timestamp',
  'Web/API/RTCAudioSourceStats/timestamp'
]
api.RTCStatsReport.type_media-source.type [
  'Web/API/RTCVideoSourceStats/type',
  'Web/API/RTCAudioSourceStats/type'
]
api.clearInterval [
  'Web/API/WorkerGlobalScope/clearInterval',
  'Web/API/Window/clearInterval'
]
api.queueMicrotask [
  'Web/API/WorkerGlobalScope/queueMicrotask',
  'Web/API/Window/queueMicrotask'
]
api.scheduler [ 'Web/API/WorkerGlobalScope/scheduler', 'Web/API/Window/scheduler' ]
api.crypto [ 'Web/API/WorkerGlobalScope/crypto', 'Web/API/Window/crypto' ]
api.setTimeout [ 'Web/API/WorkerGlobalScope/setTimeout', 'Web/API/Window/setTimeout' ]
api.isSecureContext [
  'Web/API/WorkerGlobalScope/isSecureContext',
  'Web/API/Window/isSecureContext'
]
api.performance [
  'Web/API/WorkerGlobalScope/performance',
  'Web/API/Window/performance'
]
api.btoa [ 'Web/API/WorkerGlobalScope/btoa', 'Web/API/Window/btoa' ]
api.caches [ 'Web/API/WorkerGlobalScope/caches', 'Web/API/Window/caches' ]
api.origin [ 'Web/API/WorkerGlobalScope/origin', 'Web/API/Window/origin' ]
api.fetch [ 'Web/API/WorkerGlobalScope/fetch', 'Web/API/Window/fetch' ]
api.crossOriginIsolated [
  'Web/API/WorkerGlobalScope/crossOriginIsolated',
  'Web/API/Window/crossOriginIsolated'
]
api.reportError [
  'Web/API/WorkerGlobalScope/reportError',
  'Web/API/Window/reportError'
]
api.setInterval [
  'Web/API/WorkerGlobalScope/setInterval',
  'Web/API/Window/setInterval'
]
api.structuredClone [
  'Web/API/WorkerGlobalScope/structuredClone',
  'Web/API/Window/structuredClone'
]
api.trustedTypes [
  'Web/API/WorkerGlobalScope/trustedTypes',
  'Web/API/Window/trustedTypes'
]
api.createImageBitmap [
  'Web/API/WorkerGlobalScope/createImageBitmap',
  'Web/API/Window/createImageBitmap'
]
api.atob [ 'Web/API/WorkerGlobalScope/atob', 'Web/API/Window/atob' ]
api.clearTimeout [
  'Web/API/WorkerGlobalScope/clearTimeout',
  'Web/API/Window/clearTimeout'
]
api.indexedDB [ 'Web/API/WorkerGlobalScope/indexedDB', 'Web/API/Window/indexedDB' ]

This almost looks like we should allow mdn_url to have multiple entries, possibly ordered by page descendingly by page popularity. 🤔