Bug: Empty comment if OpenTofu is used with ephemeral resources

[michemache]

I’ve noticed that when I use OpenTofu with ephemeral resources, the comment field is left empty.

After some analysis, I realised that ephemeral resources are present in the JSON output with OpenTofu but not in the human-readable output.
Consequently, when using OpenTofu, the error Resource '${name}' is modified but cannot be found in human-readable plan. is thrown. However, this is suppressed by a try-catch block in the renderPlan function and results in an empty comment.

I will prepare a PR to fix this behavior.

[michemache]

With OpenTofu version 1.12, this issue is no longer present.
But the suppression by the try-catch block here is still a thing.

[borchero]

With OpenTofu version 1.12, this issue is no longer present.

Good to hear @michemache!

But the suppression by the try-catch block here is still a thing.

What do you mean exactly?

[michemache]

@borchero Currently, the try-catch block wrapping renderTerraformPlan is silencing any error that isn't a SyntaxError. This can make debugging significantly harder if renderTerraformPlan fails for other reasons.

  try {
    return await renderTerraformPlan(...)
  } catch (error) {
    if (error instanceof SyntaxError) {
      return await renderTerragruntPlan(...)
    } 
    // Bug: Other error types are swallowed here
  }

This would be my suggestion for the fix:

  try {
    return await renderTerraformPlan(...)
  } catch (error) {
    if (error instanceof SyntaxError) {
      return await renderTerragruntPlan(...)
    } else {
      // Re-throw unexpected errors
      throw error
    } 
  }

[borchero]

Ah! Yes, that makes sense to me; feel free to put up a PR :)

[michemache]

@borchero sure, there it it: #113