feat: add options.rawErrors to `Sequelize#query` method #13881

joaoe · 2022-01-02T00:55:40Z

Pull Request Checklist

Please make sure to review and check all of these items:

Have you added new tests to prevent regressions?
Does npm run test or npm run test-DIALECT pass with this change (including linting)?
Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
Did you update the typescript typings accordingly (if applicable)?
Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description Of Change

feat(query): added options.rawErrors to query() method

This option causes all errors from the underlying connection/database library
to be propagated unformatted and unmodified. Use this for lesser common errors
sequelize can't parse or in case you prefer to see the full raw errors.

Use case: in my project, we have a central database where different apps connect, like some scientific libraries and a REST API implemented using Node.JS. All errors in all apps are logged centrally. So, if there are DB errors, it is mostly productive to get the original error messages from the database so all developers understand them, and not just those that develop with node.js+sequelize. Also, Sequelize unfortunatelly cannot parse all errors, like at some point there was a cryptic error, because sequelize could not insert in a table with a trigger, something that was easily visible once we saw the original db error.

So, the rawErrors option is a nice to have for those that are not so interested in Sequelize's own error parsing. Also, it saves some CPU cyles. It can be set per query or in the global sequelize.options.query.

Also bonus: stack handling for db2.

Todos

Wait for all pipelines to run green

WikiRik

Thanks for the PR! I only looked at the mssql docs changes and the eslint changes for now and have some comments on that

package.json

.github/workflows/ci.yml

WikiRik · 2022-01-02T01:07:18Z

And it seems that Microsoft currently only offers 2017 & 2019 Docker images so we need to figure out a different way to test on 2014 if we really want to; https://hub.docker.com/_/microsoft-mssql-server

joaoe · 2022-01-02T01:09:32Z

And it seems that Microsoft currently only offers 2017 & 2019 Docker images so we need to figure out a different way to test on 2014 if we really want to; https://hub.docker.com/_/microsoft-mssql-server

Bummer.
Perhaps phase out ms sql 2014 and 2016 support for Sequelize v7 due to lack of support from MS ? Their mainstream support date have expired.

package.json

lib/dialects/abstract/query.js

build.js

sdepold

Good stuff. Thanks :)

test/support.js

build.js

test/integration/sequelize/query.test.js

ephys

Good on my end. Just need to resolve other reviewer's requests & fix tests :)

joaoe · 2022-01-21T21:17:46Z

Howdy.

Life's busy, but I've just updated the PR with a rebased branch.
The MS SQL commit I shall do another PR.
The commit to pass the root js files to the linter is now not needed since someone else changed that in another PR.

joaoe · 2022-01-21T22:20:57Z

@ephys Hi. The pipeline is acting weird. A lot of MS SQL and MySQL fails which are completely unrelated with my work.

ephys · 2022-01-22T17:34:03Z

Updating the branch to see if it still happens. It's not happening in the other PRs so if it still happens here it must be a subtle issue that was introduced :/

ephys · 2022-01-22T19:23:57Z

Unfortunately they are still failing. Could be related to the changes made in test/support.js?

joaoe · 2022-01-23T02:10:27Z

Unfortunately they are still failing. Could be related to the changes made in test/support.js?

That would be quite fascinating given the randomness of the fails. Oh well, tomorrow I might try to push the branch one commit at a time.

joaoe · 2022-01-24T13:51:27Z

Fascinating. The pipeline passed without the _.merge() changes. Oh well.
@ephys Lets keep that commit out then just so I'm done with this PR.

ephys

Last note on my end I think, the rest looks good to me

build.js

joaoe · 2022-01-24T20:54:45Z

@ephys I'm very confused. Something happened recently with the project now the partial build takes as long at the whole build... bah ! Since there is no benefit here, I'll just skip this commit as well... :/

WikiRik · 2022-01-24T20:56:57Z

@ephys I'm very confused. Something happened recently with the project now the partial build takes as long at the whole build... bah ! Since there is no benefit here, I'll just skip this commit as well... :/

Strange. Do you happen to know around what time this change happened? For example a release/commit in which it still worked. So we can try to figure out what happened

joaoe · 2022-01-24T21:00:26Z

@ephys I'm very confused. Something happened recently with the project now the partial build takes as long at the whole build... bah ! Since there is no benefit here, I'll just skip this commit as well... :/

Strange. Do you happen to know around what time this change happened? For example a release/commit in which it still worked. So we can try to figure out what happened

The past two weeks or so. There was a big commit about making eslint becoming more stringent and doing autoformatting. Perhaps that changed some settings. I could try to bisect this but then can leave it for another PR.

joaoe · 2022-01-24T21:35:36Z

@ephys I'm very confused. Something happened recently with the project now the partial build takes as long at the whole build... bah ! Since there is no benefit here, I'll just skip this commit as well... :/

Strange. Do you happen to know around what time this change happened? For example a release/commit in which it still worked. So we can try to figure out what happened

I might be hallucinating. I tried a month old commit from early december. The age check doesn't work, it is still slow.
I think I might be confusing build.js not doing anything when I just edited test files.
Well, then this PR is ready.

WikiRik

Looks good to me

This option causes all errors from the underlying connection/database library to be propagated unformatted and unmodified. Use this for lesser common errors sequelize can't parse or in case you perfer to see the full raw errors.

…ed the query

joaoe · 2022-01-24T22:25:05Z

I see a fail in DB2 + Node 16 but that is also happening in the main branch.

WikiRik · 2022-01-25T01:04:20Z

Yeah we got a flaky test there, don't worry about that

ephys

I'm sorry to hear that the incremental build did not work :/
The rest looks good to me though

ephys · 2022-01-25T12:37:15Z

I think we can safely add this to v6 too

joaoe · 2022-01-25T17:22:43Z

ok, who can merge ?

ephys · 2022-01-25T18:58:48Z

Thank you for the PR! :)

Co-authored-by: Zoé <zoe@ephys.dev> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

github-actions · 2022-02-07T08:00:38Z

🎉 This PR is included in version 7.0.0-alpha.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

) Co-authored-by: Zoé <zoe@ephys.dev> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

WikiRik reviewed Jan 2, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

.github/workflows/ci.yml Outdated Show resolved Hide resolved

ephys requested changes Jan 2, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

lib/dialects/abstract/query.js Show resolved Hide resolved

build.js Outdated Show resolved Hide resolved

sdepold reviewed Jan 4, 2022

View reviewed changes

ephys previously approved these changes Jan 10, 2022

View reviewed changes

joaoe dismissed ephys’s stale review via 8815f6c January 21, 2022 21:10

joaoe force-pushed the slightly_opinionated_changes branch from 4c9f602 to 8815f6c Compare January 21, 2022 21:10

joaoe force-pushed the slightly_opinionated_changes branch from 8815f6c to f406fe8 Compare January 21, 2022 21:20

joaoe force-pushed the slightly_opinionated_changes branch from e03ceb0 to 0ce8e76 Compare January 24, 2022 13:03

ephys requested changes Jan 24, 2022

View reviewed changes

build.js Outdated Show resolved Hide resolved

joaoe force-pushed the slightly_opinionated_changes branch from 0ce8e76 to a3a2562 Compare January 24, 2022 20:56

joaoe changed the title ~~Slightly opinionated changes~~ feat(query): added options.rawErrors to query() method Jan 24, 2022

WikiRik previously approved these changes Jan 24, 2022

View reviewed changes

WikiRik requested a review from ephys January 24, 2022 21:50

joaoe added 2 commits January 24, 2022 22:58

feat(query): added options.rawErrors to query() method

f055cc5

This option causes all errors from the underlying connection/database library to be propagated unformatted and unmodified. Use this for lesser common errors sequelize can't parse or in case you perfer to see the full raw errors.

feat(db2/formatError): added support for reporting stack that trigger…

05c5c84

…ed the query

joaoe dismissed WikiRik’s stale review via 05c5c84 January 24, 2022 21:58

