Roam: Add feedback toggle #118

sid597 · 2025-04-04T12:29:14Z

add settings to hide or show button, also works when disabled or enabled midway

Summary by CodeRabbit

New Features
- Introduced dynamic control of the feedback widget, allowing users to toggle the visibility of the feedback button via a new settings checkbox.
- Enhanced the initialization process to apply user preferences for feedback button display.
- Enabled external control for showing or hiding the feedback button.
- Added a prompt to refresh the page when visibility elements are not detected for the changes to take full effect.

…led midway

vercel · 2025-04-04T12:29:19Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
discourse-graph	⬜️ Skipped (Inspect)			Apr 10, 2025 8:01pm

coderabbitai · 2025-04-04T12:29:22Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes update the feedback widget functionality by introducing functions that add or remove a style element to control the visibility of feedback buttons. The initialization function now accepts an optional API parameter, allowing it to check a setting and apply the appropriate styling. A new checkbox is added to the personal settings page to enable users to toggle the feedback button’s visibility, updating the extension’s setting and invoking the corresponding hide/show functions. The widget initialization is also updated in the main index file to pass the extension API.

Changes

File(s)	Change Summary
`apps/roam/src/components/BirdEatsBugs.tsx` `apps/roam/src/index.ts`	Introduced `addFeedbackButtonHidingStyles` and `removeFeedbackButtonHidingStyles` functions to manage feedback button styles. Updated `initFeedbackWidget` to accept an optional `extensionAPI` and modified its control flow. Exported aliases `hideFeedbackButton` and `showFeedbackButton`. Updated index to pass `onloadArgs.extensionAPI`.
`apps/roam/src/components/settings/HomePersonalSettings.tsx`	Added a checkbox that toggles the "hide-feedback-button" setting. The checkbox initializes based on the current setting, updates the extension API on change, and calls the respective hide/show functions. An alert prompts the user to refresh if necessary elements are missing.

Sequence Diagram(s)

sequenceDiagram
    participant IW as initFeedbackWidget
    participant API as extensionAPI
    participant DOM as DOM
    IW->>API: Retrieve "hide-feedback-button" setting
    alt Setting is true
        IW->>DOM: Call addFeedbackButtonHidingStyles (add <style> element)
    else Setting is false
        IW->>DOM: Call removeFeedbackButtonHidingStyles (remove <style> element)
    end

sequenceDiagram
    participant U as User
    participant CB as Checkbox
    participant API as extensionAPI
    participant FT as FeedbackToggle
    participant DOM as DOM

    U->>CB: Toggle checkbox state
    CB->>API: Update "hide-feedback-button" setting
    alt Checkbox is checked
        API->>FT: Invoke hideFeedbackButton()
        FT->>DOM: Insert style element to hide button
    else Checkbox is unchecked
        API->>FT: Invoke showFeedbackButton()
        FT->>DOM: Remove style element (if exists)
    end
    Note over CB,U: Alert user to refresh if DOM elements are missing

Poem

I hopped through lines of code so bright,
Adding styles to hide or show at night.
With toggles clicked and settings fine,
The feedback button now aligns.
From burrows deep to interface tall,
A rabbit cheerfully codes for all! 🐰✨

🪧 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.
- Generate unit testing code for this file.
- 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. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
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 src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

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

Documentation and Community

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.

sid597 · 2025-04-04T12:29:29Z

@coderabbitai review

coderabbitai · 2025-04-04T12:29:34Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

apps/roam/src/components/settings/HomePersonalSettings.tsx (1)
89-122: Thorough implementation of the hide feedback button setting.

The checkbox implementation:

Follows the same pattern as other settings checkboxes for consistency

Correctly initializes state from extensionAPI settings

Updates settings and applies changes immediately when toggled

Includes helpful fallback alert if DOM elements aren't found

One minor suggestion:

