Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-10-31 12:09:32 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2022-10-31 12:09:32 +0300
commit5025412fc4ab16cc7049a38d43fdc2e4095a1f87 (patch)
treeecec75618d069e02ba0ebcf36db6630150a9d073 /app/assets/javascripts/behaviors
parent853c0c530b624a2f94ce85acbbdffc70510bdba3 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'app/assets/javascripts/behaviors')
-rw-r--r--app/assets/javascripts/behaviors/markdown/render_gfm.js2
-rw-r--r--app/assets/javascripts/behaviors/markdown/render_sandboxed_mermaid.js129
2 files changed, 63 insertions, 68 deletions
diff --git a/app/assets/javascripts/behaviors/markdown/render_gfm.js b/app/assets/javascripts/behaviors/markdown/render_gfm.js
index a08cf48c327..ee5c0fe5ef3 100644
--- a/app/assets/javascripts/behaviors/markdown/render_gfm.js
+++ b/app/assets/javascripts/behaviors/markdown/render_gfm.js
@@ -15,7 +15,7 @@ $.fn.renderGFM = function renderGFM() {
syntaxHighlight(this.find('.js-syntax-highlight').get());
renderKroki(this.find('.js-render-kroki[hidden]').get());
renderMath(this.find('.js-render-math'));
- renderSandboxedMermaid(this.find('.js-render-mermaid').get());
+ renderSandboxedMermaid(this.find('.js-render-mermaid'));
renderJSONTable(
Array.from(this.find('[lang="json"][data-lang-params="table"]').get()).map((e) => e.parentNode),
);
diff --git a/app/assets/javascripts/behaviors/markdown/render_sandboxed_mermaid.js b/app/assets/javascripts/behaviors/markdown/render_sandboxed_mermaid.js
index 031b03e0d59..077e96b2fee 100644
--- a/app/assets/javascripts/behaviors/markdown/render_sandboxed_mermaid.js
+++ b/app/assets/javascripts/behaviors/markdown/render_sandboxed_mermaid.js
@@ -1,4 +1,5 @@
-import { countBy } from 'lodash';
+import $ from 'jquery';
+import { once, countBy } from 'lodash';
import { __ } from '~/locale';
import {
getBaseURL,
@@ -7,8 +8,7 @@ import {
joinPaths,
} from '~/lib/utils/url_utility';
import { darkModeEnabled } from '~/lib/utils/color_utils';
-import { setAttributes, isElementVisible } from '~/lib/utils/dom_utils';
-import { createAlert, VARIANT_WARNING } from '~/flash';
+import { setAttributes } from '~/lib/utils/dom_utils';
import { unrestrictedPages } from './constants';
// Renders diagrams and flowcharts from text using Mermaid in any element with the
@@ -27,30 +27,17 @@ import { unrestrictedPages } from './constants';
const SANDBOX_FRAME_PATH = '/-/sandbox/mermaid';
// This is an arbitrary number; Can be iterated upon when suitable.
-export const MAX_CHAR_LIMIT = 2000;
+const MAX_CHAR_LIMIT = 2000;
// Max # of mermaid blocks that can be rendered in a page.
-export const MAX_MERMAID_BLOCK_LIMIT = 50;
+const MAX_MERMAID_BLOCK_LIMIT = 50;
// Max # of `&` allowed in Chaining of links syntax
const MAX_CHAINING_OF_LINKS_LIMIT = 30;
-
export const BUFFER_IFRAME_HEIGHT = 10;
export const SANDBOX_ATTRIBUTES = 'allow-scripts allow-popups';
-
-const ALERT_CONTAINER_CLASS = 'mermaid-alert-container';
-export const LAZY_ALERT_SHOWN_CLASS = 'lazy-alert-shown';
-
// Keep a map of mermaid blocks we've already rendered.
const elsProcessingMap = new WeakMap();
let renderedMermaidBlocks = 0;
-/**
- * Determines whether a given Mermaid diagram is visible.
- *
- * @param {Element} el The Mermaid DOM node
- * @returns
- */
-const isVisibleMermaid = (el) => el.closest('details') === null && isElementVisible(el);
-
function shouldLazyLoadMermaidBlock(source) {
/**
* If source contains `&`, which means that it might
@@ -117,8 +104,8 @@ function renderMermaidEl(el, source) {
);
}
-function renderMermaids(els) {
- if (!els.length) return;
+function renderMermaids($els) {
+ if (!$els.length) return;
const pageName = document.querySelector('body').dataset.page;
@@ -127,7 +114,7 @@ function renderMermaids(els) {
let renderedChars = 0;
- els.forEach((el) => {
+ $els.each((i, el) => {
// Skipping all the elements which we've already queued in requestIdleCallback
if (elsProcessingMap.has(el)) {
return;
@@ -146,29 +133,33 @@ function renderMermaids(els) {
renderedMermaidBlocks >= MAX_MERMAID_BLOCK_LIMIT ||
shouldLazyLoadMermaidBlock(source))
) {
- const parent = el.parentNode;
-
- if (!parent.classList.contains(LAZY_ALERT_SHOWN_CLASS)) {
- const alertContainer = document.createElement('div');
- alertContainer.classList.add(ALERT_CONTAINER_CLASS);
- alertContainer.classList.add('gl-mb-5');
- parent.after(alertContainer);
- createAlert({
- message: __(
- 'Warning: Displaying this diagram might cause performance issues on this page.',
- ),
- variant: VARIANT_WARNING,
- parent: parent.parentNode,
- containerSelector: `.${ALERT_CONTAINER_CLASS}`,
- primaryButton: {
- text: __('Display'),
- clickHandler: () => {
- alertContainer.remove();
- renderMermaidEl(el, source);
- },
- },
- });
- parent.classList.add(LAZY_ALERT_SHOWN_CLASS);
+ const html = `
+ <div class="alert gl-alert gl-alert-warning alert-dismissible lazy-render-mermaid-container js-lazy-render-mermaid-container fade show" role="alert">
+ <div>
+ <div>
+ <div class="js-warning-text"></div>
+ <div class="gl-alert-actions">
+ <button type="button" class="js-lazy-render-mermaid btn gl-alert-action btn-confirm btn-md gl-button">Display</button>
+ </div>
+ </div>
+ <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+ <span aria-hidden="true">&times;</span>
+ </button>
+ </div>
+ </div>
+ `;
+
+ const $parent = $(el).parent();
+
+ if (!$parent.hasClass('lazy-alert-shown')) {
+ $parent.after(html);
+ $parent
+ .siblings()
+ .find('.js-warning-text')
+ .text(
+ __('Warning: Displaying this diagram might cause performance issues on this page.'),
+ );
+ $parent.addClass('lazy-alert-shown');
}
return;
@@ -185,33 +176,37 @@ function renderMermaids(els) {
});
}
-export default function renderMermaid(els) {
- if (!els.length) return;
+const hookLazyRenderMermaidEvent = once(() => {
+ $(document.body).on('click', '.js-lazy-render-mermaid', function eventHandler() {
+ const parent = $(this).closest('.js-lazy-render-mermaid-container');
+ const pre = parent.prev();
- const visibleMermaids = [];
- const hiddenMermaids = [];
+ const el = pre.find('.js-render-mermaid');
- for (const el of els) {
- if (isVisibleMermaid(el)) {
- visibleMermaids.push(el);
- } else {
- hiddenMermaids.push(el);
- }
- }
+ parent.remove();
+
+ // sandbox update
+ const element = el.get(0);
+ const { source } = fixElementSource(element);
+
+ renderMermaidEl(element, source);
+ });
+});
+
+export default function renderMermaid($els) {
+ if (!$els.length) return;
+
+ const visibleMermaids = $els.filter(function filter() {
+ return $(this).closest('details').length === 0 && $(this).is(':visible');
+ });
renderMermaids(visibleMermaids);
- hiddenMermaids.forEach((el) => {
- el.closest('details').addEventListener(
- 'toggle',
- ({ target: details }) => {
- if (details.open) {
- renderMermaids([...details.querySelectorAll('.js-render-mermaid')]);
- }
- },
- {
- once: true,
- },
- );
+ $els.closest('details').one('toggle', function toggle() {
+ if (this.open) {
+ renderMermaids($(this).find('.js-render-mermaid'));
+ }
});
+
+ hookLazyRenderMermaidEvent();
}