feat(service): Add Web Push

[KaviiSuri]

Description

This introduces the web push service as a notifier in the library. It uses webpush-go to handle the notifications.

This PR is still a draft!

Motivation and Context

This PR aims to close #112

How Has This Been Tested?

I need some advice on this as the webpush-go package does not provide a client struct that we can mock, rather it's a bunch of global functions.

Should the testing be done by creating such an abstraction (client struct)? Or, testing the logic to parse the options from context and payload should be enough?

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.

[KaviiSuri]

@nikoksr I've implemented the basic webpush notification service in this PR, but I need advice on the testing approach.
Would love some feedback from too!

[nikoksr]

@KaviiSuri thank you so much for this! Looks very promising already. Please excuse the delay, we're both rather busy atm but will come back to this asap!

[nikoksr]

Hi @KaviiSuri, so sorry for the big delay. Your PR is next in line, I'll tackle it over the holidays! Once again, appreciate your efforts and patience.

[KaviiSuri]

@nikoksr no problem at all! I completed understand.

I hope to contribute and learn more!

[nikoksr]

@KaviiSuri going over this now! I'll hit you up with feedback asap. Appreciate your patience so much. Hope things are well with you.

[gedw99]

@KaviiSuri

it’s blocked on static analysis ?

[KaviiSuri]

Hey @gedw99
I just noticed it, it's asking for a package comment, will do it asap!

[gedw99]

asap

ok thanks !

[KaviiSuri]

Hey @gedw99, the codacy url shows 503 Service Temporarily Unavailable. Any idea on how to fix it?

[gedw99]

Hey @gedw99, the codacy url shows 503 Service Temporarily Unavailable. Any idea on how to fix it?

No
I looked at the Workflows buy nothing stands out .

is their service down ?

[KaviiSuri]

is their service down?
It was, not anymore apparently

[nikoksr]

@KaviiSuri finally got to give this my full attention.. so sorry for the huge delay. To compensate you for your patience, you don't need to do any refactoring work, it's all done.

Your struggles with this PR are absolultely understandable to me. And I agree with you, it's not our obligation to test the webpush library in it's fullness. We just have to make sure that whatever data we touch, manipulate and forward to the library is well tested. I've utilized the httptest.Server for this, similar as with our internal HTTP service. I'm curious for your feedback on this!

Also, I made some changes to your implementation that generalize its usage a bit, but overall it was a joy working with your code. Great job, we appreciate it a ton! I'll go ahead fix the remaining linter issues and we'll be ready to merge right after. Hope you're doing well and sorry again for the delay.

Edit: Oh, and before I forget, please check if the end-to-end test still works! I may have very well broken your working implementation haha

[codecov-commenter]

Codecov Report

Patch coverage: 76.82% and project coverage change: +0.09 🎉

Comparison is base (3f4d10d) 75.07% compared to head (8171fd0) 75.17%.

❗ Current head 8171fd0 differs from pull request most recent head e387801. Consider uploading reports for the commit e387801 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #441      +/-   ##
==========================================
+ Coverage   75.07%   75.17%   +0.09%     
==========================================
  Files          41       42       +1     
  Lines        1376     1458      +82     
==========================================
+ Hits         1033     1096      +63     
- Misses        251      268      +17     
- Partials       92       94       +2     

Impacted Files	Coverage Δ
service/webpush/webpush.go	76.82% <76.82%> (ø)

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

[KaviiSuri]

@nikoksr thanks for making the improvements! So happy to contribute to the project, would love to do more work here moving forward!

[gedw99]

MIght be useful to add the following to README

https://caniuse.com/notifications

IOS needs A2HS. Like ths golang pwa does: https://go-app.dev/

[nikoksr]

@KaviiSuri @gedw99 does any of you happen to know an easy way for us to test this solution end-to-end? It's pretty safe to assume that SherClockHolmes/webpush-go does its job well and just works, but I don't like the idea of just releasing the solution without checking its behavior once.

@gedw99 great idea, we'll definitely include this!

[gedw99]

@KaviiSuri @gedw99 does any of you happen to know an easy way for us to test this solution end-to-end? It's pretty safe to assume that SherClockHolmes/webpush-go does its job well and just works, but I don't like the idea of just releasing the solution without checking its behavior once.

@gedw99 great idea, we'll definitely include this!

I test E2E locally using Caddy, MkCert for the Server. Gives you a https locally with custom domain name.
https://github.com/FiloSottile/mkcert

For the Wasm services worker i use go.app: https://github.com/maxence-charriere/go-app

I think it would be a good idea to make a little demo in this repo one day when there is time.

In CI, I can run caddy and mkcert, using a makefile as part of github workflows.
It's the exact same makefile used on your laptop, just called as part of CI.
I like this because i get full control and don't need any docker containers in CI so its fast.

For CI of the GUI, thats hard. I use screen shots and Goldens. Its brutal but works. I don't have a framework yet i can recommend because i use GIO which has build in screen shotting. It runs on web, desktop and mobile. SO its makes cross devcie testing easier. BUT gio is not used by others.

But the idea is to deploy the web app as a github page as part of CI, then you can tell it to screenshot and then you can test you got the right screen shot against your golden screenshot.

Because the makefiles are 100% OS independent you can test for all Desktops and their browsers.

Again i tres that CI browser testing is HARD and these are only suggestions.

I would be happy to work on this with someone.

[nikoksr]

