wikimedia/mediawiki-skins-MinervaNeue
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue synced 2024-11-15 10:27:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-skins-MinervaNeue/resources/skins.minerva.scripts/errorLogging.js

74 lines
2.4 KiB
JavaScript
Raw Normal View History

Restore table of contents and error logging When moving to packageFiles, the modules errorLogging and toc were not imported by init.js meaning they were not run. ResourceLoader should probably error in this situation, but until then we should fix this problem. This is a follow up to I44790dd3fc6fe42bb502d79c39c4081c223bf2b1 Bug: T212944 Change-Id: I86efb7be1c39b03f63c8f1e0b107216cd30ff6de
2019-07-16 21:41:37 +00:00
( function ( M, track, config, trackSubscribe, user, experiments ) {
module.exports = function () {
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
/**
* Handle an error and log it if necessary
* @param {string} errorMessage to be logged
* @param {number} [lineNumber] of error
* @param {number} [columnNumber] of error
* @param {string} [errorUrl] to be logged
*/
function handleError( errorMessage, lineNumber, columnNumber, errorUrl ) {
Allow us to distinguish errors for logged in users Logged in users may be more likely to have client side errors - either through using interfaces that require authentication or through gadgets that they run. I'd like to separate the two. Bucketing like this means we can still continue to count all client side errors, but we can have additional graph lines for logged in. This way we can notice spikes in bugs limited to logged in users for example T216853 Change-Id: I965c45f8b548abb16b400571ddf7852ca088529b
2019-02-22 22:15:53 +00:00
var suffix,
errorSamplingRate = config.get( 'wgMinervaErrorLogSamplingRate', 0 ),
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
sessionToken = user.sessionId(),
EVENT_CLIENT_ERROR_LOG = 'wikimedia.event.WebClientError',
Make Minerva use new PageHTMLParser.js and refactored Page.js In I02f8645aac1d7b081eaba8f2ac92a2ef51f78182, Page.js was made into a model and its html parsing responsibilities were moved to PageHTMLParser. Additionally, a singleton for the current page (currentPage.js) and a singleton for the curent page html parser (currentPageHTMLParser.js) were introduced to replace the usage of M.getCurrentPage(). This commit refactors Minerva to make use of these changes. Notable changes: * 🐛 The event bus singleton was added to references.js since it previously relied on an instance of Skin to listen for the `references-loaded` event. However, this event is emitted on the event bus singleton. * Additionally, I didn't see a reason why the `references-loaded` event needed to also pass the current page instance when the only file listening to it is references.js (which already has the current page instance) so I removed that and the convoluted passing of page.js within the file. I assumed this logic was unecessary. * The call to drawer.showReferences in references.js now was made to pass the currentPage instance as well as the currentPageHTMLParser. This is to prepare for I6e858bbe73f83166476b5b2c0fdac1cca7404246 where the getReferences() interface for ReferencesMobileViewGateway.js and ReferencesHtmlScraperGateway.js is refactored to accept both of these instances. Additionally, references.js was refactored to support event delegation which gets rid of some parsing/setup logic. Bug: T193077 Depends-On: I02f8645aac1d7b081eaba8f2ac92a2ef51f78182 Change-Id: I2f32dbcc4ebaa4bebb297cda1ecce3457922b343
2019-07-11 00:56:04 +00:00
mobile = M.require( 'mobile.startup' ),
currentPage = mobile.currentPage(),
util = mobile.util,
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
errorExperiment = {
name: 'WebClientError',
enabled: errorSamplingRate > 0,
buckets: {
on: errorSamplingRate,
off: 1 - errorSamplingRate
}
},
isErrorLoggingEnabled = experiments.getBucket( errorExperiment, sessionToken ) === 'on',
DEFAULT_ERROR_DATA = {
sessionToken: sessionToken,
skin: config.get( 'skin' ),
wgVersion: config.get( 'wgVersion' ),
mobileMode: config.get( 'wgMFMode', 'desktop' ),
isAnon: user.isAnon(),
Make Minerva use new PageHTMLParser.js and refactored Page.js In I02f8645aac1d7b081eaba8f2ac92a2ef51f78182, Page.js was made into a model and its html parsing responsibilities were moved to PageHTMLParser. Additionally, a singleton for the current page (currentPage.js) and a singleton for the curent page html parser (currentPageHTMLParser.js) were introduced to replace the usage of M.getCurrentPage(). This commit refactors Minerva to make use of these changes. Notable changes: * 🐛 The event bus singleton was added to references.js since it previously relied on an instance of Skin to listen for the `references-loaded` event. However, this event is emitted on the event bus singleton. * Additionally, I didn't see a reason why the `references-loaded` event needed to also pass the current page instance when the only file listening to it is references.js (which already has the current page instance) so I removed that and the convoluted passing of page.js within the file. I assumed this logic was unecessary. * The call to drawer.showReferences in references.js now was made to pass the currentPage instance as well as the currentPageHTMLParser. This is to prepare for I6e858bbe73f83166476b5b2c0fdac1cca7404246 where the getReferences() interface for ReferencesMobileViewGateway.js and ReferencesHtmlScraperGateway.js is refactored to accept both of these instances. Additionally, references.js was refactored to support event delegation which gets rid of some parsing/setup logic. Bug: T193077 Depends-On: I02f8645aac1d7b081eaba8f2ac92a2ef51f78182 Change-Id: I2f32dbcc4ebaa4bebb297cda1ecce3457922b343
2019-07-11 00:56:04 +00:00
revision: currentPage.getRevisionId()
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
};
Revert "Hygiene: Track minerva errors count only once" We talked about this in standup today and given Sam's comment in T212970#4943448 and a potential loss of data, we've considered this a little risky and would like to revert and discuss this. We can reapply the patch later if necessary. This reverts commit a486bde329e365dc41f2ec6ac3a85da7fd3e873a. Bug: T212970 Change-Id: I0aad3937dde92bf7a46df8c1cf892bf5ce257e17
2019-02-11 18:11:16 +00:00
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
if ( isErrorLoggingEnabled ) {
track( EVENT_CLIENT_ERROR_LOG,
util.extend( {
userUrl: window.location.href,
errorUrl: errorUrl,
errorMessage: errorMessage,
Hygiene: fix line length violators Change-Id: Ie1619acf5f319dafc2c9dc612335c1208522dab8
2018-09-13 15:33:20 +00:00
// Due to concerns for the length of the stack trace and going over the
// limit for URI length this is currently set to empty string.
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
errorStackTrace: '',
errorLineNumber: lineNumber || 0,
errorColumnNumber: columnNumber || 0
}, DEFAULT_ERROR_DATA )
);
}
Revert "Hygiene: Track minerva errors count only once" We talked about this in standup today and given Sam's comment in T212970#4943448 and a potential loss of data, we've considered this a little risky and would like to revert and discuss this. We can reapply the patch later if necessary. This reverts commit a486bde329e365dc41f2ec6ac3a85da7fd3e873a. Bug: T212970 Change-Id: I0aad3937dde92bf7a46df8c1cf892bf5ce257e17
2019-02-11 18:11:16 +00:00
if ( config.get( 'wgMinervaCountErrors' ) ) {
Allow us to distinguish errors for logged in users Logged in users may be more likely to have client side errors - either through using interfaces that require authentication or through gadgets that they run. I'd like to separate the two. Bucketing like this means we can still continue to count all client side errors, but we can have additional graph lines for logged in. This way we can notice spikes in bugs limited to logged in users for example T216853 Change-Id: I965c45f8b548abb16b400571ddf7852ca088529b
2019-02-22 22:15:53 +00:00
suffix = user.isAnon() ? '.anon' : '.loggedin';
mw.track( 'counter.MediaWiki.minerva.WebClientError' + suffix, 1 );
Errors can be counted in statsv Bug: T205582 Change-Id: I8f67b8356ac271872cac39a416ffefce47959177
2018-10-04 21:31:30 +00:00
}
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
}
// track RL exceptions
trackSubscribe( 'resourceloader.exception', function ( topic, data ) {
Hygiene: Consistent error naming Rather than using err and error as variable, use error for consistency Follow up to I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc Bug: T202026 Change-Id: I54165ff1f1b17284d8232c491244e1a98950d5e2
2018-09-06 20:45:43 +00:00
var error = data.exception;
handleError( error.message, error.lineNumber, error.columnNumber );
Client side error reporting for Minerva+MobileFrontend This adds a client side error logger that will store errors in EventLogging. We will use it to get a sense of the number of errors inside mobile. To enable make use of the new configuration variable wgMinervaErrorLogSamplingRate = 1 Notes: * the optional `meta` field will not be utilised by the generic error handler. * URI length is not trimmed for title. We will consider whether we need to make any adjustments to the schema values during roll out. ** For stack trace, we limit the length by removing errorUrl (which is logged separately) Testing: Add throw new Error('asasasa'); anywhere in your code and make sure the code executes. It should trigger an Error event provided that configuration has been updated. Bug: T202026 Change-Id: I07f01b4c025b2e5e4cbf88ec05e7c536442c62cc
2018-08-24 00:34:37 +00:00
} );
// setup the global error handler
trackSubscribe( 'global.error', function ( topic, error ) {
handleError( error.errorMessage, error.lineNumber, error.columnNumber, error.url );
} );
Restore table of contents and error logging When moving to packageFiles, the modules errorLogging and toc were not imported by init.js meaning they were not run. ResourceLoader should probably error in this situation, but until then we should fix this problem. This is a follow up to I44790dd3fc6fe42bb502d79c39c4081c223bf2b1 Bug: T212944 Change-Id: I86efb7be1c39b03f63c8f1e0b107216cd30ff6de
2019-07-16 21:41:37 +00:00
};
Hygiene: fix line length violators Change-Id: Ie1619acf5f319dafc2c9dc612335c1208522dab8
2018-09-13 15:33:20 +00:00
}(
Curtail use of mw.mobileFrontend in Minerva The MobileFrontend dependency in Minerva is problematic. Code that Minerva needs should live in core. MobileFrontend should load code on all skins when they operate on a mobile domain. This eslint check reminds developers of this in a hope it encourages more upstreaming to core when possible. Of course disabling is also an option, but this check will at least make us aware of when we are moving further away from the goal. Change-Id: I62183c9aefc81053e4ad81fb746decef2dd24b44
2019-09-27 18:53:01 +00:00
// eslint-disable-next-line no-restricted-properties
Hygiene: fix line length violators Change-Id: Ie1619acf5f319dafc2c9dc612335c1208522dab8
2018-09-13 15:33:20 +00:00
mw.mobileFrontend,
mw.track,
mw.config,
mw.trackSubscribe,
mw.user,
mw.experiments
) );
Reference in a new issue Copy permalink