Skip to content

Use `read_attribute` for extracting self attributes from retried builds

What does this MR do and why?

When a job is retried, the system extracts the attributes from a retried job and sets them to a newly created job. This process happens in RetryBuildService.

However, currently, we use public_send for extracting the attributes, meaning if a retried job is overridden by a delegator, some of the public_send might return an unexpected value. In the recent production incident case, public_send was actually fetching a value from ActionView::Helpers::UrlHelper#tag in Ci::BuildPresenter, instead of the ci_builds.tag, which is the persisted value in the database record.

We also discovered a data integrity issue on the when attribute, that we currently persist a different value between old and new jobs. See #340998 (closed) for more information.

This MR switches to read_attribute from public_send for the Ci::Build attributes to definitely fetch the value from the database records regardless of whatever delegations. Also, this effectively reduces the unnecessary queries to fetch the associated object, for example, public_send(:project) executes a query, however, read_attribute(:project_id) doesn't execute.

Keep in mind that not all attributes can use read_attribute because some data is persisted outside of ci_builds. This is out of scope in this MR.

This is a part of a corrective action for FCL issue.

This change is behind the read_self_attributes_from_retried_job feature flag.

Screenshots or screen recordings

These are strongly recommended to assist reviewers and reduce the time to merge your change.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

These checklists encourage us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Quality

  • Confirmed
  1. I have self-reviewed this MR per code review guidelines.
  2. For the code that that this change impacts, I believe that the automated tests (Testing Guide) validate functionality that is highly important to users (including consideration of all test levels). If the existing automated tests do not cover this functionality, I have added the necessary additional tests or I have added an issue to describe the automation testing gap and linked it to this MR.
  3. I have considered the technical aspects of the impact of this change on both gitlab.com hosted customers and self-hosted customers.
  4. I have considered the impact of this change on the front-end, back-end, and database portions of the system where appropriate and applied frontend, backend and database labels accordingly.
  5. I have tested this MR in all supported browsers, or determiend that this testing is not needed.
  6. I have confirmed that this change is backwards compatible across updates, or I have decided that this does not apply.
  7. I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?)
  8. If I am introducing a new expectation for existing data, I have confirmed that existing data meets this expectation or I have made this expectation optional rather than required.

Performance, reliability and availability

  • Confirmed
  1. I am confident that this MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines)
  2. I have added information for database reviewers in the MR description, or I have decided that it is unnecessary. (Does this MR have database-related changes?)
  3. I have considered the availability and reliability risks of this change. I have also considered the scalability risk based on future predicted growth
  4. I have considered the performance, reliability and availability impacts of this change on large customers who may have significantly more data than the average customer.

Documentation

  • Confirmed
  1. I have included changelog trailers, or I have decided that they are not needed. (Does this MR need a changelog?)
  2. I have added/updated documentation, or I have decided that documentation changes are not needed for this MR. (Is documentation required?)

Security

  • Confirmed
  1. I have confirmed that if this MR contains changes to processing or storing of credentials or tokens, authorization, and authentication methods, or other items described in the security review guidelines, I have added the label security and I have @-mentioned @gitlab-com/gl-security/appsec.

Deployment

  • Confirmed
  1. I have considered using a feature flag for this change because the change may be high risk. If I decided to use a feature flag, I plan to test the change in staging before I test it in production, and I have considered rolling it out to a subset of production customers before doing rolling it out to all customers. When to use a feature flag
  2. I have informed the Infrastructure department of a default setting or new setting change per definition of done, or decided that this is not needed.
Edited by Shinya Maeda

Merge request reports

Loading