ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

cli: add hint when snapshot fails due to large file

Browse source 
I also converted the error from `InternalError` to `UserError`. So far
I've intented to use `InternalError` only to indicate bugs or corrupt
repos. I'm not sure that's a good idea, and we can revisit it later.
This commit is contained in:
Martin von Zweigbergk 2023-09-01 09:08:43 -07:00 committed by Martin von Zweigbergk
parent c329cc0dc1
commit f3a16eb964
2 changed files with 44 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
cli/src/cli_util.rs
View file

@ -206,7 +206,16 @@ impl From<OpHeadResolutionError<CommandError>> for CommandError {
impl From<SnapshotError> for CommandError {
fn from(err: SnapshotError) -> Self {
CommandError::InternalError(format!("Failed to snapshot the working copy: {err}"))
match err {
SnapshotError::NewFileTooLarge { .. } => user_error_with_hint(
format!("Failed to snapshot the working copy: {err}"),
r#"Increase the value of the `snapshot.max-new-file-size` config option if you
want this file to be snapshotted. Otherwise add it to your `.gitignore` file."#,
),
err => {
CommandError::InternalError(format!("Failed to snapshot the working copy: {err}"))
}
}
}
}

34
cli/tests/test_working_copy.rs Normal file
View file

@ -0,0 +1,34 @@
// Copyright 2023 The Jujutsu Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::common::TestEnvironment;
pub mod common;
#[test]
fn test_snapshot_large_file() {
let test_env = TestEnvironment::default();
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
let repo_path = test_env.env_root().join("repo");
test_env.add_config(r#"snapshot.max-new-file-size = "10""#);
std::fs::write(repo_path.join("large"), "a lot of text").unwrap();
let stderr = test_env.jj_cmd_failure(&repo_path, &["files"]);
insta::assert_snapshot!(stderr, @r###"
BUG: Working copy lock was dropped without being closed.
Error: Failed to snapshot the working copy: New file $TEST_ENV/repo/large of size ~13.0B exceeds snapshot.max-new-file-size (10.0B)
Hint: Increase the value of the `snapshot.max-new-file-size` config option if you
want this file to be snapshotted. Otherwise add it to your `.gitignore` file.
"###);
}