로컬 에뮬레이터 도구 모음 설치, 구성, 통합

Firebase 로컬 에뮬레이터 도구 모음은 일회성 프로토타입 세션부터 프로덕션 규모의 지속적 통합 워크플로에 이르기까지 다양한 프로토타입 및 테스트 환경에 설치하고 구성할 수 있습니다.

로컬 에뮬레이터 도구 모음 설치

에뮬레이터 도구 모음을 설치하려면 필요한 사항은 다음과 같습니다.

• Node.js 버전 16.0 이상
• Java JDK 버전 11 이상

에뮬레이터 도구 모음을 설치하려면 다음 단계를 따르세요.

1. Firebase CLI를 설치합니다. Firebase CLI를 아직 설치하지 않은 경우 지금 설치합니다. 에뮬레이터 도구 모음을 사용하려면 CLI 버전 8.14.0 이상이 설치되어야 합니다. 다음 명령어를 사용하여 설치한 버전을 확인할 수 있습니다.

   firebase --version

2. 명령어를 아직 사용하지 않은 경우 화면에 표시되는 메시지에 따라 사용할 제품을 지정하여 현재 작업 디렉터리를 Firebase 프로젝트로 초기화합니다.

   firebase init

3. 에뮬레이터 도구 모음을 설정합니다. 이 명령어는 원하는 에뮬레이터를 선택하고 해당 에뮬레이터 바이너리 파일을 다운로드하며 기본값이 적절하지 않은 경우 에뮬레이터 포트를 설정할 수 있는 구성 마법사를 시작합니다.

   firebase init emulators

에뮬레이터가 설치되면 Firebase CLI 버전을 업데이트할 때까지 업데이트 확인이 수행되지 않으며 자동 다운로드가 추가로 진행되지 않습니다.

에뮬레이터 도구 모음 구성

필요할 경우 firebase.json 파일에서 에뮬레이터의 네트워크 포트와 보안 규칙 정의 경로를 구성할 수 있습니다.

• firebase init emulators를 실행하거나 firebase.json을 수동으로 편집하여 에뮬레이터 포트를 변경합니다.
• firebase.json을 수동으로 편집하여 보안 규칙 정의 경로를 변경합니다.

이러한 설정을 구성하지 않으면 에뮬레이터가 기본 포트를 리슨하며 Cloud Firestore, Realtime Database, Cloud Storage for Firebase 에뮬레이터는 개방형 데이터 보안으로 실행됩니다.

포트 구성

각 에뮬레이터는 선호하는 기본값을 사용하여 머신의 다른 포트에 바인딩됩니다.

프로젝트 ID 구성

에뮬레이터를 호출하는 방법에 따라 서로 다른 Firebase 프로젝트 ID를 사용하여 에뮬레이터의 여러 인스턴스를 실행하거나 특정 프로젝트 ID의 여러 에뮬레이터 인스턴스를 실행할 수 있습니다. 이러한 경우 에뮬레이터 인스턴스가 별도의 환경에서 실행됩니다.

Emulator Suite UI, 다양한 제품 에뮬레이터, 특정 에뮬레이터의 실행 중인 모든 인스턴스가 모든 경우에 제대로 통신할 수 있도록 일반적으로 모든 에뮬레이터 호출에 하나의 프로젝트 ID를 설정하는 것이 좋습니다.

Local Emulator Suite은 환경에서 여러 프로젝트 ID를 감지하면 경고를 표시하지만 firebase.json에서 singleProjectMode 키를 false로 설정하여 이 동작을 재정의할 수 있습니다.

다음에서 프로젝트 ID 선언의 불일치를 확인하세요.

