-
-
Notifications
You must be signed in to change notification settings - Fork 12
feat(server): migrate elysia adapter #340
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import type { ClientContract } from '@zenstackhq/orm'; | ||
| import type { SchemaDef } from '@zenstackhq/orm/schema'; | ||
| import { Elysia, type Context as ElysiaContext } from 'elysia'; | ||
| import { log } from '../../api/utils'; | ||
| import type { CommonAdapterOptions } from '../common'; | ||
|
|
||
| /** | ||
| * Options for initializing an Elysia middleware. | ||
| */ | ||
| export interface ElysiaOptions<Schema extends SchemaDef> extends CommonAdapterOptions<Schema> { | ||
| /** | ||
| * Callback method for getting a ZenStackClient instance for the given request context. | ||
| */ | ||
| getClient: (context: ElysiaContext) => Promise<ClientContract<Schema>> | ClientContract<Schema>; | ||
|
|
||
| /** | ||
| * Optional base path to strip from the request path before passing to the API handler. | ||
| */ | ||
| basePath?: string; | ||
| } | ||
|
|
||
| /** | ||
| * Creates an Elysia middleware handler for ZenStack. | ||
| * This handler provides automatic CRUD APIs through Elysia's routing system. | ||
| */ | ||
| export function createElysiaHandler<Schema extends SchemaDef>(options: ElysiaOptions<Schema>) { | ||
| return async (app: Elysia) => { | ||
| app.all('/*', async (ctx: ElysiaContext) => { | ||
| const { request, body, set } = ctx; | ||
| const client = await options.getClient(ctx); | ||
| if (!client) { | ||
| set.status = 500; | ||
| return { | ||
| message: 'unable to get ZenStackClient from request context', | ||
| }; | ||
| } | ||
|
|
||
| const url = new URL(request.url); | ||
| const query = Object.fromEntries(url.searchParams); | ||
| let path = url.pathname; | ||
|
|
||
| if (options.basePath && path.startsWith(options.basePath)) { | ||
| path = path.slice(options.basePath.length); | ||
| if (!path.startsWith('/')) { | ||
| path = '/' + path; | ||
| } | ||
| } | ||
|
|
||
| if (!path || path === '/') { | ||
| set.status = 400; | ||
| return { | ||
| message: 'missing path parameter', | ||
| }; | ||
| } | ||
|
|
||
| try { | ||
| const r = await options.apiHandler.handleRequest({ | ||
| method: request.method, | ||
| path, | ||
| query, | ||
| requestBody: body, | ||
| client, | ||
| }); | ||
|
|
||
| set.status = r.status; | ||
| return r.body; | ||
| } catch (err) { | ||
| set.status = 500; | ||
| log(options.apiHandler.log, 'error', `An unhandled error occurred while processing the request: ${err}${err instanceof Error ? '\n' + err.stack : ''}`); | ||
| return { | ||
| message: 'An internal server error occurred', | ||
| }; | ||
| } | ||
| }); | ||
|
|
||
| return app; | ||
| }; | ||
| } | ||
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
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,164 @@ | ||
| import { createTestClient } from '@zenstackhq/testtools'; | ||
| import { Elysia } from 'elysia'; | ||
| import superjson from 'superjson'; | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { createElysiaHandler } from '../../src/adapter/elysia'; | ||
| import { RestApiHandler, RPCApiHandler } from '../../src/api'; | ||
| import { makeUrl, schema } from '../utils'; | ||
|
|
||
| describe('Elysia adapter tests - rpc handler', () => { | ||
| it('properly handles requests', async () => { | ||
| const client = await createTestClient(schema); | ||
|
|
||
| const handler = await createElysiaApp( | ||
| createElysiaHandler({ getClient: () => client, basePath: '/api', 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('Elysia adapter tests - rest handler', () => { | ||
| it('properly handles requests', async () => { | ||
| const client = await createTestClient(schema); | ||
|
|
||
| const handler = await createElysiaApp( | ||
| createElysiaHandler({ | ||
| getClient: () => client, | ||
| basePath: '/api', | ||
| apiHandler: new RestApiHandler({schema: client.$schema, endpoint: 'http://localhost/api' }), | ||
| }) | ||
| ); | ||
|
|
||
| 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) { | ||
| if (body) { | ||
| return new Request(`http://localhost${path}`, { | ||
| method, | ||
| body: JSON.stringify(body), | ||
| headers: { 'Content-Type': 'application/json' }, | ||
| }); | ||
| } else { | ||
| return new Request(`http://localhost${path}`, { method }); | ||
| } | ||
| } | ||
|
|
||
| async function unmarshal(r: Response, useSuperJson = false) { | ||
| const text = await r.text(); | ||
| return (useSuperJson ? superjson.parse(text) : JSON.parse(text)) as any; | ||
| } | ||
|
|
||
| async function createElysiaApp(middleware: (app: Elysia) => Promise<Elysia>) { | ||
| const app = new Elysia(); | ||
| await middleware(app); | ||
| return app.handle; | ||
| } |
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.