Compare commits

...

8 Commits

Author SHA1 Message Date
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
10 changed files with 9880 additions and 545 deletions

4
.gitignore vendored
View File

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

View File

@ -19,22 +19,23 @@ mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- lossless - lossless
- docker - docker
- notpriv - notpriv
snyk: audit:
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install --ignore-scripts - 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
tags: tags:
- lossless
- docker - docker
- notpriv
# ==================== # ====================
# test stage # test stage
@ -49,9 +50,7 @@ testStable:
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- priv
testBuild: testBuild:
stage: test stage: test
@ -62,9 +61,7 @@ testBuild:
- npmci command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- notpriv
release: release:
stage: release stage: release
@ -84,6 +81,8 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g tslint typescript
- npmci npm prepare - npmci npm prepare

View File

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

10197
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +1,10 @@
{ {
"name": "@pushrocks/smartssr", "name": "@pushrocks/smartssr",
"version": "1.0.7", "version": "1.0.13",
"private": false, "private": false,
"description": "a smart server side renderer supporting shadow dom", "description": "a smart server side renderer supporting shadow dom",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
@ -13,29 +13,34 @@
"format": "(gitzone format)" "format": "(gitzone format)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.0.22", "@gitzone/tsbuild": "^2.1.24",
"@gitzone/tstest": "^1.0.15", "@gitzone/tstest": "^1.0.43",
"@pushrocks/tapbundle": "^3.0.7", "@pushrocks/smartserve": "^1.1.41",
"@types/node": "^13.7.4", "@pushrocks/tapbundle": "^3.2.9",
"tslint": "^6.0.0", "@types/node": "^14.0.27",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0" "tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartdelay": "^2.0.6", "@pushrocks/smartdelay": "^2.0.10",
"@pushrocks/smartfile": "^7.0.8", "@pushrocks/smartfile": "^7.0.12",
"@pushrocks/smartpromise": "^3.0.6", "@pushrocks/smartpromise": "^3.0.6",
"@pushrocks/smartpuppeteer": "^1.0.15", "@pushrocks/smartpuppeteer": "^1.0.15",
"@pushrocks/smarttime": "^3.0.12" "@pushrocks/smarttime": "^3.0.24"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
"ts_web/**/*", "ts_web/**/*",
"dist/**/*", "dist/**/*",
"dist_web/**/*", "dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*", "dist_ts_web/**/*",
"assets/**/*", "assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "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/) * [docs (typedoc)](https://pushrocks.gitlab.io/smartssr/)
## Status for master ## 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) Status Category | Status Badge
[![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) GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartssr/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartssr/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartssr)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) 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 ## 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,18 +4,22 @@ import * as smartssr from '../ts/index';
let testSSRInstance: smartssr.SmartSSR; let testSSRInstance: smartssr.SmartSSR;
tap.test('should create a valid smartssr instance', async () => { 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 () => { tap.test('should start the smartssr instance', async () => {
await testSSRInstance.start(); await testSSRInstance.start();
}); });
tap.test('should render central.eu', async tools => { tap.test('should render central.eu', async (tools) => {
await testSSRInstance.renderPage('https://central.eu'); await testSSRInstance.renderPage(
'https://central.eu/article/5e76873b9cf69b7bf6bc78bc/Introducing%3A%20central.eu'
);
}); });
tap.test('should render lossless.com', async () => { tap.skip.test('should render lossless.com', async () => {
await testSSRInstance.renderPage('https://lossless.com'); await testSSRInstance.renderPage('https://lossless.com');
}); });

View File

@ -3,11 +3,26 @@ import * as paths from './smartssr.paths';
import { serializeFunction } from './smartssr.function.serialize'; import { serializeFunction } from './smartssr.function.serialize';
export interface ISmartSSROptions {
debug: boolean;
}
/** /**
* *
*/ */
export class SmartSSR { export class SmartSSR {
public browser: plugins.smartpuppeteer.puppeteer.Browser; public browser: plugins.smartpuppeteer.puppeteer.Browser;
public options: ISmartSSROptions;
constructor(optionsArg?: ISmartSSROptions) {
this.options = {
...{
debug: false,
},
...optionsArg,
};
}
public async start() { public async start() {
this.browser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance(); this.browser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance();
} }
@ -27,20 +42,33 @@ export class SmartSSR {
const resultDeferred = plugins.smartpromise.defer<string>(); const resultDeferred = plugins.smartpromise.defer<string>();
const context = await this.browser.createIncognitoBrowserContext(); const context = await this.browser.createIncognitoBrowserContext();
const page = await context.newPage(); const page = await context.newPage();
page.on('console', msg => { page.on('console', (msg) => {
console.log(`${urlArg}: ${msg.text()}`); console.log(`${urlArg}: ${msg.text()}`);
}); });
page.on('load', async (...args) => { page.on('load', async (...args) => {
// await plugins.smartdelay.delayFor(2000); await plugins.smartdelay.delayFor(5000);
let screenshotBuffer: Buffer;
if (this.options.debug) {
screenshotBuffer = await page.screenshot({
encoding: 'binary',
});
}
await page.$eval('body', serializeFunction); await page.$eval('body', serializeFunction);
const pageContent = await page.content(); const pageContent = await page.content();
const renderedPageString = pageContent; const renderedPageString = pageContent;
resultDeferred.resolve(renderedPageString); resultDeferred.resolve(renderedPageString);
plugins.smartfile.memory.toFsSync(
renderedPageString, if (this.options.debug) {
plugins.path.join(paths.noGitDir, 'test.html') 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);
}
}); });
const renderTimeMeasurement = new plugins.smarttime.HrtMeasurement(); const renderTimeMeasurement = new plugins.smarttime.HrtMeasurement();
@ -53,8 +81,12 @@ export class SmartSSR {
context.close(); context.close();
overallTimeMeasurement.stop(); overallTimeMeasurement.stop();
console.log(`Overall it took ${overallTimeMeasurement.milliSeconds} milliseconds to render ${urlArg}`); console.log(
console.log(`The rendering alone took ${renderTimeMeasurement.milliSeconds} milliseconds for ${urlArg}`) `Overall it took ${overallTimeMeasurement.milliSeconds} milliseconds to render ${urlArg}`
);
console.log(
`The rendering alone took ${renderTimeMeasurement.milliSeconds} milliseconds for ${urlArg}`
);
return result; return result;
} }
} }

View File

@ -1,7 +1,7 @@
declare var document: Document; declare var document: Document;
export function serializeFunction(rootNode) { export function serializeFunction(rootNode) {
const uuidv4 = () => { const uuidv4 = () => {
return 'unixxxxxxxxxxx'.replace(/[xy]/g, c => { return 'unixxxxxxxxxxx'.replace(/[xy]/g, (c) => {
const r = (Math.random() * 16) | 0; const r = (Math.random() * 16) | 0;
const v = c === 'x' ? r : (r & 0x3) | 0x8; const v = c === 'x' ? r : (r & 0x3) | 0x8;
return v.toString(16); return v.toString(16);
@ -24,55 +24,57 @@ export function serializeFunction(rootNode) {
styleTemplate = styleTemplate.replace(/}[ \t\n]+div/g, `}\n\n.${uuidID} div`); styleTemplate = styleTemplate.replace(/}[ \t\n]+div/g, `}\n\n.${uuidID} div`);
return styleTemplate; return styleTemplate;
}; };
const loopProtection: any[] = [];
function serializeNode(node: HTMLElement) { function serializeNode(nodeArg: HTMLElement, logThis = false) {
if (!node.tagName.includes('-')) { if (loopProtection.includes(nodeArg)) {
return; return;
} }
if (node.hasAttribute('smartssr')) { loopProtection.push(nodeArg);
console.log(`${node.tagName} is already serialized`); // console.log(nodeArg.nodeName);
return; if (nodeArg.shadowRoot) {
} nodeArg.setAttribute('smartssr', 'yes');
node.setAttribute('smartssr', 'yes');
// lets handle the current node
const nodeUUID = uuidv4();
try { // lets handle the current node
node.classList.add(nodeUUID); const nodeUUID = uuidv4();
nodeArg.classList.add(nodeUUID);
const slots = nodeArg.shadowRoot.querySelectorAll('slot');
// handle slot element
slots.forEach((slot) => {
nodeArg.childNodes.forEach((lightNode) => slot.parentNode.insertBefore(lightNode, slot));
slot.parentNode.removeChild(slot);
});
// lets modify the css // lets modify the css
const children: HTMLElement[] = node.shadowRoot.children as any; const childNodes = nodeArg.shadowRoot.childNodes;
for (const childElement of children) { // tslint:disable-next-line: prefer-for-of
if (childElement.tagName === 'STYLE') { const noteForAppending: HTMLElement[] = [];
childElement.textContent = prependCss(nodeUUID, childElement.textContent); childNodes.forEach((childNode) => {
if (childNode instanceof HTMLElement) {
if (childNode.tagName === 'STYLE') {
childNode.textContent = prependCss(nodeUUID, childNode.textContent);
} else {
if (nodeArg.tagName?.includes('ARTICLEGRID')) {
console.log('hello ' + childNode.id);
}
serializeNode(childNode, logThis);
}
noteForAppending.push(childNode);
} }
serializeFunction(childElement); });
} noteForAppending.forEach((childNode) => {
nodeArg.append(childNode);
const templateDom = document.createElement('template'); });
templateDom.innerHTML = node.innerHTML; } else {
nodeArg.childNodes.forEach((nodeArg2: any) => {
const slot = node.shadowRoot.querySelector('slot'); serializeNode(nodeArg2, logThis);
node.childNodes.forEach(lightNode => slot.parentNode.insertBefore(lightNode, slot)); });
// remove slot element
if (slot) {
slot.parentNode.removeChild(slot);
}
// 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);
} }
} }
[...rootNode.querySelectorAll('*')] rootNode.childNodes.forEach((nodeArg) => {
.filter(element => /-/.test(element.nodeName)) serializeNode(nodeArg);
.forEach(serializeNode); });
} }