Avoid duplicate loading of component files #11195
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
As discovered in ComplianceAsCode#11190, the `components.load()` function is called many times during a build of product content. However, the component files need to be loaded only once. When the build systems resolves the content using `compile_all.py`, the `compile_all.py` creates an instance of `ssg.builld_yaml.BuildLoader` class. Moreover, many other instances of `ssg.builld_yaml.BuildLoader` class are created recursively as the loader recurses into sub-directories of the given benchmark root directory. When we iterate over the directories, for each child directory the script creates a new instance of the `ssg.build_yaml.BuildLoader` by the `ssg.builld_yaml.BuildLoader._get_new_loader()` method. This method should ensure that the component data and other data won't be unnecessarily loaded again but will be just referenced from the parent `ssg.builld_yaml.BuildLoader` that handles the parent directory. The problem is the way how the `ssg.builld_yaml.BuildLoader._load_components()` method is called in the ctor of `ssg.builld_yaml.BuildLoader`. The ctor is called before the initialization of the `rule_to_components` attribute. Also, there is no code in this ctor or elsewhere assuring that it won't load the components data if they were already loaded. In this commit, we won't call `_load_components` in the ctor, which will leave the opportunity to `_get_new_loader` to swap the data as the comment said. This should bring a speed up about 5 seconds.
|
Start a new ephemeral environment with changes proposed in this pull request: Fedora Environment Oracle Linux 8 Environment |
|
Code Climate has analyzed commit 354fdb4 and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 33.3% (50% is the threshold). This pull request will bring the total coverage in the repository to 57.0%. View more on Code Climate. |
Mab879
approved these changes
Oct 17, 2023
|
I'm waving the code climate coverage as build process more than covers this. |
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.
As discovered in #11190, the
components.load()function is called many times during a build of product content. However, the component files need to be loaded only once.When the build systems resolves the content using
compile_all.py, thecompile_all.pycreates an instance ofssg.builld_yaml.BuildLoaderclass. Moreover, many other instances ofssg.builld_yaml.BuildLoaderclass are created recursively as the loader recurses into sub-directories of the given benchmark root directory. When we iterate over the directories, for each child directory the script creates a new instance of thessg.build_yaml.BuildLoaderby thessg.builld_yaml.BuildLoader._get_new_loader()method. This method should ensure that the component data and other data won't be unnecessarily loaded again but will be just referenced from the parentssg.builld_yaml.BuildLoaderthat handles the parent directory.The problem is the way how the
ssg.builld_yaml.BuildLoader._load_components()method is called in the ctor ofssg.builld_yaml.BuildLoader. The ctor is called before the initialization of therule_to_componentsattribute. Also, there is no code in this ctor or elsewhere assuring that it won't load the components data if they were already loaded.In this commit, we won't call
_load_componentsin the ctor, which will leave the opportunity to_get_new_loaderto swap the data as the comment in this method says.This should bring a speed up about 5 seconds.