feat: Errors handling between Rust and JS #80

fmarek-kindred · 2023-09-18T05:01:31Z

The main ideas:

Throwing error

Rust code should always "throw" some Talos error, in our case all public method are throwing ClientError so, there was no need to do any changes here.
Create simple "napi-managed" enum SdkErrorKind in RS and map its values to ClientError.kind, in our case that is ClientErrorKind.rs enum.
In the napi adapter layer "cohort_sdk_js" declare a simple container class SdkErrorContainer" whose purpose is to collect attributes from ClientError` and make them a) serialisable to JSON b) transferrable to JS layer
When cohort_sdk_js is handling rust error it packs data into SdkErrorContainer, serialises it to json + string and sets into napi::Error.message

Receiving and mapping error

JS caller will receive this error as GenericError with message looking like JSON object.
Introduce cohort_sdk_client JS project which wraps every public service class from cohort_sdk_js. For example, cohort_sdk_js exposes logical service "initiator". We program this service as cohort_sdk_js::InternalInitiator and do not let JS client to use it directly. Instead, we wrap this class into "cohort_sdk_client::Initiator" so that every public method is a delegate with try .. catch. When catching error we catch a normal JS error, use it's message attribute to parse into SdkErrorContainer. Then we re-throw resulting info as "official" TalosSdkError. This is JS class extending JS Error with enum inside it.

The end client only aware of:

cohort_sdk_client as dependency
cohort_sdk_client::Initiator as service class,
cohort_sdk_client::TalosSdkError as error which will be thown from service classes. It has TalosSdkError.kind as SdkErrorKind enum.

cohort_banking_initiator_js/package.json

fmarek-kindred · 2023-09-18T05:25:34Z

cohort_banking_initiator_js/src/banking-app.ts

