Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

architecture sanity: rename benchmark_result.commit_repo_url to benchmark_result.repo_url #1486

Open
austin3dickey opened this issue Sep 18, 2023 · 0 comments
Assignees

Comments

@austin3dickey
Copy link
Member

In #1453 I introduced the benchmark_result.commit_repo_url column. @jgehrcke has pointed out that the name doesn't quite make sense (naming is hard!):

# Note(JP): maybe it is easier to think of this as just "repo_url" because
# while it is not required that each result is associated with a particular
# commit, but instead it is required to be associated with a (one!) code
# repository as identified by its user-given repository URL.

I had originally prefixed this column name with commit_ thinking it was a good namespace for other future columns that had to do with git information. In this project in the past we've sometimes used "github", "commit", and "git" interchangeably, as a tag that a certain object has something to do with git information, and this really doesn't make any sense. (I find this pretty funny.)

A better namespace in this case would be git_. But really, a namespace is probably not required. We have no current plans to put more git information onto the benchmark_result table, because the commit table remains useful. So I agree with @jgehrcke that we should rename this column to repo_url, in order to lower the barrier to entry for future developers, and remove confusion from the codebase.

This will require a DB migration, but renaming columns is extremely fast in modern Postgres versions.

@austin3dickey austin3dickey self-assigned this Sep 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant