docs(examples/supply-chain): fix yarn --no-lockfile

Primary Changes --------------- 1. Removed examples/supply-chain-app/package.json and moved the other files to cactus-example-supply -chain-backend 2. Updated the docs to match the updated path of the supply-chain-app files to cactus-example-supply- chain-backend and the new steps on how run the latest supply chain app 3. Updated the code responses in connector-fabric from null to (0) based on the logs and responses while running the application. 4. Added a parse.int for shelfCount in bookshelf- converter because it requires a number but instead the value becomes a string before it is submitted. Fixes hyperledger-cacti#2721 Signed-off-by: aldousalvarez <[email protected]>
aldousalvarez · Jan 30, 2024 · db3fe87 · db3fe87
1 parent 73ff593
commit db3fe87
Show file tree

Hide file tree

Showing 21 changed files with 91 additions and 141 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -2187,7 +2187,7 @@ jobs:
     steps:
       - uses: actions/[email protected]
       - name: ghcr.io/hyperledger/cactus-example-supply-chain-app
-        run: DOCKER_BUILDKIT=1 docker build . -f ./examples/supply-chain-app/Dockerfile -t cactus-example-supply-chain-app
+        run: DOCKER_BUILDKIT=1 docker build . -f ./examples/cactus-example-supply-chain-backend/Dockerfile -t cactus-example-supply-chain-app
       - name: Run Trivy vulnerability scan for cactus-example-supply-chain-app
         uses: aquasecurity/[email protected]
         with:

diff --git a/.github/workflows/example-supply-chain-app-publish.yaml b/.github/workflows/example-supply-chain-app-publish.yaml
@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-20.04
     env:
       DOCKER_BUILDKIT: 1
-      DOCKERFILE_PATH: ./examples/supply-chain-app/Dockerfile
+      DOCKERFILE_PATH: ./examples/cactus-example-supply-chain-backend/Dockerfile
       DOCKER_BUILD_DIR: ./
     permissions:
       packages: write

diff --git a/.vscode/template.launch.json b/.vscode/template.launch.json
@@ -60,7 +60,7 @@
       ],
       "console": "integratedTerminal",
       "sourceMaps": true,