• 명령줄의 기본 프로젝트. 기본적으로 프로젝트 ID는 시작 시 firebase init 또는 firebase use로 선택한 프로젝트에서 가져옵니다. 프로젝트 목록을 보고 어떤 프로젝트가 선택되었는지 확인하려면 firebase projects:list를 사용하세요.
• 규칙 단위 테스트. 일반적으로 프로젝트 ID는 규칙 단위 테스트 라이브러리 메서드 initializeTestEnvironment 또는 initializeTestApp을 호출할 때 지정됩니다.
• 명령줄의 --project 플래그. Firebase CLI --project 플래그를 전달하면 기본 프로젝트가 재정의됩니다. 플래그 값이 단위 테스트 및 앱 초기화의 프로젝트 ID와 일치하는지 확인해야 합니다.

또한 Apple 플랫폼, Android, 웹 프로젝트를 구성하는 동안 설정한 플랫폼별 프로젝트 ID 구성을 확인합니다.

보안 규칙 구성

에뮬레이터는 firebase.json의 database, firestore, storage 구성 키에서 보안 규칙 구성을 가져옵니다.

{
  // Existing firebase configuration ...
  "database": {
    "rules": "database.rules.json"
  },
  "firestore": {
    "rules": "firestore.rules"
  },
  "storage": {
    "rules": "storage.rules"
  }

  // ...

  // Optional emulator configuration. Default
  // values are used if absent.
  "emulators": {
    "singleProjectMode": false, // do not warn on detection of multiple project IDs
    "firestore": {
      "port": "8080"
    },
    "ui": {
      "enabled": true,      // Default is `true`
      "port": 4000          // If unspecified, see CLI log for selected port
    },
    "auth": {
      "port": "9099"
    },
    "pubsub": {
      "port": "8085"
    }
  }
}

자바 옵션 지정

Realtime Database 에뮬레이터, Cloud Firestore 에뮬레이터, 일부 Cloud Storage for Firebase 에뮬레이터는 자바를 기반으로 하며 환경 변수 JAVA_TOOL_OPTIONS을 통해 JVM 플래그로 맞춤설정할 수 있습니다.

예를 들어 자바 힙 공간 관련 오류가 발생하면 최대 자바 힙 크기를 4GB로 늘릴 수 있습니다.

export JAVA_TOOL_OPTIONS="-Xmx4g"
firebase emulators:start

JAVA_TOOL_OPTIONS="-Xms2g -Xmx4g"와 같이 여러 플래그를 따옴표 안에 공백으로 구분하여 지정할 수 있습니다. 플래그는 에뮬레이터의 자바 기반 구성요소에만 영향을 미치며 Emulator Suite UI와 같은 Firebase CLI의 다른 부분에는 영향을 미치지 않습니다.

에뮬레이터 시작

에뮬레이터를 시작하여 수동으로 종료하거나 지정된 테스트 스크립트 기간 동안 실행한 후 자동으로 종료되도록 할 수 있습니다.

firebase emulators:exec 메서드는 일반적으로 지속적 통합 워크플로에 더 적합합니다.

에뮬레이터 데이터 내보내기 및 가져오기

Authentication, Cloud Firestore, Realtime Database, Cloud Storage for Firebase 에뮬레이터에서 데이터를 내보내 공유 가능한 공통 기준 데이터 세트로 사용할 수 있습니다. 이러한 데이터 세트는 위에서 설명한 대로 --import 플래그를 사용하여 가져올 수 있습니다.

CI 시스템과 통합

컨테이너화된 에뮬레이터 도구 모음 이미지 실행

일반적인 CI 설정에서 컨테이너를 사용하여 에뮬레이터 도구 모음을 설치하고 구성하는 방법은 간단합니다.

다음과 같은 몇 가지 문제가 있습니다.

• JAR 파일은 ~/.cache/firebase/emulators/에 설치되고 캐시됩니다.

  • 이 경로를 CI 캐시 구성에 추가하여 반복 다운로드를 방지할 수 있습니다.

