Show installation progress #3338

ycombinator · 2023-08-30T20:06:40Z

What does this PR do?

This PR enhances elastic-agent install to show users the progress of the installation.

Before this PR

before.mov

After this PR

after.mov

Why is it important?

So users know installation is proceeding and not stalled.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
~~I have made corresponding changes to the documentation~~
~~I have made corresponding change to the default configuration files~~
I have added tests that prove my fix is effective or that my feature works
I have added an entry in ./changelog/fragments using the changelog tool
~~I have added an integration test or an E2E test~~

elasticmachine · 2023-08-30T20:34:43Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2023-09-07T21:38:00.579+0000
Duration: 29 min 49 sec

Test stats 🧪

Test	Results
Failed	0
Passed	6277
Skipped	55
Total	6332

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages.
run integration tests : Run the Elastic Agent Integration tests.
run end-to-end tests : Generate the packages and run the E2E Tests.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2023-08-30T20:34:51Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	98.78% (`81/82`)	👍 0.015
Files	66.212% (`194/293`)	👎 -1.508
Classes	65.562% (`356/543`)	👎 -0.73
Methods	52.612% (`1118/2125`)	👎 -0.425
Lines	38.159% (`12719/33332`)	👎 -0.485
Conditionals	100.0% (`0/0`)	💚

elasticmachine · 2023-08-30T21:37:05Z

Pinging @elastic/elastic-agent (Team:Elastic-Agent)

pierrehilbert · 2023-08-31T06:01:04Z

We discussed this on Monday, thanks I'm sure it will help users to see that something is happening there!

blakerouse

Looks good. Simple design and easy to follow.

blakerouse · 2023-09-06T17:16:42Z

internal/pkg/agent/install/progress.go

+	// Randomize interval between 65% and 250% of configured interval
+	// to make it look like the progress is non-linear. :)
+	floor := int64(math.Floor(float64(pt.tickInterval.Milliseconds()) * 0.65))
+	ceiling := int64(math.Floor(float64(pt.tickInterval.Milliseconds()) * 2.5))


Haha, I don't know if this is really needed but okay! Why not.

This whole deal is just to show some random progress to make things appear more realistic ;)

ycombinator · 2023-09-06T23:47:50Z

buildkite test this

AndersonQ

A wee blocker, isn't the 1st test susceptible to flakiness?
Another thing, it won't work well with nested steps, right?

AndersonQ · 2023-09-07T13:46:39Z

internal/pkg/agent/install/progress_test.go

+
+		pt.Stop()
+
+		require.Equal(t, "step 1 starting... FAILED\n", string(w.buf))


[Blocker]
Isn't there a chance there will be more than 3 dots(...) when the assertion happens?
You didn't disable the randomised ticker intervals.

We shouldn't see more than three dots because the step starts (line 36) and immediately fails (line 37). Unlike some of the other tests in this PR, there is no delay (sleep) in between those two lines, so more dots will not be shown.

AndersonQ

Please check my previous comment

ycombinator · 2023-09-07T15:54:43Z

Another thing, it won't work well with nested steps, right?

Correct, if/when we have such steps or want to represent such steps in the progress, we'll need to enhance the ProgressTracker with a stack or something.

ycombinator · 2023-09-07T21:37:44Z

/test

elastic-sonarqube · 2023-09-07T21:49:16Z

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

60.3% Coverage
0.0% Duplication

pierrehilbert · 2023-09-08T12:40:00Z

Unrelated failures, I'm merging

ycombinator added enhancement New feature or request Team:Elastic-Agent Label for the Agent team backport-skip labels Aug 30, 2023

mergify bot assigned ycombinator Aug 30, 2023

ycombinator marked this pull request as ready for review August 30, 2023 21:37

ycombinator requested a review from a team as a code owner August 30, 2023 21:37

ycombinator requested review from AndersonQ and blakerouse August 30, 2023 21:37

blakerouse approved these changes Sep 6, 2023

View reviewed changes

ycombinator added 9 commits September 6, 2023 12:20

Show installation progress

4423d96

Adding CHANGELOG fragment

c819e88

Adding unit tests

634febf

Add progress dots

b036b02

Add randomization to tick intervals

3369dff

Increase tick interval

7b7b1dc

Fix randomization

a25ffa4

Adjust randomization bounds

0adf4f2

Regenerate NOTICE.txt

be1206b

ycombinator force-pushed the install-progress branch from 4880210 to be1206b Compare September 6, 2023 19:21

Increasing margins with times to avoid flakiness

cbfe0e3

AndersonQ reviewed Sep 7, 2023

View reviewed changes

AndersonQ requested changes Sep 7, 2023

View reviewed changes

ycombinator requested a review from AndersonQ September 7, 2023 15:54

AndersonQ approved these changes Sep 7, 2023

View reviewed changes

ycombinator added 2 commits September 7, 2023 10:28

Doubling time intervals again

4afae51

Make test less reliant on timing

66475d4

pierrehilbert merged commit 68e5a19 into elastic:main Sep 8, 2023
8 of 11 checks passed

ycombinator deleted the install-progress branch September 11, 2023 16:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show installation progress #3338

Show installation progress #3338

ycombinator commented Aug 30, 2023 •

edited

Loading

elasticmachine commented Aug 30, 2023 •

edited

Loading

Build stats

Test stats 🧪

elasticmachine commented Aug 30, 2023 •

edited

Loading

elasticmachine commented Aug 30, 2023

pierrehilbert commented Aug 31, 2023

blakerouse left a comment

blakerouse Sep 6, 2023

ycombinator Sep 6, 2023

ycombinator commented Sep 6, 2023

AndersonQ left a comment

AndersonQ Sep 7, 2023

ycombinator Sep 7, 2023

AndersonQ left a comment •

edited

Loading

ycombinator commented Sep 7, 2023

ycombinator commented Sep 7, 2023

elastic-sonarqube bot commented Sep 7, 2023

pierrehilbert commented Sep 8, 2023


		pt.Stop()

		require.Equal(t, "step 1 starting... FAILED\n", string(w.buf))

Show installation progress #3338

Show installation progress #3338

Conversation

ycombinator commented Aug 30, 2023 • edited Loading

What does this PR do?

Before this PR

After this PR

Why is it important?

Checklist

elasticmachine commented Aug 30, 2023 • edited Loading

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

elasticmachine commented Aug 30, 2023 • edited Loading

🌐 Coverage report

elasticmachine commented Aug 30, 2023

pierrehilbert commented Aug 31, 2023

blakerouse left a comment

Choose a reason for hiding this comment

blakerouse Sep 6, 2023

Choose a reason for hiding this comment

ycombinator Sep 6, 2023

Choose a reason for hiding this comment

ycombinator commented Sep 6, 2023

AndersonQ left a comment

Choose a reason for hiding this comment

AndersonQ Sep 7, 2023

Choose a reason for hiding this comment

ycombinator Sep 7, 2023

Choose a reason for hiding this comment

AndersonQ left a comment • edited Loading

Choose a reason for hiding this comment

ycombinator commented Sep 7, 2023

ycombinator commented Sep 7, 2023

elastic-sonarqube bot commented Sep 7, 2023

pierrehilbert commented Sep 8, 2023

ycombinator commented Aug 30, 2023 •

edited

Loading

elasticmachine commented Aug 30, 2023 •

edited

Loading

elasticmachine commented Aug 30, 2023 •

edited

Loading

AndersonQ left a comment •

edited

Loading