feat(cactus-cmd-gui-app): add common cacti gui app #2265

ervvkb · 2023-01-13T13:00:36Z

Add GUI app to visualize ledger data stored in supabase by persistence plugins

Closes: feat(cactus-cmd-gui-app): add common cacti gui app #2264
Depends on: feat(cactus-plugin-persistence-ethereum): add new persistence plugin #2259

Signed-off-by: Eryk Baranowski [email protected]

jagpreetsinghsasan

Reviewed, looks good to me.

izuru0

LGTM

petermetz

@ervvkb I'm guessing these non-existent file paths need to be removed from the tsconfig.json file (or the non-existent files to be added but I'd prefer keeping this already large PR at it's current or smaller size rather than growing it TBH)

petermetz · 2023-01-31T21:38:06Z

tsconfig.json

@@ -73,6 +76,9 @@
    {
      "path": "./packages/cactus-verifier-client/tsconfig.json"
    },
+    {
+      "path": "./packages/cactus-plugin-persistence-ethereum/tsconfig.json"


@ervvkb This file does not exist on the main branch, nor in your PR diff. Was this added by mistake?

Resolving because now I know that the parent PR has this in it's diff.

petermetz · 2023-01-31T21:38:13Z

tsconfig.json

@@ -127,6 +133,9 @@
    {
      "path": "./examples/cactus-example-discounted-asset-trade/tsconfig.json"
    },
+    {
+      "path": "./examples/cactus-example-fujitsu-microfinance/tsconfig.json"


@ervvkb This file does not exist on the main branch, nor in your PR diff. Was this added by mistake?

I removed the path to microfinance, the second path is correct, it just wasn't merged before uploading the gui

I removed the path to microfinance, the second path is correct, it just wasn't merged before uploading the gui

@ervvkb Got it, thank you! Now in order to make it a little easier to review the large diff, please re-organize the commits the same way I explained it here in this other PR as well: #2331 (review)

petermetz

@ervvkb Please see #2265 (comment)

-Add GUI app to visualize ledger data stored in supabase by persistence plugins Closes: hyperledger-cacti#2264 Depends on: hyperledger-cacti#2259 Signed-off-by: Eryk Baranowski [email protected]

…rledger ledger data stored in supabase by persistence plugins Depends on: hyperledger-cacti#2265 Depends on: hyperledger-cacti#2331 Signed-off-by: Barnaba Pawelczak [email protected]

petermetz · 2023-06-02T01:03:30Z

Suggested edit:

diff --git a/packages/cactus-cmd-gui-app/package.json b/packages/cactus-cmd-gui-app/package.json
index f2ef238cf..9b08c3ad1 100644
--- a/packages/cactus-cmd-gui-app/package.json
+++ b/packages/cactus-cmd-gui-app/package.json
@@ -1,27 +1,27 @@
 {
-  "name": "@hyperledger/cactus-cmd-gui-app",
-  "version": "1.1.3",
-  "description": "Cactus GUI for visualizing ledger data.",
+  "name": "@hyperledger/cacti-cmd-gui-app",
+  "version": "2.0.0-alpha.1",
+  "description": "Cacti GUI for visualizing ledger data.",
   "keywords": [
     "Hyperledger",
-    "Cactus",
+    "Cacti",
     "Integration",
     "Blockchain",
     "Distributed Ledger Technology"
   ],
-  "homepage": "https://github.com/hyperledger/cactus#readme",
+  "homepage": "https://github.com/hyperledger/cacti#readme",
   "bugs": {
-    "url": "https://github.com/hyperledger/cactus/issues"
+    "url": "https://github.com/hyperledger/cacti/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/hyperledger/cactus.git"
+    "url": "git+https://github.com/hyperledger/cacti.git"
   },
   "license": "Apache-2.0",
   "author": {
-    "name": "Hyperledger Cactus Contributors",
-    "email": "[email protected]",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "name": "Hyperledger Cacti Contributors",
+    "email": "[email protected]",
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {

petermetz

@ervvkb Please see my comments above and also the suggestions I made to the package.json file.

petermetz · 2023-06-02T01:05:45Z

packages/cactus-cmd-gui-app/README.md

+
+## Remarks
+
+- Plugin requires running Supabase and persistence plugins in order to properly view ledger data.


@ervvkb Would it be possible to include shell commands here on how to get that done as well? Ideally the steps that can be executed in order and then have the whole thing working.

I see that there is a "Usage" section already but it keeps it vague by saying "use this and that image" and "set this paramtere to the "correct" value" (I'm guessing it's self-evident what is the correct value if you have experience like you do, but to others that may be less helpful to just say "set it to the correct value")

It is also fine if you do it later, but then I'll ask that you create a specific issue in the tracker for it with a title something like docs(cmd-gui-app): add usage guide to README

petermetz · 2023-06-02T01:09:40Z

packages/cactus-cmd-gui-app/README.md

+In the root of the project, execute the command to install and build the dependencies. It will also build this GUI front-end component:
+
+```sh
+yarn run build
+```
+


@ervvkb The build command will only perform the build but won't install the dependencies AFAICT so I'd recommend having the configure script or a yarn install here as well.

The easiest way to double check if your documentation is accurate is by running the steps one by one yourself and then seeing if/where it fails. (boring but often yields great results in terms of figuring out that some commands were missing that newcomers will immediately get stuck on as they are trying to use the code)

petermetz · 2023-06-02T01:11:43Z

packages/cactus-cmd-gui-app/README.md

+
+## Getting Started
+
+Clone the git repository on your local machine. Follow these instructions that will get you a copy of the project up and running on your local machine for development and testing purposes.


@ervvkb Can this not be used directly from npm via installing it to another project as a dependency? If the only way that this can be used is by copy pasting the source code of the framework then I'd call it an example rather than an actual reusable component of the framework.

If it CAN be used out of the box as an npm install into another project then please make sure to document how that can be done exactly as well (maybe you already did and I'm just not seeing it - sorry if this is the case)

1. Add a new plugin for storing hyperledger fabric ledger data into a database 2. Add functional tests for plugin and data access layer operations. operating with fabric-all-in-one docker composition Tests assume any postgres database, but for final deployment postgres or supabase is assumed. Data fed by this plugin can later be visualized by a GUI application or analyzed directly. ( right now the GUI will have switch to operate either with Ethereum ledger or Fabric ledger ) Also upgrade ts-node in the rood package.json because it was causing crashes for the scripts in the ./tools/ directory (such as the webpack bundle name validator script) Depends on: hyperledger-cacti#2259 Depends on: hyperledger-cacti#2265 Co-authored-by: Peter Somogyvari <[email protected]> Signed-off-by: Barnaba Pawełczak <[email protected]> Signed-off-by: Peter Somogyvari <[email protected]>

1. Add a new plugin for storing hyperledger fabric ledger data into a database 2. Add functional tests for plugin and data access layer operations. operating with fabric-all-in-one docker composition Tests assume any postgres database, but for final deployment postgres or supabase is assumed. Data fed by this plugin can later be visualized by a GUI application or analyzed directly. ( right now the GUI will have switch to operate either with Ethereum ledger or Fabric ledger ) Also upgrade ts-node in the rood package.json because it was causing crashes for the scripts in the ./tools/ directory (such as the webpack bundle name validator script) Depends on: #2259 Depends on: #2265 Co-authored-by: Peter Somogyvari <[email protected]> Signed-off-by: Barnaba Pawełczak <[email protected]> Signed-off-by: Peter Somogyvari <[email protected]>

1. Add a new plugin for storing hyperledger fabric ledger data into a database 2. Add functional tests for plugin and data access layer operations. operating with fabric-all-in-one docker composition Tests assume any postgres database, but for final deployment postgres or supabase is assumed. Data fed by this plugin can later be visualized by a GUI application or analyzed directly. ( right now the GUI will have switch to operate either with Ethereum ledger or Fabric ledger ) Also upgrade ts-node in the rood package.json because it was causing crashes for the scripts in the ./tools/ directory (such as the webpack bundle name validator script) Depends on: hyperledger-cacti#2259 Depends on: hyperledger-cacti#2265 Co-authored-by: Peter Somogyvari <[email protected]> Signed-off-by: Barnaba Pawełczak <[email protected]> Signed-off-by: Peter Somogyvari <[email protected]>

…rledger ledger data stored in supabase by persistence plugins Depends on: hyperledger-cacti#2265 Depends on: hyperledger-cacti#2331 Signed-off-by: Barnaba Pawelczak [email protected]

petermetz

@ervvkb Are you still working on this?

ervvkb · 2023-09-03T20:26:14Z

@ervvkb Are you still working on this?

I was transfered to another project couple months ago, so nope, thought someone took care of it

petermetz · 2023-09-08T22:49:25Z

@ervvkb Are you still working on this?

I was transfered to another project couple months ago, so nope, thought someone took care of it

@ervvkb Please let us know next time so that we don't waste hours reviewing a pull request that was abandoned?

outSH · 2023-09-11T08:44:06Z

@petermetz This was merged as part of #2363, I did not catch that this PR is still open - sorry for confusion

petermetz · 2024-02-01T03:42:42Z

@petermetz This was merged as part of #2363, I did not catch that this PR is still open - sorry for confusion

@outSH No worries! I'm sorry for the slow response! :-)

ervvkb requested review from petermetz, takeutak, izuru0, jagpreetsinghsasan and sandeepnRES as code owners January 13, 2023 13:00

jagpreetsinghsasan approved these changes Jan 16, 2023

View reviewed changes

izuru0 approved these changes Jan 18, 2023

View reviewed changes

petermetz requested changes Jan 31, 2023

View reviewed changes

ervvkb requested a review from VRamakrishna as a code owner March 13, 2023 16:27

ervvkb force-pushed the cmd-gui-app branch from 40c569f to e18c622 Compare March 13, 2023 16:29

This was referenced Mar 16, 2023

feat(cactus-plugin-persistence-fabric): add new persistence plugin for fabric ledger #2328

Closed

feat(cactus-plugin-persistence-fabric): add new persistence plugin for fabric ledger #2329

Closed

This was referenced Mar 20, 2023

feat(cactus-plugin-persistence-fabric): add new persistence plugin for fabric ledger #2330

Closed

feat(plugin-persistence-fabric): add new fabric persistence plugin #2331

Merged

petermetz requested changes Mar 28, 2023

View reviewed changes

barnapa mentioned this pull request Apr 3, 2023

feat(cactus-cmd-gui-app): extend common cacti gui app to operate with fabric hyperledger #2363

Merged

ervvkb force-pushed the cmd-gui-app branch from e18c622 to d5c8b2e Compare April 5, 2023 13:04

feat(cactus-cmd-gui-app): add common cacti gui app

da9ddac

-Add GUI app to visualize ledger data stored in supabase by persistence plugins Closes: hyperledger-cacti#2264 Depends on: hyperledger-cacti#2259 Signed-off-by: Eryk Baranowski [email protected]

ryjones force-pushed the cmd-gui-app branch from d5c8b2e to da9ddac Compare April 7, 2023 17:50

ervvkb requested a review from petermetz April 21, 2023 10:02

petermetz requested changes Jun 2, 2023

View reviewed changes

petermetz reviewed Aug 31, 2023

View reviewed changes

petermetz closed this Sep 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cactus-cmd-gui-app): add common cacti gui app #2265

feat(cactus-cmd-gui-app): add common cacti gui app #2265

ervvkb commented Jan 13, 2023 •

edited

Loading

jagpreetsinghsasan left a comment

izuru0 left a comment

petermetz left a comment

petermetz Jan 31, 2023

petermetz Mar 28, 2023

petermetz Jan 31, 2023

ervvkb Mar 15, 2023

petermetz Mar 28, 2023

petermetz left a comment

petermetz commented Jun 2, 2023

petermetz left a comment

petermetz Jun 2, 2023

petermetz Jun 2, 2023

petermetz Jun 2, 2023

petermetz left a comment

ervvkb commented Sep 3, 2023

petermetz commented Sep 8, 2023

outSH commented Sep 11, 2023

petermetz commented Feb 1, 2024


		## Remarks

		- Plugin requires running Supabase and persistence plugins in order to properly view ledger data.


		## Getting Started

		Clone the git repository on your local machine. Follow these instructions that will get you a copy of the project up and running on your local machine for development and testing purposes.

feat(cactus-cmd-gui-app): add common cacti gui app #2265

feat(cactus-cmd-gui-app): add common cacti gui app #2265

Conversation

ervvkb commented Jan 13, 2023 • edited Loading

jagpreetsinghsasan left a comment

Choose a reason for hiding this comment

izuru0 left a comment

Choose a reason for hiding this comment

petermetz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petermetz left a comment

Choose a reason for hiding this comment

petermetz commented Jun 2, 2023

petermetz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petermetz left a comment

Choose a reason for hiding this comment

ervvkb commented Sep 3, 2023

petermetz commented Sep 8, 2023

outSH commented Sep 11, 2023

petermetz commented Feb 1, 2024

ervvkb commented Jan 13, 2023 •

edited

Loading