Create foundation for a controller status history view #1402

kiahna-tucker · 2024-12-16T22:24:33Z

Issues

The issues directly below are advanced by this PR:
#1377

Changes

1377

The following features are included in this PR:

Create an environment variable for the base /status endpoint URL.
Add a declaration file for control-plane types relevant to the /status endpoint.
Add a Status section to the Logs tab of the Details page which serves as the foundation for comprehensive entity status view.
Update the shared CardWrapper component to support a headerless display.

Tests

Manually tested

scenarios you manually tested

Automated tests

unit testing covered

Playwright tests ran locally

Screenshots

Initialization

Hydration failed | Error returned by /status endpoint

pr_screenshot-1402-entity_status_foundation-error-hydration

Post-Initialization

Dashboard view

pr_screenshot-1402-entity_status_foundation-success-history

Code view

pr_screenshot-1402-entity_status_foundation-success-code

No controller status history returned by /status endpoint

pr_screenshot-1402-entity_status_foundation-success-no_history

Updating the view via the Refresh CTA | Table View

…status-history

travjenkins · 2025-01-15T18:43:37Z

src/components/shared/Entity/Details/Logs/Status/Overview/DetailWrapper.tsx

+                {intl.formatMessage({ id: headerMessageId })}
+            </Typography>
+
+            {Hydrating ?? children}


Whenever there is a capitalized props like Hydrating I assume it takes in a functional component and used like

<Hydrating {...whatever props you might need}/>

In this scenario it looks like all 3 uses of this are passing in a skeleton with different sizes. I think we should just pass in the sizing they want and then this component itself can handle checking hydration.

deps/control-plane/types.d.ts

travjenkins · 2025-01-15T18:47:12Z

src/api/entityStatus.ts

+    accessToken: string,
+    catalogName: string
+): Promise<EntityStatusResponse[]> =>
+    client(`${entityStatusBaseEndpoint}?name=${catalogName}`, {}, accessToken);


I think probably best to do it here - but we need to make sure catalogName is safe / escaped. Normally we have used escapeReservedCharacters but that is really for PostgREST so not 100% sure what we wanna do here.

src/components/shared/Entity/Details/Logs/Status/Overview/AutoDiscoveryStatus.tsx

travjenkins · 2025-01-16T19:57:54Z

src/components/shared/Entity/Details/Logs/Status/Overview/SectionUpdated.tsx

+                                timestamp: `${lastUpdated.toLocaleString({
+                                    hour: '2-digit',
+                                    minute: '2-digit',
+                                    second: '2-digit',
+                                    timeZoneName: 'short',
+                                })}, ${lastUpdated.toLocaleString({
+                                    day: '2-digit',
+                                    month: '2-digit',
+                                    year: 'numeric',
+                                })}`,


Can we split out the settings used to "translate" these so they can be shared?

travjenkins · 2025-01-16T20:07:27Z

src/components/shared/Entity/Details/Logs/Status/StatusResponseViewer.tsx

+                    defaultLanguage="json"
+                    height={EDITOR_HEIGHT}
+                    onMount={(
+                        editor: monacoEditor.editor.IStandaloneCodeEditor
+                    ) => {
+                        logRocketConsole('handlers:mount');
+                        editorRef.current = editor;
+                    }}
+                    options={{
+                        readOnly: true,
+                        minimap: {
+                            enabled: false,
+                        },
+                    }}
+                    path={
+                        hasLength(response.catalog_name)
+                            ? response.catalog_name
+                            : 'preset_status_path'
+                    }
+                    saveViewState={false}
+                    theme={theme.palette.mode === 'light' ? 'vs' : 'vs-dark'}
+                    value={stringifyJSON(response)}
+                />


Sometime we should make a shard "default props" kinda thing for editor

Agreed. I had a similar thought when I created this component.

travjenkins · 2025-01-16T20:15:45Z

src/components/tables/ControllerStatusHistory/Rows.tsx

+            {row.detail ? (
+                <ControllerStatus detail={row.detail} status={row.result} />
+            ) : (
+                <TableCell />
+            )}
+
+            {row.created ? (
+                <TimeStamp enableExact time={row.created} />
+            ) : (
+                <TableCell />
+            )}
+
+            {row.completed ? (
+                <TimeStamp enableExact time={row.completed} />
+            ) : (
+                <TableCell />
+            )}


This is really interesting... our tables (and all the "helper" functions/components) really are focused on tables with data that is always there.

src/components/tables/ControllerStatusHistory/index.tsx

…status-history

kiahna-tucker · 2025-01-14T13:25:33Z

src/components/tables/cells/entityStatus/ControllerStatus/StatusIndicator.tsx

The desired entity status UI and UX is still largely up-in-the-air. Nevertheless, it is worth noting that this status indicator component resembles that used in the entity status overview cards. There is a chance the latter may diverge widely enough that is does not make sense to try to share code but, presently, I believe that is unlikely.

kiahna-tucker · 2025-01-14T13:29:25Z

src/context/Theme.tsx

This file has grown to a point where it would be worthwhile to reassess its organization and whether it should be broken apart.

kiahna-tucker · 2025-01-14T13:55:18Z

src/components/tables/cells/entityStatus/ControllerErrors/index.tsx

The component and broad UX is, effectively, temporary. It was the fastest means to surface the errors that correspond to an individual controller event presented in the table.

src/components/shared/Entity/Details/Logs/Status/Overview/AutoDiscoveryStatus.tsx

src/utils/entityStatus-utils.ts

travjenkins · 2025-01-16T20:37:46Z

src/utils/env-utils.ts

