try to restructure fcm client #107

Roy-Mao · 2022-05-10T09:01:58Z

split Fcm class into separate client classes based on the protocols used.

sabman · 2022-05-10T09:12:29Z

@Roy-Mao as much as I appreciate you taking interest in the gem I would like us to make sure that the gem stays simple and easy to maintain. So the level abstraction should not feel overly engineered. Just keep that in mind.

Roy-Mao · 2022-05-11T08:20:18Z

@sabman

Thanks!

I think it would be better if we split FCM client class into two separate classes, supporting api-key and oauth2.0 protocal respectively.

fcm_http_v1_client = Fcm::HttpV1Client.new(json_key_path_credential)
fcm_http_v1_client.send_notification("payload")


fcm_legacy_client = Fcm::Client.new(api_key_credential)
fcm_legacy_client.send_notification("payload")

Can I have write access to this repository so that I can create a new branch for this improvement?

sabman · 2022-05-13T07:41:46Z

Can I have write access to this repository so that I can create a new branch for this improvement?

@Roy-Mao let's do a joint review first. Just let me know when this branch is ready to be reviewed and we can maybe even jump on a call and review this refactor together 😄 🚀

Roy-Mao · 2022-05-16T02:44:36Z

Can I have write access to this repository so that I can create a new branch for this improvement?

@Roy-Mao let's do a joint review first. Just let me know when this branch is ready to be reviewed and we can maybe even jump on a call and review this refactor together 😄 🚀

sure! I am working on it. Will let you know once it is ready for review

hound

Some files could not be reviewed due to errors:

undefined method `map!' for "spec/*.rb":String

undefined method `map!' for "spec/*.rb":String
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:296:in `block in make_excludes_absolute'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:268:in `each_key'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:292:in `make_excludes_absolute'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:239:in `check'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:231:in `create'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config_loader.rb:54:in `load_file'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config_loader.rb:83:in `configuration_from_file'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config_store.rb:44:in `for'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/cli.rb:181:in `apply_default_formatter'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/cli.rb:40:in `run'
/home/linters/.bundle/gems/rubocop-0.54.0/bin/rubocop:13:in `block in '
/usr/local/lib/ruby/2.6.0/benchmark.rb:308:in `realtime'
/home/linters/.bundle/gems/rubocop-0.54.0/bin/rubocop:12:in `'
/home/linters/.bundle/bin/rubocop:23:in `load'
/home/linters/.bundle/bin/rubocop:23:in `'
/usr/local/lib/ruby/2.6.0/bundler/cli/exec.rb:74:in `load'
/usr/local/lib/ruby/2.6.0/bundler/cli/exec.rb:74:in `kernel_load'
/usr/local/lib/ruby/2.6.0/bundler/cli/exec.rb:28:in `run'
/usr/local/lib/ruby/2.6.0/bundler/cli.rb:463:in `exec'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor/command.rb:27:in `run'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor/invocation.rb:126:in `invoke_command'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor.rb:387:in `dispatch'
/usr/local/lib/ruby/2.6.0/bundler/cli.rb:27:in `dispatch'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor/base.rb:466:in `start'
/usr/local/lib/ruby/2.6.0/bundler/cli.rb:18:in `start'
/usr/local/lib/ruby/gems/2.6.0/gems/bundler-1.17.2/exe/bundle:30:in `block in '
/usr/local/lib/ruby/2.6.0/bundler/friendly_errors.rb:124:in `with_friendly_errors'
/usr/local/lib/ruby/gems/2.6.0/gems/bundler-1.17.2/exe/bundle:22:in `'
/usr/local/bin/bundle:23:in `load'
/usr/local/bin/bundle:23:in `'

hound

Some files could not be reviewed due to errors:

