Activity Log backend and WebUI #110

bajtos · 2022-09-08T10:41:36Z

feat: add ActivityLog backend
feat: record ActivityLog entries

See #81

main/activity-log.js

main/index.js

main/saturn-node.js

main/typings.d.ts

renderer/src/main.tsx

main/activity-log.js

bajtos · 2022-09-08T14:04:24Z

The PR is ready for final review.

bajtos · 2022-09-08T14:06:24Z

@juliangruber Do you have any opinions on testing the renderer integration?

Ideally, we should have end-to-end tests to verify that window.electron.getActivityLog() and ndow.electron.onActivityLogged work correctly. On the other hand, writing and maintaining e2e tests comes with extra overhead, I am not sure if it's a good ROI at this stage of our project.

bajtos · 2022-09-08T14:13:58Z

@juliangruber Do you have any opinions on testing the renderer integration?

Ideally, we should have end-to-end tests to verify that window.electron.getActivityLog() and ndow.electron.onActivityLogged work correctly. On the other hand, writing and maintaining e2e tests comes with extra overhead, I am not sure if it's a good ROI at this stage of our project.

To keep iterating fast, if we decide to add e2e tests, then I am proposing to do so in a follow-up pull request.

juliangruber · 2022-09-09T07:37:33Z

@juliangruber Do you have any opinions on testing the renderer integration?

Ideally, we should have end-to-end tests to verify that window.electron.getActivityLog() and ndow.electron.onActivityLogged work correctly. On the other hand, writing and maintaining e2e tests comes with extra overhead, I am not sure if it's a good ROI at this stage of our project.

From my perspective we don't need tests for this at this stage. If anything we could start with IPC level tests, before looking at testing DOM results. And +1 to implementing both later.

main/activity-log.js

main/index.js

main/saturn-node.js

main/typings.d.ts

main/index.js

main/ui.js

Signed-off-by: Miroslav Bajtoš <[email protected]>

- When the Station starts/stops - When the Saturn Module starts/stops - INFO & ERROR logs from Saturn Signed-off-by: Miroslav Bajtoš <[email protected]>

Signed-off-by: Miroslav Bajtoš <[email protected]>

renderer/src/main.tsx

juliangruber

see review comments above

* prototype activity log layout * fix types * refactor types * refactor names * refactor variable names * fix sorting bug * docs

Signed-off-by: Miroslav Bajtoš <[email protected]>

Co-authored-by: Julian Gruber <[email protected]> Signed-off-by: Miroslav Bajtoš <[email protected]>

Co-authored-by: Julian Gruber <[email protected]>

Signed-off-by: Miroslav Bajtoš <[email protected]> Co-authored-by: Julian Gruber <[email protected]>

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos · 2022-09-15T13:18:34Z

We did a pair programming session with @juliangruber today and brought the PR to the finish line.

@ronaldofs @jopedroliveira We implemented a simple ActivityLog component that's consuming backend API and rendering a list of events. See renderer/src/components/ActivityLog.tsx and renderer/src/App.tsx. I hope this will make it super easy for you to integrate our changes.

Feel free to rework both App.tsx and ActivityLog.tsx in any way you like. Our code is just a minimal working example to demonstrate that the backend integration is working.

main/activity-log.js

bajtos requested a review from juliangruber September 8, 2022 10:42

juliangruber reviewed Sep 8, 2022

View reviewed changes

main/activity-log.js Outdated Show resolved Hide resolved

main/activity-log.js Outdated Show resolved Hide resolved

main/activity-log.js Outdated Show resolved Hide resolved

main/activity-log.js Outdated Show resolved Hide resolved

juliangruber reviewed Sep 8, 2022

View reviewed changes

main/activity-log.js Outdated Show resolved Hide resolved

main/activity-log.js Outdated Show resolved Hide resolved

main/index.js Show resolved Hide resolved

main/saturn-node.js Show resolved Hide resolved

bajtos commented Sep 8, 2022

View reviewed changes

main/typings.d.ts Outdated Show resolved Hide resolved

bajtos commented Sep 8, 2022

View reviewed changes

renderer/src/main.tsx Outdated Show resolved Hide resolved

bajtos commented Sep 8, 2022

View reviewed changes

main/activity-log.js Outdated Show resolved Hide resolved

