All files / src template.ts

91.97% Statements 229/249
82.35% Branches 98/119
74.55% Functions 41/55
94.81% Lines 219/231
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 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 5887x 7x 7x 7x                                   7x 7x 7x 7x 7x 7x   7x 7x 7x 7x 7x   7x           7x   50x 50x   50x 50x 49x 49x             100x 100x 99x   1x                 7x     46x 70x 42x           70x 61x 61x           70x 70x 9x 8x 8x 8x       69x 57x       69x                             48x 48x   48x 6x 6x 6x 6x     42x 59x 59x 59x   42x 42x 42x     42x   42x 42x   42x 42x   59x         42x 42x   42x 42x     42x       42x   42x         42x 42x   42x 42x               49x 49x 12x 12x 12x                   42x 25x 18x 4x 4x                       42x 10x 10x 10x 10x     10x       10x 10x         10x 10x   10x   10x               48x 308x 2x                           7x 29x 29x 29x   29x 14x   14x 5x 5x 5x     14x   16x 16x 16x         29x                     30x 2x 2x                         21x 21x 21x 21x 2x   21x 2x 1x   2x   21x 21x 1x 1x   20x 20x                             7x             8x 8x 8x 8x 8x     8x 8x 8x       8x   8x     8x       8x 8x       8x 8x     8x 8x       8x 8x 8x                             48x 30x     18x                           7x 8x   8x 8x   8x   8x   8x       8x   14x 11x 11x   11x         8x       8x 8x 8x                   48x               7x 42x 13x                     7x 42x   42x 18x 18x 18x   21x 21x 21x         21x 18x   21x 21x 4x 4x         4x   17x       18x             42x                   7x 42x   42x 18x 18x   18x 18x 18x   18x       18x       18x 18x     18x   20x 20x 20x         20x 18x     20x 19x   1x         18x             42x         141x          
import {FragmentStorefront} from "./fragment";
import cheerio from "cheerio";
import {TemplateCompiler} from "./templateCompiler";
import {
  CHEERIO_CONFIGURATION,
  CONTENT_NOT_FOUND_ERROR,
  NON_SELF_CLOSING_TAGS,
  TEMPLATE_FRAGMENT_TAG_NAME
} from "./config";
import {
  FragmentModel,
  IChunkedReplacementSet,
  ICookieMap,
  IFragmentContentResponse,
  IFragmentEndpointHandler,
  IPageDependentGateways,
  IReplaceAsset,
  IReplaceItem,
  IReplaceSet,
  IWaitedResponseFirstFlush
} from "./types";
import {HTTP_STATUS_CODE, REPLACE_ITEM_TYPE, RESOURCE_LOCATION} from "./enums";
import ResourceInjector from "./resource-injector";
import {isDebug} from "./util";
import {TemplateClass} from "./templateClass";
import {ERROR_CODES, PuzzleError} from "./errors";
import {benchmark, nrSegment, nrSegmentAsync} from "./decorators";
import {Logger} from "./logger";
import {container, TYPES} from "./base";
import fs from "fs";
import path from "path";
import {EVENT} from "./lib/enums";
import express from "express";
 
const logger = container.get(TYPES.Logger) as Logger;
 
interface CompressionStreamResponse extends express.Response {
  flush: () => void;
}
 
export class Template {
  dom: CheerioStatic;
  fragments: { [name: string]: FragmentStorefront } = {};
  pageClass: TemplateClass = new TemplateClass();
 
  constructor(public rawHtml: string, private name?: string) {
    this.load();
    this.bindPageClass();
    this.pageClass._onCreate();
  }
 
  /**
   * Loads html template into Cheerio instance
   */
  load(): void {
    const templateMatch = TemplateCompiler.TEMPLATE_CONTENT_REGEX.exec(this.rawHtml);
    if (templateMatch) {
      this.dom = cheerio.load(Template.replaceCustomScripts(templateMatch[1], true), CHEERIO_CONFIGURATION);
    } else {
      throw new PuzzleError(ERROR_CODES.TEMPLATE_NOT_FOUND);
    }
  }
 
