Переход на Go Admin SDK v4

Начиная с версии 4.0.0, Firebase Admin SDK для Go выбрал Go modules . Также есть критические изменения в обработке ошибок и семантике.

Изменения в установке

В соответствии с передовой практикой модулей основная версия SDK была добавлена ​​к имени пакета. Это изменение приводит к следующим обновлениям имени пакета:

  • firebase.google.com/go → firebase.google.com/go/v4
  • firebase.google.com/go/auth → firebase.google.com/go/v4/auth
  • firebase.google.com/go/db → firebase.google.com/go/v4/db
  • firebase.google.com/go/iid → firebase.google.com/go/v4/iid
  • firebase.google.com/go/messaging → firebase.google.com/go/v4/messaging

Разработчики уже используют модули

Используйте имя версии пакета для установки последней версии SDK.

# Install the latest version:
go install firebase.google.com/go/v4@latest

# Or install a specific version:
go install firebase.google.com/go/v4@4.16.0

При импорте SDK в исходном коде необходимо использовать то же самое имя версии пакета.

package helloworld

import (
        "firebase.google.com/go/v4"
        "firebase.google.com/go/v4/auth"
        "firebase.google.com/go/v4/messaging"
)

Чтобы установить более раннюю версию, используйте старое (неверсированное) имя пакета с явным указанием версии.

# Notice the @v3 suffix.
# This instructs Go tools to fetch the latest v3.x release of the SDK.
go get firebase.google.com/go@v3

Разработчики в настоящее время не используют модули

Разработчики, которые еще не выбрали модули, могут продолжить установку SDK, используя неверсированное имя пакета.

go get firebase.google.com/go

Однако следует отметить, что при этом загружается последняя версия SDK (v4 или более поздняя), которая содержит другие критические изменения API.

Общие изменения в обработке ошибок

В SDK v4 представлен новый пакет errorutils , который предоставляет функции для обработки ошибок на уровне платформы. В случае, если ошибка была вызвана ошибкой бэкэнд-службы, вы можете получить доступ к исходному ответу об ошибке, вызвав новую функцию errorutils.HTTPResponse() . Вы можете использовать функции в этом пакете с ошибками, возвращаемыми любым API в SDK.

Изменения API Authentication

  • Добавлены новые функции обработки ошибок для использования совместно с API VerifyIDToken() и VerifySessionCookie() :
    • IsIDTokenInvalid()
    • IsIDTokenExpired()
    • IsSessionCookieInvalid()
    • IsSessionCookieExpired()
    • IsCertificateFetchFailed()
  • Устаревшее:
    • IsProjectNotFound()
    • IsUnknown()
    • IsInsufficientPermission()
    • IsInvalidEmail()

Изменения API FCM

  • Тип messaging.WebpushFCMOptions переименован в messaging.WebpushFcmOptions .
  • Добавлен:
    • IsThirdPartyAuthError()
    • IsQuotaExceeded()
    • IsSenderIDMismatch()
    • IsUnregistered()
    • IsUnavailable()
  • Устаревшее:
    • IsInvalidAPNSCredentials()
    • IsMessageRateExceeded()
    • IsMismatchedCredential()
    • IsRegistrationTokenNotRegistered()
    • IsServerUnavailable()
    • IsTooManyTopics()
    • IsUnknown()

Изменения API IID

Все функции обработки ошибок, доступные в настоящее время в пакете iid , теперь устарели. Используйте вместо этого соответствующие функции обработки ошибок, предоставленные в пакете errorutils .