From c40f97fa2595a2565f17cc61a6843cbc8dbcbef6 Mon Sep 17 00:00:00 2001 From: Germain Souquet Date: Fri, 26 Mar 2021 09:44:52 +0000 Subject: [PATCH 1/5] Add reset option for corrupted event index store --- .../views/dialogs/SeshatResetDialog.js | 55 +++++++++++++++++++ .../views/settings/EventIndexPanel.js | 16 ++++++ src/i18n/strings/en_EN.json | 3 + src/indexing/BaseEventIndexManager.ts | 10 ++++ src/indexing/EventIndexPeg.js | 5 ++ 5 files changed, 89 insertions(+) create mode 100644 src/components/views/dialogs/SeshatResetDialog.js diff --git a/src/components/views/dialogs/SeshatResetDialog.js b/src/components/views/dialogs/SeshatResetDialog.js new file mode 100644 index 0000000000..751af72383 --- /dev/null +++ b/src/components/views/dialogs/SeshatResetDialog.js @@ -0,0 +1,55 @@ +/* +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. +*/ + +import React from 'react'; +import PropTypes from 'prop-types'; +import {_t} from "../../../languageHandler"; +import * as sdk from "../../../index"; +import {replaceableComponent} from "../../../utils/replaceableComponent"; + +@replaceableComponent("views.dialogs.SeshatResetDialog") +export default class SeshatResetDialog extends React.Component { + static propTypes = { + onFinished: PropTypes.func.isRequired, + }; + render() { + const BaseDialog = sdk.getComponent('views.dialogs.BaseDialog'); + const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); + + return ( + +
+

+ {_t( + "Your event store appears corrupted. " + + "This action will restart this application.", + )} +

+
+ + + ); + } +} diff --git a/src/components/views/settings/EventIndexPanel.js b/src/components/views/settings/EventIndexPanel.js index a48583b61d..773f687524 100644 --- a/src/components/views/settings/EventIndexPanel.js +++ b/src/components/views/settings/EventIndexPanel.js @@ -26,6 +26,7 @@ import {formatBytes, formatCountLong} from "../../../utils/FormattingUtils"; import EventIndexPeg from "../../../indexing/EventIndexPeg"; import {SettingLevel} from "../../../settings/SettingLevel"; import {replaceableComponent} from "../../../utils/replaceableComponent"; +import SeshatResetDialog from '../dialogs/SeshatResetDialog'; @replaceableComponent("views.settings.EventIndexPanel") export default class EventIndexPanel extends React.Component { @@ -122,6 +123,16 @@ export default class EventIndexPanel extends React.Component { await this.updateState(); } + _confirmEventStoreReset() { + Modal.createDialog(SeshatResetDialog, { + onFinished: (success) => { + if (success) { + EventIndexPeg.resetEventStore(); + } + }, + }); + } + render() { let eventIndexingSettings = null; const InlineSpinner = sdk.getComponent('elements.InlineSpinner'); @@ -220,6 +231,11 @@ export default class EventIndexPanel extends React.Component { {EventIndexPeg.error.message} +

+ + {_t("Reset")} + +

)} diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json index b5edf31d01..9c72f1c1c5 100644 --- a/src/i18n/strings/en_EN.json +++ b/src/i18n/strings/en_EN.json @@ -2300,6 +2300,9 @@ "Use your preferred Matrix homeserver if you have one, or host your own.": "Use your preferred Matrix homeserver if you have one, or host your own.", "Learn more": "Learn more", "About homeservers": "About homeservers", + "Reset event index store?": "Reset event index store?", + "Your event store appears corrupted. This action will restart this application.": "Your event store appears corrupted. This action will restart this application.", + "Reset event store": "Reset event store", "Sign out and remove encryption keys?": "Sign out and remove encryption keys?", "Clear Storage and Sign Out": "Clear Storage and Sign Out", "Send Logs": "Send Logs", diff --git a/src/indexing/BaseEventIndexManager.ts b/src/indexing/BaseEventIndexManager.ts index 2474406618..2ae47c6d86 100644 --- a/src/indexing/BaseEventIndexManager.ts +++ b/src/indexing/BaseEventIndexManager.ts @@ -309,4 +309,14 @@ export default abstract class BaseEventIndexManager { async deleteEventIndex(): Promise { throw new Error("Unimplemented"); } + + /** + * Reset a potentially corrupted event store + * + * @return {Promise} A promise that will resolve once the event store has + * been deleted. + */ + async resetEventStore(): Promise { + throw new Error("Unimplemented"); + } } diff --git a/src/indexing/EventIndexPeg.js b/src/indexing/EventIndexPeg.js index 7004efc554..c339ca4209 100644 --- a/src/indexing/EventIndexPeg.js +++ b/src/indexing/EventIndexPeg.js @@ -179,6 +179,11 @@ class EventIndexPeg { await indexManager.deleteEventIndex(); } } + + resetEventStore() { + const indexManager = PlatformPeg.get().getEventIndexingManager(); + return indexManager.resetEventStore(); + } } if (!global.mxEventIndexPeg) { From e53a8ad992b593290230e7ca5631f5a3bd1f62b5 Mon Sep 17 00:00:00 2001 From: Germain Souquet Date: Mon, 29 Mar 2021 08:44:10 +0100 Subject: [PATCH 2/5] Refactor SeshatResetDialog in TypeScript --- ...atResetDialog.js => SeshatResetDialog.tsx} | 27 +++++++++---------- 1 file changed, 13 insertions(+), 14 deletions(-) rename src/components/views/dialogs/{SeshatResetDialog.js => SeshatResetDialog.tsx} (71%) diff --git a/src/components/views/dialogs/SeshatResetDialog.js b/src/components/views/dialogs/SeshatResetDialog.tsx similarity index 71% rename from src/components/views/dialogs/SeshatResetDialog.js rename to src/components/views/dialogs/SeshatResetDialog.tsx index 751af72383..a351b9f15d 100644 --- a/src/components/views/dialogs/SeshatResetDialog.js +++ b/src/components/views/dialogs/SeshatResetDialog.tsx @@ -1,5 +1,5 @@ /* -Copyright 2020 The Matrix.org Foundation C.I.C. +Copyright 2021 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. @@ -15,25 +15,24 @@ limitations under the License. */ import React from 'react'; -import PropTypes from 'prop-types'; import {_t} from "../../../languageHandler"; -import * as sdk from "../../../index"; import {replaceableComponent} from "../../../utils/replaceableComponent"; -@replaceableComponent("views.dialogs.SeshatResetDialog") -export default class SeshatResetDialog extends React.Component { - static propTypes = { - onFinished: PropTypes.func.isRequired, - }; - render() { - const BaseDialog = sdk.getComponent('views.dialogs.BaseDialog'); - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); +import BaseDialog from "./BaseDialog"; +import DialogButtons from "../elements/DialogButtons"; +interface IProps { + onFinished(): void; +} + +@replaceableComponent("views.dialogs.SeshatResetDialog") +export default class SeshatResetDialog extends React.PureComponent { + render() { return ( + hasCancel={true} + onFinished={this.props.onFinished.bind(null, false)} + title={_t("Reset event index store?")}>

{_t( From b38f5c945920d98aa1964a6685e14ff647148468 Mon Sep 17 00:00:00 2001 From: Germain Souquet Date: Mon, 29 Mar 2021 15:46:58 +0100 Subject: [PATCH 3/5] Simplify event index store reset flow --- .../views/dialogs/SeshatResetDialog.tsx | 4 ++-- .../views/settings/EventIndexPanel.js | 17 ++++++++++++----- src/indexing/BaseEventIndexManager.ts | 10 ---------- src/indexing/EventIndexPeg.js | 5 ----- 4 files changed, 14 insertions(+), 22 deletions(-) diff --git a/src/components/views/dialogs/SeshatResetDialog.tsx b/src/components/views/dialogs/SeshatResetDialog.tsx index a351b9f15d..09bf25f5cc 100644 --- a/src/components/views/dialogs/SeshatResetDialog.tsx +++ b/src/components/views/dialogs/SeshatResetDialog.tsx @@ -36,8 +36,8 @@ export default class SeshatResetDialog extends React.PureComponent {

{_t( - "Your event store appears corrupted. " + - "This action will restart this application.", + "Your event store appears to be corrupted. " + + "Your messages will be re-indexed as soon as the store is initialised.", )}

diff --git a/src/components/views/settings/EventIndexPanel.js b/src/components/views/settings/EventIndexPanel.js index 773f687524..049ba72d2f 100644 --- a/src/components/views/settings/EventIndexPanel.js +++ b/src/components/views/settings/EventIndexPanel.js @@ -123,11 +123,15 @@ export default class EventIndexPanel extends React.Component { await this.updateState(); } - _confirmEventStoreReset() { - Modal.createDialog(SeshatResetDialog, { - onFinished: (success) => { + _confirmEventStoreReset = () => { + const self = this; + const { close } = Modal.createDialog(SeshatResetDialog, { + onFinished: async (success) => { if (success) { - EventIndexPeg.resetEventStore(); + await SettingsStore.setValue('enableEventIndexing', null, SettingLevel.DEVICE, false); + await EventIndexPeg.deleteEventIndex(); + await self._onEnable(); + close(); } }, }); @@ -223,7 +227,10 @@ export default class EventIndexPanel extends React.Component { eventIndexingSettings = (

- {_t("Message search initilisation failed")} + {this.state.enabling + ? + : _t("Message search initilisation failed") + }

{EventIndexPeg.error && (
diff --git a/src/indexing/BaseEventIndexManager.ts b/src/indexing/BaseEventIndexManager.ts index 2ae47c6d86..2474406618 100644 --- a/src/indexing/BaseEventIndexManager.ts +++ b/src/indexing/BaseEventIndexManager.ts @@ -309,14 +309,4 @@ export default abstract class BaseEventIndexManager { async deleteEventIndex(): Promise { throw new Error("Unimplemented"); } - - /** - * Reset a potentially corrupted event store - * - * @return {Promise} A promise that will resolve once the event store has - * been deleted. - */ - async resetEventStore(): Promise { - throw new Error("Unimplemented"); - } } diff --git a/src/indexing/EventIndexPeg.js b/src/indexing/EventIndexPeg.js index c339ca4209..7004efc554 100644 --- a/src/indexing/EventIndexPeg.js +++ b/src/indexing/EventIndexPeg.js @@ -179,11 +179,6 @@ class EventIndexPeg { await indexManager.deleteEventIndex(); } } - - resetEventStore() { - const indexManager = PlatformPeg.get().getEventIndexingManager(); - return indexManager.resetEventStore(); - } } if (!global.mxEventIndexPeg) { From 4fcb25898192f7bd72ee2fcf78df9f493cce2ef7 Mon Sep 17 00:00:00 2001 From: Germain Souquet Date: Thu, 1 Apr 2021 08:58:39 +0100 Subject: [PATCH 4/5] Refactor SeshatResetDialog props interface to use IDialogProps --- src/components/views/dialogs/SeshatResetDialog.tsx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/components/views/dialogs/SeshatResetDialog.tsx b/src/components/views/dialogs/SeshatResetDialog.tsx index 09bf25f5cc..f40b7767f7 100644 --- a/src/components/views/dialogs/SeshatResetDialog.tsx +++ b/src/components/views/dialogs/SeshatResetDialog.tsx @@ -21,12 +21,10 @@ import {replaceableComponent} from "../../../utils/replaceableComponent"; import BaseDialog from "./BaseDialog"; import DialogButtons from "../elements/DialogButtons"; -interface IProps { - onFinished(): void; -} +import {IDialogProps} from "./IDialogProps"; @replaceableComponent("views.dialogs.SeshatResetDialog") -export default class SeshatResetDialog extends React.PureComponent { +export default class SeshatResetDialog extends React.PureComponent { render() { return ( Date: Thu, 1 Apr 2021 09:03:50 +0100 Subject: [PATCH 5/5] Update seshat reset dialog copy --- src/components/views/dialogs/SeshatResetDialog.tsx | 10 ++++++---- src/i18n/strings/en_EN.json | 5 +++-- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/components/views/dialogs/SeshatResetDialog.tsx b/src/components/views/dialogs/SeshatResetDialog.tsx index f40b7767f7..135f5d8197 100644 --- a/src/components/views/dialogs/SeshatResetDialog.tsx +++ b/src/components/views/dialogs/SeshatResetDialog.tsx @@ -30,12 +30,14 @@ export default class SeshatResetDialog extends React.PureComponent + title={_t("Reset event store?")}>

- {_t( - "Your event store appears to be corrupted. " + - "Your messages will be re-indexed as soon as the store is initialised.", + {_t("You most likely do not want to reset your event index store")} +
+ {_t("If you do, please note that none of your messages will be deleted, " + + "but the search experience might be degraded for a few moments" + + "whilst the index is recreated", )}

diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json index 9c72f1c1c5..db61122005 100644 --- a/src/i18n/strings/en_EN.json +++ b/src/i18n/strings/en_EN.json @@ -2300,8 +2300,9 @@ "Use your preferred Matrix homeserver if you have one, or host your own.": "Use your preferred Matrix homeserver if you have one, or host your own.", "Learn more": "Learn more", "About homeservers": "About homeservers", - "Reset event index store?": "Reset event index store?", - "Your event store appears corrupted. This action will restart this application.": "Your event store appears corrupted. This action will restart this application.", + "Reset event store?": "Reset event store?", + "You most likely do not want to reset your event index store": "You most likely do not want to reset your event index store", + "If you do, please note that none of your messages will be deleted, but the search experience might be degraded for a few momentswhilst the index is recreated": "If you do, please note that none of your messages will be deleted, but the search experience might be degraded for a few momentswhilst the index is recreated", "Reset event store": "Reset event store", "Sign out and remove encryption keys?": "Sign out and remove encryption keys?", "Clear Storage and Sign Out": "Clear Storage and Sign Out",