feat: add logs:edge-functions command and historical log support #7944
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| import { OptionValues } from 'commander' | ||
| import inquirer from 'inquirer' | ||
|
|
||
| import { chalk, log } from '../../utils/command-helpers.js' | ||
| import { getWebSocket } from '../../utils/websockets/index.js' | ||
| import type BaseCommand from '../base-command.js' | ||
|
|
||
| import { | ||
| parseDateToMs, | ||
| buildEdgeFunctionLogsUrl, | ||
| fetchHistoricalLogs, | ||
| printHistoricalLogs, | ||
| formatLogEntry, | ||
| } from './log-api.js' | ||
| import { CLI_LOG_LEVEL_CHOICES_STRING, LOG_LEVELS_LIST } from './log-levels.js' | ||
| import { getName } from './build.js' | ||
|
|
||
| export const logsEdgeFunction = async (options: OptionValues, command: BaseCommand) => { | ||
| let deployId = options.deployId as string | undefined | ||
|
There was a problem hiding this comment.
Also applies to: 32-39 🤖 Prompt for AI Agents |
||
| await command.authenticate() | ||
|
|
||
| const client = command.netlify.api | ||
| const { site } = command.netlify | ||
| const { id: siteId } = site | ||
|
|
||
| if (!siteId) { | ||
| log('You must link a project before attempting to view edge function logs') | ||
| return | ||
| } | ||
|
|
||
| const levels = options.level as string[] | undefined | ||
| if (levels && !levels.every((level) => LOG_LEVELS_LIST.includes(level))) { | ||
| log(`Invalid log level. Choices are:${CLI_LOG_LEVEL_CHOICES_STRING.join(',')}`) | ||
| } | ||
|
|
||
| const levelsToPrint: string[] = levels || LOG_LEVELS_LIST | ||
|
|
||
| if (options.from) { | ||
| const fromMs = parseDateToMs(options.from as string) | ||
| const toMs = options.to ? parseDateToMs(options.to as string) : Date.now() | ||
|
|
||
| const url = buildEdgeFunctionLogsUrl({ siteId, from: fromMs, to: toMs }) | ||
| const data = await fetchHistoricalLogs({ url, accessToken: client.accessToken ?? '' }) | ||
| printHistoricalLogs(data, levelsToPrint) | ||
| return | ||
| } | ||
|
|
||
| const userId = command.netlify.globalConfig.get('userId') as string | ||
|
|
||
| if (!deployId) { | ||
| const deploys = await client.listSiteDeploys({ siteId }) | ||
|
|
||
| if (deploys.length === 0) { | ||
| log('No deploys found for the project') | ||
| return | ||
| } | ||
|
|
||
| if (deploys.length === 1) { | ||
| deployId = deploys[0].id | ||
| } else { | ||
| const { result } = (await inquirer.prompt({ | ||
| name: 'result', | ||
| type: 'list', | ||
| message: `Select a deploy\n\n${chalk.yellow('*')} indicates a deploy created by you`, | ||
| choices: deploys.map((deploy) => ({ | ||
| name: getName({ deploy, userId }), | ||
| value: deploy.id, | ||
| })), | ||
| })) as { result: string } | ||
|
|
||
| deployId = result | ||
| } | ||
| } | ||
|
|
||
| const ws = getWebSocket('wss://socketeer.services.netlify.com/edge-function/logs') | ||
|
Member
There was a problem hiding this comment. Side note: I hate that we're exposing this. We should set up a customer-facing domain name for this. |
||
|
|
||
| ws.on('open', () => { | ||
| ws.send( | ||
| JSON.stringify({ | ||
| deploy_id: deployId, | ||
| site_id: siteId, | ||
| access_token: client.accessToken, | ||
| since: new Date().toISOString(), | ||
| }), | ||
| ) | ||
| }) | ||
|
|
||
| ws.on('message', (data: string) => { | ||
| const logData = JSON.parse(data) as { level: string; message: string; timestamp?: string } | ||
| if (!levelsToPrint.includes(logData.level.toLowerCase())) { | ||
| return | ||
| } | ||
| log(formatLogEntry(logData)) | ||
| }) | ||
|
Comment on lines
+88
to
+94
There was a problem hiding this comment. Guard websocket parsing to prevent command crashes. Line 89 assumes every frame is valid JSON; one malformed payload will throw and terminate the stream. 🛡️ Proposed defensive parsing ws.on('message', (data: string) => {
- const logData = JSON.parse(data) as { level: string; message: string; timestamp?: string }
+ let logData: { level: string; message: string; timestamp?: string }
+ try {
+ logData = JSON.parse(data) as { level: string; message: string; timestamp?: string }
+ } catch {
+ log('Received malformed log payload')
+ return
+ }
+
if (!levelsToPrint.includes(logData.level.toLowerCase())) {
return
}
log(formatLogEntry(logData))
})🤖 Prompt for AI Agents |
||
|
|
||
| ws.on('close', () => { | ||
| log('Connection closed') | ||
| }) | ||
|
|
||
| ws.on('error', (err: Error) => { | ||
| log('Connection error') | ||
| log(err.message) | ||
| }) | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Resolve docs lint warnings in the new argument/flag text.
Line 172 (
functionName) and Line 176 (“look up”) will keep triggering lint-docs warnings; rewording here will keep docs clean.✏️ Proposed doc-only fix
Also applies to: 176-176
🧰 Tools
🪛 GitHub Check: lint-docs
[warning] 172-172:
[vale] reported by reviewdog 🐶
[base.spelling] Spellcheck: did you really mean 'functionName'?
Raw Output:
{"message": "[base.spelling] Spellcheck: did you really mean 'functionName'?", "location": {"path": "docs/commands/functions.md", "range": {"start": {"line": 172, "column": 3}}}, "severity": "WARNING"}
🤖 Prompt for AI Agents