language-servers/deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-09-26 12:19:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

refactor: unify CDP types in a single module (#21094)

Browse source 
This commit moves all Chrome Devtools Protocol messages to `cli/cdp.rs`
and refactors all places using these types to pull them from a common
place.

No functional changes.
This commit is contained in:
Bartek Iwańczuk 2023-11-05 23:58:59 +01:00 • committed by GitHub
parent 68a964346d
commit fdb4953ea4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 225 additions and 240 deletions
Download patch file Download diff file Expand all files Collapse all files

60
cli/tools/coverage/json_types.rs
View file

@ -1,60 +0,0 @@
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
use serde::Deserialize;
use serde::Serialize;
#[derive(Debug, Eq, PartialEq, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct CoverageRange {
/// Start character index.
#[serde(rename = "startOffset")]
pub start_char_offset: usize,
/// End character index.
#[serde(rename = "endOffset")]
pub end_char_offset: usize,
pub count: i64,
}
#[derive(Debug, Eq, PartialEq, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct FunctionCoverage {
pub function_name: String,
pub ranges: Vec<CoverageRange>,
pub is_block_coverage: bool,
}
#[derive(Debug, Eq, PartialEq, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct ScriptCoverage {
pub script_id: String,
pub url: String,
pub functions: Vec<FunctionCoverage>,
}
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct StartPreciseCoverageParameters {
pub call_count: bool,
pub detailed: bool,
pub allow_triggered_updates: bool,
}
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct StartPreciseCoverageReturnObject {
pub timestamp: f64,
}
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TakePreciseCoverageReturnObject {
pub result: Vec<ScriptCoverage>,
pub timestamp: f64,
}
// TODO(bartlomieju): remove me
#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ProcessCoverage {
pub result: Vec<ScriptCoverage>,
}

169
cli/tools/coverage/merge.rs
View file

