사용 중단 보고

이 문서의 상태

이 명세는 Web Platform Incubator Community Group에서 발행되었습니다. W3C 표준이 아니며 W3C 표준 트랙에도 포함되어 있지 않습니다. W3C 커뮤니티 기여자 라이선스 계약(CLA)에 따라 제한적 옵트아웃 및 기타 조건이 적용됩니다. W3C 커뮤니티 및 비즈니스 그룹에 대해 더 알아보세요.

1. 소개

[INTRODUCTION GOES HERE]

1.1. 예시

Example, Inc.는 사용자가 웹 API를 사용할 때(곧 브라우저에서 제거될 예정) 이를 추적하고 싶어합니다. 다음과 같이 헤더를 전달하여 기본 보고 엔드포인트를 정의할 수 있으며, 사용 중단 보고가 해당 위치로 전달됩니다:

Reporting-Endpoints: default="https://example.com/reports"

2. 사용 중단 보고

사용 중단 보고는 브라우저 API나 기능이 사용되었으며, 향후 브라우저 업데이트에서 동작하지 않게 될 예정임을 나타냅니다.

사용 중단 보고는 보고서의 한 종류입니다.

사용 중단 보고는 보고서 유형 "deprecation"을 가집니다.

사용 중단 보고는 ReportingObserver에서 볼 수 있습니다.

[Exposed=(Window,Worker)]
interface DeprecationReportBody : ReportBody {
  [Default] object toJSON();
  readonly attribute DOMString id;
  readonly attribute object? anticipatedRemoval;
  readonly attribute DOMString message;
  readonly attribute DOMString? sourceFile;
  readonly attribute unsigned long? lineNumber;
  readonly attribute unsigned long? columnNumber;
};

사용 중단 보고의 body는 JavaScript에서 DeprecationReportBody로 표현되며, 다음 필드를 포함합니다:

id: 제거될 기능 또는 API를 식별하는 구현 정의 문자열입니다. 이 문자열은 관련 보고서를 그룹화하거나 집계하는 데 사용할 수 있습니다.
anticipatedRemoval: 브라우저에서 해당 API가 제거된 버전이 언제 일반적으로 제공될지(ISO 8601 문자열로 표시되는 JavaScript Date 객체)를 대략적으로 나타냅니다(베타, 프리릴리스 채널 제외). 이 값은 경고의 우선순위 또는 정렬에 사용해야 하며, 알 수 없는 경우 null로 설정되어 우선순위가 낮은 것으로 간주됩니다(실제로 제거되지 않을 수도 있음).
message: 개발자 콘솔에 표시되는 것과 유사한 상세 정보를 담은 사람이 읽을 수 있는 문자열입니다. 메시지는 특정 id에 대해 고유하지 않을 수 있으며(예: API 사용 방식에 대한 추가 정보가 포함될 수 있음) 다양한 상황에서 달라질 수 있습니다.
sourceFile: 파악 가능한 경우, 해당 API를 처음 사용한 파일 이름이며, 알 수 없으면 null입니다.
lineNumber: 파악 가능한 경우, sourceFile에서 해당 API가 처음 사용된 줄 번호이며, 알 수 없으면 null입니다.
columnNumber: 파악 가능한 경우, sourceFile에서 해당 API가 처음 사용된 컬럼 번호이며, 알 수 없으면 null입니다.

참고: 사용 중단 보고는 항상 endpoint 이름이 default인 위치로 전달됩니다. 현재 이를 변경하는 방법은 없습니다. 다른 종류의 보고서만 받고 싶고, 사용 중단 보고는 받고 싶지 않다면, 그 보고서에 사용할 엔드포인트 이름을 다르게 지정하세요.

3. 보고서 샘플

    POST /reports HTTP/1.1
    Host: example.com
    ...
    Content-Type: application/reports+json

    [{
      "type": "deprecation",
      "age": 32,
      "url": "https://example.com/",
      "user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0",
      "body": {
        "id": "websql",
        "anticipatedRemoval": "2020-01-01",
        "message": "WebSQL은 사용 중단되었으며 2020년 1월경 Chrome 97에서 제거될 예정입니다",
        "sourceFile": "https://example.com/index.js",
        "lineNumber": 1234,
        "columnNumber": 42
      }
    }]
}