joaoe force-pushed the slightly_opinionated_changes branch from a3a2562 to 05c5c84 Compare January 24, 2022 21:58

ephys approved these changes Jan 25, 2022

View reviewed changes

Merge branch 'main' into slightly_opinionated_changes

b969aed

ephys changed the title ~~feat(query): added options.rawErrors to query() method~~ feat: add options.rawErrors to query() method Jan 25, 2022

ephys changed the title ~~feat: add options.rawErrors to query() method~~ feat: add options.rawErrors to Sequelize#query method Jan 25, 2022

Merge branch 'main' into slightly_opinionated_changes

4f37325

ephys merged commit 4c8fa9a into sequelize:main Jan 25, 2022

sdepold pushed a commit that referenced this pull request Jan 29, 2022

feat: add options.rawErrors to Sequelize#query method (#13881)

7c58851

Co-authored-by: Zoé <zoe@ephys.dev> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

github-actions bot added the released on @v7 label Feb 7, 2022

aliatsis pushed a commit to creditiq/sequelize that referenced this pull request Jun 2, 2022

feat: add options.rawErrors to Sequelize#query method (sequelize#13881

a02546d

) Co-authored-by: Zoé <zoe@ephys.dev> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add options.rawErrors to `Sequelize#query` method #13881

feat: add options.rawErrors to `Sequelize#query` method #13881

joaoe commented Jan 2, 2022 •

edited

WikiRik left a comment

WikiRik commented Jan 2, 2022

joaoe commented Jan 2, 2022 •

edited

sdepold left a comment

ephys left a comment •

edited

joaoe commented Jan 21, 2022

joaoe commented Jan 21, 2022

ephys commented Jan 22, 2022

ephys commented Jan 22, 2022

joaoe commented Jan 23, 2022

joaoe commented Jan 24, 2022 •

edited

ephys left a comment

joaoe commented Jan 24, 2022

WikiRik commented Jan 24, 2022

joaoe commented Jan 24, 2022

joaoe commented Jan 24, 2022 •

edited

WikiRik left a comment

joaoe commented Jan 24, 2022

WikiRik commented Jan 25, 2022

ephys left a comment

ephys commented Jan 25, 2022

joaoe commented Jan 25, 2022

ephys commented Jan 25, 2022 •

edited

github-actions bot commented Feb 7, 2022

feat: add options.rawErrors to Sequelize#query method #13881

feat: add options.rawErrors to Sequelize#query method #13881

Conversation

joaoe commented Jan 2, 2022 • edited

Pull Request Checklist

Description Of Change

Todos

WikiRik left a comment

Choose a reason for hiding this comment

WikiRik commented Jan 2, 2022

joaoe commented Jan 2, 2022 • edited

sdepold left a comment

Choose a reason for hiding this comment

ephys left a comment • edited

Choose a reason for hiding this comment

joaoe commented Jan 21, 2022

joaoe commented Jan 21, 2022

ephys commented Jan 22, 2022

ephys commented Jan 22, 2022

joaoe commented Jan 23, 2022

joaoe commented Jan 24, 2022 • edited

ephys left a comment

Choose a reason for hiding this comment

joaoe commented Jan 24, 2022

WikiRik commented Jan 24, 2022

joaoe commented Jan 24, 2022

joaoe commented Jan 24, 2022 • edited

WikiRik left a comment

Choose a reason for hiding this comment

joaoe commented Jan 24, 2022

WikiRik commented Jan 25, 2022

ephys left a comment

Choose a reason for hiding this comment

ephys commented Jan 25, 2022

joaoe commented Jan 25, 2022

ephys commented Jan 25, 2022 • edited

github-actions bot commented Feb 7, 2022

feat: add options.rawErrors to `Sequelize#query` method #13881

feat: add options.rawErrors to `Sequelize#query` method #13881

joaoe commented Jan 2, 2022 •

edited

joaoe commented Jan 2, 2022 •

edited

ephys left a comment •

edited

joaoe commented Jan 24, 2022 •

edited

joaoe commented Jan 24, 2022 •

edited

ephys commented Jan 25, 2022 •

edited