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