ausocean / ausocean/cloud

oceantv: event interface should not use fmt.Stringer but rather Name() string

Open
#410 0 comments 0 reactions 0 assignees View on GitHub
enhancement P3
Dominant language
Go
Stars
1
Forks
3
Avg merge
2d 16h
Merged PRs (30d)
6

Description

We were deriving the event interface from fmt.Stringer so that events would have a String method and could provide their name, however, it's been realised that fmt.Stringer is probably not quite the right type of interface to be using, given that Stringer is more about returning the value of something as a string, not the name. This is more consistent with how we're (eventually) going to register events with a general purpose Registry, which will use a Name() interface to key registered "objects". If String() was used, then we would be keying based on the value of things, not their name.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the oceantv event interface and the event implementations that currently satisfy fmt.Stringer. Change the interface contract to use Name() string, update affected implementations and callers, and verify that event names remain suitable for registry keys.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.