@ -3,24 +3,26 @@
// Forked from https://github.com/demurgos/v8-coverage/tree/d0ca18da8740198681e0bc68971b0a6cdb11db3e/rust
// Copyright 2021 Charles Samborski. All rights reserved. MIT license.
use super::json_types::CoverageRange;
use super::json_types::FunctionCoverage;
use super::json_types::ProcessCoverage;
use super::json_types::ScriptCoverage;
use super::range_tree::RangeTree;
use super::range_tree::RangeTreeArena;
use crate::cdp;
use std::collections::BTreeMap;
use std::collections::BTreeSet;
use std::collections::HashMap;
use std::iter::Peekable;
#[derive(Eq, PartialEq, Clone, Debug)]
pub struct ProcessCoverage {
pub result: Vec<cdp::ScriptCoverage>,
}
pub fn merge_processes(
mut processes: Vec<ProcessCoverage>,
) -> Option<ProcessCoverage> {
if processes.len() <= 1 {
return processes.pop();
}
let mut url_to_scripts: BTreeMap<String, Vec<ScriptCoverage>> =
let mut url_to_scripts: BTreeMap<String, Vec<cdp::ScriptCoverage>> =
BTreeMap::new();
for process_cov in processes {
for script_cov in process_cov.result {
@ -31,12 +33,13 @@ pub fn merge_processes(
}
}
let result: Vec<ScriptCoverage> = url_to_scripts
let result: Vec<cdp::ScriptCoverage> = url_to_scripts
.into_iter()
.enumerate()
.map(|(script_id, (_, scripts))| (script_id, scripts))
.map(|(script_id, scripts)| {
let mut merged: ScriptCoverage = merge_scripts(scripts.to_vec()).unwrap();
let mut merged: cdp::ScriptCoverage =
merge_scripts(scripts.to_vec()).unwrap();
merged.script_id = script_id.to_string();
merged
})
@ -46,21 +49,21 @@ pub fn merge_processes(
}
pub fn merge_scripts(
mut scripts: Vec<ScriptCoverage>,
) -> Option<ScriptCoverage> {
mut scripts: Vec<cdp::ScriptCoverage>,
) -> Option<cdp::ScriptCoverage> {
if scripts.len() <= 1 {
return scripts.pop();
}
let (script_id, url) = {
let first: &ScriptCoverage = &scripts[0];
let first: &cdp::ScriptCoverage = &scripts[0];
(first.script_id.clone(), first.url.clone())
};
let mut range_to_funcs: BTreeMap<CharRange, Vec<FunctionCoverage>> =
let mut range_to_funcs: BTreeMap<CharRange, Vec<cdp::FunctionCoverage>> =
BTreeMap::new();
for script_cov in scripts {
for func_cov in script_cov.functions {
let root_range = {
let root_range_cov: &CoverageRange = &func_cov.ranges[0];
let root_range_cov: &cdp::CoverageRange = &func_cov.ranges[0];
CharRange {
start: root_range_cov.start_char_offset,
end: root_range_cov.end_char_offset,
@ -70,12 +73,12 @@ pub fn merge_scripts(
}
}
let functions: Vec<FunctionCoverage> = range_to_funcs
let functions: Vec<cdp::FunctionCoverage> = range_to_funcs
.into_values()
.map(|funcs| merge_functions(funcs).unwrap())
.collect();
Some(ScriptCoverage {
Some(cdp::ScriptCoverage {
script_id,
url,
functions,
@ -105,8 +108,8 @@ impl PartialOrd for CharRange {
}
pub fn merge_functions(
mut funcs: Vec<FunctionCoverage>,
) -> Option<FunctionCoverage> {
mut funcs: Vec<cdp::FunctionCoverage>,
) -> Option<cdp::FunctionCoverage> {
if funcs.len() <= 1 {
return funcs.pop();
}
@ -124,7 +127,7 @@ pub fn merge_functions(
let ranges = merged.to_ranges();
let is_block_coverage: bool = !(ranges.len() == 1 && ranges[0].count == 0);
Some(FunctionCoverage {
Some(cdp::FunctionCoverage {
function_name,
ranges,
is_block_coverage,
@ -439,13 +442,13 @@ mod tests {
fn two_flat_trees() {
let inputs: Vec<ProcessCoverage> = vec![
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![CoverageRange {
ranges: vec![cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 1,
@ -454,13 +457,13 @@ mod tests {
}],
},
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![CoverageRange {
ranges: vec![cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 2,
@ -470,13 +473,13 @@ mod tests {
},
];
let expected: Option<ProcessCoverage> = Some(ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![CoverageRange {
ranges: vec![cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 3,
@ -492,19 +495,19 @@ mod tests {
fn two_trees_with_matching_children() {
let inputs: Vec<ProcessCoverage> = vec![
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 10,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 3,
end_char_offset: 6,
count: 1,
@ -514,19 +517,19 @@ mod tests {
}],
},
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 20,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 3,
end_char_offset: 6,
count: 2,
@ -537,19 +540,19 @@ mod tests {
},
];
let expected: Option<ProcessCoverage> = Some(ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 30,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 3,
end_char_offset: 6,
count: 3,
@ -566,19 +569,19 @@ mod tests {
fn two_trees_with_partially_overlapping_children() {
let inputs: Vec<ProcessCoverage> = vec![
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 10,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 2,
end_char_offset: 5,
count: 1,
@ -588,19 +591,19 @@ mod tests {
}],
},
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 20,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 4,
end_char_offset: 7,
count: 2,
@ -611,29 +614,29 @@ mod tests {
},
];
let expected: Option<ProcessCoverage> = Some(ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 30,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 2,
end_char_offset: 5,
count: 21,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 4,
end_char_offset: 5,
count: 3,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 5,
end_char_offset: 7,
count: 12,
@ -650,29 +653,29 @@ mod tests {
fn two_trees_with_with_complementary_children_summing_to_the_same_count() {
let inputs: Vec<ProcessCoverage> = vec![
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 1,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 1,
end_char_offset: 8,
count: 6,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 1,
end_char_offset: 5,
count: 5,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 5,
end_char_offset: 8,
count: 7,
@ -682,29 +685,29 @@ mod tests {
}],
},
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 4,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 1,
end_char_offset: 8,
count: 8,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 1,
end_char_offset: 5,
count: 9,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 5,
end_char_offset: 8,
count: 7,
@ -715,19 +718,19 @@ mod tests {
},
];
let expected: Option<ProcessCoverage> = Some(ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 5,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 1,
end_char_offset: 8,
count: 14,
@ -744,19 +747,19 @@ mod tests {
fn merges_a_similar_sliding_chain_a_bc() {
let inputs: Vec<ProcessCoverage> = vec![
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 7,
count: 10,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 4,
count: 1,
@ -766,24 +769,24 @@ mod tests {
}],
},
ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 7,
count: 20,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 1,
end_char_offset: 6,
count: 11,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 2,
end_char_offset: 5,
count: 2,
@ -794,29 +797,29 @@ mod tests {
},
];
let expected: Option<ProcessCoverage> = Some(ProcessCoverage {
result: vec![ScriptCoverage {
result: vec![cdp::ScriptCoverage {
script_id: String::from("0"),
url: String::from("/lib.js"),
functions: vec![FunctionCoverage {
functions: vec![cdp::FunctionCoverage {
function_name: String::from("lib"),
is_block_coverage: true,
ranges: vec![
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 7,
count: 30,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 6,
count: 21,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 1,
end_char_offset: 5,
count: 12,
},
CoverageRange {
cdp::CoverageRange {
start_char_offset: 2,
end_char_offset: 4,
count: 3,

27
cli/tools/coverage/mod.rs
View file

@ -3,6 +3,7 @@
use crate::args::CoverageFlags;
use crate::args::FileFlags;
use crate::args::Flags;
use crate::cdp;
use crate::colors;
use crate::factory::CliFactory;
use crate::npm::CliNpmResolver;
@ -34,11 +35,9 @@ use std::path::PathBuf;
use text_lines::TextLines;
use uuid::Uuid;
mod json_types;
mod merge;
mod range_tree;
use json_types::*;
use merge::ProcessCoverage;
pub struct CoverageCollector {
pub dir: PathBuf,
@ -84,8 +83,8 @@ impl CoverageCollector {
async fn start_precise_coverage(
&mut self,
parameters: StartPreciseCoverageParameters,
) -> Result<StartPreciseCoverageReturnObject, AnyError> {
parameters: cdp::StartPreciseCoverageArgs,
) -> Result<cdp::StartPreciseCoverageResponse, AnyError> {
let return_value = self
.session
.post_message("Profiler.startPreciseCoverage", Some(parameters))
@ -98,7 +97,7 @@ impl CoverageCollector {
async fn take_precise_coverage(
&mut self,
) -> Result<TakePreciseCoverageReturnObject, AnyError> {
) -> Result<cdp::TakePreciseCoverageResponse, AnyError> {
let return_value = self
.session
.post_message::<()>("Profiler.takePreciseCoverage", None)
@ -113,7 +112,7 @@ impl CoverageCollector {
self.enable_debugger().await?;
self.enable_profiler().await?;
self
.start_precise_coverage(StartPreciseCoverageParameters {
.start_precise_coverage(cdp::StartPreciseCoverageArgs {
call_count: true,
detailed: true,
allow_triggered_updates: false,
@ -180,7 +179,7 @@ struct CoverageReport {
}
fn generate_coverage_report(
script_coverage: &ScriptCoverage,
script_coverage: &cdp::ScriptCoverage,
script_source: String,
maybe_source_map: &Option<Vec<u8>>,
output: &Option<PathBuf>,
@ -570,8 +569,8 @@ impl CoverageReporter for PrettyCoverageReporter {
fn collect_coverages(
files: FileFlags,
) -> Result<Vec<ScriptCoverage>, AnyError> {
let mut coverages: Vec<ScriptCoverage> = Vec::new();
) -> Result<Vec<cdp::ScriptCoverage>, AnyError> {
let mut coverages: Vec<cdp::ScriptCoverage> = Vec::new();
let file_paths = FileCollector::new(|file_path| {
file_path
.extension()
@ -590,7 +589,7 @@ fn collect_coverages(
for file_path in file_paths {
let json = fs::read_to_string(file_path.as_path())?;
let new_coverage: ScriptCoverage = serde_json::from_str(&json)?;
let new_coverage: cdp::ScriptCoverage = serde_json::from_str(&json)?;
coverages.push(new_coverage);
}
@ -600,11 +599,11 @@ fn collect_coverages(
}
fn filter_coverages(
coverages: Vec<ScriptCoverage>,
coverages: Vec<cdp::ScriptCoverage>,
include: Vec<String>,
exclude: Vec<String>,
npm_resolver: &dyn CliNpmResolver,
) -> Vec<ScriptCoverage> {
) -> Vec<cdp::ScriptCoverage> {
let include: Vec<Regex> =
include.iter().map(|e| Regex::new(e).unwrap()).collect();
@ -629,7 +628,7 @@ fn filter_coverages(
(include.is_empty() || is_included) && !is_excluded && !is_internal
})
.collect::<Vec<ScriptCoverage>>()
.collect::<Vec<cdp::ScriptCoverage>>()
}
pub async fn cover_files(

14
cli/tools/coverage/range_tree.rs
View file

@ -3,7 +3,7 @@
// Forked from https://github.com/demurgos/v8-coverage/tree/d0ca18da8740198681e0bc68971b0a6cdb11db3e/rust
// Copyright 2021 Charles Samborski. All rights reserved. MIT license.
use super::json_types::CoverageRange;
use crate::cdp;
use std::iter::Peekable;
use typed_arena::Arena;
@ -126,12 +126,12 @@ impl<'rt> RangeTree<'rt> {
tree
}
pub fn to_ranges(&self) -> Vec<CoverageRange> {
let mut ranges: Vec<CoverageRange> = Vec::new();
pub fn to_ranges(&self) -> Vec<cdp::CoverageRange> {
let mut ranges: Vec<cdp::CoverageRange> = Vec::new();
let mut stack: Vec<(&RangeTree, i64)> = vec![(self, 0)];
while let Some((cur, parent_count)) = stack.pop() {
let count: i64 = parent_count + cur.delta;
ranges.push(CoverageRange {
ranges.push(cdp::CoverageRange {
start_char_offset: cur.start,
end_char_offset: cur.end,
count,
@ -145,7 +145,7 @@ impl<'rt> RangeTree<'rt> {
pub fn from_sorted_ranges<'a>(
rta: &'a RangeTreeArena<'a>,
ranges: &[CoverageRange],
ranges: &[cdp::CoverageRange],
) -> Option<&'a mut RangeTree<'a>> {
Self::from_sorted_ranges_inner(
rta,
@ -157,7 +157,7 @@ impl<'rt> RangeTree<'rt> {
fn from_sorted_ranges_inner<'a, 'b, 'c: 'b>(
rta: &'a RangeTreeArena<'a>,
ranges: &'b mut Peekable<impl Iterator<Item = &'c CoverageRange>>,
ranges: &'b mut Peekable<impl Iterator<Item = &'c cdp::CoverageRange>>,
parent_end: usize,
parent_count: i64,
) -> Option<&'a mut RangeTree<'a>> {
@ -190,7 +190,7 @@ mod tests {
#[test]
fn from_sorted_ranges_empty() {
let rta = RangeTreeArena::new();
let inputs: Vec<CoverageRange> = vec![CoverageRange {
let inputs: Vec<cdp::CoverageRange> = vec![cdp::CoverageRange {
start_char_offset: 0,
end_char_offset: 9,
count: 1,