Adding this new URL brings me a thought... we should eventually review all the env props and make a decision on which ones are mandatory.

I know people are not running Estuary on their own but it would be nice to have that all set up just in case.

travjenkins

lgtm

left some notes and comments but do not see anything that is a blocker.

travjenkins

lgtm

…status-history

Create foundation for a controller status history view

a60b508

kiahna-tucker added the change:planned This is a planned change label Dec 16, 2024

kiahna-tucker added 28 commits December 16, 2024 17:40

Rename Details table column to Event

515ed8f

Correct styling of ControllerErrors when no errors exist

728c9d6

Move control-plane related types into deps/control-plane

01bfec6

Move getEntityStatus into a file within src/api

02ec799

Merge branch 'main' into kiahna-tucker/entity-status/init-controller-…

4fb88cd

…status-history

Move controller status history table cells into entityStatus directory

34a4fc1

Update format of /status request URL

b40b47b

Update /status response URL and associated types

eb1873c

Create a foundation for controller status overview component

fb0cff7

Create foundation for auto-discovery status overview component

048f618

Merge branch 'main' into kiahna-tucker/entity-status/init-controller-…

9a96839

…status-history

Rename EntityStatusResponse.status to controller_status

3172ab0

Move component-defined colors to theme

f9986c9

Hide auto-discovery overview for non-captures

d8e77c5

Add refresh cta to status section

0250ebe

Toggle between dashboard and code views

9d17a18

Display time the endpoint was last successfully reached

09ec67a

Remove superfluous padding on SectionUpdated

edeec18

Replace response store state with computed value

d1c750d

Identify loading view state using computed value

e70c8f7

Reset entity status store state when details page unmounts

6fab387

Remove logging statements

436c508

Create production env variable for base entity status url

d314ea7

Update status section styling

62787e2

Update the overview card style

70ef39a

Update auto discovery failure timestamp

fb22211

Distinguish between loading and hydrating states

33fdaa4

Display server error

78840b7

kiahna-tucker added 3 commits January 14, 2025 08:51

Address a handful of nits

531b353

Add log rocket events

ac3b0d9

Hide section for non-support users

b317aa6

kiahna-tucker requested a review from travjenkins January 14, 2025 14:13

Merge branch 'main' into kiahna-tucker/entity-status/init-controller-…

87ed464

…status-history

kiahna-tucker marked this pull request as ready for review January 14, 2025 14:14

kiahna-tucker requested a review from a team as a code owner January 14, 2025 14:14

kiahna-tucker requested a review from psFried January 14, 2025 16:02

travjenkins reviewed Jan 15, 2025

View reviewed changes

deps/control-plane/types.d.ts Outdated Show resolved Hide resolved

travjenkins reviewed Jan 15, 2025

View reviewed changes

Move control-plane types from deps/ to src/types/

648a999

travjenkins reviewed Jan 16, 2025

View reviewed changes

src/components/shared/Entity/Details/Logs/Status/Overview/AutoDiscoveryStatus.tsx Show resolved Hide resolved

travjenkins reviewed Jan 16, 2025

View reviewed changes

src/components/tables/ControllerStatusHistory/index.tsx Outdated Show resolved Hide resolved

Merge branch 'main' into kiahna-tucker/entity-status/init-controller-…

b336ecc

…status-history

kiahna-tucker commented Jan 16, 2025

View reviewed changes

travjenkins reviewed Jan 16, 2025

View reviewed changes

src/utils/entityStatus-utils.ts Outdated Show resolved Hide resolved

travjenkins reviewed Jan 16, 2025

View reviewed changes

travjenkins approved these changes Jan 16, 2025

View reviewed changes

kiahna-tucker added 3 commits January 17, 2025 08:37

Replace temp number formatting util with readable

9f0f7d1

Set active during hydration only when store is not hydrated

06af24e

Remove optional controller status history table column code

5c70228

kiahna-tucker mentioned this pull request Jan 17, 2025

Refactor a subset of entity status-related code #1423

Open

travjenkins approved these changes Jan 17, 2025

View reviewed changes

Merge branch 'main' into kiahna-tucker/entity-status/init-controller-…

6dedc93

…status-history

travjenkins merged commit 6327adc into main Jan 21, 2025
3 checks passed

travjenkins deleted the kiahna-tucker/entity-status/init-controller-status-history branch January 21, 2025 16:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create foundation for a controller status history view #1402

Create foundation for a controller status history view #1402

kiahna-tucker commented Dec 16, 2024 •

edited

Loading

travjenkins Jan 15, 2025

travjenkins Jan 15, 2025

travjenkins Jan 16, 2025

travjenkins Jan 16, 2025

kiahna-tucker Jan 16, 2025 •

edited

Loading

travjenkins Jan 16, 2025

kiahna-tucker Jan 14, 2025

kiahna-tucker Jan 14, 2025

kiahna-tucker Jan 14, 2025

travjenkins Jan 16, 2025

travjenkins left a comment

travjenkins left a comment

Create foundation for a controller status history view #1402

Create foundation for a controller status history view #1402

Conversation

kiahna-tucker commented Dec 16, 2024 • edited Loading

Issues

Changes

1377

Tests

Manually tested

Automated tests

Playwright tests ran locally

Screenshots

Initialization

Post-Initialization

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

kiahna-tucker Jan 16, 2025 • edited Loading

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

travjenkins left a comment

Choose a reason for hiding this comment

travjenkins left a comment

Choose a reason for hiding this comment

kiahna-tucker commented Dec 16, 2024 •

edited

Loading

kiahna-tucker Jan 16, 2025 •

edited

Loading