1.0.33

.gitignore

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

.gitlab-ci.yml

@@ -7,41 +7,10 @@ cache:
   key: '$CI_BUILD_STAGE'
 
 stages:
-  - security
+  - only
-  - test
-  - release
-  - metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# test stage
-# ====================
 
 testStable:
-  stage: test
+  stage: only
   script:
     - npmci npm prepare
     - npmci node install stable
@@ -49,78 +18,5 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/smartpuppeteer",
-  "version": "1.0.10",
+  "version": "1.0.33",
   "private": false,
   "description": "simplified access to puppeteer",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
@@ -13,27 +13,32 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.28",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.59",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^12.12.7",
+    "@types/node": "^16.11.6",
-    "tslint": "^5.20.1",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartenv": "^4.0.8",
+    "@pushrocks/smartdelay": "^2.0.13",
-    "@types/puppeteer": "^1.20.2",
+    "@pushrocks/smartenv": "^4.0.16",
-    "puppeteer": "^2.0.0"
+    "puppeteer": "^11.0.0",
+    "tree-kill": "^1.2.2"
   },
   "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"
   ]
 }

readme.md

@@ -8,20 +8,31 @@ simplified access to puppeteer
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartpuppeteer/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartpuppeteer/badges/master/build.svg)](https://gitlab.com/pushrocks/smartpuppeteer/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartpuppeteer/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartpuppeteer/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartpuppeteer.svg)](https://www.npmjs.com/package/@pushrocks/smartpuppeteer)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartpuppeteer/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartpuppeteer)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartpuppeteer/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/smartpuppeteer/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/smartpuppeteer)](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/smartpuppeteer)](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/smartpuppeteer)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartpuppeteer)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartpuppeteer)](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
 
-## Contribution
+Use TypeScript for best in class intellisense.
-
-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
 
+```typescript
+const headlessBrowser = await smartpuppeteer.getEnvAwareBrowserInstance({
+  forceNoSandbox: true, // if you really want no sandbox, you can do this. Otherwise its starting things as necessary
+});
+await headlessBrowser.close();
+```
 
 ## Contribution
 

test/test.ts

@@ -1,11 +1,19 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartpuppeteer from '../ts/index';
 
-tap.test('first test', async () => {
+tap.test('first test', async (tools) => {
   const headlessBrowser = await smartpuppeteer.getEnvAwareBrowserInstance({
-    forceNoSandbox: true
+    forceNoSandbox: true,
   });
+  const page = await headlessBrowser.newPage();
   await headlessBrowser.close();
 });
 
+tap.test('should get and stop an Incognito browser', async () => {
+  const incognitoInstance = new smartpuppeteer.IncognitoBrowser();
+  await incognitoInstance.start();
+  const page = await incognitoInstance.browser.newPage();
+  await incognitoInstance.stop();
+});
+
 tap.start();

ts/index.ts

@@ -1,6 +1,7 @@
 // module exports
 
 export * from './smartpuppeteer.classes.smartpuppeteer';
+export * from './smartpuppeteer.classes.incognitobrowser';
 
 // direct exports
 import { puppeteer } from './smartpuppeteer.plugins';

ts/smartpuppeteer.classes.incognitobrowser.ts

@@ -0,0 +1,50 @@
+import { getEnvAwareBrowserInstance } from './smartpuppeteer.classes.smartpuppeteer';
+import * as plugins from './smartpuppeteer.plugins';
+
+export class IncognitoBrowser {
+  public status: 'started' | 'stopped' = 'stopped';
+  public browser: plugins.puppeteer.Browser;
+
+  constructor() {}
+
+  /**
+   * starts the IncognitoBrowser
+   */
+  public async start() {
+    this.status = 'started';
+    this.browser = await getEnvAwareBrowserInstance();
+    this.browser.on('disconnected', async (eventArg) => {
+      try {
+        this.browser.removeAllListeners();
+      } catch (err) {}
+      if (this.status === 'started') {
+        this.browser = await getEnvAwareBrowserInstance();
+      }
+    });
+  }
+
+  /**
+   * stops the IncognitoBrowser
+   */
+  public async stop() {
+    this.status = 'stopped';
+    plugins.treeKill(this.browser.process().pid, 'SIGKILL');
+    await this.browser.close();
+  }
+
+  /**
+   * rotate
+   */
+  public async rotateBrowser() {
+    this.browser.close().catch();
+    this.browser = await getEnvAwareBrowserInstance();
+  }
+
+  public async getNewIncognitoContext(): Promise<plugins.puppeteer.BrowserContext> {
+    if (this.browser) {
+      return this.browser.createIncognitoBrowserContext();
+    } else {
+      throw new Error('you need to start the IncognitoBrowser instance first');
+    }
+  }
+}

ts/smartpuppeteer.classes.smartpuppeteer.ts

@@ -10,41 +10,25 @@ export const getEnvAwareBrowserInstance = async (
   const smartenv = new plugins.smartenv.Smartenv();
   const options: IEnvAwareOptions = {
     ...{
-      forceNoSandbox: false
+      forceNoSandbox: false,
     },
-    ...optionsArg
+    ...optionsArg,
   };
 
   let chromeArgs: string[] = [];
-  if ((process.env.CI || options.forceNoSandbox) && !smartenv.isWsl) {
+  if (process.env.CI || options.forceNoSandbox || plugins.os.userInfo().username === 'root') {
-    chromeArgs = chromeArgs.concat([
+    chromeArgs = chromeArgs.concat(['--no-sandbox', '--disable-setuid-sandbox']);
-      '--no-sandbox',
-      '--disable-setuid-sandbox',
-      // '--disable-dev-shm-usage'
-    ]);
   }
 
   let headlessBrowser: plugins.puppeteer.Browser;
-  if (!smartenv.isWsl) {
+  console.log('launching puppeteer bundled chrome with arguments:');
-    // lets get the actual instance
+  console.log(chromeArgs);
-    console.log('launching puppeteer bundled chrome');
+  headlessBrowser = await plugins.puppeteer.launch({
-    headlessBrowser = await plugins.puppeteer.launch({
+    args: chromeArgs,
-      args: chromeArgs
+    pipe: true,
-    });
+    headless: true,
-  } else {
+    // executablePath: '/usr/bin/google-chrome'
-    console.log('Detected WSL. Using chromium.');
+  });
-    headlessBrowser = await plugins.puppeteer.launch({
-      args: [
-        '--disable-gpu',
-        '--disable-dev-shm-usage',
-        '--disable-setuid-sandbox',
-        '--no-first-run',
-        '--no-sandbox',
-        '--no-zygote',
-        '--single-process'
-      ]
-    });
-  }
 
   return headlessBrowser;
 };

ts/smartpuppeteer.plugins.ts

@@ -1,9 +1,16 @@
+// node native scope
+import * as os from 'os';
+
+export { os };
+
 // @pushrocks scope
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartenv from '@pushrocks/smartenv';
 
-export { smartenv };
+export { smartdelay, smartenv };
 
 // third party scope
 import puppeteer from 'puppeteer';
+import treeKill from 'tree-kill';
 
-export { puppeteer };
+export { puppeteer, treeKill };