DeprecationReport

Instanzeigenschaften

body

Der Körper des Berichts. Dies ist ein Objekt mit den folgenden Eigenschaften:

id Experimentell

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

anticipatedRemoval Experimentell

Ein Date-Objekt (als String dargestellt), das das Datum repräsentiert, an dem das Merkmal voraussichtlich aus dem aktuellen Browser entfernt wird. Wenn das Datum nicht bekannt ist, gibt diese Eigenschaft null zurück. Dieser Wert kann verwendet werden, um Warnungen zu priorisieren. Wenn diese Eigenschaft null zurückgibt, weil das Datum unbekannt ist, dann sollte die Abschreibung als von geringer Priorität betrachtet werden.

message Experimentell

Ein String, der eine menschenlesbare Beschreibung der Abschreibung enthält, einschließlich Informationen darüber, welches neuere Merkmal es gegebenenfalls ersetzt hat. Dies entspricht in der Regel der Nachricht, die ein Browser in seiner DevTools-Konsole anzeigt, wenn ein veraltetes Merkmal verwendet wird, sofern eine vorhanden ist.

sourceFile Experimentell

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

lineNumber Experimentell

Eine Zahl, die die Zeile in der Quelldatei repräsentiert, in der das veraltete Merkmal verwendet wurde, falls bekannt, oder andernfalls null.

columnNumber Experimentell

Eine Zahl, die die Zeichnungsposition in der Zeile der Quelldatei repräsentiert, in der das veraltete Merkmal erstmals verwendet wurde, falls bekannt, oder andernfalls null.

type

Der String "deprecation" zeigt an, dass dies ein Abschreibungsbericht ist.

url

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

Beschreibung

Ein Abschreibungsbericht kann generiert werden, wenn ein veraltetes Merkmal (zum Beispiel eine veraltete API-Methode) in einem Dokument verwendet wird.

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

Ein typischer Abschreibungsbericht wird unten gezeigt. Beachten Sie, dass url die ursprünglich geladene Seite darstellt, während body.sourceFile, body.lineNumber und body.columnNumber den spezifischen Ort des API-Aufrufs kennzeichnen, der die Maßnahme 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
  }
}

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

Der Aufbau des Serverberichts ist fast genau der gleiche wie DeprecationReport, mit Ausnahme der zusätzlichen Felder age und user_agent.

{
  "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 Sie "deprecation"-Berichte innerhalb einer Seite beobachten 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 erzeugen wir ein neues ReportingObserver-Objekt, um auf Berichte mit dem Typ "deprecation" zu hören, und übergeben einen Callback, der die Berichte empfangen und protokollieren wird.

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

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

// Start the observer
observer.observe();

Dann rufen wir den folgenden Code auf, der synchrones XHR (veraltete API) verwendet. Beachten Sie, dass dies nach dem Beobachter definiert ist, den es auslöst, sobald der Beobachter läuft.

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

Ergebnisse

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

Senden eines Berichts an einen Berichtsendpunkt

Um eine Webseite zu konfigurieren, um einen Abschreibungsbericht zu senden, müssen Sie einen Berichtserver-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. Er hat die gleiche Struktur wie DeprecationReport, mit Ausnahme der zusätzlichen Eigenschaften age und user_agent.

[
  {
    "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)