Skip to content

Conversation

@paodb
Copy link
Member

@paodb paodb commented Aug 14, 2025

Close #17 & #18

Summary by CodeRabbit

  • Refactor

    • Switched the Markdown component to load its frontend connector via module-based loading. No changes to behavior or public APIs. Improves compatibility with modern frontend build setups.
  • Chores

    • Updated internal framework annotations/imports to current conventions for the Markdown component. No user-facing impact.

@paodb paodb requested review from javier-godoy and mlopezFC August 14, 2025 20:15
@coderabbitai
Copy link

coderabbitai bot commented Aug 14, 2025

Walkthrough

Replaced Vaadin @javascript annotation with @jsmodule in BaseMarkdownComponent and updated the referenced frontend connector from ./connector.js to ./fcMarkdownEditorConnector.js. Adjusted the import accordingly. No other code or API changes.

Changes

Cohort / File(s) Summary
Annotation migration to JsModule
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java
Switched @javascript to @jsmodule; updated module path from ./connector.js to ./fcMarkdownEditorConnector.js; replaced JavaScript import with JsModule import.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Assessment against linked issues

Objective Addressed Explanation
Rename javascript connector to a unique name and update usage (#17) Annotation and reference updated; cannot verify the actual resource renaming/location from this diff.

Possibly related issues

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch refactor-issue17-18

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java (2)

92-95: Defensive guard to avoid runtime errors if the connector fails to load

Optional but safer: guard the calls so a missing or delayed connector doesn’t throw at runtime.

Apply this diff:

-    runBeforeClientResponse(ui -> ui.getPage().executeJs(
-        "window.Vaadin.Flow.fcMarkdownEditorConnector.observeThemeChange($0)",
-        getElement()));
+    runBeforeClientResponse(ui -> ui.getPage().executeJs(
+        "var c=window.Vaadin && Vaadin.Flow && Vaadin.Flow.fcMarkdownEditorConnector;"
+        + "if (c && c.observeThemeChange) { c.observeThemeChange($0); }",
+        getElement()));
@@
-    getUI().ifPresent(ui -> ui.getPage().executeJs(
-        "window.Vaadin.Flow.fcMarkdownEditorConnector.unobserveThemeChange($0)",
-        this.getElement()));
+    getUI().ifPresent(ui -> ui.getPage().executeJs(
+        "var c=window.Vaadin && Vaadin.Flow && Vaadin.Flow.fcMarkdownEditorConnector;"
+        + "if (c && c.unobserveThemeChange) { c.unobserveThemeChange($0); }",
+        this.getElement()));

Also applies to: 101-104


55-63: Fix swapped Javadocs for getContent/setContent

The Javadoc summaries are inverted. Also, the @param description for setContent is misleading.

Apply this diff:

-  /**
-   * Sets the content of the Markdown component.
-   * 
-   * @return the content of the Markdown component
-   */
+  /**
+   * Gets the content of the Markdown component.
+   *
+   * @return the content of the Markdown component
+   */
@@
-  /**
-   * Gets the content of the Markdown component.
-   * 
-   * @param content retrieved from the state of the component
-   */
+  /**
+   * Sets the content of the Markdown component.
+   *
+   * @param content content to be used in the Markdown component
+   */

Also applies to: 64-72

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these settings in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 7f6987c and fdf1a9d.

📒 Files selected for processing (1)
  • src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java (2 hunks)
🔇 Additional comments (2)
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java (2)

27-27: Switching to @jsmodule for Vaadin 24+ is correct — LGTM

Replacing @javascript with @jsmodule aligns with Vaadin’s Vite/ESM pipeline and avoids global script pollution. No issues here.


40-40: Connector ESM verified — API present

Verified that:

  • File: src/main/resources/META-INF/resources/frontend/fcMarkdownEditorConnector.js
    • window.Vaadin.Flow.fcMarkdownEditorConnector defined (line 22)
    • observeThemeChange defined (line 23)
    • unobserveThemeChange defined (line 74)
  • No leftover references to "connector.js" found.
  • No top-level use of this (only occurrence is in the license header).

No changes required.

@javier-godoy javier-godoy merged commit 3fc8452 into master Aug 18, 2025
3 checks passed
@javier-godoy javier-godoy deleted the refactor-issue17-18 branch August 18, 2025 12:05
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.

Rename javascript connector

3 participants