feat(manager): move and update metrics cards in the server view #2241

daniellacosse · 2024-10-14T15:34:32Z

TODOs:

access key tab
localize strings
add api call to server (not finalized)

daniellacosse · 2024-10-16T18:07:38Z

server_manager/www/shadowbox_server.ts

@@ -161,6 +161,28 @@ export class ShadowboxServer implements server.Server {
    return usageMap;
  }

+  async getTunnelTimeByLocation(): Promise<server.TunnelTimeSecondsByLocation> {


This will be implemented once we finalize the endpoint in this PR: Jigsaw-Code/outline-server#1581

fortuna

This is very helpful to see how the API is used. I believe we will benefit a lot from merging the stats flows into one.

server_manager/index.html

server_manager/messages/master_messages.json

server_manager/model/server.ts

server_manager/www/app.ts

daniellacosse

Updated with the new endpoint JSON: will merge methods next

server_manager/messages/master_messages.json

server_manager/www/app.ts

fortuna

As discussed offline, Per-ASN breakdown was a significant gap during the Iran crisis. It's a confirmed need and and we put a lot of effort to implement it. It's more of a question of how, not whether we want to surface that.

I would like to see that surfaced somehow in this PR, to inform the UX design. We've discussed a simple table, which seems to work well.

daniellacosse · 2024-11-15T18:03:30Z

As discussed offline, Per-ASN breakdown was a significant gap during the Iran crisis. It's a confirmed need and and we put a lot of effort to implement it. It's more of a question of how, not whether we want to surface that.

I would like to see that surfaced somehow in this PR, to inform the UX design. We've discussed a simple table, which seems to work well.

Sure thing, working on it!

daniellacosse · 2024-11-15T19:43:22Z

As discussed offline, Per-ASN breakdown was a significant gap during the Iran crisis. It's a confirmed need and and we put a lot of effort to implement it. It's more of a question of how, not whether we want to surface that.

I would like to see that surfaced somehow in this PR, to inform the UX design. We've discussed a simple table, which seems to work well.

Here's an initial PR for a data table component: #2273

server_manager/index.html

server_manager/model/server.ts

fortuna · 2024-12-05T22:38:20Z

server_manager/www/testing/models.ts

@@ -168,6 +168,34 @@ export class FakeServer implements server.Server {
  getDataUsage() {
    return Promise.resolve(new Map<server.AccessKeyId, number>());
  }
+  getServerMetrics() {


Perhaps throw an error instead. The tests should define what to return instead.

Just to be clear - by extending this mock and overriding the method? Or via injection?

On that note, I'd like to see some tests for the 2 scenarios (supported and unsupported), probably in app.spec.ts?

server_manager/www/app.ts

fortuna · 2024-12-05T22:51:24Z

server_manager/www/shadowbox_server.ts

+      );
+
+      return result;
+    } catch (e) {


We shouldn't fall back on every error. We should pick an API based on the server capability.
An improvement would be to fallback only on 404 errors, but that still means two requests for every update call in the non experimental case. It should be one.

We need a mechanism that will allow for a single request on the non experimental case.

One approach would be using streaming requests or websockets, then the 404 would be ok, because it's only once for all updates.
Perhaps we query in the constructor?
Or it comes in the server config?

@sbruens for thoughts

I feel like testing for "experimental features" in the constructor would be the simplest? If an experimental endpoint 404s in the constructor test, set a flag for that endpoint to false. Then we don't have to change the server while minimizing the number of requests in the manager.

Sorry missed this thread until now. Constructor test works for now. 👍

server_manager/messages/master_messages.json

server_manager/index.html

server_manager/www/ui_components/outline-server-view.ts

fortuna · 2024-12-05T23:02:47Z

server_manager/www/ui_components/outline-server-view.ts

+      {
+        icon: 'timer',
+        name: this.localize('server-metrics-user-hours'),
+        units: this.localize('server-metrics-user-hours-unit'),


This is not really how we should be formatting units. Use the standard libraries instead: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#unit_2

I think we need a follow up PR that fixes this and breaks out the units that are baked into the messages (e.g. / last 30 days) as mentioned above. It just needs to be rethought, as I assumed relying on the localizer was enough. I'll make a ticket for it, fair?

Co-authored-by: Vinicius Fortuna <[email protected]>

sbruens · 2024-12-12T18:16:44Z

server_manager/www/app.ts

+
+      let totalUserHours = 0;
+      for (const {tunnelTime} of serverMetrics.server) {
+        // convert to hours


nit: Kind of a pointless comment tbh given the naming of the variables. If it is unclear, prefer to make 60*60 self-documenting, then you won't need the comment. Something like:

const HOUR_IN_SECS = 60 * 60; ... totalUserHours += tunnelTime.seconds / HOUR_IN_SECS;

Ha, I think this comment was provided by Gemini. I'll make it self-documenting.

sbruens · 2024-12-12T18:23:15Z

server_manager/www/shadowbox_server.ts

+      );
+
+      return result;
+    } catch (e) {


Sorry missed this thread until now. Constructor test works for now. 👍

sbruens · 2024-12-12T18:28:17Z

server_manager/www/testing/models.ts

@@ -168,6 +168,34 @@ export class FakeServer implements server.Server {
  getDataUsage() {
    return Promise.resolve(new Map<server.AccessKeyId, number>());
  }
+  getServerMetrics() {


On that note, I'd like to see some tests for the 2 scenarios (supported and unsupported), probably in app.spec.ts?

github-actions bot added size/S size/M and removed size/S labels Oct 14, 2024

daniellacosse commented Oct 16, 2024

View reviewed changes

daniellacosse requested a review from sbruens October 16, 2024 18:07

daniellacosse changed the title ~~feat(manager): move and update metrics cards in the server view~~ feat(manager): [MISSING ENDPOINT] move and update metrics cards in the server view Oct 16, 2024

daniellacosse marked this pull request as ready for review October 16, 2024 18:08

daniellacosse requested review from fortuna and a team as code owners October 16, 2024 18:08

daniellacosse changed the title ~~feat(manager): [MISSING ENDPOINT] move and update metrics cards in the server view~~ feat(manager): [MISSING ENDPOINT - DO NOT MERGE] move and update metrics cards in the server view Oct 16, 2024

fortuna requested changes Oct 30, 2024

View reviewed changes

daniellacosse added 7 commits November 12, 2024 11:08

feat(manager): move and update metrics cards in the server view

90673c3

getting close. trying to figure out this weird data model

51b17e9

style update

4b51e45

don't use reduce lol

8d5d9a5

okay it roughly works end to end

80af4c7

add metrics messages

f30ccc7

access key tab

ee8c388

daniellacosse force-pushed the daniellacosse/tunneltime/move_metrics branch from 55108a4 to ee8c388 Compare November 12, 2024 16:09

update to use new "endpoint" - feedback next

ab29f2c

github-actions bot added size/L and removed size/M labels Nov 12, 2024

daniellacosse commented Nov 12, 2024

View reviewed changes

server_manager/messages/master_messages.json Show resolved Hide resolved

server_manager/messages/master_messages.json Show resolved Hide resolved

server_manager/www/app.ts Outdated Show resolved Hide resolved

feedback

2a6076d

daniellacosse requested a review from fortuna November 12, 2024 18:45

Merge branch 'master' into daniellacosse/tunneltime/move_metrics

23bf19e

fortuna reviewed Nov 15, 2024

View reviewed changes

endpoint implemented

2b1d7da

daniellacosse changed the title ~~feat(manager): [MISSING ENDPOINT - DO NOT MERGE] move and update metrics cards in the server view~~ feat(manager): move and update metrics cards in the server view Nov 21, 2024

daniellacosse requested a review from fortuna December 4, 2024 19:04

fortuna requested changes Dec 5, 2024

View reviewed changes

daniellacosse and others added 3 commits December 9, 2024 17:27

Update server_manager/www/app.ts

a0f32b1

Co-authored-by: Vinicius Fortuna <[email protected]>

Update server_manager/model/server.ts

70c8112

Co-authored-by: Vinicius Fortuna <[email protected]>

partial feedback

fb7f672

daniellacosse requested a review from fortuna December 10, 2024 18:57

sbruens reviewed Dec 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(manager): move and update metrics cards in the server view #2241

feat(manager): move and update metrics cards in the server view #2241

daniellacosse commented Oct 14, 2024 •

edited

Loading

daniellacosse Oct 16, 2024

fortuna left a comment

daniellacosse left a comment

fortuna left a comment

daniellacosse commented Nov 15, 2024

daniellacosse commented Nov 15, 2024

fortuna Dec 5, 2024

daniellacosse Dec 10, 2024 •

edited

Loading

sbruens Dec 12, 2024

fortuna Dec 5, 2024

daniellacosse Dec 10, 2024 •

edited

Loading

sbruens Dec 12, 2024

fortuna Dec 5, 2024

daniellacosse Dec 10, 2024

sbruens Dec 12, 2024

daniellacosse Dec 12, 2024

sbruens Dec 12, 2024

sbruens Dec 12, 2024

feat(manager): move and update metrics cards in the server view #2241

Are you sure you want to change the base?

feat(manager): move and update metrics cards in the server view #2241

Conversation

daniellacosse commented Oct 14, 2024 • edited Loading

Choose a reason for hiding this comment

fortuna left a comment

Choose a reason for hiding this comment

daniellacosse left a comment

Choose a reason for hiding this comment

fortuna left a comment

Choose a reason for hiding this comment

daniellacosse commented Nov 15, 2024

daniellacosse commented Nov 15, 2024

Choose a reason for hiding this comment

daniellacosse Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daniellacosse Dec 10, 2024 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daniellacosse commented Oct 14, 2024 •

edited

Loading

daniellacosse Dec 10, 2024 •

edited

Loading

daniellacosse Dec 10, 2024 •

edited

Loading