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 cx.update(|cx| {
137 this.update(cx, |_, cx| {
138 cx.dispatch_action(workspace::CloseActiveItem);
139 })
140 });
141 }
142 Err(error) => {
143 log::error!("{}", error);
144
145 cx.update(|cx| {
146 this.update(cx, |_, cx| {
147 cx.prompt(
148 PromptLevel::Critical,
149 FEEDBACK_SUBMISSION_ERROR_TEXT,
150 &["OK"],
151 );
152 })
153 });
154 }
155 }
156 }
157 })
158 .detach();
159
160 Task::ready(Ok(()))
161 }
162
163 async fn submit_feedback(
164 feedback_text: &str,
165 zed_client: Arc<Client>,
166 system_specs: SystemSpecs,
167 ) -> anyhow::Result<()> {
168 let feedback_endpoint = format!("{}/api/feedback", *ZED_SERVER_URL);
169
170 let metrics_id = zed_client.metrics_id();
171 let is_staff = zed_client.is_staff();
172 let http_client = zed_client.http_client();
173
174 let request = FeedbackRequestBody {
175 feedback_text: &feedback_text,
176 metrics_id,
177 system_specs,
178 is_staff: is_staff.unwrap_or(false),
179 token: ZED_SECRET_CLIENT_TOKEN,
180 };
181
182 let json_bytes = serde_json::to_vec(&request)?;
183
184 let request = Request::post(feedback_endpoint)
185 .header("content-type", "application/json")
186 .body(json_bytes.into())?;
187
188 let mut response = http_client.send(request).await?;
189 let mut body = String::new();
190 response.body_mut().read_to_string(&mut body).await?;
191
192 let response_status = response.status();
193
194 if !response_status.is_success() {
195 bail!("Feedback API failed with error: {}", response_status)
196 }
197
198 Ok(())
199 }
200}
201
202impl FeedbackEditor {
203 pub fn deploy(
204 system_specs: SystemSpecs,
205 _: &mut Workspace,
206 app_state: Arc<AppState>,
207 cx: &mut ViewContext<Workspace>,
208 ) {
209 let markdown = app_state.languages.language_for_name("Markdown");
210 cx.spawn(|workspace, mut cx| async move {
211 let markdown = markdown.await.log_err();
212 workspace
213 .update(&mut cx, |workspace, cx| {
214 workspace.with_local_workspace(&app_state, cx, |workspace, cx| {
215 let project = workspace.project().clone();
216 let buffer = project
217 .update(cx, |project, cx| project.create_buffer("", markdown, cx))
218 .expect("creating buffers on a local workspace always succeeds");
219 let feedback_editor = cx
220 .add_view(|cx| FeedbackEditor::new(system_specs, project, buffer, cx));
221 workspace.add_item(Box::new(feedback_editor), cx);
222 })
223 })
224 .await;
225 })
226 .detach();
227 }
228}
229
230impl View for FeedbackEditor {
231 fn ui_name() -> &'static str {
232 "FeedbackEditor"
233 }
234
235 fn render(&mut self, cx: &mut ViewContext<Self>) -> Element<Self> {
236 ChildView::new(&self.editor, cx).boxed()
237 }
238
239 fn focus_in(&mut self, _: AnyViewHandle, cx: &mut ViewContext<Self>) {
240 if cx.is_self_focused() {
241 cx.focus(&self.editor);
242 }
243 }
244}
245
246impl Entity for FeedbackEditor {
247 type Event = editor::Event;
248}
249
250impl Item for FeedbackEditor {
251 fn tab_content(
252 &self,
253 _: Option<usize>,
254 style: &theme::Tab,
255 _: &AppContext,
256 ) -> Element<Pane> {
257 Flex::row()
258 .with_child(
259 Svg::new("icons/feedback_16.svg")
260 .with_color(style.label.text.color)
261 .constrained()
262 .with_width(style.type_icon_width)
263 .aligned()
264 .contained()
265 .with_margin_right(style.spacing)
266 .boxed(),
267 )
268 .with_child(
269 Label::new("Send Feedback", style.label.clone())
270 .aligned()
271 .contained()
272 .boxed(),
273 )
274 .boxed()
275 }
276
277 fn for_each_project_item(&self, cx: &AppContext, f: &mut dyn FnMut(usize, &dyn project::Item)) {
278 self.editor.for_each_project_item(cx, f)
279 }
280
281 fn is_singleton(&self, _: &AppContext) -> bool {
282 true
283 }
284
285 fn can_save(&self, _: &AppContext) -> bool {
286 true
287 }
288
289 fn save(
290 &mut self,
291 _: ModelHandle<Project>,
292 cx: &mut ViewContext<Self>,
293 ) -> Task<anyhow::Result<()>> {
294 self.handle_save(cx)
295 }
296
297 fn save_as(
298 &mut self,
299 _: ModelHandle<Project>,
300 _: std::path::PathBuf,
301 cx: &mut ViewContext<Self>,
302 ) -> Task<anyhow::Result<()>> {
303 self.handle_save(cx)
304 }
305
306 fn reload(
307 &mut self,
308 _: ModelHandle<Project>,
309 _: &mut ViewContext<Self>,
310 ) -> Task<anyhow::Result<()>> {
311 Task::Ready(Some(Ok(())))
312 }
313
314 fn clone_on_split(
315 &self,
316 _workspace_id: workspace::WorkspaceId,
317 cx: &mut ViewContext<Self>,
318 ) -> Option<Self>
319 where
320 Self: Sized,
321 {
322 let buffer = self
323 .editor
324 .read(cx)
325 .buffer()
326 .read(cx)
327 .as_singleton()
328 .expect("Feedback buffer is only ever singleton");
329
330 Some(Self::new(
331 self.system_specs.clone(),
332 self.project.clone(),
333 buffer.clone(),
334 cx,
335 ))
336 }
337
338 fn as_searchable(&self, handle: &ViewHandle<Self>) -> Option<Box<dyn SearchableItemHandle>> {
339 Some(Box::new(handle.clone()))
340 }
341
342 fn act_as_type<'a>(
343 &'a self,
344 type_id: TypeId,
345 self_handle: &'a ViewHandle<Self>,
346 _: &'a AppContext,
347 ) -> Option<&'a AnyViewHandle> {
348 if type_id == TypeId::of::<Self>() {
349 Some(self_handle)
350 } else if type_id == TypeId::of::<Editor>() {
351 Some(&self.editor)
352 } else {
353 None
354 }
355 }
356}
357
358impl SearchableItem for FeedbackEditor {
359 type Match = Range<Anchor>;
360
361 fn to_search_event(event: &Self::Event) -> Option<workspace::searchable::SearchEvent> {
362 Editor::to_search_event(event)
363 }
364
365 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
366 self.editor
367 .update(cx, |editor, cx| editor.clear_matches(cx))
368 }
369
370 fn update_matches(&mut self, matches: Vec<Self::Match>, cx: &mut ViewContext<Self>) {
371 self.editor
372 .update(cx, |editor, cx| editor.update_matches(matches, cx))
373 }
374
375 fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
376 self.editor
377 .update(cx, |editor, cx| editor.query_suggestion(cx))
378 }
379
380 fn activate_match(
381 &mut self,
382 index: usize,
383 matches: Vec<Self::Match>,
384 cx: &mut ViewContext<Self>,
385 ) {
386 self.editor
387 .update(cx, |editor, cx| editor.activate_match(index, matches, cx))
388 }
389
390 fn find_matches(
391 &mut self,
392 query: project::search::SearchQuery,
393 cx: &mut ViewContext<Self>,
394 ) -> Task<Vec<Self::Match>> {
395 self.editor
396 .update(cx, |editor, cx| editor.find_matches(query, cx))
397 }
398
399 fn active_match_index(
400 &mut self,
401 matches: Vec<Self::Match>,
402 cx: &mut ViewContext<Self>,
403 ) -> Option<usize> {
404 self.editor
405 .update(cx, |editor, cx| editor.active_match_index(matches, cx))
406 }
407}