RFC: GithubRepo is modeled incorrectly

Offen

#1,083 erstellt am 18.10.2017 4 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@begedin arbeitet bereits daran.

Seit 16.11.2017.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

needs clarification RFC

Problem

#1080 added a unique index to the github_repos schema.

#1081 also changes behavior when syncing github repos to match by github_id

The model for a GithubRepo, however, looks like this (important bits only):

schema "github_repos" do
  field :github_id, :integer

  belongs_to :github_app_installation, CodeCorps.GithubAppInstallation
end

The problem here is, in a real world, a github repository is not uniquely identified by an installation, but by it's github_id, as we are aiming to change.

In our specific case, a belongs_to :github_app_installation simply tells us which installation provided us with the information about the repository.

I guess our initial goal was to model it so each installation stores it's own copy, even though, on github, it's the same record. With the addition of other records, this no longer works optimally.

However, with the way it all works, since in our model, a repo can only belong to a single installation, we will encounter A LOT of difficulties as we start dealing with multiple installations.

Proposed general solution

remove the "belongs_to" relationship
add a "link" table and change it to a many-to-many relationship
- not sure about naming GithubAppInstallationGithubRepo, GithubInstallationRepo? GithubAppInstallationRepo, InstallationGithubRepo? GithubAppInstallationRepo sounds best to me.

Specific changes needed

In CodeCorps.GitHub.Event.Installation.Repos

the :delete_repos, :sync_repos steps are replaced with
- :ensure_repos - find or create al repositories
- :disassociate_repos - delete GithubAppInstallationRepo records no longer in the installation
- :associate_repos - create GithubAppInstallationRepo records in the installation

Vorherrschende Sprache: Elixir
Sterne: 234
Forks: 82
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus code-corps/code-corps-api

URGENT: Security vulnerability detected in infrastructure config Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 15/100

code-corps/code-corps-api#1385 · Erstellt am 06.1.2026
Cannot Create new GitHub App Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100

code-corps/code-corps-api#1384 · Erstellt am 12.12.2019
Track anon Users that register Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

code-corps/code-corps-api#1383 · 2 Kommentare · Erstellt am 12.3.2018
Use Dependabot to automatically keep dependencies up-to-date Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100

code-corps/code-corps-api#1382 · 2 Kommentare · Erstellt am 11.3.2018
Write tests for GitHub.Sync.pull_request_event/1 Offen

Difficulty: Medium Skill: Elixir Time: 4 hours

code-corps/code-corps-api#1372 · 3 Kommentare · 1 zugewiesene Person · Erstellt am 17.1.2018

Alle Issues in code-corps/code-corps-api