undefined method `map!' for "spec/*.rb":String

undefined method `map!' for "spec/*.rb":String
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:296:in `block in make_excludes_absolute'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:268:in `each_key'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:292:in `make_excludes_absolute'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:239:in `check'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config.rb:231:in `create'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config_loader.rb:54:in `load_file'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config_loader.rb:83:in `configuration_from_file'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/config_store.rb:44:in `for'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/cli.rb:181:in `apply_default_formatter'
/home/linters/.bundle/gems/rubocop-0.54.0/lib/rubocop/cli.rb:40:in `run'
/home/linters/.bundle/gems/rubocop-0.54.0/bin/rubocop:13:in `block in '
/usr/local/lib/ruby/2.6.0/benchmark.rb:308:in `realtime'
/home/linters/.bundle/gems/rubocop-0.54.0/bin/rubocop:12:in `'
/home/linters/.bundle/bin/rubocop:23:in `load'
/home/linters/.bundle/bin/rubocop:23:in `'
/usr/local/lib/ruby/2.6.0/bundler/cli/exec.rb:74:in `load'
/usr/local/lib/ruby/2.6.0/bundler/cli/exec.rb:74:in `kernel_load'
/usr/local/lib/ruby/2.6.0/bundler/cli/exec.rb:28:in `run'
/usr/local/lib/ruby/2.6.0/bundler/cli.rb:463:in `exec'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor/command.rb:27:in `run'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor/invocation.rb:126:in `invoke_command'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor.rb:387:in `dispatch'
/usr/local/lib/ruby/2.6.0/bundler/cli.rb:27:in `dispatch'
/usr/local/lib/ruby/2.6.0/bundler/vendor/thor/lib/thor/base.rb:466:in `start'
/usr/local/lib/ruby/2.6.0/bundler/cli.rb:18:in `start'
/usr/local/lib/ruby/gems/2.6.0/gems/bundler-1.17.2/exe/bundle:30:in `block in '
/usr/local/lib/ruby/2.6.0/bundler/friendly_errors.rb:124:in `with_friendly_errors'
/usr/local/lib/ruby/gems/2.6.0/gems/bundler-1.17.2/exe/bundle:22:in `'
/usr/local/bin/bundle:23:in `load'
/usr/local/bin/bundle:23:in `'

…gistration_id

Roy-Mao · 2022-05-20T03:11:26Z

This PR aims to share with you a general idea of where to improve in the gem and how can we improve it.

Where to improve

class design and directory structure not clear
- everything in one file(class) lib/fcm.rb, including:
  - faraday http agent config and setup
  - api connections based on http_v1 protocol
  - api connections based on http_legacy protocol
  - google oauth authentication
  - response construction
coding style
- existed code base violates the coding style set by hound
- documentation style not specified
lack of error handling and retry implementation for lost connection
lack of deprecation warnings
- Firebase reference
- Firebase suggests that Apps using the FCM legacy HTTP API should consider migrating to the HTTP v1 API
test
- #manage_topic_relationship is not tested, and the covert test coverage is 89.4% reported by simplecov
- manually stub http request a lot, maybe vcr gem is a better option

PR content