@@ -25,13 +25,14 @@ export class BankingApp {

    async init() {
        this.initiator = await Initiator.init(sdkConfig)


If kafka is down the error will bubble into main method. There is an example how we can handle typed errors.

fmarek-kindred · 2023-09-18T05:27:24Z

cohort_banking_initiator_js/src/main.ts

@@ -71,6 +111,16 @@ new Promise(async (resolve) => {
        queue,
        fnFinish,
    )
-    await app.init()
+    try {


this is example where caller can deal with specific errors. I skipped else statement here.

fmarek-kindred · 2023-09-18T05:27:54Z

cohort_sdk_client/src/index.ts

+    }
+}
+
+export {


Export only what we allow client to use.

fmarek-kindred · 2023-09-18T05:28:16Z

cohort_sdk_client/src/initiator.ts

+import { isSdkError } from "./internal"
+import { TalosSdkError } from "."
+
+export class Initiator {


Wrapper with error handler.

fmarek-kindred · 2023-09-18T05:29:10Z

cohort_sdk_client/src/internal.ts

@@ -0,0 +1,5 @@
+import { SDK_CONTAINER_TYPE } from "cohort_sdk_js"


The value is managed in the Rust layer.

cohort_sdk_client/src/internal.ts

fmarek-kindred · 2023-09-18T05:31:03Z

packages/cohort_sdk_js/src/initiator/mod.rs

-
-        // println!("Initiator.certify(): after cohort.certify(...)");
-        Ok("Success".to_string())
+        let _res = self.cohort.certify(&make_new_request, &ooo_impl).await.map_err(map_error)?;


That's where we use our error handling and packaging logic.

packages/cohort_sdk_js/src/typed_errors_test.rs

…encies on images.

codecov · 2023-09-18T06:58:37Z

Codecov Report

❗ No coverage uploaded for pull request base (feature/cohort_replicator_js@f261ebf). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head d0bb3dd differs from pull request most recent head d66ea6a. Consider uploading reports for the commit d66ea6a to get more accurate results

Additional details and impacted files

@@                       Coverage Diff                       @@
##             feature/cohort_replicator_js      #80   +/-   ##
===============================================================
  Coverage                                ?   58.16%           
===============================================================
  Files                                   ?      103           
  Lines                                   ?     5314           
  Branches                                ?        0           
===============================================================
  Hits                                    ?     3091           
  Misses                                  ?     2223           
  Partials                                ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…and RS.

* feat: Add wrapper and error handler for Replicator JS. * feat: Add ReplicatorError and map it to JS layer. * fix: Move dev dependencies into relevant section in the package.json

gk-kindred

Nice 👍

* fix: Refactor strucutre to define re-usabe elements. * fix: Move replicator callback traits into callbacks.rs * feat: Add Replicator JS wrapper * feat: Cohort Replicator JS * feat: Use launch parameters to configure runtime settings. * feat: Use i64 when converting numbers from JS to Rust. * chore: Remove unused file. * fix: Use better error handling inside replicator install() * chore: Add logging to Replicator JS * fix: Convert snapshot version to number in JS * feat: Add missing DB migrartions; Organise Makefile commands. (#79) * feat: Errors handling between Rust and JS (#80) * feat: Initial draft for errors handling between Rust and JS * fix: Remove cohort_sdk_js dependency, instead declare optional dependencies on images. * fix: Inject using serde annotation _typ during serialisation into JSON. * fix: Improve error handling when processig callback calls between JS and RS. * feat: Add ReplicatorError and map it to JS layer. (#81) * feat: Add wrapper and error handler for Replicator JS. * feat: Add ReplicatorError and map it to JS layer. * fix: Move dev dependencies into relevant section in the package.json

feat: Initial draft for errors handling between Rust and JS

8a917ae

fmarek-kindred requested a review from anil0906 September 18, 2023 05:22

fmarek-kindred commented Sep 18, 2023

View reviewed changes

cohort_banking_initiator_js/package.json Outdated Show resolved Hide resolved

fmarek-kindred commented Sep 18, 2023

View reviewed changes

cohort_sdk_client/src/index.ts

}

}

export {

Copy link

Contributor Author

fmarek-kindred Sep 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Export only what we allow client to use.

fmarek-kindred commented Sep 18, 2023

View reviewed changes

cohort_sdk_client/src/internal.ts Outdated Show resolved Hide resolved

fmarek-kindred commented Sep 18, 2023

View reviewed changes

packages/cohort_sdk_js/src/typed_errors_test.rs Outdated Show resolved Hide resolved

fix: Remove cohort_sdk_js dependency, instead declare optional depend…

dd2f896

…encies on images.

fmarek-kindred added 2 commits September 19, 2023 12:51

fix: Inject using serde annotation _typ during serialisation into JSON.

fea08e3

fix: Improve error handling when processig callback calls between JS …

734d462

…and RS.

fmarek-kindred requested a review from gk-kindred September 19, 2023 05:17

fmarek-kindred marked this pull request as ready for review September 20, 2023 06:13

feat: Add ReplicatorError and map it to JS layer. (#81)

d66ea6a

* feat: Add wrapper and error handler for Replicator JS. * feat: Add ReplicatorError and map it to JS layer. * fix: Move dev dependencies into relevant section in the package.json

fmarek-kindred changed the title ~~feat: Initial draft for errors handling between Rust and JS~~ feat: Errors handling between Rust and JS Sep 21, 2023

gk-kindred approved these changes Sep 25, 2023

View reviewed changes

fmarek-kindred merged commit 4cecb9f into feature/cohort_replicator_js Sep 25, 2023
2 checks passed

fmarek-kindred deleted the feature/errors_mapping_rust_to_js branch September 25, 2023 05:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Errors handling between Rust and JS #80

feat: Errors handling between Rust and JS #80

fmarek-kindred commented Sep 18, 2023 •

edited

Loading

fmarek-kindred Sep 18, 2023

fmarek-kindred Sep 18, 2023

fmarek-kindred Sep 18, 2023

fmarek-kindred Sep 18, 2023

fmarek-kindred Sep 18, 2023

fmarek-kindred Sep 18, 2023 •

edited

Loading

codecov bot commented Sep 18, 2023 •

edited

Loading

gk-kindred left a comment

		@@ -25,13 +25,14 @@ export class BankingApp {

		async init() {
		this.initiator = await Initiator.init(sdkConfig)

		@@ -0,0 +1,5 @@
		import { SDK_CONTAINER_TYPE } from "cohort_sdk_js"

feat: Errors handling between Rust and JS #80

feat: Errors handling between Rust and JS #80

Conversation

fmarek-kindred commented Sep 18, 2023 • edited Loading

fmarek-kindred Sep 18, 2023

Choose a reason for hiding this comment

fmarek-kindred Sep 18, 2023

Choose a reason for hiding this comment

fmarek-kindred Sep 18, 2023

Choose a reason for hiding this comment

fmarek-kindred Sep 18, 2023

Choose a reason for hiding this comment

fmarek-kindred Sep 18, 2023

Choose a reason for hiding this comment

fmarek-kindred Sep 18, 2023 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Sep 18, 2023 • edited Loading

Codecov Report

gk-kindred left a comment

Choose a reason for hiding this comment

fmarek-kindred commented Sep 18, 2023 •

edited

Loading

fmarek-kindred Sep 18, 2023 •

edited

Loading

codecov bot commented Sep 18, 2023 •

edited

Loading