컨테이너 타이밍 API

커뮤니티 그룹 보고서 초안,

이 버전:
https://WICG.github.io/container-timing/
테스트 스위트:
https://github.com/web-platform-tests/wpt/tree/master/container-timing
이슈 추적:
GitHub
편집자:
Jason Williams (Bloomberg)
(Igalia)

초록

이 명세는 DOM의 주석 지정된 섹션이 화면에 표시되고 최초 페인트를 완료했을 때 이를 모니터링할 수 있게 하는 API를 정의한다.

이 문서의 상태

이 명세는 웹 플랫폼 인큐베이터 커뮤니티 그룹에서 발행했다. 이는 W3C 표준이 아니며 W3C 표준화 단계에 있지도 않다. 다음 사항에 유의하라. W3C 커뮤니티 기여자 라이선스 계약 (CLA)에 따라 제한적인 옵트아웃 및 기타 조건이 적용된다. W3C 커뮤니티 및 비즈니스 그룹에 대해 자세히 알아보라.

1. 소개

컨테이너 타이밍 API는 DOM의 주석 지정된 섹션이 화면에 표시되고 최초 페인트를 완료했을 때 이를 모니터링할 수 있게 한다. 개발자는 containertiming 속성(Element Timing API의 elementtiming과 유사함)으로 DOM의 하위 섹션을 표시하고, 해당 섹션이 처음 페인트되었을 때 성능 항목을 받을 수 있다.

이 API를 통해 개발자는 페이지 안의 여러 컴포넌트 타이밍을 측정할 수 있다. 개발자가 애플리케이션을 점점 더 컴포넌트 단위로 구성함에 따라, 애플리케이션이나 웹 페이지의 하위 섹션에 대한 성능을 측정하려는 수요가 커지고 있다.

Element Timing과 달리, DOM의 한 섹션이 언제 페인트를 완료했는지 렌더러가 알 수는 없다(향후 변경, 새 이미지에 대한 비동기 요청, 느리게 로드되는 버튼 등이 있을 수 있음). 따라서 이 API는 업데이트가 있었을 때 PerformanceEntry 객체 형식의 후보를 내보낸다.

2. 동기

개발자는 테이블, 위젯 또는 기타 컴포넌트와 같은 DOM의 하위 섹션이 언제 페인트되었는지 측정하여 페인트 시간을 추적하고 분석 시스템에 제출하려 한다. 현재 웹 API는 이를 충분히 지원하지 않는다.

웹 작성자는 자신의 도메인을 누구보다 잘 알고 있으며, 사용자나 조직이 이해할 수 있는 방식으로 자신들의 콘텐츠 블록 성능을 전달하려 한다(예: "첫 트윗까지의 시간").

2.1. 수명 주기

이 예시 수명 주기에서 컴포넌트는 여러 콘텐츠 조각을 서로 다른 시점에 페인트하며, 이러한 각 시점은 업데이트된 정보가 포함된 새 PerformanceContainerTiming 항목을 생성한다.

그러나 한 영역이 한 번 페인트되면, 같은 영역의 후속 페인트는 새 항목을 생성하지 않는다. Container Timing Life Cycle Diagram

3. 사용 예

다음 예시는 컨테이너 루트를 등록하고 그 페인트 타이밍을 관찰하는 방법을 보여준다.

등록은 containertiming 속성을 사용해 요소별로 수행된다.
<div containertiming="foobar">
  <main>...</main>
  <aside>...</aside>
</div>

<script>
  const observer = new PerformanceObserver((list) => {
    let perfEntries = list.getEntries();
    for (const entry of perfEntries) {
      console.log('컨테이너가 페인트됨:', entry.identifier,
                  '시각', entry.startTime,
                  '크기:', entry.size);
    }
  });
  observer.observe({ entryTypes: ["container"] });
</script>

이 속성은 요소가 문서에 추가되기 전에 설정되어야 한다(HTML에서, 또는 JavaScript로 설정하는 경우 문서에 추가하기 전에). 속성을 나중에 소급해서 설정하면 후속 이벤트와 향후 페인트만 포착된다.

