This repository has been archived by the owner on Sep 30, 2024. It is now read-only.
[SD-112] Resolve the issue of the site form layout crashing. #157
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
vincent-gao
commented
Aug 1, 2024
| @@ -22,7 +24,7 @@ function tide_site_install() { | |||
| * New field taxonomy image logo. | |||
| */ | |||
| function tide_site_update_10001() { | |||
| module_load_include('inc', 'tide_core', 'includes/helpers'); | |||
There was a problem hiding this comment.
we shouldn't use deprecated functions.
vincent-gao
commented
Aug 1, 2024
| $config->set('dependencies', $config_read['dependencies']); | ||
| $config->set('content', $config_read['content']); | ||
| $config->set('hidden', $config_read['hidden']); | ||
| $config->save(); |
There was a problem hiding this comment.
Arbitrarily overwriting active configurations may lead to layout inconsistencies.
vincent-gao
commented
Aug 1, 2024
| $display_config_entity = \Drupal::configFactory()->getEditable($form_config); | ||
| $original_config = $display_config_entity->getRawData(); | ||
| $rewritten_config = NestedArray::mergeDeep($original_config, $rewrite); | ||
| if ($rewritten_config['dependencies']) { |
There was a problem hiding this comment.
The reason I need to handle the dependencies data seems to be due to a bug with it's not a bug, unfortunately.NestedArray::mergeDeep (I'm not entirely sure), which causes data duplication within dependencies. I might need to check Drupal.org for more information
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Jira
https://digital-vic.atlassian.net/browse/SD-112
Changes
This PR fixes the recurring layout breakdown issues caused by inconsistencies between active and inactive configurations, which are distributed across different modules.
Drupal\Component\Utility\NestedArrayfor more robust config handling.The root cause of our layout issues came from configurations being spread across multiple modules (e.g. tide_site and tide_site_theming). When update hooks only modify configs in one module (e.g. tide_site), they can inadvertently overwrite settings from other modules (e.g. tide_site_theming), leading to inconsistencies and layout failures.
For instance, content-reference configurations exist in both tide_site and tide_site_theming. Updating only from tide_site can overwrite tide_site_theming settings, causing layout breakdowns.
To mitigate these issues, we should consolidate all field configurations for a module within its top-level module. This approach, combined with proper update methods, can significantly reduce layout disappearance problems. (tide mono-repo 😹 )