2023-12-06 22:27:10 +00:00
|
|
|
use std::{ops::RangeInclusive, sync::Arc};
|
2023-12-06 21:15:44 +00:00
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
use anyhow::bail;
|
|
|
|
use client::{Client, ZED_SECRET_CLIENT_TOKEN, ZED_SERVER_URL};
|
|
|
|
use db::kvp::KEY_VALUE_STORE;
|
2023-12-06 21:15:44 +00:00
|
|
|
use editor::{Editor, EditorEvent};
|
2023-12-06 22:27:10 +00:00
|
|
|
use futures::AsyncReadExt;
|
2023-12-06 19:13:56 +00:00
|
|
|
use gpui::{
|
2023-12-06 22:27:10 +00:00
|
|
|
div, red, rems, serde_json, AppContext, DismissEvent, Div, EventEmitter, FocusHandle,
|
|
|
|
FocusableView, Model, PromptLevel, Render, Task, View, ViewContext,
|
2023-12-06 19:13:56 +00:00
|
|
|
};
|
2023-12-06 22:27:10 +00:00
|
|
|
use isahc::Request;
|
2023-12-06 21:15:44 +00:00
|
|
|
use language::Buffer;
|
|
|
|
use project::Project;
|
2023-12-06 22:27:10 +00:00
|
|
|
use regex::Regex;
|
|
|
|
use serde_derive::Serialize;
|
2023-12-06 19:13:56 +00:00
|
|
|
use ui::{prelude::*, Button, ButtonStyle, Label, Tooltip};
|
2023-12-06 21:15:44 +00:00
|
|
|
use util::ResultExt;
|
2023-12-06 22:27:10 +00:00
|
|
|
use workspace::Workspace;
|
2023-12-06 21:15:44 +00:00
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
use crate::{system_specs::SystemSpecs, GiveFeedback, OpenZedCommunityRepo};
|
2023-12-06 19:13:56 +00:00
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
const DATABASE_KEY_NAME: &str = "email_address";
|
|
|
|
const EMAIL_REGEX: &str = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b";
|
2023-12-06 21:15:44 +00:00
|
|
|
const FEEDBACK_CHAR_LIMIT: RangeInclusive<usize> = 10..=5000;
|
|
|
|
const FEEDBACK_SUBMISSION_ERROR_TEXT: &str =
|
|
|
|
"Feedback failed to submit, see error log for details.";
|
2023-12-06 19:13:56 +00:00
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
#[derive(Serialize)]
|
|
|
|
struct FeedbackRequestBody<'a> {
|
|
|
|
feedback_text: &'a str,
|
|
|
|
email: Option<String>,
|
|
|
|
metrics_id: Option<Arc<str>>,
|
|
|
|
installation_id: Option<Arc<str>>,
|
|
|
|
system_specs: SystemSpecs,
|
|
|
|
is_staff: bool,
|
|
|
|
token: &'a str,
|
|
|
|
}
|
|
|
|
|
2023-12-06 19:13:56 +00:00
|
|
|
pub struct FeedbackModal {
|
2023-12-06 21:15:44 +00:00
|
|
|
system_specs: SystemSpecs,
|
|
|
|
feedback_editor: View<Editor>,
|
|
|
|
email_address_editor: View<Editor>,
|
|
|
|
project: Model<Project>,
|
|
|
|
character_count: usize,
|
2023-12-06 23:36:17 +00:00
|
|
|
pending_submission: bool,
|
2023-12-06 19:13:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl FocusableView for FeedbackModal {
|
2023-12-06 21:15:44 +00:00
|
|
|
fn focus_handle(&self, cx: &AppContext) -> FocusHandle {
|
|
|
|
self.feedback_editor.focus_handle(cx)
|
2023-12-06 19:13:56 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
impl EventEmitter<DismissEvent> for FeedbackModal {}
|
|
|
|
|
|
|
|
impl FeedbackModal {
|
|
|
|
pub fn register(workspace: &mut Workspace, cx: &mut ViewContext<Workspace>) {
|
|
|
|
let _handle = cx.view().downgrade();
|
|
|
|
workspace.register_action(move |workspace, _: &GiveFeedback, cx| {
|
2023-12-06 21:15:44 +00:00
|
|
|
let markdown = workspace
|
|
|
|
.app_state()
|
|
|
|
.languages
|
|
|
|
.language_for_name("Markdown");
|
|
|
|
|
|
|
|
let project = workspace.project().clone();
|
|
|
|
|
|
|
|
cx.spawn(|workspace, mut cx| async move {
|
|
|
|
let markdown = markdown.await.log_err();
|
|
|
|
let buffer = project
|
|
|
|
.update(&mut cx, |project, cx| {
|
|
|
|
project.create_buffer("", markdown, cx)
|
|
|
|
})?
|
|
|
|
.expect("creating buffers on a local workspace always succeeds");
|
|
|
|
|
|
|
|
workspace.update(&mut cx, |workspace, cx| {
|
|
|
|
let system_specs = SystemSpecs::new(cx);
|
|
|
|
|
|
|
|
workspace.toggle_modal(cx, move |cx| {
|
|
|
|
FeedbackModal::new(system_specs, project, buffer, cx)
|
|
|
|
});
|
|
|
|
})?;
|
|
|
|
|
|
|
|
anyhow::Ok(())
|
|
|
|
})
|
|
|
|
.detach_and_log_err(cx);
|
2023-12-06 19:13:56 +00:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2023-12-06 21:15:44 +00:00
|
|
|
pub fn new(
|
|
|
|
system_specs: SystemSpecs,
|
|
|
|
project: Model<Project>,
|
|
|
|
buffer: Model<Buffer>,
|
|
|
|
cx: &mut ViewContext<Self>,
|
|
|
|
) -> Self {
|
|
|
|
let email_address_editor = cx.build_view(|cx| {
|
|
|
|
let mut editor = Editor::single_line(cx);
|
|
|
|
editor.set_placeholder_text("Email address (optional)", cx);
|
2023-12-06 22:27:10 +00:00
|
|
|
|
|
|
|
if let Ok(Some(email_address)) = KEY_VALUE_STORE.read_kvp(DATABASE_KEY_NAME) {
|
|
|
|
editor.set_text(email_address, cx)
|
|
|
|
}
|
|
|
|
|
2023-12-06 21:15:44 +00:00
|
|
|
editor
|
|
|
|
});
|
2023-12-06 22:27:10 +00:00
|
|
|
|
2023-12-06 21:15:44 +00:00
|
|
|
let feedback_editor = cx.build_view(|cx| {
|
|
|
|
let mut editor = Editor::for_buffer(buffer, Some(project.clone()), cx);
|
|
|
|
editor.set_vertical_scroll_margin(5, cx);
|
|
|
|
editor
|
|
|
|
});
|
|
|
|
|
|
|
|
cx.subscribe(
|
|
|
|
&feedback_editor,
|
|
|
|
|this, editor, event: &EditorEvent, cx| match event {
|
|
|
|
EditorEvent::Edited => {
|
|
|
|
this.character_count = editor
|
|
|
|
.read(cx)
|
|
|
|
.buffer()
|
|
|
|
.read(cx)
|
|
|
|
.as_singleton()
|
|
|
|
.expect("Feedback editor is never a multi-buffer")
|
|
|
|
.read(cx)
|
|
|
|
.len();
|
|
|
|
cx.notify();
|
|
|
|
}
|
|
|
|
_ => {}
|
|
|
|
},
|
|
|
|
)
|
|
|
|
.detach();
|
|
|
|
|
2023-12-06 19:13:56 +00:00
|
|
|
Self {
|
2023-12-06 21:15:44 +00:00
|
|
|
system_specs: system_specs.clone(),
|
|
|
|
feedback_editor,
|
|
|
|
email_address_editor,
|
|
|
|
project,
|
2023-12-06 22:27:10 +00:00
|
|
|
pending_submission: false,
|
2023-12-06 21:15:44 +00:00
|
|
|
character_count: 0,
|
2023-12-06 19:13:56 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
pub fn submit(&mut self, cx: &mut ViewContext<Self>) -> Task<anyhow::Result<()>> {
|
|
|
|
let feedback_text = self.feedback_editor.read(cx).text(cx).trim().to_string();
|
|
|
|
let email = self.email_address_editor.read(cx).text_option(cx);
|
2023-12-06 19:13:56 +00:00
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
let answer = cx.prompt(
|
|
|
|
PromptLevel::Info,
|
|
|
|
"Ready to submit your feedback?",
|
|
|
|
&["Yes, Submit!", "No"],
|
|
|
|
);
|
|
|
|
let client = cx.global::<Arc<Client>>().clone();
|
|
|
|
let specs = self.system_specs.clone();
|
|
|
|
cx.spawn(|this, mut cx| async move {
|
|
|
|
let answer = answer.await.ok();
|
|
|
|
if answer == Some(0) {
|
2023-12-06 23:36:17 +00:00
|
|
|
if let Some(email) = email.clone() {
|
|
|
|
let _ = KEY_VALUE_STORE
|
|
|
|
.write_kvp(DATABASE_KEY_NAME.to_string(), email)
|
|
|
|
.await;
|
|
|
|
}
|
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
this.update(&mut cx, |feedback_editor, cx| {
|
|
|
|
feedback_editor.set_pending_submission(true, cx);
|
|
|
|
})
|
|
|
|
.log_err();
|
|
|
|
match FeedbackModal::submit_feedback(&feedback_text, email, client, specs).await {
|
|
|
|
Ok(_) => {}
|
|
|
|
Err(error) => {
|
|
|
|
log::error!("{}", error);
|
|
|
|
this.update(&mut cx, |feedback_editor, cx| {
|
|
|
|
let prompt = cx.prompt(
|
|
|
|
PromptLevel::Critical,
|
|
|
|
FEEDBACK_SUBMISSION_ERROR_TEXT,
|
|
|
|
&["OK"],
|
|
|
|
);
|
|
|
|
cx.spawn(|_, _cx| async move {
|
|
|
|
prompt.await.ok();
|
|
|
|
})
|
|
|
|
.detach();
|
|
|
|
feedback_editor.set_pending_submission(false, cx);
|
|
|
|
})
|
|
|
|
.log_err();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
})
|
|
|
|
.detach();
|
|
|
|
Task::ready(Ok(()))
|
|
|
|
}
|
2023-12-06 19:13:56 +00:00
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
fn set_pending_submission(&mut self, pending_submission: bool, cx: &mut ViewContext<Self>) {
|
|
|
|
self.pending_submission = pending_submission;
|
|
|
|
cx.notify();
|
|
|
|
}
|
2023-12-06 19:13:56 +00:00
|
|
|
|
2023-12-06 22:27:10 +00:00
|
|
|
async fn submit_feedback(
|
|
|
|
feedback_text: &str,
|
|
|
|
email: Option<String>,
|
|
|
|
zed_client: Arc<Client>,
|
|
|
|
system_specs: SystemSpecs,
|
|
|
|
) -> anyhow::Result<()> {
|
|
|
|
let feedback_endpoint = format!("{}/api/feedback", *ZED_SERVER_URL);
|
|
|
|
let telemetry = zed_client.telemetry();
|
|
|
|
let metrics_id = telemetry.metrics_id();
|
|
|
|
let installation_id = telemetry.installation_id();
|
|
|
|
let is_staff = telemetry.is_staff();
|
|
|
|
let http_client = zed_client.http_client();
|
|
|
|
let request = FeedbackRequestBody {
|
|
|
|
feedback_text: &feedback_text,
|
|
|
|
email,
|
|
|
|
metrics_id,
|
|
|
|
installation_id,
|
|
|
|
system_specs,
|
|
|
|
is_staff: is_staff.unwrap_or(false),
|
|
|
|
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(())
|
|
|
|
}
|
2023-12-06 19:13:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Render for FeedbackModal {
|
|
|
|
type Element = Div;
|
|
|
|
|
|
|
|
fn render(&mut self, cx: &mut ViewContext<Self>) -> Self::Element {
|
2023-12-06 22:27:10 +00:00
|
|
|
let valid_email_address = match self.email_address_editor.read(cx).text_option(cx) {
|
|
|
|
Some(email_address) => Regex::new(EMAIL_REGEX).unwrap().is_match(&email_address),
|
|
|
|
None => true,
|
|
|
|
};
|
|
|
|
|
2023-12-06 23:36:17 +00:00
|
|
|
let allow_submission = FEEDBACK_CHAR_LIMIT.contains(&self.character_count)
|
2023-12-06 22:27:10 +00:00
|
|
|
&& valid_email_address
|
|
|
|
&& !self.pending_submission;
|
2023-12-06 21:15:44 +00:00
|
|
|
|
2023-12-06 19:13:56 +00:00
|
|
|
let dismiss = cx.listener(|_, _, cx| cx.emit(DismissEvent));
|
2023-12-06 21:15:44 +00:00
|
|
|
// let open_community_issues =
|
|
|
|
// cx.listener(|_, _, cx| cx.dispatch_action(Box::new(OpenZedCommunityRepo)));
|
|
|
|
// let open_community_discussions = cx.listener(|_, _, cx| cx.emit(DismissEvent));
|
2023-12-07 00:11:03 +00:00
|
|
|
let open_community_repo =
|
|
|
|
cx.listener(|_, _, cx| cx.dispatch_action(Box::new(OpenZedCommunityRepo)));
|
2023-12-06 19:13:56 +00:00
|
|
|
|
|
|
|
v_stack()
|
|
|
|
.elevation_3(cx)
|
|
|
|
.min_w(rems(40.))
|
|
|
|
.max_w(rems(96.))
|
|
|
|
.h(rems(40.))
|
|
|
|
.p_2()
|
|
|
|
.gap_2()
|
2023-12-06 21:15:44 +00:00
|
|
|
.child(
|
|
|
|
v_stack().child(
|
|
|
|
div()
|
|
|
|
.size_full()
|
|
|
|
.border()
|
|
|
|
.border_color(red())
|
|
|
|
.child(Label::new("Give Feedback").color(Color::Default))
|
|
|
|
.child(Label::new("This editor supports markdown").color(Color::Muted)),
|
|
|
|
),
|
|
|
|
)
|
2023-12-06 19:13:56 +00:00
|
|
|
.child(
|
|
|
|
div()
|
|
|
|
.flex_1()
|
|
|
|
.bg(cx.theme().colors().editor_background)
|
|
|
|
.border()
|
|
|
|
.border_color(cx.theme().colors().border)
|
2023-12-06 21:15:44 +00:00
|
|
|
.child(self.feedback_editor.clone()),
|
|
|
|
)
|
|
|
|
.child(
|
|
|
|
div().border().border_color(red()).child(
|
|
|
|
Label::new(format!(
|
|
|
|
"{} / {} Characters",
|
|
|
|
self.character_count,
|
|
|
|
FEEDBACK_CHAR_LIMIT.end()
|
|
|
|
))
|
|
|
|
.color(Color::Default),
|
|
|
|
),
|
|
|
|
)
|
|
|
|
.child( div()
|
|
|
|
.bg(cx.theme().colors().editor_background)
|
|
|
|
.border()
|
|
|
|
.border_color(cx.theme().colors().border)
|
|
|
|
.child(self.email_address_editor.clone())
|
2023-12-06 19:13:56 +00:00
|
|
|
)
|
|
|
|
.child(
|
|
|
|
h_stack()
|
2023-12-06 21:15:44 +00:00
|
|
|
.justify_between()
|
2023-12-06 19:13:56 +00:00
|
|
|
.gap_1()
|
2023-12-06 21:15:44 +00:00
|
|
|
.child(Button::new("community_repo", "Community Repo")
|
|
|
|
.style(ButtonStyle::Filled)
|
|
|
|
.color(Color::Muted)
|
2023-12-07 00:11:03 +00:00
|
|
|
.on_click(open_community_repo)
|
2023-12-06 21:15:44 +00:00
|
|
|
)
|
|
|
|
.child(h_stack().justify_between().gap_1()
|
|
|
|
.child(
|
|
|
|
Button::new("cancel_feedback", "Cancel")
|
|
|
|
.style(ButtonStyle::Subtle)
|
|
|
|
.color(Color::Muted)
|
|
|
|
.on_click(dismiss),
|
|
|
|
)
|
|
|
|
.child(
|
|
|
|
Button::new("send_feedback", "Send Feedback")
|
|
|
|
.color(Color::Accent)
|
|
|
|
.style(ButtonStyle::Filled)
|
2023-12-07 00:10:45 +00:00
|
|
|
// TODO - error handling - show modal on error
|
|
|
|
.on_click(cx.listener(|this, _, cx| {let _ = this.submit(cx);}))
|
2023-12-06 21:15:44 +00:00
|
|
|
.tooltip(|cx| {
|
|
|
|
Tooltip::with_meta(
|
|
|
|
"Submit feedback to the Zed team.",
|
|
|
|
None,
|
|
|
|
"Provide an email address if you want us to be able to reply.",
|
|
|
|
cx,
|
|
|
|
)
|
|
|
|
})
|
2023-12-06 23:36:17 +00:00
|
|
|
.when(!allow_submission, |this| this.disabled(true)),
|
2023-12-06 21:15:44 +00:00
|
|
|
),
|
2023-12-06 19:13:56 +00:00
|
|
|
)
|
|
|
|
|
2023-12-06 21:15:44 +00:00
|
|
|
)
|
2023-12-06 19:13:56 +00:00
|
|
|
}
|
|
|
|
}
|