diff options
Diffstat (limited to 'devtools/client/webconsole/test/node/store/filters.test.js')
| -rw-r--r-- | devtools/client/webconsole/test/node/store/filters.test.js | 345 |
1 files changed, 345 insertions, 0 deletions
diff --git a/devtools/client/webconsole/test/node/store/filters.test.js b/devtools/client/webconsole/test/node/store/filters.test.js new file mode 100644 index 0000000000..eddf59e537 --- /dev/null +++ b/devtools/client/webconsole/test/node/store/filters.test.js @@ -0,0 +1,345 @@ +/* Any copyright is dedicated to the Public Domain. + * http://creativecommons.org/publicdomain/zero/1.0/ */ + +"use strict"; + +const expect = require("expect"); + +const actions = require("resource://devtools/client/webconsole/actions/index.js"); +const { + messagesAdd, +} = require("resource://devtools/client/webconsole/actions/index.js"); +const { + ConsoleCommand, +} = require("resource://devtools/client/webconsole/types.js"); +const { + getVisibleMessages, +} = require("resource://devtools/client/webconsole/selectors/messages.js"); +const { + getAllFilters, +} = require("resource://devtools/client/webconsole/selectors/filters.js"); +const { + setupStore, + getFiltersPrefs, +} = require("resource://devtools/client/webconsole/test/node/helpers.js"); +const { + FILTERS, + PREFS, +} = require("resource://devtools/client/webconsole/constants.js"); +const { + stubPackets, +} = require("resource://devtools/client/webconsole/test/node/fixtures/stubs/index.js"); +const { + stubPreparedMessages, +} = require("resource://devtools/client/webconsole/test/node/fixtures/stubs/index.js"); + +describe("Filtering", () => { + let store; + let numMessages; + // Number of messages in prepareBaseStore which are not filtered out, i.e. Evaluation + // Results and console commands. + const numUnfilterableMessages = 2; + + beforeEach(() => { + store = prepareBaseStore(); + store.dispatch(actions.filtersClear()); + numMessages = getVisibleMessages(store.getState()).length; + }); + + /** + * Tests for filter buttons in Console toolbar. The test switches off + * all filters and consequently tests one by one on the list of messages + * created in `prepareBaseStore` method. + */ + describe("Level filter", () => { + beforeEach(() => { + // Switch off all filters (include those which are on by default). + store.dispatch(actions.filtersClear()); + store.dispatch(actions.filterToggle(FILTERS.DEBUG)); + store.dispatch(actions.filterToggle(FILTERS.ERROR)); + store.dispatch(actions.filterToggle(FILTERS.INFO)); + store.dispatch(actions.filterToggle(FILTERS.LOG)); + store.dispatch(actions.filterToggle(FILTERS.WARN)); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages); + }); + + it("filters log messages", () => { + store.dispatch(actions.filterToggle(FILTERS.LOG)); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 6); + }); + + it("filters debug messages", () => { + store.dispatch(actions.filterToggle(FILTERS.DEBUG)); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 1); + }); + + it("filters info messages", () => { + store.dispatch(actions.filterToggle(FILTERS.INFO)); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 1); + }); + + it("filters warning messages", () => { + store.dispatch(actions.filterToggle(FILTERS.WARN)); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 1); + }); + + it("filters error messages", () => { + store.dispatch(actions.filterToggle(FILTERS.ERROR)); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 5); + }); + + it("filters css messages", () => { + const message = stubPreparedMessages.get( + "Unknown property ‘such-unknown-property’. Declaration dropped." + ); + store.dispatch(messagesAdd([message])); + + let messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages); + + store.dispatch(actions.filterToggle("css")); + messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 1); + }); + + it("filters xhr messages", () => { + const message = stubPreparedMessages.get("XHR GET request"); + store.dispatch(messagesAdd([message])); + + let messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages); + + store.dispatch(actions.filterToggle("netxhr")); + messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 1); + }); + + it("filters network messages", () => { + const message = stubPreparedMessages.get("GET request update"); + store.dispatch(messagesAdd([message])); + + let messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages); + + store.dispatch(actions.filterToggle("net")); + messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numUnfilterableMessages + 1); + }); + }); + + describe("Text filter", () => { + it("set the expected property on the store", () => { + store.dispatch(actions.filterTextSet("danger")); + expect(getAllFilters(store.getState()).text).toEqual("danger"); + }); + + it("matches on value grips", () => { + store.dispatch(actions.filterTextSet("danger")); + let messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + + // Checks that trimming works. + store.dispatch(actions.filterTextSet(" danger ")); + messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + }); + + it("matches unicode values", () => { + store.dispatch(actions.filterTextSet("鼬")); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + }); + + it("matches locations", () => { + // Add a message with a different filename. + const locationMsg = Object.assign( + {}, + stubPackets.get("console.log('foobar', 'test')") + ); + locationMsg.message = Object.assign({}, locationMsg.message, { + filename: "search-location-test.js", + }); + store.dispatch(messagesAdd([locationMsg])); + + store.dispatch(actions.filterTextSet("search-location-test.js")); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + }); + + it("matches stacktrace functionName", () => { + const traceMessage = stubPackets.get("console.trace()"); + store.dispatch(messagesAdd([traceMessage])); + + store.dispatch(actions.filterTextSet("testStacktraceFiltering")); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + }); + + it("matches stacktrace location", () => { + const traceMessage = stubPackets.get("console.trace()"); + traceMessage.message = Object.assign({}, traceMessage.message, { + filename: "search-location-test.js", + lineNumber: 85, + columnNumber: 13, + }); + + store.dispatch(messagesAdd([traceMessage])); + + store.dispatch(actions.filterTextSet("search-location-test.js:85:13")); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + }); + + it("matches prefixed log message", () => { + const stub = { + level: "debug", + filename: "resource:///modules/CustomizableUI.sys.mjs", + lineNumber: 181, + functionName: "initialize", + timeStamp: 1519311532912, + arguments: ["Initializing"], + prefix: "MyNicePrefix", + workerType: "none", + styles: [], + category: "webdev", + _type: "ConsoleAPI", + }; + store.dispatch(messagesAdd([stub])); + + store.dispatch(actions.filterTextSet("MyNice")); + let messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + + store.dispatch(actions.filterTextSet("MyNicePrefix")); + messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + + store.dispatch(actions.filterTextSet("MyNicePrefix:")); + messages = getVisibleMessages(store.getState()); + expect(messages.length - numUnfilterableMessages).toEqual(1); + }); + + it("restores all messages once text is cleared", () => { + store.dispatch(actions.filterTextSet("danger")); + store.dispatch(actions.filterTextSet("")); + + const messages = getVisibleMessages(store.getState()); + expect(messages.length).toEqual(numMessages); + }); + }); + + describe("Combined filters", () => { + // @TODO add test + it.todo("filters"); + }); +}); + +describe("Clear filters", () => { + it("clears all filters", () => { + const store = setupStore(); + + // Setup test case + store.dispatch(actions.filterToggle(FILTERS.ERROR)); + store.dispatch(actions.filterToggle(FILTERS.CSS)); + store.dispatch(actions.filterToggle(FILTERS.NET)); + store.dispatch(actions.filterToggle(FILTERS.NETXHR)); + store.dispatch(actions.filterTextSet("foobar")); + + expect(getAllFilters(store.getState())).toEqual({ + // default + [FILTERS.WARN]: true, + [FILTERS.LOG]: true, + [FILTERS.INFO]: true, + [FILTERS.DEBUG]: true, + // changed + [FILTERS.ERROR]: false, + [FILTERS.CSS]: true, + [FILTERS.NET]: true, + [FILTERS.NETXHR]: true, + [FILTERS.TEXT]: "foobar", + }); + expect(getFiltersPrefs()).toEqual({ + [PREFS.FILTER.WARN]: true, + [PREFS.FILTER.LOG]: true, + [PREFS.FILTER.INFO]: true, + [PREFS.FILTER.DEBUG]: true, + [PREFS.FILTER.ERROR]: false, + [PREFS.FILTER.CSS]: true, + [PREFS.FILTER.NET]: true, + [PREFS.FILTER.NETXHR]: true, + }); + + store.dispatch(actions.filtersClear()); + + expect(getAllFilters(store.getState())).toEqual({ + [FILTERS.CSS]: false, + [FILTERS.DEBUG]: true, + [FILTERS.ERROR]: true, + [FILTERS.INFO]: true, + [FILTERS.LOG]: true, + [FILTERS.NET]: false, + [FILTERS.NETXHR]: false, + [FILTERS.WARN]: true, + [FILTERS.TEXT]: "", + }); + + expect(getFiltersPrefs()).toEqual({ + [PREFS.FILTER.CSS]: false, + [PREFS.FILTER.DEBUG]: true, + [PREFS.FILTER.ERROR]: true, + [PREFS.FILTER.INFO]: true, + [PREFS.FILTER.LOG]: true, + [PREFS.FILTER.NET]: false, + [PREFS.FILTER.NETXHR]: false, + [PREFS.FILTER.WARN]: true, + }); + }); +}); + +function prepareBaseStore() { + const store = setupStore([ + // Console API + "console.log('foobar', 'test')", + "console.warn('danger, will robinson!')", + "console.log(undefined)", + "console.count('bar')", + "console.log('鼬')", + // Evaluation Result - never filtered + "new Date(0)", + // PageError + "ReferenceError: asdf is not defined", + "TypeError longString message", + "console.debug('debug message');", + "console.info('info message');", + "console.error('error message');", + "console.table(['red', 'green', 'blue']);", + "console.assert(false, {message: 'foobar'})", + // This is a 404 request, it's displayed as an error + "GET request update", + "console.group('bar')", + "console.groupEnd()", + ]); + + // Console Command - never filtered + store.dispatch( + messagesAdd([new ConsoleCommand({ messageText: `console.warn("x")` })]) + ); + + return store; +} |