linuxboot / linuxboot/contest

Switch to using a single event type

Open
#23 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
20
Forks
17
PR merge metrics
No merged PRs in 30d

Description

**Issue by [marcoguerri](https://github.com/marcoguerri)**
_Wednesday Jun 17, 2020 at 09:09 GMT_
_Originally opened as https://github.com/facebookincubator/contest/issues/123_

----

At the moment we have two type of events, `testevents` and `frameworkevents`. The former are meant to be used when emitted by a `Step`, the latter from anywhere in the framework outside of a `Step`. The intention was to enforce non-null on most of the fields of the `Step`.

Eventually we settled on the fact that this is too restrictive. `FrameworkEvents` are barely used, and lots of places of the framework need to emit events that include a subset of the information of `testevents`.

So, we agree on deprecating `frameworkevents`, and using one single concept of `event`, where fields might be null. In addition, this event should be associated to a "source" in the header (most likely split into `SourceType` and `SourceName`), which will indicate who emitted the event.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the testevents and frameworkevents definitions and the Step and framework code that emits them. Trace which fields each event currently requires, then define the scope for one nullable event type with source information. Done means frameworkevents is deprecated and event emission consistently uses the unified concept.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
testing
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.