fix: render mfe-ports for unmounted mfes when these exist #241
+13
−6
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
regisb
requested changes
Dec 16, 2024
| {%- set _ = unmounted_mfes.append((app_name, app)) %} | ||
| {%- endif %} | ||
| {%- endfor %} | ||
| {% if unmounted_mfes|length > 0 %} |
There was a problem hiding this comment.
nit: {% if unmounted_mfes|length > 0 %}
| @@ -1,10 +1,17 @@ | |||
| {%- set unmounted_mfes = [] %} | |||
| {%- for app_name, app in iter_mfes() %} | |||
There was a problem hiding this comment.
Could we simplify this declaration with the following?
{%- set unmounted_mfes = [(app_name, app) for app_name, app in iter_mfes() if not list(iter_mounts(MOUNTS, app_name))] %}
There was a problem hiding this comment.
It's giving error: Error: Template syntax error: expected token ',', got 'for'. Because of , in app_name, app. I've also tried with iter_mfes().items(). Got same error.
There was a problem hiding this comment.
Right. In which case, I suggest to expose a unmounted_mfes variable via the ENV_TEMPLATE_VARIABLES filter.
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.
Description
The issue occurs when all MFEs (Micro Frontends) are mounted, and the
portssection in the Docker configuration is left empty, leading to a syntax error in the generated Dockerfile. Specifically, theports:line becomes invalid as another key follows it (auth:) without any content. In thetutor devcontext, the issue occurs because developers mount MFEs for testing purposes. It won't reproduce fortutor local.How to Reproduce
authn, account, communications, course-authoring, discussions, gradebook, learner-dashboard, learning, ora-grading, profile)tutor mounts add $(pwd)/frontend-app-*where*represents all MFEs name one by onetutor config savetutor dev startOR directly check themfe-portssection intutor-env/env/dev/docker-compose.ymlWhat this PR does
This PR resolves the issue by implementing logic to first check if any unmounted MFEs exist. If unmounted MFEs are found, their corresponding ports are rendered in the ports: section. This ensures that the Docker configuration is generated correctly and avoids errors caused by leaving the
ports:section empty.TestCases:
mfe: ports:section.mfe: ports:section should be excluded entirely from the generated output.Closes #242