# All files / src/html NodeProcessor.ts

74.66% Statements 165/221
67.07% Branches 55/82
84.21% Functions 16/19
74.64% Lines 159/213

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    4278x
    8x
    8x
    8x
    8x
    8x

    8x
    8x
    8x

    8x
    8x
    8x

    8x
    8x
    8x
    8x
    8x

    8x

    8x
    8x
    8x
    8x

    8x

    8x

    8x

    8x

    8x

    8x

    8x
    80x

    80x
    80x
    80x

    80x

    80x

    80x

    80x
    80x
    80x
    80x
    80x
    80x

    80x
    80x

    534x
    534x
    534x
    2x

    532x
    532x
    1248x
    1248x

    244x
    244x
    1004x
    496x

    3034x

    4x
    4x
    4x

    2x
    2x

    2x

    2x

    4x

    4x

    4x

    4x
    4x

    664x
    664x
    580x

    580x
    580x

    580x

    580x

    4x
    4x

    226x
    226x
    222x
    2x

    8x
    8x

    4x
    4x

    4x
    4x

    4x
    4x

    4x
    4x

    2x
    2x

    4x
    4x

    4x
    4x

    4x
    4x

    4x
    4x

    6x
    6x

    2x

    2x
    2x

    300x

    342x

    544x
    540x

    540x
    540x

    2x
    2x

    538x

    540x
    540x

    1292x
    754x

    538x
    538x
    538x
    226x
    226x
    226x

    226x

    538x

    538x

    538x
    538x

    538x
    538x
    1254x

    538x

    538x

    538x
    538x
    236x

    538x

    538x

    38x

    38x
    38x
    38x

    38x

    38x
    38x

    38x

    38x

    38x

    38x
    38x

    38x

    38x
    38x
    38x
    38x

    38x

     import path from 'path';
    import cheerio from 'cheerio';
    import htmlparser, { DomElement } from 'htmlparser2';
    import Promise from 'bluebird';
    import isArray from 'lodash/isArray';
    import has from 'lodash/has';

    import { ATTRIB_CWF } from '../constants';
    import { Context } from './Context';
    import { createErrorNode } from './elements';
    import { PageSources } from '../Page/PageSources';
    import { isMarkdownFileExt } from '../utils/fsUtil';
    import * as logger from '../utils/logger';
    import * as linkProcessor from './linkProcessor';
    import type { VariableProcessor } from '../variables/VariableProcessor';
    import { warnConflictingAtributesMap } from './warnings';
    import { shiftSlotNodeDeeper, transformOldSlotSyntax } from './vueSlotSyntaxProcessor';
    import { MdAttributeRenderer } from './MdAttributeRenderer';
    import { MarkdownProcessor } from './MarkdownProcessor';
    import { processScriptAndStyleTag } from './scriptAndStyleTagProcessor';
    import type { SiteLinkManager } from './SiteLinkManager';
    import type { PluginManager } from '../plugins/PluginManager';
    import { processInclude, processPanelSrc, processPopoverSrc } from './includePanelProcessor';

    import { PageNavProcessor, renderSiteNav, addSitePageNavPortal } from './siteAndPageNavProcessor';
    import { highlightCodeBlock, setCodeLineNumbers } from './codeblockProcessor';
    import { setHeadingId, assignPanelId } from './headerProcessor';
    import { FootnoteProcessor } from './FootnoteProcessor';
    import { MbNode, NodeOrText, TextElement } from '../utils/node';
    import { processUlNode } from './CustomListIconProcessor';

    const fm = require('fastmatter');

    const _ = {
      isArray,
      has,
    };

    // Load our htmlparser2 patch for supporting "special" tags
    require('../patches/htmlparser2');

    const FRONTMATTER_FENCE = '---';

    cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

    export type NodeProcessorConfig = {
      baseUrl: string,
      baseUrlMap: Set<string>,
      rootPath: string,
      outputPath: string,
      ignore: string[],
      addressablePagesSource: string[],
      intrasiteLinkValidation: { enabled: boolean },
      codeLineNumbers: boolean,
      plantumlCheck: boolean,
      headerIdMap: {
        [id: string]: number,
      },
    };

    export class NodeProcessor {
      frontmatter: Record<string, string> = {};

      headTop: string[] = [];
      headBottom: string[] = [];
      scriptBottom: string[] = [];

      markdownProcessor: MarkdownProcessor;
      footnoteProcessor = new FootnoteProcessor();
      mdAttributeRenderer: MdAttributeRenderer;
      pageNavProcessor = new PageNavProcessor();

      processedModals: Record<string, boolean> = {};

      constructor(
        private config: NodeProcessorConfig,
        private pageSources: PageSources,
        private variableProcessor: VariableProcessor,
        private pluginManager: PluginManager,
        private siteLinkManager: SiteLinkManager,
        private userScriptsAndStyles: string[] | undefined,
        docId = '',
      ) {
        this.markdownProcessor = new MarkdownProcessor(docId);
        this.mdAttributeRenderer = new MdAttributeRenderer(this.markdownProcessor);
      }

      /*
       * Private utility functions
       */

      static _trimNodes(nodeOrText: NodeOrText) {
        Iif (NodeProcessor._isText(nodeOrText)) return;
        const node = nodeOrText as MbNode;
        if (node.name === 'pre' || node.name === 'code') {
          return;
        }
        if (node.children) {
          for (let n = 0; n < node.children.length; n += 1) {
            const child = node.children[n];
            if (child.type === 'comment'
              || (child.type === 'text' && n === node.children.length - 1 && !/\S/.test(child.data))) {
              node.children.splice(n, 1);
              n -= 1;
            } else if (child.type === 'tag') {
              NodeProcessor._trimNodes(child);
            }
          }
        }
      }

      static _isText(node: NodeOrText) {
        return node.type === 'text' || node.type === 'comment';
      }

      /*
       * Frontmatter collection
       */
      private _processFrontmatter(node: MbNode, context: Context) {
        let currentFrontmatter = {};
        const frontmatter = cheerio(node);
        if (!context.processingOptions.omitFrontmatter && frontmatter.text().trim()) {
          // Retrieves the frontmatter from either the first frontmatter element
          // or from a frontmatter element that includes from another file
          // The latter case will result in the data being wrapped in a div
          const frontmatterIncludeDiv = frontmatter.find('div');
          const frontmatterData = frontmatterIncludeDiv.length
            ? ((frontmatterIncludeDiv[0] as MbNode).children as MbNode[])[0].data
            : ((frontmatter[0] as MbNode).children as MbNode[])[0].data;
          const frontmatterWrapped = `${FRONTMATTER_FENCE}\n${frontmatterData}\n${FRONTMATTER_FENCE}`;

          currentFrontmatter = fm(frontmatterWrapped).attributes;
        }

        this.frontmatter = {
          ...this.frontmatter,
          ...currentFrontmatter,
        };
        cheerio(node).remove();
      }

      /*
       * Layout element collection
       */

      private static collectLayoutEl(node: MbNode): string | null {
        const $ = cheerio(node);
        const html = $.html();
        $.remove();
        return html;
      }

      /**
       * Removes the node if modal id already exists, processes node otherwise
       */
      private processModal(node: MbNode) {
        Iif (this.processedModals[node.attribs.id]) {
          cheerio(node).remove();
        } else {
          this.processedModals[node.attribs.id] = true;
          this.mdAttributeRenderer.processModalAttributes(node);
        }
      }

      /*
       * API
       */
      processNode(nodeOrText: NodeOrText, context: Context): Context {
        try {
          if (NodeProcessor._isText(nodeOrText)) return context;
          const node = nodeOrText as MbNode;

          transformOldSlotSyntax(node);
          shiftSlotNodeDeeper(node);

          // log warnings for conflicting attributes
          if (_.has(warnConflictingAtributesMap, node.name)) { warnConflictingAtributesMap[node.name](node); }

          switch (node.name) {
          case 'frontmatter':
            this._processFrontmatter(node, context);
            break;
          case 'body':
            // eslint-disable-next-line no-console
            console.warn(`<body> tag found in ${node.attribs[ATTRIB_CWF]}. This may cause formatting errors.`);
            break;
          case 'include':
            this.markdownProcessor.docId += 1; // used in markdown-it-footnotes
            return processInclude(node, context, this.pageSources, this.variableProcessor,
                                  (text: string) => this.markdownProcessor.renderMd(text),
                                  (text: string) => this.markdownProcessor.renderMdInline(text),
                                  this.config);
          case 'panel':
            this.mdAttributeRenderer.processPanelAttributes(node);
            return processPanelSrc(node, context, this.pageSources, this.config);
          case 'question':
            this.mdAttributeRenderer.processQuestion(node);
            break;
          case 'ul':
            processUlNode(node);
            break;
          case 'q-option':
            this.mdAttributeRenderer.processQOption(node);
            break;
          case 'quiz':
            this.mdAttributeRenderer.processQuiz(node);
            break;
          case 'popover':
            this.mdAttributeRenderer.processPopoverAttributes(node);
            return processPopoverSrc(node, context, this.pageSources, this.variableProcessor,
                                     (text: string) => this.markdownProcessor.renderMd(text), this.config);
          case 'tooltip':
            this.mdAttributeRenderer.processTooltip(node);
            break;
          case 'modal':
            this.processModal(node);
            break;
          case 'tab':
          case 'tab-group':
            this.mdAttributeRenderer.processTabAttributes(node);
            break;
          case 'box':
            this.mdAttributeRenderer.processBoxAttributes(node);
            break;
          case 'dropdown':
            this.mdAttributeRenderer.processDropdownAttributes(node);
            break;
          case 'thumbnail':
            this.mdAttributeRenderer.processThumbnailAttributes(node);
            break;
          case 'page-nav':
            this.pageNavProcessor.renderPageNav(node);
            break;
          case 'page-nav-print':
            PageNavProcessor.transformPrintContainer(node);
            break;
          case 'site-nav':
            renderSiteNav(node);
            break;
          case 'mb-temp-footnotes':
            this.footnoteProcessor.processMbTempFootnotes(node);
            break;
          case 'script':
          case 'style':
            processScriptAndStyleTag(node, this.userScriptsAndStyles);
            break;
          case 'scroll-top-button':
            this.mdAttributeRenderer.processScrollTopButtonAttributes(node);
            break;
          case 'code':
            setCodeLineNumbers(node, this.config.codeLineNumbers);
            // fall through
          case 'annotation': // Annotations are added automatically by KaTeX when rendering math formulae.
          case 'eq': // markdown-it-texmath html tag
          case 'eqn': // markdown-it-texmath html tag
          case 'thumb': // image
            /*
             * These are not components from MarkBind Vue components.
             * We have to add 'v-pre' to let Vue know to ignore this tag and not compile it.
             *
             * Although there won't be warnings if we use production Vue, it is still good to add this.
             */
            if (!_.has(node.attribs, 'v-pre')) { node.attribs['v-pre'] = ''; }
            break;
          default:
            break;
          }
        } catch (error) {
          logger.error(error);
        }

        return context;
      }

      postProcessNode(nodeOrText: NodeOrText) {
        if (NodeProcessor._isText(nodeOrText)) return;
        const node = nodeOrText as MbNode;

        try {
          switch (node.name) {
          case 'pre':
            highlightCodeBlock(node);
            break;
          case 'panel':
            assignPanelId(node);
            break;
          case 'head-top': {
            const collected = NodeProcessor.collectLayoutEl(node);
            Iif (collected) {
              this.headTop.push(collected);
            }
            break;
          }
          case 'head-bottom': {
            const collected = NodeProcessor.collectLayoutEl(node);
            Iif (collected) {
              this.headBottom.push(collected);
            }
            break;
          }
          case 'script-bottom': {
            const collected = NodeProcessor.collectLayoutEl(node);
            Iif (collected) {
              this.scriptBottom.push(collected);
            }
            break;
          }
          default:
            break;
          }
        } catch (error) {
          logger.error(error);
        }

        if (node.attribs) {
          delete node.attribs[ATTRIB_CWF];
        }
      }

      private traverse(dom: DomElement, context: Context): NodeOrText {
        if (NodeProcessor._isText(dom)) {
          return dom as TextElement;
        }
        const node = dom as MbNode;
        node.name = node.name.toLowerCase();
        if (linkProcessor.hasTagLink(node)) {
          linkProcessor.convertRelativeLinks(node, context.cwf, this.config.rootPath, this.config.baseUrl);
          linkProcessor.convertMdExtToHtmlExt(node);
          Iif (this.config.intrasiteLinkValidation.enabled) {
            this.siteLinkManager.collectIntraLinkToValidate(node, context.cwf);
          }
          linkProcessor.collectSource(node, this.config.rootPath, this.config.baseUrl, this.pageSources);
        }

        switch (node.name) {
        case 'md':
          node.name = 'span';
          cheerio(node).html(
            this.markdownProcessor.renderMdInline(cheerio.html(node.children as unknown as cheerio.Element)),
          );
          break;
        case 'markdown':
          node.name = 'div';
          cheerio(node).html(
            this.markdownProcessor.renderMd(cheerio.html(node.children as unknown as cheerio.Element)),
          );
          break;
        default:
          break;
        }

        // eslint-disable-next-line no-param-reassign
        context = this.processNode(node, context);
        this.pluginManager.processNode(node);

        if (node.children) {
          node.children.forEach((child) => {
            this.traverse(child, context);
          });
        }

        this.postProcessNode(node);

        addSitePageNavPortal(node);

        const isHeadingTag = (/^h[1-6]$/).test(node.name);
        if (isHeadingTag && !node.attribs.id) {
          setHeadingId(node, this.config);
        }

        this.pluginManager.postProcessNode(node);

        return node;
      }

      process(
        file: string,
        content: string,
        cwf: string = file,
        extraVariables: Record<string, string> = {},
      ) {
        const context = new Context(cwf, [], extraVariables, {});

        return new Promise((resolve, reject) => {
          const handler = new htmlparser.DomHandler((error, dom) => {
            Iif (error) {
              reject(error);
              return;
            }
            const mainHtmlNodes = dom.map((d) => {
              let processed: NodeOrText;
              try {
                processed = this.traverse(d, context);
              } catch (err: any) {
                err.message += `\nError while rendering '${file}'`;
                logger.error(err);
                processed = createErrorNode(d, err);
              }
              return processed;
            });
            mainHtmlNodes.forEach(d => NodeProcessor._trimNodes(d));

            const footnotesHtml = this.footnoteProcessor.combineFootnotes(node => this.processNode(
              node, new Context(cwf, [], extraVariables, {}),
            ));
            const mainHtml = cheerio(mainHtmlNodes).html();
            const mainHtmlWithUniqPageNavUuid = this.pageNavProcessor.finalizePageNavUuid(
              mainHtml, mainHtmlNodes, footnotesHtml);

            resolve(mainHtmlWithUniqPageNavUuid + footnotesHtml);
          });
          const parser = new htmlparser.Parser(handler);
          const fileExt = path.extname(file);
          if (isMarkdownFileExt(fileExt)) {
            const renderedContent = this.markdownProcessor.renderMd(content);
            // Wrap with <root> as $.remove() does not work on top level nodes
            parser.parseComplete(`<root>${renderedContent}</root>`);
          } else Eif (fileExt === '.html') {
            parser.parseComplete(`<root>${content}</root>`);
          } else {
            const error = new Error(`Unsupported File Extension: '${fileExt}'`);
            reject(error);
          }
        });
      }
    }