1use std::{
2 any::TypeId,
3 ops::{Range, RangeInclusive},
4 sync::Arc,
5};
6
7use anyhow::bail;
8use client::{Client, ZED_SECRET_CLIENT_TOKEN, ZED_SERVER_URL};
9use editor::{Anchor, Editor};
10use futures::AsyncReadExt;
11use gpui::{
12 actions,
13 elements::{ChildView, Flex, Label, ParentElement, Svg},
14 platform::PromptLevel,
15 serde_json, AnyViewHandle, AppContext, Drawable, Element, Entity, ModelHandle, Task, View,
16 ViewContext, ViewHandle,
17};
18use isahc::Request;
19use language::Buffer;
20use postage::prelude::Stream;
21
22use project::Project;
23use serde::Serialize;
24use util::ResultExt;
25use workspace::{
26 item::{Item, ItemHandle},
27 searchable::{SearchableItem, SearchableItemHandle},
28 AppState, Pane, Workspace,
29};
30
31use crate::{submit_feedback_button::SubmitFeedbackButton, system_specs::SystemSpecs};
32
33const FEEDBACK_CHAR_LIMIT: RangeInclusive<usize> = 10..=5000;
34const FEEDBACK_SUBMISSION_ERROR_TEXT: &str =
35 "Feedback failed to submit, see error log for details.";
36
37actions!(feedback, [GiveFeedback, SubmitFeedback]);
38
39pub fn init(system_specs: SystemSpecs, app_state: Arc<AppState>, cx: &mut AppContext) {
40 cx.add_action({
41 move |workspace: &mut Workspace, _: &GiveFeedback, cx: &mut ViewContext<Workspace>| {
42 FeedbackEditor::deploy(system_specs.clone(), workspace, app_state.clone(), cx);
43 }
44 });
45
46 cx.add_async_action(
47 |submit_feedback_button: &mut SubmitFeedbackButton, _: &SubmitFeedback, cx| {
48 if let Some(active_item) = submit_feedback_button.active_item.as_ref() {
49 Some(active_item.update(cx, |feedback_editor, cx| feedback_editor.handle_save(cx)))
50 } else {
51 None
52 }
53 },
54 );
55}
56
57#[derive(Serialize)]
58struct FeedbackRequestBody<'a> {
59 feedback_text: &'a str,
60 metrics_id: Option<Arc<str>>,
61 system_specs: SystemSpecs,
62 is_staff: bool,
63 token: &'a str,
64}
65
66#[derive(Clone)]
67pub(crate) struct FeedbackEditor {
68 system_specs: SystemSpecs,
69 editor: ViewHandle<Editor>,
70 project: ModelHandle<Project>,
71}
72
73impl FeedbackEditor {
74 fn new(
75 system_specs: SystemSpecs,
76 project: ModelHandle<Project>,
77 buffer: ModelHandle<Buffer>,
78 cx: &mut ViewContext<Self>,
79 ) -> Self {
80 let editor = cx.add_view(|cx| {
81 let mut editor = Editor::for_buffer(buffer, Some(project.clone()), cx);
82 editor.set_vertical_scroll_margin(5, cx);
83 editor
84 });
85
86 cx.subscribe(&editor, |_, _, e, cx| cx.emit(e.clone()))
87 .detach();
88
89 Self {
90 system_specs: system_specs.clone(),
91 editor,
92 project,
93 }
94 }
95
96 fn handle_save(&mut self, cx: &mut ViewContext<Self>) -> Task<anyhow::Result<()>> {
97 let feedback_text = self.editor.read(cx).text(cx);
98 let feedback_char_count = feedback_text.chars().count();
99 let feedback_text = feedback_text.trim().to_string();
100
101 let error = if feedback_char_count < *FEEDBACK_CHAR_LIMIT.start() {
102 Some(format!(
103 "Feedback can't be shorter than {} characters.",
104 FEEDBACK_CHAR_LIMIT.start()
105 ))
106 } else if feedback_char_count > *FEEDBACK_CHAR_LIMIT.end() {
107 Some(format!(
108 "Feedback can't be longer than {} characters.",
109 FEEDBACK_CHAR_LIMIT.end()
110 ))
111 } else {
112 None
113 };
114
115 if let Some(error) = error {
116 cx.prompt(PromptLevel::Critical, &error, &["OK"]);
117 return Task::ready(Ok(()));
118 }
119
120 let mut answer = cx.prompt(
121 PromptLevel::Info,
122 "Ready to submit your feedback?",
123 &["Yes, Submit!", "No"],
124 );
125
126 let this = cx.handle();
127 let client = cx.global::<Arc<Client>>().clone();
128 let specs = self.system_specs.clone();
129
130 cx.spawn(|_, mut cx| async move {
131 let answer = answer.recv().await;
132
133 if answer == Some(0) {
134 match FeedbackEditor::submit_feedback(&feedback_text, client, specs).await {
135 Ok(_) => {
136 this.update(&mut cx, |_, cx| {
137 cx.dispatch_action(workspace::CloseActiveItem);
138 })
139 .log_err();
140 }
141 Err(error) => {
142 log::error!("{}", error);
143 this.update(&mut cx, |_, cx| {
144 cx.prompt(
145 PromptLevel::Critical,
146 FEEDBACK_SUBMISSION_ERROR_TEXT,
147 &["OK"],
148 );
149 })
150 .log_err();
151 }
152 }
153 }
154 })
155 .detach();
156
157 Task::ready(Ok(()))
158 }
159
160 async fn submit_feedback(
161 feedback_text: &str,
162 zed_client: Arc<Client>,
163 system_specs: SystemSpecs,
164 ) -> anyhow::Result<()> {
165 let feedback_endpoint = format!("{}/api/feedback", *ZED_SERVER_URL);
166
167 let metrics_id = zed_client.metrics_id();
168 let is_staff = zed_client.is_staff();
169 let http_client = zed_client.http_client();
170
171 let request = FeedbackRequestBody {
172 feedback_text: &feedback_text,
173 metrics_id,
174 system_specs,
175 is_staff: is_staff.unwrap_or(false),
176 token: ZED_SECRET_CLIENT_TOKEN,
177 };
178
179 let json_bytes = serde_json::to_vec(&request)?;
180
181 let request = Request::post(feedback_endpoint)
182 .header("content-type", "application/json")
183 .body(json_bytes.into())?;
184
185 let mut response = http_client.send(request).await?;
186 let mut body = String::new();
187 response.body_mut().read_to_string(&mut body).await?;
188
189 let response_status = response.status();
190
191 if !response_status.is_success() {
192 bail!("Feedback API failed with error: {}", response_status)
193 }
194
195 Ok(())
196 }
197}
198
199impl FeedbackEditor {
200 pub fn deploy(
201 system_specs: SystemSpecs,
202 _: &mut Workspace,
203 app_state: Arc<AppState>,
204 cx: &mut ViewContext<Workspace>,
205 ) {
206 let markdown = app_state.languages.language_for_name("Markdown");
207 cx.spawn(|workspace, mut cx| async move {
208 let markdown = markdown.await.log_err();
209 workspace
210 .update(&mut cx, |workspace, cx| {
211 workspace.with_local_workspace(&app_state, cx, |workspace, cx| {
212 let project = workspace.project().clone();
213 let buffer = project
214 .update(cx, |project, cx| project.create_buffer("", markdown, cx))
215 .expect("creating buffers on a local workspace always succeeds");
216 let feedback_editor = cx
217 .add_view(|cx| FeedbackEditor::new(system_specs, project, buffer, cx));
218 workspace.add_item(Box::new(feedback_editor), cx);
219 })
220 })?
221 .await
222 })
223 .detach_and_log_err(cx);
224 }
225}
226
227impl View for FeedbackEditor {
228 fn ui_name() -> &'static str {
229 "FeedbackEditor"
230 }
231
232 fn render(&mut self, cx: &mut ViewContext<Self>) -> Element<Self> {
233 ChildView::new(&self.editor, cx).boxed()
234 }
235
236 fn focus_in(&mut self, _: AnyViewHandle, cx: &mut ViewContext<Self>) {
237 if cx.is_self_focused() {
238 cx.focus(&self.editor);
239 }
240 }
241}
242
243impl Entity for FeedbackEditor {
244 type Event = editor::Event;
245}
246
247impl Item for FeedbackEditor {
248 fn tab_content(&self, _: Option<usize>, style: &theme::Tab, _: &AppContext) -> Element<Pane> {
249 Flex::row()
250 .with_child(
251 Svg::new("icons/feedback_16.svg")
252 .with_color(style.label.text.color)
253 .constrained()
254 .with_width(style.type_icon_width)
255 .aligned()
256 .contained()
257 .with_margin_right(style.spacing)
258 .boxed(),
259 )
260 .with_child(
261 Label::new("Send Feedback", style.label.clone())
262 .aligned()
263 .contained()
264 .boxed(),
265 )
266 .boxed()
267 }
268
269 fn for_each_project_item(&self, cx: &AppContext, f: &mut dyn FnMut(usize, &dyn project::Item)) {
270 self.editor.for_each_project_item(cx, f)
271 }
272
273 fn is_singleton(&self, _: &AppContext) -> bool {
274 true
275 }
276
277 fn can_save(&self, _: &AppContext) -> bool {
278 true
279 }
280
281 fn save(
282 &mut self,
283 _: ModelHandle<Project>,
284 cx: &mut ViewContext<Self>,
285 ) -> Task<anyhow::Result<()>> {
286 self.handle_save(cx)
287 }
288
289 fn save_as(
290 &mut self,
291 _: ModelHandle<Project>,
292 _: std::path::PathBuf,
293 cx: &mut ViewContext<Self>,
294 ) -> Task<anyhow::Result<()>> {
295 self.handle_save(cx)
296 }
297
298 fn reload(
299 &mut self,
300 _: ModelHandle<Project>,
301 _: &mut ViewContext<Self>,
302 ) -> Task<anyhow::Result<()>> {
303 Task::Ready(Some(Ok(())))
304 }
305
306 fn clone_on_split(
307 &self,
308 _workspace_id: workspace::WorkspaceId,
309 cx: &mut ViewContext<Self>,
310 ) -> Option<Self>
311 where
312 Self: Sized,
313 {
314 let buffer = self
315 .editor
316 .read(cx)
317 .buffer()
318 .read(cx)
319 .as_singleton()
320 .expect("Feedback buffer is only ever singleton");
321
322 Some(Self::new(
323 self.system_specs.clone(),
324 self.project.clone(),
325 buffer.clone(),
326 cx,
327 ))
328 }
329
330 fn as_searchable(&self, handle: &ViewHandle<Self>) -> Option<Box<dyn SearchableItemHandle>> {
331 Some(Box::new(handle.clone()))
332 }
333
334 fn act_as_type<'a>(
335 &'a self,
336 type_id: TypeId,
337 self_handle: &'a ViewHandle<Self>,
338 _: &'a AppContext,
339 ) -> Option<&'a AnyViewHandle> {
340 if type_id == TypeId::of::<Self>() {
341 Some(self_handle)
342 } else if type_id == TypeId::of::<Editor>() {
343 Some(&self.editor)
344 } else {
345 None
346 }
347 }
348}
349
350impl SearchableItem for FeedbackEditor {
351 type Match = Range<Anchor>;
352
353 fn to_search_event(event: &Self::Event) -> Option<workspace::searchable::SearchEvent> {
354 Editor::to_search_event(event)
355 }
356
357 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
358 self.editor
359 .update(cx, |editor, cx| editor.clear_matches(cx))
360 }
361
362 fn update_matches(&mut self, matches: Vec<Self::Match>, cx: &mut ViewContext<Self>) {
363 self.editor
364 .update(cx, |editor, cx| editor.update_matches(matches, cx))
365 }
366
367 fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
368 self.editor
369 .update(cx, |editor, cx| editor.query_suggestion(cx))
370 }
371
372 fn activate_match(
373 &mut self,
374 index: usize,
375 matches: Vec<Self::Match>,
376 cx: &mut ViewContext<Self>,
377 ) {
378 self.editor
379 .update(cx, |editor, cx| editor.activate_match(index, matches, cx))
380 }
381
382 fn find_matches(
383 &mut self,
384 query: project::search::SearchQuery,
385 cx: &mut ViewContext<Self>,
386 ) -> Task<Vec<Self::Match>> {
387 self.editor
388 .update(cx, |editor, cx| editor.find_matches(query, cx))
389 }
390
391 fn active_match_index(
392 &mut self,
393 matches: Vec<Self::Match>,
394 cx: &mut ViewContext<Self>,
395 ) -> Option<usize> {
396 self.editor
397 .update(cx, |editor, cx| editor.active_match_index(matches, cx))
398 }
399}