Remove Redundant Description HTML field from Release API [RUN ALL RSPEC] [RUN AS-IF-FOSS]
NOTE: This is an urgent MR in the context.
What does this MR do?
As we discussed in the thread, Release List API is quite slow due to rendering HTML description for each release entry. 80-90% of the response time is spent on this process. Especially, the timing could be extremely longer when the description is very long, like length > 1 megabyte.
However, we found that this entry is unnecessary to be exposed by high chance. In the past, frontend used to use this Rest API for rendering the release index page, but they have already switched to GraphQL API a half year ago. So there are no usecases internally, and external users should access to Markdown API if they need the rendered data. Therefore, this MR removes the filed from the API payload.
Also, we've already been exposing description field. Exposing both description and description_html is redundant. The nearly duplicate texts doubles up the payload size and pressurizes the network bandwidth. For the datapoint, GitHub's Release API only expose the plain text description (as body), so this doesn't make our product worse than the competitors.
Since this is subject of breaking change, we gracefully roll out this change with feature flag. Generally, we can introduce such change at major update only, however, this should be exceptional case due to the urgency.
Related #299447 (closed)
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
📋 Does this MR need a changelog?-
I have included a changelog entry. -
I have not included a changelog entry because it's behind the feature flag.
-
-
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec -
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team