Merge pull request #3491 from dpalou/MOBILE-4081

MOBILE-4081 core: Revert split wscache into several tables
main
Noel De Martin 2022-11-30 13:50:21 +01:00 committed by GitHub
commit 7990ca3e91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 60 additions and 99 deletions

View File

@ -54,8 +54,7 @@ import {
CoreSiteLastViewedDBRecord, CoreSiteLastViewedDBRecord,
CoreSiteWSCacheRecord, CoreSiteWSCacheRecord,
LAST_VIEWED_TABLE, LAST_VIEWED_TABLE,
WSGroups, WS_CACHE_TABLE,
WS_CACHE_TABLES_PREFIX,
} from '@services/database/sites'; } from '@services/database/sites';
import { Observable, ObservableInput, ObservedValueOf, OperatorFunction, Subject } from 'rxjs'; import { Observable, ObservableInput, ObservedValueOf, OperatorFunction, Subject } from 'rxjs';
import { finalize, map, mergeMap } from 'rxjs/operators'; import { finalize, map, mergeMap } from 'rxjs/operators';
@ -121,7 +120,7 @@ export class CoreSite {
// Rest of variables. // Rest of variables.
protected logger: CoreLogger; protected logger: CoreLogger;
protected db?: SQLiteDB; protected db?: SQLiteDB;
protected cacheTables: Record<WSGroups, AsyncInstance<CoreDatabaseTable<CoreSiteWSCacheRecord>>>; protected cacheTable: AsyncInstance<CoreDatabaseTable<CoreSiteWSCacheRecord>>;
protected configTable: AsyncInstance<CoreDatabaseTable<CoreSiteConfigDBRecord, 'name'>>; protected configTable: AsyncInstance<CoreDatabaseTable<CoreSiteConfigDBRecord, 'name'>>;
protected lastViewedTable: AsyncInstance<CoreDatabaseTable<CoreSiteLastViewedDBRecord, 'component' | 'id'>>; protected lastViewedTable: AsyncInstance<CoreDatabaseTable<CoreSiteLastViewedDBRecord, 'component' | 'id'>>;
protected cleanUnicode = false; protected cleanUnicode = false;
@ -158,15 +157,11 @@ export class CoreSite {
this.logger = CoreLogger.getInstance('CoreSite'); this.logger = CoreLogger.getInstance('CoreSite');
this.siteUrl = CoreUrlUtils.removeUrlParams(this.siteUrl); // Make sure the URL doesn't have params. this.siteUrl = CoreUrlUtils.removeUrlParams(this.siteUrl); // Make sure the URL doesn't have params.
this.cacheTables = Object.values(WSGroups).reduce((tables, group) => { this.cacheTable = asyncInstance(() => CoreSites.getSiteTable(WS_CACHE_TABLE, {
tables[group] = asyncInstance(() => CoreSites.getSiteTable(WS_CACHE_TABLES_PREFIX + group, { siteId: this.getId(),
siteId: this.getId(), database: this.getDb(),
database: this.getDb(), config: { cachingStrategy: CoreDatabaseCachingStrategy.None },
config: { cachingStrategy: CoreDatabaseCachingStrategy.None }, }));
}));
return tables;
}, <Record<WSGroups, AsyncInstance<CoreDatabaseTable<CoreSiteWSCacheRecord>>>> {});
this.configTable = asyncInstance(() => CoreSites.getSiteTable(CONFIG_TABLE, { this.configTable = asyncInstance(() => CoreSites.getSiteTable(CONFIG_TABLE, {
siteId: this.getId(), siteId: this.getId(),
@ -1210,15 +1205,14 @@ export class CoreSite {
} }
const id = this.getCacheId(method, data); const id = this.getCacheId(method, data);
const group = this.getWSGroupFromWSName(method);
let entry: CoreSiteWSCacheRecord | undefined; let entry: CoreSiteWSCacheRecord | undefined;
if (preSets.getCacheUsingCacheKey || (emergency && preSets.getEmergencyCacheUsingCacheKey)) { if (preSets.getCacheUsingCacheKey || (emergency && preSets.getEmergencyCacheUsingCacheKey)) {
const entries = await this.cacheTables[group].getMany({ key: preSets.cacheKey }); const entries = await this.cacheTable.getMany({ key: preSets.cacheKey });
if (!entries.length) { if (!entries.length) {
// Cache key not found, get by params sent. // Cache key not found, get by params sent.
entry = await this.cacheTables[group].getOneByPrimaryKey({ id }); entry = await this.cacheTable.getOneByPrimaryKey({ id });
} else { } else {
if (entries.length > 1) { if (entries.length > 1) {
// More than one entry found. Search the one with same ID as this call. // More than one entry found. Search the one with same ID as this call.
@ -1230,7 +1224,7 @@ export class CoreSite {
} }
} }
} else { } else {
entry = await this.cacheTables[group].getOneByPrimaryKey({ id }); entry = await this.cacheTable.getOneByPrimaryKey({ id });
} }
if (entry === undefined) { if (entry === undefined) {
@ -1280,25 +1274,6 @@ export class CoreSite {
throw new CoreError('Cache entry not valid.'); throw new CoreError('Cache entry not valid.');
} }
/**
* Get WS group based on a WS name.
*
* @return WS group.
*/
protected getWSGroupFromWSName(name: string): WSGroups {
if (name.startsWith('mod_')) {
return WSGroups.MOD;
} else if (name.startsWith('tool_')) {
return WSGroups.TOOL;
} else if (name.startsWith('block_') || name.startsWith('core_block_')) {
return WSGroups.BLOCK;
} else if (name.startsWith('core_')) {
return WSGroups.CORE;
} else {
return WSGroups.OTHER;
}
}
/** /**
* Gets the size of cached data for a specific component or component instance. * Gets the size of cached data for a specific component or component instance.
* *
@ -1314,7 +1289,7 @@ export class CoreSite {
extraClause = ' AND componentId = ?'; extraClause = ' AND componentId = ?';
} }
const sizes = await Promise.all(Object.values(this.cacheTables).map(table => table.reduce( return this.cacheTable.reduce(
{ {
sql: 'SUM(length(data))', sql: 'SUM(length(data))',
js: (size, record) => size + record.data.length, js: (size, record) => size + record.data.length,
@ -1325,9 +1300,7 @@ export class CoreSite {
sqlParams: params, sqlParams: params,
js: record => record.component === component && (params.length === 1 || record.componentId === componentId), js: record => record.component === component && (params.length === 1 || record.componentId === componentId),
}, },
))); );
return sizes.reduce((totalSize, size) => totalSize + size, 0);
} }
/** /**
@ -1349,7 +1322,6 @@ export class CoreSite {
// Since 3.7, the expiration time contains the time the entry is modified instead of the expiration time. // Since 3.7, the expiration time contains the time the entry is modified instead of the expiration time.
// We decided to reuse this field to prevent modifying the database table. // We decided to reuse this field to prevent modifying the database table.
const id = this.getCacheId(method, data); const id = this.getCacheId(method, data);
const group = this.getWSGroupFromWSName(method);
const entry = { const entry = {
id, id,
data: JSON.stringify(response), data: JSON.stringify(response),
@ -1367,7 +1339,7 @@ export class CoreSite {
} }
} }
await this.cacheTables[group].insert(entry); await this.cacheTable.insert(entry);
} }
/** /**
@ -1382,12 +1354,11 @@ export class CoreSite {
// eslint-disable-next-line @typescript-eslint/no-explicit-any // eslint-disable-next-line @typescript-eslint/no-explicit-any
protected async deleteFromCache(method: string, data: any, preSets: CoreSiteWSPreSets, allCacheKey?: boolean): Promise<void> { protected async deleteFromCache(method: string, data: any, preSets: CoreSiteWSPreSets, allCacheKey?: boolean): Promise<void> {
const id = this.getCacheId(method, data); const id = this.getCacheId(method, data);
const group = this.getWSGroupFromWSName(method);
if (allCacheKey) { if (allCacheKey) {
await this.cacheTables[group].delete({ key: preSets.cacheKey }); await this.cacheTable.delete({ key: preSets.cacheKey });
} else { } else {
await this.cacheTables[group].deleteByPrimaryKey({ id }); await this.cacheTable.deleteByPrimaryKey({ id });
} }
} }
@ -1410,7 +1381,7 @@ export class CoreSite {
params['componentId'] = componentId; params['componentId'] = componentId;
} }
await Promise.all(Object.values(this.cacheTables).map(table => table.delete(params))); await this.cacheTable.delete(params);
} }
/* /*
@ -1445,7 +1416,7 @@ export class CoreSite {
this.logger.debug('Invalidate all the cache for site: ' + this.id); this.logger.debug('Invalidate all the cache for site: ' + this.id);
try { try {
await Promise.all(Object.values(this.cacheTables).map(table => table.update({ expirationTime: 0 }))); await this.cacheTable.update({ expirationTime: 0 });
} finally { } finally {
CoreEvents.trigger(CoreEvents.WS_CACHE_INVALIDATED, {}, this.getId()); CoreEvents.trigger(CoreEvents.WS_CACHE_INVALIDATED, {}, this.getId());
} }
@ -1464,7 +1435,7 @@ export class CoreSite {
this.logger.debug('Invalidate cache for key: ' + key); this.logger.debug('Invalidate cache for key: ' + key);
await Promise.all(Object.values(this.cacheTables).map(table => table.update({ expirationTime: 0 }, { key }))); await this.cacheTable.update({ expirationTime: 0 }, { key });
} }
/** /**
@ -1498,11 +1469,11 @@ export class CoreSite {
this.logger.debug('Invalidate cache for key starting with: ' + key); this.logger.debug('Invalidate cache for key starting with: ' + key);
await Promise.all(Object.values(this.cacheTables).map(table => table.updateWhere({ expirationTime: 0 }, { await this.cacheTable.updateWhere({ expirationTime: 0 }, {
sql: 'key LIKE ?', sql: 'key LIKE ?',
sqlParams: [key + '%'], sqlParams: [key + '%'],
js: record => !!record.key?.startsWith(key), js: record => !!record.key?.startsWith(key),
}))); });
} }
/** /**
@ -1570,20 +1541,18 @@ export class CoreSite {
} }
/** /**
* Gets an approximation of the cache tables usage of the site. * Gets an approximation of the cache table usage of the site.
* *
* Currently this is just the total length of the data fields in the cache tables. * Currently this is just the total length of the data fields in the cache table.
* *
* @return Promise resolved with the total size of all data in the cache tables (bytes) * @return Promise resolved with the total size of all data in the cache table (bytes)
*/ */
async getCacheUsage(): Promise<number> { async getCacheUsage(): Promise<number> {
const sizes = await Promise.all(Object.values(this.cacheTables).map(table => table.reduce({ return this.cacheTable.reduce({
sql: 'SUM(length(data))', sql: 'SUM(length(data))',
js: (size, record) => size + record.data.length, js: (size, record) => size + record.data.length,
jsInitialValue: 0, jsInitialValue: 0,
}))); });
return sizes.reduce((totalSize, size) => totalSize + size, 0);
} }
/** /**

View File

@ -25,18 +25,9 @@ export const SCHEMA_VERSIONS_TABLE_NAME = 'schema_versions';
/** /**
* Database variables for CoreSite class. * Database variables for CoreSite class.
*/ */
export enum WSGroups { export const WS_CACHE_TABLE = 'wscache_2';
CORE = 'core',
BLOCK = 'block',
MOD = 'mod',
TOOL = 'tool',
OTHER = 'other',
}
export const WS_CACHE_OLD_TABLE = 'wscache_2';
export const WS_CACHE_TABLES_PREFIX = 'wscache_';
export const CONFIG_TABLE = 'core_site_config'; export const CONFIG_TABLE = 'core_site_config';
export const LAST_VIEWED_TABLE = 'core_site_last_viewed'; export const LAST_VIEWED_TABLE = 'core_site_last_viewed';
export const WS_CACHE_TABLES = Object.values(WSGroups).map(group => WS_CACHE_TABLES_PREFIX + group);
// Schema to register in App DB. // Schema to register in App DB.
export const APP_SCHEMA: CoreAppSchema = { export const APP_SCHEMA: CoreAppSchema = {
@ -93,38 +84,39 @@ export const APP_SCHEMA: CoreAppSchema = {
// Schema to register for Site DB. // Schema to register for Site DB.
export const SITE_SCHEMA: CoreSiteSchema = { export const SITE_SCHEMA: CoreSiteSchema = {
name: 'CoreSitesProvider', name: 'CoreSitesProvider',
version: 4, version: 3,
canBeCleared: [...WS_CACHE_TABLES, WS_CACHE_OLD_TABLE], canBeCleared: [WS_CACHE_TABLE],
tables: WS_CACHE_TABLES.concat(WS_CACHE_OLD_TABLE).map(name => <SQLiteDBTableSchema> ({ tables: [
name: name, {
columns: [ name: WS_CACHE_TABLE,
{ columns: [
name: 'id', {
type: 'TEXT', name: 'id',
primaryKey: true, type: 'TEXT',
}, primaryKey: true,
{ },
name: 'data', {
type: 'TEXT', name: 'data',
}, type: 'TEXT',
{ },
name: 'key', {
type: 'TEXT', name: 'key',
}, type: 'TEXT',
{ },
name: 'expirationTime', {
type: 'INTEGER', name: 'expirationTime',
}, type: 'INTEGER',
{ },
name: 'component', {
type: 'TEXT', name: 'component',
}, type: 'TEXT',
{ },
name: 'componentId', {
type: 'INTEGER', name: 'componentId',
}, type: 'INTEGER',
], },
})).concat([ ],
},
{ {
name: CONFIG_TABLE, name: CONFIG_TABLE,
columns: [ columns: [
@ -166,7 +158,7 @@ export const SITE_SCHEMA: CoreSiteSchema = {
], ],
primaryKeys: ['component', 'id'], primaryKeys: ['component', 'id'],
}, },
]), ],
}; };
// Table for site DB to include the schema versions. It's not part of SITE_SCHEMA because it needs to be created first. // Table for site DB to include the schema versions. It's not part of SITE_SCHEMA because it needs to be created first.