Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(client): check in bundled client code into version control #3524

Merged
merged 1 commit into from
Aug 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
node_modules
npm-debug.log
static/context.js
static/karma.js
.idea/*
*.iml
docs/_build
Expand Down
4 changes: 1 addition & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ jobs:
- node_js: "10"
script:
- npm run init
- npm run build
- npm run test:unit
- npm run test:e2e

- node_js: "12"
script:
- npm run init
- npm run build
- npm run test:unit
- npm run test:e2e

Expand All @@ -23,7 +21,7 @@ jobs:
- npm run init
- commitlint-travis
- npm run lint
- npm run build
- npm run build:check
- npm run test:unit
- npm run test:e2e
- npm run test:client
Expand Down
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ install:
- npm run init:windows

test_script:
- npm run appveyor
- npm run test:appveyor

build: off

Expand Down
2 changes: 0 additions & 2 deletions docs/dev/02-making-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ Here are some tips on how to set up a Karma workspace and how to send a good pul
$ npm run init
# or if you're on Windows
$ npm run init:windows

$ npm run build
```

## Testing and Building
Expand Down
5 changes: 0 additions & 5 deletions lib/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ const tmp = require('tmp')
const fs = require('fs')
const path = require('path')

const BundleUtils = require('./utils/bundle-utils')
const NetUtils = require('./utils/net-utils')
const root = global || window || this

Expand Down Expand Up @@ -116,10 +115,6 @@ class Server extends KarmaEventEmitter {
async start () {
const config = this.get('config')
try {
await Promise.all([
BundleUtils.bundleResourceIfNotExist('client/main.js', 'static/karma.js'),
BundleUtils.bundleResourceIfNotExist('context/main.js', 'static/context.js')
])
this._boundServer = await NetUtils.bindAvailablePort(config.port, config.listenAddress)
this._boundServer.on('connection', (socket) => {
// Attach an error handler to avoid UncaughtException errors.
Expand Down
26 changes: 0 additions & 26 deletions lib/utils/bundle-utils.js

This file was deleted.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -491,14 +491,14 @@
"test:e2e": "cucumber-js test/e2e/*.feature",
"test:client": "grunt test:client",
"test": "npm run test:unit && npm run test:e2e && npm run test:client",
"build": "grunt build",
"build": "node scripts/client.js build",
"build:check": "node scripts/client.js check",
"test:appveyor": "grunt test-appveyor",
"test:integration": "./scripts/integration-tests.sh",
"link": "node --eval \"path=require('path'); require('fs').symlinkSync(path.resolve(__dirname), path.resolve(__dirname, 'node_modules', 'karma'), 'junction')\"",
"unlink": "node --eval \"require('fs').unlinkSync(require('path').resolve(__dirname, 'node_modules', 'karma'))\"",
"init": "rm -rf node_modules/karma && cd node_modules && ln -nsf ../ karma && cd ../",
"init:windows": "(IF EXIST node_modules\\karma (rmdir node_modules\\karma /S /q)) && npm run link",
"appveyor": "npm run build && npm run test:appveyor",
"semantic-release": "semantic-release"
}
}
51 changes: 51 additions & 0 deletions scripts/client.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
const browserify = require('browserify')
const fs = require('fs')
const { readFile } = require('fs').promises

const bundleResourceToFile = (inPath, outPath) => {
return new Promise((resolve, reject) => {
browserify(inPath).bundle()
.pipe(fs.createWriteStream(outPath))
.once('finish', () => resolve())
.once('error', (e) => reject(e))
})
}

const bundleResource = (inPath) => {
return new Promise((resolve, reject) => {
browserify(inPath).bundle((err, buffer) => {
if (err != null) {
reject(err)
return
}

resolve(buffer)
})
})
}

const main = async () => {
if (process.argv[2] === 'build') {
await bundleResourceToFile('client/main.js', 'static/karma.js')
await bundleResourceToFile('context/main.js', 'static/context.js')
} else if (process.argv[2] === 'check') {
const expectedClient = await bundleResource('client/main.js')
const expectedContext = await bundleResource('context/main.js')

const actualClient = await readFile('static/karma.js')
const actualContext = await readFile('static/context.js')

if (Buffer.compare(expectedClient, actualClient) !== 0 || Buffer.compare(expectedContext, actualContext) !== 0) {
// eslint-disable-next-line no-throw-literal
throw 'Bundled client assets are outdated. Forgot to run "npm run build"?'
}
} else {
// eslint-disable-next-line no-throw-literal
throw `Unknown command: ${process.argv[2]}`
}
}

main().catch((err) => {
console.error(err)
process.exit(1)
})