Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow queueing dictionary update & delete together #1561

Merged
merged 16 commits into from
Nov 6, 2024
Merged

Allow queueing dictionary update & delete together #1561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d13e640
dictionary update queue
khaitruong922 Nov 4, 2024
020cc8d
naming
khaitruong922 Nov 4, 2024
62d4c0d
update conditions
khaitruong922 Nov 4, 2024
bebe1e7
lint
khaitruong922 Nov 4, 2024
ced4a67
remove unneeded async await
khaitruong922 Nov 5, 2024
8a30fa9
allow queueing delete and update in 1 queue
khaitruong922 Nov 5, 2024
021d794
await database update before running next task
khaitruong922 Nov 5, 2024
e684834
remove cmt
khaitruong922 Nov 5, 2024
4222e7b
naming
khaitruong922 Nov 5, 2024
0eeea1d
Merge branch 'master' into update-queue
khaitruong922 Nov 5, 2024
7800919
Rename var
khaitruong922 Nov 5, 2024
f71557d
move await logic to correct place
khaitruong922 Nov 6, 2024
97ba5d7
use deferPromise
khaitruong922 Nov 6, 2024
40fcfe0
move promise to _deleteDictionaryInternal
khaitruong922 Nov 6, 2024
5366244
removeconsole.log
khaitruong922 Nov 6, 2024
ea9f994
preserve update button after database update
khaitruong922 Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 105 additions & 35 deletions ext/js/pages/settings/dictionary-controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import * as ajvSchemas0 from '../../../lib/validate-schemas.js';
import {EventListenerCollection} from '../../core/event-listener-collection.js';
import {readResponseJson} from '../../core/json.js';
import {log} from '../../core/log.js';
import {deferPromise} from '../../core/utilities.js';
import {compareRevisions} from '../../dictionary/dictionary-data-util.js';
import {DictionaryWorker} from '../../dictionary/dictionary-worker.js';
import {querySelectorNotNull} from '../../dom/query-selector.js';
Expand All @@ -32,14 +33,17 @@ class DictionaryEntry {
* @param {DocumentFragment} fragment
* @param {number} index
* @param {import('dictionary-importer').Summary} dictionaryInfo
* @param {string | null} updateDownloadUrl
*/
constructor(dictionaryController, fragment, index, dictionaryInfo) {
constructor(dictionaryController, fragment, index, dictionaryInfo, updateDownloadUrl) {
/** @type {DictionaryController} */
this._dictionaryController = dictionaryController;
/** @type {number} */
this._index = index;
/** @type {import('dictionary-importer').Summary} */
this._dictionaryInfo = dictionaryInfo;
/** @type {string | null} */
this._updateDownloadUrl = updateDownloadUrl;
/** @type {EventListenerCollection} */
this._eventListeners = new EventListenerCollection();
/** @type {?import('dictionary-database').DictionaryCountGroup} */
Expand Down Expand Up @@ -86,6 +90,7 @@ class DictionaryEntry {
this._outdatedButton.hidden = (version >= 3);
this._priorityInput.dataset.setting = `dictionaries[${index}].priority`;
this._enabledCheckbox.dataset.setting = `dictionaries[${index}].enabled`;
this._showUpdatesAvailableButton();
this._eventListeners.addEventListener(this._enabledCheckbox, 'settingChanged', this._onEnabledChanged.bind(this), false);
this._eventListeners.addEventListener(this._menuButton, 'menuOpen', this._onMenuOpen.bind(this), false);
this._eventListeners.addEventListener(this._menuButton, 'menuClose', this._onMenuClose.bind(this), false);
Expand Down Expand Up @@ -122,6 +127,11 @@ class DictionaryEntry {
this._enabledCheckbox.checked = value;
}

/** */
hideUpdatesAvailableButton() {
this._updatesAvailable.hidden = true;
}

/**
* @returns {Promise<boolean>}
*/
Expand All @@ -147,21 +157,38 @@ class DictionaryEntry {

const downloadUrl = latestDownloadUrl ?? currentDownloadUrl;

this._updatesAvailable.dataset.downloadUrl = downloadUrl;
this._updatesAvailable.hidden = false;
this._updateDownloadUrl = downloadUrl;
this._showUpdatesAvailableButton();
return true;
}

/**
* @returns {string | null}
*/
get updateDownloadUrl() {
return this._updateDownloadUrl;
}

// Private

/** */
_showUpdatesAvailableButton() {
if (this._updateDownloadUrl === null || this._dictionaryController.isDictionaryInTaskQueue(this.dictionaryTitle)) {
return;
}
this._updatesAvailable.dataset.downloadUrl = this._updateDownloadUrl;
this._updatesAvailable.hidden = false;
}

/**
* @param {import('popup-menu').MenuOpenEvent} e
*/
_onMenuOpen(e) {
const bodyNode = e.detail.menu.bodyNode;
const count = this._dictionaryController.dictionaryOptionCount;
this._setMenuActionEnabled(bodyNode, 'moveTo', count > 1);
this._setMenuActionEnabled(bodyNode, 'delete', !this._dictionaryController.isDictionaryInDeleteQueue(this.dictionaryTitle));
const deleteDisabled = this._dictionaryController.isDictionaryInTaskQueue(this.dictionaryTitle);
this._setMenuActionEnabled(bodyNode, 'delete', !deleteDisabled);
}

/**
Expand Down Expand Up @@ -504,10 +531,12 @@ export class DictionaryController {
this._allCheckbox = querySelectorNotNull(document, '#all-dictionaries-enabled');
/** @type {?DictionaryExtraInfo} */
this._extraInfo = null;
/** @type {import('dictionary-controller.js').DictionaryTask[]} */
this._dictionaryTaskQueue = [];
/** @type {boolean} */
this._isDeleting = false;
/** @type {string[]} */
this._dictionaryDeleteQueue = [];
this._isTaskQueueRunning = false;
/** @type {(() => void) | null} */
this._onDictionariesUpdate = null;
}

/** @type {import('./modal-controller.js').ModalController} */
Expand Down Expand Up @@ -738,6 +767,10 @@ export class DictionaryController {
this._dictionaries = dictionaries;

await this._updateEntries();

if (this._onDictionariesUpdate) {
this._onDictionariesUpdate();
}
}

/** */
Expand All @@ -754,7 +787,10 @@ export class DictionaryController {
if (dictionaries === null) { return; }
this._updateMainDictionarySelectOptions(dictionaries);

/** @type {Map<string, string | null>} */
const dictionaryUpdateDownloadUrlMap = new Map();
for (const entry of this._dictionaryEntries) {
dictionaryUpdateDownloadUrlMap.set(entry.dictionaryTitle, entry.updateDownloadUrl);
entry.cleanup();
}
this._dictionaryEntries = [];
Expand Down Expand Up @@ -784,8 +820,9 @@ export class DictionaryController {
for (let i = 0, ii = dictionaryOptionsArray.length; i < ii; ++i) {
const {name} = dictionaryOptionsArray[i];
const dictionaryInfo = dictionaryInfoMap.get(name);
const updateDownloadUrl = dictionaryUpdateDownloadUrlMap.get(name) ?? null;
if (typeof dictionaryInfo === 'undefined') { continue; }
this._createDictionaryEntry(i, dictionaryInfo);
this._createDictionaryEntry(i, dictionaryInfo, updateDownloadUrl);
}
}

Expand Down Expand Up @@ -842,11 +879,12 @@ export class DictionaryController {
const modal = /** @type {import('./modal.js').Modal} */ (this._deleteDictionaryModal);
modal.setVisible(false);

const title = modal.node.dataset.dictionaryTitle;
if (typeof title !== 'string') { return; }
const dictionaryTitle = modal.node.dataset.dictionaryTitle;
if (typeof dictionaryTitle !== 'string') { return; }
delete modal.node.dataset.dictionaryTitle;

void this._enqueueDictionaryDelete(title);
void this._enqueueTask({type: 'delete', dictionaryTitle});
this._hideUpdatesAvailableButton(dictionaryTitle);
}

/**
Expand All @@ -858,12 +896,25 @@ export class DictionaryController {
const modal = /** @type {import('./modal.js').Modal} */ (this._updateDictionaryModal);
modal.setVisible(false);

const title = modal.node.dataset.dictionaryTitle;
const dictionaryTitle = modal.node.dataset.dictionaryTitle;
const downloadUrl = modal.node.dataset.downloadUrl;
if (typeof title !== 'string') { return; }
if (typeof dictionaryTitle !== 'string') { return; }
delete modal.node.dataset.dictionaryTitle;

void this._updateDictionary(title, downloadUrl);
void this._enqueueTask({type: 'update', dictionaryTitle, downloadUrl});
this._hideUpdatesAvailableButton(dictionaryTitle);
}

/**
* @param {string} dictionaryTitle
*/
_hideUpdatesAvailableButton(dictionaryTitle) {
for (const entry of this._dictionaryEntries) {
if (entry.dictionaryTitle === dictionaryTitle) {
entry.hideUpdatesAvailableButton();
break;
}
}
}

/**
Expand Down Expand Up @@ -954,7 +1005,7 @@ export class DictionaryController {

/** */
async _checkForUpdates() {
if (this._dictionaries === null || this._checkingIntegrity || this._checkingUpdates || this._isDeleting) { return; }
if (this._dictionaries === null || this._checkingIntegrity || this._checkingUpdates || this._isTaskQueueRunning) { return; }
let hasUpdates;
try {
this._checkingUpdates = true;
Expand All @@ -977,7 +1028,7 @@ export class DictionaryController {

/** */
async _checkIntegrity() {
if (this._dictionaries === null || this._checkingIntegrity || this._checkingUpdates || this._isDeleting) { return; }
if (this._dictionaries === null || this._checkingIntegrity || this._checkingUpdates || this._isTaskQueueRunning) { return; }

try {
this._checkingIntegrity = true;
Expand Down Expand Up @@ -1033,11 +1084,12 @@ export class DictionaryController {
/**
* @param {number} index
* @param {import('dictionary-importer').Summary} dictionaryInfo
* @param {string|null} updateDownloadUrl
*/
_createDictionaryEntry(index, dictionaryInfo) {
_createDictionaryEntry(index, dictionaryInfo, updateDownloadUrl) {
const fragment = this.instantiateTemplateFragment('dictionary');

const entry = new DictionaryEntry(this, fragment, index, dictionaryInfo);
const entry = new DictionaryEntry(this, fragment, index, dictionaryInfo, updateDownloadUrl);
this._dictionaryEntries.push(entry);
entry.prepare();

Expand All @@ -1053,30 +1105,41 @@ export class DictionaryController {
* @param {string} dictionaryTitle
* @returns {boolean}
*/
isDictionaryInDeleteQueue(dictionaryTitle) {
return this._dictionaryDeleteQueue.includes(dictionaryTitle);
isDictionaryInTaskQueue(dictionaryTitle) {
return this._dictionaryTaskQueue.some((task) => task.dictionaryTitle === dictionaryTitle);
}

/**
* @param {string} dictionaryTitle
* @param {import('dictionary-controller.js').DictionaryTask} task
*/
async _enqueueDictionaryDelete(dictionaryTitle) {
if (this.isDictionaryInDeleteQueue(dictionaryTitle)) { return; }
this._dictionaryDeleteQueue.push(dictionaryTitle);
if (this._isDeleting) { return; }
while (this._dictionaryDeleteQueue.length > 0) {
const title = this._dictionaryDeleteQueue[0];
if (!title) { continue; }
await this._deleteDictionary(title);
void this._dictionaryDeleteQueue.shift();
_enqueueTask(task) {
if (this.isDictionaryInTaskQueue(task.dictionaryTitle)) { return; }
this._dictionaryTaskQueue.push(task);
void this._runTaskQueue();
}


/** */
async _runTaskQueue() {
if (this._isTaskQueueRunning) { return; }
this._isTaskQueueRunning = true;
while (this._dictionaryTaskQueue.length > 0) {
const task = this._dictionaryTaskQueue[0];
if (task.type === 'delete') {
await this._deleteDictionary(task.dictionaryTitle);
} else if (task.type === 'update') {
await this._updateDictionary(task.dictionaryTitle, task.downloadUrl);
}
void this._dictionaryTaskQueue.shift();
}
this._isTaskQueueRunning = false;
}

/**
* @param {string} dictionaryTitle
*/
async _deleteDictionary(dictionaryTitle) {
if (this._isDeleting || this._checkingIntegrity) { return; }
if (this._checkingIntegrity) { return; }

const index = this._dictionaryEntries.findIndex((entry) => entry.dictionaryTitle === dictionaryTitle);
if (index < 0) { return; }
Expand All @@ -1089,7 +1152,6 @@ export class DictionaryController {
const statusLabels = /** @type {NodeListOf<HTMLElement>} */ (document.querySelectorAll(`${progressSelector} .progress-status`));
const prevention = this._settingsController.preventPageExit();
try {
this._isDeleting = true;
this._setButtonsEnabled(false);

/**
Expand All @@ -1115,14 +1177,14 @@ export class DictionaryController {

await this._deleteDictionaryInternal(dictionaryTitle, onProgress);
await this._deleteDictionarySettings(dictionaryTitle);
this._onDictionariesUpdate = null;
} catch (e) {
log.error(e);
} finally {
prevention.end();
for (const progress of progressContainers) { progress.hidden = true; }
if (statusFooter !== null) { statusFooter.setTaskActive(progressSelector, false); }
this._setButtonsEnabled(true);
this._isDeleting = false;
this._triggerStorageChanged();
}
}
Expand All @@ -1132,7 +1194,7 @@ export class DictionaryController {
* @param {string|undefined} downloadUrl
*/
async _updateDictionary(dictionaryTitle, downloadUrl) {
if (this._checkingIntegrity || this._checkingUpdates || this._isDeleting || this._dictionaries === null) { return; }
if (this._checkingIntegrity || this._checkingUpdates || this._dictionaries === null) { return; }

const dictionaryInfo = this._dictionaries.find((entry) => entry.title === dictionaryTitle);
if (typeof dictionaryInfo === 'undefined') { throw new Error('Dictionary not found'); }
Expand All @@ -1156,7 +1218,10 @@ export class DictionaryController {
}

await this._deleteDictionary(dictionaryTitle);
this._settingsController.trigger('importDictionaryFromUrl', {url: downloadUrl, profilesDictionarySettings});
/** @type {import('core').DeferredPromiseDetails<void>} */
const {promise: importPromise, resolve} = deferPromise();
this._settingsController.trigger('importDictionaryFromUrl', {url: downloadUrl, profilesDictionarySettings, onImportDone: resolve});
await importPromise;
}

/**
Expand All @@ -1175,7 +1240,12 @@ export class DictionaryController {
*/
async _deleteDictionaryInternal(dictionaryTitle, onProgress) {
await new DictionaryWorker().deleteDictionary(dictionaryTitle, onProgress);
/** @type {import('core').DeferredPromiseDetails<void>} */
const {promise: dictionariesUpdatePromise, resolve} = deferPromise();
this._onDictionariesUpdate = resolve;
void this._settingsController.application.api.triggerDatabaseUpdated('dictionary', 'delete');
await dictionariesUpdatePromise;
this._onDictionariesUpdate = null;
}

/**
Expand Down
Loading