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