Optimize eyeglass asset installation. #226
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If additional output from a sass compilation is written to a location that is outside of the broccoli output tree we can't just ignore it because the persistent cache hit would not create the same outputs. But because the output locatio is outside of the tree, it's not this plugin's responsbility to restore that output. To manage this, the "additional-output" event can now provide a source location and target url for the asset. When there's a persistent cache hit, the "cached-asset" event is fired with the source location and target url that was provided by "additional-output". In this way the build integration that is using this plugin must decide how to restore the cache for those files correctly.
Eyeglass assets are installed for each invocation of asset-url() which can add performance overhead at scale especially when the same asset is installed many times. ember-cli-eyeglass now intercepts asset installation and records which assets are installed to which locations. It does this by writing all those assets into a single tree for the entire app and all addons and engines. This has the benefit of also ensuring that asset urls can be resolved to any path instead of forcing those urls to resolve to a location relative to the current tree, which fixes a long-standing annoyance that forced assets to be duplicated in engines (note: this patch doesn't change the asset installation locations -- a custom resolver is required to accomplish this for now).
chriseppstein
force-pushed
the
perf_tuning_asset_install
branch
from
07509f2 to
8d0402a
Compare
|
@chriseppstein nice, I plan to take a thorough look this evening/weekend. |
In a multi-app project layout, the postBuild hook gets a project that isn't used elsewhere which makes clearing the app caches more tricky. instead we use a map to store the information and some global data for bookkeeping so we can find our data later. Use the app storage to pass a session cache to broccoli-eyeglass and reset it after each build.
…d caching, it's more correctly unique.
… be shared across the session.
Performance enhancement release.
stefanpenner
requested changes
Mar 25, 2019
| * | ||
| * BroccoliSymbolicLinker | ||
| */ | ||
| export class BroccoliSymbolicLinker extends BroccoliPlugin { |
There was a problem hiding this comment.
this plugin likely needs to be tested, https://github.com/broccolijs/broccoli-test-helper can be quite helpful for that.
|
@chriseppstein I think the overall approach here is very interesting. Good way to have a single "install" step. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Eyeglass assets are installed for each invocation of
asset-url()which can add performance overhead at scale especially when the same asset is installed many times.ember-cli-eyeglassnow intercepts asset installation and records which assets are installed to which locations. It does this by writing all those assets into a single tree for the entire app and all addons and engines after they are built, which it only needs to do once per distinct url. To accomplish this, I wrote a new broccoli-plugin in this commit which makes in possible to symlink arbitrary files into an output tree.This PR has the benefit of also ensuring that asset urls can be resolved to any path instead of forcing those urls to resolve to a location relative to the current tree, which fixes a long-standing annoyance that forced assets to be duplicated in engines (note: this patch doesn't change the asset installation locations -- a custom resolver is required to accomplish this for now).
This patch was made more tricky because of my bone-headed insistence of having a generic broccoli sass plugin as the base class for the broccoli eyeglass plugin. The pure sass plugin is in charge of the caching strategy so it uses events to delegate knowledge of how additional outputs are restored from cache to the external code that is invoking this plugin and doing weird things with assets outside the output tree.
A few other things to note:
TODO: I need to add some additional test cases.