@KaviiSuri @gedw99 does any of you happen to know an easy way for us to test this solution end-to-end? It's pretty safe to assume that SherClockHolmes/webpush-go does its job well and just works, but I don't like the idea of just releasing the solution without checking its behavior once.
@gedw99 great idea, we'll definitely include this!

I test E2E locally using Caddy, MkCert for the Server. Gives you a https locally with custom domain name. FiloSottile/mkcert

For the Wasm services worker i use go.app: maxence-charriere/go-app

I think it would be a good idea to make a little demo in this repo one day when there is time.

In CI, I can run caddy and mkcert, using a makefile as part of github workflows. It's the exact same makefile used on your laptop, just called as part of CI. I like this because i get full control and don't need any docker containers in CI so its fast.

For CI of the GUI, thats hard. I use screen shots and Goldens. Its brutal but works. I don't have a framework yet i can recommend because i use GIO which has build in screen shotting. It runs on web, desktop and mobile. SO its makes cross devcie testing easier. BUT gio is not used by others.

But the idea is to deploy the web app as a github page as part of CI, then you can tell it to screenshot and then you can test you got the right screen shot against your golden screenshot.

Because the makefiles are 100% OS independent you can test for all Desktops and their browsers.

Again i tres that CI browser testing is HARD and these are only suggestions.

I would be happy to work on this with someone.

Wow, fascinating! Thanks for sharing all that knowledge with us. I wasn't aware of screenshot based browser testing and thus neither of golden.

I wonder how or if we could reduce the complexity of this. Here's something I found with a quick Google search.

[gedw99]

@KaviiSuri @gedw99 does any of you happen to know an easy way for us to test this solution end-to-end? It's pretty safe to assume that SherClockHolmes/webpush-go does its job well and just works, but I don't like the idea of just releasing the solution without checking its behavior once.
@gedw99 great idea, we'll definitely include this!

I test E2E locally using Caddy, MkCert for the Server. Gives you a https locally with custom domain name. FiloSottile/mkcert
For the Wasm services worker i use go.app: maxence-charriere/go-app
I think it would be a good idea to make a little demo in this repo one day when there is time.
In CI, I can run caddy and mkcert, using a makefile as part of github workflows. It's the exact same makefile used on your laptop, just called as part of CI. I like this because i get full control and don't need any docker containers in CI so its fast.
For CI of the GUI, thats hard. I use screen shots and Goldens. Its brutal but works. I don't have a framework yet i can recommend because i use GIO which has build in screen shotting. It runs on web, desktop and mobile. SO its makes cross devcie testing easier. BUT gio is not used by others.
But the idea is to deploy the web app as a github page as part of CI, then you can tell it to screenshot and then you can test you got the right screen shot against your golden screenshot.
Because the makefiles are 100% OS independent you can test for all Desktops and their browsers.
Again i tres that CI browser testing is HARD and these are only suggestions.
I would be happy to work on this with someone.

Wow, fascinating! Thanks for sharing all that knowledge with us. I wasn't aware of screenshot based browser testing and thus neither of golden.

I wonder how or if we could reduce the complexity of this. Here's something I found with a quick Google search.

@nikoksr

Looks pretty old and hacky.

I have used this:

https://saucelabs.com/resources/blog/how-to-test-push-notifications-on-android-and-ios-in-real-device-cloud

[nikoksr]

@KaviiSuri @gedw99 does any of you happen to know an easy way for us to test this solution end-to-end? It's pretty safe to assume that SherClockHolmes/webpush-go does its job well and just works, but I don't like the idea of just releasing the solution without checking its behavior once.
@gedw99 great idea, we'll definitely include this!

I test E2E locally using Caddy, MkCert for the Server. Gives you a https locally with custom domain name. FiloSottile/mkcert
For the Wasm services worker i use go.app: maxence-charriere/go-app
I think it would be a good idea to make a little demo in this repo one day when there is time.
In CI, I can run caddy and mkcert, using a makefile as part of github workflows. It's the exact same makefile used on your laptop, just called as part of CI. I like this because i get full control and don't need any docker containers in CI so its fast.
For CI of the GUI, thats hard. I use screen shots and Goldens. Its brutal but works. I don't have a framework yet i can recommend because i use GIO which has build in screen shotting. It runs on web, desktop and mobile. SO its makes cross devcie testing easier. BUT gio is not used by others.
But the idea is to deploy the web app as a github page as part of CI, then you can tell it to screenshot and then you can test you got the right screen shot against your golden screenshot.
Because the makefiles are 100% OS independent you can test for all Desktops and their browsers.
Again i tres that CI browser testing is HARD and these are only suggestions.
I would be happy to work on this with someone.

Wow, fascinating! Thanks for sharing all that knowledge with us. I wasn't aware of screenshot based browser testing and thus neither of golden.
I wonder how or if we could reduce the complexity of this. Here's something I found with a quick Google search.

@nikoksr

Looks pretty old and hacky.

I have used this:

saucelabs.com/resources/blog/how-to-test-push-notifications-on-android-and-ios-in-real-device-cloud

Oh, definitely! My thought process was rather about taking this as a starting point and building a suitable solution on it, but Saucelabs already seems to be doing all that.

I would definitely welcome E2E tests for protocol centric services in the future and since we're slowly moving more and more services away from a third-party dependency based implementation towards http service based implementations E2E testing might become more viable even for platform centric services too.

[gedw99]

Lets start a New Issue or Discussion about this ?

[nikoksr]

Sure! Would you like to open it?

[nikoksr]

@KaviiSuri will merge as soon as you mark this as ready (marked as draft atm)!