  /**
   * Returns fragment dependencies
   * @returns {IPageDependentGateways}
   */
  @benchmark(isDebug(), logger.info)
  getDependencies() {
    let primaryName: string | null;
 
    return this.dom(TEMPLATE_FRAGMENT_TAG_NAME).toArray().reduce((dependencyList: IPageDependentGateways, fragment: CheerioElement) => {
      if (!dependencyList.gateways[fragment.attribs.from]) {
        dependencyList.gateways[fragment.attribs.from] = {
          gateway: null,
          ready: false
        };
      }
 
      if (!dependencyList.fragments[fragment.attribs.name]) {
        this.fragments[fragment.attribs.name] = new FragmentStorefront(fragment.attribs.name, fragment.attribs.from);
        dependencyList.fragments[fragment.attribs.name] = {
          gateway: fragment.attribs.from,
          instance: this.fragments[fragment.attribs.name]
        };
      }
 
      Eif (!this.fragments[fragment.attribs.name].primary) {
        if (typeof fragment.attribs.primary !== 'undefined') {
          if (primaryName != null && primaryName !== fragment.attribs.name) throw new PuzzleError(ERROR_CODES.MULTIPLE_PRIMARY_FRAGMENTS);
          primaryName = fragment.attribs.name;
          this.fragments[fragment.attribs.name].primary = true;
          this.fragments[fragment.attribs.name].shouldWait = true;
        }
      }
 
      if (!this.fragments[fragment.attribs.name].shouldWait) {
        this.fragments[fragment.attribs.name].shouldWait = typeof fragment.attribs.shouldwait !== 'undefined' || (fragment.parent && fragment.parent.name === 'head') || false;
      }
 
 
      return dependencyList;
    }, {
      gateways: {},
      fragments: {}
    });
  }
 
  //todo fragmentConfigleri versiyon bilgileriyle inmis olmali ki assetleri versionlara gore compile edebilelim. ayni not gatewayde de var.
  /**
   * Compiles template and returns a function that can handle the request.
   * @param {ICookieMap} testCookies
   * @param {boolean} isDebug
   * @returns {Promise<IFragmentEndpointHandler>}
   */
  async compile(testCookies: ICookieMap, isDebug = false, precompile = false): Promise<IFragmentEndpointHandler> {
    logger.info(`[Compiling Page ${this.name}]`, 'Creating virtual dom');
    this.load();
 
    if (Object.keys(this.fragments).length === 0) {
      logger.info(`[Compiling Page ${this.name}]`, 'No fragments detected, implementing single flush handler');
      this.replaceEmptyTags();
      const singleFlushHandlerWithoutFragments = TemplateCompiler.compile(Template.clearHtmlContent(this.dom.html()));
      return this.buildHandler(singleFlushHandlerWithoutFragments, [], [], [], isDebug);
    }
 
    const resourceInjector = new ResourceInjector(this.fragments, this.name, testCookies);
    const chunkedFragmentsWithShouldWait = Object.values(this.fragments).filter(fragment => fragment.config && fragment.shouldWait && !fragment.config.render.static);
    const chunkedFragmentsWithoutWait = Object.values(this.fragments).filter(fragment => fragment.config && !fragment.shouldWait && !fragment.config.render.static);
    const staticFragments = Object.values(this.fragments).filter(fragment => fragment.config && fragment.config.render.static);
 
    logger.info(`[Compiling Page ${this.name}]`, 'Injecting Puzzle Lib to head');
    resourceInjector.injectAssets(this.dom);
    resourceInjector.injectLibraryConfig(this.dom);
 
    // todo kaldir lib bagla
    const replaceScripts: any[] = [];
 
    logger.info(`[Compiling Page ${this.name}]`, 'Adding containers for waited fragments');
    const waitedFragmentReplacements: IReplaceSet[] = this.replaceWaitedFragmentContainers(chunkedFragmentsWithShouldWait, replaceScripts, isDebug);
 
    logger.info(`[Compiling Page ${this.name}]`, 'Adding containers for chunked fragments');
    const chunkReplacements: IReplaceSet[] = this.replaceChunkedFragmentContainers(chunkedFragmentsWithoutWait);
 
    this.replaceUnfetchedFragments(Object.values(this.fragments).filter(fragment => !fragment.config));
 
    // todo kaldir lib bag
    //await this.addDependencies();
 
    logger.info(`[Compiling Page ${this.name}]`, 'Replacing static contents with their real contents');
    await this.replaceStaticFragments(staticFragments, replaceScripts.filter(replaceSet => replaceSet.fragment.config && replaceSet.fragment.config.render.static));
 
    logger.info(`[Compiling Page ${this.name}]`, 'Adding placeholders for chunked fragments');
    await this.appendPlaceholders(chunkReplacements);
 
 
    logger.info(`[Compiling Page ${this.name}]`, 'Combining and minifying page styles');
    /**
     * @deprecated Combine this with only on render start assets.
     */
    await resourceInjector.injectStyleSheets(this.dom, precompile);
 
    this.replaceEmptyTags();
 
    /**
     * todo Bu kafa olmaz runtimeda debug not debug degismez, handler ici runtime guzel olur.
     */
    const puzzleLib = fs.readFileSync(path.join(__dirname, `/lib/${isDebug ? 'puzzle_debug.min.js' : 'puzzle.min.js'}`)).toString();
    const clearLibOutput = Template.replaceCustomScripts(this.dom.html().replace('{puzzleLibContent}', puzzleLib), false);
 
    logger.info(`[Compiling Page ${this.name}]`, 'Sending virtual dom to compiler');
    return this.buildHandler(TemplateCompiler.compile(Template.clearHtmlContent(clearLibOutput)), chunkReplacements, waitedFragmentReplacements, replaceScripts, isDebug);
  }
 
 
  /**
   * Bind user class to page
   */
  private bindPageClass(): void {
    const scriptMatch = TemplateCompiler.PAGE_CLASS_CONTENT_REGEX.exec(this.rawHtml);
    if (scriptMatch) {
      const pageClass = eval(scriptMatch[1]);
      pageClass.__proto__ = new TemplateClass();
      this.pageClass = pageClass;
    }
  }
 
