acjzz / gokaf Goto Github PK

First of all, thanks for writing that package.
I can already think about usage at work and would like to contribute to it.

I took time to read carefully the code, and i find it really clear, well written.
I still have few suggestions :

• What about using Fuzz testing (https://github.com/google/gofuzz) ? I really believe it can make a lot of sense, more precisely inside the Topic related tests. Trying to test the handling workflow with a crazy amount of possible values can be really valuable, and can help us cover a lot of usability scenarios.

• gokaf/topic.go

  Line 21 in 8a7e54a

  channelTopic = make(chan internalMessage, numConsumers[0])

Here, i feel the usage of variadic parameters coupled to the fact that the topic will only take the first argument if any exists can confuse the user at some point.
Of course, usage of variadic is really smart and cover the fact that golang does not offer optional argument capabilities, but my idea is to be more strict, and return an explicit error if more than one numConsumer is passed as argument.

• I would also try to use as much early returns as i can, and avoiding else's as much as possible to make the code easier to ready and reduce cyclomatic complexity.

Examples :

For that last example, i would for instance find that smoother on eyes :

func (ge *Engine) AddTopic(name string, handler func(string, interface{}), numConsumers ...int) {
	name = strings.ToLower(name)
        if _, ok := ge.topics[name]; ok {   
              ge.logger.Warn("topic already exists")
              return
        }

        if len(numConsumers) > 0 {
                ge.topics[name] = NewTopic(ge.ctx, name, handler, numConsumers[0])
        } else {
                ge.topics[name] = NewTopic(ge.ctx, name, handler)
        }
        ge.topics[name].run()
}

Le me know what do you think.
Of course all of that are just details, but i just wanted to give my thoughts on that.

Another time, thanks for your awesome work.
I look forward to contribute, please create Issue when you have any feature idea, so as we can contribute.

Cheers !

Hello,
I'm thinking about implementing a kind of topic broadcaster feature.

The idea is adding a new type of topic (so will need to add a related interface), that will act as a topic container and will contain multiple classic (existing) topics. It can actually be compared to the exchange features that most of the message brokers systems has.
The final result would be a user publishing go that kind of topic, will see his stream message be processed by multiple handlers.

The usage would be something like :

func main() {
	ge := gokaf.NewEngine("MyEngine", logrus.DebugLevel)

        aragorn := NewTopic(ge.ctx, "aragorn", func(topic string, obj interface{}) {
            fmt.Printf("Consumed '%v' from topic aragorn", obj, topic)
        })
        legolas := NewTopic(ge.ctx, "legolas", func(topic string, obj interface{}) {
            fmt.Printf("Consumed '%v' from topic legolas", obj)
        })
       
	ge.AddTopicContainer("soldiers", aragorn, legolas)

	e := ge.Publish("soldiers", fmt.Sprintf("Message%d", i))
	if e != nil {
		fmt.Printf("publishing to topic 'soldiers', err: %v", e)
	}

	ge.Stop()
}

Of course the naming is weird here, but that's just a simple boilerplate code to express my idea.

When starting with open source projects, it is helpful to add few details
namely:

• Code of Conduct
• Contributing guidelines
• Pull request templates
• Issues or Bug Report template
• Feature request template

I'll be happy to add these details as a PR or multiple PRs. References for the
same are listed below.

https://www.contributor-covenant.org/
https://help.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates