1use std::{ops::RangeInclusive, sync::Arc, time::Duration};
2
3use anyhow::{anyhow, bail};
4use bitflags::bitflags;
5use client::Client;
6use db::kvp::KEY_VALUE_STORE;
7use editor::{Editor, EditorEvent};
8use futures::AsyncReadExt;
9use gpui::{
10 div, rems, AppContext, DismissEvent, EventEmitter, FocusHandle, FocusableView, Model,
11 PromptLevel, Render, Task, View, ViewContext,
12};
13use http::HttpClient;
14use isahc::Request;
15use language::Buffer;
16use project::Project;
17use regex::Regex;
18use serde_derive::Serialize;
19use ui::{prelude::*, Button, ButtonStyle, IconPosition, Tooltip};
20use util::ResultExt;
21use workspace::notifications::NotificationId;
22use workspace::{DismissDecision, ModalView, Toast, Workspace};
23
24use crate::{system_specs::SystemSpecs, GiveFeedback, OpenZedRepo};
25
26// For UI testing purposes
27const SEND_SUCCESS_IN_DEV_MODE: bool = true;
28const SEND_TIME_IN_DEV_MODE: Duration = Duration::from_secs(2);
29
30// Temporary, until tests are in place
31#[cfg(debug_assertions)]
32const DEV_MODE: bool = true;
33
34#[cfg(not(debug_assertions))]
35const DEV_MODE: bool = false;
36
37const DATABASE_KEY_NAME: &str = "email_address";
38const EMAIL_REGEX: &str = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b";
39const FEEDBACK_CHAR_LIMIT: RangeInclusive<i32> = 10..=5000;
40const FEEDBACK_SUBMISSION_ERROR_TEXT: &str =
41 "Feedback failed to submit, see error log for details.";
42
43#[derive(Serialize)]
44struct FeedbackRequestBody<'a> {
45 feedback_text: &'a str,
46 email: Option<String>,
47 metrics_id: Option<Arc<str>>,
48 installation_id: Option<Arc<str>>,
49 system_specs: SystemSpecs,
50 is_staff: bool,
51}
52
53bitflags! {
54 #[derive(Debug, Clone, PartialEq)]
55 struct InvalidStateFlags: u8 {
56 const EmailAddress = 0b00000001;
57 const CharacterCount = 0b00000010;
58 }
59}
60
61#[derive(Debug, Clone, PartialEq)]
62enum CannotSubmitReason {
63 InvalidState { flags: InvalidStateFlags },
64 AwaitingSubmission,
65}
66
67#[derive(Debug, Clone, PartialEq)]
68enum SubmissionState {
69 CanSubmit,
70 CannotSubmit { reason: CannotSubmitReason },
71}
72
73pub struct FeedbackModal {
74 system_specs: SystemSpecs,
75 feedback_editor: View<Editor>,
76 email_address_editor: View<Editor>,
77 submission_state: Option<SubmissionState>,
78 dismiss_modal: bool,
79 character_count: i32,
80}
81
82impl FocusableView for FeedbackModal {
83 fn focus_handle(&self, cx: &AppContext) -> FocusHandle {
84 self.feedback_editor.focus_handle(cx)
85 }
86}
87impl EventEmitter<DismissEvent> for FeedbackModal {}
88
89impl ModalView for FeedbackModal {
90 fn on_before_dismiss(&mut self, cx: &mut ViewContext<Self>) -> DismissDecision {
91 self.update_email_in_store(cx);
92
93 if self.dismiss_modal {
94 return DismissDecision::Dismiss(true);
95 }
96
97 let has_feedback = self.feedback_editor.read(cx).text_option(cx).is_some();
98 if !has_feedback {
99 return DismissDecision::Dismiss(true);
100 }
101
102 let answer = cx.prompt(PromptLevel::Info, "Discard feedback?", None, &["Yes", "No"]);
103
104 cx.spawn(move |this, mut cx| async move {
105 if answer.await.ok() == Some(0) {
106 this.update(&mut cx, |this, cx| {
107 this.dismiss_modal = true;
108 cx.emit(DismissEvent)
109 })
110 .log_err();
111 }
112 })
113 .detach();
114
115 DismissDecision::Pending
116 }
117}
118
119impl FeedbackModal {
120 pub fn register(workspace: &mut Workspace, cx: &mut ViewContext<Workspace>) {
121 let _handle = cx.view().downgrade();
122 workspace.register_action(move |workspace, _: &GiveFeedback, cx| {
123 let markdown = workspace
124 .app_state()
125 .languages
126 .language_for_name("Markdown");
127
128 let project = workspace.project().clone();
129 let is_local_project = project.read(cx).is_local();
130
131 if !is_local_project {
132 struct FeedbackInRemoteProject;
133
134 workspace.show_toast(
135 Toast::new(
136 NotificationId::unique::<FeedbackInRemoteProject>(),
137 "You can only submit feedback in your own project.",
138 ),
139 cx,
140 );
141 return;
142 }
143
144 cx.spawn(|workspace, mut cx| async move {
145 let markdown = markdown.await.log_err();
146 let buffer = project.update(&mut cx, |project, cx| {
147 project.create_local_buffer("", markdown, cx)
148 })?;
149
150 workspace.update(&mut cx, |workspace, cx| {
151 let system_specs = SystemSpecs::new(cx);
152
153 workspace.toggle_modal(cx, move |cx| {
154 FeedbackModal::new(system_specs, project, buffer, cx)
155 });
156 })?;
157
158 anyhow::Ok(())
159 })
160 .detach_and_log_err(cx);
161 });
162 }
163
164 pub fn new(
165 system_specs: SystemSpecs,
166 project: Model<Project>,
167 buffer: Model<Buffer>,
168 cx: &mut ViewContext<Self>,
169 ) -> Self {
170 let email_address_editor = cx.new_view(|cx| {
171 let mut editor = Editor::single_line(cx);
172 editor.set_placeholder_text("Email address (optional)", cx);
173
174 if let Ok(Some(email_address)) = KEY_VALUE_STORE.read_kvp(DATABASE_KEY_NAME) {
175 editor.set_text(email_address, cx)
176 }
177
178 editor
179 });
180
181 let feedback_editor = cx.new_view(|cx| {
182 let mut editor = Editor::for_buffer(buffer, Some(project.clone()), cx);
183 editor.set_placeholder_text(
184 "You can use markdown to organize your feedback with code and links.",
185 cx,
186 );
187 editor.set_show_gutter(false, cx);
188 editor.set_show_inline_completions(false);
189 editor.set_vertical_scroll_margin(5, cx);
190 editor.set_use_modal_editing(false);
191 editor
192 });
193
194 cx.subscribe(&feedback_editor, |this, editor, event: &EditorEvent, cx| {
195 if *event == EditorEvent::Edited {
196 this.character_count = editor
197 .read(cx)
198 .buffer()
199 .read(cx)
200 .as_singleton()
201 .expect("Feedback editor is never a multi-buffer")
202 .read(cx)
203 .len() as i32;
204 cx.notify();
205 }
206 })
207 .detach();
208
209 Self {
210 system_specs: system_specs.clone(),
211 feedback_editor,
212 email_address_editor,
213 submission_state: None,
214 dismiss_modal: false,
215 character_count: 0,
216 }
217 }
218
219 pub fn submit(&mut self, cx: &mut ViewContext<Self>) -> Task<anyhow::Result<()>> {
220 let feedback_text = self.feedback_editor.read(cx).text(cx).trim().to_string();
221 let email = self.email_address_editor.read(cx).text_option(cx);
222
223 let answer = cx.prompt(
224 PromptLevel::Info,
225 "Ready to submit your feedback?",
226 None,
227 &["Yes, Submit!", "No"],
228 );
229 let client = Client::global(cx).clone();
230 let specs = self.system_specs.clone();
231 cx.spawn(|this, mut cx| async move {
232 let answer = answer.await.ok();
233 if answer == Some(0) {
234 this.update(&mut cx, |this, cx| {
235 this.submission_state = Some(SubmissionState::CannotSubmit {
236 reason: CannotSubmitReason::AwaitingSubmission,
237 });
238 cx.notify();
239 })
240 .log_err();
241
242 let res =
243 FeedbackModal::submit_feedback(&feedback_text, email, client, specs).await;
244
245 match res {
246 Ok(_) => {
247 this.update(&mut cx, |this, cx| {
248 this.dismiss_modal = true;
249 cx.notify();
250 cx.emit(DismissEvent)
251 })
252 .ok();
253 }
254 Err(error) => {
255 log::error!("{}", error);
256 this.update(&mut cx, |this, cx| {
257 let prompt = cx.prompt(
258 PromptLevel::Critical,
259 FEEDBACK_SUBMISSION_ERROR_TEXT,
260 None,
261 &["OK"],
262 );
263 cx.spawn(|_, _cx| async move {
264 prompt.await.ok();
265 })
266 .detach();
267
268 this.submission_state = Some(SubmissionState::CanSubmit);
269 cx.notify();
270 })
271 .log_err();
272 }
273 }
274 }
275 })
276 .detach();
277
278 Task::ready(Ok(()))
279 }
280
281 async fn submit_feedback(
282 feedback_text: &str,
283 email: Option<String>,
284 zed_client: Arc<Client>,
285 system_specs: SystemSpecs,
286 ) -> anyhow::Result<()> {
287 if DEV_MODE {
288 smol::Timer::after(SEND_TIME_IN_DEV_MODE).await;
289
290 if SEND_SUCCESS_IN_DEV_MODE {
291 return Ok(());
292 } else {
293 return Err(anyhow!("Error submitting feedback"));
294 }
295 }
296
297 let telemetry = zed_client.telemetry();
298 let metrics_id = telemetry.metrics_id();
299 let installation_id = telemetry.installation_id();
300 let is_staff = telemetry.is_staff();
301 let http_client = zed_client.http_client();
302 let feedback_endpoint = http_client.build_url("/api/feedback");
303 let request = FeedbackRequestBody {
304 feedback_text: &feedback_text,
305 email,
306 metrics_id,
307 installation_id,
308 system_specs,
309 is_staff: is_staff.unwrap_or(false),
310 };
311 let json_bytes = serde_json::to_vec(&request)?;
312 let request = Request::post(feedback_endpoint)
313 .header("content-type", "application/json")
314 .body(json_bytes.into())?;
315 let mut response = http_client.send(request).await?;
316 let mut body = String::new();
317 response.body_mut().read_to_string(&mut body).await?;
318 let response_status = response.status();
319 if !response_status.is_success() {
320 bail!("Feedback API failed with error: {}", response_status)
321 }
322 Ok(())
323 }
324
325 fn update_submission_state(&mut self, cx: &mut ViewContext<Self>) {
326 if self.awaiting_submission() {
327 return;
328 }
329
330 let mut invalid_state_flags = InvalidStateFlags::empty();
331
332 let valid_email_address = match self.email_address_editor.read(cx).text_option(cx) {
333 Some(email_address) => Regex::new(EMAIL_REGEX).unwrap().is_match(&email_address),
334 None => true,
335 };
336
337 if !valid_email_address {
338 invalid_state_flags |= InvalidStateFlags::EmailAddress;
339 }
340
341 if !FEEDBACK_CHAR_LIMIT.contains(&self.character_count) {
342 invalid_state_flags |= InvalidStateFlags::CharacterCount;
343 }
344
345 if invalid_state_flags.is_empty() {
346 self.submission_state = Some(SubmissionState::CanSubmit);
347 } else {
348 self.submission_state = Some(SubmissionState::CannotSubmit {
349 reason: CannotSubmitReason::InvalidState {
350 flags: invalid_state_flags,
351 },
352 });
353 }
354 }
355
356 fn update_email_in_store(&self, cx: &mut ViewContext<Self>) {
357 let email = self.email_address_editor.read(cx).text_option(cx);
358
359 cx.spawn(|_, _| async move {
360 match email {
361 Some(email) => {
362 KEY_VALUE_STORE
363 .write_kvp(DATABASE_KEY_NAME.to_string(), email)
364 .await
365 .ok();
366 }
367 None => {
368 KEY_VALUE_STORE
369 .delete_kvp(DATABASE_KEY_NAME.to_string())
370 .await
371 .ok();
372 }
373 }
374 })
375 .detach();
376 }
377
378 fn valid_email_address(&self) -> bool {
379 !self.in_invalid_state(InvalidStateFlags::EmailAddress)
380 }
381
382 fn valid_character_count(&self) -> bool {
383 !self.in_invalid_state(InvalidStateFlags::CharacterCount)
384 }
385
386 fn in_invalid_state(&self, flag: InvalidStateFlags) -> bool {
387 match self.submission_state {
388 Some(SubmissionState::CannotSubmit {
389 reason: CannotSubmitReason::InvalidState { ref flags },
390 }) => flags.contains(flag),
391 _ => false,
392 }
393 }
394
395 fn awaiting_submission(&self) -> bool {
396 matches!(
397 self.submission_state,
398 Some(SubmissionState::CannotSubmit {
399 reason: CannotSubmitReason::AwaitingSubmission
400 })
401 )
402 }
403
404 fn can_submit(&self) -> bool {
405 matches!(self.submission_state, Some(SubmissionState::CanSubmit))
406 }
407
408 fn cancel(&mut self, _: &menu::Cancel, cx: &mut ViewContext<Self>) {
409 cx.emit(DismissEvent)
410 }
411}
412
413impl Render for FeedbackModal {
414 fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
415 self.update_submission_state(cx);
416
417 let submit_button_text = if self.awaiting_submission() {
418 "Submitting..."
419 } else {
420 "Submit"
421 };
422
423 let open_zed_repo = cx.listener(|_, _, cx| cx.dispatch_action(Box::new(OpenZedRepo)));
424
425 v_flex()
426 .elevation_3(cx)
427 .key_context("GiveFeedback")
428 .on_action(cx.listener(Self::cancel))
429 .min_w(rems(40.))
430 .max_w(rems(96.))
431 .h(rems(32.))
432 .p_4()
433 .gap_2()
434 .child(Headline::new("Give Feedback"))
435 .child(
436 Label::new(if self.character_count < *FEEDBACK_CHAR_LIMIT.start() {
437 format!(
438 "Feedback must be at least {} characters.",
439 FEEDBACK_CHAR_LIMIT.start()
440 )
441 } else {
442 format!(
443 "Characters: {}",
444 *FEEDBACK_CHAR_LIMIT.end() - self.character_count
445 )
446 })
447 .color(if self.valid_character_count() {
448 Color::Success
449 } else {
450 Color::Error
451 }),
452 )
453 .child(
454 div()
455 .flex_1()
456 .bg(cx.theme().colors().editor_background)
457 .p_2()
458 .border_1()
459 .rounded_md()
460 .border_color(cx.theme().colors().border)
461 .child(self.feedback_editor.clone()),
462 )
463 .child(
464 v_flex()
465 .gap_1()
466 .child(
467 h_flex()
468 .bg(cx.theme().colors().editor_background)
469 .p_2()
470 .border_1()
471 .rounded_md()
472 .border_color(if self.valid_email_address() {
473 cx.theme().colors().border
474 } else {
475 cx.theme().status().error_border
476 })
477 .child(self.email_address_editor.clone()),
478 )
479 .child(
480 Label::new("Provide an email address if you want us to be able to reply.")
481 .size(LabelSize::Small)
482 .color(Color::Muted),
483 ),
484 )
485 .child(
486 h_flex()
487 .justify_between()
488 .gap_1()
489 .child(
490 Button::new("zed_repository", "Zed Repository")
491 .style(ButtonStyle::Transparent)
492 .icon(IconName::ExternalLink)
493 .icon_position(IconPosition::End)
494 .icon_size(IconSize::Small)
495 .on_click(open_zed_repo),
496 )
497 .child(
498 h_flex()
499 .gap_1()
500 .child(
501 Button::new("cancel_feedback", "Cancel")
502 .style(ButtonStyle::Subtle)
503 .color(Color::Muted)
504 .on_click(cx.listener(move |_, _, cx| {
505 cx.spawn(|this, mut cx| async move {
506 this.update(&mut cx, |_, cx| cx.emit(DismissEvent))
507 .ok();
508 })
509 .detach();
510 })),
511 )
512 .child(
513 Button::new("submit_feedback", submit_button_text)
514 .color(Color::Accent)
515 .style(ButtonStyle::Filled)
516 .on_click(cx.listener(|this, _, cx| {
517 this.submit(cx).detach();
518 }))
519 .tooltip(move |cx| {
520 Tooltip::text("Submit feedback to the Zed team.", cx)
521 })
522 .when(!self.can_submit(), |this| this.disabled(true)),
523 ),
524 ),
525 )
526 }
527}
528
529// TODO: Testing of various button states, dismissal prompts, etc. :)