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

Jump to bottom

Don't hide ffi-inliner errors #82

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Don't hide ffi-inliner errors #82

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
24 changes: 14 additions & 10 deletions lib/ffi-libarchive/entry.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,12 +181,14 @@ def copy_lstat(filename)
raise "ffi-inliner build for copy_stat failed:\n#{e}"
end

stat = Archive::Stat.ffi_libarchive_create_lstat(filename)
raise Error, "Copy stat failed: #{Archive::Stat.ffi_error}" if stat.null?
begin
stat = Archive::Stat.ffi_libarchive_create_lstat(filename)
raise Error, "Copy stat failed: #{Archive::Stat.ffi_error}" if stat.null?

C.archive_entry_copy_stat(entry, stat)
ensure
Archive::Stat.ffi_libarchive_free_stat(stat)
C.archive_entry_copy_stat(entry, stat)
ensure
Archive::Stat.ffi_libarchive_free_stat(stat)
end
Comment on lines +184 to +191
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe I'm wrong, but won't this still be the same? It'll still raise an error, the ensure will still fire, the free_stat will still fire, no?

[phil@rider ~]$ cat /tmp/test2.rb 
#!/usr/bin/ruby


def test
  puts "foo"
  begin
    raise 'test error'
  ensure
    raise 'ensure error'
  end
end

test
[phil@rider ~]$ /tmp/test.rb 
foo
/tmp/test.rb:8:in `ensure in test': ensure error (RuntimeError)
	from /tmp/test.rb:8:in `test'
	from /tmp/test.rb:11:in `<main>'
/tmp/test.rb:6:in `test': test error (RuntimeError)
	from /tmp/test.rb:11:in `<main>'
[phil@rider ~]$ /tmp/test2.rb 
foo
/tmp/test2.rb:9:in `ensure in test': ensure error (RuntimeError)
	from /tmp/test2.rb:9:in `test'
	from /tmp/test2.rb:13:in `<main>'
/tmp/test2.rb:7:in `test': test error (RuntimeError)
	from /tmp/test2.rb:13:in `<main>'

I think you want to rescue the specific error you're looking for.

Or perhaps you want to not call ffi_libarchive_free_stat if stat is null?

Copy link
Contributor Author

@sj26 sj26 Aug 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Ah, sorry, I didn't explain very well. The error comes from the require on line 179, while loading the file and running ffi-inliner. That is caught a another error raised by 181. Then the ensure block runs line 189 which has no hope of succeeding.

It's closer to:

def test
  begin
    raise "original error"
  rescue
    raise "had an error"
  end
  foo = true
ensure
  unless foo
    raise "unrelated error"
  end
end

test
/tmp/test.rb:10:in `ensure in test': unrelated error (RuntimeError)
	from /tmp/test.rb:10:in `test'
	from /tmp/test.rb:14:in `<main>'
/tmp/test.rb:5:in `rescue in test': had an error (RuntimeError)
	from /tmp/test.rb:2:in `test'
	from /tmp/test.rb:14:in `<main>'
/tmp/test.rb:3:in `test': original error (RuntimeError)
	from /tmp/test.rb:14:in `<main>'

and this refactors to:

def test
  begin
    raise "original error"
  rescue
    raise "had an error"
  end

  begin
    foo = true
  ensure
    unless foo
      raise "unrelated error"
    end
  end
end

test
/tmp/test.rb:5:in `rescue in test': had an error (RuntimeError)
	from /tmp/test.rb:2:in `test'
	from /tmp/test.rb:16:in `<main>'
/tmp/test.rb:3:in `test': original error (RuntimeError)
	from /tmp/test.rb:16:in `<main>'

It prevents the ensure block coming into context unless the condition it is protecting against can exist, preventing a red herring during error diagnosis for the user.

end

def copy_pathname(file_name)
Expand All @@ -207,12 +209,14 @@ def copy_stat(filename)
raise "ffi-inliner build for copy_stat failed:\n#{e}"
end

stat = Archive::Stat.ffi_libarchive_create_stat(filename)
raise Error, "Copy stat failed: #{Archive::Stat.ffi_error}" if stat.null?
begin
stat = Archive::Stat.ffi_libarchive_create_stat(filename)
raise Error, "Copy stat failed: #{Archive::Stat.ffi_error}" if stat.null?

C.archive_entry_copy_stat(entry, stat)
ensure
Archive::Stat.ffi_libarchive_free_stat(stat)
C.archive_entry_copy_stat(entry, stat)
ensure
Archive::Stat.ffi_libarchive_free_stat(stat)
end
end

def copy_symlink(slnk)
Expand Down