chore: add console error logging in env.config.jsx template #254
Conversation
This file contains hidden or 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
DawoudSheraz
force-pushed
the
dsheraz/add-env-config-logging
branch
from
c417dcd to
9ab9e8e
Compare
arbrandes
requested changes
May 7, 2025
There was a problem hiding this comment.
I usually object to console.logging in production code, but it seems plugin configuration and interaction will always be prone to errors. We can discuss a way to do conditional logging later, but for now I think this is worth it.
I do think we should log the error message as well, though.
| @@ -43,7 +43,7 @@ async function setConfig () { | |||
| {%- endfor %} | |||
|
|
|||
| {{- patch("mfe-env-config-runtime-final") }} | |||
| } catch { } | |||
| } catch (error) { console.error("env.config.jsx failed to apply.";} | |||
There was a problem hiding this comment.
Since we're using a catch-all, it would be useful to log the error message as well, I think.
There was a problem hiding this comment.
Sure. I misunderstood console.error that it would automatically log the error, it is not the case.
arbrandes
approved these changes
May 8, 2025
Co-authored-by: Adolfo R. Brandes <adolfo@axim.org>
github-project-automation
bot
moved this from In review
to Done
in Tutor project management
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.
Edly recently faced an issue with Teak sandbox in which env.config.jsx did not apply when both Indigo and Aspects plugins were enabled. Upon debugging, it was found that there was an issue in env.config.jsx related patches in Indigo which caused this. However, it was not apparent at first that this was the issue and it required debugging and re-building images to pinpoint the issue. While we are fixing the Indigo issue in overhangio/tutor-indigo#148, we are adding a small change in tutor-mfe to log the error in env.config.jsx if config fails to apply for any reason. This will make future debugging easier.