style(examples): 2021-09-20 linter warnings batch 17 / 26; part 2

[adrianbatuto]

1. Added a user-defined type guard to check for BambooHarvest types
   on the front-end.
2. Additional runtime type checks during data type conversion so that
   if we get invalid input it speaks up against it specifically instead of
   using any types and generic crashes.

Fixes #2092

Co-authored-by: Peter Somogyvari peter.somogyvari@accenture.com

Signed-off-by: adrianbatuto adrian.batuto@accenture.com
Signed-off-by: Peter Somogyvari peter.somogyvari@accenture.com

[jagpreetsinghsasan]

@adrianbatuto thankyou for the PR !
I would suggest you to squash merge the commits into 1, alongside proper PR description and commit title & description. For reference: #2272 (you can check the PR description and the commit title & description in this PR).

[adrianbatuto]

@adrianbatuto thankyou for the PR ! I would suggest you to squash merge the commits into 1, alongside proper PR description and commit title & description. For reference: #2272 (you can check the PR description and the commit title & description in this PR).

Thanks @jagpreetsinghsasan. I have made some updates to the pr.

[petermetz]

Suggested edit:

diff --git a/examples/cactus-example-supply-chain-business-logic-plugin/src/main/typescript/model/converter/bamboo-harvest-converter.ts b/examples/cactus-example-supply-chain-business-logic-plugin/src/main/typescript/model/converter/bamboo-harvest-converter.ts
index 7aa858086..0b2981a63 100644
--- a/examples/cactus-example-supply-chain-business-logic-plugin/src/main/typescript/model/converter/bamboo-harvest-converter.ts
+++ b/examples/cactus-example-supply-chain-business-logic-plugin/src/main/typescript/model/converter/bamboo-harvest-converter.ts
@@ -1,4 +1,5 @@
 import { BambooHarvest } from "../../generated/openapi/typescript-axios";
+import { RuntimeError } from 'run-time-error';
 
 /**
  * Responsible for converting model entities such as the `BambooHarvest` to and
@@ -22,9 +23,21 @@ export class BambooHarvestConverter {
    * `BambooHarvest` model entity.
    */
   public static ofSolidityStruct(arr: unknown[]): BambooHarvest {
+    const id = arr[BambooHarvestConverter.SOLIDITY_FIELD_ID];
+    if (typeof id !== "string") {
+      const errMsg = `Expected the value of arr[${BambooHarvestConverter.SOLIDITY_FIELD_ID}] to be a string`;
+      throw new RuntimeError(errMsg);
+    }
+
+    const location = arr[BambooHarvestConverter.SOLIDITY_FIELD_LOCATION];
+    if (typeof location !== "string") {
+      const errMsg = `Expected the value of arr[${BambooHarvestConverter.SOLIDITY_FIELD_LOCATION}] to be a string`;
+      throw new RuntimeError(errMsg);
+    }
+
     return {
-      id: arr[BambooHarvestConverter.SOLIDITY_FIELD_ID] as string,
-      location: arr[BambooHarvestConverter.SOLIDITY_FIELD_LOCATION] as string,
+      id,
+      location,
       startedAt: arr[
         BambooHarvestConverter.SOLIDITY_FIELD_STARTED_AT
       ] as string,

[petermetz]

Please see my suggestion and make sure to apply the same logic for the rest of the fields e.g. these below:

startedAt: arr[
        BambooHarvestConverter.SOLIDITY_FIELD_STARTED_AT
      ] as string,
      endedAt: arr[BambooHarvestConverter.SOLIDITY_FIELD_ENDED_AT] as string,
      harvester: arr[BambooHarvestConverter.SOLIDITY_FIELD_HARVESTER] as string,

[petermetz]

@adrianbatuto I added a couple more comments here, please see above.

[petermetz]

@adrianbatuto See my comments above please

[petermetz]

@adrianbatuto nvm, I pushed some fixes just now so that we can get this over the line ASAP. Apart from my comments above the other thing that I changed is that I moved the user-defined type guard to it's own code-file and exported it so that it can be re-used elsewhere.