Consider extracting the document.getElementById checks into a separate function for better readability:
-          if (
-            !document.getElementById("birdeatsbug-default-button") &&
-            !document.getElementById("feedback-button-hiding-styles")
-          ) {
+          if (!isFeedbackElementsPresent()) {
With a helper function:
const isFeedbackElementsPresent = () => {
  return document.getElementById("birdeatsbug-default-button") || 
         document.getElementById("feedback-button-hiding-styles");
}

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6e34519 and e9ce59d.

📒 Files selected for processing (3)

apps/roam/src/components/BirdEatsBugs.tsx (3 hunks)
apps/roam/src/components/settings/HomePersonalSettings.tsx (2 hunks)
apps/roam/src/index.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (2)

apps/roam/src/index.ts (1)

apps/roam/src/components/BirdEatsBugs.tsx (1)

initFeedbackWidget (70-216)

apps/roam/src/components/settings/HomePersonalSettings.tsx (1)

apps/roam/src/components/BirdEatsBugs.tsx (2)

hideFeedbackButton (218-218)

showFeedbackButton (219-219)

🔇 Additional comments (7)

apps/roam/src/components/BirdEatsBugs.tsx (5)

2-2: Good import addition for type safety.

The import of OnloadArgs type from "roamjs-components/types" provides proper type safety for the extensionAPI parameter.

44-61: Well-implemented function to hide feedback button.

The addFeedbackButtonHidingStyles function is well-structured with several positive aspects:

Checks for existing style element to prevent duplication

Uses a semantic ID for the style element

Uses !important to ensure styles override any existing ones

Targets specific elements that need hiding

63-68: Good cleanup function implementation.

The removeFeedbackButtonHidingStyles function properly cleans up by:

Finding the element by ID

Checking if the element exists before attempting removal

Removing the element completely from the DOM

70-82: Well-structured conditional logic for initialization.

The updated initFeedbackWidget function properly:

Accepts an optional extensionAPI parameter

Checks both for the existence of extensionAPI and the setting value

Returns early after hiding to prevent unnecessary initialization

Cleans up styles when feature is disabled

218-219: Clean export of utility functions.

Exporting aliases for the utility functions provides a cleaner, more semantic API for external components to use.

apps/roam/src/components/settings/HomePersonalSettings.tsx (1)

11-11: Good import for needed functionality.

Importing the utility functions directly from BirdEatsBugs module follows the established pattern and maintains separation of concerns.

apps/roam/src/index.ts (1)

63-63: Correct parameter passing to support new functionality.

The updated function call correctly passes the extensionAPI to the initFeedbackWidget function, enabling the new feature to work properly.

mdroidian · 2025-04-05T12:57:40Z

apps/roam/src/components/BirdEatsBugs.tsx

+};
+
+export const initFeedbackWidget = (
+  extensionAPI?: OnloadArgs["extensionAPI"],


This function is only called in one place, and extensionAPI is required. So let's remove the ?

mdroidian · 2025-04-05T12:57:52Z

apps/roam/src/components/BirdEatsBugs.tsx

+  ) {
+    addFeedbackButtonHidingStyles();
+    return;
+  } else if (extensionAPI) {


remove the if

mdroidian · 2025-04-05T12:58:00Z

apps/roam/src/components/BirdEatsBugs.tsx

+  extensionAPI?: OnloadArgs["extensionAPI"],
+): void => {
+  if (
+    extensionAPI &&


mdroidian · 2025-04-05T13:02:51Z

apps/roam/src/components/BirdEatsBugs.tsx

+const addFeedbackButtonHidingStyles = () => {
+  const styleId = "feedback-button-hiding-styles";
+
+  if (document.getElementById(styleId)) {
+    return;
+  }
+
+  const styleElement = document.createElement("style");
+  styleElement.id = styleId;
+  styleElement.textContent = `
+    #birdeatsbug-sdk,
+    #birdeatsbug-default-button {
+      display: none !important;
+    }
+  `;
+
+  document.head.appendChild(styleElement);
+};
+
+const removeFeedbackButtonHidingStyles = () => {
+  const styleElement = document.getElementById("feedback-button-hiding-styles");
+  if (styleElement) {
+    styleElement.remove();
+  }


nit: this could be one function
If not, could make styleId as STYLE_ID outside of functions so it is only in one place.

mdroidian · 2025-04-05T13:15:48Z

apps/roam/src/components/settings/HomePersonalSettings.tsx

+            showFeedbackButton();
+          }
+
+          if (


When is this required?

mdroidian

Good stuff. This is the only blocking request.

mdroidian · 2025-04-05T13:18:38Z

apps/roam/src/components/settings/HomePersonalSettings.tsx

+            !document.getElementById("birdeatsbug-default-button") &&
+            !document.getElementById("feedback-button-hiding-styles")
+          ) {
+            alert(


We have a roamjs-component for this that uses BlueprintJS: renderToast

mdroidian

👍

mdroidian · 2025-04-10T19:59:37Z

apps/roam/src/components/settings/HomePersonalSettings.tsx

  onPageRefObserverChange,
  previewPageRefHandler,
 } from "~/utils/pageRefObserverHandlers";
+import { hideFeedbackButton, showFeedbackButton } from "../BirdEatsBugs";


mdroidian · 2025-04-10T19:59:45Z

apps/roam/src/components/settings/HomePersonalSettings.tsx

  previewPageRefHandler,
 } from "~/utils/pageRefObserverHandlers";
+import { hideFeedbackButton, showFeedbackButton } from "../BirdEatsBugs";
+import renderToast from "roamjs-components/components/Toast";


author Trang Doan <[email protected]> 1744314525 -0400 committer Michael Gartner <[email protected]> 1747354088 -0600 ENG-96 Create new relationship between nodes (#115) * instantiate new relationship worked * fix * address PR comments * fix bi-directional update issues * show only compatible node type options * small fix * breakdown the components. use datacore * working * address PR comments * improve search by only allowing compatible node results * . * rm dataview --------- Co-authored-by: Michael Gartner <[email protected]> Move llm-api endpoints to vercel serverless (#102) * testing gemini * move endgoint to website * open ai endpoint * added anthropic endpoint * pass env vars * add cors handdling and options * . * using centralised cors middleware * only adding bypass cookie * use right key * remove the bypass token requirement * sanitize, fix routes * remove server action config * DRY * remove unused * address review * adress review Roam: Add feedback toggle (#118) * add settings to hide or show button, also works when disabled or enabled midway * review * . --------- Co-authored-by: Michael Gartner <[email protected]> [ENG-197] Fix creating link with invalid chars (#121) * fix creating link with invalid chars * placeholder update --------- Co-authored-by: Michael Gartner <[email protected]> Roam: Add feedback button to settings menu - ENG-147 (#122) * add button to bottom right, don't hide sdk css, tested * remove intent not working git * remove ts-ignore and use a better type def * remove styling Update NodeConfig to use new UIDs for DiscourseNodeIndex and DiscourseNodeSpecification components (#126) Roam: Add PostHog user identification for enhanced analytics tracking using user's roam UID as the unique identifier - ENG-177 (#123) * add posthog identify * remove username and email to keep it anonymus * double userUid and best practice for js Roam: Discourse Context Overlay - remove queue and arbitrary delay (#127) * Refactor getOverlayInfo to use async/await and improve error handling. Update cache key from title to tag and remove overlayQueue logic for cleaner implementation. * Remove experimental getOverlayInfo function * Remove unused refreshUi logic [ENG-44] Display relations (#116) * instantiate new relationship worked * add display relations * remove dv * sm fix [ENG-198] Filtered out related file in search (#125) * filtered out related file * fix some naming [ENG-97] Use TailwindCSS in obsidian app (#128) * Update Obsidian app to integrate Tailwind CSS with PostCSS and Autoprefixer support - Added Tailwind CSS, PostCSS, and Autoprefixer to package dependencies - Configured styles.css to include Tailwind directives - Enhanced compile script to process styles using PostCSS with Tailwind and Autoprefixer * delete irrelevant package [ENG-192] Change all existing styles to using tw (#129) * Update Obsidian app to integrate Tailwind CSS with PostCSS and Autoprefixer support - Added Tailwind CSS, PostCSS, and Autoprefixer to package dependencies - Configured styles.css to include Tailwind directives - Enhanced compile script to process styles using PostCSS with Tailwind and Autoprefixer * delete irrelevant package * changing all styles to tailwindcss * Update Obsidian app to integrate Tailwind CSS with PostCSS and Autoprefixer support - Added Tailwind CSS, PostCSS, and Autoprefixer to package dependencies - Configured styles.css to include Tailwind directives - Enhanced compile script to process styles using PostCSS with Tailwind and Autoprefixer * delete irrelevant package * changing all styles to tailwindcss --------- Co-authored-by: Michael Gartner <[email protected]> Roam: Bug-fix: Don't let user create discourse nodes with empty text using node context menu - ENG-171 (#130) * functional covering all three cases tested locally * apply coderabbit review suggestion * better approach one that I understand and can reason about * accidental removal of onClose Update Roam app version to 0.13.0 in package.json and package-lock.json (#134) [ENG-204] Move from localStorage to extensionAPI.settings (#133) * cur progress * address PR comments * kinda works. need to test more * small fix * address PR comments . Create publish-obsidian.yml Update publish-obsidian.yml Update publish-obsidian.yml Update publish-obsidian.yml Enhance DiscourseContextOverlay: Update button styles to include loading state and improve score/ref display during loading. Use placeholders for score and refs when loading. (#136) . Update publish-obsidian.yml Update publish-obsidian.yml Update publish-obsidian.yml Update publish-obsidian.yml Refactor ExportDialog: Remove discourseGraphEnabled state and simplify FormGroup visibility logic. Set includeDiscourseContext to false by default. (#139) Enhance LabelDialog: Add confirmText to return object for improved button text handling based on action type. (#141) Additional styles / cursor rules (#142) * Update STYLE_GUIDE.md and main.mdc: Add guideline for utilizing utility functions for reusable logic and common operations. * Update STYLE_GUIDE.md and main.mdc: Add guideline to prefer arrow functions over regular function declarations. * Update main.mdc: Add guideline to prefer Tailwind classes when refactoring inline styles. * Update STYLE_GUIDE.md and main.mdc: Add guideline to prefer early returns over nested conditionals for improved readability. Roam: When a user deletes a node also delete all the corresponding relations to the node - ENG-26 (#149) * ask user for confirmation, delete corresponding relations * address review * address review * address comments [ENG-301] Create node in right-click menu (#152) * create node in right-click menu * small fix * address PR comments * address PR comments add readme and remove sample commands remove sample editor command rm space minor fixes Roam: Bug fix - Insert Discourse Node after creation (#154) * remove focus after menu select to allow updateBlock to work * add clarifying comment [ENG-308] Add command to open DG settings (#158) * add command to open DG settings * edit comment ENG-322 - Switch from MIT to Apache 2.0 license (#156) * Switch from MIT to Apache 2.0 license * copyright discourse graphs * rm liscense from apps/roam --------- Co-authored-by: Michael Gartner <[email protected]> initial port [ENG-207] Move Github sync setting to individual nodes (#124) * current progress * improve in UI: if sync is turned off then also turn off the comments configuration * address PR comments * revert graphOverviewUid bug * revert graphOverviewUid bug - getDiscourseNodes * avoid racing conditions for github sync * nested settings * temp fix to race condition * remove unecessary DOM and match existing styles --------- Co-authored-by: Michael Gartner <[email protected]> Eng 286 show when GitHub sync is disabled globally (#143) * Refactor GitHub Sync settings in NodeConfig and GeneralSettings components - Updated the onChange handler for GitHub Sync to use async/await and added a timeout for refreshing the config tree. - Introduced a global settings check in NodeConfig to conditionally render the GitHub Sync checkbox and comments configuration. - Passed setMainTab prop to NodeConfig for better navigation control. This improves the user experience by ensuring that settings are updated correctly and provides clear feedback when global settings are disabled. * matchingNode fix . Refactor Export components to use getSetting for consistent settings retrieval - Updated ExportDialog and ExportGithub components to replace localStorageGet with getSetting for fetching GitHub OAuth and repository settings. - Modified extensionSettings utility functions to use arrow functions and provide a default value for getSetting. - Improved code readability and maintainability by standardizing the method of accessing settings. Eng 286 show when GitHub sync is disabled globally (#143) * Refactor GitHub Sync settings in NodeConfig and GeneralSettings components - Updated the onChange handler for GitHub Sync to use async/await and added a timeout for refreshing the config tree. - Introduced a global settings check in NodeConfig to conditionally render the GitHub Sync checkbox and comments configuration. - Passed setMainTab prop to NodeConfig for better navigation control. This improves the user experience by ensuring that settings are updated correctly and provides clear feedback when global settings are disabled. * matchingNode fix .

add settings to hide or show button, also works when disabled or enab…

e9ce59d

…led midway

github-project-automation bot added this to General Apr 4, 2025

coderabbitai bot reviewed Apr 4, 2025

View reviewed changes

mdroidian changed the title ~~add settings to hide or show button, also works when disabled or enab…~~ Roam: Add feedback toggle Apr 5, 2025

mdroidian reviewed Apr 5, 2025

View reviewed changes

apps/roam/src/components/settings/HomePersonalSettings.tsx Outdated

showFeedbackButton();

}

if (

Copy link

Contributor

mdroidian Apr 5, 2025

Choose a reason for hiding this comment

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

When is this required?

mdroidian requested changes Apr 5, 2025

View reviewed changes

review

098474f

vercel bot temporarily deployed to Preview April 8, 2025 01:06 Inactive

sid597 requested a review from mdroidian April 8, 2025 16:43

.

f39cf43

mdroidian approved these changes Apr 10, 2025

View reviewed changes

vercel bot temporarily deployed to Preview April 10, 2025 20:01 Inactive

mdroidian merged commit f44050d into main Apr 10, 2025
4 checks passed

mdroidian deleted the toggle-send-feedback branch April 10, 2025 20:02

github-project-automation bot moved this to Done in General Apr 10, 2025

coderabbitai bot mentioned this pull request Apr 11, 2025

Roam: Add feedback button to settings menu - ENG-147 #122

Merged

coderabbitai bot mentioned this pull request Aug 11, 2025

ENG-592 Replace Send feedback button with a FAB (Floating Action Button) containing DG logo #337

Merged

Roam: Add feedback toggle #118

Roam: Add feedback toggle #118

Uh oh!

Conversation

sid597 commented Apr 4, 2025 • edited by mdroidian Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sid597 commented Apr 4, 2025

Uh oh!

coderabbitai bot commented Apr 4, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

mdroidian left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

mdroidian left a comment

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

mdroidian Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sid597 commented Apr 4, 2025 •

edited by mdroidian

Loading

vercel bot commented Apr 4, 2025 •

edited

Loading

coderabbitai bot commented Apr 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mdroidian Apr 5, 2025 •

edited

Loading

mdroidian left a comment •

edited

Loading