feat: provide display name for split api routes #2155
Merged
Conversation
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
✅ Deploy Preview for netlify-plugin-nextjs-nx-monorepo-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-static-root-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-plugin-edge-middleware ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
github-actions
bot
added
the
type: feature
✅ Deploy Preview for netlify-plugin-nextjs-next-auth-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for nextjs-plugin-custom-routes-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-plugin-canary ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-i18next-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-export-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
LekoArts
approved these changes
Jun 12, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR updates how API Routes are named + displayed when the Split-API-Routes flag is enabled.
Before, the generated API-Routes were named
_api-0to_api-n, and there were no display names. Now, the names are a bit more complicated, but easier to understand as well. They take into account that some lambdas serve multiple API routes, while others serve only a single one.In the new logic, those "singleton lambdas" are named based on their page name (
/api/shows/[:id]becomes_api_shows_id-handler) and receive a display name that shows their route (Next.js API handler /api/shows/[:id]). Scheduled functions and background function have that exact same naming convention, we'll rely on the UI-displayed badge to signal that those are special functions.For "packed lambdas", which serve multiple API routes, we use simpler names. If there's only one big packed lambda, then we'll name it
___netlify-api-handler, similar to the existing___netlify-handlerand___netlify-odb-handler. We'll give it the display-nameNext.js API handler, similar to the existingNext.js SSR handler.If there's multiple packed lambdas because one wasn't big enough, then we enumerate them from
___netlify-api-handler-1to___netlify-api-handler-nwith the display namesNext.js API handler 1/ntoNext.js API handler n/n.Documentation
Tests
added a unit test.
Relevant links (GitHub issues, etc.) or a picture of cute animal
came up in https://netlify.slack.com/archives/C053SCS9GDQ/p1685732487867909