Misleading error message for THIRD_PARTY_AUTH_ERROR: raw "OAuth 2 access token" text surfaced instead of the APNs-specific message

Open
#3,215 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api, backend

Research direction

Start in src/messaging/error.ts by reading the THIRD_PARTY_AUTH_ERROR mapping and the later error.message assignment. Confirm how the canonical APNs message is selected when the raw UNAUTHENTICATED response is present, then update the behavior and wording so APNs auth keys and Web Push VAPID credentials are covered. Done means the third-party-auth-error no longer surfaces the misleading raw OAuth guidance as its primary message.

Written by the indexing model from the issue text.

Description

api: messaging

Summary

When FCM rejects an iOS send with UNAUTHENTICATED, the SDK surfaces the raw
gateway message ("...Expected OAuth 2 access token...") instead of its own
APNs-specific message, even though the error is classified as
messaging/third-party-auth-error. This sends developers down the wrong path
(debugging their own service-account / OAuth setup) when the real cause is a
downstream APNs credential problem.

What happened

Sending to iOS device tokens, some tokens fail with:

HTTP 401
{
  "error": {
    "code": 401,
    "status": "UNAUTHENTICATED",
    "message": "Request is missing required authentication credential. Expected OAuth 2 access token, login cookie or other valid authentication credential. ...",
    "details": [{ "@type": "...FcmError", "errorCode": "THIRD_PARTY_AUTH_ERROR" }]
  }
}

error.code is correctly messaging/third-party-auth-error, but error.message
is the raw "Expected OAuth 2 access token" text. That message strongly implies
a problem with the caller's own authentication (service account / access token),
so it's natural to spend several debugging cycles verifying OAuth, the service
account, token refresh, etc. — all of which are fine. The actual cause is on the
APNs side (e.g. an APNs auth key/certificate that doesn't cover the environment a
given token was minted in). The misleading message cost us multiple debugging
rounds before we inspected details[].errorCode.

Root cause in the SDK

In src/messaging/error.ts on current main:

  • UNAUTHENTICATED is mapped to THIRD_PARTY_AUTH_ERROR (line ~201), and there is
    a clear canonical message for it (lines ~133–137):

    "A message targeted to an iOS device could not be sent because the required
    APNs SSL certificate was not uploaded or has expired. Check the validity of
    your development and production certificates."

  • But the error message is assigned as (line ~260):

    error.message = message || error.message;
    

    Since the raw server message is truthy, it always wins, so the SDK's own
    clearer, APNs-specific message is never shown for this code — the misleading
    "OAuth 2 access token" text is surfaced instead.

A second, smaller issue: the canonical message is dated

Even when shown, the canonical message only mentions an "APNs SSL certificate"
and "development and production certificates" — i.e. the .p12 model. Modern
setups use .p8 APNs auth keys (token-based auth), and Web Push uses VAPID
keys. For those, "certificate ... has expired / check your certificates" is
itself misleading, because there is no certificate involved.

Suggested fix

  1. For third-party-auth-error, prefer (or prepend) the SDK's canonical message
    rather than the raw UNAUTHENTICATED gateway text, since that raw text
    systematically points debugging in the wrong direction. The raw text can be
    kept as "Raw server response: ..." (the SDK already appends that in some
    paths).
  2. Update the canonical message to cover APNs auth keys (.p8) and Web Push
    (VAPID)
    , not just SSL certificates.

Environment

  • Verified against current main, src/messaging/error.ts.
  • Reproduced on a real send to an affected iOS token (401 / UNAUTHENTICATED /
    details[].errorCode = THIRD_PARTY_AUTH_ERROR).

Happy to open a PR along the lines of the suggested fix if this direction sounds right.

Dominant language
TypeScript
Stars
1.7k
Forks
419
Avg merge
3d 10h
Merged PRs (30d)
16

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from firebase/firebase-admin-node

All issues in firebase/firebase-admin-node

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.