-
-
Notifications
You must be signed in to change notification settings - Fork 12
feat(server): migrate hono adapter #341
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import type { ClientContract } from '@zenstackhq/orm'; | ||
| import type { SchemaDef } from '@zenstackhq/orm/schema'; | ||
| import type { Context, MiddlewareHandler } from 'hono'; | ||
| import { routePath } from 'hono/route'; | ||
| import type { ContentfulStatusCode } from 'hono/utils/http-status'; | ||
| import { logInternalError, type CommonAdapterOptions } from '../common'; | ||
|
|
||
| /** | ||
| * Options for initializing a Hono middleware. | ||
| */ | ||
| export interface HonoOptions<Schema extends SchemaDef> extends CommonAdapterOptions<Schema> { | ||
| /** | ||
| * Callback method for getting a ZenStackClient instance for the given request. | ||
| */ | ||
| getClient: (ctx: Context) => Promise<ClientContract<Schema>> | ClientContract<Schema>; | ||
| } | ||
|
|
||
| export function createHonoHandler<Schema extends SchemaDef>(options: HonoOptions<Schema>): MiddlewareHandler { | ||
| return async (ctx) => { | ||
| const client = await options.getClient(ctx); | ||
| if (!client) { | ||
| return ctx.json({ message: 'unable to get ZenStackClient from request context' }, 500); | ||
| } | ||
|
|
||
| const url = new URL(ctx.req.url); | ||
| const query = Object.fromEntries(url.searchParams); | ||
|
|
||
| const path = ctx.req.path.substring(routePath(ctx).length - 1); | ||
| if (!path) { | ||
| return ctx.json({ message: 'missing path parameter' }, 400); | ||
| } | ||
|
|
||
| let requestBody: unknown; | ||
| if (ctx.req.raw.body) { | ||
| try { | ||
| requestBody = await ctx.req.json(); | ||
| } catch { | ||
| // noop | ||
| } | ||
| } | ||
|
|
||
| try { | ||
| const r = await options.apiHandler.handleRequest({ | ||
| method: ctx.req.method, | ||
| path, | ||
| query, | ||
| requestBody, | ||
| client, | ||
| }); | ||
| return ctx.json(r.body as object, r.status as ContentfulStatusCode); | ||
| } catch (err) { | ||
| logInternalError(options.apiHandler.log, err); | ||
| return ctx.json({ message: `An internal server error occurred` }, 500); | ||
| } | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './handler'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| import { createTestClient } from '@zenstackhq/testtools'; | ||
| import { Hono, MiddlewareHandler } from 'hono'; | ||
| import superjson from 'superjson'; | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { createHonoHandler } from '../../src/adapter/hono'; | ||
| import { RestApiHandler, RPCApiHandler } from '../../src/api'; | ||
| import { makeUrl, schema } from '../utils'; | ||
|
|
||
| describe('Hono adapter tests - rpc handler', () => { | ||
| it('properly handles requests', async () => { | ||
| const client = await createTestClient(schema); | ||
|
|
||
| const handler = await createHonoApp(createHonoHandler({ getClient: () => client, apiHandler: new RPCApiHandler({schema: client.$schema}) })); | ||
|
|
||
| let r = await handler(makeRequest('GET', makeUrl('/api/post/findMany', { where: { id: { equals: '1' } } }))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toHaveLength(0); | ||
|
|
||
| r = await handler( | ||
| makeRequest('POST', '/api/user/create', { | ||
| include: { posts: true }, | ||
| data: { | ||
| id: 'user1', | ||
| email: '[email protected]', | ||
| posts: { | ||
| create: [ | ||
| { title: 'post1', published: true, viewCount: 1 }, | ||
| { title: 'post2', published: false, viewCount: 2 }, | ||
| ], | ||
| }, | ||
| }, | ||
| }) | ||
| ); | ||
| expect(r.status).toBe(201); | ||
| expect((await unmarshal(r)).data).toMatchObject({ | ||
| email: '[email protected]', | ||
| posts: expect.arrayContaining([ | ||
| expect.objectContaining({ title: 'post1' }), | ||
| expect.objectContaining({ title: 'post2' }), | ||
| ]), | ||
| }); | ||
|
|
||
| r = await handler(makeRequest('GET', makeUrl('/api/post/findMany'))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toHaveLength(2); | ||
|
|
||
| r = await handler(makeRequest('GET', makeUrl('/api/post/findMany', { where: { viewCount: { gt: 1 } } }))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toHaveLength(1); | ||
|
|
||
| r = await handler( | ||
| makeRequest('PUT', '/api/user/update', { where: { id: 'user1' }, data: { email: '[email protected]' } }) | ||
| ); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data.email).toBe('[email protected]'); | ||
|
|
||
| r = await handler(makeRequest('GET', makeUrl('/api/post/count', { where: { viewCount: { gt: 1 } } }))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toBe(1); | ||
|
|
||
| r = await handler(makeRequest('GET', makeUrl('/api/post/aggregate', { _sum: { viewCount: true } }))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data._sum.viewCount).toBe(3); | ||
|
|
||
| r = await handler( | ||
| makeRequest('GET', makeUrl('/api/post/groupBy', { by: ['published'], _sum: { viewCount: true } })) | ||
| ); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toEqual( | ||
| expect.arrayContaining([ | ||
| expect.objectContaining({ published: true, _sum: { viewCount: 1 } }), | ||
| expect.objectContaining({ published: false, _sum: { viewCount: 2 } }), | ||
| ]) | ||
| ); | ||
|
|
||
| r = await handler(makeRequest('DELETE', makeUrl('/api/user/deleteMany', { where: { id: 'user1' } }))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data.count).toBe(1); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Hono adapter tests - rest handler', () => { | ||
| it('properly handles requests', async () => { | ||
| const client = await createTestClient(schema); | ||
|
|
||
| const handler = await createHonoApp( | ||
| createHonoHandler({ | ||
| getClient: () => client, | ||
| apiHandler: new RestApiHandler({ endpoint: 'http://localhost/api', schema: client.$schema }), | ||
| }) | ||
| ); | ||
|
|
||
| let r = await handler(makeRequest('GET', makeUrl('/api/post/1'))); | ||
| expect(r.status).toBe(404); | ||
|
|
||
| r = await handler( | ||
| makeRequest('POST', '/api/user', { | ||
| data: { | ||
| type: 'user', | ||
| attributes: { id: 'user1', email: '[email protected]' }, | ||
| }, | ||
| }) | ||
| ); | ||
| expect(r.status).toBe(201); | ||
| expect(await unmarshal(r)).toMatchObject({ | ||
| data: { | ||
| id: 'user1', | ||
| attributes: { | ||
| email: '[email protected]', | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| r = await handler(makeRequest('GET', makeUrl('/api/user?filter[id]=user1'))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toHaveLength(1); | ||
|
|
||
| r = await handler(makeRequest('GET', makeUrl('/api/user?filter[id]=user2'))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toHaveLength(0); | ||
|
|
||
| r = await handler(makeRequest('GET', makeUrl('/api/user?filter[id]=user1&filter[email]=xyz'))); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data).toHaveLength(0); | ||
|
|
||
| r = await handler( | ||
| makeRequest('PUT', makeUrl('/api/user/user1'), { | ||
| data: { type: 'user', attributes: { email: '[email protected]' } }, | ||
| }) | ||
| ); | ||
| expect(r.status).toBe(200); | ||
| expect((await unmarshal(r)).data.attributes.email).toBe('[email protected]'); | ||
|
|
||
| r = await handler(makeRequest('DELETE', makeUrl('/api/user/user1'))); | ||
| expect(r.status).toBe(200); | ||
| expect(await client.user.findMany()).toHaveLength(0); | ||
| }); | ||
| }); | ||
|
|
||
| function makeRequest(method: string, path: string, body?: any) { | ||
| const payload = body ? JSON.stringify(body) : undefined; | ||
| return new Request(`http://localhost${path}`, { method, body: payload }); | ||
| } | ||
|
|
||
| async function unmarshal(r: Response, useSuperJson = false) { | ||
| const text = await r.text(); | ||
| return (useSuperJson ? superjson.parse(text) : JSON.parse(text)) as any; | ||
| } | ||
|
|
||
| async function createHonoApp(middleware: MiddlewareHandler) { | ||
| const app = new Hono(); | ||
|
|
||
| app.use('/api/*', middleware); | ||
|
|
||
| return app.fetch; | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.