a more clear file structure and class design
- lib/fcm/client.rb => Fcm::Client.new(api_key).any_legacy_api
- lib/fcm/v1_client.rb => Fcm::ClientV1.new(json_key_path).any_v1_api
- lib/fcm/client/*.rb => categorized by the type of legacy protocol api
- lib/fcm/client_v1/*.rb => categorized by the type of v1 protocol api
- lib/connection.rb => where to setup faraday agent for http connection
  - use typhoeus as adapter
  - retry on http connection error, such as timeout
- lib/response.rb => where to build customized gem response based on faraday response
- lib/error.rb => where to build customized gem error
fix rubocop(hound) violations of existing code
- add rubocop and rubocop-rspec gem
- overwrite som of the rules in .rubocop.yml
integrate simplecov for test coverage and yard for documentation in dev mode

Future improvements

improve the test coverage to 90+ would be a bonus
using vcr for external http connection to firebase
integrate simplecov to CircileCi work flow
more robust retry mechanism with exponential backoff
- should retry when receiving server_unavailable error from Firebase based on the Retry-After header
- Firebase retry recommendation

I have no intention of merging it to the master branch right now, which is very risky.
Instead I wanna have a discussion with you based on the facts I listed above over the phone first.
Then we can take a gradual approach to improve the gem by:

make a decision about coding style
know how we are gonna refactor the gem and complete test cases
a. write tests for every public methods
b. integrate simplecov into CircleCI workflow
migrate old deprecated method to new method gradually

@sabman
Let me how you think and maybe we can have casual call over the phone 😄 🚀

sabman · 2022-05-20T18:57:26Z

@Roy-Mao yes that would be awesome let's do a call. Can you send me meeting request for later next week via https://calendly.com/sabman and we can do a paired code review

Roy-Mao · 2022-05-26T09:41:32Z

lib/fcm/connection.rb

+module Fcm
+  # underhood http client using faraday with typhoeus adapter
+  module Connection
+    DEFAULT_TIMEOUT = 30


todo:
its better to overwrite the value.

chrisedington · 2022-10-22T09:04:46Z

Just spent some time being confused why the V1 didnt work on topic subscriptions -- I think this merge would help alot of people.

sabman · 2022-10-22T11:12:35Z

@chrisedington I was waiting for @Roy-Mao to add tests. But seems he's busy now. I'll take a look next week.

Roy-Mao · 2022-10-24T04:41:49Z

@chrisedington
@sabman

Sorry for the late reply, I am very busy recently. It would be very helpful if someone can help me add some tests for all the public methods. I will look back into this PR weekend!!

Roy-Mao force-pushed the restructure_client branch 3 times, most recently from a1961ea to 9953ec9 Compare May 13, 2022 05:06

Roy-Mao force-pushed the restructure_client branch 2 times, most recently from 0885c06 to 3d7cd6e Compare May 16, 2022 02:37

hound bot reviewed May 17, 2022

View reviewed changes

hound bot reviewed May 18, 2022

View reviewed changes

Roy-Mao force-pushed the restructure_client branch from 06e2849 to f8cfbca Compare May 19, 2022 03:15

Roy-Mao added 17 commits May 19, 2022 12:21

add required gems

31fcfd1

add customized rubocop rules

a8913fc

mount hound config to customized rubocop rules

e2086ab

adjustment to follow rubocop rule rubocop --save-auto-correct

4750806

use simplecov to measure test coverage

430c791

better writing style of RSpec following rspec-rubocop rules

708d500

create fcm legacy http protocol client

95dca01

create fcm http v1 protocol client

46629ec

build faraday-based connection class for making http request

fce586a

create a hash format fcm response based on faraday response

813faae

create a fcm error class

7f3f032

interface for sending notification based on http legacy protocol

d4fbec6

apis related to notification settings such as notification_key and re…

27fbde2

…gistration_id

apis related to topic management such as topic (un)subscription

0f10803

api for sending notifications based on http v1 protocol

046c515

deprecating old fcm methods and adding deprecation notes

91a2dea

module to define the version of fcm

e336da7

Roy-Mao force-pushed the restructure_client branch from f8cfbca to e336da7 Compare May 19, 2022 03:41

Roy-Mao marked this pull request as ready for review May 19, 2022 03:46

Roy-Mao marked this pull request as draft May 19, 2022 03:47

Roy-Mao changed the title ~~try to re-structure fcm client~~ try to restructure fcm client May 19, 2022

Roy-Mao commented May 26, 2022

View reviewed changes

sabman mentioned this pull request Nov 24, 2022

Where to find Firebase API_Token ? #109

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

try to restructure fcm client #107

try to restructure fcm client #107

Roy-Mao commented May 10, 2022 •

edited

Loading

sabman commented May 10, 2022

Roy-Mao commented May 11, 2022

sabman commented May 13, 2022 •

edited

Loading

Roy-Mao commented May 16, 2022

hound bot left a comment

hound bot left a comment

Roy-Mao commented May 20, 2022

sabman commented May 20, 2022

Roy-Mao May 26, 2022

chrisedington commented Oct 22, 2022

sabman commented Oct 22, 2022

Roy-Mao commented Oct 24, 2022

try to restructure fcm client #107

Are you sure you want to change the base?

try to restructure fcm client #107

Conversation

Roy-Mao commented May 10, 2022 • edited Loading

sabman commented May 10, 2022

Roy-Mao commented May 11, 2022

sabman commented May 13, 2022 • edited Loading

Roy-Mao commented May 16, 2022

hound bot left a comment

Choose a reason for hiding this comment

hound bot left a comment

Choose a reason for hiding this comment

Roy-Mao commented May 20, 2022

Where to improve

PR content

Future improvements

sabman commented May 20, 2022

Roy-Mao May 26, 2022

Choose a reason for hiding this comment

chrisedington commented Oct 22, 2022

sabman commented Oct 22, 2022

Roy-Mao commented Oct 24, 2022

Roy-Mao commented May 10, 2022 •

edited

Loading

sabman commented May 13, 2022 •

edited

Loading