Merge pull request #18 from qlik-oss/DEB-133

Aligned build to Dashboard bundle extension builds

.circleci/config.yml

@@ -26,9 +26,6 @@ jobs:
             --blackduck.username="svc-blackduck" \
             --blackduck.password=${svc_blackduck} \
             --detect.project.name="viz-bundle-qlik-network-chart"
-      - run:
-          name: Run tests
-          command: npm run test-once
 
   bump-version:
     <<: *defaults
@@ -56,16 +53,18 @@ jobs:
           command: |
             export VERSION=$(scripts/get-bumped-version.sh)
             echo "Version: ${VERSION}"
-            npm run build
+            npm run build:zip
+            sudo chmod +x scripts/verify-files.sh
+            scripts/verify-files.sh
           environment:
             NODE_ENV: production
       - persist_to_workspace:
           root: ~/qlik-network-chart
           paths:
-            - build
+            - dist
       - store_artifacts:
-          path: build
-          destination: build
+          path: dist
+          destination: dist
   deploy:
     <<: *defaults
     steps:

.gitignore

@@ -1,3 +1,3 @@
 node_modules/
-build/
+dist/
 BUMPED_VERSION

gulpfile.js

@@ -1,24 +1,61 @@
 var gulp = require('gulp');
+var gutil = require('gulp-util');
 var zip = require('gulp-zip');
 var del = require('del');
-var settings = require('./settings');
 var webpackConfig = require('./webpack.config');
 var webpack = require('webpack');
-var WebpackDevServer = require('webpack-dev-server');
-var jeditor = require("gulp-json-editor");
+var pkg = require('./package.json');
 
-gulp.task('remove-build-folder', function(){
-  return del([settings.buildDestination], { force: true });
+var DIST = './dist';
+var VERSION = process.env.VERSION || 'local-dev';
+
+gulp.task('qext', function () {
+	var qext = {
+		name: 'Network chart',
+		type: 'visualization',
+		description: pkg.description + '\nVersion: ' + VERSION,
+		version: VERSION,
+		icon: 'bubbles',
+		preview: 'network.png',
+		keywords: 'qlik-sense, visualization',
+		author: pkg.author,
+		homepage: pkg.homepage,
+		license: pkg.license,
+		repository: pkg.repository,
+		dependencies: {
+			'qlik-sense': '>=5.5.x'
+		}
+	};
+	if (pkg.contributors) {
+		qext.contributors = pkg.contributors;
+	}
+	var src = require('stream').Readable({
+		objectMode: true
+	});
+	src._read = function () {
+		this.push(new gutil.File({
+			cwd: '',
+			base: '',
+			path: pkg.name + '.qext',
+			contents: Buffer.from(JSON.stringify(qext, null, 4))
+		}));
+		this.push(null);
+	};
+	return src.pipe(gulp.dest(DIST));
+});
+
+gulp.task('clean', function(){
+  return del([DIST], { force: true });
 });
 
 gulp.task('zip-build', function(){
-  return gulp.src(settings.buildDestination + '/**/*')
-    .pipe(zip(`${settings.name}_${settings.version}.zip`))
-    .pipe(gulp.dest(settings.buildDestination));
+  return gulp.src(DIST + '/**/*')
+    .pipe(zip(`${pkg.name}_${VERSION}.zip`))
+    .pipe(gulp.dest(DIST));
 });
 
 gulp.task('add-assets', function(){
-  return gulp.src("./assets/**/*").pipe(gulp.dest(settings.buildDestination));
+  return gulp.src('./assets/**/*').pipe(gulp.dest(DIST));
 });
 
 gulp.task('webpack-build', done => {
@@ -37,39 +74,13 @@ gulp.task('webpack-build', done => {
   });
 });
 
-gulp.task('update-qext-version', function () {
-  return gulp.src(`${settings.buildDestination}/${settings.name}.qext`)
-    .pipe(jeditor({
-      'version': settings.version
-    }))
-    .pipe(gulp.dest(settings.buildDestination));
-});
-
 gulp.task('build',
-  gulp.series('remove-build-folder', 'webpack-build', 'update-qext-version', 'add-assets', 'zip-build')
+  gulp.series('clean', 'webpack-build', 'qext', 'add-assets')
 );
 
-gulp.task('watch', () => new Promise((resolve, reject) => {
-  webpackConfig.entry.unshift('webpack-dev-server/client?http://localhost:' + settings.port);
-  const compiler = webpack(webpackConfig);
-  const originalOutputFileSystem = compiler.outputFileSystem;
-  const devServer = new WebpackDevServer(compiler, {
-    headers: {
-      "Access-Control-Allow-Origin": "*"
-    },
-  }).listen(settings.port, 'localhost', error => {
-    compiler.outputFileSystem = originalOutputFileSystem;
-    if (error) {
-      console.error(error); // eslint-disable-line no-console
-      return reject(error);
-    }
-
-    // eslint-disable-next-line no-console
-    console.log('Listening at localhost:' + settings.port);
-
-    resolve(null, devServer);
-  });
-}));
+gulp.task('zip',
+  gulp.series('build', 'zip-build')
+);
 
 gulp.task('default',
   gulp.series('build')

karma.conf.js

@@ -1,43 +0,0 @@
-const settings = require('./settings');
-
-module.exports = (config) => {
-  config.set({
-    browsers: ['SlimChromeHeadless'],
-    customLaunchers: {
-      SlimChromeHeadless: {
-        base: 'ChromeHeadless',
-        flags: ['--headless', '--disable-gpu', '--disable-translate', '--disable-extensions']
-      }
-    },
-    files: [
-      { pattern: 'src/*.spec.js', watched: false }
-    ],
-    frameworks: ['jasmine'],
-    preprocessors: {
-      'src/*.spec.js': ['webpack', 'sourcemap']
-    },
-    webpack: {
-      devtool: 'source-map',
-      mode: settings.mode,
-      externals: {
-        qlik: {
-          amd: 'qlik',
-          commonjs: 'qlik',
-          commonjs2: 'qlik',
-          root: '_'
-        }
-      },
-      module: {
-        rules: [
-          {
-            test: /\.js$/,
-            exclude: [/node_modules/],
-            loaders: ['babel-loader']
-          },
-          { test: /\.less$/, loader: 'ignore-loader' },
-          { test: /\.json$/, loader: 'ignore-loader' }
-        ]
-      }
-    }
-  });
-};

package.json

@@ -1,18 +1,15 @@
 {
   "name": "qlik-network-chart",
   "version": "0.0.1",
-  "description": "Network chart",
-  "keywords": "network chart qliksense extension",
+  "description": "Displays hierarchical or relational dimensions as nodes and edges´, with measures to show the significance of its links.",
+  "homepage": "",
   "repository": "https://github.com/qlik-oss/network-vis-chart",
   "author": "Michael Laenen (miclae76) <m.laenen@contactoffice.net>",
   "license": "MIT",
   "scripts": {
     "build": "gulp build",
-    "eslint": "eslint src",
-    "eslint:fix": "eslint --fix src",
-    "test": "karma start karma.conf.js",
-    "test-once": "karma start karma.conf.js --single-run",
-    "watch": "gulp watch"
+    "build:zip": "gulp zip",
+    "eslint": "eslint src"
   },
   "devDependencies": {
     "@babel/core": "7.1.5",
@@ -20,29 +17,20 @@
     "@babel/preset-env": "7.1.5",
     "babel-eslint": "10.0.1",
     "babel-loader": "8.0.4",
-    "copy-webpack-plugin": "4.6.0",
     "css-loader": "1.0.1",
     "del": "3.0.0",
     "eslint": "5.8.0",
     "eslint-loader": "2.1.1",
     "file-loader": "2.0.0",
     "gulp": "4.0.0",
-    "gulp-json-editor": "2.4.3",
+    "gulp-util": "^3.0.7",
     "gulp-zip": "4.2.0",
-    "jasmine-core": "3.3.0",
-    "karma": "3.1.1",
-    "karma-chrome-launcher": "2.2.0",
-    "karma-jasmine": "1.1.2",
-    "karma-sourcemap-loader": "0.3.7",
-    "karma-webpack": "3.0.5",
     "less": "3.8.1",
     "less-loader": "4.1.0",
     "style-loader": "0.23.1",
     "stylelint": "9.7.1",
     "stylelint-webpack-plugin": "0.10.5",
-    "webpack": "4.25.1",
-    "webpack-cli": "3.1.2",
-    "webpack-dev-server": "3.1.10"
+    "webpack": "4.25.1"
   },
   "dependencies": {
     "vis": "4.21.0"

scripts/create-release.sh

@@ -2,8 +2,8 @@
 set -o errexit
 
 echo "Creating release for version: $VERSION"
-echo "Artifact name: ./build/${3}_${VERSION}.zip"
-$HOME/bin/ghr -t ${ghoauth} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} ${VERSION} "./build/${3}_${4}.zip"
+echo "Artifact name: ./dist/${3}_${VERSION}.zip"
+$HOME/bin/ghr -t ${ghoauth} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} ${VERSION} "./dist/${3}_${4}.zip"
 
 
 # Usage

scripts/verify-files.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# The build script has a known race-condition that sometimes causes it to not include all files
+# in the built zip. This script verifies the that the zip contains the correct number of files.
+
+set -o errexit
+
+echo "Verifying built file count"
+
+while read line; do
+    if [[ $line =~ ^\"name\": ]]; then
+        name=${line#*: \"}
+        name=${name%\"*}
+    fi
+done < package.json
+
+expected_file_count=$(($(find dist -type f | wc -l)-1))
+zip_file_count=$(zipinfo dist/${name}_${VERSION}.zip | grep ^- | wc -l)
+
+if [ "${expected_file_count}" -ne "${zip_file_count}" ]; then
+    # File count is incorrect
+    echo "Expected file count ${expected_file_count}, but was ${zip_file_count}"
+    exit 1
+fi
+echo "File count OK"
+exit 0

settings.js

@@ -1,13 +0,0 @@
-const path = require('path');
-const packageJSON = require('./package.json');
-
-const defaultBuildDestination = path.resolve("./build");
-
-module.exports = {
-  buildDestination: process.env.BUILD_PATH || defaultBuildDestination,
-  mode: process.env.NODE_ENV || 'development',
-  name: packageJSON.name,
-  version: process.env.VERSION || 'local-dev',
-  url: process.env.BUILD_URL || defaultBuildDestination,
-  port: 8082
-};

src/paint.spec.js

@@ -1,7 +0,0 @@
-import paint from './paint';
-
-describe('paint', () => {
-  it('should be defined', () => {
-    expect(paint).toBeDefined();
-  });
-});

src/qlik-network-chart.qext

@@ -1,16 +0,0 @@
-{
-	"name" : "Network chart",
-	"description" : "Displays hierarchical or relational dimensions as nodes and edges´, with measures to show the significance of its links.",
-	"icon" : "bubbles",
-	"type" : "visualization",
-	"version": "X.Y.Z",
-	"preview" : "network.png",
-	"keywords": "qlik-sense, visualization",
-	"author": "Michael Laenen <michael.laenen@agilos.com>",
-	"homepage": "",
-	"license": "MIT",
-	"repository": "",
-	"dependencies": {
-      "qlik-sense": ">=5.5.x"
-  }
-}

webpack.config.js

@@ -1,20 +1,23 @@
-const CopyWebpackPlugin = require('copy-webpack-plugin');
 const StyleLintPlugin = require('stylelint-webpack-plugin');
-const settings = require('./settings');
+const packageJSON = require('./package.json');
+const path = require('path');
 const webpack = require('webpack');
 
-console.log('Webpack mode:', settings.mode); // eslint-disable-line no-console
+const DIST = path.resolve("./dist");
+const MODE = process.env.NODE_ENV || 'development';
+
+console.log('Webpack mode:', MODE); // eslint-disable-line no-console
 
 const config = {
   devtool: 'source-map',
   entry: [
     './src/index.js'
   ],
-  mode: settings.mode,
+  mode: MODE,
   output: {
-    path: settings.buildDestination,
-    filename: settings.name + '.js',
-    libraryTarget: 'umd'
+    filename: `${packageJSON.name}.js`,
+    libraryTarget: 'amd',
+    path: DIST
   },
   externals: {
     qlik: {
@@ -71,9 +74,6 @@ const config = {
     ]
   },
   plugins: [
-    new CopyWebpackPlugin([
-      'src/' + settings.name + '.qext'
-    ], {}),
     new StyleLintPlugin(),
     new webpack.ContextReplacementPlugin(/moment[\\\/]locale$/, /^\.\/en$/),
   ]