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

Add nrepl message log #1292

Merged
merged 27 commits into from
Oct 25, 2021
Merged

Add nrepl message log #1292

merged 27 commits into from
Oct 25, 2021

Conversation

bpringe
Copy link
Member

@bpringe bpringe commented Sep 5, 2021

What has Changed?

  • Adds a command for toggling nrepl message logging on and off - "Toggle nREPL Message Logging Enabled"
  • When nrepl logging is enabled, and output channel called "nREPL Messages" is created and shown. nREPL messages are logged to this channel, and you can see the direction in which the message travelled.
  • The command is enabled at all times, whether or not the repl is connected. This allows logging of messages as soon as a repl is connected (if logging is enabled before connecting a repl).
  • When nrepl logging is disabled, the channel is hidden and disposed.

Closes #1198

My Calva PR Checklist

I have:

  • Read How to Contribute.
  • Directed this pull request at the dev branch. (Or have specific reasons to target some other branch.)
  • Made sure I have changed the PR base branch, so that it is not published. (Sorry for the nagging.)
  • Updated the [Unreleased] entry in CHANGELOG.md, linking the issue(s) that the PR is addressing.
  • Figured if anything about the fix warrants tests on Mac/Linux/Windows/Remote/Whatever, and either tested it there if so, or mentioned it in the PR.
  • Added to or updated docs in this branch, if appropriate
  • Tested the VSIX built from the PR (so, after you've submitted the PR). You'll find the artifacts by clicking Show all checks in the CI section of the PR page, and then Details on the ci/circleci: build test. NB: You need to sign in/up at Circle CI to find the Artifacts tab.
    • Tested the particular change
    • Figured if the change might have some side effects and tested those as well.
    • Smoke tested the extension as such.
  • Referenced the issue I am fixing/addressing in a commit message for the pull request.
    • If I am fixing the issue, I have used GitHub's fixes/closes syntax
    • If I am fixing just part of the issue, I have just referenced it w/o any of the "fixes” keywords.
  • Created the issue I am fixing/addressing, if it was not present.

The Calva Team PR Checklist:

Before merging we (at least one of us) have:

  • Made sure the PR is directed at the dev branch (unless reasons).
  • Figured if anything about the fix warrants tests on Mac/Linux/Windows/Remote/Whatever, and tested it there if so.
  • Read the source changes.
  • Given feedback and guidance on source changes, if needed. (Please consider noting extra nice stuff as well.)
  • Tested the VSIX built from the PR (well, if this is a PR that changes the source code.)
    • Tested the particular change
    • Figured if the change might have some side effects and tested those as well.
    • Smoke tested the extension as such.
  • If need be, had a chat within the team about particular changes.

Ping @PEZ, @bpringe

@bpringe bpringe requested a review from PEZ October 3, 2021 23:25
@bpringe bpringe marked this pull request as ready for review October 3, 2021 23:26
@PEZ PEZ force-pushed the add_nrepl_message_log branch from 06ee696 to b3ef801 Compare October 5, 2021 06:12
Copy link
Collaborator

@PEZ PEZ left a comment

Choose a reason for hiding this comment

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

Awesome to finally see this happening! Haven't tried it yet, hopefully I get to do that during the day.

src/nrepl/index.ts Outdated Show resolved Hide resolved
src/nrepl/logging.ts Outdated Show resolved Hide resolved
@bpringe
Copy link
Member Author

bpringe commented Oct 14, 2021

I think the code is ready now, I just need to add info to the docs about it.

@PEZ Where should this go in the docs? We have multiple places for troubleshooting info about specific subjects on those particular pages. I'm not sure if this warrants a new, general troubleshooting page, or if we should fit it into some existing page.

@PEZ
Copy link
Collaborator

PEZ commented Oct 14, 2021

For now we can slap it in here https://calva.io/connect/#troubleshooting maybe? Hmm, that is not a perfect fit at all. Maybe instead create a page cider-nrepl that goes just before the Clojure LSP page, and put the info about this trace there, and link to it from the connection troubeshooting section. Then add an issue to give the new page more love. WDYT? My rationale is to keep it incremental so that this awesome feature does not get locked up in documentation jail. 😄

@bpringe
Copy link
Member Author

bpringe commented Oct 15, 2021

That sounds good to me! I'll be busy this weekend, but will get to it soon.

@bpringe bpringe merged commit 334c15b into dev Oct 25, 2021
@bpringe bpringe deleted the add_nrepl_message_log branch October 25, 2021 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants