Sruthi Chandran fa176ca292 New upstream version 12.2.8

2019-10-12 21:52:04 +05:30

23 KiB

Raw Blame History

Code Review Guidelines

This guide contains advice and best practices for performing code review, and having your code reviewed.

All merge requests for GitLab CE and EE, whether written by a GitLab team member or a volunteer contributor, must go through a code review process to ensure the code is effective, understandable, maintainable, and secure.

Getting your merge request reviewed, approved, and merged

You are strongly encouraged to get your code reviewed by a reviewer as soon as there is any code to review, to get a second opinion on the chosen solution and implementation, and an extra pair of eyes looking for bugs, logic problems, or uncovered edge cases. The reviewer can be from a different team, but it is recommended to pick someone who knows the domain well. You can read more about the importance of involving reviewer(s) in the section on the responsibility of the author below.

If you need some guidance (e.g. it's your first merge request), feel free to ask one of the Merge request coaches.

If you need assistance with security scans or comments, feel free to include the Security Team (@gitlab-com/gl-security) in the review.

Depending on the areas your merge request touches, it must be approved by one or more maintainers:

For approvals, we use the approval functionality found in the merge request widget. Reviewers can add their approval by approving additionally.

Getting your merge request merged also requires a maintainer. If it requires more than one approval, the last maintainer to review and approve it will also merge it.

Reviewer roulette

The danger-review CI job will randomly pick a reviewer and a maintainer for each area of the codebase that your merge request seems to touch. It only makes recommendations - feel free to override it if you think someone else is a better fit!

It picks reviewers and maintainers from the list at the engineering projects page, with these behaviours:

It will not pick people whose GitLab status contains the string 'OOO'.
Trainee maintainers are three times as likely to be picked as other reviewers.
It always picks the same reviewers and maintainers for the same branch name (unless their OOO status changes, as in point 1). It removes leading ce- and ee-, and trailing -ce and -ee, so that it can be stable for backport branches.

Approval guidelines

As described in the section on the responsibility of the maintainer below, you are recommended to get your merge request approved and merged by maintainer(s) from teams other than your own.

If your merge request includes backend changes ¹, it must be approved by a backend maintainer.
If your merge request includes database migrations or changes to expensive queries ², it must be approved by a database maintainer. Read the database review guidelines for more details.
If your merge request includes frontend changes ¹, it must be approved by a frontend maintainer.
If your merge request includes UX changes ¹, it must be approved by a UX team member.
If your merge request includes adding a new JavaScript library ¹, it must be approved by a frontend lead.
If your merge request includes adding a new UI/UX paradigm ¹, it must be approved by a UX lead.
If your merge request includes a new dependency or a filesystem change, it must be approved by a Distribution team member. See how to work with the Distribution team for more details.

Security requirements

View the updated documentation regarding internal application security reviews for when and how to request a security review.

The responsibility of the merge request author

The responsibility to find the best solution and implement it lies with the merge request author.

Before assigning a merge request to a maintainer for approval and merge, they should be confident that it actually solves the problem it was meant to solve, that it does so in the most appropriate way, that it satisfies all requirements, and that there are no remaining bugs, logical problems, uncovered edge cases, or known vulnerabilities. The merge request should also have a completed task list in its description and a passing CI pipeline to avoid unnecessary back and forth.

To reach the required level of confidence in their solution, an author is expected to involve other people in the investigation and implementation processes as appropriate.

They are encouraged to reach out to domain experts to discuss different solutions or get an implementation reviewed, to product managers and UX designers to clear up confusion or verify that the end result matches what they had in mind, to database specialists to get input on the data model or specific queries, or to any other developer to get an in-depth review of the solution.

If an author is unsure if a merge request needs a domain expert's opinion, that's usually a pretty good sign that it does, since without it the required level of confidence in their solution will not have been reached.

Before the review, the author is requested to submit comments on the merge request diff alerting the reviewer to anything important as well as for anything that demands further explanation or attention. Examples of content that may warrant a comment could be:

The addition of a linting rule (Rubocop, JS etc)
The addition of a library (Ruby gem, JS lib etc)
Where not obvious, a link to the parent class or method
Any benchmarking performed to complement the change
Potentially insecure code

Do not add these comments directly to the source code, unless the reviewer requires you to do so.

This saves reviewers time and helps authors catch mistakes earlier.

The responsibility of the maintainer

Maintainers are responsible for the overall health, quality, and consistency of the GitLab codebase, across domains and product areas.

Consequently, their reviews will focus primarily on things like overall architecture, code organization, separation of concerns, tests, DRYness, consistency, and readability.

Since a maintainer's job only depends on their knowledge of the overall GitLab codebase, and not that of any specific domain, they can review, approve and merge merge requests from any team and in any product area.

In fact, authors are encouraged to get their merge requests merged by maintainers from teams other than their own, to ensure that all code across GitLab is consistent and can be easily understood by all contributors, from both inside and outside the company, without requiring team-specific expertise.

Maintainers will do their best to also review the specifics of the chosen solution before merging, but as they are not necessarily domain experts, they may be poorly placed to do so without an unreasonable investment of time. In those cases, they will defer to the judgment of the author and earlier reviewers and involved domain experts, in favor of focusing on their primary responsibilities.

If a developer who happens to also be a maintainer was involved in a merge request as a domain expert and/or reviewer, it is recommended that they are not also picked as the maintainer to ultimately approve and merge it.

Maintainers should check before merging if the merge request is approved by the required approvers.

Maintainers must check before merging if the merge request is introducing new vulnerabilities, by inspecting the list in the Merge Request Security Widget. When in doubt, a Security Engineer can be involved. The list of detected vulnerabilities must be either empty or containing:

dismissed vulnerabilities in case of false positives
vulnerabilities converted to issues

Maintainers should never dismiss vulnerabilities to "empty" the list, without duly verifying them.

Best practices

Everyone

Accept that many programming decisions are opinions. Discuss tradeoffs, which you prefer, and reach a resolution quickly.
Ask questions; don't make demands. ("What do you think about naming this :user_id?")
Ask for clarification. ("I didn't understand. Can you clarify?")
Avoid selective ownership of code. ("mine", "not mine", "yours")
Avoid using terms that could be seen as referring to personal traits. ("dumb", "stupid"). Assume everyone is attractive, intelligent, and well-meaning.
Be explicit. Remember people don't always understand your intentions online.
Be humble. ("I'm not sure - let's look it up.")
Don't use hyperbole. ("always", "never", "endlessly", "nothing")
Be careful about the use of sarcasm. Everything we do is public; what seems like good-natured ribbing to you and a long-time colleague might come off as mean and unwelcoming to a person new to the project.
Consider one-on-one chats or video calls if there are too many "I didn't understand" or "Alternative solution:" comments. Post a follow-up comment summarizing one-on-one discussion.
If you ask a question to a specific person, always start the comment by mentioning them; this will ensure they see it if their notification level is set to "mentioned" and other people will understand they don't have to respond.

Having your code reviewed

Please keep in mind that code review is a process that can take multiple iterations, and reviewers may spot things later that they may not have seen the first time.

The first reviewer of your code is you. Before you perform that first push of your shiny new branch, read through the entire diff. Does it make sense? Did you include something unrelated to the overall purpose of the changes? Did you forget to remove any debugging code?
Be grateful for the reviewer's suggestions. ("Good call. I'll make that change.")
Don't take it personally. The review is of the code, not of you.
Explain why the code exists. ("It's like that because of these reasons. Would it be more clear if I rename this class/file/method/variable?")
Extract unrelated changes and refactorings into future merge requests/issues.
Seek to understand the reviewer's perspective.
Try to respond to every comment.
The merge request author resolves only the threads they have fully addressed. If there's an open reply, an open thread, a suggestion, a question, or anything else, the thread should be left to be resolved by the reviewer.
Push commits based on earlier rounds of feedback as isolated commits to the branch. Do not squash until the branch is ready to merge. Reviewers should be able to read individual updates based on their earlier feedback.

Assigning a merge request for a review

If you want to have your merge request reviewed, you can assign it to any reviewer. The list of reviewers can be found on Engineering projects page.

You can also use ready for review label. That means that your merge request is ready to be reviewed and any reviewer can pick it. It is recommended to use that label only if there isn't time pressure and make sure the merge request is assigned to a reviewer.

When your merge request was reviewed and can be passed to a maintainer you can either pick a specific maintainer or use a label ready for merge.

It is responsibility of the author of a merge request that the merge request is reviewed. If it stays in ready for review state too long it is recommended to assign it to a specific reviewer.

List of merge requests ready for review

Developers who have capacity can regularly check the list of merge requests to review and assign any merge request they want to review.

Review turnaround time

Since unblocking others is always a top priority, reviewers are expected to review assigned merge requests in a timely manner, even when this may negatively impact their other tasks and priorities. Doing so allows everyone involved in the merge request to iterate faster as the context is fresh in memory, improves contributors' experiences significantly, and gives authors more time to address feedback and iterate on their work before the feature freeze.

A turnaround time of two working days is usually acceptable, since engineers will typically have other things to work on while they're waiting for review, but don't hesitate to ask the author if it's unclear what time frame would be acceptable, how urgent the review is, or how significant the blockage. Authors are also encouraged to provide this information up-front to reviewers, but are expected to be mindful of the guidelines on when to ask for review on MRs that are intended to go in before the feature freeze, and realistic in their expectations if these were not followed.

If you don't think you'll be able to review a merge request within a reasonable time frame, let the author know as soon as possible and try to help them find another reviewer or maintainer who will be able to, so that they can be unblocked and get on with their work quickly. Of course, if you are out of office and have communicated this through your GitLab.com Status, authors are expected to realize this and find a different reviewer themselves.

When a merge request author feels like they have been blocked for longer than is reasonable, they are free to remind the reviewer through Slack or assign another reviewer.

Reviewing code

Understand why the change is necessary (fixes a bug, improves the user experience, refactors the existing code). Then:

Try to be thorough in your reviews to reduce the number of iterations.
Communicate which ideas you feel strongly about and those you don't.
Identify ways to simplify the code while still solving the problem.
Offer alternative implementations, but assume the author already considered them. ("What do you think about using a custom validator here?")
Seek to understand the author's perspective.
If you don't understand a piece of code, say so. There's a good chance someone else would be confused by it as well.
After a round of line notes, it can be helpful to post a summary note such as "LGTM 👍", or "Just a couple things to address."
Assign the merge request to the author if changes are required following your review.
Set the milestone before merging a merge request.
Avoid accepting a merge request before the job succeeds. Of course, "Merge When Pipeline Succeeds" (MWPS) is fine.
If you set the MR to "Merge When Pipeline Succeeds", you should take over subsequent revisions for anything that would be spotted after that.
Consider using the Squash and merge feature when the merge request has a lot of commits. When merging code a maintainer should only use the squash feature if the author has already set this option or if the merge request clearly contains a messy commit history that is intended to be squashed.

The right balance

One of the most difficult things during code review is finding the right balance in how deep the reviewer can interfere with the code created by a reviewee.

Learning how to find the right balance takes time; that is why we have reviewers that become maintainers after some time spent on reviewing merge requests.
Finding bugs and improving code style is important, but thinking about good design is important as well. Building abstractions and good design is what makes it possible to hide complexity and makes future changes easier.
Asking the reviewee to change the design sometimes means the complete rewrite of the contributed code. It's usually a good idea to ask another maintainer or reviewer before doing it, but have the courage to do it when you believe it is important.
There is a difference in doing things right and doing things right now. Ideally, we should do the former, but in the real world we need the latter as well. A good example is a security fix which should be released as soon as possible. Asking the reviewee to do the major refactoring in the merge request that is an urgent fix should be avoided.
Doing things well today is usually better than doing something perfectly tomorrow. Shipping a kludge today is usually worse than doing something well tomorrow. When you are not able to find the right balance, ask other people about their opinion.

GitLab-specific concerns

GitLab is used in a lot of places. Many users use our Omnibus packages, but some use the Docker images, some are installed from source, and there are other installation methods available. GitLab.com itself is a large Enterprise Edition instance. This has some implications:

Query changes should be tested to ensure that they don't result in worse performance at the scale of GitLab.com:
1. Generating large quantities of data locally can help.
2. Asking for query plans from GitLab.com is the most reliable way to validate these.
Database migrations must be:
1. Reversible.
2. Performant at the scale of GitLab.com - ask a maintainer to test the migration on the staging environment if you aren't sure.
3. Categorised correctly:
  - Regular migrations run before the new code is running on the instance.
  - Post-deployment migrations run after the new code is deployed, when the instance is configured to do that.
  - Background migrations run in Sidekiq, and should only be done for migrations that would take an extreme amount of time at GitLab.com scale.
Sidekiq workers cannot change in a backwards-incompatible way:
1. Sidekiq queues are not drained before a deploy happens, so there will be workers in the queue from the previous version of GitLab.
2. If you need to change a method signature, try to do so across two releases, and accept both the old and new arguments in the first of those.
3. Similarly, if you need to remove a worker, stop it from being scheduled in one release, then remove it in the next. This will allow existing jobs to execute.
4. Don't forget, not every instance will upgrade to every intermediate version (some people may go from X.1.0 to X.10.0, or even try bigger upgrades!), so try to be liberal in accepting the old format if it is cheap to do so.
Cached values may persist across releases. If you are changing the type a cached value returns (say, from a string or nil to an array), change the cache key at the same time.
Settings should be added as a last resort. If you're adding a new setting in gitlab.yml:
1. Try to avoid that, and add to ApplicationSetting instead.
2. Ensure that it is also added to Omnibus.
Filesystem access can be slow, so try to avoid shared files when an alternative solution is available.

Examples

How code reviews are conducted can surprise new contributors. Here are some examples of code reviews that should help to orient you as to what to expect.

"Modify DiffNote to reuse it for Designs": It contained everything from nitpicks around newlines to reasoning about what versions for designs are, how we should compare them if there was no previous version of a certain file (parent vs. blank sha vs empty tree).

"Support multi-line suggestions": The MR itself consists of a collaboration between FE and BE, and documenting comments from the author for the reviewer. There's some nitpicks, some questions for information, and towards the end, a security vulnerability.

"Allow multiple repositories per project": ZJ referred to the other projects (workhorse) this might impact, suggested some improvements for consistency. And James' comments helped us with overall code quality (using delegation, &. those types of things), and making the code more robust.

"Support multiple assignees for merge requests": A good example of collaboration on an MR touching multiple parts of the codebase. Nick pointed out interesting edge cases, James Lopes also joined in raising concerns on import/export feature.

Credits

Largely based on the thoughtbot code review guide.

Return to Development documentation

Please note that specs other than JavaScript specs are considered backend code. ↩︎
We encourage you to seek guidance from a database maintainer if your merge request is potentially introducing expensive queries. It is most efficient to comment on the line of code in question with the SQL queries so they can give their advice. ↩︎

23 KiB Raw Blame History