Skip to content

Conversation

@mahadzaryab1
Copy link
Collaborator

@mahadzaryab1 mahadzaryab1 commented Sep 1, 2024

Which problem is this PR solving?

Description of the changes

  • Created one file assets.go that holds both the placeholder and actual assets.
  • Added a helper GetStaticFiles to get the assets based on whether the actual filesystem has an index.html.gz. If it does, we return the assets. Otherwise, we return the placeholder index.html file.

How was this change tested?

Added unit tests and performed the following manual tests

Test 1

Makefile Target

.PHONY: run-all-in-one
run-all-in-one:
	go run ./cmd/all-in-one --log-level debug

Clearing out the actual directory and ran make run-all-in-one. Going to http://localhost:16686/ renders the placeholder HTML page.

Test 2

Makefile Target

.PHONY: run-all-in-one
run-all-in-one: build-ui
	go run ./cmd/all-in-one --log-level debug

Ran make run-all-in-one. Going to http://localhost:16686/ renders the Jaeger UI.

Checklist

@codecov
Copy link

codecov bot commented Sep 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.81%. Comparing base (5bd6980) to head (2b62656).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5917   +/-   ##
=======================================
  Coverage   96.81%   96.81%           
=======================================
  Files         342      343    +1     
  Lines       16525    16528    +3     
=======================================
+ Hits        15998    16001    +3     
  Misses        340      340           
  Partials      187      187           
Flag Coverage Δ
badger_v1 8.05% <ø> (ø)
badger_v2 1.82% <ø> (ø)
cassandra-3.x-v1 16.62% <ø> (ø)
cassandra-3.x-v2 1.75% <ø> (ø)
cassandra-4.x-v1 16.62% <ø> (ø)
cassandra-4.x-v2 1.75% <ø> (ø)
elasticsearch-6.x-v1 18.78% <ø> (ø)
elasticsearch-7.x-v1 18.85% <ø> (ø)
elasticsearch-8.x-v1 19.03% <ø> (ø)
elasticsearch-8.x-v2 1.82% <ø> (ø)
grpc_v1 9.49% <ø> (ø)
grpc_v2 7.16% <ø> (ø)
kafka-v1 9.74% <ø> (ø)
kafka-v2 1.82% <ø> (ø)
memory_v2 1.82% <ø> (+0.01%) ⬆️
opensearch-1.x-v1 18.89% <ø> (-0.02%) ⬇️
opensearch-2.x-v1 18.90% <ø> (ø)
opensearch-2.x-v2 1.82% <ø> (+0.01%) ⬆️
tailsampling-processor 0.46% <ø> (ø)
unittests 95.29% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mahadzaryab1 mahadzaryab1 changed the title [WIP] Simplify bundling of UI assets Simplify Bundling of UI assets Sep 1, 2024
@mahadzaryab1 mahadzaryab1 marked this pull request as ready for review September 1, 2024 19:37
@mahadzaryab1 mahadzaryab1 requested a review from a team as a code owner September 1, 2024 19:37
@mahadzaryab1 mahadzaryab1 requested a review from jkowall September 1, 2024 19:37
@dosubot dosubot bot added the ui label Sep 1, 2024
Signed-off-by: Mahad Zaryab <[email protected]>
Signed-off-by: Mahad Zaryab <[email protected]>
Signed-off-by: Mahad Zaryab <[email protected]>
Signed-off-by: Mahad Zaryab <[email protected]>
Signed-off-by: Mahad Zaryab <[email protected]>
@mahadzaryab1
Copy link
Collaborator Author

mahadzaryab1 commented Sep 2, 2024

@yurishkuro anything we can do about the failing codecoverage step?

@yurishkuro
Copy link
Member

yurishkuro commented Sep 2, 2024

you could have another test where you swap actualFS for a test fixture, e.g.

ui/testdata/
  actual/
    index.html.gz -- dummy file
  mock.go // embed fake actual here

@mahadzaryab1
Copy link
Collaborator Author

you could have another test where you swap actualFS for a test fixture, e.g.

ui/testdata/
  actual/
    index.html.gz -- dummy file
  mock.go // embed fake actual here

thanks for the suggestion! I added a second test in.

Signed-off-by: Mahad Zaryab <[email protected]>
Signed-off-by: Mahad Zaryab <[email protected]>
Signed-off-by: Mahad Zaryab <[email protected]>
@yurishkuro yurishkuro merged commit 7df6975 into jaegertracing:main Sep 2, 2024
@yurishkuro
Copy link
Member

Thanks!

@mahadzaryab1 mahadzaryab1 deleted the simplify-ui-binding branch September 28, 2024 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Simplify bundling of UI assets

2 participants