Scaffold new v1 api with incremental approach #259

openint-bot · 2025-02-13T04:06:10Z

Having problems with deploy. But if you run it locally then visit http://localhost:4000/api/v1 you'l be able to see the new api spec explorer.

Important

Scaffold new v1 API with OpenAPI and tRPC integration, including routes, handlers, tests, and client setup.

API Scaffold:
- Introduces new v1 API scaffold in packages-v1/api-v1.
- Defines routes for /connection, /connector-config, and /health in app.ts.
- Uses Elysia framework with OpenAPI and tRPC integration.
OpenAPI and tRPC:
- Generates OpenAPI spec in scripts/gen-oas.ts and trpc/openapi.ts.
- Defines Zod schemas in models.ts for plaid and greenhouse connectors.
- Creates handlers in trpc/handlers.ts for OpenAPI and tRPC requests.
Testing:
- Adds tests in app.spec.ts for route verification and client interactions.
Clients:
- Sets up tRPC and OpenAPI clients in sdk-v1/index.ts.
Dependencies:
- Updates package.json in api-v1 and sdk-v1 with necessary dependencies.

^{This description was created by}^{for c115f75. It will automatically update as commits are pushed.}

vercel · 2025-02-13T04:06:14Z

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

Name	Status	Preview	Comments	Updated (UTC)
openint	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 14, 2025 4:16am

recurseml · 2025-02-13T04:11:14Z

✨ No issues found! Your code is sparkling clean! ✨

openint-bot · 2025-02-13T12:46:05Z

packages-v1/api-v1/__generated__/openapi.json

