feat: Disable the auto-refresh of the semantic browser on Capella session startup #321
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
jamilraichouni
commented
Oct 2, 2024
jamilraichouni
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
5 times, most recently
from
5021640
to
6eacceb
Compare
|
The pipeline fails because of a new incompatibility (with pre-commit 4.0.0) of the pre-commit hook docformatter. The issue is from yesterday and open: PyCQA/docformatter#289 |
jamilraichouni
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
3 times, most recently
from
f5bdbc5
to
2acffc4
Compare
|
Can you add a small section in https://dsd-dbs.github.io/capella-dockerimages/capella/base/ where you explain that the Semantic Browser is disabled by default, why it is the case and how to enable it again? |
jamilraichouni
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
3 times, most recently
from
f607246
to
e84597f
Compare
MoritzWeber0
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
from
d53e776
to
c4c9b69
Compare
MoritzWeber0
changed the title
MoritzWeber0
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
from
c4c9b69
to
29378d5
Compare
MoritzWeber0
approved these changes
Oct 8, 2024
jamilraichouni
commented
Oct 9, 2024
MoritzWeber0
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
from
29378d5
to
0fcfa38
Compare
jamilraichouni
commented
Oct 10, 2024
Comment on lines
1
to
5
| # SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| import fileinput |
There was a problem hiding this comment.
We may want to add a module docstring that explains, why we do the string replacement and do not modify using lxml.
There was a problem hiding this comment.
Do you want to write it? You have looked into lxml more deeply and could explain better why it's not a good option for us.
jamilraichouni
commented
Oct 10, 2024
MoritzWeber0
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
from
0fcfa38
to
62e7de6
Compare
Make it possible to disable the auto-refresh of the semantic browser by setting the environment variable `CAPELLA_DISABLE_SEMANTIC_BROWSER_AUTO_REFRESH` to `1`.
- Replace hardcoded workspace directory with env variable - Use functions for better readibility - Use context manager and `enumerate` for file iteration - Use `replace` statement to replace old with new
Describe why we cannot use `lxml` to edit the file in-place and why we use `fileinput` instead.
MoritzWeber0
force-pushed
the
feat-disable-semantic-browser-auto-refresh
branch
from
b0b143a
to
3dd0d49
Compare
MoritzWeber0
approved these changes
Oct 16, 2024
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.
When the semantic browser is in the foreground and the displayed setting is active in its toolbar, the UI can freeze for bigger models and every change of model element selection.
It takes its time to load the context of related elements and this bootle neck makes bigger models nearly unusable espoecially for models on a remote Team4Capella (T4C) server.
This is why it has been decided to introduce an according configuration option that disables this toolbar option for every new Capella session.
The default of Capella for a freshly created workspace makes this auto-refresh active as illustrated.
This PR adds a new environment variable which allows to deviate from the default and disables the auto-refresh of the semantic browser, when the environment variables is set to
CAPELLA_DISABLE_SEMANTIC_BROWSER_AUTO_REFRESH=1.Note, that the toolbar of the semantic browser comes with another button related to the refresh of the semantic browser's view.
The button with curved and yellow arrows allows to trigger a manual refresh of the semantic browser.
Resolves #316