Завантаження документації...
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
navigation.docs_sidebar.audience.founderHint
navigation.docs_sidebar.audience.founderHint
navigation.docs_sidebar.audience.founderHint
Ring Platform использует Firebase в двух отдельных направлениях — серверный Admin SDK для FCM push и серверных операций, и клиентский браузерный SDK для регистрации push-токенов и отображения уведомлений. Эти направления используют разные стратегии учётных данных и разные версии SDK.
В режимах k8s-postgres-fcm и supabase-fcm Firebase Admin используется только для FCM push. Абстракция базы данных (DatabaseService) маршрутизирует к PostgreSQL, а не к Firestore. Только DB_BACKEND_MODE=firebase-full активирует Firestore как основное хранилище данных.
| Файл | Назначение | Стратегия учётных данных |
|---|---|---|
lib/firebase-admin.server.ts | Singleton Firebase Admin SDK — FCM, Auth, Firestore, RTDB | Всегда явный cert() — требует AUTH_FIREBASE_CLIENT_EMAIL + AUTH_FIREBASE_PRIVATE_KEY |
lib/database/adapters/FirebaseAdapter.ts | Абстракция базы данных для Firestore (активен только в режиме firebase-full) | ADC-first — запасной cert() при наличии учётных данных в конфигурации |
lib/services/firebase-service-manager.ts | Кэшированные чтения Firestore с использованием React 19 cache(), пакетные операции, транзакции | Делегирует к firebase-admin.server.ts |
lib/firebase/build-mock.server.ts | Имитация сервисов во время SSG-сборки Next.js — предотвращает 22+ лишних инициализаций | Возвращает имитации без подключения |
| Файл | Назначение |
|---|---|
public/firebase-messaging-sw.js | Service worker — Firebase compat SDK v12.9.0 загружается с CDN, обрабатывает push-события и фоновые сообщения |
Файл lib/firebase.ts отсутствует — клиентский Firebase инициализируется исключительно внутри service worker через importScripts() с CDN. Регистрация FCM-токена в браузере происходит в React-компонентах с помощью хука use-fcm.ts внутри FCMProvider.
Ваш Ring-клон требует учётных данных Firebase в двух контекстах:
DB_BACKEND_MODE. Firebase является только транспортным средством доставки push; ваши данные приложения остаются в основной базе данных (PostgreSQL или Firestore).DB_BACKEND_MODE=firebase-full. Firebase Admin SDK служит основной базой данных.Если вам не нужны push-уведомления, вы можете опустить все переменные окружения Firebase. Платформа работает на одном PostgreSQL.
/api/entities/upload)firebase-admin.server.ts, но не используется в режиме firebase-full)lib/firebase.ts отсутствует)Ring Platform использует Firebase в двух отдельных направлениях — серверный Admin SDK для FCM push и серверных операций, и клиентский браузерный SDK для регистрации push-токенов и отображения уведомлений. Эти направления используют разные стратегии учётных данных и разные версии SDK.
В режимах k8s-postgres-fcm и supabase-fcm Firebase Admin используется только для FCM push. Абстракция базы данных (DatabaseService) маршрутизирует к PostgreSQL, а не к Firestore. Только DB_BACKEND_MODE=firebase-full активирует Firestore как основное хранилище данных.
| Файл | Назначение | Стратегия учётных данных |
|---|---|---|
lib/firebase-admin.server.ts | Singleton Firebase Admin SDK — FCM, Auth, Firestore, RTDB | Всегда явный cert() — требует AUTH_FIREBASE_CLIENT_EMAIL + AUTH_FIREBASE_PRIVATE_KEY |
lib/database/adapters/FirebaseAdapter.ts | Абстракция базы данных для Firestore (активен только в режиме firebase-full) | ADC-first — запасной cert() при наличии учётных данных в конфигурации |
lib/services/firebase-service-manager.ts | Кэшированные чтения Firestore с использованием React 19 cache(), пакетные операции, транзакции | Делегирует к firebase-admin.server.ts |
lib/firebase/build-mock.server.ts | Имитация сервисов во время SSG-сборки Next.js — предотвращает 22+ лишних инициализаций | Возвращает имитации без подключения |
| Файл | Назначение |
|---|---|
public/firebase-messaging-sw.js | Service worker — Firebase compat SDK v12.9.0 загружается с CDN, обрабатывает push-события и фоновые сообщения |
Файл lib/firebase.ts отсутствует — клиентский Firebase инициализируется исключительно внутри service worker через importScripts() с CDN. Регистрация FCM-токена в браузере происходит в React-компонентах с помощью хука use-fcm.ts внутри FCMProvider.
Ваш Ring-клон требует учётных данных Firebase в двух контекстах:
DB_BACKEND_MODE. Firebase является только транспортным средством доставки push; ваши данные приложения остаются в основной базе данных (PostgreSQL или Firestore).DB_BACKEND_MODE=firebase-full. Firebase Admin SDK служит основной базой данных.Если вам не нужны push-уведомления, вы можете опустить все переменные окружения Firebase. Платформа работает на одном PostgreSQL.
/api/entities/upload)firebase-admin.server.ts, но не используется в режиме firebase-full)lib/firebase.ts отсутствует)Ring Platform использует Firebase в двух отдельных направлениях — серверный Admin SDK для FCM push и серверных операций, и клиентский браузерный SDK для регистрации push-токенов и отображения уведомлений. Эти направления используют разные стратегии учётных данных и разные версии SDK.
В режимах k8s-postgres-fcm и supabase-fcm Firebase Admin используется только для FCM push. Абстракция базы данных (DatabaseService) маршрутизирует к PostgreSQL, а не к Firestore. Только DB_BACKEND_MODE=firebase-full активирует Firestore как основное хранилище данных.
| Файл | Назначение | Стратегия учётных данных |
|---|---|---|
lib/firebase-admin.server.ts | Singleton Firebase Admin SDK — FCM, Auth, Firestore, RTDB | Всегда явный cert() — требует AUTH_FIREBASE_CLIENT_EMAIL + AUTH_FIREBASE_PRIVATE_KEY |
lib/database/adapters/FirebaseAdapter.ts | Абстракция базы данных для Firestore (активен только в режиме firebase-full) | ADC-first — запасной cert() при наличии учётных данных в конфигурации |
lib/services/firebase-service-manager.ts | Кэшированные чтения Firestore с использованием React 19 cache(), пакетные операции, транзакции | Делегирует к firebase-admin.server.ts |
lib/firebase/build-mock.server.ts | Имитация сервисов во время SSG-сборки Next.js — предотвращает 22+ лишних инициализаций | Возвращает имитации без подключения |
| Файл | Назначение |
|---|---|
public/firebase-messaging-sw.js | Service worker — Firebase compat SDK v12.9.0 загружается с CDN, обрабатывает push-события и фоновые сообщения |
Файл lib/firebase.ts отсутствует — клиентский Firebase инициализируется исключительно внутри service worker через importScripts() с CDN. Регистрация FCM-токена в браузере происходит в React-компонентах с помощью хука use-fcm.ts внутри FCMProvider.
Ваш Ring-клон требует учётных данных Firebase в двух контекстах:
DB_BACKEND_MODE. Firebase является только транспортным средством доставки push; ваши данные приложения остаются в основной базе данных (PostgreSQL или Firestore).DB_BACKEND_MODE=firebase-full. Firebase Admin SDK служит основной базой данных.Если вам не нужны push-уведомления, вы можете опустить все переменные окружения Firebase. Платформа работает на одном PostgreSQL.
/api/entities/upload)firebase-admin.server.ts, но не используется в режиме firebase-full)lib/firebase.ts отсутствует)SDK агрессивно очищает входные данные переменных окружения — удаляет внешние кавычки, преобразует \\n в реальные новые строки, обрезает пробелы. Согласованность двойных кавычек в env.local.template для AUTH_FIREBASE_PRIVATE_KEY является намеренной:
FirebaseAdapter.ts)FirebaseAdapter реализует IDatabaseService и используется только когда DB_BACKEND_MODE=firebase-full. По умолчанию он использует Application Default Credentials (ADC):
Адаптер предоставляет стандартный контракт DatabaseService:
firebase-service-manager.ts)Предоставляет кэшированные операции Firebase с использованием React 19 cache() для дедупликации на один запрос. Используется только когда getAdminDb() возвращает реальный (не имитированный) экземпляр Firestore.
Ключевые экспорты:
| Экспорт | Описание |
|---|---|
getCachedDocument(collection, docId) | Одиночный документ с дедупликацией через cache() |
getCachedCollection(collection, options) | Запрос коллекции с кэшированием |
getCachedDocumentBatch(requests) | Пакетное получение нескольких документов |
getCachedCollectionAdvanced(collection, queryConfig) | Сложные запросы (where, orderBy, paginate) |
getCachedSubcollection(parentCol, parentId, subCol, options) | Запросы вложенных коллекций |
getCachedCollectionGroup(collectionId, options) | Межколлекционные запросы |
createDocument, updateDocument, deleteDocument | Операции записи (без кэширования) |
createBatchWriter / executeBatch | Пакетная запись |
runTransaction | Атомные транзакции |
getCacheMetrics / logCachePerformance | Отладочные метрики (только для разработки) |
Оптимизация на этапе сборки: Все кэшированные функции вызываются только когда getAdminDb() возвращает реальный Firestore. Во время сборки (SSG) методы имитированного Firestore возвращают пустые результаты, а слой cache() дедуплицирует в пределах каждого запроса.
build-mock.server.ts)Во время статической генерации Next.js (NEXT_PHASE=phase-production-build) вызовы Firebase Admin перехватываются имитированными сервисами:
Это предотвращает примерно 22 лишних инициализации Firebase Admin во время SSG и сокращает время сборки примерно на 31%.
Service worker по адресу public/firebase-messaging-sw.js загружает Firebase compat SDK v12.9.0 с Google CDN:
Service worker поддерживает внедрённую во время выполнения конфигурацию Firebase через переменные self.* (устанавливаются заполнителями env.local.template на этапе сборки или внедряются в развёртываниях k8s).
Процесс регистрации FCM-токена:
'use client' вызывает Notification.requestPermission()getToken(messaging, { vapidKey })upsertFcmToken в основную базу данных (PostgreSQL или Firestore в зависимости от DB_BACKEND_MODE)useAuth().signOut() вызывает unregisterCurrentDeviceFcmToken(), которая запускает deleteToken Firebase + инвалидацию на стороне сервера| Аспект | Admin SDK (firebase-admin.server.ts) | Адаптер (FirebaseAdapter.ts) |
|---|---|---|
| Учётные данные | Всегда явный cert() | ADC-first, запасной cert() |
| Переменные окружения | Все 3 AUTH_FIREBASE_* обязательны | Только AUTH_FIREBASE_PROJECT_ID для ADC |
| Активен в | Все значения DB_BACKEND_MODE (FCM) | Только firebase-full |
| Имитация в postgres-primary | Да — возвращает имитированные Firestore/Auth | Нет — адаптер не зарегистрирован |
| Путь импорта | firebase-admin/app, firebase-admin/firestore | То же |
| Версия | v14 (именованные подпути импорта) | v14 |
AUTH_FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nMIIEvQ...\n-----END PRIVATE KEY-----\n"
# Обязательные для FCM + инициализации Firebase Admin (все три):
AUTH_FIREBASE_PROJECT_ID=your_firebase_project_id
AUTH_FIREBASE_CLIENT_EMAIL=your_firebase_client_email
AUTH_FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"
# Опционально:
FIREBASE_DATABASE_URL=https://your-project-default-rtdb.firebaseio.com
FIREBASE_PRIVATE_KEY_ID=your_firebase_private_key_id
FIREBASE_CLIENT_ID="your_firebase_client_id"
FIREBASE_FIRESTORE_DEBUG=true
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_firebase_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=G-YCZKPV315E
NEXT_PUBLIC_FIREBASE_VAPID_KEY=your_vapid_keySDK агрессивно очищает входные данные переменных окружения — удаляет внешние кавычки, преобразует \\n в реальные новые строки, обрезает пробелы. Согласованность двойных кавычек в env.local.template для AUTH_FIREBASE_PRIVATE_KEY является намеренной:
FirebaseAdapter.ts)FirebaseAdapter реализует IDatabaseService и используется только когда DB_BACKEND_MODE=firebase-full. По умолчанию он использует Application Default Credentials (ADC):
Адаптер предоставляет стандартный контракт DatabaseService:
firebase-service-manager.ts)Предоставляет кэшированные операции Firebase с использованием React 19 cache() для дедупликации на один запрос. Используется только когда getAdminDb() возвращает реальный (не имитированный) экземпляр Firestore.
Ключевые экспорты:
| Экспорт | Описание |
|---|---|
getCachedDocument(collection, docId) | Одиночный документ с дедупликацией через cache() |
getCachedCollection(collection, options) | Запрос коллекции с кэшированием |
getCachedDocumentBatch(requests) | Пакетное получение нескольких документов |
getCachedCollectionAdvanced(collection, queryConfig) | Сложные запросы (where, orderBy, paginate) |
getCachedSubcollection(parentCol, parentId, subCol, options) | Запросы вложенных коллекций |
getCachedCollectionGroup(collectionId, options) | Межколлекционные запросы |
createDocument, updateDocument, deleteDocument | Операции записи (без кэширования) |
createBatchWriter / executeBatch | Пакетная запись |
runTransaction | Атомные транзакции |
getCacheMetrics / logCachePerformance | Отладочные метрики (только для разработки) |
Оптимизация на этапе сборки: Все кэшированные функции вызываются только когда getAdminDb() возвращает реальный Firestore. Во время сборки (SSG) методы имитированного Firestore возвращают пустые результаты, а слой cache() дедуплицирует в пределах каждого запроса.
build-mock.server.ts)Во время статической генерации Next.js (NEXT_PHASE=phase-production-build) вызовы Firebase Admin перехватываются имитированными сервисами:
Это предотвращает примерно 22 лишних инициализации Firebase Admin во время SSG и сокращает время сборки примерно на 31%.
Service worker по адресу public/firebase-messaging-sw.js загружает Firebase compat SDK v12.9.0 с Google CDN:
Service worker поддерживает внедрённую во время выполнения конфигурацию Firebase через переменные self.* (устанавливаются заполнителями env.local.template на этапе сборки или внедряются в развёртываниях k8s).
Процесс регистрации FCM-токена:
'use client' вызывает Notification.requestPermission()getToken(messaging, { vapidKey })upsertFcmToken в основную базу данных (PostgreSQL или Firestore в зависимости от DB_BACKEND_MODE)useAuth().signOut() вызывает unregisterCurrentDeviceFcmToken(), которая запускает deleteToken Firebase + инвалидацию на стороне сервера| Аспект | Admin SDK (firebase-admin.server.ts) | Адаптер (FirebaseAdapter.ts) |
|---|---|---|
| Учётные данные | Всегда явный cert() | ADC-first, запасной cert() |
| Переменные окружения | Все 3 AUTH_FIREBASE_* обязательны | Только AUTH_FIREBASE_PROJECT_ID для ADC |
| Активен в | Все значения DB_BACKEND_MODE (FCM) | Только firebase-full |
| Имитация в postgres-primary | Да — возвращает имитированные Firestore/Auth | Нет — адаптер не зарегистрирован |
| Путь импорта | firebase-admin/app, firebase-admin/firestore | То же |
| Версия | v14 (именованные подпути импорта) | v14 |
AUTH_FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nMIIEvQ...\n-----END PRIVATE KEY-----\n"
# Обязательные для FCM + инициализации Firebase Admin (все три):
AUTH_FIREBASE_PROJECT_ID=your_firebase_project_id
AUTH_FIREBASE_CLIENT_EMAIL=your_firebase_client_email
AUTH_FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"
# Опционально:
FIREBASE_DATABASE_URL=https://your-project-default-rtdb.firebaseio.com
FIREBASE_PRIVATE_KEY_ID=your_firebase_private_key_id
FIREBASE_CLIENT_ID="your_firebase_client_id"
FIREBASE_FIRESTORE_DEBUG=true
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_firebase_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=G-YCZKPV315E
NEXT_PUBLIC_FIREBASE_VAPID_KEY=your_vapid_keySDK агрессивно очищает входные данные переменных окружения — удаляет внешние кавычки, преобразует \\n в реальные новые строки, обрезает пробелы. Согласованность двойных кавычек в env.local.template для AUTH_FIREBASE_PRIVATE_KEY является намеренной:
FirebaseAdapter.ts)FirebaseAdapter реализует IDatabaseService и используется только когда DB_BACKEND_MODE=firebase-full. По умолчанию он использует Application Default Credentials (ADC):
Адаптер предоставляет стандартный контракт DatabaseService:
firebase-service-manager.ts)Предоставляет кэшированные операции Firebase с использованием React 19 cache() для дедупликации на один запрос. Используется только когда getAdminDb() возвращает реальный (не имитированный) экземпляр Firestore.
Ключевые экспорты:
| Экспорт | Описание |
|---|---|
getCachedDocument(collection, docId) | Одиночный документ с дедупликацией через cache() |
getCachedCollection(collection, options) | Запрос коллекции с кэшированием |
getCachedDocumentBatch(requests) | Пакетное получение нескольких документов |
getCachedCollectionAdvanced(collection, queryConfig) | Сложные запросы (where, orderBy, paginate) |
getCachedSubcollection(parentCol, parentId, subCol, options) | Запросы вложенных коллекций |
getCachedCollectionGroup(collectionId, options) | Межколлекционные запросы |
createDocument, updateDocument, deleteDocument | Операции записи (без кэширования) |
createBatchWriter / executeBatch | Пакетная запись |
runTransaction | Атомные транзакции |
getCacheMetrics / logCachePerformance | Отладочные метрики (только для разработки) |
Оптимизация на этапе сборки: Все кэшированные функции вызываются только когда getAdminDb() возвращает реальный Firestore. Во время сборки (SSG) методы имитированного Firestore возвращают пустые результаты, а слой cache() дедуплицирует в пределах каждого запроса.
build-mock.server.ts)Во время статической генерации Next.js (NEXT_PHASE=phase-production-build) вызовы Firebase Admin перехватываются имитированными сервисами:
Это предотвращает примерно 22 лишних инициализации Firebase Admin во время SSG и сокращает время сборки примерно на 31%.
Service worker по адресу public/firebase-messaging-sw.js загружает Firebase compat SDK v12.9.0 с Google CDN:
Service worker поддерживает внедрённую во время выполнения конфигурацию Firebase через переменные self.* (устанавливаются заполнителями env.local.template на этапе сборки или внедряются в развёртываниях k8s).
Процесс регистрации FCM-токена:
'use client' вызывает Notification.requestPermission()getToken(messaging, { vapidKey })upsertFcmToken в основную базу данных (PostgreSQL или Firestore в зависимости от DB_BACKEND_MODE)useAuth().signOut() вызывает unregisterCurrentDeviceFcmToken(), которая запускает deleteToken Firebase + инвалидацию на стороне сервера| Аспект | Admin SDK (firebase-admin.server.ts) | Адаптер (FirebaseAdapter.ts) |
|---|---|---|
| Учётные данные | Всегда явный cert() | ADC-first, запасной cert() |
| Переменные окружения | Все 3 AUTH_FIREBASE_* обязательны | Только AUTH_FIREBASE_PROJECT_ID для ADC |
| Активен в | Все значения DB_BACKEND_MODE (FCM) | Только firebase-full |
| Имитация в postgres-primary | Да — возвращает имитированные Firestore/Auth | Нет — адаптер не зарегистрирован |
| Путь импорта | firebase-admin/app, firebase-admin/firestore | То же |
| Версия | v14 (именованные подпути импорта) | v14 |
AUTH_FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nMIIEvQ...\n-----END PRIVATE KEY-----\n"
# Обязательные для FCM + инициализации Firebase Admin (все три):
AUTH_FIREBASE_PROJECT_ID=your_firebase_project_id
AUTH_FIREBASE_CLIENT_EMAIL=your_firebase_client_email
AUTH_FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"
# Опционально:
FIREBASE_DATABASE_URL=https://your-project-default-rtdb.firebaseio.com
FIREBASE_PRIVATE_KEY_ID=your_firebase_private_key_id
FIREBASE_CLIENT_ID="your_firebase_client_id"
FIREBASE_FIRESTORE_DEBUG=true
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_firebase_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=G-YCZKPV315E
NEXT_PUBLIC_FIREBASE_VAPID_KEY=your_vapid_key