feat: add example for using javascript SDK #832

JeffreyDallas · 2024-11-14T20:07:01Z

Description

This pull request changes the following:

Changes to Taskfile.yaml

Fix the issue of node name starting from node0 instead of node1
Remove installation task per user suggest, since user may already installed own tool chains even not enabled in search path, should not force to install again
Add relay deploy and destroy task
Add port-forward tasks

Added a unit test to instantiate SDK client to interact with solo

Added SDK.md about how to use Hedera Javascript SDK with solo

https://github.com/hashgraph/solo/blob/00816-D-client-doc-example/docs/content/User/SDK.md

By using environment variable OPERATOR_ID and OPERATOR_KEY, end user can start
running SDK examples immediately after deploying solo.

Related Issues

Closes Create instructions on how to create expose ports necessary to create an SDK connection to both the Consenus Nodes plus the Mirror Node #816

github-actions · 2024-11-14T20:10:31Z

Unit Test Results - Windows

1 files ±0 36 suites ±0 13s ⏱️ -1s
109 tests ±0 109 ✅ ±0 0 💤 ±0 0 ❌ ±0
118 runs ±0 118 ✅ ±0 0 💤 ±0 0 ❌ ±0

Results for commit f01c890. ± Comparison against base commit 5e1c652.

♻️ This comment has been updated with latest results.

github-actions · 2024-11-14T21:36:15Z

Unit Test Results - Linux

1 files ±0 36 suites ±0 3s ⏱️ -2s
109 tests ±0 109 ✅ ±0 0 💤 ±0 0 ❌ ±0
118 runs ±0 118 ✅ ±0 0 💤 ±0 0 ❌ ±0

Results for commit f01c890. ± Comparison against base commit 5e1c652.

♻️ This comment has been updated with latest results.

github-actions · 2024-11-18T21:41:02Z

E2E Test Report

16 files 110 suites 1h 2m 57s ⏱️
213 tests 213 ✅ 0 💤 0 ❌
216 runs 216 ✅ 0 💤 0 ❌

Results for commit cf3a6a9.

github-actions · 2024-11-18T21:41:02Z

E2E Test Report

16 files 110 suites 1h 18m 9s ⏱️
233 tests 233 ✅ 0 💤 0 ❌
236 runs 236 ✅ 0 💤 0 ❌

Results for commit cc19979.

♻️ This comment has been updated with latest results.

codacy-production · 2024-11-18T21:41:16Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for `7fa86ad`¹	✅ 95.24%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`7fa86ad`)	Report Missing	Report Missing	Report Missing
Head commit (`cc19979`)	14339	12536	87.43%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#832)	21	20	95.24%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct. ↩

codecov · 2024-11-18T21:42:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.28%. Comparing base (b66fe05) to head (cf3a6a9).
Report is 65 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #832      +/-   ##
==========================================
- Coverage   87.09%   86.28%   -0.82%     
==========================================
  Files          40       43       +3     
  Lines       12545    13580    +1035     
  Branches      944     1339     +395     
==========================================
+ Hits        10926    11717     +791     
- Misses       1568     1734     +166     
- Partials       51      129      +78

Files with missing lines	Coverage Δ
src/commands/account.ts	`76.06% <100.00%> (+0.57%)`	⬆️
src/commands/flags.ts	`99.53% <100.00%> (+0.04%)`	⬆️
src/commands/relay.ts	`82.69% <100.00%> (+0.92%)`	⬆️
version.ts	`100.00% <100.00%> (ø)`

... and 22 files with indirect coverage changes

---- 🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

Signed-off-by: Jeffrey Tang <[email protected]>

Signed-off-by: Jeromy Cannon <[email protected]>

mishomihov00

Reviewed only these files:
.github/workflows/flow-task-test.yaml
.github/workflows/zxc-e2e-test.yaml

jeromy-cannon · 2024-11-21T09:55:28Z

Is this ready for review? you have it in open status and not draft status. You also have a lot of merge conflicts.

…client-doc-example Signed-off-by: Jeffrey Tang <[email protected]> # Conflicts: # src/commands/account.ts # test/e2e/commands/account.test.ts

JeffreyDallas · 2024-11-21T19:56:35Z

