Skip to content

Fixes #53 Ensure storage api calls error are caught and logged #126

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

Merged
merged 1 commit into from
Mar 1, 2023
Merged

Fixes #53 Ensure storage api calls error are caught and logged #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"esbuild",
"eslintignore",
"jsdelivr",
"lage",
"localstorage",
"maxcdn",
"ncaught",
Expand Down
14 changes: 8 additions & 6 deletions packages/core/src/configuration/SettingsManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ export class SettingsManager {
}

this._isUpdatingSettings = true;
const { log } = config.services;
try {
const { log, storage, submissionClient } = config.services;

try {
const unableToUpdateMessage = "Unable to update settings";
if (!config.isValid) {
log.error(`${unableToUpdateMessage}: ApiKey is not set`);
Expand All @@ -39,7 +39,7 @@ export class SettingsManager {

const version = config.settingsVersion;
log.trace(`Checking for updated settings from: v${version}`);
const response = await config.services.submissionClient.getSettings(version);
const response = await submissionClient.getSettings(version);

if (response.status === 304) {
log.trace("Settings are up-to-date");
Expand All @@ -53,7 +53,7 @@ export class SettingsManager {

config.applyServerSettings(response.data);

await config.services.storage.setItem(SettingsManager.SettingsKey, JSON.stringify(response.data));
await storage.setItem(SettingsManager.SettingsKey, JSON.stringify(response.data));
log.trace(`Updated settings: v${response.data.version}`);
} catch (ex) {
log.error(`Error updating settings: ${ex instanceof Error ? ex.message : ex + ''}`);
Expand All @@ -63,10 +63,12 @@ export class SettingsManager {
}

private static async getSavedServerSettings(config: Configuration): Promise<ServerSettings> {
const { log, storage } = config.services;
try {
const settings = await config.services.storage.getItem(SettingsManager.SettingsKey);
const settings = await storage.getItem(SettingsManager.SettingsKey);
return settings && JSON.parse(settings) as ServerSettings || new ServerSettings({}, 0);
} catch {
} catch (ex) {
log.error(`Error getting saved settings: ${ex instanceof Error ? ex.message : ex + ''}`);
return new ServerSettings({}, 0);
}
}
Expand Down
21 changes: 14 additions & 7 deletions packages/core/src/queue/DefaultEventQueue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,9 @@ export class DefaultEventQueue implements IEventQueue {

private async loadEvents(): Promise<void> {
if (this.config.usePersistedQueueStorage) {
const { log, storage } = this.config.services;

try {
const storage = this.config.services.storage;
const files: string[] = await storage.keys();

for (const file of files) {
Expand All @@ -269,7 +270,7 @@ export class DefaultEventQueue implements IEventQueue {
}
}
} catch (ex) {
this.config.services.log.error(`Error loading queue items from storage: ${ex instanceof Error ? ex.message : ex + ''}`)
log.error(`Error loading queue items from storage: ${ex instanceof Error ? ex.message : ex + ''}`)
}
}
}
Expand All @@ -278,21 +279,25 @@ export class DefaultEventQueue implements IEventQueue {
this._lastFileTimestamp = Math.max(Date.now(), this._lastFileTimestamp + 1);
const file = `${this.QUEUE_PREFIX}${this._lastFileTimestamp}.json`;

const { storage, log } = this.config.services;
const { log, storage } = this.config.services;
const useStorage: boolean = this.config.usePersistedQueueStorage;
if (this._queue.push({ file, event }) > this.maxItems) {
log.trace("Removing oldest queue entry: maxItems exceeded");
const item = this._queue.shift();
if (useStorage && item) {
await storage.removeItem(item.file);
try {
await storage.removeItem(item.file);
} catch (ex) {
log.error(`Error removing oldest queue entry from storage: ${ex instanceof Error ? ex.message : ex + ''}`)
}
}
}

if (useStorage) {
try {
await storage.setItem(file, JSON.stringify(event));
} catch (ex) {
log.error(`Error saving queue item to storage: ${ex instanceof Error ? ex.message : ex + ''}`)
log.error(`Error saving queue entry to storage: ${ex instanceof Error ? ex.message : ex + ''}`)
}
}

Expand All @@ -302,11 +307,13 @@ export class DefaultEventQueue implements IEventQueue {
private async removeEvents(items: EventQueueItem[]): Promise<void> {
const files = items.map(i => i.file);
if (this.config.usePersistedQueueStorage) {
const { log, storage } = this.config.services;

for (const file of files) {
try {
await this.config.services.storage.removeItem(file);
await storage.removeItem(file);
} catch (ex) {
this.config.services.log.error(`Error removing queue item from storage: ${ex instanceof Error ? ex.message : ex + ''}`)
log.error(`Error removing queue item from storage: ${ex instanceof Error ? ex.message : ex + ''}`)
}
}
}
Expand Down