feat: split api routes into separate functions #1495

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.

Sign up for GitHub

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

Jump to bottom

Merged

kodiakhq merged 30 commits into main from mk/background-functions

Oct 17, 2022

Contributor

ascorbic commented Jul 31, 2022 •

edited by nickytonline

Loading

Summary

Rather than including API routes in the SSR function, this splits them into individual functions per route. This makes them smaller, easier to track in the UI, and enables them to be configured individually.

Test plan

Visit the Deploy Preview
Open the API route examples

Relevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal

Standard checks:

Check the Deploy Preview's Demo site for your PR's functionality
Add docs when necessary

🧪 Once merged, make sure to update the version if needed and that it was published correctly.

ascorbic added 2 commits

July 30, 2022 11:45


          feat: add static analysis helper

25f3e2f


          feat: split api routes into separate functions

fbfd0cc

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for netlify-plugin-nextjs-export-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/netlify-plugin-nextjs-export-demo/deploys/634d839bd7f54700084d2a76
😎 Deploy Preview	https://deploy-preview-1495--netlify-plugin-nextjs-export-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for netlify-plugin-nextjs-nx-monorepo-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/netlify-plugin-nextjs-nx-monorepo-demo/deploys/634d839ba18ea400092e4343
😎 Deploy Preview	https://deploy-preview-1495--netlify-plugin-nextjs-nx-monorepo-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for netlify-plugin-nextjs-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/netlify-plugin-nextjs-demo/deploys/634d839ba787480008f4d097
😎 Deploy Preview	https://deploy-preview-1495--netlify-plugin-nextjs-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for next-plugin-edge-middleware ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/next-plugin-edge-middleware/deploys/634d839b9bea8e0009c9c9e8
😎 Deploy Preview	https://deploy-preview-1495--next-plugin-edge-middleware.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

github-actions bot added the type: feature label

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for next-hp-edge-demo ready!

Name	Link
🔨 Latest commit	`898a8a7`
🔍 Latest deploy log	https://app.netlify.com/sites/next-hp-edge-demo/deploys/633ff3cfc903030009ddbf4a
😎 Deploy Preview	https://deploy-preview-1495--next-hp-edge-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for next-plugin-rsc-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/next-plugin-rsc-demo/deploys/634d839b7366320008ced7b1
😎 Deploy Preview	https://deploy-preview-1495--next-plugin-rsc-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for netlify-plugin-nextjs-next-auth-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/netlify-plugin-nextjs-next-auth-demo/deploys/634d839b5cb15c00098c9f3e
😎 Deploy Preview	https://deploy-preview-1495--netlify-plugin-nextjs-next-auth-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for next-i18next-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/next-i18next-demo/deploys/634d839b89d8700009d14b24
😎 Deploy Preview	https://deploy-preview-1495--next-i18next-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for next-plugin-canary ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/next-plugin-canary/deploys/634d839b414f1a000802fa18
😎 Deploy Preview	https://deploy-preview-1495--next-plugin-canary.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for nextjs-plugin-custom-routes-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/nextjs-plugin-custom-routes-demo/deploys/634d839b9775ac0008e88cc7
😎 Deploy Preview	https://deploy-preview-1495--nextjs-plugin-custom-routes-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify bot commented Jul 31, 2022 •

edited

Loading

✅ Deploy Preview for netlify-plugin-nextjs-static-root-demo ready!

Name	Link
🔨 Latest commit	`781be0c`
🔍 Latest deploy log	https://app.netlify.com/sites/netlify-plugin-nextjs-static-root-demo/deploys/634d839b23e05f00080e06f0
😎 Deploy Preview	https://deploy-preview-1495--netlify-plugin-nextjs-static-root-demo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

This comment was marked as outdated.

Sign in to view

cypress bot commented Jul 31, 2022 •

edited

Loading

Test summary

2 • 0 • 0 • 0

Run details


Project	netlify-plugin-nextjs-nx-monorepo-demo
Status	Passed
Commit	`2b22248` ℹ️
Started	Aug 8, 2022 10:55 AM
Ended	Aug 8, 2022 10:56 AM
Duration	01:10 💡
OS	Linux Ubuntu - 20.04
Browser	Chrome 103

View run in Cypress Dashboard ➡️

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

cypress bot commented Jul 31, 2022 •

edited

Loading

Test summary

7 • 0 • 0 • 0

Run details


Project	netlify-plugin-nextjs-static-demo
Status	Passed
Commit	`2b22248` ℹ️
Started	Aug 8, 2022 10:54 AM
Ended	Aug 8, 2022 10:56 AM
Duration	01:19 💡
OS	Linux Ubuntu - 20.04
Browser	Chrome 103

View run in Cypress Dashboard ➡️

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

ascorbic added 2 commits

July 31, 2022 07:44


          chore: fix syntax of api handlers for better static analysis

57b31b2


          fix: broken test

dc8c3de

ascorbic force-pushed the mk/background-functions branch from 902f75d to dc8c3de Compare