Is this ready for review? you have it in open status and not draft status. You also have a lot of merge conflicts.

ready for review

.github/workflows/script/solo_smoke_test.sh

tsconfig.json

.github/workflows/script/solo_smoke_test.sh

Signed-off-by: Jeffrey Tang <[email protected]>

JeffreyDallas · 2024-11-22T17:28:17Z

I remove the smoke test from workflow

.github/workflows/script/relay_smoke_test.sh

## [0.32.0](v0.31.1...v0.32.0) (2024-12-31) ### ⚠ BREAKING CHANGES * update readme with warning about BREAKING CHANGE in this next release (#730) ### Features * add ci test flow to test task command to launch solo ([#811](#811)) ([356f341](356f341)) * add example for using javascript SDK ([#832](#832)) ([1d9452e](1d9452e)) * add extended math utils and duration support ([#923](#923)) ([f5a69e7](f5a69e7)) * add separate commands for update ([#735](#735)) ([44c3132](44c3132)) * add solo smoke test to test flow ([#905](#905)) ([79410f0](79410f0)) * add support for flexible lease acquisition and production readiness ([#830](#830)) ([7fa86ad](7fa86ad)) * Add the ability to inject a ca certificate for use in gRPC and gRPC Web ([#753](#753)) ([2cd8a38](2cd8a38)) * add timeout flag to network destroy command ([#821](#821)) ([0fb570b](0fb570b)) * allow settings a reserved static IP address for the consensus nodes HAProxy and Envoy Proxy though the cli with flags ([#937](#937)) ([de9ec2e](de9ec2e)) * change mirror node and explorer from subchart to individual chart ([#743](#743)) ([58f0496](58f0496)) * Create a local config for storing configurations on the users machine ([#803](#803)) ([0a4382d](0a4382d)) * Create remote config ([#862](#862)) ([e8fe739](e8fe739)) * dynamically construct the genesis-network.json and add it to the values file to be used during network deploy ([#982](#982)) ([1b9b7e6](1b9b7e6)) * expose pod check attempts and delays as environment controlled variables ([#812](#812)) ([a7b3279](a7b3279)) * Implement IOC ([#1010](#1010)) ([ed23a7b](ed23a7b)) * Implement solo context connect ([#863](#863)) ([782b3ec](782b3ec)) * Increase helm chart version and switch to use oci registry ([#788](#788)) ([1973275](1973275)) * **k8s:** introduce Kubernetes lease lock mechanism ([#707](#707)) ([f1b8089](f1b8089)) * new command to save state files and upload state files ([#849](#849)) ([d5a9a18](d5a9a18)) * removed caching of ConfigManager and its flags ([#713](#713)) ([76a61e3](76a61e3)) * Setup mirror node monitor pinger service ([#893](#893)) ([f4c4320](f4c4320)) * update `solo context connect` to connect to single remote cluster ([#993](#993)) ([c9711c5](c9711c5)) * Update document ([#956](#956)) ([b378937](b378937)) * update readme and hugo workflow ([#930](#930)) ([0e08abc](0e08abc)) * Validate a remote config ([#922](#922)) ([a7bbae0](a7bbae0)) ### Bug Fixes * add delay before calling script ([#955](#955)) ([76f4b81](76f4b81)) * allow expired leases to be overwritten ([#828](#828)) ([1fa1d78](1fa1d78)) * bump chart and hedera version, re-enable node add ([#985](#985)) ([9cae011](9cae011)) * check if setup chart installed or not before network deploy ([#799](#799)) ([6930dab](6930dab)) * document typo ([#988](#988)) ([8e4fe04](8e4fe04)) * Error in `node update` separate commands when new admin key is not supplied ([#854](#854)) ([6e472b5](6e472b5)) * Examples of performance configs for HashSphere and Latitude ([#926](#926)) ([#957](#957)) ([928148b](928148b)) * fix missing file issues when running solo from npm install -g ([#736](#736)) ([2a5cfc1](2a5cfc1)) * fixed genesis-network.json file lock issue ([#1074](#1074)) ([e590516](e590516)) * flag check of node logs command and incorrect download source ([#848](#848)) ([03051f0](03051f0)) * inconsistent failures ([#866](#866)) ([13ea46d](13ea46d)) * local chart directory not being taken correctly ([#983](#983)) ([58e96e1](58e96e1)) * nextNode ID for release version > 0.56.0 ([#765](#765)) ([3b98dd6](3b98dd6)) * node id should start from `1` ([#884](#884)) ([d90c9b5](d90c9b5)) * node update with single node ([#981](#981)) ([74285bf](74285bf)) * patch issue with dist folder not showing up ([#733](#733)) ([077f989](077f989)) * performance improvements for node stop ([#986](#986)) ([437bbc6](437bbc6)) * refactored Taskfiles, fixed bugs with taskfile, lease interval, sdk node client connection, and commands missing quiet flag ([#978](#978)) ([7bb0e99](7bb0e99)) * remote config validation not working ([#967](#967)) ([88c2506](88c2506)) * resolve node update test failures ([#856](#856)) ([5e1c652](5e1c652)) * Revised example configs for Latitude deployment, automation friendly ([#1038](#1038)) ([434daf3](434daf3)) * undefined log output of namespace ([#764](#764)) ([ac15957](ac15957)) ### Documentation * update readme with warning about BREAKING CHANGE in this next release ([#730](#730)) ([06295f6](06295f6))

