Improve build-ui Makefile target and fix dependencies
#2573
Conversation
Signed-off-by: albertteoh <albert.teoh@logz.io>
Signed-off-by: albertteoh <albert.teoh@logz.io>
Makefile
Outdated
| @echo "Expect UI assets: $(EXPECT_ASSETS)" | ||
| @echo "Found UI assets: $(FOUND_ASSETS)" | ||
|
|
||
| ifeq ($(FOUND_ASSETS), $(EXPECT_ASSETS)) |
There was a problem hiding this comment.
I'm open to suggestions of a better approach to checking if build-ui was previously run.
There was a problem hiding this comment.
This is what Make was built for - we can to define the files as dependencies of a target. However, the trick is that the files themselves should also be dependency-tracked. I.e. something like this:
placeholder/gen_assets.go: placeholder/public/index.html
esc ...
actual/gen_assets.go: jaeger-ui/packages/jaeger-ui/build/index.html
esc ...
build-ui: placeholder/gen_assets.go actual/gen_assets.go
# actually, nothing to do here
But, there are still two problems with this:
- ideally,
jaeger-ui/packages/jaeger-ui/build/index.htmlshould also be dependent on the actual UI source. This gets pretty complicated to manage. - this set-up always requires a real UI build, a situation I would rather avoid. It should only be required when the binary is compiled with
-tags ui.
There was a problem hiding this comment.
Ah yes, good suggestion re: make on file dependencies.
ideally, jaeger-ui/packages/jaeger-ui/build/index.html should also be dependent on the actual UI source. This gets pretty complicated to manage.
Could we solve this with the following make target spec? I suspect you are suggesting that there's more to consider that I haven't picked up on:
jaeger-ui/packages/jaeger-ui/build/index.html:
cd jaeger-ui && yarn install --frozen-lockfile && cd packages/jaeger-ui && yarn build
this set-up always requires a real UI build, a situation I would rather avoid.
Forgive me for not understanding and my ignorance; what specifically about this set-up requires a real UI build? I thought yarn build would result in a real UI build?
It should only be required when the binary is compiled with -tags ui.
In this PR, I made sure the build-ui target is only executed for binaries compiled with -tags ui, or have I misunderstood something?
There was a problem hiding this comment.
Could we solve this with the following make target spec?
The main idea of Make is to execute targets when dependencies change. When the target itself is a file AND has no dependencies, then once that file exists the command will never be run:
$ cat Makefile
x: file
file:
echo n > file
$ make x
echo n > file
$ make x
make: Nothing to be done for `x'.
There was a problem hiding this comment.
We could add the build dir to the clean target (which doesn't exist when initing the submodule, also note actual/gen_assets.go isn't checked in so it should be okay to remove). So we'd have the following:
.PHONY: clean
clean:
rm -rf cover.out .cover/ cover.html lint.log fmt.log \
cmd/query/app/ui/actual/gen_assets.go \
jaeger-ui/packages/jaeger-ui/build
.PHONY: build-ui
build-ui: cmd/query/app/ui/actual/gen_assets.go cmd/query/app/ui/placeholder/gen_assets.go
# Do nothing
jaeger-ui/packages/jaeger-ui/build/index.html:
cd jaeger-ui && yarn install --frozen-lockfile && cd packages/jaeger-ui && yarn build
cmd/query/app/ui/actual/gen_assets.go: jaeger-ui/packages/jaeger-ui/build/index.html
esc -pkg assets -o cmd/query/app/ui/actual/gen_assets.go -prefix jaeger-ui/packages/jaeger-ui/build jaeger-ui/packages/jaeger-ui/build
cmd/query/app/ui/placeholder/gen_assets.go: cmd/query/app/ui/placeholder/public/index.html
esc -pkg assets -o cmd/query/app/ui/placeholder/gen_assets.go -prefix cmd/query/app/ui/placeholder/public cmd/query/app/ui/placeholder/public
From a fresh clone, I performed the following test:
$ git submodule update --init --recursive
$ make build-ui
cd jaeger-ui && yarn install --frozen-lockfile && cd packages/jaeger-ui && yarn build
esc -pkg assets -o cmd/query/app/ui/actual/gen_assets.go -prefix jaeger-ui/packages/jaeger-ui/build jaeger-ui/packages/jaeger-ui/build
esc -pkg assets -o cmd/query/app/ui/placeholder/gen_assets.go -prefix cmd/query/app/ui/placeholder/public cmd/query/app/ui/placeholder/public
$ make build-ui
# Do nothing
# Trigger a rebuild of UI assets
$ make clean
rm -rf cover.out .cover/ cover.html lint.log fmt.log \
cmd/query/app/ui/actual/gen_assets.go \
jaeger-ui/packages/jaeger-ui/build
$ make build-ui
cd jaeger-ui && yarn install --frozen-lockfile && cd packages/jaeger-ui && yarn build
esc -pkg assets -o cmd/query/app/ui/actual/gen_assets.go -prefix jaeger-ui/packages/jaeger-ui/build jaeger-ui/packages/jaeger-ui/build
There was a problem hiding this comment.
Sounds good. I would change # Do nothing to # Do nothing. If you need to force a rebuild of UI assets, run make clean.
I don't think you need to include cmd/query/app/ui/actual/gen_assets.go in the clean target, because that file will be rebuilt any time index.html is changed (which is being deleted in clean).
Codecov Report
@@ Coverage Diff @@
## master #2573 +/- ##
==========================================
+ Coverage 95.32% 95.34% +0.02%
==========================================
Files 208 208
Lines 9281 9281
==========================================
+ Hits 8847 8849 +2
+ Misses 355 354 -1
+ Partials 79 78 -1
Continue to review full report at Codecov.
|
Makefile
Outdated
| rm -rf cover.out .cover/ cover.html lint.log fmt.log | ||
| rm -rf cover.out .cover/ cover.html lint.log fmt.log \ | ||
| cmd/query/app/ui/actual/gen_assets.go \ | ||
| cmd/query/app/ui/placeholder/gen_assets.go |
There was a problem hiding this comment.
this file is checked in, I don't think clean should be removing it.
Signed-off-by: albertteoh <albert.teoh@logz.io>
Signed-off-by: albertteoh <albert.teoh@logz.io>
Makefile
Outdated
| # packages the assets into a Go file that is `.gitignore`-ed. | ||
| # | ||
| # The packaged assets can be enabled by providing a build tag `ui`; for example: | ||
| # $ go run -tags ui ./cmd/all-in-one/main.go |
There was a problem hiding this comment.
I think CONTRIBUTING file is a better place for this documentation than a makefile, nobody would look here, especially when reading instructions in CONTRIBUTING
There was a problem hiding this comment.
I compared CI run for this PR (https://travis-ci.org/github/jaegertracing/jaeger/builds/736964904) with recent run on master (https://travis-ci.org/github/jaegertracing/jaeger/builds/735758902). The CROSDOCK steps were a few minutes longer, probably because they are now running yarn to build full UI, a step that we intentionally tried to avoid (see target build-crossdock-ui-placeholder). I think that target needs to be changed to also copy index.html from placeholder dir into jaeger-ui/build
|
btw, please give a different title to this PR, I think changes to makefile are more significant than adding documentation |
albertteoh
changed the title
build-ui Makefile target and fix dependencies
Done, please let me know if the new title is appropriate or if you have suggestions to improve it. |
| cd jaeger-ui && yarn install --frozen-lockfile && cd packages/jaeger-ui && yarn build | ||
|
|
||
| cmd/query/app/ui/actual/gen_assets.go: jaeger-ui/packages/jaeger-ui/build/index.html |
There was a problem hiding this comment.
please add to the top of build-crossdock-ui-placeholder target:
mkdir -p jaeger-ui/packages/jaeger-ui/build/
cp cmd/query/app/ui/placeholder/public/index.html jaeger-ui/packages/jaeger-ui/build/index.html
to avoid running yarn for crossdock CI steps
Signed-off-by: albertteoh <albert.teoh@logz.io>
Signed-off-by: albertteoh <albert.teoh@logz.io>
Which problem is this PR solving?
Short description of the changes
build-uistep from CONTRIBUTING.md as it's automated by Makefile.cleantarget to enable rebuilding of UI assets.build-uidoes under the hood into the Makefile under its namesake, which was deleted in Update static UI assets path in contrib doc #2548.build-uitarget dependency should only be used for builds that use-tags ui(remove fromdockerandbuild-all-in-one-linuxtargets).build-uitarget idempotent by explicitly checking for the UI assets files' existence. If all expected files exist, do nothing. Otherwise, regenerate UI asset files.