feat: add @auth/astro framework library #9856

TheOtterlord · 2024-01-30T13:55:02Z

☕️ Reasoning

This PR is the next iteration of #6463

Introduces an Astro framework package. The package exposes an integration, along with helper methods for both server & client uses.

🧢 Checklist

Documentation (Note: The auth-astro.vercel.app autogenerated link doesn't have a deployed site. I'm assuming any deployed example will be hosted by this org)
Tests
Ready to be merged

🎫 Affected issues

📌 Resources

vercel · 2024-01-30T13:55:06Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
auth-docs	❌ Failed (Inspect)			Apr 28, 2024 6:16pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
next-auth-docs	⬜️ Ignored (Inspect)	Visit Preview		Apr 28, 2024 6:16pm

apps/dev/astro/auth.config.ts

packages/frameworks-astro/src/config.ts

…c stuff

balazsorban44

Thanks! Added some comments!

Besides those, have a look at https://github.com/nextauthjs/next-auth/blob/main/packages/utils/scripts/providers.js

Used eg. here:

next-auth/packages/next-auth/package.json

Lines 61 to 65 in f33a0ac

    
           "build": "pnpm clean && pnpm providers && tsc", 
        
           "clean": "rm -rf *.js *.d.ts* lib providers", 
        
           "dev": "pnpm providers && tsc -w", 
        
           "test": "vitest -c ../utils/vitest.config.ts", 
        
           "providers": "node ../utils/scripts/providers"

