ERC-7774 웹3 URL 이벤트 기반 캐시 무효화 (Cache invalidation in ERC-5219 mode Web3 URL)
Draft · 기타 · 2024-09-20 작성
web3:// 주소로 열리는 온체인 웹사이트가 스마트 컨트랙트 이벤트로 캐시 삭제 시점을 알려, 내용이 바뀌지 않는 한 RPC 호출 없이 저장된 페이지를 다시 쓸 수 있게 합니다.
왜 필요한가
web3:// 주소는 스마트 컨트랙트에서 웹페이지를 받아 오는 방식이라, 페이지를 열 때마다 이더리움 노드에 요청(RPC 호출)을 보내야 합니다. 이 호출은 직접 노드를 돌리면 컴퓨터 자원이 들고 외부 유료 제공자를 쓰면 비용이 들며 호출 횟수 제한에 걸려 접속이 끊기기도 합니다. 보통 웹에서는 캐시(한 번 받은 내용을 저장해 두고 재사용하는 것)로 이런 부담을 줄이지만 ERC-6944 방식은 요청 HTTP 헤더를 컨트랙트에 전달하지 않아 If-None-Match나 If-Modified-Since 같은 표준 캐시 검증을 처리할 수 없습니다. 그래서 유효 기간(max-age)만 쓸 수 있고 기간이 지나면 캐시 검증 요청마다 RPC 호출로 전체 응답을 다시 만들어야 합니다.
구현해야 하는 것
event ClearPathCache(string[] paths);: 배열에 담긴 경로들의 캐시를 지우라고 알리는 이벤트입니다. 각 경로는 ERC-6860 정의의 pathQuery 부분을 가리킵니다.
심층 설명
evm-events 지시어를 쓰는 조건
ERC-6944 리졸브 모드 웹사이트가 이벤트 기반 캐싱을 쓰려면 세 가지를 반드시 지켜야 합니다. 응답의 Cache-Control 헤더에 evm-events 지시어를 포함하고 기존 RFC 9111 HTTP 캐싱대로 ETag나 Cache-Control 헤더를 함께 포함하며 응답 출력이 바뀌어 캐시를 지울 필요가 있다고 판단하면 해당 경로에 대한 캐시 무효화 이벤트를 컨트랙트에서 발생시켜야 합니다. evm-events는 RFC 9111의 5.2.3절에 정의된 확장 지시어 형식을 따릅니다.
지시어 값으로 감시 대상 넓히기
evm-events 지시어의 값은 선택 사항이며 다른 컨트랙트나 다른 경로의 이벤트도 함께 듣도록 지정할 때 씁니다. 값이 없으면 응답한 컨트랙트가 서비스된 경로에 대해 이벤트를 낼 때 캐시가 지워집니다. evm-events="/path/path2"처럼 경로만 적으면 그 경로의 이벤트도 함께 듣고 0x로 시작하는 20바이트 컨트랙트 주소를 앞에 붙이면 그 컨트랙트의 이벤트도 듣습니다. 주소만 적으면 그 컨트랙트가 서비스된 경로에 대해 내는 이벤트를 듣습니다. 공백으로 구분해 여러 항목을 나열할 수 있어, evm-events="/path/path2 /path/path3"은 두 경로 중 어느 쪽의 이벤트가 와도 캐시를 지웁니다.
ClearPathCache 이벤트와 경로 비교 규칙
캐시 무효화 이벤트는 event ClearPathCache(string[] paths) 하나로 정의되며 배열에 담긴 경로들의 캐시를 지웁니다. 각 경로는 ERC-6860 ABNF 정의의 pathQuery 부분을 가리킵니다. 경로는 /로 끝나면 안 되고 전체 경로가 루트인 / 하나일 때만 예외입니다. 두 경로는 ERC-5219 리소스 항목이 같고 매개변수 값이 순서와 상관없이 일치하면 같은 경로로 봅니다. 예를 들어 /test?a=1&b=2와 /test?b=2&a=1은 같은 경로입니다.
와일드카드 규칙
경로에는 * 와일드카드를 쓸 수 있지만 규칙이 엄격합니다. 리소스 항목에서는 *를 단독으로만 쓸 수 있고 /t*t처럼 다른 문자와 섞으면 그 경로 전체가 무시됩니다. *는 최소 한 글자와 맞아야 하므로 /*는 /test와 맞지만 /나 /test/abc와는 맞지 않고 /test/*는 /test/abc와 맞지만 /test/나 /test/abc/def와는 맞지 않습니다. 매개변수 값에도 같은 규칙이 적용되어 /abc?a=*는 /abc?a=zz와 맞지만 /abc?a=나 /abc?a=zz&b=cc와는 맞지 않으며 /abc?a=z*는 무시됩니다. 경로가 * 하나뿐이면 그 컨트랙트의 모든 경로와 맞는 전역 와일드카드입니다. 이렇게 단순한 경우로 제한한 것은 효율적인 경로 조회 구현을 쉽게 하기 위해서입니다.
클라이언트의 두 상태와 캐시 매핑
web3:// 클라이언트는 체인과 컨트랙트별로 두 상태 중 하나에 있습니다. '이벤트 수신' 상태에서는 캐시 무효화 이벤트를 가능한 한 실시간에 가깝게 들어야 하고 '비수신' 상태(이 ERC를 구현하지 않았을 때의 기본 상태)에서는 If-None-Match, If-Modified-Since 같은 캐시 검증 요청을 모두 무시합니다. 상태는 언제든 바꿀 수 있고 RPC 사용을 최적화하는 휴리스틱을 둘 수도 있습니다. 캐시는 (체인 ID, 컨트랙트 주소, ERC-6860 pathQuery)를 키로, (최종 수정일, ETag)를 값으로 하는 매핑으로 관리하며 수신 상태에서 비수신 상태로 바뀔 때 반드시 비워야 합니다. ERC-7618처럼 Accept-Encoding 요청 헤더를 키에 추가해야 하는 경우도 있습니다.
이벤트 수신 상태에서의 요청 처리
매핑 항목이 없으면 컨트랙트를 호출하고 응답에 evm-events 지시어와 ETag가 있으면 ETag로 항목을 만듭니다. evm-events와 max-age=XX 지시어가 있으면 Last-Modified 헤더, Date 헤더, 컨트랙트를 조회한 블록 시각의 우선순위로 최종 수정일을 정해 항목을 만들고 둘 다 있으면 ETag와 최종 수정일을 모두 담은 항목 하나를 만듭니다. 항목이 있을 때 요청의 If-None-Match 값이 저장된 ETag와 일치하면 즉시 304 Not Modified를 돌려주고 저장된 최종 수정일이 If-Modified-Since 날짜보다 앞서면 역시 즉시 304를 돌려줍니다. 일치하지 않거나 두 헤더가 없으면 컨트랙트를 호출하고 항목을 지운 뒤 항목이 없던 것처럼 처리합니다. 이벤트가 오면 경로가 맞는 매핑 항목을 삭제합니다.
별도 지시어를 둔 이유
표준 HTTP에 최대한 가깝게 가려고 기존 HTTP 캐싱 헤더를 재사용하면서도 evm-events 지시어를 따로 둔 것은 안전장치입니다. 어떤 웹사이트가 전통적인 RFC 9111 캐싱 헤더만 쓰고 이 ERC의 이벤트는 발생시키지 않는다면, 이 ERC를 구현한 클라이언트가 그 사이트의 오래된 내용을 무기한 보여 주게 됩니다. 지시어를 명시한 사이트만 이벤트 기반 캐싱의 대상으로 삼아 이런 상황을 피합니다.
아직 초안 단계인 제안
이 ERC는 ERC-6944 리졸브 모드의 확장으로, 인터페이스 변경 없이 추가할 수 있어 이 모드에 붙였고 ERC-5219와 ERC-6944를 전제로 합니다. 요청 HTTP 헤더를 전달하는 미래의 리졸브 모드도 이 ERC를 구현할 수 있습니다. 2024년 9월에 등록된 Draft(초안) 상태의 제안이라 아직 내용이 바뀌거나 진행이 멈출 수 있습니다.
쓸 때 주의할 점
- 이벤트 반영 지연 중 오래된 내용 제공: 캐시 삭제 이벤트를 내는 사용자 트랜잭션이 발생한 뒤 web3:// 클라이언트가 그 이벤트를 받아 처리할 때까지의 지연 동안에는 오래된 내용이 제공됩니다.
- 이벤트 누락 시 무기한 오래된 내용: 웹사이트는 캐시되는 각 페이지에 대해 캐시 무효화 이벤트를 제대로 구현해야 합니다. 그러지 않으면 오래된 내용이 무기한 제공됩니다.
- 체인 재구성 시 상태 되돌리기: 체인 재구성이 일어나면 web3:// 클라이언트는 캐싱 상태를 되돌려야 합니다. 그러지 않으면 되돌려진 내용이 다음 캐시 삭제 이벤트가 올 때까지 계속 제공됩니다.