feat: update Firebase adapter to use new API

[chanceaclark]

Ports and refactors adapter-firebase to use new Adapter API. Ported from this PR: nextauthjs/adapters#183

Breaking Changes:

• Requires Firebase@9+
• Adapter now consumes FirebaseOptions
• Additional emulator options to connect to Firestore emulator

Reasoning 💡

Uses new firebase modular + adapter api.

Checklist 🧢

• Documentation
• Tests
• Ready to be merged

Affected issues 🎟

Closes #3827

cc. @balazsorban44

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/nextauthjs/next-auth/B9LdbAmzy78jXehodwfN8ttCYbf1
✅ Preview: https://next-auth-git-fork-chanceaclark-feat-firebase-c1d8cc-nextauthjs.vercel.app

[Deployment for 0735258 failed]

[balazsorban44]

I really appreciate it! Once we finish the migration to a monorepo setup #3650, I'll have a look!

My main blocker on my original PR was to figure out how could we integrate with Firebase Authentication's User management.

Do you have any ideas? It would certainly be cleaner for Firebase users, but we could also just use Firestore for now and re-visit this later on.

I also know people wanted a security rule suggestion, so if you have any, could you add it to the docs at the same time?

[chanceaclark]

I really appreciate it! Once we finish the migration to a monorepo setup #3650, I'll have a look!

For sure, no worries!

Do you have any ideas? It would certainly be cleaner for Firebase users, but we could also just use Firestore for now and re-visit this later on.

I was thinking about this for while and tried to take a stab at it myself adding it to this adapter. But I gave up after a little because it was like fitting a square peg in a round hole. Firebase Auth acts similarly to this library – providers in next-auth are similar in nature "Sign-in providers" in firebase/auth. Potentially we could make something work in y'alls Provider API but it might not be an all-in-one solution that we are looking for. For example I was thinking of something like FirebaseEmailProvider, FirebaseGoogleProvider, etc... I'm not too familiar with this library, but what do you think about that?

I also know people wanted a security rule suggestion, so if you have any, could you add it to the docs at the same time?

Do you know what kind of suggestion people are looking for? Like rules around the next-auth created collections (users, accounts, sessions and verificationTokens)? Or how to protect resources you create after a user has been authenticated? Also, is there a issue around this that I can get more context?

[thiras]

Hello. Is there any ETA for the merge?

[chanceaclark]

Hey @thiras, I think we are still kinda waiting for #3952 to be resolved. Not sure what the status is on that, maybe @balazsorban44 or @ndom91 can enlighten us?

[balazsorban44]

The monorepo migration has been finished, currently making sure the release pipeline is ready. I'll look into PRs like this when I'm confident about releases. 👍

Thank you for your patience. In the meantime, please test this adapter by copy-pasting it into your projects and see if it works.

I see there is a merge conflict, that should be fixed anyway before this could be merged.

[chanceaclark]

You got it @balazsorban44. I'll go ahead and rebase + test it. Also, it seems like one of the CI checks needs approval by a maintainer before running, would you mind checking that out?

EDIT: Updated some deps to the latest and tested locally - looks ✅

[DiegoGonzalezCruz]

Hi guys, I just found this and I'm loving it! Sending y'all good energies for a successfull PR!

[MarinaMijatovic]

Can this adapter work with firebase realtime database?

[ndom91]

Can this adapter work with firebase realtime database?

This adapter is specifically designed to work with Firestore only. I'm curious what use-case you would need a realtime database for when storing user metadata (email, username, etc.)

[MarinaMijatovic]

Can this adapter work with firebase realtime database?

This adapter is specifically designed to work with Firestore only. I'm curious what use-case you would need a realtime database for when storing user metadata (email, username, etc.)

Sign in should be done by email provider, and the email provider requires adapter to store verification token. The project itself requires users metadata, and tracking current flow of their progress on their project. I'm not sure whether realtime database is the best solution, still researching.

[Sal-man]

Hi guys, any ETA on the merge?

[ndom91]

