🚧 Experiment with cache for all filters and tagRenderings
This commit is contained in:
Robin van der Linde
parent
5b4a3c77e8
commit
b61270e51e
GPG key ID:
53956B3252478F0D
3 changed files with 532 additions and 46 deletions
|
|
@ -8,8 +8,9 @@ import {
|
|||
tagRenderingDefinitionProvider,
|
||||
} from "./layers";
|
||||
import { pathDefinitionProvider } from "./license_info";
|
||||
import { CacheWorker } from "./utils/cache";
|
||||
|
||||
export function activate(context: vscode.ExtensionContext) {
|
||||
export async function activate(context: vscode.ExtensionContext) {
|
||||
// Activate all theme related features
|
||||
context.subscriptions.push(layerCompletionProvider, layerDefinitionProvider);
|
||||
|
||||
|
|
@ -26,4 +27,10 @@ export function activate(context: vscode.ExtensionContext) {
|
|||
|
||||
// Activate all generic features
|
||||
context.subscriptions.push(iconDefinitionProvider, colorProvider);
|
||||
|
||||
// Upon activation, we also scan the workspace for all themes and layers
|
||||
// and save them in a cache, so we can quickly look up definitions and completions
|
||||
// for each theme and layer
|
||||
// We should also listen for changes in the workspace, so we can update the cache
|
||||
CacheWorker.create(context);
|
||||
}
|
||||
|
|
|
|||
450
src/utils/cache.ts
Normal file
450
src/utils/cache.ts
Normal file
|
|
@ -0,0 +1,450 @@
|
|||
/**
|
||||
* This file contains all functions related to caching the workspace
|
||||
*/
|
||||
|
||||
import * as vscode from "vscode";
|
||||
import { JSONPath } from "jsonc-parser";
|
||||
|
||||
/**
|
||||
* Worker class to handle the cache creation and updates
|
||||
*/
|
||||
export class CacheWorker {
|
||||
/**
|
||||
* Creates a new cache
|
||||
*
|
||||
* @param context The extension context
|
||||
* @returns Promise<Cache> The cache
|
||||
*/
|
||||
public static async create(
|
||||
context: vscode.ExtensionContext
|
||||
): Promise<CacheWorker> {
|
||||
const cache = new CacheWorker(context);
|
||||
await cache.initialize();
|
||||
return cache;
|
||||
}
|
||||
|
||||
private async initialize() {
|
||||
await this.scanWorkspace();
|
||||
}
|
||||
private readonly context: vscode.ExtensionContext;
|
||||
private cache: CacheItem[] = [];
|
||||
|
||||
/**
|
||||
* Saves the current cache to the storage as JSON
|
||||
*/
|
||||
private save() {
|
||||
const jsonString = JSON.stringify(this.cache);
|
||||
// Save it in the cache.json file in the .cache folder in the workspace
|
||||
const workspaceFolder = vscode.workspace.workspaceFolders?.[0].uri.fsPath;
|
||||
if (workspaceFolder) {
|
||||
const cacheUri = vscode.Uri.file(`${workspaceFolder}/.cache/cache.json`);
|
||||
vscode.workspace.fs.writeFile(cacheUri, Buffer.from(jsonString));
|
||||
} else {
|
||||
console.error("No workspace folder found");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new cache
|
||||
*
|
||||
* @param context The extension context
|
||||
*/
|
||||
constructor(context: vscode.ExtensionContext) {
|
||||
this.context = context;
|
||||
// We probably want to create a fileSystemWatcher here
|
||||
// to listen for changes in the workspace
|
||||
this.createFileSystemWatcher();
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a file system watcher
|
||||
*/
|
||||
private createFileSystemWatcher() {
|
||||
const watcher = vscode.workspace.createFileSystemWatcher(
|
||||
"**/assets/**/*.json"
|
||||
);
|
||||
watcher.onDidChange(this.onChanged, this, this.context.subscriptions);
|
||||
watcher.onDidCreate(this.onCreated, this, this.context.subscriptions);
|
||||
watcher.onDidDelete(this.onDeleted, this, this.context.subscriptions);
|
||||
}
|
||||
|
||||
private onChanged(uri: vscode.Uri) {
|
||||
this.saveFileToCache(uri);
|
||||
}
|
||||
|
||||
private onCreated(uri: vscode.Uri) {
|
||||
this.saveFileToCache(uri);
|
||||
}
|
||||
|
||||
private onDeleted(uri: vscode.Uri) {
|
||||
this.deleteFileFromCache(uri);
|
||||
}
|
||||
|
||||
/**
|
||||
* Scans the workspace for all themes and layers
|
||||
*/
|
||||
private async scanWorkspace() {
|
||||
const files = await vscode.workspace.findFiles("**/assets/**/*.json");
|
||||
for (const file of files) {
|
||||
this.saveFileToCache(file);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Scans a file, extracts all relevant information and saves it to the cache
|
||||
*
|
||||
* @param uri File URI
|
||||
*/
|
||||
private saveFileToCache(uri: vscode.Uri) {
|
||||
// First, we determine what kind of file it is, and whether we actually care about it
|
||||
// If we don't care about it, we return early
|
||||
// Possible relevant patterns:
|
||||
// - ./assets/themes/{name}/{name}.json
|
||||
// - ./assets/layers/{name}/{name}.json
|
||||
|
||||
const filePath = uri.fsPath;
|
||||
const regex = /\/assets\/(?<asset>themes|layers)\/([^/]+)\/\2\.json/;
|
||||
const match = regex.exec(filePath);
|
||||
const asset = match?.groups?.asset;
|
||||
if (!match) {
|
||||
return;
|
||||
} else {
|
||||
console.log("We care about this file", filePath);
|
||||
this.deleteFileFromCache(uri);
|
||||
|
||||
// Determine what kind of file we're dealing with
|
||||
switch (asset) {
|
||||
case "themes":
|
||||
console.log("Theme found", filePath);
|
||||
this.saveThemeToCache(uri);
|
||||
break;
|
||||
case "layers":
|
||||
console.log("Layer found", filePath);
|
||||
this.saveLayerToCache(uri);
|
||||
break;
|
||||
default:
|
||||
console.error("Unknown asset type", filePath);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a file from the cache
|
||||
*
|
||||
* @param uri File URI
|
||||
*/
|
||||
private deleteFileFromCache(uri: vscode.Uri) {
|
||||
this.cache = this.cache.filter(
|
||||
(item) => item.filePath.fsPath !== uri.fsPath
|
||||
);
|
||||
|
||||
this.save();
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves a theme to the cache
|
||||
*
|
||||
* @param filePath The file path
|
||||
*/
|
||||
private async saveThemeToCache(uri: vscode.Uri) {
|
||||
const filePath = uri.fsPath;
|
||||
console.log("Saving theme to cache", filePath);
|
||||
/**
|
||||
* For now, we only care about the layer references in the theme
|
||||
*/
|
||||
|
||||
// Read the file
|
||||
const content = vscode.workspace.fs.readFile(uri);
|
||||
const text = new TextDecoder().decode(await content);
|
||||
const json = JSON.parse(text);
|
||||
|
||||
// Look through the layers
|
||||
for (const layer of json.layers) {
|
||||
// Check if it is a string and not an object
|
||||
if (typeof layer === "string") {
|
||||
// It is a reference
|
||||
console.log(`Reference found to ${layer} in ${filePath}`);
|
||||
|
||||
const from = `themes.${json.id}`;
|
||||
const to = layer.includes(".")
|
||||
? `themes.${layer.split(".")[0]}layers.${layer.split(".")[1]}`
|
||||
: `layers.${layer}`;
|
||||
|
||||
this.cache.push({
|
||||
id: layer,
|
||||
filePath: uri,
|
||||
jsonPath: ["layers"],
|
||||
type: "reference",
|
||||
reference: {
|
||||
from,
|
||||
to,
|
||||
type: "layer",
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
this.save();
|
||||
this.printCache();
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves a layer to the cache
|
||||
*
|
||||
* @param uri The URI of the layer
|
||||
*/
|
||||
private async saveLayerToCache(uri: vscode.Uri) {
|
||||
// Read the file
|
||||
const content = vscode.workspace.fs.readFile(uri);
|
||||
const text = new TextDecoder().decode(await content);
|
||||
const uriPath = uri.path;
|
||||
const uriPathSplit = uriPath.split("/");
|
||||
const uriFileName = uriPathSplit[uriPathSplit.length - 1];
|
||||
const from = `layers.${uriFileName.split(".")[0]}`;
|
||||
|
||||
this.saveLayerTextToCache(text, uri, from);
|
||||
}
|
||||
|
||||
/**
|
||||
* Save a layer to the cache, given the text of the layer
|
||||
*
|
||||
* @param text The text of the layer
|
||||
* @param uri The URI of the layer file
|
||||
* @param from The theme or layer where the layer is from, e.g. layers.bicycle_rental or themes.cyclofix.layers.0
|
||||
*/
|
||||
private saveLayerTextToCache(text: string, uri: vscode.Uri, from: string) {
|
||||
const filePath = uri.fsPath;
|
||||
console.log("Saving layer to cache", filePath);
|
||||
/**
|
||||
* For now, we only care about the tagRenderings and filters in the layer
|
||||
*/
|
||||
const json = JSON.parse(text);
|
||||
|
||||
// Look through the tagRenderings, if the layer has any
|
||||
if (json.tagRenderings) {
|
||||
for (const tagRendering of json.tagRenderings) {
|
||||
// Check if it is a string and not an object
|
||||
if (typeof tagRendering === "string") {
|
||||
// It is a reference
|
||||
console.log(`Reference found to ${tagRendering} in ${filePath}`);
|
||||
|
||||
const to = tagRendering.includes(".")
|
||||
? `layers.${tagRendering.split(".")[0]}.tagRenderings.${
|
||||
tagRendering.split(".")[1]
|
||||
}`
|
||||
: `layers.questions.tagRenderings.${tagRendering}`;
|
||||
|
||||
this.cache.push({
|
||||
id: tagRendering,
|
||||
filePath: uri,
|
||||
jsonPath: ["tagRenderings"],
|
||||
type: "reference",
|
||||
reference: {
|
||||
from,
|
||||
to,
|
||||
type: "tagRendering",
|
||||
},
|
||||
});
|
||||
} else if (typeof tagRendering === "object") {
|
||||
// This is a tagRendering, which can be reused
|
||||
console.log(`TagRendering found in ${filePath}`);
|
||||
this.cache.push({
|
||||
id: `${json.id}.${tagRendering.id}`,
|
||||
filePath: uri,
|
||||
jsonPath: ["tagRenderings"],
|
||||
type: "tagRendering",
|
||||
});
|
||||
}
|
||||
}
|
||||
} else {
|
||||
console.log("No tagRenderings found in", filePath);
|
||||
}
|
||||
|
||||
if (json.filter) {
|
||||
// Look through the filters
|
||||
for (const filter of json.filter) {
|
||||
// Check if it is a string and not an object
|
||||
if (typeof filter === "string") {
|
||||
// It is a reference
|
||||
console.log(`Reference found to ${filter} in ${filePath}`);
|
||||
|
||||
const from = `layers.${json.id}`;
|
||||
const to = `layers.${filter}`;
|
||||
|
||||
this.cache.push({
|
||||
id: filter,
|
||||
filePath: uri,
|
||||
jsonPath: ["filters"],
|
||||
type: "reference",
|
||||
reference: {
|
||||
from,
|
||||
to,
|
||||
type: "filter",
|
||||
},
|
||||
});
|
||||
} else if (typeof filter === "object") {
|
||||
// This is a filter, which can be reused
|
||||
console.log(`Filter found in ${filePath}`);
|
||||
this.cache.push({
|
||||
id: `${json.id}.${filter.id}`,
|
||||
filePath: uri,
|
||||
jsonPath: ["filters"],
|
||||
type: "filter",
|
||||
});
|
||||
}
|
||||
}
|
||||
} else {
|
||||
console.log("No filters found in", filePath);
|
||||
}
|
||||
|
||||
this.save();
|
||||
this.printCache();
|
||||
}
|
||||
|
||||
/**
|
||||
* Print the current cache state
|
||||
*/
|
||||
public printCache() {
|
||||
console.log("Current cache state:", this.cache);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache for interacting with the cache
|
||||
*/
|
||||
export class Cache {
|
||||
private cache: CacheItem[] = [];
|
||||
|
||||
public static async create() {
|
||||
const cache = new Cache();
|
||||
await cache.loadCache();
|
||||
return cache;
|
||||
}
|
||||
|
||||
private async loadCache() {
|
||||
// Get the cache from the .cache/cache.json file in the workspace folder
|
||||
const workspaceFolder = vscode.workspace.workspaceFolders?.[0].uri.fsPath;
|
||||
if (workspaceFolder) {
|
||||
const cacheUri = vscode.Uri.file(`${workspaceFolder}/.cache/cache.json`);
|
||||
const cache = await vscode.workspace.fs.readFile(cacheUri);
|
||||
const cacheString = new TextDecoder().decode(cache);
|
||||
this.cache = JSON.parse(cacheString);
|
||||
console.log(`Cache loaded, ${this.cache.length} items`);
|
||||
} else {
|
||||
console.error("No workspace folder found");
|
||||
throw new Error("No workspace folder found");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all tag renderings from the cache
|
||||
*
|
||||
* @returns List of CompletionItems for tagRenderings
|
||||
*/
|
||||
public getTagRenderings(): vscode.CompletionItem[] {
|
||||
console.log("Getting tag renderings from cache");
|
||||
const tagRenderings: vscode.CompletionItem[] = [];
|
||||
for (const item of this.cache) {
|
||||
if (item.type === "tagRendering") {
|
||||
if (item.id.startsWith("questions.")) {
|
||||
const completionItem = new vscode.CompletionItem(
|
||||
item.id.replace("questions.", ""),
|
||||
vscode.CompletionItemKind.Value
|
||||
);
|
||||
// To give built-in tagRenderings a higher priority, we sort them to the top
|
||||
completionItem.sortText = `#${item.id}`;
|
||||
tagRenderings.push(completionItem);
|
||||
} else {
|
||||
tagRenderings.push(
|
||||
new vscode.CompletionItem(item.id, vscode.CompletionItemKind.Value)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
return tagRenderings;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all filters from the cache
|
||||
*/
|
||||
public getFilters(): vscode.CompletionItem[] {
|
||||
console.log("Getting filters from cache");
|
||||
const filters: vscode.CompletionItem[] = [];
|
||||
for (const item of this.cache) {
|
||||
if (item.type === "filter") {
|
||||
if (item.id.startsWith("filters.")) {
|
||||
const completionItem = new vscode.CompletionItem(
|
||||
item.id.replace("filters.", ""),
|
||||
vscode.CompletionItemKind.Value
|
||||
);
|
||||
// To give built-in filters a higher priority, we sort them to the top
|
||||
completionItem.sortText = `#${item.id}`;
|
||||
filters.push(completionItem);
|
||||
} else {
|
||||
filters.push(
|
||||
new vscode.CompletionItem(item.id, vscode.CompletionItemKind.Value)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
return filters;
|
||||
}
|
||||
}
|
||||
|
||||
interface CacheItem {
|
||||
/**
|
||||
* Where the item is defined in the workspace
|
||||
*/
|
||||
filePath: vscode.Uri;
|
||||
|
||||
/**
|
||||
* The JSON path to the item in the file
|
||||
*/
|
||||
jsonPath: JSONPath;
|
||||
|
||||
/**
|
||||
* What kind of item it is
|
||||
*/
|
||||
type: "tagRendering" | "filter" | "layer" | "reference";
|
||||
|
||||
/**
|
||||
* The ID of the item
|
||||
*
|
||||
* When we need to reuse an items in a configuration, we can use the ID
|
||||
* This does mean the ID definitely doesn't have to be unique, because when this is a reference,
|
||||
* the ID is the same as the reference ID and items can be reused by multiple themes or layers
|
||||
*/
|
||||
id: string;
|
||||
|
||||
/**
|
||||
* In case of a reference, this contains the reference
|
||||
*/
|
||||
reference?: Reference;
|
||||
}
|
||||
|
||||
/**
|
||||
* A reference between two items
|
||||
*/
|
||||
interface Reference {
|
||||
/**
|
||||
* The theme or layer where the reference is from
|
||||
*
|
||||
* @example themes.cyclofix
|
||||
*/
|
||||
from: string;
|
||||
|
||||
/**
|
||||
* The path of the file where the reference points to
|
||||
* This can also be more specific, like a tagRendering or filter
|
||||
*
|
||||
* @example layers.bicycle_rental
|
||||
* @example layers.questions.tagRenderings.name
|
||||
*/
|
||||
to: string;
|
||||
|
||||
/**
|
||||
* The type of item being referenced/reused
|
||||
*/
|
||||
type: "tagRendering" | "filter" | "layer";
|
||||
}
|
||||
|
|
@ -4,6 +4,7 @@
|
|||
|
||||
import * as vscode from "vscode";
|
||||
import * as path from "path";
|
||||
import { Cache } from "./cache";
|
||||
|
||||
/**
|
||||
* Function to get all available layers on disk
|
||||
|
|
@ -33,67 +34,95 @@ export async function getAvailableLayers(): Promise<string[]> {
|
|||
|
||||
/**
|
||||
* Utility function to get the tagRenderings from the questions layer
|
||||
* //TODO: This should get ALL tagRenderings, not just from the questions layer
|
||||
*
|
||||
* This function first tries to get all of the tagRenderings from the cache, and if that fails, it falls back to the questions.json file
|
||||
*
|
||||
* @returns List of CompletionItems for tagRenderings
|
||||
*/
|
||||
export async function getTagRenderings(): Promise<vscode.CompletionItem[]> {
|
||||
const tagRenderings: vscode.CompletionItem[] = [];
|
||||
// First, we try to get the tagRenderings from the cache
|
||||
// If the cache is not available, instead return the tagRenderings from the questions layer
|
||||
|
||||
// Open the questions layer file
|
||||
const questionsFile = await vscode.workspace.findFiles(
|
||||
"assets/layers/questions/questions.json",
|
||||
"**/node_modules/**"
|
||||
);
|
||||
|
||||
if (questionsFile.length === 0) {
|
||||
console.error("questions.json not found");
|
||||
return [];
|
||||
}
|
||||
|
||||
const content = await vscode.workspace.fs.readFile(questionsFile[0]);
|
||||
const questions = JSON.parse(new TextDecoder().decode(content));
|
||||
|
||||
for (const tagRendering of questions.tagRenderings) {
|
||||
tagRenderings.push(
|
||||
new vscode.CompletionItem(
|
||||
tagRendering.id,
|
||||
vscode.CompletionItemKind.Value
|
||||
)
|
||||
try {
|
||||
const cache = await Cache.create();
|
||||
return cache.getTagRenderings();
|
||||
} catch (error) {
|
||||
console.error(
|
||||
"Error getting tagRenderings from cache, falling back to questions.json",
|
||||
error
|
||||
);
|
||||
}
|
||||
|
||||
return tagRenderings;
|
||||
const tagRenderings: vscode.CompletionItem[] = [];
|
||||
|
||||
// Open the questions layer file
|
||||
const questionsFile = await vscode.workspace.findFiles(
|
||||
"assets/layers/questions/questions.json",
|
||||
"**/node_modules/**"
|
||||
);
|
||||
|
||||
if (questionsFile.length === 0) {
|
||||
console.error("questions.json not found");
|
||||
return [];
|
||||
}
|
||||
|
||||
const content = await vscode.workspace.fs.readFile(questionsFile[0]);
|
||||
const questions = JSON.parse(new TextDecoder().decode(content));
|
||||
|
||||
for (const tagRendering of questions.tagRenderings) {
|
||||
tagRenderings.push(
|
||||
new vscode.CompletionItem(
|
||||
tagRendering.id,
|
||||
vscode.CompletionItemKind.Value
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
return tagRenderings;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility function to get the filters from the filters layer
|
||||
* //TODO: This should get ALL filters, not just from the filters layer
|
||||
*
|
||||
* This function first tries to get all of the filters from the cache, and if that fails, it falls back to the filters.json file
|
||||
*
|
||||
* @returns List of CompletionItems for tagRenderings
|
||||
*/
|
||||
export async function getFilters(): Promise<vscode.CompletionItem[]> {
|
||||
const filtersList: vscode.CompletionItem[] = [];
|
||||
// First, we try to get the filters from the cache
|
||||
// If the cache is not available, instead return the filters from the filters layer
|
||||
|
||||
// Open the filters layer file
|
||||
const filtersFile = await vscode.workspace.findFiles(
|
||||
"assets/layers/filters/filters.json",
|
||||
"**/node_modules/**"
|
||||
);
|
||||
|
||||
if (filtersFile.length === 0) {
|
||||
console.error("filters.json not found");
|
||||
return [];
|
||||
}
|
||||
|
||||
const content = await vscode.workspace.fs.readFile(filtersFile[0]);
|
||||
const filters = JSON.parse(new TextDecoder().decode(content));
|
||||
|
||||
for (const filter of filters.filter) {
|
||||
filtersList.push(
|
||||
new vscode.CompletionItem(filter.id, vscode.CompletionItemKind.Value)
|
||||
try {
|
||||
const cache = await Cache.create();
|
||||
return cache.getFilters();
|
||||
} catch (error) {
|
||||
console.error(
|
||||
"Error getting filters from cache, falling back to filters.json",
|
||||
error
|
||||
);
|
||||
}
|
||||
|
||||
return filtersList;
|
||||
const filtersList: vscode.CompletionItem[] = [];
|
||||
|
||||
// Open the filters layer file
|
||||
const filtersFile = await vscode.workspace.findFiles(
|
||||
"assets/layers/filters/filters.json",
|
||||
"**/node_modules/**"
|
||||
);
|
||||
|
||||
if (filtersFile.length === 0) {
|
||||
console.error("filters.json not found");
|
||||
return [];
|
||||
}
|
||||
|
||||
const content = await vscode.workspace.fs.readFile(filtersFile[0]);
|
||||
const filters = JSON.parse(new TextDecoder().decode(content));
|
||||
|
||||
for (const filter of filters.filter) {
|
||||
filtersList.push(
|
||||
new vscode.CompletionItem(filter.id, vscode.CompletionItemKind.Value)
|
||||
);
|
||||
}
|
||||
|
||||
return filtersList;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue