bulkPut's BulkError doesn't specify which keys it failed to put

[guanzo]

The BulkError thrown by bulkPut only tells you how many puts failed, but not which ones. Is there any way to find out which keys failed when catching BulkError?

[dfahlander]

No, and that's one thing that is going to change in Dexie 3. Have already created bulkPut methods in another branch (dbcore-middleware-support), that can tell this info. The trick is how to be backward compatible in the API. Probably I will just add another property on BulkError containing a map between positions and the error.

export interface BulkError extends DexieError {
  failures: Error[];
  failuresByPos: {[operationNumber: number]: Error};
}

That way you could enumerate the error and lookup the originating record:

db.bulkPut(items).catch(error => {
   if (error.name === 'BulkError') {
     Object.keys(error.failuresByPos).forEach(pos => {
       console.log(`The item no ${pos} (${JSON.stringify(items[pos])}) failed with error ${error.failuresByPos[pos]}`);
     });
  }
});

What you think about that?

[guanzo]

I think that's a good solution. Looking forward to the v3 release and thank you for this wonderful library.

[dfahlander]

Thanks!

I'll investigate some kind of solution. As it's a major version upgrade it might be ok to change the failures to be the map in itself instead of an array. Just scanned all unit tests and there are no ones referencing failures[0] or failures.length.

Anyhow, any breaking changes will be published in the release notes. Will try to remember to update this issue with the final solution.

[Christilut]

I just ran into the same problem. Is this possible with v3 now? I'm on 3.0.3

[dfahlander]

I must have missed this issue in 3.0 release. However, it's not a breaking change to introduce failuresByPos property on BulkError so I've done a new PR now that will go into next prerelease (3.1.0-alpha.7). Also noticed that the typings for BulkError.failures is not correct since the runtime value of BulkError.failures are still a plain array of Errors and not an object map (like in 2.x). BulkError.failures is now typed correctly as an Error[] and I've added failuresByPos: {[operationNumber: number]: Error}. A new test for this is also part of the PR #1209.

[dfahlander]

Closing as it is now implemented and will be part of next version after 3.1.0-alpha.6.