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.

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

Restyle Add message receive and send tracing to chip-tool #13638

Closed

Conversation

restyled-io[bot]
Copy link
Contributor

@restyled-io restyled-io bot commented Jan 17, 2022

A duplicate of #13637 with additional commits that automatically address
incorrect style, created by Restyled.

⚠️ Even though this PR is not a Fork, it contains outside contributions.
Please review accordingly.

Since the original Pull Request was opened as a fork in a contributor's
repository, we are unable to create a Pull Request branching from it with only
the style fixes.

The following Restylers made fixes:

To incorporate these changes, you can either:

  1. Merge this Pull Request instead of the original, or

  2. Ask your contributor to locally incorporate these commits and push them to
    the original Pull Request

    Expand for example instructions
    ```console
    git remote add upstream https://github.com/project-chip/connectedhomeip.git
    git fetch upstream pull/<this PR number>/head
    git merge --ff-only FETCH_HEAD
    git push
    ```
    

NOTE: As work continues on the original Pull Request, this process will
re-run and update (force-push) this Pull Request with updated style fixes as
necessary. If the style is fixed manually at any point (i.e. this process finds
no fixes to make), this Pull Request will be closed automatically.

Sorry if this was unexpected. To disable it, see our documentation.

tcarmelveilleux and others added 4 commits January 14, 2022 13:27
- SessionManager has symetrical processing steps for
  group and unsecured message, but some side-effects of
  unicast secure sessions are delegated to SecureMessageCodec
  that should actually just be encrypt/decrypt logic.
- This is needed to assist in having a single point of tracing
  for incoming/outgoing messages (upcoming PR). Current organization
  requires putting that logic in several modules due to the
  side-effects occuring at the wrong layer.

Done by this PR:
- Hoists those side effects (e.g. updating counter) up from
  SecureMessageCodec where they do not belong, into SessionManager.
- Fix documentation and argument names of SecureMessageCodec that
  had rotted over many refactors and terminological changes.
- Add a bit of processing symmetry in SessionManager

Testing done: unit tests pass, integration tests pass
- Move tracing from SecureMessageCodec to SessionManager
  to allow covering both received and sent messages
- Add received message tracing
- Update trace handling to be flexible to receiving a context
  pointer.
- Refactor trace handling logic in common/tracing to be more
  flexible to
- Add bookend FinishEvent to the TraceStream interface to assist
  in event flushing.

Testing done:
- Integration tests pass, unit tests all pass
- Validated manually through several runs that with chip-tool
  (using `--trace_log 1`) that dumped received/sent message traces
  match the outer higher-level (but less detailed) logs around them
@restyled-io restyled-io bot added the restyled label Jan 17, 2022
@restyled-io restyled-io bot closed this Jan 17, 2022
@restyled-io restyled-io bot deleted the restyled/cleanup-secure-message-processing2 branch January 17, 2022 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants