From 3506ee664a38960921c4f52b4c7457f2f6c83ca1 Mon Sep 17 00:00:00 2001 From: Yaroslav Admin Date: Fri, 15 May 2020 00:05:19 +0200 Subject: [PATCH] fix: detect type for URLs with query parameter or fragment identifier Closes #3497 --- docs/dev/05-plugins.md | 2 +- lib/file.js | 10 ++++++++++ lib/middleware/karma.js | 14 ++++++++------ lib/url.js | 12 ++++++++++++ test/e2e/helpful-logs.feature | 24 ++++++++++++++++++++++++ test/unit/file.spec.js | 15 +++++++++++++++ test/unit/url.spec.js | 30 ++++++++++++++++++++++++++++++ 7 files changed, 100 insertions(+), 7 deletions(-) create mode 100644 test/e2e/helpful-logs.feature create mode 100644 test/unit/file.spec.js create mode 100644 test/unit/url.spec.js diff --git a/docs/dev/05-plugins.md b/docs/dev/05-plugins.md index 5f4a19d50..d785102fb 100644 --- a/docs/dev/05-plugins.md +++ b/docs/dev/05-plugins.md @@ -27,7 +27,7 @@ A preprocessor is a function that accepts three arguments (`content`, `file`, an - **path:** the current file, mutable file path. e. g. `some/file.coffee` -> `some/file.coffee.js` _This path is mutable and may not actually exist._ - **originalPath:** the original, unmutated path - **encodings:** A mutable, keyed object where the keys are a valid encoding type ('gzip', 'compress', 'br', etc.) and the values are the encoded content. Encoded content should be stored here and not resolved using `next(null, encodedContent)` - - **type:** the pattern used to match the file + - **type:** determines how to include a file, when serving - **`next`** function to be called when preprocessing is complete, should be called as `next(null, processedContent)` or `next(error)` - example plugins: [karma-coffee-preprocessor], [karma-ng-html2js-preprocessor] - use naming convention is `karma-*-preprocessor` diff --git a/lib/file.js b/lib/file.js index 69f245b91..08ab6df4e 100644 --- a/lib/file.js +++ b/lib/file.js @@ -1,5 +1,7 @@ 'use strict' +const path = require('path') + /** * File object used for tracking files in `file-list.js`. */ @@ -29,6 +31,14 @@ class File { this.isBinary = isBinary === undefined ? null : isBinary } + /** + * Detect type from the file extension. + * @returns {string} detected file type of empty string + */ + detectType () { + return path.extname(this.path).substring(1) + } + toString () { return this.path } diff --git a/lib/middleware/karma.js b/lib/middleware/karma.js index dd1ee1d00..a2da96dcb 100644 --- a/lib/middleware/karma.js +++ b/lib/middleware/karma.js @@ -11,9 +11,7 @@ * - setting propert caching headers */ -const path = require('path') const url = require('url') -const helper = require('../helper') const log = require('../logger').create('middleware:karma') const stripHost = require('./strip_host').stripHost @@ -164,10 +162,14 @@ function createKarmaMiddleware ( const scriptTags = [] for (const file of files.included) { let filePath = file.path - const fileType = file.type || path.extname(filePath).substring(1) - - if (helper.isDefined(fileType) && !FILE_TYPES.includes(fileType)) { - log.warn(`Invalid file type (${fileType}), defaulting to js.`) + const fileType = file.type || file.detectType() + + if (!FILE_TYPES.includes(fileType)) { + log.warn( + `Invalid file type (${fileType}), defaulting to js.\n` + + ` To silence the warning specify type for ${file.originalPath} in the configuration file.\n` + + ` See http://karma-runner.github.io/latest/config/files.html` + ) } if (!file.isUrl) { diff --git a/lib/url.js b/lib/url.js index 908982bf8..26398b2bb 100644 --- a/lib/url.js +++ b/lib/url.js @@ -1,15 +1,27 @@ 'use strict' +const path = require('path') +const { URL } = require('url') + /** * Url object used for tracking files in `file-list.js`. */ class Url { constructor (path, type) { this.path = path + this.originalPath = path this.type = type this.isUrl = true } + /** + * Detect type from the file extension in the path part of the URL. + * @returns {string} detected file type of empty string + */ + detectType () { + return path.extname(new URL(this.path).pathname).substring(1) + } + toString () { return this.path } diff --git a/test/e2e/helpful-logs.feature b/test/e2e/helpful-logs.feature new file mode 100644 index 000000000..f3c663f01 --- /dev/null +++ b/test/e2e/helpful-logs.feature @@ -0,0 +1,24 @@ +Feature: Helpful warning and errors + In order to use Karma + As a person who wants to write great tests + I want to get messages which help me to fix problems + + Scenario: Warning on invalid file type + Given a configuration with: + """ + files = [ 'modules/**/*.mjs' ]; + browsers = ['ChromeHeadlessNoSandbox']; + frameworks = ['mocha', 'chai']; + plugins = [ + 'karma-mocha', + 'karma-chai', + 'karma-chrome-launcher' + ]; + """ + When I start Karma + Then the stdout matches RegExp: + """ + WARN \[middleware:karma\]: Invalid file type \(mjs\), defaulting to js. + To silence the warning specify type for .+modules/minus.mjs in the configuration file. + See http://karma-runner.github.io/latest/config/files.html + """ diff --git a/test/unit/file.spec.js b/test/unit/file.spec.js new file mode 100644 index 000000000..ccbd35119 --- /dev/null +++ b/test/unit/file.spec.js @@ -0,0 +1,15 @@ +const File = require('../../lib/file') + +describe('File', () => { + describe('detectType', () => { + it('should detect type from the file extension', () => { + const file = new File('/path/to/file.js') + expect(file.detectType()).to.equal('js') + }) + + it('should return empty string if file does not an extension', () => { + const file = new File('/path/to/file-without-extension') + expect(file.detectType()).to.equal('') + }) + }) +}) diff --git a/test/unit/url.spec.js b/test/unit/url.spec.js new file mode 100644 index 000000000..09a39265f --- /dev/null +++ b/test/unit/url.spec.js @@ -0,0 +1,30 @@ +const Url = require('../../lib/url') + +describe('Url', () => { + describe('detectType', () => { + it('should detect type from the file extension in the path of the URL', () => { + const file = new Url('https://example.com/path/to/file.js') + expect(file.detectType()).to.equal('js') + }) + + it('should detect type for URL with query params', () => { + const file = new Url('https://example.com/path/to/file.js?query=simple') + expect(file.detectType()).to.equal('js') + }) + + it('should detect type for URL with a fragment', () => { + const file = new Url('https://example.com/path/to/file.js#fragment') + expect(file.detectType()).to.equal('js') + }) + + it('should return empty string if URL does not have path', () => { + const file = new Url('https://example.com') + expect(file.detectType()).to.equal('') + }) + + it('should return empty string if path in the URL does not have an extension', () => { + const file = new Url('https://example.com/path/to/file-without-extension') + expect(file.detectType()).to.equal('') + }) + }) +})