Junhyunny's Devlogs

글 검색

기술 글 제목, 본문, 카테고리에서 검색합니다.

    이전 화면으로

    브라우저 서비스 워커 (Service Worker)

    • information
    이 글의 목차

    0. 들어가면서

    프론트엔드 테스트가 복잡해지면서 이를 단순화 하기 위해 공부하던 중 MSW(Mock Service Worker)를 알게 됐다. 목 서비스 워커는 브라우저의 서비스 워커를 테스트 더블로 만드는 라이브러리다. 현재 프론트엔드 애플리케이션의 PWA(Progressive Web Application)로 전환을 고려하면서 서비스 워커를 한번 더 마주쳤다. 이번 글을 통해 서비스 워커가 어떤 역할을 수행하는지 정리한다.

    1. Service Worker

    서비스 워커는 웹 브라우저에서 실행되는 백그라운드 스크립트다. 웹 애플리케이션의 성능을 향상시키고 기능 구현에 도움을 주는 기술이다. 웹 페이지와 별개로 동작하며 일종의 네트워크 프록시(proxy)로서 프론트엔드 애플리케이션과 서버 사이에서 요청과 응답을 처리할 수 있다. 네트워크 연결이 불안정한 경우에도 사용자 경험을 향상시킬 수 있다. 로컬호스트(localhost)를 제외하면 HTTPS 통신이 가능한 서버에서만 동작한다. 대표적으로 다음과 같은 기능을 제공한다.

    • 오프라인 브라우징(offline browsing)
      • 서비스 워커를 통해 웹 애플리케이션의 캐시(cache)를 관리할 수 있다.
      • 네트워크 연결이 없는 상황에서도 캐시된 리소스를 사용하여 애플리케이션을 실행할 수 있다.
    • 백그라운드 동기화
      • 사용자가 오프라인 상태에서 수행한 작업을 추적한다.
      • 네트워크 연결이 다시 활성화 될 때 작업을 동기화한다.
      • 오프라인 상태에서 작업하거나 변경한 내용을 온라인 상태가 되면 서버로 전송하여 동기화한다.
    • 푸시 알림
      • 푸시 알림을 받아 사용자에게 표시할 수 있다.
      • 웹 애플리케이션이 백그라운드에서도 중요한 정보를 사용자에게 전달할 수 있다.

    서비스 워커는 어디에 위치할까? 또 어떤 역할을 수행할 수 있을까?

    • 웹 애플리케이션과 웹 서버 사이의 새로운 계층에서 동작한다.
      • 웹 애플리케이션 입장에선 네트워크 프록시 역할을 수행한다.
    • 브라우저의 캐시 저장소를 사용해 필요한 리소스들을 저장한다.
      • 오프라인 상태에서도 캐시에 저장된 리소스를 사용하므로 일부 기능이 제한되지만, 정상적인 동작이 가능한다.
      • 캐시 저장소는 브라우저 캐시와 독립적으로 동작하며 영구적으로 보관된다.
    • 서비스 워커는 웹 애플리케이션과 독립적으로 동작하기 위해 설치를 통해 사용한다.
      • 웹 페이지와 독립적으로 동작하기 때문에 DOM 엘리먼트나 window 객체에 접근할 수 없습니다.
      • 백그라운드 동기화나 푸시 알림을 받아 처리할 수 있다.

    2. Service Worker Lifecycle and States

    서비스 워커는 설치에서 활성화까지 아래와 같은 상태를 거치게 된다.

    1. installing
      • navigator.serviceWorker.register() 함수 호출에 의해 설치가 시작된다.
      • 서비스 워커는 installing 상태가 되며 install 이벤트 콜백 함수가 실행된다.
      • 해당 콜백 함수에서 필요한 리소스를 사전에 캐시에 저장하는 등의 작업을 처리한다.
      • 설치에 실패하는 경우 redundant 상태로 변경된다.
    2. installed / waiting
      • 서비스 워커 설치가 완료되면 installed 상태가 된다.
      • 현재 활성화 된 서비스 워커가 없다면 activating 상태가 된다.
      • 현재 활성화 된 서비스 워커가 있다면 waiting 상태가 된다.
      • 현재 서비스 워커가 동작 중에 정지되는 것을 방지하고자 제어 중인 모든 웹 애플리케이션이 종료되면 대기 중인 새로운 워커로 변경된다.
      • skipWaiting() 함수를 통해 대기 상태 없이 즉시 새로운 서비스 워커를 사용할 수도 있다.
    3. activating
      • 서비스 워커가 활성화되기 전 상태이며 activate 이벤트 콜백 함수가 실행된다.
      • HTML 문서가 서비스 워커에 의해 제어되려면 리로드(reload)되어야 하지만, client.claim() 함수 호출을 통해 리로드 없이 재정의할 수 있다.
    4. activated
      • 서비스 워커가 활성화 된 상태이며 이 시점부터 fetch, push, sync 등의 이벤트 콜백을 받아 처리할 수 있다.
    5. redundant
      • 서비스 워커가 설치 중 실패하거나 새로운 버전으로 교체되면 redundant 상태가 된다.
      • redundant 상태의 서비스 워커는 앱에 아무런 영향을 미치지 못 한다.
    https://www.oreilly.com/library/view/building-progressive-web/9781491961643/ch04.html

    3. Practice

    서비스 워커는 이벤트 기반으로 동작한다. 이번 글에선 간단하게 fetch 이벤트를 통해 이미지를 캐싱하는 예제를 다뤄본다. 아래 목록은 서비스 워커에서 다룰 수 있는 이벤트 종류다.

    • Lifecycle Events
      • install
      • activate
    • Legacy Events
      • message
      • messageerror
    • Functional Events
      • fetch
      • sync
      • push
      • notificationclick
      • notificationclose
      • canmakepayment
      • paymentrequest

    3.1. index HTML

    메인 화면인 index.html 파일을 먼저 살펴보자.

    • HTML 문서 마지막 부분에서 regsiterServiceWorker 함수를 호출해 서비스 워커를 등록한다.
      • 서비스 워커는 프로젝트 폴더에 service-worker.js 스크립트 파일로 존재한다.
    • 두 개의 버튼이 존재하며 각 버튼은 다음과 같은 동작을 수행한다.
      • Clear Cache 버튼은 브라우저 캐시를 삭제하는 기능이다.
      • Cat Image 버튼은 고양이 이미지를 서버로부터 받아서 보여주는 기능이다.
    <html lang="en">
    
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <link rel="stylesheet" href="./style.css">
        <title>Document</title>
    </head>
    
    <body>
        <main>
            <div class="image">
                <img id="cat-image" src="https://cdn2.thecatapi.com/images/3k0.jpg" alt="cat">
            </div>
            <div class="buttons">
                <button onclick="clearCache()">Clear Cache</button>
                <button onclick="fetchCat()">Cat Image</button>
            </div>
        </main>
    </body>
    
    <script>
        function regsiterServiceWorker() {
            if ('serviceWorker' in navigator) {
                navigator.serviceWorker
                    .register('./service-worker.js')
                    .then(function (registration) {
                        if (registration.active && !navigator.serviceWorker.controller) {
                            window.location.reload();
                        }
                        console.log('register service worker - ', serviceWorker);
                    });
            }
        }
    
        function clearCache() {
            if ('caches' in window) {
                return caches.keys()
                    .then(function (keyList) {
                        console.log(keyList)
                        return Promise.all(keyList.map(function (key) {
                            return caches.delete(key);
                        }));
                    })
            }
            return Promise.resolve();
        }
    
        function fetchCat() {
            fetch('https://api.thecatapi.com/v1/images/search?limit=1')
                .then(response => response.json())
                .then(data => {
                    const catImage = document.querySelector("#cat-image");
                    catImage.src = data[0].url;
                })
                .catch(error => console.log(error));
        }
    
        regsiterServiceWorker();
    </script>
    
    </html>

    3.2. service-worker JavaScript

    서비스 워커에서 다음과 같은 이벤트를 처리한다.

    • install event
      • 서비스 워커를 설치 완료 전에 로그를 출력한다.
    • activate event
      • 서비스 워커가 활성화 상태 전에 로그를 출력한다.
      • clients.claim() 함수를 호출하여 리로드 없이 서비스 워커를 활성화한다.
    • fetch event
      • 네트워크 요청 이벤트를 처리한다.
      • 캐시에 데이터가 존재하면 이를 반환한다.
      • 캐시에 데이터가 존재하지 않으면 서버에 요청 후 응답을 캐시에 저장하고 이를 반환한다.
    self.addEventListener('install', event => {
        console.log('[Service Worker] install');
    });
    
    self.addEventListener('activate', event => {
        console.log('[Service Worker] activate');
        clients.claim();
    });
    
    self.addEventListener('fetch', fetchHandler);
    
    function fetchHandler(event) {
        const { request } = event;
        console.log("[Service Worker] fetch ", request);
        event.respondWith(
            caches.match(request)
                .then(response => {
                    return response || fetchAndCaching(request);
                })
        );
    }
    
    function fetchAndCaching(request) {
        return fetch(request)
            .then(response =>
                caches.open('my-cache')
                    .then(cache => {
                        cache.put(request, response.clone());
                        return response;
                    })
                    .catch(error => console.log(error))
            );
    }

    3.3. Run Web Server

    서비스 워커의 동작을 확인하기 위해 live-server 명령어로 간단하게 웹 서버를 실행한다.

    $ live-server             
    
    Serving "/Users/junhyunk/Desktop/2023-06-05-service-worker-api" at http://127.0.0.1:8080
    Ready for changes
    GET /favicon.ico 404 1.793 ms - 150

    서비스 워커 스크립트의 동작 모습을 살펴보자.

    • 등록된 서비스 워커 정보는 개발자 도구(F12) > 애플리케이션 > Service Workers에서 확인할 수 있다.
    • 사용 중인 캐시 정보는 개발자 도구 > 애플리케이션 > 캐시 저장공간에서 확인할 수 있다.
    • Cat Image 버튼 클릭 시
      • fetch 함수를 통해 API 요청 시 고양이 이미지 리소스 주소가 담긴 JSON 응답을 받는다.
      • 요청 정보를 키로 JSON 응답 캐시에 저장한다.
      • img 엘리먼트의 src 속성을 변경하면 새로운 이미지를 다운로드 받는다. 네트워크를 통해 이미지를 다운로드 받을 때도 서비스 워커의 fetch 이벤트 콜백 함수가 실행된다.
      • 요청 정보를 키로 다운로드 받은 이미지를 캐시에 저장한다.
      • 캐시된 데이터가 있으므로 다시 버튼을 누르면 이미지 변경이 발생하지 않는다.
    • Clear Cache 버튼 클릭 시
      • 캐시에 저장된 데이터를 모두 삭제한다.
      • 저장된 데이터가 삭제된 후 Cat Image 버튼을 누르면 이미지가 변경된다.
      • 이후에 Cat Image 버튼을 누르면 캐시된 데이터에 의해 이미지 변경이 발생하지 않는다.

    KEEP READING

    DISCUSSION

    댓글