refactor(extra-info): split code into several classes
This commit refactors the extra info feature so the code is more
maintainable, in preparation for a future commit which will make it work
with the RCE thread page.
It doesn't refactor the code related to the thread view since it will be
heavily modified, and the code related to canned responses has been
deleted since the number of uses of a CR is no longer relevant because
it is no longer counted.
Bug: twpowertools:93
Change-Id: I06c045fb9ff0c824c99f63acfa10976b2110e5ed
diff --git a/src/contentScripts/communityConsole/extraInfo/handlers/basedOnResponseEvent.js b/src/contentScripts/communityConsole/extraInfo/handlers/basedOnResponseEvent.js
new file mode 100644
index 0000000..881356c
--- /dev/null
+++ b/src/contentScripts/communityConsole/extraInfo/handlers/basedOnResponseEvent.js
@@ -0,0 +1,76 @@
+import {waitFor} from 'poll-until-promise';
+
+import {shouldImplement} from '../../../../common/commonUtils.js';
+
+import BaseInfoHandler from './base.js';
+
+export default class ResponseEventBasedInfoHandler extends BaseInfoHandler {
+ constructor() {
+ super();
+
+ if (this.constructor == ResponseEventBasedInfoHandler) {
+ throw new Error('The base class cannot be instantiated.');
+ }
+
+ this.setUpDefaultInfoValue();
+ this.setUpEventHandler();
+ }
+
+ /**
+ * Should return the name of the XHR interceptor event for the API response
+ * which has the information being handled.
+ */
+ getEvent() {
+ shouldImplement('getEvent');
+ }
+
+ /**
+ * This function should return a promise which resolves to a boolean
+ * specifying whether this.info is the information related to the view that
+ * the user is currently on.
+ */
+ async isInfoCurrent(_injectionDetails) {
+ shouldImplement('isInfoCurrent');
+ }
+
+ /**
+ * Should return the options for the waitFor function which is called when
+ * checking whether the information is current or not.
+ */
+ getWaitForCurrentInfoOptions() {
+ shouldImplement('getWaitForCurrentInfoOptions');
+ }
+
+ setUpDefaultInfoValue() {
+ this.info = {
+ body: {},
+ id: -1,
+ timestamp: 0,
+ };
+ }
+
+ setUpEventHandler() {
+ window.addEventListener(this.getEvent(), e => {
+ if (e.detail.id < this.info.id) return;
+
+ this.info = {
+ body: e.detail.body,
+ id: e.detail.id,
+ timestamp: Date.now(),
+ };
+ });
+ }
+
+ async getCurrentInfo(injectionDetails) {
+ const options = this.getWaitForCurrentInfoOptions();
+ return waitFor(
+ () => this.attemptToGetCurrentInfo(injectionDetails), options);
+ }
+
+ async attemptToGetCurrentInfo(injectionDetails) {
+ const isInfoCurrent = await this.isInfoCurrent(injectionDetails);
+ if (!isInfoCurrent) throw new Error('Didn\'t receive current information');
+
+ return this.info;
+ }
+}