DeprecationReport

Instanzeigenschaften

body

Der Hauptteil des Berichts. Dies ist ein Objekt mit den folgenden Eigenschaften:

id Experimentell

Ein String, der das Feature oder die API repräsentiert, das veraltet ist, zum Beispiel NavigatorGetUserMedia. Dies kann verwendet werden, um Berichte nach veraltetem Feature zu gruppieren.

anticipatedRemoval Experimentell

Ein Date-Objekt (als String dargestellt), das das Datum angibt, an dem das Feature voraussichtlich aus dem aktuellen Browser entfernt wird. Wenn das Datum nicht bekannt ist, wird diese Eigenschaft null zurückgeben. Dieser Wert kann verwendet werden, um Warnungen zu priorisieren. Wenn diese Eigenschaft null zurückgibt, weil das Datum unbekannt ist, sollte die Veraltung als niedrige Priorität angesehen werden.

message Experimentell

Ein String, der eine für Menschen lesbare Beschreibung der Veraltung enthält, einschließlich Informationen wie welches neuere Feature es gegebenenfalls ersetzt hat. Dies entspricht typischerweise der Nachricht, die ein Browser in seiner DevTools-Konsole anzeigt, wenn ein veraltetes Feature verwendet wird, sofern eine vorhanden ist.

sourceFile Experimentell

Ein String, der den Pfad zur Quelldatei enthält, in der das veraltete Feature verwendet wurde, falls bekannt, oder andernfalls null.

lineNumber Experimentell

Eine Zahl, die die Zeile in der Quelldatei darstellt, in der das veraltete Feature verwendet wurde, falls bekannt, oder andernfalls null.

columnNumber Experimentell

Eine Zahl, die die Zeichenposition in der Zeile der Quelldatei darstellt, in der das veraltete Feature erstmals verwendet wurde, falls bekannt, oder andernfalls null.

type

Der String "deprecation", der angibt, dass dies ein Veraltungsbericht ist.

url

Ein String, der die URL des Dokuments repräsentiert, das den Bericht erzeugt hat.

Beschreibung

Ein Veraltungsbericht kann erstellt werden, wenn ein veraltetes Feature (zum Beispiel eine veraltete API-Methode) in einem Dokument verwendet wird.

Sie können innerhalb der Seite, in der sie ausgelöst werden, auf Veraltungsberichte überwachen, indem Sie die Reporting API verwenden. Dazu erstellen Sie ein ReportingObserver-Objekt, um auf Berichte zu lauschen, indem Sie eine Callback-Methode und optional eine options-Eigenschaft übergeben, die die Arten von Berichten spezifiziert, die Sie berichten möchten. Die Callback-Methode wird dann mit Berichten der angeforderten Typen aufgerufen, wobei ein Berichtsobjekt übergeben wird. Für Veraltungsberichte wird das Objekt eine DeprecationReport-Instanz sein (welche die type-Eigenschaft auf "deprecation" gesetzt hat).

Ein typischer Veraltungsbericht wird unten gezeigt. Beachten Sie, dass url die ursprüngliche Seite darstellt, die geladen wurde, während body.sourceFile, body.lineNumber und body.columnNumber den spezifischen Ort des API-Aufrufs anzeigen, der das Eingreifen ausgelöst hat (in diesem Beispiel ist es die gleiche Datei).

{
  "type": "deprecation",
  "url": "https://example.com/",
  "body": {
    "sourceFile": "https://example.com/",
    "lineNumber": 54,
    "columnNumber": 11,
    "id": "XMLHttpRequestSynchronousInNonWorkerOutsideBeforeUnload",
    "message": "Synchronous `XMLHttpRequest` on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check https://xhr.spec.whatwg.org/.",
    "anticipatedRemoval": null
  }
}

Veraltungsberichte werden auch als JSON-Objekte in einer POST-Anfrage an den Reporting-Server-Endpunkt namens "default" gesendet, falls dieser definiert ist. Der Reporting-Server-Endpunkt und dessen Zuordnung zu einer bestimmten URL werden mit dem Reporting-Endpoints-Header festgelegt.

Die Struktur des Serverberichts ist fast genau die gleiche wie DeprecationReport, mit Ausnahme, dass er zusätzlich die Felder age und user_agent umfasst.

{
  "type": "deprecation",
  "age": 27,
  "url": "https://example.com/",
  "user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0",
  "body": {
    "sourceFile": "https://example.com/",
    "lineNumber": 54,
    "columnNumber": 11,
    "id": "XMLHttpRequestSynchronousInNonWorkerOutsideBeforeUnload",
    "message": "Synchronous `XMLHttpRequest` on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check https://xhr.spec.whatwg.org/.",
    "anticipatedRemoval": null
  }
}

Beispiele

Verwendung der ReportingObserver-Schnittstelle

Dieses Beispiel zeigt, wie "deprecation"-Berichte innerhalb einer Seite beobachtet werden können, die sie auslöst.

<pre id="log"></pre>

#log {
  height: 200px;
  margin: 10px;
  overflow: scroll;
  padding: 0.5rem;
  border: 1px solid black;
}

const logElement = document.querySelector("#log");
function log(text) {
  logElement.innerText = `${logElement.innerText}${text}\n`;
  logElement.scrollTop = logElement.scrollHeight;
}

JavaScript

Zuerst konstruieren wir ein neues ReportingObserver-Objekt, um auf Berichte mit dem Typ "deprecation" zu lauschen, indem wir einen Callback übergeben, der die Berichte empfängt und protokolliert.

const options = {
  types: ["deprecation"],
  buffered: true,
};

const observer = new ReportingObserver((reports, observer) => {
  reports.forEach((report) => {
    log(JSON.stringify(report, null, 2));
  });
}, options);

// Start the observer
observer.observe();

Wir rufen dann den folgenden Code auf, der synchrone XHR verwendet (veraltete API). Beachten Sie, dass dies nach dem Beobachter definiert ist, er wird ausgelöst, sobald der Beobachter läuft.

const xhr = new XMLHttpRequest();
xhr.open("GET", "/", false); // false = synchronous (deprecated)
xhr.send();

Ergebnisse

In Browsern, die Veraltungsberichte unterstützen, sollte unten ein Bericht angezeigt werden. Beachten Sie, dass der type "deprecation" ist.

Senden eines Berichts an einen Reporting-Endpunkt

Die Konfiguration einer Webseite zum Senden eines Veraltungsberichts erfordert, dass Sie einen Reporting-Server-Endpunkt namens "default" mit dem Reporting-Endpoints-Header festlegen. Unten setzen wir den default-Endpunkt auf https://example.com/deprecation:

Der Bericht wird dann als JSON-Objekt in einer POST-Anfrage an den Endpunkt gesendet, wann immer eine veraltete API verwendet wird. Es hat die gleiche Struktur wie DeprecationReport, mit Ausnahme der hinzufügen age- und user_agent-Eigenschaften.

[
  {
    "type": "deprecation",
    "age": 27,
    "url": "https://example.com/",
    "user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0",
    "body": {
      "sourceFile": "https://example.com/",
      "lineNumber": 54,
      "columnNumber": 11,
      "id": "XMLHttpRequestSynchronousInNonWorkerOutsideBeforeUnload",
      "message": "Synchronous `XMLHttpRequest` on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check https://xhr.spec.whatwg.org/.",
      "anticipatedRemoval": null
    }
  }
]

Spezifikationen

Browser-Kompatibilität

Siehe auch

• ReportingObserver
• Reporting-Endpoints
• Reporting API
• The Reporting API (developer.chrome.com)