• 저장소에 firebase.json 파일이 없는 경우 emulators:start 또는 emulators:exec 명령어에 명령줄 인수를 추가하여 시작할 에뮬레이터를 지정해야 합니다. 예를 들면 다음과 같습니다.
  --only functions,firestore

인증 토큰 생성(호스팅 에뮬레이터 전용)

지속적 통합 워크플로가 Firebase Hosting을 사용하는 경우 firebase emulators:exec를 실행하려면 토큰을 사용하여 로그인해야 합니다. 다른 에뮬레이터에는 로그인이 필요하지 않습니다.

토큰을 생성하려면 로컬 환경에서 firebase login:ci를 실행합니다. 이 작업은 CI 시스템에서 수행하면 안 됩니다. 안내에 따라 인증하세요. 토큰은 빌드 간에 유효하므로 프로젝트당 한 번만 수행하면 됩니다. 토큰은 비밀번호처럼 비밀로 유지해야 합니다.

CI 환경에서 빌드 스크립트에 사용할 수 있는 환경 변수를 지정할 수 있으면 값이 액세스 토큰 문자열인 FIREBASE_TOKEN이라는 환경 변수를 만들면 됩니다. Firebase CLI가 자동으로 FIREBASE_TOKEN 환경 변수를 선택하고 에뮬레이터가 올바르게 시작됩니다.

마지막 수단으로 빌드 스크립트에 토큰을 포함할 수 있지만 신뢰할 수 없는 사용자가 액세스할 수 없도록 해야 합니다. 이 하드 코딩된 방식의 경우 firebase emulators:exec 명령어에 --token "YOUR_TOKEN_STRING_HERE"를 추가할 수 있습니다.

Emulator Hub REST API 사용

실행 중인 에뮬레이터 나열

현재 실행 중인 에뮬레이터를 나열하려면 GET 요청을 에뮬레이터 허브의 /emulators 엔드포인트로 전송합니다.

curl localhost:4400/emulators

결과로 실행 중인 모든 에뮬레이터와 호스트/포트 구성을 나열하는 JSON 객체가 반환됩니다. 예를 들면 다음과 같습니다.

{
  "hub":{
    "name": "hub",
    "host": "localhost",
    "port": 4400
  },
  "functions": {
    "name": "functions",
    "host": "localhost",
    "port": 5001
  }
  "firestore": {
    "name": "firestore",
    "host": "localhost",
    "port": 8080
  }
}

백그라운드 함수 트리거 사용 설정/사용 중지

상황에 따라서는 로컬 함수와 확장 프로그램 트리거를 일시적으로 사용 중지해야 할 수 있습니다. 예를 들어 Cloud Functions 또는 Extensions 에뮬레이터에서 실행 중인 onDelete 함수를 트리거하지 않고 Cloud Firestore 에뮬레이터의 모든 데이터를 삭제하려는 경우가 해당합니다.

로컬 함수 트리거를 일시적으로 사용 중지하려면 PUT 요청을 에뮬레이터 허브의 /functions/disableBackgroundTriggers 엔드포인트로 전송합니다.

curl -X PUT localhost:4400/functions/disableBackgroundTriggers

결과로 현재 상태를 자세히 설명하는 JSON 객체가 반환됩니다.

{
  "enabled": false
}

로컬 함수 트리거를 사용 중지한 후 사용 설정하려면 PUT 요청을 에뮬레이터 허브의 /functions/enableBackgroundTriggers 엔드포인트로 전송합니다.

curl -X PUT localhost:4400/functions/enableBackgroundTriggers

결과로 현재 상태를 자세히 설명하는 JSON 객체가 반환됩니다.

{
  "enabled": true
}

에뮬레이터 SDK 통합

이 섹션의 표는 클라이언트 및 Admin SDK에서 지원하는 에뮬레이터를 나타냅니다. 예정은 에뮬레이터 지원이 예정되어 있지만 아직 사용할 수 없음을 의미합니다.

클라이언트 SDK 가용성

Admin SDK 가용성