camunda-external-task-client-js - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0-alpha1

docs/Client.md

@@ -137,2 +137,16 @@ # `Client`
 * `client.on("lock:success", function(task) {})`
-* `client.on("lock:error", function(task, error) {})`
+* `client.on("lock:error", function(task, error) {})`
+
+### Error
+
+The error object exposes the response body of the REST API request and has the following properties:
+
+| Property       | Description                                                                                                                        | Type   |
+|----------------|------------------------------------------------------------------------------------------------------------------------------------|--------|
+| message        | A summary of the error, e.g., `Response code 400 (Bad Request); Error: my engine error; Type: ProcessEngineException; Code: 33333` | string |
+| httpStatusCode | The HTTP status code returned by the REST API, e.g., `400`                                                                         | number |
+| engineMsg      | The engine error message, e.g., `my engine error`                                                                                  | string |
+| type           | The class name of the exception, e.g., `ProcessEngineException`                                                                    | string |
+| code           | A numeric exception error code, e.g., `33333`.                                                                                     | number |
+
+You can find more information about the exception error code feature in the [Camunda Platform 7 Documentation](https://docs.camunda.org/manual/latest/user-guide/process-engine/error-handling/#exception-codes).

docs/Variables.md

 # Variables
 ```js
-const { Variables } = require("camunda-external-task-handler-js");
+const { Variables } = require("camunda-external-task-client-js");
 
@@ -5,0 +5,0 @@ // ... somewhere in the handler function

lib/__internal/EngineError.js

@@ -34,14 +34,18 @@ /*
     const { response, options } = httpError;
-    let error, type;
 
-    if (response.body && response.body.message && response.body.type) {
-      error = response.body.message;
-      type = response.body.type;
-    } else {
-      error = response.body;
-      type = "undefined";
+    let responseBody = null;
+    try {
+      responseBody = JSON.parse(response.body);
+    } catch (e) {
+      responseBody = response.body;
     }
 
+    const { message, type, code } = responseBody;
+
     super(
-      `Response code ${response.statusCode} (${response.statusMessage}); Error: ${error}; Type: ${type}`,
+      `Response code ${response.statusCode} (${
+        response.statusMessage
+      }); Error: ${
+        message ? message : responseBody
+      }; Type: ${type}; Code: ${code}`,
       {},
@@ -52,5 +56,18 @@ options
 
-    Object.defineProperty(this, "response", {
-      enumerable: false,
-      value: response
+    Object.defineProperties(this, {
+      response: {
+        value: response
+      },
+      httpStatusCode: {
+        value: response.statusCode
+      },
+      code: {
+        value: code
+      },
+      type: {
+        value: type
+      },
+      engineMsg: {
+        value: message
+      }
     });
@@ -57,0 +74,0 @@ }

lib/__internal/EngineError.test.js

@@ -26,3 +26,7 @@ /*
       {
-        body: { type: "SomeExceptionClass", message: "a detailed message" },
+        body: {
+          type: "SomeExceptionClass",
+          message: "a detailed message",
+          code: 33333
+        },
         statusCode: 400,
@@ -34,3 +38,3 @@ statusMessage: "Bad request"
     const expectedPayload =
-      "Response code 400 (Bad request); Error: a detailed message; Type: SomeExceptionClass";
+      "Response code 400 (Bad request); Error: a detailed message; Type: SomeExceptionClass; Code: 33333";
 
@@ -42,2 +46,6 @@ //when
     expect(engineError.message).toEqual(expectedPayload);
+    expect(engineError.engineMsg).toEqual("a detailed message");
+    expect(engineError.code).toEqual(33333);
+    expect(engineError.type).toEqual("SomeExceptionClass");
+    expect(engineError.httpStatusCode).toEqual(400);
   });
@@ -56,3 +64,3 @@
     const expectedPayload =
-      "Response code 400 (Bad request); Error: Some unexpected error message; Type: undefined";
+      "Response code 400 (Bad request); Error: Some unexpected error message; Type: undefined; Code: undefined";
 
@@ -63,4 +71,7 @@ //when
     //then
+    expect(engineError.httpStatusCode).toEqual(400);
     expect(engineError.message).toEqual(expectedPayload);
+    expect(engineError.code).toBeUndefined();
+    expect(engineError.type).toBeUndefined();
   });
 });

lib/__internal/EngineService.test.js

@@ -230,3 +230,7 @@ /*
         {
-          body: { type: "SomeExceptionClass", message: "a detailed message" },
+          body: {
+            type: "SomeExceptionClass",
+            message: "a detailed message",
+            code: 33333
+          },
           statusCode: 400,
@@ -233,0 +237,0 @@ statusMessage: "Bad request"

package.json

 {
-  "version": "2.2.0",
+  "version": "2.3.0-alpha1",
   "name": "camunda-external-task-client-js",
@@ -4,0 +4,0 @@ "main": "index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

600872

increased by159.48%

Number of package files

80

increased by48.15%

Lines of code

4154

increased by22.61%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes