This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8960

rhg: add a `DebugData` `Command` to prepare the `rhg debugdata` subcommand
ClosedPublic

Authored by acezar on Aug 26 2020, 9:23 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG66756b34c06e: rhg: add a `DebugData` `Command` to prepare the `rhg debugdata` subcommand

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

acezar created this revision.Aug 26 2020, 9:23 AM
Alphare added a subscriber: Alphare.Aug 28 2020, 8:54 AM
Alphare added inline comments.
rust/rhg/src/commands/debugdata.rs
44

to_string() is unnecessary.

44

Also, didn't we discuss having some sort of utf8_to_local method that did nothing for now but allowed encapsulation for future support of different locales?

acezar marked 2 inline comments as done.Aug 31 2020, 10:37 AM
acezar added inline comments.
rust/rhg/src/commands/debugdata.rs
44

without to_string(): no method named as_bytes` found for type std::io::Error in the current scope`

acezar marked an inline comment as done.Aug 31 2020, 10:40 AM
acezar updated this revision to Diff 22493.
acezar updated this revision to Diff 22530.Sep 3 2020, 4:51 AM
acezar updated this revision to Diff 22534.Sep 3 2020, 8:50 AM
Alphare added inline comments.Sep 6 2020, 4:01 AM
rust/rhg/src/commands/debugdata.rs
44

This is marked as done, but the utf8_to_local encapsulation is nowhere to be found, I'm assuming you forgot since we talked about it last time.

acezar updated this revision to Diff 22581.Sep 9 2020, 6:08 AM
acezar marked an inline comment as done.Sep 9 2020, 6:09 AM
acezar added inline comments.
rust/rhg/src/commands/debugdata.rs
44

Oups. My bad. It's really done now.

acezar marked an inline comment as done.Sep 9 2020, 6:11 AM
acezar updated this revision to Diff 22582.
Alphare accepted this revision.Sep 17 2020, 5:18 AM

Good enough for now, thanks.
I'll probably send a follow-up for the typo and maybe see about removing the .into() calls.

acezar updated this revision to Diff 22781.Sep 23 2020, 8:07 AM
acezar added a commit: rHG66756b34c06e: rhg: add a `DebugData` `Command` to prepare the `rhg debugdata` subcommand.Sep 23 2020, 10:55 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG66756b34c06e: rhg: add a `DebugData` `Command` to prepare the `rhg debugdata` subcommand (authored by acezar). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 22582

rust/hg-core/src/operations/mod.rs

//! A distinction is made between operations and commands. //! A distinction is made between operations and commands.
//! An operation is what can be done whereas a command is what is exposed by //! An operation is what can be done whereas a command is what is exposed by
//! the cli. A single command can use several operations to achieve its goal. //! the cli. A single command can use several operations to achieve its goal.
mod debugdata; mod debugdata;
mod dirstate_status; mod dirstate_status;
mod find_root; mod find_root;
mod list_tracked_files; mod list_tracked_files;
pub use debugdata::{
DebugData, DebugDataError, DebugDataErrorKind, DebugDataKind,
};
pub use find_root::{FindRoot, FindRootError, FindRootErrorKind}; pub use find_root::{FindRoot, FindRootError, FindRootErrorKind};
pub use list_tracked_files::{ pub use list_tracked_files::{
ListTrackedFiles, ListTrackedFilesError, ListTrackedFilesErrorKind, ListTrackedFiles, ListTrackedFilesError, ListTrackedFilesErrorKind,
}; };
// TODO add an `Operation` trait when GAT have landed (rust #44265): // TODO add an `Operation` trait when GAT have landed (rust #44265):
// there is no way to currently define a trait which can both return // there is no way to currently define a trait which can both return
// references to `self` and to passed data, which is what we would need. // references to `self` and to passed data, which is what we would need.
// Generic Associated Types may fix this and allow us to have a unified // Generic Associated Types may fix this and allow us to have a unified
// interface. // interface.

rust/rhg/src/commands.rs

pub mod debugdata;
pub mod files; pub mod files;
pub mod root; pub mod root;
use crate::error::CommandError; use crate::error::CommandError;
use crate::ui::Ui; use crate::ui::Ui;
/// The common trait for rhg commands /// The common trait for rhg commands
/// ///
/// Normalize the interface of the commands provided by rhg /// Normalize the interface of the commands provided by rhg
pub trait Command { pub trait Command {
fn run(&self, ui: &Ui) -> Result<(), CommandError>; fn run(&self, ui: &Ui) -> Result<(), CommandError>;
} }

rust/rhg/src/commands/debugdata.rs

  • This file was added.
use crate::commands::Command;
use crate::error::{CommandError, CommandErrorKind};
use crate::ui::utf8_to_local;
use crate::ui::Ui;
use hg::operations::{
DebugData, DebugDataError, DebugDataErrorKind, DebugDataKind,
};
pub const HELP_TEXT: &str = "
Dump the contents of a data file revision
";
pub struct DebugDataCommand<'a> {
rev: &'a str,
kind: DebugDataKind,
}
impl<'a> DebugDataCommand<'a> {
pub fn new(rev: &'a str, kind: DebugDataKind) -> Self {
DebugDataCommand { rev, kind }
}
}
impl<'a> Command for DebugDataCommand<'a> {
fn run(&self, ui: &Ui) -> Result<(), CommandError> {
let mut operation = DebugData::new(self.rev, self.kind);
let data =
operation.run().map_err(|e| to_command_error(self.rev, e))?;
let mut stdout = ui.stdout_buffer();
stdout.write_all(&data)?;
stdout.flush()?;
Ok(())
}
}
/// Convert operation errors to command errors
fn to_command_error(rev: &str, err: DebugDataError) -> CommandError {
match err.kind {
DebugDataErrorKind::FindRootError(err) => CommandError::from(err),
DebugDataErrorKind::IoError(err) => CommandError {
kind: CommandErrorKind::Abort(Some(
utf8_to_local(&format!("abort: {}\n", err)).into(),
AlphareUnsubmitted
Done

to_string() is unnecessary.

Alphare: `to_string()` is unnecessary.
acezarAuthorUnsubmitted
Done

without to_string(): no method named as_bytes` found for type std::io::Error in the current scope`

acezar: without `to_string()`: `no method named `as_bytes` found for type `std::io::Error` in the…
AlphareUnsubmitted
Done

Also, didn't we discuss having some sort of utf8_to_local method that did nothing for now but allowed encapsulation for future support of different locales?

Alphare: Also, didn't we discuss having some sort of `utf8_to_local` method that did nothing for now but…
AlphareUnsubmitted
Done

This is marked as done, but the utf8_to_local encapsulation is nowhere to be found, I'm assuming you forgot since we talked about it last time.

Alphare: This is marked as done, but the `utf8_to_local` encapsulation is nowhere to be found, I'm…
acezarAuthorUnsubmitted
Done

Oups. My bad. It's really done now.

acezar: Oups. My bad. It's really done now.
)),
},
DebugDataErrorKind::InvalidRevision => CommandError {
kind: CommandErrorKind::Abort(Some(
utf8_to_local(&format!(
"abort: invalid revision identifier{}\n",
rev
))
.into(),
)),
},
DebugDataErrorKind::UnsuportedRevlogVersion(version) => CommandError {
kind: CommandErrorKind::Abort(Some(
utf8_to_local(&format!(
"abort: unsupported revlog version {}\n",
version
))
.into(),
)),
},
DebugDataErrorKind::CorruptedRevlog => CommandError {
kind: CommandErrorKind::Abort(Some(
"abort: corrupted revlog\n".into(),
)),
},
DebugDataErrorKind::UnknowRevlogDataFormat(format) => CommandError {
kind: CommandErrorKind::Abort(Some(
utf8_to_local(&format!(
"abort: unknow revlog dataformat {:?}\n",
format
))
.into(),
)),
},
}
}

rust/rhg/src/ui.rs

use std::borrow::Cow;
use std::io; use std::io;
use std::io::{ErrorKind, Write}; use std::io::{ErrorKind, Write};
#[derive(Debug)] #[derive(Debug)]
pub struct Ui { pub struct Ui {
stdout: std::io::Stdout, stdout: std::io::Stdout,
stderr: std::io::Stderr, stderr: std::io::Stderr,
} }
fn handle_stderr_error(error: io::Error) -> Result<(), UiError> { fn handle_stderr_error(error: io::Error) -> Result<(), UiError> {
// A broken pipe should not result in a error // A broken pipe should not result in a error
// like with `| head` for example // like with `| head` for example
if let ErrorKind::BrokenPipe = error.kind() { if let ErrorKind::BrokenPipe = error.kind() {
return Ok(()); return Ok(());
} }
Err(UiError::StdoutError(error)) Err(UiError::StdoutError(error))
} }
/// Encode rust strings according to the user system.
pub fn utf8_to_local(s: &str) -> Cow<[u8]> {
// TODO encode for the user's system //
let bytes = s.as_bytes();
Cow::Borrowed(bytes)
}