Skip to content

Add plan comments - #955

Merged
pgiraud merged 3 commits into
dalibo:masterfrom
Florian-Cullmann:fix/720-comment-field
Sep 8, 2026
Merged

pgiraud merged 3 commits into
dalibo:masterfrom
Florian-Cullmann:fix/720-comment-field

Conversation

@Florian-Cullmann

@Florian-Cullmann Florian-Cullmann commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add an optional plan-comment prop to the reusable Plan component
  • add a Comments field to the demo app and preserve comments through save, import, export, edit, and reopen flows
  • display comments in a dedicated Comment tab, independently from the SQL query
  • document the public prop and cover the workflow with browser tests

Why

PEV2 only carried the plan source and SQL query through its component and demo data flows, so users had no dedicated place to keep context such as configuration differences or tuning notes. Comments are now stored separately from SQL and shown in their own tab with their original line breaks.

Impact

Existing integrations and previously saved plans remain compatible because the new component prop and stored comment value are optional.

Closes #720

@Florian-Cullmann
Florian-Cullmann marked this pull request as ready for review August 19, 2026 19:51
@pgiraud

pgiraud commented Aug 26, 2026

Copy link
Copy Markdown
Member

@Florian-Cullmann could you please take the comments made in #720 into account?

@Florian-Cullmann

Copy link
Copy Markdown
Contributor Author

@pgiraud on it!

@Florian-Cullmann

Copy link
Copy Markdown
Contributor Author

@pgiraud done

@pgiraud

pgiraud commented Sep 1, 2026

Copy link
Copy Markdown
Member

If it doesn't bother you to make a small change, I'd be in favor of not adding the Comment tab when it's empty instead of just disabling it. It's probably just a matter of taste.

While you're at it, can you please, in an additional commit, move the Plan Name for field to the top, before the Plan one?

@Florian-Cullmann

Copy link
Copy Markdown
Contributor Author

@pgiraud done

@pgiraud

pgiraud commented Sep 3, 2026

Copy link
Copy Markdown
Member

Can you please make it so the sample plans selector is on the same line as Plan Name label?

Also, can you please squash the 3 first commits and create one single "Add plan comments" commit?

@pgiraud

pgiraud commented Sep 8, 2026

Copy link
Copy Markdown
Member

Do you think you'll be able to work on this soon? I'd like to publish a new release.

@Florian-Cullmann

Florian-Cullmann commented Sep 8, 2026

Copy link
Copy Markdown
Contributor Author

@pgiraud Done - I moved the sample plans selector next to the Plan Name label and squashed the first three commits. Does this look good to you?

@pgiraud
pgiraud merged commit 6d14a4f into dalibo:master Sep 8, 2026
3 checks passed
@pgiraud

pgiraud commented Sep 8, 2026

Copy link
Copy Markdown
Member

Thanks a lot for your contribution to the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Comment field

2 participants