Add h3 framework #477
Add h3 framework #477
Conversation
| const request = new H3Request(event); | ||
| const response = new H3Response(event); | ||
| try { | ||
| await supertokens.middleware(request, response); |
There was a problem hiding this comment.
h3 middlewares seem to be compatible with express' middleware. Therefore, I think you can just copy over the logic from the express framework (but of course, use the H3Request and H3Response wrapper instead of ExpressRequest and ExpressResponse.
The key point here is that await supertokens.middleware(request, response) returns a boolean. If it's false, it means that supertokens didn't handle the request and you need to call the next function.
| const error = createError({}); | ||
| sendError(event, error); |
There was a problem hiding this comment.
I think you can copy over the code from the express errorHandler cause the errorHandler too is a middleware that needs to be added to your h3 app after all your routes.
| import type { SessionEvent } from "../../../framework/h3/framework"; | ||
| import { H3Request, H3Response } from "../../../framework/h3/framework"; | ||
| import SuperTokens from "../../../supertokens"; | ||
| import { eventHandler } from "h3"; |
There was a problem hiding this comment.
| import { eventHandler } from "h3"; | |
| import type { eventHandler } from "h3"; |
There was a problem hiding this comment.
We are only allowed to import types from frameworks cause our package.json has h3 only in dev dependencies.
| import { | ||
| eventHandler, | ||
| send, | ||
| setCookie, | ||
| createError, | ||
| EventHandler, | ||
| H3Event, | ||
| sendError, | ||
| readBody, | ||
| getQuery, | ||
| getCookie, | ||
| getHeader, | ||
| getMethod, | ||
| } from "h3"; |
There was a problem hiding this comment.
Our SDK cannot depend on these functions cause we can't add dependency on h3 in our package.json (but we can in dev dependencies - which you already have). Is there a way in which these functions can be called directly on the H3Event object? For example event.readBody()
| try { | ||
| await supertokens.middleware(request, response); | ||
| } catch (err) { | ||
| await supertokens.errorHandler(err, request, response); |
There was a problem hiding this comment.
In the discord logs you had sent earlier, it seemed that the code execution came in the error handler (which is expected), and that this function wrote status code 401 to the response object, but you still got back a 404. This could possibly be because:
- Setting the status code on the
responseobject and sending a reply doesn't actually send it to the client (maybe a bug in theH3Responseimplementation above) - h3 routing may require you to define paths for all routes that can be called from the frontend, else it returns a
404. This behaviour is similar to other frameworks like Hapi in which we push all the routes dynamically as seen here.
Summary of change
This PR aims to add compatibility to h3 (and by extension Nitro) to Supertokens back-end.
Test Plan
So for now I am trying to get it to work with a simple nitro server with an empty "/" route by creating a plugin to init supertokens and adding the required middlewares to h3. This is still WIP and creating a real testing suite like it is done for other frameworks should be the way to go.
Documentation changes
Will probably need a new tab on backend frameworks examples.
Checklist for important updates
coreDriverInterfaceSupported.jsonfile has been updated (if needed)lib/ts/version.tsfrontendDriverInterfaceSupported.jsonfile has been updated (if needed)package.jsonpackage-lock.jsonlib/ts/version.tsnpm run build-prettygit tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.add-ts-no-check.jsfile to include thatsomeFunc: function () {..}).