use std::{ ops::{Range, RangeInclusive}, sync::Arc, }; use anyhow::bail; use client::{Client, ZED_SECRET_CLIENT_TOKEN}; use editor::{Anchor, Editor}; use futures::AsyncReadExt; use gpui::{ actions, elements::{ChildView, Flex, Label, MouseEventHandler, ParentElement, Stack, Text}, serde_json, AnyViewHandle, AppContext, CursorStyle, Element, ElementBox, Entity, ModelHandle, MouseButton, MutableAppContext, PromptLevel, RenderContext, Task, View, ViewContext, ViewHandle, }; use isahc::Request; use language::Buffer; use postage::prelude::Stream; use lazy_static::lazy_static; use project::Project; use serde::Serialize; use settings::Settings; use workspace::{ item::{Item, ItemHandle}, searchable::{SearchableItem, SearchableItemHandle}, StatusItemView, Workspace, }; use crate::system_specs::SystemSpecs; lazy_static! { pub static ref ZED_SERVER_URL: String = std::env::var("ZED_SERVER_URL").unwrap_or_else(|_| "https://zed.dev".to_string()); } const FEEDBACK_CHAR_LIMIT: RangeInclusive = 10..=5000; const FEEDBACK_PLACEHOLDER_TEXT: &str = "Thanks for spending time with Zed. Enter your feedback here as Markdown. Save the tab to submit your feedback."; const FEEDBACK_SUBMISSION_ERROR_TEXT: &str = "Feedback failed to submit, see error log for details."; actions!(feedback, [SubmitFeedback, GiveFeedback, DeployFeedback]); pub fn init(cx: &mut MutableAppContext) { cx.add_action(FeedbackEditor::deploy); } pub struct FeedbackButton; impl Entity for FeedbackButton { type Event = (); } impl View for FeedbackButton { fn ui_name() -> &'static str { "FeedbackButton" } fn render(&mut self, cx: &mut RenderContext<'_, Self>) -> ElementBox { Stack::new() .with_child( MouseEventHandler::::new(0, cx, |state, cx| { let theme = &cx.global::().theme; let theme = &theme.workspace.status_bar.feedback; Text::new( "Give Feedback".to_string(), theme.style_for(state, true).clone(), ) .boxed() }) .with_cursor_style(CursorStyle::PointingHand) .on_click(MouseButton::Left, |_, cx| cx.dispatch_action(GiveFeedback)) .boxed(), ) .boxed() } } impl StatusItemView for FeedbackButton { fn set_active_pane_item( &mut self, _: Option<&dyn ItemHandle>, _: &mut gpui::ViewContext, ) { } } #[derive(Serialize)] struct FeedbackRequestBody<'a> { feedback_text: &'a str, metrics_id: Option>, system_specs: SystemSpecs, token: &'a str, } #[derive(Clone)] struct FeedbackEditor { editor: ViewHandle, project: ModelHandle, } impl FeedbackEditor { fn new_with_buffer( project: ModelHandle, buffer: ModelHandle, cx: &mut ViewContext, ) -> Self { let editor = cx.add_view(|cx| { let mut editor = Editor::for_buffer(buffer, Some(project.clone()), cx); editor.set_vertical_scroll_margin(5, cx); editor.set_placeholder_text(FEEDBACK_PLACEHOLDER_TEXT, cx); editor }); cx.subscribe(&editor, |_, _, e, cx| cx.emit(e.clone())) .detach(); let this = Self { editor, project }; this } fn new(project: ModelHandle, cx: &mut ViewContext) -> Self { let markdown_language = project.read(cx).languages().language_for_name("Markdown"); let buffer = project .update(cx, |project, cx| { project.create_buffer("", markdown_language, cx) }) .expect("creating buffers on a local workspace always succeeds"); Self::new_with_buffer(project, buffer, cx) } fn handle_save( &mut self, _: gpui::ModelHandle, cx: &mut ViewContext, ) -> Task> { let feedback_char_count = self.editor.read(cx).buffer().read(cx).len(cx); let error = if feedback_char_count < *FEEDBACK_CHAR_LIMIT.start() { Some(format!( "Feedback can't be shorter than {} characters.", FEEDBACK_CHAR_LIMIT.start() )) } else if feedback_char_count > *FEEDBACK_CHAR_LIMIT.end() { Some(format!( "Feedback can't be longer than {} characters.", FEEDBACK_CHAR_LIMIT.end() )) } else { None }; if let Some(error) = error { cx.prompt(PromptLevel::Critical, &error, &["OK"]); return Task::ready(Ok(())); } let mut answer = cx.prompt( PromptLevel::Info, "Ready to submit your feedback?", &["Yes, Submit!", "No"], ); let this = cx.handle(); let client = cx.global::>().clone(); let feedback_text = self.editor.read(cx).text(cx); let specs = SystemSpecs::new(cx); cx.spawn(|_, mut cx| async move { let answer = answer.recv().await; if answer == Some(0) { match FeedbackEditor::submit_feedback(&feedback_text, client, specs).await { Ok(_) => { cx.update(|cx| { this.update(cx, |_, cx| { cx.dispatch_action(workspace::CloseActiveItem); }) }); } Err(error) => { log::error!("{}", error); cx.update(|cx| { this.update(cx, |_, cx| { cx.prompt( PromptLevel::Critical, FEEDBACK_SUBMISSION_ERROR_TEXT, &["OK"], ); }) }); } } } }) .detach(); Task::ready(Ok(())) } async fn submit_feedback( feedback_text: &str, zed_client: Arc, system_specs: SystemSpecs, ) -> anyhow::Result<()> { let feedback_endpoint = format!("{}/api/feedback", *ZED_SERVER_URL); let metrics_id = zed_client.metrics_id(); let http_client = zed_client.http_client(); let request = FeedbackRequestBody { feedback_text: &feedback_text, metrics_id, system_specs, token: ZED_SECRET_CLIENT_TOKEN, }; let json_bytes = serde_json::to_vec(&request)?; let request = Request::post(feedback_endpoint) .header("content-type", "application/json") .body(json_bytes.into())?; let mut response = http_client.send(request).await?; let mut body = String::new(); response.body_mut().read_to_string(&mut body).await?; let response_status = response.status(); if !response_status.is_success() { bail!("Feedback API failed with error: {}", response_status) } Ok(()) } } impl FeedbackEditor { pub fn deploy(workspace: &mut Workspace, _: &GiveFeedback, cx: &mut ViewContext) { let feedback_editor = cx.add_view(|cx| FeedbackEditor::new(workspace.project().clone(), cx)); workspace.add_item(Box::new(feedback_editor), cx); } } impl View for FeedbackEditor { fn ui_name() -> &'static str { "FeedbackEditor" } fn render(&mut self, cx: &mut RenderContext) -> ElementBox { ChildView::new(&self.editor, cx).boxed() } fn focus_in(&mut self, _: AnyViewHandle, cx: &mut ViewContext) { if cx.is_self_focused() { cx.focus(&self.editor); } } } impl Entity for FeedbackEditor { type Event = editor::Event; } impl Item for FeedbackEditor { fn tab_content( &self, _: Option, style: &theme::Tab, _: &gpui::AppContext, ) -> ElementBox { Flex::row() .with_child( Label::new("Feedback".to_string(), style.label.clone()) .aligned() .contained() .boxed(), ) .boxed() } fn for_each_project_item(&self, cx: &AppContext, f: &mut dyn FnMut(usize, &dyn project::Item)) { self.editor.for_each_project_item(cx, f) } fn to_item_events(_: &Self::Event) -> Vec { Vec::new() } fn is_singleton(&self, _: &gpui::AppContext) -> bool { true } fn set_nav_history(&mut self, _: workspace::ItemNavHistory, _: &mut ViewContext) {} fn can_save(&self, _: &gpui::AppContext) -> bool { true } fn save( &mut self, project: gpui::ModelHandle, cx: &mut ViewContext, ) -> Task> { self.handle_save(project, cx) } fn save_as( &mut self, project: gpui::ModelHandle, _: std::path::PathBuf, cx: &mut ViewContext, ) -> Task> { self.handle_save(project, cx) } fn reload( &mut self, _: gpui::ModelHandle, _: &mut ViewContext, ) -> Task> { unreachable!("reload should not have been called") } fn clone_on_split( &self, _workspace_id: workspace::WorkspaceId, cx: &mut ViewContext, ) -> Option where Self: Sized, { let buffer = self .editor .read(cx) .buffer() .read(cx) .as_singleton() .expect("Feedback buffer is only ever singleton"); Some(Self::new_with_buffer( self.project.clone(), buffer.clone(), cx, )) } fn serialized_item_kind() -> Option<&'static str> { None } fn deserialize( _: gpui::ModelHandle, _: gpui::WeakViewHandle, _: workspace::WorkspaceId, _: workspace::ItemId, _: &mut ViewContext, ) -> Task>> { unreachable!() } fn as_searchable(&self, handle: &ViewHandle) -> Option> { Some(Box::new(handle.clone())) } } impl SearchableItem for FeedbackEditor { type Match = Range; fn to_search_event(event: &Self::Event) -> Option { Editor::to_search_event(event) } fn clear_matches(&mut self, cx: &mut ViewContext) { self.editor .update(cx, |editor, cx| editor.clear_matches(cx)) } fn update_matches(&mut self, matches: Vec, cx: &mut ViewContext) { self.editor .update(cx, |editor, cx| editor.update_matches(matches, cx)) } fn query_suggestion(&mut self, cx: &mut ViewContext) -> String { self.editor .update(cx, |editor, cx| editor.query_suggestion(cx)) } fn activate_match( &mut self, index: usize, matches: Vec, cx: &mut ViewContext, ) { self.editor .update(cx, |editor, cx| editor.activate_match(index, matches, cx)) } fn find_matches( &mut self, query: project::search::SearchQuery, cx: &mut ViewContext, ) -> Task> { self.editor .update(cx, |editor, cx| editor.find_matches(query, cx)) } fn active_match_index( &mut self, matches: Vec, cx: &mut ViewContext, ) -> Option { self.editor .update(cx, |editor, cx| editor.active_match_index(matches, cx)) } }