|
| 1 | +import * as fs from 'fs-extra'; |
| 2 | +import * as os from 'os'; |
| 3 | +import * as path from 'path'; |
| 4 | +import { Disposable, ExtensionContext } from 'vscode'; |
| 5 | +import { logger } from './logging'; |
| 6 | + |
| 7 | +const LAST_SCRUB_TIME_KEY = 'lastScrubTime'; |
| 8 | + |
| 9 | +type Counter = { |
| 10 | + increment: () => void; |
| 11 | +}; |
| 12 | + |
| 13 | +/** |
| 14 | + * Registers an interval timer that will periodically check for queries old enought |
| 15 | + * to be deleted. |
| 16 | + * |
| 17 | + * Note that this scrubber will clean all queries from all workspaces. It should not |
| 18 | + * run too often and it should only run from one workspace at a time. |
| 19 | + * |
| 20 | + * Generally, `wakeInterval` should be significantly shorter than `throttleTime`. |
| 21 | + * |
| 22 | + * @param wakeInterval How often to check to see if the job should run. |
| 23 | + * @param throttleTime How often to actually run the job. |
| 24 | + * @param maxQueryTime The maximum age of a query before is ready for deletion. |
| 25 | + * @param queryDirectory The directory containing all queries. |
| 26 | + * @param ctx The extension context. |
| 27 | + */ |
| 28 | +export function registerQueryHistoryScubber( |
| 29 | + wakeInterval: number, |
| 30 | + throttleTime: number, |
| 31 | + maxQueryTime: number, |
| 32 | + queryDirectory: string, |
| 33 | + ctx: ExtensionContext, |
| 34 | + |
| 35 | + // optional counter to keep track of how many times the scrubber has run |
| 36 | + counter?: Counter |
| 37 | +): Disposable { |
| 38 | + const deregister = setInterval(scrubber, wakeInterval, throttleTime, maxQueryTime, queryDirectory, ctx, counter); |
| 39 | + |
| 40 | + return { |
| 41 | + dispose: () => { |
| 42 | + clearInterval(deregister); |
| 43 | + } |
| 44 | + }; |
| 45 | +} |
| 46 | + |
| 47 | +async function scrubber( |
| 48 | + throttleTime: number, |
| 49 | + maxQueryTime: number, |
| 50 | + queryDirectory: string, |
| 51 | + ctx: ExtensionContext, |
| 52 | + counter?: Counter |
| 53 | +) { |
| 54 | + const lastScrubTime = ctx.globalState.get<number>(LAST_SCRUB_TIME_KEY); |
| 55 | + const now = Date.now(); |
| 56 | + |
| 57 | + // If we have never scrubbed before, or if the last scrub was more than `throttleTime` ago, |
| 58 | + // then scrub again. |
| 59 | + if (lastScrubTime === undefined || now - lastScrubTime >= throttleTime) { |
| 60 | + await ctx.globalState.update(LAST_SCRUB_TIME_KEY, now); |
| 61 | + |
| 62 | + let scrubCount = 0; // total number of directories deleted |
| 63 | + try { |
| 64 | + counter?.increment(); |
| 65 | + void logger.log('Scrubbing query directory. Removing old queries.'); |
| 66 | + if (!(await fs.pathExists(queryDirectory))) { |
| 67 | + void logger.log(`Cannot scrub. Query directory does not exist: ${queryDirectory}`); |
| 68 | + return; |
| 69 | + } |
| 70 | + |
| 71 | + const baseNames = await fs.readdir(queryDirectory); |
| 72 | + const errors: string[] = []; |
| 73 | + for (const baseName of baseNames) { |
| 74 | + const dir = path.join(queryDirectory, baseName); |
| 75 | + const scrubResult = await scrubDirectory(dir, now, maxQueryTime); |
| 76 | + if (scrubResult.errorMsg) { |
| 77 | + errors.push(scrubResult.errorMsg); |
| 78 | + } |
| 79 | + if (scrubResult.deleted) { |
| 80 | + scrubCount++; |
| 81 | + } |
| 82 | + } |
| 83 | + |
| 84 | + if (errors.length) { |
| 85 | + throw new Error(os.EOL + errors.join(os.EOL)); |
| 86 | + } |
| 87 | + } catch (e) { |
| 88 | + void logger.log(`Error while scrubbing queries: ${e}`); |
| 89 | + } finally { |
| 90 | + void logger.log(`Scrubbed ${scrubCount} old queries.`); |
| 91 | + } |
| 92 | + } |
| 93 | +} |
| 94 | + |
| 95 | +async function scrubDirectory(dir: string, now: number, maxQueryTime: number): Promise<{ |
| 96 | + errorMsg?: string, |
| 97 | + deleted: boolean |
| 98 | +}> { |
| 99 | + const timestampFile = path.join(dir, 'timestamp'); |
| 100 | + try { |
| 101 | + let deleted = true; |
| 102 | + if (!(await fs.stat(dir)).isDirectory()) { |
| 103 | + void logger.log(` ${dir} is not a directory. Deleting.`); |
| 104 | + await fs.remove(dir); |
| 105 | + } else if (!(await fs.pathExists(timestampFile))) { |
| 106 | + void logger.log(` ${dir} has no timestamp file. Deleting.`); |
| 107 | + await fs.remove(dir); |
| 108 | + } else if (!(await fs.stat(timestampFile)).isFile()) { |
| 109 | + void logger.log(` ${timestampFile} is not a file. Deleting.`); |
| 110 | + await fs.remove(dir); |
| 111 | + } else { |
| 112 | + const timestampText = await fs.readFile(timestampFile, 'utf8'); |
| 113 | + const timestamp = parseInt(timestampText, 10); |
| 114 | + |
| 115 | + if (Number.isNaN(timestamp)) { |
| 116 | + void logger.log(` ${dir} has invalid timestamp '${timestampText}'. Deleting.`); |
| 117 | + await fs.remove(dir); |
| 118 | + } else if (now - timestamp > maxQueryTime) { |
| 119 | + void logger.log(` ${dir} is older than ${maxQueryTime / 1000} seconds. Deleting.`); |
| 120 | + await fs.remove(dir); |
| 121 | + } else { |
| 122 | + void logger.log(` ${dir} is not older than ${maxQueryTime / 1000} seconds. Keeping.`); |
| 123 | + deleted = false; |
| 124 | + } |
| 125 | + } |
| 126 | + return { |
| 127 | + deleted |
| 128 | + }; |
| 129 | + } catch (err) { |
| 130 | + return { |
| 131 | + errorMsg: ` Could not delete '${dir}': ${err}`, |
| 132 | + deleted: false |
| 133 | + }; |
| 134 | + } |
| 135 | +} |
0 commit comments