[SDK-3557] Refactor session lifecycle

[adamjmcgrath]

• All new/changed/fixed functionality is covered by tests (or N/A)
• I have added documentation for all new/changed functionality (or N/A)

📋 Changes

Changed the cookie writing behaviour from lazy (at the end of the request) to eager (when it's first accessed and the session is rolling and every-time it's updated).

This has enabled us to:

• remove on-headers dependency (which doesn't play well with Next.js server and doesn't work at all with Next.js middleware)
• remove wrappers (getServerSideProps wrapper and removed the need for an API route wrapper)
• removed the magic about implicit session updates by adding an explicit updateUser method
• allowed users to prevent the cookie from being written on every request when the session is absolute (not rolling) - which can be an issue for specific implementations and platforms

At a cost of potentially higher overhead when updating the session multiple times in the request, because multiple calls to updateUser will cause multiple cookie serialisation (encryption) attempts (but multiple reads will stay the same).

In order to do this we've needed to:

• Make a stateful Cookie class to manage/aggregate writes to the set-cookie header
• Add an updateUser method
• Update the session cache to eagerly write to the cookie, rather than use on-headers

📎 References

see #668 #425 #616 #524

🎯 Testing

https://github.com/auth0/nextjs-auth0/blob/54cd48f1e1cb78eb37b700f39f4da826a5683c1a/tests/session/update-user.test.ts

[vercel]

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

1 Ignored Deployment

Name	Status	Preview	Updated
nextjs-auth0	⬜️ Ignored (Inspect)		Aug 24, 2022 at 3:59PM (UTC)

[Widcket]

Shouldn't this be removed?

[adamjmcgrath]

I'm still using it in some test fixtures, so I moved it to devDependencies

[Widcket]

Looks good! Nice solution. Just left a question regarding the on-headers dependency, which –according to the PR description– was removed, yet is still in the package.json.