Compare commits

...

45 Commits

Author SHA1 Message Date
344e213c41 1.0.31 2021-08-16 17:47:21 +02:00
0ae13c970e fix(core): update 2021-08-16 17:47:20 +02:00
0502e7bc99 1.0.30 2021-08-16 16:26:13 +02:00
c0a425e16d fix(core): update 2021-08-16 16:26:13 +02:00
90089357cf 1.0.29 2021-08-16 10:31:39 +02:00
e36aed4b2b fix(core): update 2021-08-16 10:31:38 +02:00
4d2aa7a0ee 1.0.28 2021-08-16 10:30:46 +02:00
759fa1ff43 fix(core): update 2021-08-16 10:30:46 +02:00
042caeeeb5 1.0.27 2021-05-19 15:21:48 +00:00
6ddfaffbff fix(core): update 2021-05-19 15:21:47 +00:00
567507c88b 1.0.26 2021-05-19 11:32:13 +00:00
35f7bdd984 fix(core): update 2021-05-19 11:32:12 +00:00
602fa2b7ff 1.0.25 2021-05-19 01:33:59 +00:00
b1aae3e5b9 fix(core): update 2021-05-19 01:33:58 +00:00
6b381d6115 1.0.24 2021-01-15 14:22:50 +00:00
25006901d9 fix(core): update 2021-01-15 14:22:49 +00:00
ee613836d1 1.0.23 2021-01-15 07:17:08 +00:00
4b53173618 fix(core): update 2021-01-15 07:17:08 +00:00
46a0220273 1.0.22 2021-01-12 15:17:31 +00:00
46a6c903e1 fix(core): update 2021-01-12 15:17:31 +00:00
134151eb70 1.0.21 2021-01-12 15:07:45 +00:00
ac1c3ac53d fix(core): update 2021-01-12 15:07:45 +00:00
09c23d04f4 1.0.20 2021-01-12 14:18:17 +00:00
3f359cb58c fix(core): update 2021-01-12 14:18:16 +00:00
a85eb48343 1.0.19 2021-01-09 01:48:37 +00:00
7c851b5ed2 fix(core): update 2021-01-09 01:48:36 +00:00
bcd69059f8 1.0.18 2021-01-08 22:08:02 +00:00
acba539a6f fix(core): update 2021-01-08 22:08:01 +00:00
446b4c38ea 1.0.17 2021-01-08 22:06:26 +00:00
bc6d3f45f8 fix(core): update 2021-01-08 22:06:25 +00:00
bd381ff23f 1.0.16 2020-08-06 17:50:03 +00:00
7e5bdf8521 fix(core): update 2020-08-06 17:50:00 +00:00
f427141c7c 1.0.15 2020-08-06 15:30:54 +00:00
e8191187a1 fix(core): update 2020-08-06 15:30:54 +00:00
6e1dcccd81 1.0.14 2020-08-06 15:18:54 +00:00
f8eee10a40 1.0.13 2020-08-06 15:18:48 +00:00
a6492a5465 1.0.12 2020-08-06 15:18:40 +00:00
eb9c2bd284 1.0.11 2020-08-06 15:17:01 +00:00
9991e234ce fix(core): update 2020-08-06 15:17:01 +00:00
d6ba1bbed7 1.0.10 2020-08-06 15:14:56 +00:00
46aefbde48 1.0.9 2020-08-06 15:13:57 +00:00
6087c08c0a 1.0.8 2020-08-06 15:13:39 +00:00
2158b366cb fix(core): update 2020-08-06 15:13:38 +00:00
b0e17be31e 1.0.7 2020-03-01 13:50:29 +00:00
a5151b6c89 fix(core): update 2020-03-01 13:50:28 +00:00
11 changed files with 27836 additions and 721 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds
dist/
dist_web/
dist_serve/
dist_ts_web/
dist_*/
# custom

View File

@ -19,22 +19,35 @@ mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
snyk:
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command snyk test
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- lossless
- docker
- notpriv
allow_failure: true
# ====================
# test stage
@ -49,9 +62,7 @@ testStable:
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- priv
testBuild:
stage: test
@ -62,9 +73,7 @@ testBuild:
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- notpriv
release:
stage: release
@ -84,6 +93,8 @@ release:
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare

View File

@ -15,7 +15,7 @@
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm"]
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}

