1.0.15

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,10 +18,11 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 snyk:
   stage: security
@@ -31,89 +32,89 @@ snyk:
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   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:
@@ -121,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartpuppeteer",
-  "version": "1.0.2",
+  "version": "1.0.15",
   "private": false,
   "description": "simplified access to puppeteer",
   "main": "dist/index.js",
@@ -9,24 +9,30 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^13.7.4",
+    "tslint": "^6.0.0",
     "tslint-config-prettier": "^1.15.0"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@pushrocks/smartdelay": "^2.0.6",
+    "@pushrocks/smartenv": "^4.0.8",
+    "@types/puppeteer": "^2.0.0",
+    "puppeteer": "^2.1.1"
+  },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -18,9 +18,22 @@ simplified access to puppeteer
 
 ## Usage
 
+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
+
+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). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,8 +1,11 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartpuppeteer from '../ts/index';
 
-tap.test('first test', async () => {
-  console.log(smartpuppeteer.standardExport);
+tap.test('first test', async tools => {
+  const headlessBrowser = await smartpuppeteer.getEnvAwareBrowserInstance({
+    forceNoSandbox: true
+  });
+  await headlessBrowser.close();
 });
 
 tap.start();

ts/index.ts

@@ -1,3 +1,7 @@
-import * as plugins from './smartpuppeteer.plugins';
+// module exports
 
-export let standardExport = 'Hi there! :) This is an exported string';
+export * from './smartpuppeteer.classes.smartpuppeteer';
+
+// direct exports
+import { puppeteer } from './smartpuppeteer.plugins';
+export { puppeteer };

ts/smartpuppeteer.classes.smartpuppeteer.ts

@@ -0,0 +1,34 @@
+import * as plugins from './smartpuppeteer.plugins';
+
+export interface IEnvAwareOptions {
+  forceNoSandbox?: boolean;
+}
+
+export const getEnvAwareBrowserInstance = async (
+  optionsArg: IEnvAwareOptions = {}
+): Promise<plugins.puppeteer.Browser> => {
+  const smartenv = new plugins.smartenv.Smartenv();
+  const options: IEnvAwareOptions = {
+    ...{
+      forceNoSandbox: false
+    },
+    ...optionsArg
+  };
+
+  let chromeArgs: string[] = [];
+  if ((process.env.CI || options.forceNoSandbox || plugins.os.userInfo().username === 'root') && !smartenv.isWsl) {
+    chromeArgs = chromeArgs.concat(['--no-sandbox', '--disable-setuid-sandbox']);
+  } else if (smartenv.isWsl) {
+    console.log('Detected WSL.');
+    chromeArgs = chromeArgs.concat(['--no-sandbox', '--single-process']);
+  }
+
+  let headlessBrowser: plugins.puppeteer.Browser;
+  console.log('launching puppeteer bundled chrome with arguments:');
+  console.log(chromeArgs);
+  headlessBrowser = await plugins.puppeteer.launch({
+    args: chromeArgs
+  });
+
+  return headlessBrowser;
+};

ts/smartpuppeteer.plugins.ts

@@ -1,2 +1,17 @@
-const removeme = {};
-export { removeme };
+// 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 { smartdelay, smartenv };
+
+// third party scope
+import puppeteer from 'puppeteer';
+
+export { puppeteer };