-      "cwd": "${workspaceFolder}/examples/supply-chain-app/",
+      "cwd": "${workspaceFolder}/examples/cactus-example-supply-chain-backend/",
       "outFiles": [
         "${workspaceFolder}/**/*.js",
         "!**/node_modules/**"

diff --git a/docs-cactus/source/examples/supply-chain-app.md b/docs-cactus/source/examples/supply-chain-app.md
@@ -1,3 +1,3 @@
-```{include} ../../../examples/supply-chain-app/README.md
+```{include} ../../../examples/cactus-example-supply-chain-backend/README.md
 :relative-images:
 ```
diff --git a/docs/docs/cactus/examples/supply-chain-app.md b/docs/docs/cactus/examples/supply-chain-app.md
@@ -5,7 +5,7 @@ Usage
 --------------------------------------------
 
 1.  Execute the following from:
-    
+
     docker run \\
       \--rm \\
       \--privileged \\
@@ -16,25 +16,25 @@ Usage
       \-p 4100:4100 \\
       \-p 4200:4200 \\
       ghcr.io/hyperledger/cactus-example-supply-chain-app:2022-04-05--feat-1579
-    
+
 2.  Observe the example application pulling up in the logs
-    
+
     1.  the test ledger containers,
-        
+
     2.  a test consortium with multiple members and their Cactus nodes
-        
+
 3.  Wait for the output to show the message `INFO (api-server): Cactus Cockpit reachable http://0.0.0.0:3200`
-    
+
 4.  Visit http://0.0.0.0:3200 in your web browser with Javascript enabled
-    
+
 
 Building and running the container locally
 ----------------------------------------------------------------------------------------------------------------------
 
 \# Change directories to the project root
 
 \# Build the docker image and tag it as "scaeb" for supply chain app example backend
-DOCKER\_BUILDKIT\=1 docker build \-f ./examples/supply-chain-app/Dockerfile . \-t scaeb
+DOCKER\_BUILDKIT\=1 docker build \-f ./examples/cactus-example-supply-chain-backend/Dockerfile . \-t scaeb
 
 \# Run the built image with ports mapped to the host machine as you see fit
 \# The --privileged flag is required because we use Docker-in-Docker for pulling
@@ -47,7 +47,7 @@ Building the image with a specific npm package version:
 
 DOCKER\_BUILDKIT\=1 docker build \\
   \--build-arg NPM\_PKG\_VERSION\=jwt-supply-chain \\
-  \--file ./examples/supply-chain-app/Dockerfile \\
+  \--file ./examples/cactus-example-supply-chain-backend/Dockerfile \\
   \--tag scaeb \\
   ./
 
@@ -58,70 +58,70 @@ Running the Example Application Locally
 
 On the terminal, issue the following commands:
 
-1.  `npm run install-yarn`
-    
-2.  `yarn configure`
-    
+1.  `npm run enable-corepack`
+
+2.  `yarn run configure`
+
 3.  `yarn start:example-supply-chain`
-    
+
 
 Debugging the Example Application Locally
 --------------------------------------------------------------------------------------------------------------------
 
 On the terminal, issue the following commands (steps 1 to 6) and then perform the rest of the steps manually.
 
-1.  `npm run install-yarn`
-    
+1.  `npm run enable-corepack`
+
 2.  `yarn configure`
-    
+
 3.  `yarn build:dev`
-    
-4.  `cd ./examples/supply-chain-app/`
-    
-5.  `yarn --no-lockfile`
-    
+
+4.  `cd ./examples/cactus-example-supply-chain-backend/`
+
+5.  `yarn install`
+
 6.  `cd ../../`
-    
+
 7.  Locate the `.vscode/template.launch.json` file
-    
+
 8.  Within that file locate the entry named `"Example: Supply Chain App"`
-    
+
 9.  Copy the VSCode debug definition object from 2) to your `.vscode/launch.json` file
-    
+
 10.  At this point the VSCode `Run and Debug` panel on the left should have an option also titled `"Example: Supply Chain App"` which starts the application
-    
+
 11.  When the application finishes loading, the JWT token generated is displayed on the terminal
-    
+
 12.  Visit http://localhost:3200 in a web browser with Javascript enabled and insert the token when prompted
-    
+
 
 Live Reloading the GUI Application
 ------------------------------------------------------------------------------------------------------
 
-1.  `npm run install-yarn`
-    
+1.  `npm run enable-corepack`
+
 2.  `yarn configure`
-    
+
 3.  `yarn build:dev`
-    
+
 4.  Locate the `.vscode/template.launch.json` file
-    
+
 5.  Within that file locate the entry named `"Example: Supply Chain App"`
-    
+
 6.  Copy the VSCode debug definition object from 2) to your `.vscode/launch.json` file
-    
+
 7.  At this point the VSCode `Run and Debug` panel on the left should have an option also titled `"Example: Supply Chain App"` which starts the application
-    
+
 8.  `cd ./examples/cactus-example-supply-chain-frontend/`
-    
+
 9.  `yarn serve:proxy`
-    
+
 10.  When the application finishes loading, the JWT token generated is displayed on the terminal
-    
+
 11.  Visit http://localhost:8000 in a web browser with Javascript enabled and insert the token when prompted
-    
+
 12.  At this point if you modify the source code of the GUI application under the `./examples/cactus-example-supply-chain-frontend/` path it will automatically reload the browser window (you will need to paste in the JWT again when this happens)
-    
+
 
 [Previous](../examples.md "Examples") [Next](../governance.md "Governance")
 

diff --git a/examples/supply-chain-app/.dockerignore → ...xample-supply-chain-backend/.dockerignore b/examples/supply-chain-app/.dockerignore → ...xample-supply-chain-backend/.dockerignore
@@ -39,7 +39,7 @@ coverage/
 # Introperability App specifics
 examples/simple-asset-transfer/fabric/**/hfc-key-store/
 
-examples/supply-chain-app/Dockerfile
+examples/cactus-example-supply-chain-backend/Dockerfile
 
 bin/
 .tmp/