Can this adapter work with firebase realtime database?

This adapter is specifically designed to work with Firestore only. I'm curious what use-case you would need a realtime database for when storing user metadata (email, username, etc.)

Sign in should be done by email provider, and the email provider requires adapter to store verification token. The project itself requires users metadata, and tracking current flow of their progress on their project. I'm not sure whether realtime database is the best solution, still researching.

Normal firestore -like database should be fine for this 👍

[ndom91]

We fixed the docs failed deploy, should be good to go now.

It looks good to me, will try to get the teams support to merge this as soon as possible!

[balazsorban44]

Thanks for the PR, and sorry for the delay! I'm thinking renaming to FirestoreAdapter is not a good idea, since the package is still called @next-auth/firebase-adapter. Won't that be confusing? 🤔

Do we see a future with a different Firebase-based adapter? Should we either:

1. release @next-auth/firestore-adapter
2. add this in a submodule @next-auth/firebase-adapter/firestore
3. Let the export name be FirebaseAdapter

Apart from that, I had some code nitpicks, which I'll hold to myself for now, and can do in a follow-up PR, you have done great work here and I don't want to unnecessarily prolong the merge of this. 😅

[chanceaclark]

Thanks for the PR, and sorry for the delay! I'm thinking renaming to FirestoreAdapter is not a good idea, since the package is still called @next-auth/firebase-adapter. Won't that be confusing? 🤔

I do agree with you that it is a little confusing, but I will say it's already confusing as is since this adapter is purely built for Firestore. We've seen the many comments of when Firebase Auth will be added to this adapter and we probably want to make it clear what this adapter actually supports: Firestore.

Do we see a future with a different Firebase-based adapter? Should we either:

1. release @next-auth/firestore-adapter
2. add this in a submodule @next-auth/firebase-adapter/firestore
3. Let the export name be FirebaseAdapter

Unless I'm missing some context y'all might have, the only thing I potentially see is exporting a Firebase Realtime DB adapter. However, I've never worked with it so I don't know if it's even feasible/wanted. In regards to those options:

1. I think that would be a lot of work and it's up to y'all if you want to go down that path of deprecating @next-auth/firebase-adapter – IMO I would leave it as is.
2. Submodules is a fine approach, but you could also just export additional modules along with it if you are worried about namespacing them e.g. import { FirestoreAdapter, RealtimeAdapter } from '@next-auth/firebase-adapter 🤷
3. I assume this is just revert the last commit just leave it as FirebaseAdapter.

My recommendation is the 2nd option I proposed, but at the end of the day it's your call. If you don't want to deal with the renaming quite yet, I'll rip it out, just give me the word. We can continue the discussion in #4592.

Apart from that, I had some code nitpicks, which I'll hold to myself for now, and can do in a follow-up PR, you have done great work here and I don't want to unnecessarily prolong the merge of this. 😅

I appreciate it! I also don't mind tackling them if need be, just let me know.

[cdriesler]

Since we're right at the finish line I want to jump in -

@chanceaclark do you have a sponsorship link somewhere, GitHub or otherwise? I've been eagerly following this PR for a while now. It'll solve a pile of problems for me, and I'd like to buy you a coffee-or-two as thanks for the months of work.

[chanceaclark]

I appreciate the offer @cdriesler! However, I don't have anything setup for sponsorship currently and I'm doing this for the fun of it 😄 Maybe in the future, but for right now, just giving back to the community 🙇‍♂️

[adrianvanlan]

When will this version be available in npm?

[balazsorban44]

Good news, this is now available as @next-auth/firebase-adapter@latest! 🎉 Thanks to everyone who decided to stick around! 😅 👏

Let us know if you have any issues!

[dellwatson]

i just created new project and now have problem with firebaseAdapter:
name: 'GetUserByAccountError . it seems working now without next-auth, i suppose must be related to this?

[DanielBailey-web]

My main blocker on my original PR was to figure out how could we integrate with Firebase Authentication's User management.

Is this part of a new issue?