3.1. 하위 트리 무시

DOM 트리의 일부는 <containertiming-ignore> 속성을 사용해 무시할 수 있다.
<div containertiming="foobar">
  <main>...</main>
  <!-- Aside 업데이트는 컨테이너 타이밍 이벤트를 트리거하지 않음 -->
  <aside containertiming-ignore>...</aside>
</div>

4. 용어

컨테이너 루트Elementcontainertiming 속성을 가진 것이다.

무시되는 하위 트리Element를 루트로 하는 하위 트리 중 containertiming-ignore> 속성을 가진 것이다.

페인트된 영역은 처음 관찰된 이후 컨테이너 루트의 페인트된 모든 부분을 나타내는 영역(사각형들의 모음)이다.

컨테이너 타이밍 API는 컨테이너 루트가 화면에 페인트되는 시점에 관한 타이밍 정보를 제공한다.

5. PerformanceContainerTiming 인터페이스

[Exposed=Window]
interface PerformanceContainerTiming : PerformanceEntry {
    readonly attribute DOMString identifier;
    readonly attribute DOMRectReadOnly intersectionRect;
    readonly attribute unsigned long long size;
    readonly attribute DOMHighResTimeStamp firstRenderTime;
    readonly attribute Element? lastPaintedElement;
    readonly attribute Element? rootElement;
};

PerformanceContainerTiming includes PaintTimingMixin;
PerformanceContainerTiming 객체는 다음 관련 개념을 가진다.

entryType 속성의 getter는 DOMString "container"를 반환해야 한다.

name 속성의 getter는 빈 문자열을 반환해야 한다.

duration 속성은 0을 반환해야 한다.

startTime 속성의 getter는 thisrenderTime 값을 반환해야 한다.

identifier 속성은 thisidentifier 값을 반환해야 한다.

intersectionRect 속성은 thisintersectionRect 값을 반환해야 한다.

size 속성은 thissize 값을 반환해야 한다.

firstRenderTime 속성은 thisfirstRenderTime 값을 반환해야 한다.

lastPaintedElement 속성은 thislastPaintedElement 값을 반환해야 한다.

rootElement 속성은 thisrootElement 값을 반환해야 한다.

참고: 사용자 에이전트는 제거된 콘텐츠가 메모리 누수를 일으키지 않도록 컨테이너 루트 레코드 맵을 유지해야 한다. 특히 항목의 수명을 Element에 대한 약한 포인터와 연결할 수 있으므로, Element가 제거된 뒤 어느 시점에 정리될 수 있다. 이 맵은 웹 개발자에게 노출되지 않으므로, 가비지 컬렉션 타이밍을 노출하지 않는다.

6. 처리 모델

참고: 컨테이너 타이밍 API를 구현하는 사용자 에이전트는 supportedEntryTypes"container"를 포함해야 한다. 이는 Window 컨텍스트에 적용된다. 이를 통해 개발자는 컨테이너 타이밍 지원 여부를 감지할 수 있다.

6.1. 문서별 상태

Document에 대해, 사용자 에이전트는 컨테이너 루트 ElementContainer Timing Record 객체에 매핑하는 컨테이너 루트 레코드 맵을 유지해야 한다.

6.2. Element 인터페이스 확장

이 섹션은 [DOM] 명세가 수정되면 제거될 것이다.

우리는 Element 인터페이스를 다음과 같이 확장한다.

partial interface Element {
    [CEReactions] attribute DOMString containertiming;
    [CEReactions] attribute DOMString? containertimingIgnore;
};
containertiming 속성은 요소를 컨테이너 루트로 식별하는 DOMString이다. 해당 값은 대응하는 PerformanceContainerTiming 항목의 identifier가 된다.

containertiming-ignore 속성은, 존재할 때 해당 요소와 그 자손을 조상 컨테이너 루트의 컨테이너 타이밍 측정에 기여하지 않아야 하는 무시되는 하위 트리로 표시한다.

6.3. 컨테이너 타이밍 레코드

이 명세는 처리 모델에서 사용되는 내부 데이터 구조를 정의한다.

