Module: Bugwatch::FeedbackHelper

Defined in:
lib/bugwatch/feedback_helper.rb

Instance Method Summary collapse

Instance Method Details

#bugwatch_feedback_widget(user_email: nil, user_name: nil, issue_id: nil, metadata: {}, placeholder: "What happened? Tell us about the issue...", submit_text: "Send Feedback", success_message: "Thanks for your feedback!") ⇒ Object

Renders a minimal, unstyled feedback widget form.

The form submits via fetch to the BugWatch feedback API. All markup uses “bugwatch-feedback-*” CSS classes so you can style it however you want without collisions.

Options:

:user_email  - Pre-fill email (e.g. current_user.email)
:user_name   - Pre-fill name  (e.g. current_user.name)
:issue_id    - Link feedback to a specific BugWatch issue
:metadata    - Hash of extra data to attach
:placeholder - Textarea placeholder text
:submit_text - Submit button label (default: "Send Feedback")
:success_message - Message shown after successful submit



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/bugwatch/feedback_helper.rb', line 18

def bugwatch_feedback_widget(user_email: nil, user_name: nil, issue_id: nil, metadata: {}, placeholder: "What happened? Tell us about the issue...", submit_text: "Send Feedback", success_message: "Thanks for your feedback!")
  config   = Bugwatch.configuration
  endpoint = "#{config.endpoint&.chomp("/")}/api/v1/feedback"
  api_key  = config.api_key
  widget_id = "bugwatch-feedback-#{SecureRandom.hex(4)}"

  html = <<~HTML
    <form id="#{widget_id}" class="bugwatch-feedback-form" data-bugwatch-feedback>
      <div class="bugwatch-feedback-field">
        <label for="#{widget_id}-name" class="bugwatch-feedback-label">Name</label>
        <input type="text" id="#{widget_id}-name" name="name" value="#{ERB::Util.html_escape(user_name.to_s)}" class="bugwatch-feedback-input" />
      </div>
      <div class="bugwatch-feedback-field">
        <label for="#{widget_id}-email" class="bugwatch-feedback-label">Email</label>
        <input type="email" id="#{widget_id}-email" name="email" value="#{ERB::Util.html_escape(user_email.to_s)}" class="bugwatch-feedback-input" />
      </div>
      <div class="bugwatch-feedback-field">
        <label for="#{widget_id}-message" class="bugwatch-feedback-label">Message</label>
        <textarea id="#{widget_id}-message" name="message" required class="bugwatch-feedback-textarea" placeholder="#{ERB::Util.html_escape(placeholder)}"></textarea>
      </div>
      <button type="submit" class="bugwatch-feedback-submit">#{ERB::Util.html_escape(submit_text)}</button>
      <div class="bugwatch-feedback-success" style="display:none">#{ERB::Util.html_escape(success_message)}</div>
      <div class="bugwatch-feedback-error" style="display:none"></div>
    </form>
    <script>
      (function() {
        var form = document.getElementById("#{widget_id}");
        form.addEventListener("submit", function(e) {
          e.preventDefault();
          var btn     = form.querySelector(".bugwatch-feedback-submit");
          var success = form.querySelector(".bugwatch-feedback-success");
          var error   = form.querySelector(".bugwatch-feedback-error");
          success.style.display = "none";
          error.style.display   = "none";
          btn.disabled = true;

          var body = {
            api_key: #{api_key.to_json},
            message: form.querySelector("[name=message]").value,
            name:    form.querySelector("[name=name]").value || undefined,
            email:   form.querySelector("[name=email]").value || undefined,
            url:     window.location.href
          };
          #{issue_id ? "body.issue_id = #{issue_id.to_json};" : ""}
          #{metadata.any? ? "body.metadata = #{metadata.to_json};" : ""}

          fetch(#{endpoint.to_json}, {
            method: "POST",
            headers: { "Content-Type": "application/json" },
            body: JSON.stringify(body)
          }).then(function(r) {
            if (!r.ok) throw new Error("Request failed");
            form.querySelector("[name=message]").value = "";
            success.style.display = "";
            btn.disabled = false;
          }).catch(function(err) {
            error.textContent = "Something went wrong. Please try again.";
            error.style.display = "";
            btn.disabled = false;
          });
        });
      })();
    </script>
  HTML

  html.html_safe
end