@@ -0,0 +1,565 @@
+{


@pellicceama initial spec here.

pellicceama · 2025-02-13T13:48:08Z

packages-v1/api-v1/trpc/routers/index.ts

+    .meta({
+      openapi: {method: 'GET', path: '/connection'},
+    })
+    .input(z.void())


should we include pagination?

This reverts commit 4faa596.

ellipsis-dev

❌ Changes requested. Reviewed everything up to c115f75 in 2 minutes and 48 seconds

More details

Looked at 1418 lines of code in 16 files
Skipped 1 files when reviewing.
Skipped posting 4 drafted comments based on config settings.

1. packages-v1/api-v1/app.ts:10

Draft comment:
Typo: Change 'tos specify url' to 'to specify url'.
Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50%
While the typo exists, it's in a comment rather than in actual code. The meaning is still clear despite the typo. Comments are for developer documentation and this minor typo doesn't impact code functionality or significantly impact readability. According to the rules, we should not make comments that are obvious or unimportant.
The typo could be seen as reducing code quality and professionalism. Some teams might have strict standards for documentation quality.
While documentation quality matters, this is such a minor issue that fixing it provides negligible value and creates unnecessary PR noise.
Delete this comment as it points out an unimportant typo in a comment that doesn't significantly impact code quality or understanding.

2. packages-v1/api-v1/trpc/routers/index.ts:41

Draft comment:
Review the mergeRouters call formatting – while trailing commas are allowed, consider if a more consistent style would improve readability.
Reason this comment was not posted:
Confidence changes required: 30% <= threshold 50%
None

3. packages-v1/api-v1/app.ts:10

Draft comment:
Typo in comment: 'tos' should be 'to'.
Reason this comment was not posted:
Marked as duplicate.

4. packages-v1/api-v1/app.ts:20

Draft comment:
The mounting strategy differs between TRPC and OpenAPI handlers ('/v1/trpc' vs '/v1*'). Consider unifying the mounting approach to reduce confusion.
Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50%
The author is already aware of the inconsistency and has documented why it exists. The comment suggests unifying the approach, but the code comments explicitly state that other approaches don't work when mounted inside Next.js. This suggests the inconsistency is unavoidable given the current constraints.
Maybe there's a newer version or configuration of these libraries that would allow for consistent mounting patterns that the author hasn't discovered?
The code comments indicate this has been thoroughly investigated, and the current solution is the only working approach when mounted in Next.js. The inconsistency is a known limitation.
Delete the comment as it's suggesting a change that's already been investigated and documented as not possible in the current setup.

Workflow ID: wflow_JSr6cj02QhUZO071

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2025-02-16T00:36:43Z

packages-v1/api-v1/trpc/handlers.ts

+import {contextFromRequest} from './context'
+import {appRouter} from './routers'
+
+export const createTrpcHandler =


This functionality already exists - consider using createRouterTRPCHandler instead. It's more flexible as it allows passing different routers.

function createRouterTRPCHandler (createRouterHandler.ts)

ellipsis-dev · 2025-02-16T00:36:43Z

packages-v1/sdk-v1/index.ts

+import type {paths} from '@openint/api-v1/__generated__/openapi.types'
+
+export const trpcClient = createTRPCClient<AppRouter>({
+  links: [httpLink({url: '/api/trpc'})],


TRPC client URL is inconsistent with the mounted route. It uses '/api/trpc' but should likely be '/api/v1/trpc' matching app.ts.

Suggested change

links: [httpLink({url: '/api/trpc'})],

links: [httpLink({url: '/api/v1/trpc'})],

ellipsis-dev · 2025-02-16T00:36:44Z

packages-v1/api-v1/trpc/handlers.ts

+
+export const createTrpcHandler =
+  (opts: {endpoint: `/${string}`}) => (req: Request) => {
+    console.log('handleTrpcRequest', req.url)


Consider gating or reducing verbose logging in production; logging every request in handlers may leak information or clutter logs.

Suggested change

console.log('handleTrpcRequest', req.url)

if (process.env.NODE_ENV !== 'production') console.log('handleTrpcRequest', req.url)

This reverts commit b6baee1.

…#269)" This reverts commit 8be89f7.

…ent crash (#273) * Revert "Revert "Scaffold new v1 api with incremental approach (#259)" (#269)" This reverts commit 8be89f7. * lockfile update * Add debug page showing trpc client working * fix issue with trpc version related crash

vercel bot had a problem deploying to Preview February 13, 2025 04:21 Failure

vercel bot deployed to Preview February 13, 2025 05:56 View deployment

vercel bot deployed to Preview February 13, 2025 10:43 View deployment

vercel bot deployed to Preview February 13, 2025 11:35 View deployment

vercel bot had a problem deploying to Preview February 13, 2025 11:59 Failure

vercel bot had a problem deploying to Preview February 13, 2025 12:09 Failure

vercel bot had a problem deploying to Preview February 13, 2025 12:10 Failure

vercel bot had a problem deploying to Preview February 13, 2025 12:23 Failure

vercel bot had a problem deploying to Preview February 13, 2025 12:34 Failure

openint-bot changed the base branch from main to build-test February 13, 2025 12:34

openint-bot changed the title ~~V1 incremental~~ Scaffold new v1 api Feb 13, 2025

openint-bot changed the title ~~Scaffold new v1 api~~ Scaffold new v1 api with incremental approach Feb 13, 2025

vercel bot had a problem deploying to Preview February 13, 2025 12:39 Failure

vercel bot had a problem deploying to Preview February 13, 2025 12:45 Failure

openint-bot commented Feb 13, 2025

View reviewed changes

pellicceama reviewed Feb 13, 2025

View reviewed changes

openint-bot force-pushed the v1-incremental branch from a37d76c to 80db9c3 Compare February 14, 2025 03:57

vercel bot had a problem deploying to Preview February 14, 2025 03:57 Failure

openint-bot added 3 commits February 13, 2025 20:04

Revert "Removing all v1 code to stack prs"

9a5a370

This reverts commit 4faa596.

update generated

c763bcf

Output latest version of spec and add note about types being broken

d4990a1

openint-bot force-pushed the v1-incremental branch from 80db9c3 to d4990a1 Compare February 14, 2025 04:04

vercel bot had a problem deploying to Preview February 14, 2025 04:04 Failure

openint-bot changed the base branch from build-test to main February 14, 2025 04:05

Revert next.js change, and see if build still fails

c115f75

vercel bot deployed to Preview February 14, 2025 04:08 View deployment

openint-bot marked this pull request as ready for review February 16, 2025 00:33

openint-bot merged commit b6baee1 into main Feb 16, 2025
4 checks passed

openint-bot deleted the v1-incremental branch February 16, 2025 00:36

ellipsis-dev bot reviewed Feb 16, 2025

View reviewed changes

pellicceama restored the v1-incremental branch February 18, 2025 15:58

pellicceama added a commit that referenced this pull request Feb 18, 2025

Revert "Scaffold new v1 api with incremental approach (#259)"

4a3725e

This reverts commit b6baee1.

pellicceama mentioned this pull request Feb 18, 2025

Revert "Scaffold new v1 api with incremental approach" #269

Merged

pellicceama added a commit that referenced this pull request Feb 18, 2025

Revert "Scaffold new v1 api with incremental approach (#259)" (#269)

8be89f7

This reverts commit b6baee1.

openint-bot added a commit that referenced this pull request Feb 21, 2025

Revert "Revert "Scaffold new v1 api with incremental approach (#259)" (…

7af24a1

…#269)" This reverts commit 8be89f7.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scaffold new v1 api with incremental approach #259

Scaffold new v1 api with incremental approach #259

openint-bot commented Feb 13, 2025 •

edited by ellipsis-dev bot

Loading

vercel bot commented Feb 13, 2025 •

edited

Loading

recurseml bot commented Feb 13, 2025

openint-bot Feb 13, 2025

pellicceama Feb 13, 2025

ellipsis-dev bot left a comment

ellipsis-dev bot Feb 16, 2025

ellipsis-dev bot Feb 16, 2025

ellipsis-dev bot Feb 16, 2025

	links: [httpLink({url: '/api/trpc'})],
	links: [httpLink({url: '/api/v1/trpc'})],

	console.log('handleTrpcRequest', req.url)
	if (process.env.NODE_ENV !== 'production') console.log('handleTrpcRequest', req.url)

Scaffold new v1 api with incremental approach #259

Scaffold new v1 api with incremental approach #259

Conversation

openint-bot commented Feb 13, 2025 • edited by ellipsis-dev bot Loading

vercel bot commented Feb 13, 2025 • edited Loading

recurseml bot commented Feb 13, 2025

openint-bot Feb 13, 2025

Choose a reason for hiding this comment

pellicceama Feb 13, 2025

Choose a reason for hiding this comment

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Feb 16, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Feb 16, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Feb 16, 2025

Choose a reason for hiding this comment

openint-bot commented Feb 13, 2025 •

edited by ellipsis-dev bot

Loading

vercel bot commented Feb 13, 2025 •

edited

Loading