Container Timing Record는 다음 관련 개념을 가진다.
paint timing info paintTimingInfoDOMString identifier가 주어졌을 때 Container Timing Record를 생성하려면, 다음 단계를 수행한다.
  1. record를 새 Container Timing Record로 둔다.

  2. recordpaintTimingInfopaintTimingInfo로 설정한다.

  3. recordidentifieridentifier로 설정한다.

  4. record를 반환한다.

6.4. 컨테이너 루트 등록

[^containertiming^] 콘텐츠 속성을 가진 Element가 문서에 연결될 때:

  1. 사용자 에이전트는 그 요소를 컨테이너 루트로 등록해야 한다.

  2. 사용자 에이전트는 컨테이너 루트에 대해 빈 페인트된 영역을 초기화해야 한다.

  3. 사용자 에이전트는 모든 무시되는 하위 트리를 제외하고, 컨테이너 루트의 하위 트리 안의 모든 페인트 작업을 추적해야 한다.

6.5. 컨테이너 타이밍을 위한 Element 페인트 처리

요소가 페인트되고 사용자 에이전트가 컨테이너 타이밍 업데이트를 처리해야 할 때, Document document, paint timing info paintTimingInfo, Element element, 그리고 DOMRectReadOnly intersectionRect가 주어지면 다음 단계를 수행한다.
  1. element컨테이너 타이밍에 기여하지 않으면 반환한다.

  2. containerRootelement가 주어졌을 때 컨테이너 루트 요소를 가져오는 결과로 둔다.

  3. containerRoot가 null이면 반환한다.

  4. recordcontainerRoot에 대한 document컨테이너 루트 레코드 맵 안 항목으로 둔다. 그러한 항목이 없으면, recordpaintTimingInfocontainerRoot의 [^containertiming^] 콘텐츠 속성 값이 주어졌을 때 Container Timing Record를 생성한 결과로 설정한 다음, (containerRootrecord)를 document컨테이너 루트 레코드 맵에 추가한다.

  5. enclosingRectintersectionRect의 가장 작은 외접 사각형으로 둔다.

  6. document, containerRoot, element, enclosingRect, 그리고 paintTimingInfo가 주어졌을 때 record에 대해 마지막 새로 페인트된 영역을 업데이트할 수 있으면 업데이트한다.

  7. Document를 대기 중인 컨테이너 타이밍 변경이 있는 것으로 표시한다.

참고: 이 알고리즘은 페인트되는 각 이미지 또는 텍스트 노드마다 호출된다. 교차 사각형은 요소를 대상으로, 뷰포트를 루트로 하는 교차 사각형 알고리즘을 사용해 계산하고, visual viewport와 교차시켜야 한다. 텍스트 노드의 경우, 교차 사각형은 소유된 텍스트 노드 집합에 있는 모든 텍스트 노드의 border box를 포함하는 가장 작은 사각형을 visual viewport와 교차시킨 것이다.

6.6. 컨테이너 타이밍 항목 내보내기

Document document에 대해 컨테이너 타이밍 항목을 내보내도록 요청받으면, 다음 단계를 수행한다. 이는 모든 페인트 작업이 처리된 뒤 프레임마다 한 번 호출되어야 한다.
  1. document에 대기 중인 컨테이너 타이밍 변경이 없으면 반환한다.

  2. document컨테이너 루트 레코드 맵에 있는 containerRootrecord 각각에 대해 반복한다:

    1. recordhasPendingChanges가 false이면 계속한다.

    2. recordcontainerRoot가 주어졌을 때 Container Timing 항목을 생성한다.

    3. recordhasPendingChanges를 false로 설정한다.

  3. Document를 더 이상 대기 중인 컨테이너 타이밍 변경이 없는 것으로 표시한다.

참고: 페인트된 요소마다 여러 항목을 내보낼 수 있는 일부 다른 페인트 타이밍 API와 달리, Container Timing은 각 컨테이너 루트에 대해 페인트된 영역을 누적하고, 프레임당 컨테이너 루트마다 최대 하나의 PerformanceContainerTiming 항목만 내보낸다. 이 배치 방식은 더 효율적이며 컨테이너의 페인트 상태에 대한 전체적인 관점을 제공한다.

