Example Email Provider sendVerificationRequest code only works for nodemailer's SMTP transport

nextauthjs / next-auth

Authentication for the Web.

ISC License

24.78k stars 3.49k forks source link

Provider type

Environment

System: OS: macOS 14.1.2 CPU: (10) arm64 Apple M1 Pro Memory: 110.58 MB / 16.00 GB Shell: 5.9 - /bin/zsh Binaries: Node: 21.2.0 - ~/.nvm/versions/node/v21.2.0/bin/node Yarn: 1.22.19 - /opt/homebrew/bin/yarn npm: 10.2.3 - ~/.nvm/versions/node/v21.2.0/bin/npm pnpm: 8.10.5 - ~/.nvm/versions/node/v21.2.0/bin/pnpm Browsers: Brave Browser: 109.1.47.186 Chrome: 120.0.6099.109 Safari: 17.1.2 npmPackages: @auth/core: ^0.18.5 => 0.18.5 @auth/supabase-adapter: ^0.1.12 => 0.1.12 @auth/sveltekit: ^0.3.16 => 0.3.16

Reproduction URL

requires mailgun api key

Describe the issue

The following code (https://github.com/nextauthjs/next-auth/blob/5254ff78f2002c0eacf13389c26baac47a2b5326/packages/core/src/providers/email.ts#L382)

      const result = await transport.sendMail({ ... })
      const failed = result.rejected.concat(result.pending).filter(Boolean)

only works with the SMTP Nodemailer Transport, because it depends on the rejected and pending attributes of the result object – these are only provided by the smtp-connection class in nodemailer. Unfortunately, nodemailer's types are under-specified, so this is an easy oversight to make. (ref: https://github.com/search?q=repo%3Anodemailer%2Fnodemailer+rejected&type=code). Unfortunately, for those of us not using the SMTP transport (I'm using Mailgun), it's a very difficult issue to track down. The error message is only:

const failed = result.rejected.concat(result.pending).filter(Boolean);
TypeError: Cannot read properties of undefined (reading 'concat') at Object.sendVerificationRequest

A fix would be to modify the default / example code to check for the presence of a messageId attribute (which all transports must implement) instead of rejected and pending, or at the very least adding a test for the rejected and pending attributes before accessing them (and ideally adding a comment indicating that the result is specific to the SMTP transport).

How to reproduce

Use the Email provider default delivery code with any transport other than the default nodemailer SMTP transport.

Expected behavior

The application should not crash. Verification that the email sent (let alone was delivered) is very limited at this stage in the code, so it's probably unreasonable (and unnecessary) to expect a robust error condition handler.

We could not detect a valid reproduction link. Make sure to follow the bug report template carefully.

Why was this issue closed?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. We need a link to a public GitHub repository. Example: (NextAuth.js example repository).

The bug template that you filled out has a section called "Reproduction URL", which is where you should provide the link to the reproduction.

If you did not provide a link or the link you provided is not valid, we will close the issue.
If you provide a link to a private repository, we will close the issue.
If you provide a link to a repository but not in the correct section, we will close the issue.

What should I do?

Depending on the reason the issue was closed, you can do the following:

If you did not provide a link, please open a new issue with a link to a reproduction.
If you provided a link to a private repository, please open a new issue with a link to a public repository.
If you provided a link to a repository but not in the correct section, please open a new issue with a link to a reproduction in the correct section.

In general, assume that we should not go through a lengthy onboarding process at your company code only to be able to verify an issue.

My repository is private and cannot make it public

In most cases, a private repo will not be a sufficient minimal reproduction, as this codebase might contain a lot of unrelated parts that would make our investigation take longer. Please do not make it public. Instead, create a new repository using the templates above, adding the relevant code to reproduce the issue. Common things to look out for:

Remove any code that is not related to the issue. (pages, API Routes, components, etc.)
Remove any dependencies that are not related to the issue.
Remove any third-party service that would require us to sign up for an account to reproduce the issue.
Remove any environment variables that are not related to the issue.
Remove private packages that we do not have access to.
If the issue is not related to a monorepo specifically, try to reproduce the issue without a complex monorepo setup

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps by opening a new issue.

I think my reproduction is good enough, why aren't you looking into it quickly?

We look into every issue and monitor open issues for new comments.

However, sometimes we might miss a few due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it.

nextauthjs / next-auth