refacot(network): simplify the get_record handling code.

[RolandSherwin]

Description

• Refactors the get_record re attempt code by moving the target check inside the kad event handling loop
• This is achieved by moving GetRecordCfg inside the SwarmDriver.
• Also removes early completion for chunks
  • This code exited early if the RecordHeader::RecordKind is found to be a chunk AND if Quorum::One.
  • But we can mimic the same behavior by just setting the Qourum::One in the main code.
  • Thus, we can safely remove the extra code.
• Moves all the get record event handling code to its own file.

Summary generated by Reviewpad on 06 Dec 23 08:01 UTC

This pull request includes the following changes:

• In the bootstrap.rs file, a typo in the comment on line 24 has been corrected, changing "minumn" to "minimum".

• Changes related to handling errors and inconsistencies in retrieving and storing records from the network have been made. This includes an additional variant called ReturnedRecordDoesNotMatch in the GetRecordError enum, which now takes a Record parameter. The ReturnedRecordDoesNotMatch variant has also been removed from the Error enum. Additionally, the ReturnedRecordDoesNotMatch variant in the GetRecordError enum now includes a more detailed error message.

• In the sn_networking crate's lib.rs file, the following changes have been made:

  • A new module called get_record_handler has been added.
  • The Quorum and RecordKey imports from the libp2p::kad module have been removed.
  • The RecordHeader and RecordKind imports from the sn_protocol module have been removed.
  • The impl Network block has been updated with changes related to the handling of record retrieval attempts.

• In the code diff, there are various changes including import statement modifications, code reorganization, removal of unused type definition, and the addition of a new struct named GetRecordCfg. The Debug trait has also been implemented for the GetRecordCfg struct.

• The file diff includes changes to the SwarmCmd enum and its implementation. The import statement for REPLICATE_RANGE has been removed. The GetNetworkRecord variant of the SwarmCmd enum now includes a cfg field of type GetRecordCfg instead of quorum and expected_holders fields. The Debug implementation for the SwarmCmd enum has been updated accordingly. The impl Debug for SwarmCmd block has been updated to use the {holder:?} syntax for formatting the holder field in the AddKeysToReplicationFetcher variant and the topic_id field in the GossipsubPublish variant. The GetNetworkRecord match arm in the impl SwarmDriver block has been modified to use the get_cfg field instead of the quorum and expected_holders fields.

Please review the specific changes in the diff for more details.

[reviewpad]

Reviewpad Report

‼️ Errors

• Unconventional commit detected: 'refactor(network): remove custom early completion for chunks

• the code exited early if the record is a chunk and the quorum is set
  to One.
• But the behaviour happens if we just set the quorum to One. No need to
  perform a custom check there.' (006c6ee)

• Unconventional title detected: 'refacot(network): simplify the get_record handling code.' illegal 'o' character in commit message type: col=05

[joshuef]

Okay, seems a ncie simplification. Lets ensure we need Quorum::All for chunks vs n::2 or ::One for validation there.