6.7. 부모 컨테이너 루트 Element 가져오기

Element element가 주어졌을 때 부모 컨테이너 루트 요소를 가져오려면, 다음 단계를 수행한다.
  1. parentelement의 parentElement로 둔다.

  2. parent가 null이면 null을 반환한다.

  3. parent가 주어졌을 때 컨테이너 루트 요소를 가져오는 결과를 반환한다.

6.8. 컨테이너 타이밍에 기여

Element가 다음 조건을 모두 만족하면, 컨테이너 루트컨테이너 타이밍에 기여한다.

Element element컨테이너 루트 containerRoot의 컨테이너 타이밍에 기여하는지 판단하려면:
  1. element가 null이면 false를 반환한다.

  2. element가 shadow tree 안에 있으면 false를 반환한다.

  3. elementcontainerRoot의 자손이 아니면 false를 반환한다.

  4. element무시되는 하위 트리 안에 있으면 false를 반환한다.

  5. true를 반환한다.

6.9. 컨테이너 루트 Element 가져오기

Element element가 주어졌을 때 컨테이너 루트 요소를 가져오려면, 다음 단계를 수행한다.
  1. element가 null이면 null을 반환한다.

  2. element의 [^containertiming^] 콘텐츠 속성이 존재하면 element를 반환한다.

  3. element의 parentElement가 null이 아니면, element의 parentElement가 주어졌을 때 컨테이너 루트 요소를 가져오는 결과를 반환한다.

  4. null을 반환한다.

6.10. 마지막 새로 페인트된 영역 업데이트 가능성

Container Timing Record record에 대해 마지막 새로 페인트된 영역을 업데이트할 수 있으면 업데이트하려면, Document document, 컨테이너 루트 Element containerRoot, Element element, DOMRectReadOnly enclosingRect, 그리고 paint timing info paintTimingInfo가 주어졌을 때 다음 단계를 수행한다.
  1. paintedRegionrecordpaintedRegion으로 둔다.

  2. paintedRegionenclosingRect를 완전히 포함하면 반환한다.

  3. recordpaintedRegionpaintedRegionenclosingRect의 합집합으로 설정한다.

  4. recordlastNewPaintedAreaPaintTimingInfopaintTimingInfo로 설정한다.

  5. recordlastNewPaintedAreaElementelement로 설정한다.

  6. recordhasPendingChanges를 true로 설정한다.

  7. containerRoot의 [^containertiming-ignore^] 콘텐츠 속성이 존재하면 반환한다.

  8. parentContainerRootcontainerRoot가 주어졌을 때 부모 컨테이너 루트 요소를 가져오는 결과로 둔다.

  9. parentContainerRoot가 null이면 반환한다.

  10. parentRecordparentContainerRoot에 대한 document컨테이너 루트 레코드 맵 안 항목으로 둔다. 그러한 항목이 없으면 parentRecordpaintTimingInfoparentContainerRoot의 [^containertiming^] 콘텐츠 속성 값이 주어졌을 때 Container Timing Record를 생성한 결과로 설정한 다음, (parentContainerRootparentRecord)를 document컨테이너 루트 레코드 맵에 추가한다.

  11. document, parentContainerRoot, element, enclosingRect, 그리고 paintTimingInfo가 주어졌을 때 parentRecord에 대해 마지막 새로 페인트된 영역을 업데이트할 수 있으면 업데이트한다.

참고: 이 알고리즘은 크기와 관계없이 페인트된 영역의 모든 변경을 보고한다. 페인트된 영역이 1픽셀만 변경되어도 새 PerformanceContainerTiming 항목이 큐에 추가된다. 작은 변경을 필터링하려는 개발자는 항목 간의 size 값을 비교하여 그렇게 할 수 있다.

6.11. 컨테이너 타이밍 항목 생성

