Deprecate isRetriableError and ensure isRetryableError functions#1305
Deprecate isRetriableError and ensure isRetryableError functions#1305
Conversation
packages/bolt-connection/test/connection-provider/connection-provider-direct.test.js
Outdated
Show resolved
Hide resolved
packages/bolt-connection/test/connection-provider/connection-provider-direct.test.js
Show resolved
Hide resolved
| * @param {object|undefined|null} error the error object | ||
| * @returns {boolean} true if the error is retryable | ||
| */ | ||
| static isRetryable (error?: any | null): boolean { |
There was a problem hiding this comment.
I can imagine user code that writes to error.retriable. With this PR the driver starts to basically ignore that field all together (users now have to write to error.retryable to achieve the same behavior). I'm not sure there's a legitimate use-case for such a thing or whether we'd want to support this at all, but it's a subtle breakage worth considering.
There was a problem hiding this comment.
This is true and to some extent a breaking change. However I can't see any real use-case for writing to retriable, and I'm okay with such usage needing to do a small bit of migration since it's a major version release. The alternative would be to still use the value of retriable internally, but then the user would need to use the deprecated member for their code to work, which is worse to me.
There was a problem hiding this comment.
Convinced ✔️
Just make sure that the changelog, migration guide, etc. clearly highlights this subtle breakage.
Co-authored-by: Robsdedude <rouven.bauer@neo4j.com>
deprecates the old isRetriableError and introduces isRetryableError in it's place. also changes internal names with "retriable" to "retryable"