[needs review] 946 feature HeaderWithItsEntry

[jameschrray]

PR summary

Fetches #1860 as CI build is failing there due to overuse of CI resources on my normal account. Has additional fixes.

Aims to close #946.

By changing EntryWithHeader to an HeaderWithItsEntry tuple struct (with getters etc.), and using a try_from_header_and_entry() as a constructor and not a new() constructor, this introduces a lot of changes, and not only with renaming. The rename to HeaderWithItsEntry, to me, indicates intent more clearly: this is a header that must be with its corresponding entry, and not just with any entry. Thus the rename as well as the actual structure should fix #946.

testing/benchmarking notes

The change also broke a couple of tests, since the header and entry in them didn't match, and these tests have been fixed. Convenience functions have been set up, and some additions and changes have been made that could pave the way for more refactoring of repetition.

followups

( any new tickets/concerns that were discovered or created during this work but aren't in scope for review here )

changelog

• if this is a code change that effects some consumer (e.g. zome developers) of holochain core, then it has been added to our between-release changelog with the format

- summary of change [PR#1234](https://github.com/holochain/holochain-rust/pull/1234)

documentation

• this code has been documented according to our docs checklist

[jameschrray]

This is quite baffling with errors for the cli-tests:

+ bats crates/cli/test/hc.bats
1..2
# in the nix store by default
# shadowed after an installation
not ok 1 install and uninstall
# (in test file crates/cli/test/hc.bats, line 19)
#   `hc-cli-install' failed with status 101
# dropping hc binary from cargo home directory

It's hard to debug with a backtrace

error[E0407]: method `augment_clap` is not a member of trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:140:33
    |
140 | #[derive(Clone, Debug, Default, StructOpt)]
    |                                 ^^^^^^^^^
    |                                 |
    |                                 not a member of trait `structopt::StructOpt`
    |                                 in this macro invocation
    | 
   ::: /holochain-rust/build/.cargo/registry/src/github.com-1ecc6299db9ec823/structopt-derive-0.3.6/src/lib.rs:52:1
    |
52  | #[proc_macro_error]
    | ------------------- in this expansion of `#[derive(StructOpt)]`

error[E0407]: method `is_subcommand` is not a member of trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:140:33
    |
140 | #[derive(Clone, Debug, Default, StructOpt)]
    |                                 ^^^^^^^^^
    |                                 |
    |                                 not a member of trait `structopt::StructOpt`
    |                                 in this macro invocation
    | 
   ::: /holochain-rust/build/.cargo/registry/src/github.com-1ecc6299db9ec823/structopt-derive-0.3.6/src/lib.rs:52:1
    |
52  | #[proc_macro_error]
    | ------------------- in this expansion of `#[derive(StructOpt)]`

error[E0407]: method `augment_clap` is not a member of trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:155:33
    |
155 | #[derive(Clone, Debug, Default, StructOpt)]
    |                                 ^^^^^^^^^
    |                                 |
    |                                 not a member of trait `structopt::StructOpt`
    |                                 in this macro invocation
    | 
   ::: /holochain-rust/build/.cargo/registry/src/github.com-1ecc6299db9ec823/structopt-derive-0.3.6/src/lib.rs:52:1
    |
52  | #[proc_macro_error]
    | ------------------- in this expansion of `#[derive(StructOpt)]`

error[E0407]: method `is_subcommand` is not a member of trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:155:33
    |
155 | #[derive(Clone, Debug, Default, StructOpt)]
    |                                 ^^^^^^^^^
    |                                 |
    |                                 not a member of trait `structopt::StructOpt`
    |                                 in this macro invocation
    | 
   ::: /holochain-rust/build/.cargo/registry/src/github.com-1ecc6299db9ec823/structopt-derive-0.3.6/src/lib.rs:52:1
    |
52  | #[proc_macro_error]
    | ------------------- in this expansion of `#[derive(StructOpt)]`

error[E0576]: cannot find method or associated constant `augment_clap` in trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:140:33
    |
140 | #[derive(Clone, Debug, Default, StructOpt)]
    |                                 ^^^^^^^^^
    |                                 |
    |                                 not found in `structopt::StructOpt`
    |                                 in this macro invocation
    | 
   ::: /holochain-rust/build/.cargo/registry/src/github.com-1ecc6299db9ec823/structopt-derive-0.3.6/src/lib.rs:52:1
    |
52  | #[proc_macro_error]
    | ------------------- in this expansion of `#[derive(StructOpt)]`

error[E0576]: cannot find method or associated constant `augment_clap` in trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:155:33
    |
155 | #[derive(Clone, Debug, Default, StructOpt)]
    |                                 ^^^^^^^^^
    |                                 |
    |                                 not found in `structopt::StructOpt`
    |                                 in this macro invocation
    | 
   ::: /holochain-rust/build/.cargo/registry/src/github.com-1ecc6299db9ec823/structopt-derive-0.3.6/src/lib.rs:52:1
    |
52  | #[proc_macro_error]
    | ------------------- in this expansion of `#[derive(StructOpt)]`

error[E0576]: cannot find method or associated constant `augment_clap` in trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:175:17
    |
175 |     #[structopt(flatten)]
    |                 ^^^^^^^ not found in `structopt::StructOpt`

error[E0576]: cannot find method or associated constant `is_subcommand` in trait `structopt::StructOpt`
   --> crates/metrics/src/cloudwatch.rs:175:17
    |
175 |     #[structopt(flatten)]
    |                 ^^^^^^^ not found in `structopt::StructOpt`

[jameschrray]

Well, it works now.

[jameschrray]

Ah, I saw #2014.

[jameschrray]

@thedavidmeister, @maackle and anyone else, may you please review this?

[jameschrray]

I can merge changes from the develop branch but I don't want to needlessly consume Circle CI resources, and I don't know when this will be reviewed, so perhaps whoever wants to review it can merge the changes, and if there are any conflicts I can then fix them up before review.

[jamesray1]

If I fix the current checks will this be reviewed? Or is there anything else that I can do to help it to be reviewed?

[jamesray1]

Is there any general idea of when there might be capacity to review this?

[jamesray1]

Do you want me to fix up holochain/holonix#127 before also fixing this up, and for this to then be reviewed? I'm keen to demonstrate value, but I also want to make sure that my contributions are valued.

[maackle]

I'm OK with this! Let's get at least one other dev to chime in too. @thedavidmeister?

[thedavidmeister]

if this is a try_* then i think we want to return a result rather than panic

[jamesray1]

I'll fix this up when I've got time alongside with a job and startup.

[thedavidmeister]

@maackle sure

[jamesray1]

I didn't run the tests locally before pushing, so no need to run the CI builds yet.

[jamesray1]

 17:10:14  ✘  jr@fm  ~/hcr  ⬡ v8.16.0  🦀 1.33.0-nightly   946-feature-chain-pair ✔ ⬆ 
$ nt
nix-shell: error while loading shared libraries: libboost_context.so.1.69.0: cannot open shared object file: No such file or directory

 17:10:22  ✘  jr@fm  ~/hcr  ⬡ v8.16.0  🦀 1.33.0-nightly   946-feature-chain-pair ✔ ⬆ 
$ alias nt
nt='nix-shell --run hc-rust-test'

[jamesray1]

I may go through steps here again on my desktop:

https://forum.manjaro.org/t/error-while-loading-shared-libraries-libboost-context-so-1-69-0-cannot-open-shared-object-file-no-such-file-or-directory/115811/4