Improve typing for options.auth

[samtstern]

Discussion

This is a non-breaking change to improve the typing for options.auth in initializeTestApp. Note that this removes the uid property of the token which should never have been there in the first place (sub is the canonical uid field).

Related issues:

• Better docs and examples for the 'auth' param and custom tokens quickstart-testing#2
• Authentication token property "firebase" not defined on test app's instance firebase-tools#2405
• http://b/153398707 (internal)

Testing

Improved existing unit tests

API Changes

N/A

[changeset-bot]

🦋 Changeset detected

Latest commit: 39cd8ff

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@firebase/rules-unit-testing	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[google-oss-bot]

Size Analysis Report

Affected Products

No changes between base commit (a10c18f) and head commit (f87eb8b).

Test Logs

• Base (a10c18f8): https://github.com/firebase/firebase-js-sdk/actions/runs/281518697
• Head (f87eb8b5): https://github.com/firebase/firebase-js-sdk/actions/runs/282664954

[google-oss-bot]

Binary Size Report

Affected SDKs

• @firebase/rules-unit-testing

  Type	Base (a10c18f)	Head (44411cd)	Diff
  main	7.28 kB	7.84 kB	+561 B (+7.7%)

Test Logs

• Base (a10c18f8): https://github.com/firebase/firebase-js-sdk/actions/runs/281518697
• Head (44411cd3): https://github.com/firebase/firebase-js-sdk/actions/runs/282663229

[mdirolf]

When using custom claims in firestore rules I grab them off the top-level token object, as documented here https://firebase.google.com/docs/auth/admin/custom-claims:

    function isAdmin() {
      return request.auth.token.admin;
    }

In testing I was able to create an app instance that passed those rules like this:

firebaseTesting.initializeTestApp({
    projectId,
    auth: {
      uid: 'mike', admin: true, firebase: {
        sign_in_provider: 'google.com'
      }
    }
  })

This change makes that admin: true a type error, so I tried moving it into a claims object like:

firebaseTesting.initializeTestApp({
    projectId,
    auth: {
      uid: 'mike', claims: {admin: true}, firebase: {
        sign_in_provider: 'google.com'
      }
    }
  })

That passes type checking but doesn't seem to work when testing those security rules. Am I doing something wrong or do custom claims need to get hoisted up a level at some point?

[samtstern]

@mdirolf hmmm that's interesting, would you mind opening a new issue rather than discussing it here on this closed PR?

[samtstern]

@mdirolf fixed in #3915 !

[mdirolf]

@samtstern thanks! sorry for not opening a new issue to begin with