July 31, 2022 14:23

ascorbic and others added 6 commits

August 7, 2022 16:29


          Merge branch 'main' into mk/background-functions

47f0a95


          chore: change config shape

9d1dfdd


          Merge branch 'mk/background-functions' of github.com:netlify/netlify-…

b3cc08e

…plugin-nextjs into mk/background-functions


          chore: fix test

1786f84


          chore: windows paths 😠

8f312f1


          chore: add e2e tests for extended API routes

5f582b2

ascorbic force-pushed the mk/background-functions branch from 8c35268 to 5f582b2 Compare

August 8, 2022 10:51

ascorbic added 2 commits

August 19, 2022 09:33


          Merge branch 'main' into mk/background-functions

56abd3a


          chore: fix cypress 404 test

00a80a7

ascorbic force-pushed the mk/background-functions branch from dd87de6 to 00a80a7 Compare

August 19, 2022 12:19

ascorbic added 2 commits

September 23, 2022 11:18


          chore: remove unused function

bb65d50


          Merge branch 'main' into mk/background-functions

daeb493

nickytonline reviewed

View reviewed changes

packages/runtime/src/helpers/utils.ts Outdated Show resolved Hide resolved

nickytonline reviewed

View reviewed changes

packages/runtime/src/helpers/analysis.ts Show resolved Hide resolved

ascorbic added 2 commits

October 6, 2022 09:22


          chore: use enum for api route type

6aad6b1


          Merge branch 'main' into mk/background-functions

df28822

ascorbic marked this pull request as ready for review

October 6, 2022 08:24

ascorbic requested a review from a team

October 6, 2022 08:24

ascorbic added 3 commits

October 6, 2022 09:43


          chore: snapidoo

7cbe3ef


          chore: lockfile

56d5a06


          chore: debug preview test

0d3152f

nickytonline reviewed

View reviewed changes

packages/runtime/src/helpers/analysis.ts Outdated Show resolved Hide resolved

packages/runtime/src/helpers/analysis.ts Show resolved Hide resolved

packages/runtime/src/helpers/analysis.ts Show resolved Hide resolved

packages/runtime/src/helpers/analysis.ts Show resolved Hide resolved

ascorbic and others added 2 commits

October 6, 2022 16:07


          chore: use const enum

f83d562


          Merge branch 'main' into mk/background-functions

nickytonline reviewed

View reviewed changes

cypress/integration/default/preview.spec.ts

Comment on lines +3 to +4

		Cypress.Cookies.debug(true)
		cy.getCookies().then((cookie) => cy.log('cookies', cookie))

nickytonline Oct 6, 2022

Are these debug lines still necessary?

nickytonline Oct 13, 2022

Just following up on this @ascorbic

nickytonline Oct 17, 2022

Last ping about this. It's not a blocker, but I assume it was only for debugging purposes?

nickytonline reviewed

View reviewed changes

packages/runtime/src/helpers/files.ts Outdated Show resolved Hide resolved

test/index.js Show resolved Hide resolved

ascorbic added 2 commits

October 7, 2022 09:13


          Merge branch 'main' into mk/background-functions


          feat: add warning logs for advanced api routes

898a8a7

nickytonline commented Oct 13, 2022

It looks like the demo site for the split API routes is failing @ascorbic.

5:40:25 AM: Error: > Couldn't find a `pages` directory. Please create one under the project root
    at Object.findPagesDir (/opt/build/repo/node_modules/next/dist/lib/find-pages-dir.js:42:19)
5:40:25 AM:     at /opt/build/repo/node_modules/next/dist/build/index.js:95:70
5:40:25 AM:     at async Span.traceAsyncFn (/opt/build/repo/node_modules/next/dist/trace/trace.js:79:20)
5:40:25 AM:     at async Object.build [as default] (/opt/build/repo/node_modules/next/dist/build/index.js:65:29)

Contributor Author

ascorbic commented Oct 14, 2022

@nickytonline you have two copies of the plugin in your site. You need to disable to auto-installed one.

ascorbic requested a review from nickytonline

October 17, 2022 08:22

ascorbic and others added 2 commits

October 17, 2022 15:03


          Merge branch 'main' into mk/background-functions

a190160


          chore: support jsx

781be0c

nickytonline approved these changes

View reviewed changes

nickytonline left a comment

As expected an HTTP 202 is returned for the background function in the demo, i.e. /api/hello-background

And for a scheduled route, i.e. /api/hello-scheduled, it correctly returns an HTTP 404.

Nice work @ascorbic!

ascorbic added the automerge label

kodiakhq bot merged commit 654c6de into main

kodiakhq bot deleted the mk/background-functions branch

October 17, 2022 21:56

token-generator-app bot mentioned this pull request

chore: release main #1688

Merged

This was referenced Oct 27, 2022

[Bug]: Dynamic api route does not pass query params #1726

Closed

fix: only split extended routes to decrease build times #1731

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge type: feature