diff --git a/examples/supply-chain-app/Dockerfile → ...s-example-supply-chain-backend/Dockerfile b/examples/supply-chain-app/Dockerfile → ...s-example-supply-chain-backend/Dockerfile
@@ -43,7 +43,7 @@ RUN source ~/.bashrc && \
 SHELL ["/bin/bash", "--login", "-c"]
 
 
-COPY --chown=${APP_USER}:${APP_USER} ./examples/supply-chain-app/healthcheck.sh /
+COPY --chown=${APP_USER}:${APP_USER} ./examples/cactus-example-supply-chain-backend/healthcheck.sh /
 
 ENV AUTHORIZATION_CONFIG_JSON="{}"
 ENV AUTHORIZATION_PROTOCOL=NONE
@@ -67,7 +67,7 @@ ENV API_PORT=4000
 ENV GRPC_TLS_ENABLED=false
 ENV LOG_LEVEL=TRACE
 
-COPY examples/supply-chain-app/supervisord.conf /etc/supervisord.conf
+COPY examples/cactus-example-supply-chain-backend/supervisord.conf /etc/supervisord.conf
 
 # supervisord web ui/dashboard
 EXPOSE 9001
@@ -91,4 +91,4 @@ USER root
 ENTRYPOINT ["/usr/bin/supervisord"]
 CMD ["--configuration", "/etc/supervisord.conf", "--nodaemon"]
 HEALTHCHECK --interval=1s --timeout=5s --start-period=20s --retries=250 \
-    CMD /usr/src/app/examples/supply-chain-app/healthcheck.sh
+    CMD /usr/src/app/examples/cactus-example-supply-chain-backend/healthcheck.sh
diff --git a/examples/supply-chain-app/README.md → ...us-example-supply-chain-backend/README.md b/examples/supply-chain-app/README.md → ...us-example-supply-chain-backend/README.md
@@ -28,7 +28,7 @@
 # Change directories to the project root
 
 # Build the docker image and tag it as "scaeb" for supply chain app example backend
-DOCKER_BUILDKIT=1 docker build -f ./examples/supply-chain-app/Dockerfile . -t scaeb
+DOCKER_BUILDKIT=1 docker build -f ./examples/cactus-example-supply-chain-backend/Dockerfile . -t scaeb
 
 # Run the built image with ports mapped to the host machine as you see fit
 # The --privileged flag is required because we use Docker-in-Docker for pulling
@@ -43,7 +43,7 @@ Building the image with a specific npm package version:
 ```sh
 DOCKER_BUILDKIT=1 docker build \
   --build-arg NPM_PKG_VERSION=jwt-supply-chain \
-  --file ./examples/supply-chain-app/Dockerfile \
+  --file ./examples/cactus-example-supply-chain-backend/Dockerfile \
   --tag scaeb \
   ./
 ```
@@ -63,10 +63,10 @@ On the terminal, issue the following commands:
 On the terminal, issue the following commands (steps 1 to 6) and then perform the rest of the steps manually.
 
 1. `npm run enable-corepack`
-2. `npm run configure`
+2. `yarn run configure`
 3. `yarn build:dev`
-4. `cd ./examples/supply-chain-app/`
-5. `yarn --no-lockfile`
+4. `cd ./examples/cactus-example-supply-chain-backend/`
+5. `yarn install`
 6. `cd ../../`
 7. Locate the `.vscode/template.launch.json` file
 8. Within that file locate the entry named `"Example: Supply Chain App"`