  /**
   * Appends placeholders to reserved locations
   * @param {IChunkedReplacementSet[]} chunkedReplacements
   * @returns {Promise<void>}
   */
  private async appendPlaceholders(chunkedReplacements: IChunkedReplacementSet[]) {
    for (const replacement of chunkedReplacements) {
      const placeholders = replacement.replaceItems.filter(item => item.type === REPLACE_ITEM_TYPE.PLACEHOLDER);
      for (const placeholderReplacement of placeholders) {
        const placeholderContent = await replacement.fragment.getPlaceholder();
        this.dom(`[puzzle-placeholder="${placeholderReplacement.key}"]`).append(placeholderContent);
      }
    }
  }
 
  /**
   * Replaces static fragments with their content on vDOM
   * @param {FragmentStorefront[]} fragments
   * @param {IReplaceAsset[]} replaceAssets
   * @returns {Promise<void>}
   */
  private async replaceStaticFragments(fragments: FragmentStorefront[], replaceAssets: IReplaceAsset[]): Promise<void> {
    for (const fragment of fragments) {
      const partialElements: any = [];
      let mainElement: any = null;
      this.dom(`fragment[name="${fragment.name}"][from="${fragment.from}"]`).each((i, element) => {
        Iif (this.dom(element).attr('partial') && this.dom(element).attr('partial') !== "main") {
          partialElements.push(element);
        } else {
          mainElement = element;
        }
      });
 
      const assets = replaceAssets.find(set => set.fragment.name === fragment.name);
      const fragmentScripts = assets ? assets.replaceItems.reduce((script, replaceItem) => {
        script += ResourceInjector.wrapJsAsset(replaceItem);
        return script;
      }, '') : '';
 
      const processedAttributes = TemplateCompiler.processExpression(mainElement.attribs, this.pageClass);
      const fragmentContent: IFragmentContentResponse = await fragment.getContent(processedAttributes);
 
      this.dom(mainElement).replaceWith(`<div id="${fragment.name}" puzzle-fragment="${fragment.name}" puzzle-gateway="${fragment.from}" fragment-partial="${'main'}">${fragmentContent.html['main'] || CONTENT_NOT_FOUND_ERROR}</div>${fragmentScripts}<script>PuzzleJs.emit('${EVENT.ON_FRAGMENT_RENDERED}','${fragment.name}');</script>`);
 
      partialElements.forEach((i: number, element: any) => {
        this.dom(element).replaceWith(`<div id="${fragment.name}" puzzle-fragment="${fragment.name}" puzzle-gateway="${fragment.from}" fragment-partial="${element.attribs.partial}">${fragmentContent.html[element.attribs.partial] || CONTENT_NOT_FOUND_ERROR}</div>${fragmentScripts}<script>PuzzleJs.emit('${EVENT.ON_FRAGMENT_RENDERED}','${fragment.name}');</script>`);
      });
 
    }
  }
 
  private replaceEmptyTags(): any {
    this.dom('*').each((i, element) => {
      if (NON_SELF_CLOSING_TAGS.indexOf(this.dom(element)[0].name) !== -1 && this.dom(element).text().length === 0 && !this.dom(element).html()) {
        this.dom(element).text(' ');
      }
    });
  }
 
  /**
   * Replaces waited fragments with their content on first flush string.
   * @param {IReplaceSet[]} waitedFragments
   * @param {string} template
   * @param req
   * @param isDebug
   * @returns {Promise<IWaitedResponseFirstFlush>}
   */
  @nrSegmentAsync("template.replaceWaitedFragments", true)
  private async replaceWaitedFragments(waitedFragments: IReplaceSet[], template: string, req: any, isDebug: boolean): Promise<IWaitedResponseFirstFlush> {
    let statusCode = HTTP_STATUS_CODE.OK;
    let headers = {};
    let cookies = {};
 
    await Promise.all(waitedFragments.map(async waitedFragmentReplacement => {
      const fragmentContent = await waitedFragmentReplacement.fragment.getContent(TemplateCompiler.processExpression(waitedFragmentReplacement.fragmentAttributes, this.pageClass, req), req);
 
      if (waitedFragmentReplacement.fragment.primary) {
        statusCode = fragmentContent.status;
        headers = fragmentContent.headers;
        cookies = fragmentContent.cookies;
      }
 
      waitedFragmentReplacement.replaceItems
        .forEach(replaceItem => {
          Eif (replaceItem.type === REPLACE_ITEM_TYPE.CONTENT) {
            const fragmentInject = fragmentContent.html[replaceItem.partial] || CONTENT_NOT_FOUND_ERROR;
            template = template.replace(replaceItem.key, () => fragmentInject + Template.fragmentModelScript(waitedFragmentReplacement.fragment, fragmentContent.model, isDebug));
          }
        });
    }));
 
    return {template, statusCode, headers, cookies};
  }
 
  /**
   * Maps fragment response variable model into PuzzleLib
   * @param {{name: string}} fragment
   * @param {FragmentModel} fragmentPageModel
   * @param {boolean} isDebug
   * @returns {string}
   */
  static fragmentModelScript(fragment: { name: string }, fragmentPageModel: FragmentModel, isDebug = false) {
    return fragmentPageModel && Object.keys(fragmentPageModel).length ? `<script>${Object.keys(fragmentPageModel).reduce((modelVariable, key) => {
      modelVariable += `PuzzleJs.emit("${EVENT.ON_VARIABLES}", "${fragment.name}", "${key}", ${JSON.stringify(fragmentPageModel[key])});`;
      return modelVariable;
    }, '')}</script>` : '';
  }
 
  /**
   * Handles non chunked page renders
   * @param firstFlushHandler
   * @param waitedFragments
   * @param isDebug
   * @param req
   * @param res
   */
  async nonChunkedHandler(firstFlushHandler: Function, waitedFragments: IReplaceSet[], isDebug: boolean, req: express.Request, res: CompressionStreamResponse) {
    this.pageClass._onRequest(req);
    const fragmentedHtml = firstFlushHandler.call(this.pageClass, req);
    const waitedReplacement = await this.replaceWaitedFragments(waitedFragments, fragmentedHtml, req, isDebug);
    for (const prop in waitedReplacement.headers) {
      res.set(prop, waitedReplacement.headers[prop]);
    }
    for (const prop in waitedReplacement.cookies) {
      if (waitedReplacement.cookies[prop].options && waitedReplacement.cookies[prop].options.expires) {
        waitedReplacement.cookies[prop].options.expires = new Date(String(waitedReplacement.cookies[prop].options.expires));
      }
      res.cookie(prop, waitedReplacement.cookies[prop].value, waitedReplacement.cookies[prop].options);
    }
    res.status(waitedReplacement.statusCode);
    if (waitedReplacement.statusCode === HTTP_STATUS_CODE.MOVED_PERMANENTLY) {
      res.end();
      this.pageClass._onResponseEnd();
    } else {
      res.send(waitedReplacement.template.replace('</body>', () => `<script>PuzzleJs.emit('${EVENT.ON_PAGE_LOAD}');</script></body>`));
      this.pageClass._onResponseEnd();
    }
  }
 
