Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(console): don't make details requests with rewritten IDs #251

Merged
merged 1 commit into from
Jan 7, 2022
Merged

fix(console): don't make details requests with rewritten IDs #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions console/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ async fn main() -> color_eyre::Result<()> {
let _ = update_tx.send(update_kind);
match update_kind {
UpdateKind::SelectTask(task_id) => {
tracing::info!(task_id, "starting details watch");
match conn.watch_details(task_id).await {
Ok(stream) => {
tokio::spawn(watch_details_stream(task_id, stream, update_rx.clone(), details_tx.clone()));
Expand Down
23 changes: 12 additions & 11 deletions console/src/state/async_ops.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pub(crate) enum SortBy {

#[derive(Debug)]
pub(crate) struct AsyncOp {
id: u64,
num: u64,
parent_id: InternedStr,
resource_id: u64,
meta_id: u64,
Expand Down Expand Up @@ -69,7 +69,7 @@ impl Default for SortBy {
impl SortBy {
pub fn sort(&self, now: SystemTime, ops: &mut Vec<Weak<RefCell<AsyncOp>>>) {
match self {
Self::Aid => ops.sort_unstable_by_key(|ao| ao.upgrade().map(|a| a.borrow().id)),
Self::Aid => ops.sort_unstable_by_key(|ao| ao.upgrade().map(|a| a.borrow().num)),
Self::Task => ops.sort_unstable_by_key(|ao| ao.upgrade().map(|a| a.borrow().task_id())),
Self::Source => {
ops.sort_unstable_by_key(|ao| ao.upgrade().map(|a| a.borrow().source.clone()))
Expand Down Expand Up @@ -154,10 +154,11 @@ impl AsyncOpsState {
}
};

let id = async_op.id?.id;
let stats = AsyncOpStats::from_proto(stats_update.remove(&id)?, meta, styles, strings);
let span_id = async_op.id?.id;
let stats =
AsyncOpStats::from_proto(stats_update.remove(&span_id)?, meta, styles, strings);

let id = self.ids.id_for(id);
let num = self.ids.id_for(span_id);
let resource_id = resource_ids.id_for(async_op.resource_id?.id);
let parent_id = match async_op.parent_async_op_id {
Some(id) => strings.string(format!("{}", self.ids.id_for(id.id))),
Expand All @@ -167,7 +168,7 @@ impl AsyncOpsState {
let source = strings.string(async_op.source);

let async_op = AsyncOp {
id,
num,
parent_id,
resource_id,
meta_id,
Expand All @@ -176,14 +177,14 @@ impl AsyncOpsState {
};
let async_op = Rc::new(RefCell::new(async_op));
new_list.push(Rc::downgrade(&async_op));
Some((id, async_op))
Some((num, async_op))
});

self.async_ops.extend(new_async_ops);

for (id, stats) in stats_update {
let id = self.ids.id_for(id);
if let Some(async_op) = self.async_ops.get_mut(&id) {
for (span_id, stats) in stats_update {
let num = self.ids.id_for(span_id);
if let Some(async_op) = self.async_ops.get_mut(&num) {
let mut async_op = async_op.borrow_mut();
if let Some(meta) = metas.get(&async_op.meta_id) {
async_op.stats = AsyncOpStats::from_proto(stats, meta, styles, strings);
Expand All @@ -210,7 +211,7 @@ impl AsyncOpsState {

impl AsyncOp {
pub(crate) fn id(&self) -> u64 {
self.id
self.num
}

pub(crate) fn parent_id(&self) -> &str {
Expand Down
41 changes: 27 additions & 14 deletions console/src/state/resources.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,15 @@ pub(crate) enum SortBy {

#[derive(Debug)]
pub(crate) struct Resource {
id: u64,
/// The resource's pretty (console-generated, sequential) ID.
///
/// This is NOT the `tracing::span::Id` for the resource's `tracing` span on the
/// remote.
num: u64,
/// The `tracing::span::Id` on the remote process for this resource's span.
///
/// This is used when requesting a resource details stream.
span_id: u64,
Comment on lines +39 to +47
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we can rename it to just pretty_id or display_id?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm also fine with a name like that; i went with num because they're sequential numbers, but I'd be happy to change it.

id_str: InternedStr,
parent: InternedStr,
parent_id: InternedStr,
Expand Down Expand Up @@ -68,9 +76,8 @@ impl Default for SortBy {
impl SortBy {
pub fn sort(&self, now: SystemTime, resources: &mut Vec<Weak<RefCell<Resource>>>) {
match self {
Self::Rid => {
resources.sort_unstable_by_key(|resource| resource.upgrade().map(|r| r.borrow().id))
}
Self::Rid => resources
.sort_unstable_by_key(|resource| resource.upgrade().map(|r| r.borrow().num)),
Self::Kind => resources.sort_unstable_by_key(|resource| {
resource.upgrade().map(|r| r.borrow().kind.clone())
}),
Expand Down Expand Up @@ -166,10 +173,11 @@ impl ResourcesState {
}
};

let id = resource.id?.id;
let stats = ResourceStats::from_proto(stats_update.remove(&id)?, meta, styles, strings);
let span_id = resource.id?.id;
let stats =
ResourceStats::from_proto(stats_update.remove(&span_id)?, meta, styles, strings);

let id = self.ids.id_for(id);
let num = self.ids.id_for(span_id);
let parent_id = resource.parent_resource_id.map(|id| self.ids.id_for(id.id));

let parent = strings.string(match parent_id {
Expand Down Expand Up @@ -199,8 +207,9 @@ impl ResourcesState {
};

let resource = Resource {
id,
id_str: strings.string(id.to_string()),
num,
span_id,
id_str: strings.string(num.to_string()),
parent,
parent_id,
kind,
Expand All @@ -213,14 +222,14 @@ impl ResourcesState {
};
let resource = Rc::new(RefCell::new(resource));
new_list.push(Rc::downgrade(&resource));
Some((id, resource))
Some((num, resource))
});

self.resources.extend(new_resources);

for (id, stats) in stats_update {
let id = self.ids.id_for(id);
if let Some(resource) = self.resources.get_mut(&id) {
for (span_id, stats) in stats_update {
let num = self.ids.id_for(span_id);
if let Some(resource) = self.resources.get_mut(&num) {
let mut r = resource.borrow_mut();
if let Some(meta) = metas.get(&r.meta_id) {
r.stats = ResourceStats::from_proto(stats, meta, styles, strings);
Expand All @@ -247,7 +256,11 @@ impl ResourcesState {

impl Resource {
pub(crate) fn id(&self) -> u64 {
self.id
self.num
}

pub(crate) fn span_id(&self) -> u64 {
self.span_id
}

pub(crate) fn id_str(&self) -> &str {
Expand Down
39 changes: 26 additions & 13 deletions console/src/state/tasks.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,15 @@ pub(crate) type TaskRef = Weak<RefCell<Task>>;

#[derive(Debug)]
pub(crate) struct Task {
id: u64,
/// The task's pretty (console-generated, sequential) task ID.
///
/// This is NOT the `tracing::span::Id` for the task's tracing span on the
/// remote.
num: u64,
/// The `tracing::span::Id` on the remote process for this task's span.
///
/// This is used when requesting a task details stream.
span_id: u64,
short_desc: InternedStr,
formatted_fields: Vec<Vec<Span<'static>>>,
stats: TaskStats,
Expand Down Expand Up @@ -150,22 +158,23 @@ impl TasksState {
.collect::<Vec<_>>();

let formatted_fields = Field::make_formatted(styles, &mut fields);
let id = task.id?;
let span_id = task.id?.id;

let stats = stats_update.remove(&id.id)?.into();
let stats = stats_update.remove(&span_id)?.into();
let location = format_location(task.location);

// remap the server's ID to a pretty, sequential task ID
let id = self.ids.id_for(id.id);
let num = self.ids.id_for(span_id);

let short_desc = strings.string(match name.as_ref() {
Some(name) => format!("{} ({})", id, name),
None => format!("{}", id),
Some(name) => format!("{} ({})", num, name),
None => format!("{}", num),
});

let mut task = Task {
name,
id,
num,
span_id,
short_desc,
formatted_fields,
stats,
Expand All @@ -176,12 +185,12 @@ impl TasksState {
task.lint(linters);
let task = Rc::new(RefCell::new(task));
new_list.push(Rc::downgrade(&task));
Some((id, task))
Some((num, task))
});
self.tasks.extend(new_tasks);
for (id, stats) in stats_update {
let id = self.ids.id_for(id);
if let Some(task) = self.tasks.get_mut(&id) {
for (span_id, stats) in stats_update {
let num = self.ids.id_for(span_id);
if let Some(task) = self.tasks.get_mut(&num) {
let mut task = task.borrow_mut();
tracing::trace!(?task, "processing stats update for");
task.stats = stats.into();
Expand Down Expand Up @@ -225,7 +234,11 @@ impl Details {

impl Task {
pub(crate) fn id(&self) -> u64 {
self.id
self.num
}

pub(crate) fn span_id(&self) -> u64 {
self.span_id
}

pub(crate) fn target(&self) -> &str {
Expand Down Expand Up @@ -407,7 +420,7 @@ impl Default for SortBy {
impl SortBy {
pub fn sort(&self, now: SystemTime, tasks: &mut Vec<Weak<RefCell<Task>>>) {
match self {
Self::Tid => tasks.sort_unstable_by_key(|task| task.upgrade().map(|t| t.borrow().id)),
Self::Tid => tasks.sort_unstable_by_key(|task| task.upgrade().map(|t| t.borrow().num)),
Self::Name => {
tasks.sort_unstable_by_key(|task| task.upgrade().map(|t| t.borrow().name.clone()))
}
Expand Down
4 changes: 2 additions & 2 deletions console/src/view/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ impl View {
match event {
key!(Enter) => {
if let Some(task) = self.tasks_list.selected_item().upgrade() {
update_kind = UpdateKind::SelectTask(task.borrow().id());
update_kind = UpdateKind::SelectTask(task.borrow().span_id());
self.state = TaskInstance(self::task::TaskView::new(
task,
state.task_details_ref(),
Expand All @@ -123,7 +123,7 @@ impl View {
match event {
key!(Enter) => {
if let Some(res) = self.resources_list.selected_item().upgrade() {
update_kind = UpdateKind::SelectResource(res.borrow().id());
update_kind = UpdateKind::SelectResource(res.borrow().span_id());
self.state = ResourceInstance(self::resource::ResourceView::new(res));
}
}
Expand Down