swirlds-automation · 2024-12-31T21:30:59Z

🎉 This PR is included in version 0.32.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

JeffreyDallas requested review from a team and leninmehedy as code owners November 14, 2024 20:07

JeffreyDallas requested a review from dalvizu November 14, 2024 20:07

JeffreyDallas marked this pull request as draft November 14, 2024 20:07

JeffreyDallas changed the title ~~00816 d client doc example~~ feat: update workflow to test relay node, add example for using javascript SDK Nov 14, 2024

jeromy-cannon assigned JeffreyDallas Nov 19, 2024

JeffreyDallas added 15 commits November 19, 2024 10:54

add test sdk client

db835ea

Signed-off-by: Jeffrey Tang <[email protected]>

save

b37203a

Signed-off-by: Jeffrey Tang <[email protected]>

Fix account test

f2fca67

Signed-off-by: Jeffrey Tang <[email protected]>

add steps to launch solo network

c78dbb8

Signed-off-by: Jeffrey Tang <[email protected]>

fix relay test

8599657

Signed-off-by: Jeffrey Tang <[email protected]>

fix change background traffic without using watch command

00eef83

Signed-off-by: Jeffrey Tang <[email protected]>

change local node version

84d52bd

Signed-off-by: Jeffrey Tang <[email protected]>

add step for using sdk sample

4370b50

Signed-off-by: Jeffrey Tang <[email protected]>

update relay test flow

9169373

Signed-off-by: Jeffrey Tang <[email protected]>

add clean port forward

8f79b5b

Signed-off-by: Jeffrey Tang <[email protected]>

add sdk test

d6cc4d4

Signed-off-by: Jeffrey Tang <[email protected]>

change script name

75474db

Signed-off-by: Jeffrey Tang <[email protected]>

check port forwarding

6ed3be0

Signed-off-by: Jeffrey Tang <[email protected]>

fix task command

3bb7aaa

Signed-off-by: Jeffrey Tang <[email protected]>

fix namespace

ca48359

Signed-off-by: Jeffrey Tang <[email protected]>

JeffreyDallas and others added 2 commits November 19, 2024 09:27

Fix private key extraction

da5daa5

Signed-off-by: Jeffrey Tang <[email protected]>

add solo network connection example

96d06c6

Signed-off-by: Jeromy Cannon <[email protected]>

JeffreyDallas marked this pull request as ready for review November 20, 2024 20:37

mishomihov00 previously approved these changes Nov 21, 2024

View reviewed changes

Merge commit '7fa86ad19c66d2ea98d4d10b0400b1635499c322' into 00816-D-…

cc19979

…client-doc-example Signed-off-by: Jeffrey Tang <[email protected]> # Conflicts: # src/commands/account.ts # test/e2e/commands/account.test.ts

JeffreyDallas dismissed mishomihov00’s stale review via cc19979 November 21, 2024 15:39

jeromy-cannon reviewed Nov 22, 2024

View reviewed changes

.github/workflows/script/solo_smoke_test.sh Outdated Show resolved Hide resolved