  /**
   * Handles chunked page renders
   * @param firstFlushHandler
   * @param waitedFragments
   * @param chunkedFragmentReplacements
   * @param jsReplacements
   * @param isDebug
   * @param req
   * @param res
   */
  @nrSegmentAsync("template.chunkedHandler", true)
  async chunkedHandler(firstFlushHandler: Function,
                       waitedFragments: IReplaceSet[],
                       chunkedFragmentReplacements: IReplaceSet[],
                       jsReplacements: IReplaceAsset[],
                       isDebug: boolean,
                       req: express.Request,
                       res: CompressionStreamResponse) {
    this.pageClass._onRequest(req);
    const fragmentedHtml = firstFlushHandler.call(this.pageClass, req).replace('</body>', '').replace('</html>', '');
    res.set('transfer-encoding', 'chunked');
    res.set('content-type', 'text/html; charset=UTF-8');
    const waitedPromises: Array<Promise<any>> = [];
 
    //Fire requests in parallel
    const waitedReplacementPromise = this.replaceWaitedFragments(waitedFragments, fragmentedHtml, req, isDebug);
    for (const chunkedReplacement of chunkedFragmentReplacements) {
      waitedPromises.push(chunkedReplacement.fragment.getContent(TemplateCompiler.processExpression(chunkedReplacement.fragmentAttributes, this.pageClass, req), req));
    }
 
    //Wait for first flush
    const waitedReplacement = await waitedReplacementPromise;
 
    for (const prop in waitedReplacement.headers) {
      res.set(prop, waitedReplacement.headers[prop]);
    }
    for (const prop in waitedReplacement.cookies) {
      res.cookie(prop, waitedReplacement.cookies[prop].value, waitedReplacement.cookies[prop].options);
    }
 
    res.status(waitedReplacement.statusCode);
    Iif (waitedReplacement.statusCode === HTTP_STATUS_CODE.MOVED_PERMANENTLY) {
      res.end();
      this.pageClass._onResponseEnd();
    } else {
      res.write(waitedReplacement.template);
      res.flush();
 
      //Bind flush method to resolved or being resolved promises of chunked replacements
      Object.values(chunkedFragmentReplacements).forEach((chunkedReplacement, x) => {
        waitedPromises[x].then(this.flush(chunkedReplacement, jsReplacements, res, isDebug));
      });
 
      //Close stream after all chunked fragments done
      await Promise.all(waitedPromises);
      res.end(`<script>PuzzleJs.emit('${EVENT.ON_PAGE_LOAD}');</script></body></html>`);
      this.pageClass._onResponseEnd();
    }
  };
 
 
  /**
   * Creates a request handler from the compilation output. Express requests uses the return of this method
   * @param {Function} firstFlushHandler
   * @param {IReplaceSet[]} chunkedFragmentReplacements
   * @param {IReplaceSet[]} waitedFragments
   * @param {IReplaceAsset[]} jsReplacements
   * @param isDebug
   * @returns {(req: any, res: any) => void}
   */
  private buildHandler(firstFlushHandler: Function, chunkedFragmentReplacements: IReplaceSet[], waitedFragments: IReplaceSet[] = [], jsReplacements: IReplaceAsset[] = [], isDebug: boolean) {
    if (chunkedFragmentReplacements.length === 0) {
      return this.nonChunkedHandler.bind(this, firstFlushHandler, waitedFragments, isDebug);
    } else {
      // @ts-ignore https://stackoverflow.com/questions/57072381/typescript-bind-gives-type-error-when-using-more-than-4-parameters/57072988
      return this.chunkedHandler.bind(this, firstFlushHandler, waitedFragments, chunkedFragmentReplacements, jsReplacements, isDebug);
    }
  }
 
 
  /**
   * Flushes incoming fragment response
   * @param {IReplaceSet} chunkedReplacement
   * @param {IReplaceAsset[]} jsReplacements
   * @param res
   * @param isDebug
   * @returns {(fragmentContent: IFragmentContentResponse) => void}
   */
  @nrSegment("template.flush", true)
  private flush(chunkedReplacement: IReplaceSet, jsReplacements: IReplaceAsset[], res: CompressionStreamResponse, isDebug: boolean) {
    return (fragmentContent: IFragmentContentResponse) => {
 
      const fragmentJsReplacements = jsReplacements.find(jsReplacement => jsReplacement.fragment.name === chunkedReplacement.fragment.name);
      const selfReplacing = chunkedReplacement.fragment.config && chunkedReplacement.fragment.config.render.selfReplace;
 
      let output = '';
 
      output += Template.fragmentModelScript(chunkedReplacement.fragment, fragmentContent.model, isDebug);
 
      fragmentJsReplacements && fragmentJsReplacements.replaceItems.filter(item => item.location === RESOURCE_LOCATION.CONTENT_START).forEach(replaceItem => {
        output += ResourceInjector.wrapJsAsset(replaceItem);
      });
 
      chunkedReplacement.replaceItems
        .forEach(replaceItem => {
          if (replaceItem.type === REPLACE_ITEM_TYPE.CHUNKED_CONTENT) {
            output += `<div style="display: none;" puzzle-fragment="${chunkedReplacement.fragment.name}" puzzle-chunk-key="${replaceItem.key}">${fragmentContent.html[replaceItem.partial] || CONTENT_NOT_FOUND_ERROR}</div>`;
            Eif (!(replaceItem.key === 'main' && selfReplacing)) {
              // todo replace here
              output += `<script>PuzzleJs.emit('${EVENT.ON_FRAGMENT_RENDERED}','${chunkedReplacement.fragment.name}','[puzzle-chunk="${replaceItem.key}"]','[puzzle-chunk-key="${replaceItem.key}"]');</script>`;
            }
          }
        });
 
      fragmentJsReplacements && fragmentJsReplacements.replaceItems.filter(item => item.location === RESOURCE_LOCATION.CONTENT_END).forEach(replaceItem => {
        output += ResourceInjector.wrapJsAsset(replaceItem);
      });
 
      this.pageClass._onChunk(output);
      res.write(output);
      res.flush();
    };
  }
 