28235
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,40 +1,46 @@
{
"name": "@pushrocks/smartssr",
"version": "1.0.6",
"version": "1.0.31",
"private": false,
"description": "a smart server side renderer supporting shadow dom",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest test/ --web)",
"build": "(tsbuild --web)",
"format": "(gitzone format)"
"serve": "tsrun scripts/serve.ts"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.0.22",
"@gitzone/tstest": "^1.0.15",
"@pushrocks/tapbundle": "^3.0.7",
"@types/node": "^13.7.4",
"tslint": "^6.0.0",
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tstest": "^1.0.54",
"@pushrocks/smartserve": "^1.1.41",
"@pushrocks/tapbundle": "^3.2.14",
"@types/node": "^15.3.0",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0"
},
"dependencies": {
"@pushrocks/smartdelay": "^2.0.6",
"@pushrocks/smartfile": "^7.0.8",
"@pushrocks/smartpromise": "^3.0.6",
"@pushrocks/smartpuppeteer": "^1.0.15"
"@pushrocks/smartdelay": "^2.0.10",
"@pushrocks/smartfile": "^8.0.10",
"@pushrocks/smartpromise": "^3.1.5",
"@pushrocks/smartpuppeteer": "^1.0.21",
"@pushrocks/smarttime": "^3.0.38"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_web/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

View File

@ -8,13 +8,20 @@ a smart server side renderer supporting shadow dom
* [docs (typedoc)](https://pushrocks.gitlab.io/smartssr/)
## Status for master
[![pipeline status](https://gitlab.com/pushrocks/smartssr/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartssr/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartssr/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartssr/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartssr.svg)](https://www.npmjs.com/package/@pushrocks/smartssr)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartssr/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartssr)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartssr/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartssr/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartssr)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartssr)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartssr)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartssr)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartssr)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage

9
scripts/serve.ts Normal file
View File

@ -0,0 +1,9 @@
import * as smartserve from '@pushrocks/smartserve';
import * as path from 'path';
const smartserveInstance = new smartserve.SmartServe({
injectReload: true,
serveDir: path.join(__dirname, '../.nogit/')
});
smartserveInstance.start();

View File

@ -4,27 +4,22 @@ import * as smartssr from '../ts/index';
let testSSRInstance: smartssr.SmartSSR;
tap.test('should create a valid smartssr instance', async () => {
testSSRInstance = new smartssr.SmartSSR();
testSSRInstance = new smartssr.SmartSSR({
debug: true,
});
});
tap.test('should start the smartssr instance', async () => {
await testSSRInstance.start();
tap.test('should render central.eu', async (tools) => {
await testSSRInstance.renderPage('https://lossless.com');
});
tap.test('should render central.eu', async tools => {
await testSSRInstance.renderPage('https://central.eu');
});
tap.test('should render lossless.com', async () => {
tap.skip.test('should render lossless.com', async () => {
await testSSRInstance.renderPage('https://lossless.com');
});
tap.skip.test('should render https://lossless.gmbh', async () => {
const renderedPage = await testSSRInstance.renderPage('https://lossless.gmbh');
});
tap.test('should stop the smartssr instance', async () => {
await testSSRInstance.stop();
console.log(renderedPage);
});
tap.start();

View File

@ -3,49 +3,93 @@ import * as paths from './smartssr.paths';
import { serializeFunction } from './smartssr.function.serialize';
export interface ISmartSSROptions {
debug: boolean;
}
/**
*
*/
export class SmartSSR {
public browser: plugins.smartpuppeteer.puppeteer.Browser;
public async start() {
this.browser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance();
}
public async stop() {
if (this.browser) {
await plugins.smartdelay.delayFor(3000);
await this.browser.close();
this.browser = null;
} else {
console.log('browser was not in started mode');
}
public options: ISmartSSROptions;
constructor(optionsArg?: ISmartSSROptions) {
this.options = {
...{
debug: false,
},
...optionsArg,
};
}
public async renderPage(urlArg: string) {
const overallTimeMeasurement = new plugins.smarttime.HrtMeasurement();
overallTimeMeasurement.start();
const resultDeferred = plugins.smartpromise.defer<string>();
const context = await this.browser.createIncognitoBrowserContext();
const page = await context.newPage();
page.on('console', msg => {
console.log(`${urlArg}: ${msg.text()}`);
});
const browser = new plugins.smartpuppeteer.IncognitoBrowser();
const renderTimeMeasurement = new plugins.smarttime.HrtMeasurement();
let renderedPageString: string;
let screenshotBuffer: Buffer;
await browser.start();
try {
const context = await browser.getNewIncognitoContext();
const page = await context.newPage();
// lets protect against left open tabs
plugins.smartdelay.delayFor(30000).then(async () => {
try {
await browser.stop();
} catch {}
});
page.on('console', (msg) => {
console.log(`${urlArg}: ${msg.text()}`);
});
renderTimeMeasurement.start();
await page.goto(urlArg, {
waitUntil: 'networkidle2',
timeout: 30000,
});
if (this.options.debug) {
screenshotBuffer = await page.screenshot({
encoding: 'binary',
});
}
page.on('load', async (...args) => {
// await plugins.smartdelay.delayFor(2000);
await page.$eval('body', serializeFunction);
const pageContent = await page.content();
const renderedPageString = pageContent;
renderedPageString = pageContent;
resultDeferred.resolve(renderedPageString);
renderTimeMeasurement.stop();
// lets clean up async
await page.close();
await context.close();
} catch (e) {
console.log(e);
}
await browser.stop();
overallTimeMeasurement.stop();
console.log(
`Overall it took ${overallTimeMeasurement.milliSeconds} milliseconds to render ${urlArg}`
);
console.log(
`The rendering alone took ${renderTimeMeasurement.milliSeconds} milliseconds for ${urlArg}`
);
// debug
if (this.options.debug) {
plugins.smartfile.memory.toFsSync(
renderedPageString,
plugins.path.join(paths.noGitDir, 'test.html')
);
});
const fs = await import('fs');
fs.writeFileSync(plugins.path.join(paths.noGitDir, 'test.png'), screenshotBuffer);
}
await page.goto(urlArg);
const result = await resultDeferred.promise;
page.close().then(async () => {
await context.close();
});
return result;
return resultDeferred.promise;
}
}

View File

@ -1,7 +1,7 @@
declare var document: Document;
export function serializeFunction(rootNode) {
const uuidv4 = () => {
return 'unixxxxxxxxxxx'.replace(/[xy]/g, c => {
return 'unixxxxxxxxxxx'.replace(/[xy]/g, (c) => {
const r = (Math.random() * 16) | 0;
const v = c === 'x' ? r : (r & 0x3) | 0x8;
return v.toString(16);
@ -24,55 +24,80 @@ export function serializeFunction(rootNode) {
styleTemplate = styleTemplate.replace(/}[ \t\n]+div/g, `}\n\n.${uuidID} div`);
return styleTemplate;
};
const loopProtection: any[] = [];
function serializeNode(node: HTMLElement) {
if (!node.tagName.includes('-')) {
function serializeNode(nodeArg: HTMLElement, logThis = false) {
if (loopProtection.includes(nodeArg)) {
return;
}
if (node.hasAttribute('smartssr')) {
console.log(`${node.tagName} is already serialized`);
return;
}
node.setAttribute('smartssr', 'yes');
// lets handle the current node
const nodeUUID = uuidv4();
loopProtection.push(nodeArg);
// console.log(nodeArg.nodeName);
if (nodeArg.shadowRoot) {
nodeArg.setAttribute('smartssr', 'yes');
try {
node.classList.add(nodeUUID);
// lets handle the current node
const nodeUUID = uuidv4();
nodeArg.classList.add(nodeUUID);
// find all slots
const slots = nodeArg.shadowRoot.querySelectorAll('slot');
// handle slot element
const slotsForMove: HTMLSlotElement[] = [];
slots.forEach((slot) => {
slotsForMove.push(slot);
});
for (const slot of slotsForMove) {
const slottedLightNodesForMove = [];
slot.assignedNodes().forEach((lightNode) => slottedLightNodesForMove.push(lightNode));
slottedLightNodesForMove.forEach((lightNode) =>
slot.parentNode.insertBefore(lightNode, slot)
);
}
// lets modify the css
const children: HTMLElement[] = node.shadowRoot.children as any;
for (const childElement of children) {
if (childElement.tagName === 'STYLE') {
childElement.textContent = prependCss(nodeUUID, childElement.textContent);
const childNodes = nodeArg.shadowRoot.childNodes;
// tslint:disable-next-line: prefer-for-of
const noteForAppending: HTMLElement[] = [];
// lets care about static css first
if (
(nodeArg.constructor as any).styles &&
(nodeArg.constructor as any).styles instanceof Array
) {
for (const objectArg of (nodeArg.constructor as any).styles) {
const styleTag = document.createElement('style');
styleTag.textContent = prependCss(nodeUUID, objectArg.cssText);
noteForAppending.push(styleTag);
}
serializeFunction(childElement);
}
const templateDom = document.createElement('template');
templateDom.innerHTML = node.innerHTML;
const slot = node.shadowRoot.querySelector('slot');
node.childNodes.forEach(lightNode => slot.parentNode.insertBefore(lightNode, slot));
// remove slot element
if (slot) {
slot.parentNode.removeChild(slot);
childNodes.forEach((childNode) => {
if (childNode instanceof HTMLElement) {
if (childNode.tagName === 'STYLE') {
childNode.textContent = prependCss(nodeUUID, childNode.textContent);
} else {
serializeNode(childNode, logThis);
}
noteForAppending.push(childNode);
}
});
while (nodeArg.firstChild) {
nodeArg.removeChild(nodeArg.firstChild);
}
// move shadowDom into root node
node.shadowRoot.childNodes.forEach(shadowNode => node.appendChild(shadowNode));
// add original lightDom as template
if (templateDom.innerHTML !== '') {
node.appendChild(templateDom);
}
} catch (err) {
console.log('error:', err.message);
console.log(node.tagName);
noteForAppending.forEach((childNode) => {
nodeArg.append(childNode);
});
} else {
nodeArg.childNodes.forEach((nodeArg2: any) => {
serializeNode(nodeArg2, logThis);
});
}
}
[...rootNode.querySelectorAll('*')]
.filter(element => /-/.test(element.nodeName))
.forEach(serializeNode);
rootNode.childNodes.forEach((nodeArg) => {
serializeNode(nodeArg);
});
}

View File

@ -8,5 +8,6 @@ import * as smartdelay from '@pushrocks/smartdelay';
import * as smartfile from '@pushrocks/smartfile';
import * as smartpuppeteer from '@pushrocks/smartpuppeteer';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smarttime from '@pushrocks/smarttime';
export { smartdelay, smartfile, smartpuppeteer, smartpromise };
export { smartdelay, smartfile, smartpuppeteer, smartpromise, smarttime };