2.0.0

.gitignore

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

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,22 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - 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:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -49,9 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,6 +97,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.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,39 +1,44 @@
 {
   "name": "@pushrocks/smartpuppeteer",
-  "version": "1.0.9",
+  "version": "2.0.0",
   "private": false,
   "description": "simplified access to puppeteer",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "test": "tstest test/",
+    "build": "tsbuild --web --allowimplicitany"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.12.7",
-    "tslint": "^5.20.1",
+    "@gitzone/tsbuild": "^2.1.60",
+    "@gitzone/tstest": "^1.0.69",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^17.0.23",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartenv": "^4.0.8",
-    "@types/puppeteer": "^1.20.2",
-    "puppeteer": "^2.0.0"
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartshell": "^2.0.30",
+    "puppeteer": "^13.5.1",
+    "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)
-[![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)
-[![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/smartpuppeteer/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartpuppeteer/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartpuppeteer)](https://lossless.cloud)
+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
-
-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). :)
+Use TypeScript for best in class intellisense.
 
+```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';
+import * as smartpuppeteer from '../ts/index.js';
 
-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,7 +1,8 @@
 // module exports
 
-export * from './smartpuppeteer.classes.smartpuppeteer';
+export * from './smartpuppeteer.classes.smartpuppeteer.js';
+export * from './smartpuppeteer.classes.incognitobrowser.js';
 
 // direct exports
-import { puppeteer } from './smartpuppeteer.plugins';
+import { puppeteer } from './smartpuppeteer.plugins.js';
 export { puppeteer };

ts/smartpuppeteer.classes.incognitobrowser.ts

@@ -0,0 +1,50 @@
+import { getEnvAwareBrowserInstance } from './smartpuppeteer.classes.smartpuppeteer.js';
+import * as plugins from './smartpuppeteer.plugins.js';
+
+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

@@ -1,4 +1,4 @@
-import * as plugins from './smartpuppeteer.plugins';
+import * as plugins from './smartpuppeteer.plugins.js';
 
 export interface IEnvAwareOptions {
   forceNoSandbox?: boolean;
@@ -7,44 +7,34 @@ export interface IEnvAwareOptions {
 export const getEnvAwareBrowserInstance = async (
   optionsArg: IEnvAwareOptions = {}
 ): Promise<plugins.puppeteer.Browser> => {
-  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) {
-    chromeArgs = chromeArgs.concat([
-      '--no-sandbox',
-      '--disable-setuid-sandbox',
-      '--disable-dev-shm-usage'
-    ]);
+  if (process.env.CI || options.forceNoSandbox || plugins.os.userInfo().username === 'root') {
+    chromeArgs = chromeArgs.concat(['--no-sandbox', '--disable-setuid-sandbox']);
   }
 
   let headlessBrowser: plugins.puppeteer.Browser;
-  if (!smartenv.isWsl) {
-    // lets get the actual instance
-    console.log('launching puppeteer bundled chrome');
-    headlessBrowser = await plugins.puppeteer.launch({
-      args: chromeArgs
-    });
-  } else {
-    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'
-      ]
-    });
-  }
+  console.log('launching puppeteer bundled chrome with arguments:');
+  console.log(chromeArgs);
+  headlessBrowser = await plugins.puppeteer.launch({
+    args: chromeArgs,
+    pipe: true,
+    headless: true,
+    ...(() => {
+      const returnObject: any = {};
+      const googleChrome = plugins.smartshell.which.sync('google-chrome');
+      if (googleChrome) {
+        returnObject.executablePath = googleChrome;
+      }
+      return returnObject;
+    })(),
+  });
 
   return headlessBrowser;
 };

ts/smartpuppeteer.plugins.ts

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