bajtos marked this pull request as ready for review September 8, 2022 14:00

bajtos requested a review from juliangruber September 8, 2022 14:03

bajtos force-pushed the feat-activity-log-backend branch from 73f67eb to c90fd5e Compare September 8, 2022 14:04

juliangruber suggested changes Sep 9, 2022

View reviewed changes

bajtos added 10 commits September 13, 2022 10:21

feat: add ActivityLog backend

45d9eb0

Signed-off-by: Miroslav Bajtoš <[email protected]>

feat: record ActivityLog entries

733f4e2

- When the Station starts/stops - When the Saturn Module starts/stops - INFO & ERROR logs from Saturn Signed-off-by: Miroslav Bajtoš <[email protected]>

feat: expose ActivityLog to renderer

ac0abd9

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! address Julian comments

aad1f6e

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! use String(val) instead of '' + val

780b762

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! remove unused clone()

610e8cf

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! import types via JSDoc

3e97d6a

Signed-off-by: Miroslav Bajtoš <[email protected]>

feat: limit ActivityLog size to 100 items

4b8ddab

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! remove forgotten console log

0359412

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! add more typedefs

4fd20c4

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos force-pushed the feat-activity-log-backend branch from c90fd5e to 4fd20c4 Compare September 13, 2022 08:31

bajtos added 3 commits September 13, 2022 10:34

fixup! extract isDev variable

d6eb214

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! fix deregistration of the IPC listener

3271350

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! rework activity streaming to renderer

7e2dcad

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos requested a review from juliangruber September 13, 2022 08:55

bajtos commented Sep 13, 2022

View reviewed changes

renderer/src/main.tsx Outdated Show resolved Hide resolved

Merge branch 'main' into feat-activity-log-backend

0aaa890

juliangruber suggested changes Sep 13, 2022

View reviewed changes

juliangruber mentioned this pull request Sep 14, 2022

Refactor activity log types #127

Merged

juliangruber and others added 3 commits September 15, 2022 13:18

Refactor activity log types (#127)

d8e010f

* prototype activity log layout * fix types * refactor types * refactor names * refactor variable names * fix sorting bug * docs

fix: fix eslint issue in tests

cf3e3f1

Signed-off-by: Miroslav Bajtoš <[email protected]>

refactor: with Julian

cde1d46

Co-authored-by: Julian Gruber <[email protected]> Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos force-pushed the feat-activity-log-backend branch from d3fe20c to cde1d46 Compare September 15, 2022 12:00

bajtos and others added 4 commits September 15, 2022 14:34

feat: renderer integration & component

cd4157d

Co-authored-by: Julian Gruber <[email protected]>

fixup! more tweaks

6bff5be

Signed-off-by: Miroslav Bajtoš <[email protected]> Co-authored-by: Julian Gruber <[email protected]>

Merge branch 'main' into feat-activity-log-backend

3259737

fixup! fix store loading and tests

739b4a6

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos requested a review from juliangruber September 15, 2022 13:15

bajtos requested a review from ronaldofs September 15, 2022 13:18

bajtos commented Sep 15, 2022

View reviewed changes

main/activity-log.js Show resolved Hide resolved

bajtos enabled auto-merge (squash) September 15, 2022 13:25

juliangruber approved these changes Sep 15, 2022

View reviewed changes

bajtos merged commit 7fca41b into main Sep 15, 2022

bajtos deleted the feat-activity-log-backend branch September 15, 2022 13:59

bajtos changed the title ~~Activity Log backend~~ Activity Log backend and WebUI Sep 15, 2022

bajtos mentioned this pull request Sep 15, 2022

Expose stats & events from L2-node to WebUI #81

Closed

5 tasks

Activity Log backend and WebUI #110

Activity Log backend and WebUI #110

Uh oh!

Conversation

bajtos commented Sep 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bajtos commented Sep 8, 2022

Uh oh!

bajtos commented Sep 8, 2022

Uh oh!

bajtos commented Sep 8, 2022

Uh oh!

juliangruber commented Sep 9, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

juliangruber left a comment

Choose a reason for hiding this comment

Uh oh!

bajtos commented Sep 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bajtos commented Sep 8, 2022 •

edited

Loading

bajtos commented Sep 15, 2022 •

edited

Loading