Provide request context to custom Adapter

[yanickrochon]

Description 📓

While implementing a custom adapter, I can't find any way to obtain the request context in order to save device information when performing requests. We use this data in order to debug when clients have issues, so we can track what devices they use to connect, etc. I am aware that I could go around this by using other methods during the authentication pipeline, but it seems redundant to make two requests instead of one.

As far as I can see, all methods from the Adapter interface have a single parameter, adding the request as the second argument would provide that functionality.

Ex:

class CustomAdapter extends Adapter {
  useVerificationToken({ identifier, token }, req) {
    // req.clientAddress
  }
}

How to reproduce ☕️

Nothing to reproduce

Contributing 🙌🏽

Yes, I am willing to help implement this feature in a PR

[balazsorban44]

If you mean the incoming NextApiRequest you can already access it through https://next-auth.js.org/configuration/initialization#advanced-initialization

I don't see this as a general enough use case to pass it to all adapter methods.

[yanickrochon]

So, instead of

class CustomAdapter extends Adapter {
  useVerificationToken({ identifier, token }, req) {
    // req.clientAddress
  }
}

export default NextAuth({
  ...
  adapter: new CustomAdapter(),
  ....
});

which initializes everything once during the application's lifetime, you are suggesting this

class CustomAdapter extends Adapter {
  constructor({ req }) {
    this.req = req;
  }
  useVerificationToken({ identifier, token }) {
    // this.req.clientAddress
  }
}

export default async function auth(req, res) {
  return await NextAuth(req, res, {
    ...
    adapter: new CustomAdapter({ req }),
    ....
  });
}

which will get executed at every single requests?

[yanickrochon]

The CredentialProvider does pass the request context to it's authorize callback :

CredentialsProvider({
  name: "Credentials",
  async authorize(credentials, req) {
    const context = getContext(req);

    // ... validate credentials with the given request context
  }
})

So why doesn't the EmailProvider also pass the request context to it's methods? Why does it require a different method to access that object?

Seriously, it's a dumb fix! Just add the params to the adapter methods!

next-auth/packages/next-auth/src/core/routes/callback.ts

Lines 208 to 211 in 2469e44

	const invite = await useVerificationToken?.({
	identifier,
	token: hashToken(token, options),
	})

Would become

    const invite = await useVerificationToken?.({
      identifier,
      token: hashToken(token, options),
    }, params)

etc.

[yanickrochon]

I think this discussion has become stale in favor if this one : #4865