feat(deploy): print edge function logs url #6851
Merged
Conversation
This file contains 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
`name` was always `nil` so it effectively never really existed
This could be useful, but it also makes the feature easier to test. :)
serhalp
commented
Oct 2, 2024
Comment on lines
677
to
+679
| logs: results.logsUrl, | ||
| function_logs: results.functionLogsUrl, | ||
| edge_function_logs: results.edgeFunctionLogsUrl, |
There was a problem hiding this comment.
I would rather have suffixed these with _url but since logs was already named logs I erred toward internal consistency 😞.
serhalp
commented
Oct 2, 2024
| }) | ||
| await builder.build() | ||
|
|
||
| const deploy = await callCli(['deploy', '--json', '--dir', 'public', '--prod'], { |
There was a problem hiding this comment.
fun fact: this is the very first test coverage of ntl deploy --prod 😬😬😬
eduardoboucas
approved these changes
Oct 8, 2024
serhalp
added a commit
that referenced
this pull request
Oct 17, 2024
Follow-up to #6851. You can see here it says "Show logs for deploy...": https://app.netlify.com/sites/hydrogen-advanced-caching/logs/ edge-functions?scope=deployid:6705473738103f2856071dbd. This doesn't work with `?scope=deploy:` This is a bit of a footgun since the Functions log URL takes `deploy:` but the Edge Functions log URL takes `deployid:`.
serhalp
added a commit
that referenced
this pull request
Oct 17, 2024
Follow-up to #6851. You can see here it says "Show logs for deploy...": https://app.netlify.com/sites/hydrogen-advanced-caching/logs/ edge-functions?scope=deployid:6705473738103f2856071dbd. This doesn't work with `?scope=deploy:` This is a bit of a footgun since the Functions log URL takes `deploy:` but the Edge Functions log URL takes `deployid:`.
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
The
netlify deploycommand prints the build logs URL and the function logs URL:It's inconvenient and inconsistent that this doesn't also include a link to edge function logs. So this PR adds it.
Changes
4d5ebca: add missing types to
printResultsand neighbouring codebee888c: fix issues uncovered by above
namein the JSON output was coming from a field that did not exist, so it was always undefined (andundefinedvalues are omitted when JSON stringifying), so I just removed it, as it's effectively never truly existedsite_namefield which is working as intended.site_idnever worked (or at least hasn't for some time) as it was reading from a field that didn't exist. I fixed this one.8bee1a9: add edge function logs URL to pretty output
Example:
aed9afe: add
function_logsandedge_function_logsto--jsonoutputIt wasn't consistent that these weren't included in the JSON output. These also could be useful to users. But mostly it allowed me to more easily add test coverage (none of the printed URLs — neither pretty nor json — had test coverage).
Example before:
{ "site_name": "hydrogen-remix-template", "deploy_id": "66fd5eacf914aa188272ebe8", "deploy_url": "https://66fd5eacf914aa188272ebe8--hydrogen-remix-template.netlify.app", "logs": "https://app.netlify.com/sites/hydrogen-remix-template/deploys/66fd5eacf914aa188272ebe8" }Example after:
{ "site_id": "da7ae002-b3be-4dd5-a294-d44321e2459f", "site_name": "hydrogen-remix-template", "deploy_id": "66fd5ef32443dc1423ce705b", "deploy_url": "https://66fd5ef32443dc1423ce705b--hydrogen-remix-template.netlify.app", "logs": "https://app.netlify.com/sites/hydrogen-remix-template/deploys/66fd5ef32443dc1423ce705b", "function_logs": "https://app.netlify.com/sites/hydrogen-remix-template/logs/functions?scope=deploy:66fd5ef32443dc1423ce705b", "edge_function_logs": "https://app.netlify.com/sites/hydrogen-remix-template/logs/edge-functions?scope=deploy:66fd5ef32443dc1423ce705b" }Future improvements
💡 We should only include the function logs URL when the deploy included >0 functions and only include the edge function logs URL when the deploy included >0 edge functions.