[Tenscan] health check UI on Tenscan #1719

Jennievon · 2023-12-22T12:18:58Z

Why this change is needed

Please provide a description and a link to the underlying ticket

https://github.com/ten-protocol/ten-internal/issues/2624

What changes were made as part of this PR

Please provide a high level list of the changes made

Health check UI on Tenscan

PR checks pre-merging

Please indicate below by ticking the checkbox that you have read and performed the required
PR checks

PR checks reviewed and performed

coderabbitai · 2023-12-22T12:19:08Z

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The recent updates involve renaming a method in the ObsClient from Health to HealthStatusOfNode, necessitating updates in several call sites across multiple files. Additionally, new functionalities for health status checking were introduced, including a backend method GetHealthStatus, a corresponding web server route and handler, a React component HealthIndicator, a new API route, and a custom React hook useGeneralService to manage fetching and state of the testnet health status.

Changes

File Path	Change Summary
`go/obsclient/obsclient.go`	Renamed `Health` method to `HealthStatusOfNode`.
`integration/.../dev_network.go`, `integration/.../util.go`, `integration/.../socket.go`, `integration/.../simulation.go`, `testnet/.../docker.go`	Updated method calls from `Health` to `HealthStatusOfNode`.
`tools/obscuroscan_v2/backend/obscuroscan_backend.go`	Added `GetHealthStatus` method; method order updated.
`tools/obscuroscan_v2/backend/webserver/.../webserver_routes_items.go`	Added `POST` route and `getHealthStatus` method for health info.
`tools/obscuroscan_v3/frontend/api/general.ts`	Added `fetchTestnetStatus` function.
`tools/obscuroscan_v3/frontend/src/components/health-indicator.tsx`	Introduced `HealthIndicator` component.
`tools/obscuroscan_v3/frontend/src/components/layouts/header.tsx`	Added `HealthIndicator` to `Header`.
`tools/obscuroscan_v3/frontend/src/routes/index.ts`	Added `getHealthStatus` API route.
`tools/obscuroscan_v3/frontend/src/services/useGeneralService.ts`	Introduced `useGeneralService` hook for testnet status.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat with CodeRabbit Bot (`@coderabbitai`)

You can directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
- @coderabbitai read the files in the src/scheduler package and generate README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai · 2023-12-22T12:22:24Z

tools/obscuroscan_v3/frontend/src/services/useGeneralService.ts

+export const useGeneralService = () => {
+  const [noPolling, setNoPolling] = useState(false);
+
+  const {
+    data: testnetStatus,
+    isLoading: isStatusLoading,
+    refetch: refetchTestnetStatus,
+  } = useQuery({
+    queryKey: ["testnetStatus"],
+    queryFn: () => fetchTestnetStatus(),
+    // refetchInterval: noPolling ? false : pollingInterval,
+  });
+
+  return { testnetStatus, isStatusLoading, setNoPolling, refetchTestnetStatus };


The useGeneralService hook is set up to fetch and provide the testnet status. However, the commented out refetchInterval in line 15 suggests there might have been an intention to use polling which is currently not active. If polling is required, ensure that the pollingInterval is defined and uncomment the line.

…nnifer/health-check-ui-on-tenscan

…nnifer/2624-add-a-health-indicator-for-testnet-on-tenscan-and-the-gateway

…scan-and-the-gateway' of https://github.com/ten-protocol/go-ten into jennifer/health-check-ui-on-tenscan

otherview

lgtm - not sure if the error is somehting we want to display ? perhaps not

otherview · 2023-12-29T14:55:28Z

tools/tenscan/frontend/api/general.ts

Can another name be used for this ? Seems to be a bag of holding file.

otherview · 2023-12-29T14:56:39Z

tools/tenscan/frontend/api/general.ts

+export const fetchTestnetStatus = async (): Promise<
+  ResponseDataInterface<any>
+> => {
+  return await httpRequest<ResponseDataInterface<any>>({


Do we do anything with the error ooc ? Should we ?

…nnifer/2624-add-a-health-indicator-for-testnet-on-tenscan-and-the-gateway

…scan-and-the-gateway' of https://github.com/ten-protocol/go-ten into jennifer/health-check-ui-on-tenscan

Jennievon added 3 commits December 21, 2023 16:14

wip: add an endpoint for health check

92d7197

feat: add endpoint for health check

9896ed7

add ui for health check on Tenscan

e8beeee

Jennievon requested review from zkokelj and otherview December 22, 2023 12:18

Jennievon self-assigned this Dec 22, 2023

Jennievon changed the base branch from main to jennifer/2624-add-a-health-indicator-for-testnet-on-tenscan-and-the-gateway December 22, 2023 12:19

coderabbitai bot reviewed Dec 22, 2023

View reviewed changes

Jennievon added 3 commits December 29, 2023 16:14

Merge branch 'main' of https://github.com/ten-protocol/go-ten into je…

e64a7c5

…nnifer/health-check-ui-on-tenscan

Merge branch 'main' of https://github.com/ten-protocol/go-ten into je…

2394bbf

…nnifer/2624-add-a-health-indicator-for-testnet-on-tenscan-and-the-gateway

Merge branch 'jennifer/2624-add-a-health-indicator-for-testnet-on-ten…

e71c46e

…scan-and-the-gateway' of https://github.com/ten-protocol/go-ten into jennifer/health-check-ui-on-tenscan

otherview approved these changes Dec 29, 2023

View reviewed changes

Jennievon added 4 commits December 29, 2023 21:34

Refactor health status method names

ba87900

Merge branch 'main' of https://github.com/ten-protocol/go-ten into je…

6386d90

…nnifer/2624-add-a-health-indicator-for-testnet-on-tenscan-and-the-gateway

Refactor health check function calls

d87f71a

Merge branch 'jennifer/2624-add-a-health-indicator-for-testnet-on-ten…

1e681f3

…scan-and-the-gateway' of https://github.com/ten-protocol/go-ten into jennifer/health-check-ui-on-tenscan

Base automatically changed from jennifer/2624-add-a-health-indicator-for-testnet-on-tenscan-and-the-gateway to main January 8, 2024 07:19

Jennievon merged commit 3daec73 into main Jan 8, 2024
1 check passed

Jennievon deleted the jennifer/health-check-ui-on-tenscan branch January 8, 2024 07:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tenscan] health check UI on Tenscan #1719

[Tenscan] health check UI on Tenscan #1719

Jennievon commented Dec 22, 2023

coderabbitai bot commented Dec 22, 2023 •

edited

Loading

Auto Review Skipped

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot Dec 22, 2023

otherview left a comment

otherview Dec 29, 2023

otherview Dec 29, 2023

[Tenscan] health check UI on Tenscan #1719

[Tenscan] health check UI on Tenscan #1719

Conversation

Jennievon commented Dec 22, 2023

Why this change is needed

What changes were made as part of this PR

PR checks pre-merging

coderabbitai bot commented Dec 22, 2023 • edited Loading

Auto Review Skipped

Walkthrough

Changes

Chat with CodeRabbit Bot (@coderabbitai)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot Dec 22, 2023

Choose a reason for hiding this comment

otherview left a comment

Choose a reason for hiding this comment

otherview Dec 29, 2023

Choose a reason for hiding this comment

otherview Dec 29, 2023

Choose a reason for hiding this comment

coderabbitai bot commented Dec 22, 2023 •

edited

Loading

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Configration File (`.coderabbit.yaml`)