Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add functionName to callsite frames #321

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
merged 4 commits into from
Dec 19, 2021
Merged

Add functionName to callsite frames #321

merged 4 commits into from
Dec 19, 2021

Conversation

@mmkal
Copy link
Contributor

@mmkal mmkal commented Dec 19, 2021 •
edited
Loading

An idea: it's frustrating that when there are errors in a query, the call-stacks are always full of pg-protocol and related sites, never much to do with the application code. captureStackTrace can help. Here's roughly what I want to do:

const pool = createPool('postgresql://postgres:postgres@localhost:5433/postgres', {
  captureStackTrace: true,
  interceptors: [
    {
      queryExecutionError: (context, query, error, notices) => {
        console.log({context, query, error, notices})
        if (context.stackTrace) {
          throw Object.assign(new Error(error.message), {
            stack:
              `${error.message}\n` +
              context.stackTrace
                .map(site => {
                  const location = `${site.fileName}:${site.lineNumber}:${site.columnNumber}`
                  return `    at ${site.functionName || '[unknown]'} (${location})`
                })
                .join('\n'),
            cause: error,
          })
        }
      },
    },
  ],
})

Basically, reverse-engineer the "real" call stack. Then when running code like this:

await pool
  .query(sql`select * from this is bad syntax`)
  .catch(e => console.log(e))

Before (note that everything in the call stack is useless to someone debugging):

syntax error at or near "is"
    at Parser.parseErrorMessage (/path/to/folder/node_modules/pg-protocol/dist/parser.js:287:98)
    at Parser.handlePacket (/path/to/folder/node_modules/pg-protocol/dist/parser.js:126:29)
    at Parser.parse (/path/to/folder/node_modules/pg-protocol/dist/parser.js:39:38)
    at Socket.<anonymous> (/path/to/folder/node_modules/pg-protocol/dist/index.js:11:42)
    at Socket.emit (events.js:376:20)
    at addChunk (internal/streams/readable.js:309:12)
    at readableAddChunk (internal/streams/readable.js:284:9)
    at Socket.Readable.push (internal/streams/readable.js:223:10)
    at TCP.onStreamRead (internal/stream_base_commons.js:188:23) {
  length: 91,
  severity: 'ERROR',
  code: '42601',
  detail: undefined,
  hint: undefined,
  position: '20',
  internalPosition: undefined,
  internalQuery: undefined,
  where: undefined,
  schema: undefined,
  table: undefined,
  column: undefined,
  dataType: undefined,
  constraint: undefined,
  file: 'scan.l',
  line: '1149',
  routine: 'scanner_yyerror',
  notices: []
}

After:

syntax error at or near "is"
    at executeQuery (/path/to/folder/node_modules/slonik/src/routines/executeQuery.ts:142:41)
    at query (/path/to/folder/node_modules/slonik/src/connectionMethods/query.ts:22:4)
    at query (/path/to/folder/node_modules/slonik/src/binders/bindPoolConnection.ts:150:8)
    at [unknown] (/path/to/folder/node_modules/slonik/src/binders/bindPool.ts:297:33)
    at createConnection (/path/to/folder/node_modules/slonik/src/factories/createConnection.ts:187:19)
    at processTicksAndRejections (internal/process/task_queues.js:95:5)
    at main (/path/to/folder/test.js:45:3) {
  cause: error: syntax error at or near "is"
      at Parser.parseErrorMessage (/path/to/folder/node_modules/pg-protocol/dist/parser.js:287:98)
      at Parser.handlePacket (/path/to/folder/node_modules/pg-protocol/dist/parser.js:126:29)
      at Parser.parse (/path/to/folder/node_modules/pg-protocol/dist/parser.js:39:38)
      at Socket.<anonymous> (/path/to/folder/node_modules/pg-protocol/dist/index.js:11:42)
      at Socket.emit (events.js:376:20)
      at addChunk (internal/streams/readable.js:309:12)
      at readableAddChunk (internal/streams/readable.js:284:9)
      at Socket.Readable.push (internal/streams/readable.js:223:10)
      at TCP.onStreamRead (internal/stream_base_commons.js:188:23) {
    length: 91,
    severity: 'ERROR',
    code: '42601',
    detail: undefined,
    hint: undefined,
    position: '20',
    internalPosition: undefined,
    internalQuery: undefined,
    where: undefined,
    schema: undefined,
    table: undefined,
    column: undefined,
    dataType: undefined,
    constraint: undefined,
    file: 'scan.l',
    line: '1149',
    routine: 'scanner_yyerror',
    notices: []
  }
}

Note the frame at main (/path/to/folder/test.js:45:3) which is where the actual query is, the part that has the typo in it and needs to change.

Most of this is possible now, but this change adds the function name so that it can be included in the call stack instead of [unknown].

mmkal
mmkal commented Dec 19, 2021
View reviewed changes
@coveralls
Copy link

Coverage Status

Coverage remained the same at 89.054% when pulling 953034a on mmkal:patch-4 into 193cb3f on gajus:master.

@gajus gajus merged commit 29febd2 into gajus:master Dec 19, 2021
@gajus
Copy link
Owner

gajus commented Dec 19, 2021

🎉 This PR is included in version 26.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Dec 19, 2021
@mmkal mmkal deleted the patch-4 branch December 19, 2021 19:09
@alxndrsn alxndrsn mentioned this pull request Sep 10, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mmkal @coveralls @gajus