eco 0.23.0

A tool for reasoning about breaking changes in Rust ecosystems
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
//! Generate update information from dependency information.

use std::sync::Arc;
use std::collections::HashMap;
use std::io::{self, Write};

use semver::{self, Version};

use crate::dependencies;

/// Writes update info.
pub fn write<W: Write>(update_packages: &[Package], w: &mut W) -> Result<(), io::Error> {
    use piston_meta::json;

    writeln!(w, "{{")?;
    let n0 = update_packages.len();
    for (i0, update_package) in update_packages.iter().enumerate() {
        write!(w, "  ")?;
        json::write_string(w, &update_package.name)?;
        writeln!(w, ": {{")?;
        writeln!(w, "    \"order\": {},", update_package.order)?;

        // Bump package.
        writeln!(w, "    \"bump\": {{")?;
        write!(w, "      \"old\": ")?;
        json::write_string(w, &format!("{}", update_package.bump.old))?;
        writeln!(w, ",")?;
        write!(w, "      \"new\": ")?;
        json::write_string(w, &format!("{}", update_package.bump.new))?;
        writeln!(w, "")?;
        writeln!(w, "    }},")?;

        // Dependencies.
        writeln!(w, "    \"dependencies\": {{")?;
        let n1 = update_package.dependencies.len();
        for (i1, dep) in update_package.dependencies.iter().enumerate() {
            write!(w, "      ")?;
            json::write_string(w, &dep.name)?;
            writeln!(w, ": {{")?;
            writeln!(w, "        \"bump\": {{")?;
            write!(w, "          \"old\": ")?;
            json::write_string(w, &format!("{}", dep.bump.old))?;
            writeln!(w, ",")?;
            write!(w, "          \"new\": ")?;
            json::write_string(w, &format!("{}", dep.bump.new))?;
            writeln!(w, "")?;
            writeln!(w, "        }}")?;
            write!(w, "      }}")?;
            if i1 + 1 < n1 {
                writeln!(w, ",")?;
            } else {
                writeln!(w, "")?;
            }
        }
        writeln!(w, "    }},")?;

        // Dev dependencies.
        writeln!(w, "    \"dev-dependencies\": {{")?;
        let n1 = update_package.dev_dependencies.len();
        for (i1, dep) in update_package.dev_dependencies.iter().enumerate() {
            write!(w, "      ")?;
            json::write_string(w, &dep.name)?;
            writeln!(w, ": {{")?;
            writeln!(w, "        \"bump\": {{")?;
            write!(w, "          \"old\": ")?;
            json::write_string(w, &format!("{}", dep.bump.old))?;
            writeln!(w, ",")?;
            write!(w, "          \"new\": ")?;
            json::write_string(w, &format!("{}", dep.bump.new))?;
            writeln!(w, "")?;
            writeln!(w, "        }}")?;
            write!(w, "      }}")?;
            if i1 + 1 < n1 {
                writeln!(w, ",")?;
            } else {
                writeln!(w, "")?;
            }
        }
        writeln!(w, "    }}")?;

        write!(w, "  }}")?;
        if i0 + 1 < n0 {
            writeln!(w, ",")?;
        } else {
            writeln!(w, "")?;
        }
    }
    writeln!(w, "}}")?;
    Ok(())
}

/// Stores old and new version.
pub struct Bump {
    /// The old version.
    pub old: Version,
    /// The new version.
    pub new: Version,
}

/// Stores update info for dependency.
pub struct Dependency {
    /// The library name.
    pub name: Arc<String>,
    /// Bump info.
    pub bump: Bump,
}

/// Stores information about a package.
pub struct Package {
    /// The package name.
    pub name: Arc<String>,
    /// The order to update library.
    pub order: u32,
    /// Update information.
    pub bump: Bump,
    /// The dependencies.
    pub dependencies: Vec<Dependency>,
    /// The dev dependencies.
    pub dev_dependencies: Vec<Dependency>,
}