This way, users can import providers from @auth/astro/providers/* instead of having to install @auth/core!

Further, for other integrations support automatic environment variable inference by using the setEnvDefaults method like so

next-auth/packages/frameworks-express/src/index.ts

Line 160 in f33a0ac

setEnvDefaults(process.env, config)

there is also createActionURL, a method from core that helps you create the url for the Request of Auth in a much less hacky way!

And lastly, the default basePath value is expected to be /auth, not /api/auth. (NextAuth.js is the only exception, since historically that was the default basePath there and we did not want to make this a breaking change in v5)

Could you incorporate these changes, and then make sure that the dev app and example app is also correctly updated? 🙏 Thanks!

packages/frameworks-astro/module.d.ts

packages/frameworks-astro/package.json

balazsorban44 · 2024-01-31T00:49:09Z

packages/frameworks-astro/package.json

+    ".": "./src/index.ts",
+    "./config": "./src/config.ts",
+    "./client": "./src/client.ts",
+    "./server": "./src/server.ts",
+    "./middleware": "./middleware.ts"


Suggested change

".": "./src/index.ts",

"./config": "./src/config.ts",

"./client": "./src/client.ts",

"./server": "./src/server.ts",

"./middleware": "./middleware.ts"

".": {

"types": "./index.d.ts",

"import": "./index.js"

},

"./config": {

"types": "./config.d.ts",

"import": "./config.js"

},

"./client": {

"types": "./client.d.ts",

"import": "./client.js"

},

"./server": {

"types": "./server.d.ts",

"import": "./server.js"

},

"./middleware": {

"types": "./middleware.d.ts",

"import": "./middleware.js"

},

"./adapters": {

"types": "./adapters.d.ts"

},

"./providers/*": {

"types": "./providers/*.d.ts",

"import": "./providers/*.js"

}

The Astro package doesn't require bundling, as all Astro projects (regardless of config) support TypeScript files. Is there still a reason to specify both types and import if they both lead to the same file?

packages/frameworks-astro/package.json

packages/frameworks-astro/tsconfig.json

packages/frameworks-astro/src/server.ts

Co-authored-by: Balázs Orbán <info@balazsorban.com>

…nto auth-astro

…, clean up file structure

NuroDev · 2024-03-10T10:03:51Z

Is there any further things blocking this from getting merged? I'd love to start using it

ndom91 · 2024-03-11T16:21:18Z

There seem to be some merge conflicts. Otherwise it should be close. Needs another last going over, testing, etc.

TheOtterlord · 2024-03-12T18:59:17Z

@ndom91 happy to resolve the conflict, seems to just be the pnpm-lock, so I'll try to do this tonight. Also, I have some notes from the last review in Discord that might be relevant when going over for another round of reviewing.

I also know there's been work on the framework guidelines? I've not been able to keep up as much as I wanted, so let me know if I'm missing anything important from those!

ndom91 · 2024-03-13T21:04:12Z

@ndom91 happy to resolve the conflict, seems to just be the pnpm-lock, so I'll try to do this tonight. Also, I have some notes from the last review in Discord that might be relevant when going over for another round of reviewing.

I also know there's been work on the framework guidelines? I've not been able to keep up as much as I wanted, so let me know if I'm missing anything important from those!

Awesome, thanks! Yeah no I don't think there were any changes there. There's just this creating a framework pkg guidelines 👍

vercel · 2024-03-13T21:51:38Z

@TheOtterlord is attempting to deploy a commit to the authjs Team on Vercel.

A member of the Team first needs to authorize it.

…-astro

ndom91 · 2024-04-26T16:54:40Z

Hey looking over this and adding some minor things here and there, hope thats okay with you! We shipped a whole new docs site recently, so I reverted your docs/* changes and will add them back to the new docs as soon as I can merge the latest main changes back into your branch. Having trouble with this pnpm-lokc.yaml merge conflict still

Also, I'm curious about the build process for the main @auth/astro package. There doesn't seem to be any. We can't just ship typescript to the client, right.

Also it'd be great to have some tests in here 🙏

ndom91 · 2024-04-26T17:08:22Z

Okay so I added a build step, it creates all .js and .d.ts type files into dist/*, including copies of all providers after copying them into here first.

Also I updated the export map and files array to correctly publish the right files.

Finally, I also removed the api/[...auth].ts file you had that looked like the next-auth dynamic route handler as well. This was mistakenly kept in the framework-astro/ directory, right? Instead of one of the development / example apps? It didn't seem like it belonged here at all, but I'm not 100% sure.

Anyway, going forward, there's a few things that immediately jumepd out at me.

We still have the pnpm-lock.yaml merge conflict. It's got ~350 conflicts, so doing it manually in the GitHub web editor seems undoable 😅 If you have a quick way to take care of that, that'd be amazing. Once that's fixed and the updates from main are merged back in, I'll put all the relevant new docs stuff back 👍
There's still 1 typescript issue when building. In the src/index.ts:162 the virtualConfigModule method has some error. I didn't look into it too deeply, but it'd be great if you cuold if you have time!
Also like I mentioned previously, some tests here would be amazing

Thanks!

TheOtterlord · 2024-04-26T19:12:42Z

I didn't add a build step as any Astro project supports TypeScript files out-the-box. I'll leave it as-is unless you'd like to revert it (there's no issue with having a build step, it's just not required).

No, [...auth].ts is actually injected by the Astro integration 😅
It adds the necessary routes without a user needing to create what is essentially a file with 2 lines of code. This behaviour can be disabled for more advanced uses, but it's handled by default when you install the integration, simplifying the setup process. It also doesn't matter if this ends up as ts/js. I'll add this back in to fix it.

Yep, I'll fix the lockfile 👍
Looks like it's just warning that Vite is out of date (and therefore possibly the type). I've updated locally and it looks fine.
Tests sound like a good idea. I won't add those immediately, but I'll try my best to look at how you structure tests this weekend.

Let me know if I can clarify anything, or if you have any questions!

TheOtterlord · 2024-04-26T19:47:45Z

@ndom91 Fixed the lockfile, typescript error, and restored the api route. I've yet to look at tests but this should unblock you on docs.

ndom91 · 2024-04-28T16:18:42Z

Looks like we've got a pnpm-lock.yaml merge conflict again 😂

After you fix it, if you could pull in the updates from main to get all the new docs stuff, I can go from there

TheOtterlord · 2024-04-28T18:15:52Z

Fixed and up-to-date!

Apexal · 2024-05-20T23:57:04Z

Any movement on this? Happy to assist in any way as I'm using https://github.com/nowaythatworked/auth-astro

Implement new version of @auth/astro

d559a15

TheOtterlord requested review from ThangHuuVu, ndom91 and balazsorban44 as code owners January 30, 2024 13:55

github-actions bot added frameworks examples labels Jan 30, 2024

TheOtterlord mentioned this pull request Jan 30, 2024

feat: add @auth/astro framework library with example & docs #6463

Closed

3 tasks

vercel bot deployed to Preview – auth-docs January 30, 2024 14:00 View deployment

Add missed additions

1da57c0

vercel bot deployed to Preview – auth-docs January 30, 2024 14:21 View deployment

NuroDev reviewed Jan 30, 2024

View reviewed changes

apps/dev/astro/auth.config.ts Outdated Show resolved Hide resolved

packages/frameworks-astro/src/config.ts Outdated Show resolved Hide resolved

Reimplement auth config with overrides, clean up types, fix other mis…

d57bf7b

…c stuff

vercel bot deployed to Preview – auth-docs January 30, 2024 23:23 View deployment

balazsorban44 requested changes Jan 31, 2024

View reviewed changes

Update packages/frameworks-astro/package.json

2ba14c9

Co-authored-by: Balázs Orbán <info@balazsorban.com>

vercel bot deployed to Preview – auth-docs January 31, 2024 11:35 View deployment

TheOtterlord and others added 3 commits January 31, 2024 11:47

Update packages/frameworks-astro/src/server.ts

d957b9b

Co-authored-by: Balázs Orbán <info@balazsorban.com>

Update types

ba3fd40

Merge branch 'auth-astro' of https://github.com/TheOtterlord/authjs i…

653ea4f

…nto auth-astro

vercel bot deployed to Preview – auth-docs January 31, 2024 11:49 View deployment

Change baseURL to /auth, add framework redirect, add providers script…

b74d6a8

…, clean up file structure

vercel bot had a problem deploying to Preview – auth-docs January 31, 2024 13:09 Failure

Docs changes

bc0019d

vercel bot had a problem deploying to Preview – auth-docs March 13, 2024 21:52 Failure

ndom91 added 2 commits April 26, 2024 17:46

Merge branch 'auth-astro' of github.com:TheOtterlord/authjs into auth…

80be2b5

…-astro

chore: more root package.json cleanup

7698eb3

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 15:50 Failure

chore: update root pnpm-lock.yaml

8c84008

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 15:52 Failure

chore: add README.md

a0ec246

ndom91 added 2 commits April 26, 2024 18:59

fix: rm misplaced api/[...auth] file in frameworks-astro dir

de08620

fix: add build step and cleanup package.json

afe69a5

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 17:05 Failure

Update Vite & restore injected route

ba8aa3f

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 19:20 Failure

TheOtterlord added 2 commits April 26, 2024 20:22

Delete lockfile

0beb5ca

Update lockfile

53af586

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 19:25 Failure

TheOtterlord added 2 commits April 26, 2024 20:37

Actually fix lockfile & merge upstream/main into auth-astro

2dfbbad

Undelete vscode file

47bd52d

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 19:42 Failure

Fix linting

64fa5fd

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 19:45 Failure

Fix errors caused by linting

64ad2c6

vercel bot had a problem deploying to Preview – auth-docs April 26, 2024 20:12 Failure

Merge from upstream/main

953650b

vercel bot had a problem deploying to Preview – auth-docs April 28, 2024 18:16 Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add @auth/astro framework library #9856

feat: add @auth/astro framework library #9856

TheOtterlord commented Jan 30, 2024 •

edited

vercel bot commented Jan 30, 2024 •

edited

balazsorban44 left a comment

balazsorban44 Jan 31, 2024

TheOtterlord Jan 31, 2024

NuroDev commented Mar 10, 2024

ndom91 commented Mar 11, 2024

TheOtterlord commented Mar 12, 2024

ndom91 commented Mar 13, 2024

vercel bot commented Mar 13, 2024

ndom91 commented Apr 26, 2024

ndom91 commented Apr 26, 2024 •

edited

TheOtterlord commented Apr 26, 2024

TheOtterlord commented Apr 26, 2024

ndom91 commented Apr 28, 2024

TheOtterlord commented Apr 28, 2024

Apexal commented May 20, 2024

	"build": "pnpm clean && pnpm providers && tsc",
	"clean": "rm -rf .js .d.ts* lib providers",
	"dev": "pnpm providers && tsc -w",
	"test": "vitest -c ../utils/vitest.config.ts",
	"providers": "node ../utils/scripts/providers"

-    ".": "./src/index.ts",
-    "./config": "./src/config.ts",
-    "./client": "./src/client.ts",
-    "./server": "./src/server.ts",
-    "./middleware": "./middleware.ts"
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./config": {
+      "types": "./config.d.ts",
+      "import": "./config.js"
+    },
+    "./client": {
+      "types": "./client.d.ts",
+      "import": "./client.js"
+    },
+    "./server": {
+      "types": "./server.d.ts",
+      "import": "./server.js"
+    },
+    "./middleware": {
+      "types": "./middleware.d.ts",
+      "import": "./middleware.js"
+    },
+    "./adapters": {
+        "types": "./adapters.d.ts"
+      },
+    "./providers/*": {
+      "types": "./providers/*.d.ts",
+      "import": "./providers/*.js"
+    }

feat: add @auth/astro framework library #9856

Are you sure you want to change the base?

feat: add @auth/astro framework library #9856

Conversation

TheOtterlord commented Jan 30, 2024 • edited

☕️ Reasoning

🧢 Checklist

🎫 Affected issues

📌 Resources

vercel bot commented Jan 30, 2024 • edited

balazsorban44 left a comment

Choose a reason for hiding this comment

balazsorban44 Jan 31, 2024

Choose a reason for hiding this comment

TheOtterlord Jan 31, 2024

Choose a reason for hiding this comment

NuroDev commented Mar 10, 2024

ndom91 commented Mar 11, 2024

TheOtterlord commented Mar 12, 2024

ndom91 commented Mar 13, 2024

vercel bot commented Mar 13, 2024

ndom91 commented Apr 26, 2024

ndom91 commented Apr 26, 2024 • edited

TheOtterlord commented Apr 26, 2024

TheOtterlord commented Apr 26, 2024

ndom91 commented Apr 28, 2024

TheOtterlord commented Apr 28, 2024

Apexal commented May 20, 2024

TheOtterlord commented Jan 30, 2024 •

edited

vercel bot commented Jan 30, 2024 •

edited

ndom91 commented Apr 26, 2024 •

edited