  /**
   * Clears html content from empty spaces
   * @param {string} str
   * @returns {string}
   */
  private static clearHtmlContent(str: string) {
    return str.replace(/>\s+</g, "><").trim();
  }
 
  /**
   * Replaces unfetched fragments with empty div error
   * @param {FragmentStorefront[]} fragments
   */
  @benchmark(isDebug(), logger.info)
  private replaceUnfetchedFragments(fragments: FragmentStorefront[]) {
    fragments.forEach(fragment => {
      this.dom(`fragment[from="${fragment.from}"][name="${fragment.name}"]`).replaceWith(`<div puzzle-fragment="${fragment.name}" puzzle-gateway="${fragment.from}">${CONTENT_NOT_FOUND_ERROR}</div>`);
    });
  }
 
 
  /**
   * Creates chunked fragment containers
   * @param {FragmentStorefront[]} chunkedFragments
   * @returns {IReplaceSet[]}
   */
  @benchmark(isDebug(), logger.info)
  private replaceChunkedFragmentContainers(chunkedFragments: FragmentStorefront[]) {
    const chunkReplacements: IReplaceSet[] = [];
 
    chunkedFragments.forEach(fragment => {
      const replaceItems: IReplaceItem[] = [];
      let fragmentAttributes = {};
      this.dom(`fragment[from="${fragment.from}"][name="${fragment.name}"]`)
        .each((i, element) => {
          const partial = element.attribs.partial || 'main';
          const contentKey = fragment.name + '_' + partial;
          const replaceItem = {
            type: REPLACE_ITEM_TYPE.CHUNKED_CONTENT,
            partial,
            key: contentKey,
          };
          if (partial === 'main') {
            fragmentAttributes = element.attribs;
          }
          replaceItems.push(replaceItem);
          if (fragment.config && fragment.config.render.placeholder && replaceItem.partial === 'main') {
            const placeholderContentKey = contentKey + '_placeholder';
            replaceItems.push({
              type: REPLACE_ITEM_TYPE.PLACEHOLDER,
              partial,
              key: placeholderContentKey
            });
            this.dom(element).replaceWith(`<div id="${fragment.name}" puzzle-fragment="${element.attribs.name}" puzzle-gateway="${element.attribs.from}" ${element.attribs.partial ? 'fragment-partial="' + element.attribs.partial + '"' : ''} puzzle-chunk="${contentKey}" puzzle-placeholder="${placeholderContentKey}"></div>`);
          } else {
            this.dom(element).replaceWith(`<div id="${fragment.name}" puzzle-fragment="${element.attribs.name}" puzzle-gateway="${element.attribs.from}" ${element.attribs.partial ? 'fragment-partial="' + element.attribs.partial + '"' : ''} puzzle-chunk="${contentKey}"> </div>`);
          }
        });
 
      chunkReplacements.push({
        fragment,
        replaceItems,
        fragmentAttributes
      });
    });
 
    return chunkReplacements;
  }
 
