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

feat(service): Add matrix service #410

Merged
merged 9 commits into from
Oct 4, 2022
Merged

feat(service): Add matrix service #410

merged 9 commits into from
Oct 4, 2022

Conversation

arnocornette
Copy link
Contributor

@arnocornette arnocornette commented Oct 2, 2022

Description

Adds a notifier service for Matrix

Motivation and Context

This addresses #283 partially. I decided to split up the Matrix and Signal PRs as tey are two features in one ticket.

Matrix is an open standard and communication protocl for real-time communication.

How Has This Been Tested?

I tested this in 2 steps:

  • Basic unit tests using mocks
  • Manual testing has been performed as well

Screenshots / Output (if appropriate):

image
This is output from several runs.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@arnocornette arnocornette changed the title Feat/service matrix feat(service): Add matrix service Oct 2, 2022
@arnocornette
Copy link
Contributor Author

arnocornette commented Oct 2, 2022

Normally I reformatted with gofumpt. My bad, didn't see that you used a different formatter

P.S. Maybe you can put it in the how to contribute page?

@codecov-commenter
Copy link

codecov-commenter commented Oct 2, 2022

Codecov Report

Base: 63.55% // Head: 64.06% // Increases project coverage by +0.51% 🎉

Coverage data is based on head (3d3d28a) compared to base (3e00299).
Patch coverage: 72.58% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #410      +/-   ##
==========================================
+ Coverage   63.55%   64.06%   +0.51%     
==========================================
  Files          30       32       +2     
  Lines        1029     1091      +62     
==========================================
+ Hits          654      699      +45     
- Misses        316      326      +10     
- Partials       59       66       +7     
Impacted Files Coverage Δ
service/matrix/mock_matrix_client.go 70.00% <70.00%> (ø)
service/matrix/matrix.go 75.00% <75.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

service/matrix/matrix.go Outdated Show resolved Hide resolved
service/matrix/matrix_test.go Outdated Show resolved Hide resolved
service/matrix/matrix_test.go Show resolved Hide resolved
service/matrix/matrix_test.go Show resolved Hide resolved
service/matrix/matrix.go Outdated Show resolved Hide resolved
service/matrix/matrix.go Show resolved Hide resolved
@svaloumas
Copy link
Collaborator

Normally I reformatted with gofumpt. My bad, didn't see that you used a different formatter

P.S. Maybe you can put it in the how to contribute page?

@nikoksr Leaving this comment here cause I think that's a good idea to consider.

@nikoksr
Copy link
Owner

nikoksr commented Oct 4, 2022

Normally I reformatted with gofumpt. My bad, didn't see that you used a different formatter

P.S. Maybe you can put it in the how to contribute page?

@nikoksr Leaving this comment here cause I think that's a good idea to consider.

100% agree. We can go over the step-by-step guide and make it a little bit more granular probably. Thanks for the feedback @arnocornette.

@arnocornette
Copy link
Contributor Author

I think the linter will not complain now but it's hard as the lint action does not give the filenames it doesn't work on

@nikoksr
Copy link
Owner

nikoksr commented Oct 4, 2022

@arnocornette not sure if you're aware of it, but you can run make lint and make fmt locally. That should help you resolve it.

We'll definitely clarify the step-by-step section in the contrib guide.

@svaloumas svaloumas self-requested a review October 4, 2022 14:58
@svaloumas svaloumas merged commit d2dfd10 into nikoksr:main Oct 4, 2022
@nikoksr
Copy link
Owner

nikoksr commented Oct 4, 2022

Greatly appreciate your contribution, @arnocornette! And thanks again for the feedback.

@blackandred
Copy link

Awesome work, thank you! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants