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 let feedback_editor = cx.new_view(|cx| {
183 let mut editor = Editor::for_buffer(buffer, Some(project.clone()), cx);
184 editor.set_placeholder_text(
185 "You can use markdown to organize your feedback with code and links.",
186 cx,
187 );
188 editor.set_show_gutter(false, cx);
189 editor.set_vertical_scroll_margin(5, cx);
190 editor
191 });
192
193 cx.subscribe(&feedback_editor, |this, editor, event: &EditorEvent, cx| {
194 if *event == EditorEvent::Edited {
195 this.character_count = editor
196 .read(cx)
197 .buffer()
198 .read(cx)
199 .as_singleton()
200 .expect("Feedback editor is never a multi-buffer")
201 .read(cx)
202 .len() as i32;
203 cx.notify();
204 }
205 })
206 .detach();
207
208 Self {
209 system_specs: system_specs.clone(),
210 feedback_editor,
211 email_address_editor,
212 submission_state: None,
213 dismiss_modal: false,
214 character_count: 0,
215 }
216 }
217
218 pub fn submit(&mut self, cx: &mut ViewContext<Self>) -> Task<anyhow::Result<()>> {
219 let feedback_text = self.feedback_editor.read(cx).text(cx).trim().to_string();
220 let email = self.email_address_editor.read(cx).text_option(cx);
221
222 let answer = cx.prompt(
223 PromptLevel::Info,
224 "Ready to submit your feedback?",
225 &["Yes, Submit!", "No"],
226 );
227 let client = cx.global::<Arc<Client>>().clone();
228 let specs = self.system_specs.clone();
229 cx.spawn(|this, mut cx| async move {
230 let answer = answer.await.ok();
231 if answer == Some(0) {
232 this.update(&mut cx, |this, cx| {
233 this.submission_state = Some(SubmissionState::CannotSubmit {
234 reason: CannotSubmitReason::AwaitingSubmission,
235 });
236 cx.notify();
237 })
238 .log_err();
239
240 let res =
241 FeedbackModal::submit_feedback(&feedback_text, email, client, specs).await;
242
243 match res {
244 Ok(_) => {
245 this.update(&mut cx, |this, cx| {
246 this.dismiss_modal = true;
247 cx.notify();
248 cx.emit(DismissEvent)
249 })
250 .ok();
251 }
252 Err(error) => {
253 log::error!("{}", error);
254 this.update(&mut cx, |this, cx| {
255 let prompt = cx.prompt(
256 PromptLevel::Critical,
257 FEEDBACK_SUBMISSION_ERROR_TEXT,
258 &["OK"],
259 );
260 cx.spawn(|_, _cx| async move {
261 prompt.await.ok();
262 })
263 .detach();
264
265 this.submission_state = Some(SubmissionState::CanSubmit);
266 cx.notify();
267 })
268 .log_err();
269 }
270 }
271 }
272 })
273 .detach();
274
275 Task::ready(Ok(()))
276 }
277
278 async fn submit_feedback(
279 feedback_text: &str,
280 email: Option<String>,
281 zed_client: Arc<Client>,
282 system_specs: SystemSpecs,
283 ) -> anyhow::Result<()> {
284 if DEV_MODE {
285 smol::Timer::after(SEND_TIME_IN_DEV_MODE).await;
286
287 if SEND_SUCCESS_IN_DEV_MODE {
288 return Ok(());
289 } else {
290 return Err(anyhow!("Error submitting feedback"));
291 }
292 }
293
294 let feedback_endpoint = format!("{}/api/feedback", *ZED_SERVER_URL);
295 let telemetry = zed_client.telemetry();
296 let metrics_id = telemetry.metrics_id();
297 let installation_id = telemetry.installation_id();
298 let is_staff = telemetry.is_staff();
299 let http_client = zed_client.http_client();
300 let request = FeedbackRequestBody {
301 feedback_text: &feedback_text,
302 email,
303 metrics_id,
304 installation_id,
305 system_specs,
306 is_staff: is_staff.unwrap_or(false),
307 token: ZED_SECRET_CLIENT_TOKEN,
308 };
309 let json_bytes = serde_json::to_vec(&request)?;
310 let request = Request::post(feedback_endpoint)
311 .header("content-type", "application/json")
312 .body(json_bytes.into())?;
313 let mut response = http_client.send(request).await?;
314 let mut body = String::new();
315 response.body_mut().read_to_string(&mut body).await?;
316 let response_status = response.status();
317 if !response_status.is_success() {
318 bail!("Feedback API failed with error: {}", response_status)
319 }
320 Ok(())
321 }
322
323 fn update_submission_state(&mut self, cx: &mut ViewContext<Self>) {
324 if self.awaiting_submission() {
325 return;
326 }
327
328 let mut invalid_state_flags = InvalidStateFlags::empty();
329
330 let valid_email_address = match self.email_address_editor.read(cx).text_option(cx) {
331 Some(email_address) => Regex::new(EMAIL_REGEX).unwrap().is_match(&email_address),
332 None => true,
333 };
334
335 if !valid_email_address {
336 invalid_state_flags |= InvalidStateFlags::EmailAddress;
337 }
338
339 if !FEEDBACK_CHAR_LIMIT.contains(&self.character_count) {
340 invalid_state_flags |= InvalidStateFlags::CharacterCount;
341 }
342
343 if invalid_state_flags.is_empty() {
344 self.submission_state = Some(SubmissionState::CanSubmit);
345 } else {
346 self.submission_state = Some(SubmissionState::CannotSubmit {
347 reason: CannotSubmitReason::InvalidState {
348 flags: invalid_state_flags,
349 },
350 });
351 }
352 }
353
354 fn update_email_in_store(&self, cx: &mut ViewContext<Self>) {
355 let email = self.email_address_editor.read(cx).text_option(cx);
356
357 cx.spawn(|_, _| async move {
358 match email {
359 Some(email) => {
360 KEY_VALUE_STORE
361 .write_kvp(DATABASE_KEY_NAME.to_string(), email)
362 .await
363 .ok();
364 }
365 None => {
366 KEY_VALUE_STORE
367 .delete_kvp(DATABASE_KEY_NAME.to_string())
368 .await
369 .ok();
370 }
371 }
372 })
373 .detach();
374 }
375
376 fn valid_email_address(&self) -> bool {
377 !self.in_invalid_state(InvalidStateFlags::EmailAddress)
378 }
379
380 fn valid_character_count(&self) -> bool {
381 !self.in_invalid_state(InvalidStateFlags::CharacterCount)
382 }
383
384 fn in_invalid_state(&self, flag: InvalidStateFlags) -> bool {
385 match self.submission_state {
386 Some(SubmissionState::CannotSubmit {
387 reason: CannotSubmitReason::InvalidState { ref flags },
388 }) => flags.contains(flag),
389 _ => false,
390 }
391 }
392
393 fn awaiting_submission(&self) -> bool {
394 matches!(
395 self.submission_state,
396 Some(SubmissionState::CannotSubmit {
397 reason: CannotSubmitReason::AwaitingSubmission
398 })
399 )
400 }
401
402 fn can_submit(&self) -> bool {
403 matches!(self.submission_state, Some(SubmissionState::CanSubmit))
404 }
405
406 fn cancel(&mut self, _: &menu::Cancel, cx: &mut ViewContext<Self>) {
407 cx.emit(DismissEvent)
408 }
409}
410
411impl Render for FeedbackModal {
412 fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
413 self.update_submission_state(cx);
414
415 let submit_button_text = if self.awaiting_submission() {
416 "Submitting..."
417 } else {
418 "Submit"
419 };
420
421 let open_community_repo =
422 cx.listener(|_, _, cx| cx.dispatch_action(Box::new(OpenZedCommunityRepo)));
423
424 v_stack()
425 .elevation_3(cx)
426 .key_context("GiveFeedback")
427 .on_action(cx.listener(Self::cancel))
428 .min_w(rems(40.))
429 .max_w(rems(96.))
430 .h(rems(32.))
431 .p_4()
432 .gap_2()
433 .child(Headline::new("Share Feedback"))
434 .child(
435 Label::new(if self.character_count < *FEEDBACK_CHAR_LIMIT.start() {
436 format!(
437 "Feedback must be at least {} characters.",
438 FEEDBACK_CHAR_LIMIT.start()
439 )
440 } else {
441 format!(
442 "Characters: {}",
443 *FEEDBACK_CHAR_LIMIT.end() - self.character_count
444 )
445 })
446 .color(if self.valid_character_count() {
447 Color::Success
448 } else {
449 Color::Error
450 }),
451 )
452 .child(
453 div()
454 .flex_1()
455 .bg(cx.theme().colors().editor_background)
456 .p_2()
457 .border()
458 .rounded_md()
459 .border_color(cx.theme().colors().border)
460 .child(self.feedback_editor.clone()),
461 )
462 .child(
463 v_stack()
464 .gap_1()
465 .child(
466 h_stack()
467 .bg(cx.theme().colors().editor_background)
468 .p_2()
469 .border()
470 .rounded_md()
471 .border_color(if self.valid_email_address() {
472 cx.theme().colors().border
473 } else {
474 cx.theme().status().error_border
475 })
476 .child(self.email_address_editor.clone()),
477 )
478 .child(
479 Label::new("Provide an email address if you want us to be able to reply.")
480 .size(LabelSize::Small)
481 .color(Color::Muted),
482 ),
483 )
484 .child(
485 h_stack()
486 .justify_between()
487 .gap_1()
488 .child(
489 Button::new("community_repository", "Community Repository")
490 .style(ButtonStyle::Transparent)
491 .icon(IconName::ExternalLink)
492 .icon_position(IconPosition::End)
493 .icon_size(IconSize::Small)
494 .on_click(open_community_repo),
495 )
496 .child(
497 h_stack()
498 .gap_1()
499 .child(
500 Button::new("cancel_feedback", "Cancel")
501 .style(ButtonStyle::Subtle)
502 .color(Color::Muted)
503 .on_click(cx.listener(move |_, _, cx| {
504 cx.spawn(|this, mut cx| async move {
505 this.update(&mut cx, |_, cx| cx.emit(DismissEvent))
506 .ok();
507 })
508 .detach();
509 })),
510 )
511 .child(
512 Button::new("submit_feedback", submit_button_text)
513 .color(Color::Accent)
514 .style(ButtonStyle::Filled)
515 .on_click(cx.listener(|this, _, cx| {
516 this.submit(cx).detach();
517 }))
518 .tooltip(move |cx| {
519 Tooltip::text("Submit feedback to the Zed team.", cx)
520 })
521 .when(!self.can_submit(), |this| this.disabled(true)),
522 ),
523 ),
524 )
525 }
526}
527
528// TODO: Testing of various button states, dismissal prompts, etc. :)