88 lines
2.9 KiB
TypeScript
88 lines
2.9 KiB
TypeScript
/*
|
|
Copyright 2018 New Vector Ltd
|
|
Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/*
|
|
* Separate file that sets up rageshake logging when imported.
|
|
* This is necessary so that rageshake logging is set up before
|
|
* anything else. Webpack puts all import statements at the top
|
|
* of the file before any code, so imports will always be
|
|
* evaluated first. Other imports can cause other code to be
|
|
* evaluated (eg. the loglevel library in js-sdk, which if set
|
|
* up before rageshake causes some js-sdk logging to be missing
|
|
* from the rageshake.)
|
|
*/
|
|
|
|
import * as rageshake from "matrix-react-sdk/src/rageshake/rageshake";
|
|
import SdkConfig from "matrix-react-sdk/src/SdkConfig";
|
|
import sendBugReport from "matrix-react-sdk/src/rageshake/submit-rageshake";
|
|
import { logger } from "matrix-js-sdk/src/logger";
|
|
|
|
export function initRageshake(): Promise<void> {
|
|
// we manually check persistence for rageshakes ourselves
|
|
const prom = rageshake.init(/*setUpPersistence=*/ false);
|
|
prom.then(
|
|
() => {
|
|
logger.log("Initialised rageshake.");
|
|
logger.log(
|
|
"To fix line numbers in Chrome: " + "Meatball menu → Settings → Ignore list → Add /rageshake\\.js$",
|
|
);
|
|
|
|
window.addEventListener("beforeunload", () => {
|
|
logger.log("element-web closing");
|
|
// try to flush the logs to indexeddb
|
|
rageshake.flush();
|
|
});
|
|
|
|
rageshake.cleanup();
|
|
},
|
|
(err) => {
|
|
logger.error("Failed to initialise rageshake: " + err);
|
|
},
|
|
);
|
|
return prom;
|
|
}
|
|
|
|
export function initRageshakeStore(): Promise<void> {
|
|
return rageshake.tryInitStorage();
|
|
}
|
|
|
|
window.mxSendRageshake = function (text: string, withLogs?: boolean): void {
|
|
const url = SdkConfig.get().bug_report_endpoint_url;
|
|
if (!url) {
|
|
logger.error("Cannot send a rageshake - no bug_report_endpoint_url configured");
|
|
return;
|
|
}
|
|
|
|
if (withLogs === undefined) withLogs = true;
|
|
if (!text || !text.trim()) {
|
|
logger.error("Cannot send a rageshake without a message - please tell us what went wrong");
|
|
return;
|
|
}
|
|
sendBugReport(url, {
|
|
userText: text,
|
|
sendLogs: withLogs,
|
|
progressCallback: logger.log.bind(console),
|
|
}).then(
|
|
() => {
|
|
logger.log("Bug report sent!");
|
|
},
|
|
(err) => {
|
|
logger.error(err);
|
|
},
|
|
);
|
|
};
|