  /**
   * Creates containers for fragments should be waited
   * @param {FragmentStorefront[]} fragmentsShouldBeWaited
   * @param {IReplaceAsset[]} replaceJsAssets
   * @returns {IReplaceSet[]}
   */
  @benchmark(isDebug(), logger.info)
  private replaceWaitedFragmentContainers(fragmentsShouldBeWaited: FragmentStorefront[], replaceJsAssets: IReplaceAsset[], isDebug: boolean) {
    const waitedFragmentReplacements: IReplaceSet[] = [];
 
    fragmentsShouldBeWaited.forEach(fragment => {
      const replaceItems: IReplaceItem[] = [];
      let fragmentAttributes = {};
 
      const jsReplacements = replaceJsAssets.find(jsReplacement => jsReplacement.fragment.name === fragment.name);
      let contentStart = '';
      let contentEnd = ``;
 
      jsReplacements && jsReplacements.replaceItems.filter(item => item.location === RESOURCE_LOCATION.CONTENT_START).forEach(replaceItem => {
        contentStart += ResourceInjector.wrapJsAsset(replaceItem);
      });
 
      jsReplacements && jsReplacements.replaceItems.filter(item => item.location === RESOURCE_LOCATION.CONTENT_END).forEach(replaceItem => {
        contentEnd += ResourceInjector.wrapJsAsset(replaceItem);
      });
 
      this.dom(contentStart).insertBefore(this.dom(`fragment[from="${fragment.from}"][name="${fragment.name}"]`).first());
      this.dom(contentEnd).insertAfter(this.dom(`fragment[from="${fragment.from}"][name="${fragment.name}"]`).last());
 
 
      this.dom(`fragment[from="${fragment.from}"][name="${fragment.name}"]`)
        .each((i, element) => {
          const replaceKey = `{fragment|${element.attribs.name}_${element.attribs.from}_${element.attribs.partial || 'main'}}`;
          const partial = element.attribs.partial || 'main';
          replaceItems.push({
            type: REPLACE_ITEM_TYPE.CONTENT,
            key: replaceKey,
            partial,
          });
          if (partial === 'main') {
            fragmentAttributes = element.attribs;
          }
 
          if (element.parentNode.name !== 'head') {
            this.dom(element).replaceWith(`<div id="${fragment.name}" puzzle-fragment="${element.attribs.name}" puzzle-gateway="${element.attribs.from}" ${element.attribs.partial ? 'fragment-partial="' + element.attribs.partial + '"' : ''}>${replaceKey}</div><script>PuzzleJs.emit('${EVENT.ON_FRAGMENT_RENDERED}','${fragment.name}');</script>`);
          } else {
            this.dom(element).replaceWith(replaceKey);
          }
        });
 
 
      waitedFragmentReplacements.push({
        fragment,
        replaceItems,
        fragmentAttributes
      });
    });
 
    return waitedFragmentReplacements;
  }
 
 
  private static replaceCustomScripts(template: string, encode: boolean) {
    return encode ?
      template.replace(/<puzzle-script>/g, '<!--custom-script').replace(/<\/puzzle-script>/g, '/custom-script-->') :
      template.replace(/<!--custom-script/g, '<script>').replace(/\/custom-script-->/g, '</script>');
  }
}