mozilla / mozilla/bugbug

Keep Hackbot client models synchronized with API schemas

Open
#6,757 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

hackbot
Dominant language
Python
Stars
570
Forks
351
Avg merge
2d 13h
Merged PRs (30d)
65

Description

Follow-up to https://github.com/mozilla/bugbug/pull/6742#discussion_r3910174857

RunStatus and RunRef are duplicated in:

  • libs/hackbot-client/hackbot_client/models.py
  • services/hackbot-api/app/schemas.py

They should be synchronised automatically.

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

Compare the duplicated RunStatus and RunRef definitions in libs/hackbot-client/hackbot_client/models.py and services/hackbot-api/app/schemas.py. Start by reviewing the API schema and client model boundaries, then determine how synchronization can be automated. Done means both models are generated or otherwise kept synchronized without manual duplication.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.