chore(deps): Replace showdown dependency with marked (#369)

Author: wise-king-sullyman

packages/dev/package.json

@@ -22,7 +22,7 @@
     "react-dom": "^18.2.0",
     "react-i18next": "^11.7.3",
     "react-router-dom": "^6.11.2",
-    "showdown": "2.1.0",
+    "marked": "^15.0.6",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {

packages/module/package.json

@@ -47,7 +47,7 @@
     "@patternfly/react-core": ">=5.0.0",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "showdown": ">=2.1.0"
+    "marked": "^15.0.6"
   },
   "dependencies": {
     "@patternfly/react-catalog-view-extension": "^5.0.0",

packages/module/src/ConsoleInternal/components/markdown-view.tsx

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { css } from '@patternfly/react-styles';
-import { Converter } from 'showdown';
+import { marked } from 'marked';
 import { useForceRender } from '@console/shared';
 import { QuickStartContext, QuickStartContextValues } from '../../utils/quick-start-context';
 import './_markdown-view.scss';
@@ -16,18 +16,7 @@ interface ShowdownExtension {
   replace?: (...args: any[]) => string;
 }
 
-export const markdownConvert = (markdown, extensions?: ShowdownExtension[]) => {
-  const converter = new Converter({
-    tables: true,
-    openLinksInNewWindow: true,
-    strikethrough: true,
-    emoji: false,
-  });
-
-  if (extensions) {
-    converter.addExtension(extensions);
-  }
-
+export const markdownConvert = async (markdown: string, extensions?: ShowdownExtension[]) => {
   DOMPurify.addHook('beforeSanitizeElements', function (node) {
     // nodeType 1 = element type
 
@@ -62,12 +51,26 @@ export const markdownConvert = (markdown, extensions?: ShowdownExtension[]) => {
     }
   });
 
-  return DOMPurify.sanitize(converter.makeHtml(markdown), {
-    USE_PROFILES: {
-      html: true,
-      svg: true,
-    },
-  });
+  // Replace code fences with non markdown formatting relates tokens so that marked doesn't try to parse them as code spans
+  const markdownWithSubstitutedCodeFences = markdown.replace(/```/g, '@@@');
+  const parsedMarkdown = await marked.parse(markdownWithSubstitutedCodeFences);
+  // Swap the temporary tokens back to code fences before we run the extensions
+  let md = parsedMarkdown.replace(/@@@/g, '```');
+
+  if (extensions) {
+    // Convert code spans back to md format before we run the custom extension regexes
+    md = md.replace(/<code>(.*)<\/code>/g, '`$1`');
+
+    extensions.forEach(({ regex, replace }) => {
+      if (regex) {
+        md = md.replace(regex, replace);
+      }
+    });
+
+    // Convert any remaining backticks back into code spans
+    md = md.replace(/`(.*)`/g, '<code>$1</code>');
+  }
+  return DOMPurify.sanitize(md);
 };
 
 interface SyncMarkdownProps {
@@ -96,10 +99,18 @@ export const SyncMarkdownView: React.FC<SyncMarkdownProps> = ({
   className,
 }) => {
   const { getResource } = React.useContext<QuickStartContextValues>(QuickStartContext);
-  const markup = React.useMemo(
-    () => markdownConvert(content || emptyMsg || getResource('Not available'), extensions),
-    [content, emptyMsg, extensions, getResource],
-  );
+  const [markup, setMarkup] = React.useState<string>('');
+
+  React.useEffect(() => {
+    async function getMd() {
+      const md = await markdownConvert(
+        content || emptyMsg || getResource('Not available'),
+        extensions,
+      );
+      setMarkup(md);
+    }
+    getMd();
+  }, [content, emptyMsg, getResource, extensions]);
   const innerProps: InnerSyncMarkdownProps = {
     renderExtension: extensions?.length > 0 ? renderExtension : undefined,
     exactHeight,

packages/module/src/QuickStartPanelContent.tsx

@@ -59,6 +59,7 @@ const QuickStartPanelContent: React.FC<QuickStartPanelContentProps> = ({
   const { getResource, activeQuickStartState, focusOnQuickStart } =
     React.useContext<QuickStartContextValues>(QuickStartContext);
   const [contentRef, setContentRef] = React.useState<HTMLDivElement>();
+  const [displayName, setDisplayName] = React.useState<string>('');
   const shadows = useScrollShadows(contentRef);
   const quickStart = quickStarts.find((qs) => qs.metadata.name === activeQuickStartID);
   const taskNumber = activeQuickStartState?.taskNumber;
@@ -95,6 +96,14 @@ const QuickStartPanelContent: React.FC<QuickStartPanelContentProps> = ({
     }
   }, [focusOnQuickStart, quickStart]);
 
+  React.useEffect(() => {
+    async function getDisplayName() {
+      const convertedMdDisplayName = await markdownConvert(quickStart?.spec.displayName);
+      setDisplayName(removeParagraphWrap(convertedMdDisplayName));
+    }
+    getDisplayName();
+  }, [quickStart]);
+
   const content = quickStart ? (
     <DrawerPanelContent
       isResizable={isResizable}
@@ -115,7 +124,7 @@ const QuickStartPanelContent: React.FC<QuickStartPanelContentProps> = ({
             >
               <span
                 dangerouslySetInnerHTML={{
-                  __html: removeParagraphWrap(markdownConvert(quickStart?.spec.displayName)),
+                  __html: displayName,
                 }}
               />{' '}
               <small className="pfext-quick-start-panel-content__duration">

packages/module/src/controller/QuickStartTaskHeader.tsx

@@ -67,13 +67,23 @@ const QuickStartTaskHeader: React.FC<QuickStartTaskHeaderProps> = ({
 }) => {
   const titleRef = React.useRef(null);
   const { focusOnQuickStart } = React.useContext(QuickStartContext);
+  const [parsedTitle, setParsedTitle] = React.useState<string>('');
 
   React.useEffect(() => {
     if (focusOnQuickStart && isActiveTask) {
       // Focus the WizardNavItem button element that contains the title
       titleRef.current.parentNode.focus();
     }
   }, [focusOnQuickStart, isActiveTask]);
+
+  React.useEffect(() => {
+    async function getParsedTitle() {
+      const convertedMdTitle = await markdownConvert(title);
+      setParsedTitle(removeParagraphWrap(convertedMdTitle));
+    }
+    getParsedTitle();
+  }, [title]);
+
   const classNames = css('pfext-quick-start-task-header__title', {
     'pfext-quick-start-task-header__title-success': taskStatus === QuickStartTaskStatus.SUCCESS,
     'pfext-quick-start-task-header__title-failed':
@@ -96,7 +106,7 @@ const QuickStartTaskHeader: React.FC<QuickStartTaskHeaderProps> = ({
     <div className="pfext-quick-start-task-header" ref={titleRef}>
       <TaskIcon taskIndex={taskIndex} taskStatus={taskStatus} />
       <Title headingLevel="h3" size={size} className={classNames}>
-        <span dangerouslySetInnerHTML={{ __html: removeParagraphWrap(markdownConvert(title)) }} />
+        <span dangerouslySetInnerHTML={{ __html: parsedTitle }} />
         {isActiveTask && subtitle && (
           <span
             className="pfext-quick-start-task-header__subtitle"

yarn.lock

@@ -4771,7 +4771,7 @@ commander@^8.3.0:
   resolved "https://registry.yarnpkg.com/commander/-/commander-8.3.0.tgz#4837ea1b2da67b9c616a67afbb0fafee567bca66"
   integrity sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==
 
-commander@^9.0.0, commander@^9.4.1:
+commander@^9.4.1:
   version "9.5.0"
   resolved "https://registry.yarnpkg.com/commander/-/commander-9.5.0.tgz#bc08d1eb5cedf7ccb797a96199d41c7bc3e60d30"
   integrity sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==
@@ -10823,6 +10823,11 @@ markdown-table@^2.0.0:
   dependencies:
     repeat-string "^1.0.0"
 
+marked@^15.0.6:
+  version "15.0.7"
+  resolved "https://registry.yarnpkg.com/marked/-/marked-15.0.7.tgz#f67d7e34d202ce087e6b879107b5efb04e743314"
+  integrity sha512-dgLIeKGLx5FwziAnsk4ONoGwHwGPJzselimvlVskE9XLN4Orv9u2VA3GWw/lYUqjfA0rUT/6fqKwfZJapP9BEg==
+
 marked@^4.0.16:
   version "4.3.0"
   resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3"
@@ -14226,13 +14231,6 @@ shortid@^2.2.8:
   dependencies:
     nanoid "^2.1.0"
 
-[email protected]:
-  version "2.1.0"
-  resolved "https://registry.yarnpkg.com/showdown/-/showdown-2.1.0.tgz#1251f5ed8f773f0c0c7bfc8e6fd23581f9e545c5"
-  integrity sha512-/6NVYu4U819R2pUIk79n67SYgJHWCce0a5xTP979WbNp0FL9MN1I1QK662IDU1b6JzKTvmhgI7T7JYIxBi3kMQ==
-  dependencies:
-    commander "^9.0.0"
-
 side-channel@^1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.0.4.tgz#efce5c8fdc104ee751b25c58d4290011fa5ea2cf"