feat: enable API, SSR and DSG functions individually as required #375
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-gatsby-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
ascorbic
reviewed
May 13, 2022
orinokai
commented
May 13, 2022
2 tasks
ascorbic
previously approved these changes
May 18, 2022
plugin/src/helpers/config.ts
Outdated
| // eslint-disable-next-line complexity | ||
| function overrideNeededFunctions(neededFunctions) { | ||
| const skipAll = | ||
| process.env.NETLIFY_SKIP_GATSBY_FUNCTIONS === 'true' || |
There was a problem hiding this comment.
[sand] I wonder if these repeated checks could be abstracted into a helper that checks for true or 1
There was a problem hiding this comment.
Good point. Have updated. Reads cleaner.
ascorbic
approved these changes
May 18, 2022
2 tasks
2 tasks
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.
Summary
This PR switches
shouldSkipFunctions()forgetNeededFunctions()which checks the skip file generated by gatsby-plugin-netlify and returns an array of the required functions, rather than a boolean.This array is then used throughout the remaining function setup code to enable each function individually.
Backward compatibility is maintained by disabling all functions if an empty skip file is provided and enabling all functions if no skip file exists.
The current env var
NETLIFY_SKIP_GATSBY_FUNCTIONSstill disables all functions as before, but 3 additional env vars have been added to control each function individually:NETLIFY_SKIP_API_FUNCTIONNETLIFY_SKIP_SSR_FUNCTIONNETLIFY_SKIP_DSG_FUNCTIONTest plan
Relevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal
Fixes #374
The additional functionality in this PR is only possible when paired with this PR in the gatsby-plugin-repo, but the plugin still works as before without it.
Standard checks:
🧪 Once merged, make sure to update the version if needed and that it was
published correctly.