planetscale / planetscale/database-js
Descriptive body for errors
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.2k
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
I am trying to catch exceptions when inserting duplicates that violate a UNIQUE constraint. Node prints the exception as
… caused DatabaseError: target: ….-.primary: vttablet: rpc error: code = AlreadyExists desc = Duplicate entry 'foo' for key 'SomeTable.someAttribute' (errno 1062) (sqlstate 23000) (CallerID: …): Sql: "insert into SomeTable(
someAttribute) values (:vtg1 /* VARCHAR */)", BindVars: {REDACTED}
console.log(e) gives me
{
status: 400,
body: {
message: 'target: ….-.primary: vttablet: rpc error: code = AlreadyExists desc = Duplicate entry \'foo\' for key \'SomeTable.someAttribute\' (errno 1062) (sqlstate 23000) (CallerID: …): Sql: "insert into SomeTable(`someAttribute`) values (:vtg1 /* VARCHAR */)", BindVars: {REDACTED}',
code: 'UNKNOWN'
}
}
I can parse that message with a regex to extract the code and everything, but I think it'd make more sense to have a few more fields that digest that information already (errno would probably be the most helpful, at least for my use case).
One could also take that a step further and introduce more classes that derive https://github.com/planetscale/database-js/blob/f62005c7e5d31a1e1b475ee6aad7f20ca3dba911/src/index.ts#L15 but I suspect that might get out of hand quickly. I just checked out the MySQL error reference and it's enormous.
Also code: 'UNKNOWN' seems a bit odd, unless it does not describe any of code, errno or sqlstate.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the exception definition in src/index.ts around line 15 and trace how the duplicate-key error becomes the current message and code fields. Use the UNIQUE-constraint example as the acceptance case; done means the error exposes the agreed structured information and clarifies what UNKNOWN represents, with tests covering the resulting behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- mysql, typescript
- Domain
- api, database
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100