Skip to content

Use GFM Markdown fixtures in Content Editor

Enrique Alcántara requested to merge use-gfm-fixtures-content-editor into master

What does this MR do?

Context: We generate frontend fixtures to test the compatibility of the Content Editor with GitLab Flavored Markdown. These fixtures are generated by sending small snippets of Markdown to the Markdown REST API. See the description of !55856 (merged) for more information.

This MR passes the gfm: true parameter to the Markdown API call to process the Markdown snippets using GitLab Markdown extensions. In cases like processing images or code blocks, the API output completely changes. As a result, this MR also introduces fixes to the image and code_block extensions to properly process the API output.

How to test?

  • Generate the Markdown API fixtures: bundle exec rspec spec/frontend/fixtures/api_markdown.rb
  • Run the jest tests: yarn jest --watch spec/frontend/content_editor/markdown_processing_spec.js

If you are interested in understand how the extensions are parsing the API output, check the API output in tmp/tests/frontend/fixtures-ee/api/markdown/

Screenshots (strongly suggested)

This change is behind a feature flag and it doesn’t provide user-facing changes.

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • 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
Edited by Ezekiel Kigbo

Merge request reports

Loading