diff --git a/examples/supply-chain-app/healthcheck.sh → ...ample-supply-chain-backend/healthcheck.sh b/examples/supply-chain-app/healthcheck.sh → ...ample-supply-chain-backend/healthcheck.sh
diff --git a/examples/cactus-example-supply-chain-backend/package.json b/examples/cactus-example-supply-chain-backend/package.json
@@ -43,6 +43,8 @@
     "dist/*"
   ],
   "scripts": {
+    "start": "node -r dotenv/config dist/lib/main/typescript/supply-chain-app-cli.js dotenv_config_path=process.env",
+    "start-direct": "node ./node_modules/@hyperledger/cactus-example-supply-chain-backend/dist/lib/main/typescript/supply-chain-app-cli.js",
     "watch": "npm-watch",
     "webpack": "npm-run-all webpack:dev",
     "webpack:dev": "npm-run-all webpack:dev:node webpack:dev:web",

diff --git a/examples/supply-chain-app/process.env → ...-example-supply-chain-backend/process.env b/examples/supply-chain-app/process.env → ...-example-supply-chain-backend/process.env
diff --git a/examples/cactus-example-supply-chain-backend/src/main/solidity/BambooHarvestRepository.sol b/examples/cactus-example-supply-chain-backend/src/main/solidity/BambooHarvestRepository.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
-pragma solidity ^0.7.0;
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import { SupplyChainAppDataModelLib as model } from "./SupplyChainAppDataModel.sol";

diff --git a/examples/cactus-example-supply-chain-backend/src/main/solidity/BookshelfRepository .sol b/examples/cactus-example-supply-chain-backend/src/main/solidity/BookshelfRepository .sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
-pragma solidity ^0.7.0;
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import { SupplyChainAppDataModelLib as model } from "./SupplyChainAppDataModel.sol";

diff --git a/examples/supply-chain-app/supervisord.conf → ...ple-supply-chain-backend/supervisord.conf b/examples/supply-chain-app/supervisord.conf → ...ple-supply-chain-backend/supervisord.conf
@@ -13,7 +13,7 @@ stderr_logfile=/usr/src/app/log/dockerd.err.log
 stdout_logfile=/usr/src/app/log/dockerd.out.log
 
 [program:supply-chain-app]
-command=/home/appuser/.nvm/versions/node/v16.8.0/bin/node /usr/src/app/node_modules/@hyperledger/cactus-example-supply-chain-backend/dist/lib/main/typescript/supply-chain-app-cli.js
+command=/home/appuser/.nvm/versions/node/v16.14.2/bin/node /usr/src/app/node_modules/@hyperledger/cactus-example-supply-chain-backend/dist/lib/main/typescript/supply-chain-app-cli.js
 autostart=true
 autorestart=unexpected
 startretries=20

diff --git a/...ly-chain-business-logic-plugin/src/main/typescript/model/converter/bookshelf-converter.ts b/...ly-chain-business-logic-plugin/src/main/typescript/model/converter/bookshelf-converter.ts
@@ -26,7 +26,10 @@ export class BookshelfConverter {
       const errMsg = `Expected the value of arr[${BookshelfConverter.SOLIDITY_FIELD_ID}] to be a string`;
       throw new RuntimeError(errMsg);
     }
-    const shelfCount = arr[BookshelfConverter.SOLIDITY_FIELD_SHELF_COUNT];
+    const shelfCountStr = arr[
+      BookshelfConverter.SOLIDITY_FIELD_SHELF_COUNT
+    ] as string;
+    const shelfCount = parseInt(shelfCountStr, 10);
     if (typeof shelfCount !== "number") {
       const errMsg = `Expected the value of arr[${BookshelfConverter.SOLIDITY_FIELD_SHELF_COUNT}] to be a number`;
       throw new RuntimeError(errMsg);

diff --git a/examples/cactus-example-supply-chain-frontend/angular.json b/examples/cactus-example-supply-chain-frontend/angular.json
@@ -88,13 +88,15 @@
         "serve": {
           "builder": "@angular-devkit/build-angular:dev-server",
           "options": {
-            "browserTarget": "app:build"
+            "browserTarget": "app:build",
+            "proxyConfig": "proxy.conf.json"
           },
           "configurations": {
             "production": {
               "browserTarget": "app:build:production"
             },
             "ci": {
+
             }
           }
         },
@@ -176,9 +178,7 @@
     }
   },
   "cli": {
-    "schematicCollections": [
-      "@ionic/angular-toolkit"
-    ],
+    "schematicCollections": ["@ionic/angular-toolkit"],
     "analytics": false
   },
   "schematics": {

diff --git a/examples/supply-chain-app/package.json b/examples/supply-chain-app/package.json