Container Timing Record record컨테이너 루트 Element containerRoot가 주어졌을 때 Container Timing 항목을 생성하기 위해, 사용자 에이전트는 다음 단계를 수행해야 한다.
  1. entry를 다음 값을 가진 새 PerformanceContainerTiming 항목으로 둔다:

  2. entry PerformanceEntry를 큐에 추가한다.

7. 보안 및 개인정보 보호 고려사항

7.1. 교차 출처 제한

이 API는 교차 출처 경계를 존중한다.

7.2. 정보 노출

이 API가 제공하는 대부분의 정보는 기존 API를 통해 이미 추정할 수 있다.

이 API는 다음을 노출하지 않는다.

7.3. 타이밍 공격

이 API는 DOMHighResTimeStamp를 사용하며, 이는 다른 Performance API와 일관되게 보안 목적의 해상도 제한을 받을 수 있다.

7.4. 개인정보 보호 고려사항

이 API는 다음을 하지 않는다.

8. 감사의 말

소중한 피드백과 조언을 주신 다음 분들께 깊이 감사한다.

적합성

문서 규약

적합성 요구사항은 서술적 주장과 RFC 2119 용어의 조합으로 표현된다. 이 문서의 규범적 부분에서 핵심 단어 “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, “OPTIONAL”은 RFC 2119에 설명된 대로 해석되어야 한다. 다만 가독성을 위해, 이 명세에서는 이러한 단어가 모두 대문자로 표시되지는 않는다.

이 명세의 모든 텍스트는 규범적이다. 단, 명시적으로 비규범으로 표시된 섹션, 예제 및 참고는 제외한다. [RFC2119]

이 명세의 예제는 “예를 들어”라는 말로 도입되거나, 규범적 텍스트와 구분되도록 class="example"으로 따로 표시된다. 다음과 같다.

이것은 정보성 예제의 예이다.

정보성 참고는 “참고”라는 말로 시작하며, 규범적 텍스트와 구분되도록 class="note"로 따로 표시된다. 다음과 같다.

참고, 이것은 정보성 참고이다.

색인

이 명세에서 정의하는 용어

참조로 정의된 용어

참고문헌

규범 참고문헌

[DOM]
Anne van Kesteren. DOM Standard. Living Standard. URL: https://dom.spec.whatwg.org/
[GEOMETRY-1]
Sebastian Zartner; Yehonatan Daniv. Geometry Interfaces Module Level 1. URL: https://drafts.csswg.org/geometry/
[HR-TIME-3]
Yoav Weiss. High Resolution Time. URL: https://w3c.github.io/hr-time/
[HTML]
Anne van Kesteren; et al. HTML Standard. Living Standard. URL: https://html.spec.whatwg.org/multipage/
[INFRA]
Anne van Kesteren; Domenic Denicola. Infra Standard. Living Standard. URL: https://infra.spec.whatwg.org/
[PAINT-TIMING]
Ian Clelland; Noam Rosenthal. Paint Timing. URL: https://w3c.github.io/paint-timing/
[PERFORMANCE-TIMELINE]
Nicolas Pena Moreno. Performance Timeline. URL: https://w3c.github.io/performance-timeline/
[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. 1997년 3월. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc2119
[WEBIDL]
Edgar Chen; Timothy Gu. Web IDL Standard. Living Standard. URL: https://webidl.spec.whatwg.org/

정보성 참고문헌

[INTERSECTION-OBSERVER]
Stefan Zager; Emilio Cobos Álvarez; Traian Captan. Intersection Observer. URL: https://w3c.github.io/IntersectionObserver/

IDL 색인

[Exposed=Window]
interface PerformanceContainerTiming : PerformanceEntry {
    readonly attribute DOMString identifier;
    readonly attribute DOMRectReadOnly intersectionRect;
    readonly attribute unsigned long long size;
    readonly attribute DOMHighResTimeStamp firstRenderTime;
    readonly attribute Element? lastPaintedElement;
    readonly attribute Element? rootElement;
};

PerformanceContainerTiming includes PaintTimingMixin;

partial interface Element {
    [CEReactions] attribute DOMString containertiming;
    [CEReactions] attribute DOMString? containertimingIgnore;
};