/// Tries appending zero to version to make it parse.
/// Ignores extra information after `,`.
pub fn parse_version(text: &str) -> Result<Version, semver::SemVerError> {
    let text = if text == "1" { "1.0" } else { text };
    let text = if text == "^1" { "1.0" } else { text };

    // Ignore `>=`.
    let mut text = if text.starts_with(">=") {
        &text[2..]
    } else if text.starts_with("^") {
        &text[1..]
    } else if text.starts_with("=") {
        &text[1..]
    } else {
        text
    };

    // Ignore extra information after `,`.
    for ch in text.char_indices() {
        if ch.1 == ',' {
            text = &text[..ch.0];
        }
    }

    let text = {
        let n = text.len();
        if text.ends_with(".*") {
            &text[..n - 2]
        } else {
            text
        }
    };
    match Version::parse(text) {
        Err(_) => {
            let append_zero = format!("{}.0", text);
            Version::parse(&append_zero)
        }
        x => x,
    }
}

/// Generates update info.
pub fn generate_update_info_from(dependency_info: &str) -> Result<String, String> {
    use piston_meta::*;

    type PackageIndex = usize;
    type Depth = u32;

    fn depth_of(
        package_index: PackageIndex,
        package_indices: &HashMap<Arc<String>, PackageIndex>,
        depths: &mut HashMap<PackageIndex, Depth>,
        dependencies_data: &[dependencies::Package],
    ) -> Depth {
        let package = &dependencies_data[package_index];
        let d = depths.get(&package_index).map(|d| *d);
        match d {
            None => {
                // The depth of a package equals maximum depth of the dependencies + 1.
                let new_depth: Depth = package
                    .dependencies
                    .iter()
                    .map(|dep| {
                        package_indices
                            .get(&dep.name)
                            .map(|&p| depth_of(p, package_indices, depths, dependencies_data))
                            .unwrap_or(0)
                    })
                    .max()
                    .unwrap_or(0) + 1;
                depths.insert(package_index, new_depth);
                new_depth
            }
            Some(x) => x,
        }
    }

    // Whether the version should be ignored.
    fn ignore_version(text: &str) -> bool {
        text == "*"
    }

    // Returns true if two different versions means a breaking change.
    fn breaks(a: &Version, b: &Version) -> bool {
        if a.major != b.major {
            true
        } else if a.major != 0 {
            false
        } else if a.minor != b.minor {
            true
        } else if a.minor != 0 {
            false
        } else if a.patch != b.patch {
            true
        } else {
            false
        }
    }

    // Increment first non-zero number.
    fn increment_version(version: &mut Version) {
        if version.major != 0 {
            version.increment_major();
        } else if version.minor != 0 {
            version.increment_minor();
        } else {
            version.increment_patch();
        }
    }

    // Parse and convert to dependencies data.
    let dependencies_meta_syntax = include_str!("../assets/dependencies/syntax.txt");
    let dependencies_meta_rules =
        stderr_unwrap(dependencies_meta_syntax, syntax(dependencies_meta_syntax));
    let mut dependency_info_meta_data = vec![];
    stderr_unwrap(
        dependency_info,
        parse(
            &dependencies_meta_rules,
            dependency_info,
            &mut dependency_info_meta_data,
        ),
    );
    let mut ignored = vec![];
    let dependencies_data = dependencies::convert(&dependency_info_meta_data, &mut ignored)
        .map_err(|_| String::from("Could not convert dependency info"))?;

    // Stores the package indices using package name as key.
    let package_indices: HashMap<Arc<String>, PackageIndex> = HashMap::from_iter(
        dependencies_data
            .iter()
            .enumerate()
            .map(|(i, p)| (p.name.clone(), i)),
    );

    // Store the depths of libraries.
    let mut depths: HashMap<PackageIndex, Depth> = HashMap::new();
    for i in 0..dependencies_data.len() {
        let _depth = depth_of(i, &package_indices, &mut depths, &dependencies_data);
    }

    let mut new_versions: HashMap<Arc<String>, Version> = HashMap::new();
    for package in &dependencies_data {
        // Get latest version used by any dependency.
        for dep in &package.dependencies {
            if ignore_version(&dep.version) {
                continue;
            }

            let version = parse_version(&dep.version).map_err(|_| {
                format!(
                    "Could not parse version `{}` for dependency `{}` in `{}`",
                    &dep.version, &dep.name, &package.name
                )
            })?;
            let v = new_versions.get(&dep.name).map(|v| v.clone());
            match v {
                None => {
                    new_versions.insert(dep.name.clone(), version);
                }
                Some(v) => {
                    if v < version {
                        new_versions.insert(dep.name.clone(), version);
                    }
                }
            }
        }

        // Get latest version used by any dev dependency.
        for dep in &package.dev_dependencies {
            if ignore_version(&dep.version) {
                continue;
            }

            let version = parse_version(&dep.version).map_err(|_| {
                format!(
                    "Could not parse version `{}` for dev dependency `{}` in `{}`",
                    &dep.version, &dep.name, &package.name
                )
            })?;
            let v = new_versions.get(&dep.name).map(|v| v.clone());
            match v {
                None => {
                    new_versions.insert(dep.name.clone(), version);
                }
                Some(v) => {
                    if v < version {
                        new_versions.insert(dep.name.clone(), version);
                    }
                }
            }
        }
    }

    // Overwrite the versions used by packages.
    for package in &dependencies_data {
        let version = Version::parse(&package.version).map_err(|_| {
            format!(
                "Could not parse version `{}` for `{}`",
                &package.version, &package.name
            )
        })?;
        new_versions.insert(package.name.clone(), version);
    }

    // Create list of sorted package indices by depth.
    let mut sorted_depths: Vec<_> = depths.iter().collect();
    sorted_depths.sort_by(|&(_, da), &(_, db)| da.cmp(db));

    // Stores the update info.
    let mut update_packages: Vec<Package> = vec![];

    for (&package_index, &order) in sorted_depths {
        let package = &dependencies_data[package_index];
        let mut update_dependencies = vec![];

        // Find dependencies that needs update.
        for dep in &package.dependencies {
            if ignore_version(&dep.version) {
                continue;
            }
            // Do not generate update info for dependencies starting with `>=`.
            if dep.version.starts_with(">=") {
                continue;
            }

            let old_version = parse_version(&dep.version).map_err(|_| {
                format!(
                    "Could not parse version `{}` for dependency `{}` in `{}`",
                    &dep.version, &dep.name, &package.name
                )
            })?;
            let new_version = new_versions.get(&dep.name).unwrap();
            if breaks(new_version, &old_version) {
                if let Some(ref ignore_version) = dep.ignore_version {
                    // Ignore update to a specific version.
                    if &new_version.to_string() == &**ignore_version {
                        continue;
                    }
                }
                update_dependencies.push(Dependency {
                    name: dep.name.clone(),
                    bump: Bump {
                        old: old_version,
                        new: new_version.clone(),
                    },
                });
            }
        }

        // If any dependency needs update, then the package needs update.
        if update_dependencies.len() > 0 {
            let old_version = Version::parse(&package.version).map_err(|_| {
                format!(
                    "Could not parse version `{}` for `{}`",
                    &package.version, &package.name
                )
            })?;
            let new_version = new_versions.get_mut(&package.name).unwrap();
            if *new_version == old_version {
                increment_version(new_version);
            }
            update_packages.push(Package {
                name: package.name.clone(),
                order: order,
                bump: Bump {
                    old: old_version,
                    new: new_version.clone(),
                },
                dependencies: update_dependencies,
                dev_dependencies: vec![],
            });
        }
    }

    // Find dev dependencies that needs update.
    // This requires a second step since a library can have dev-dependencies to
    // a library with higher depth.
    for update_package in &mut update_packages {
        let package_index = *package_indices.get(&update_package.name).unwrap();
        let package = &dependencies_data[package_index];

        for dep in &package.dev_dependencies {
            if ignore_version(&dep.version) {
                continue;
            }
            // Do not generate update info for dependencies starting with `>=`.
            if dep.version.starts_with(">=") {
                continue;
            }

            let old_version = parse_version(&dep.version).map_err(|_| {
                format!(
                    "Could not parse version `{}` for dev dependency `{}` in `{}`",
                    &dep.version, &dep.name, &package.name
                )
            })?;
            let new_version = new_versions.get(&dep.name).unwrap();
            if breaks(new_version, &old_version) {
                if let Some(ref ignore_version) = dep.ignore_version {
                    // Ignore update to a specific version.
                    if &new_version.to_string() == &**ignore_version {
                        continue;
                    }
                }
                update_package.dev_dependencies.push(Dependency {
                    name: dep.name.clone(),
                    bump: Bump {
                        old: old_version,
                        new: new_version.clone(),
                    },
                });
            }
        }
    }

    let mut w: Vec<u8> = vec![];
    write(&update_packages, &mut w).unwrap();

    Ok(String::from_utf8(w).unwrap())
}