feat!: remove custom nodetag files setting

This setting was added to keep track of new NodeTags, but file parsing
adds impact on performance and rarely used. It is a better idea to move
this to configuration file.

For now this setting is not removed from VS Code configuration, so not
error messages will be shown. Maybe I will find another way to use this.

Author: ashenBlade

README.md

@@ -159,16 +159,6 @@ There are 4 settings:
   required files (node tag files, `pg_bsd_indent` and so on). If not specified
   search starts from workspace root. (Next, this settings will be used as `*SrcPath*`).
 
-- `postgresql-hacker-helper.nodeTagFiles` - Files with NodeTag files
-  
-  List of paths points to files that contain NodeTags.
-  
-  - If path is absolute - specified files will be used directly.
-  - If path is relative, search starts from source files directory (see
-  `postgresql-hacker-helper.srcPath`).
-  - If not specified, `*SrcPath*/src/include/nodes/nodes.h`
-  and `*SrcPath*/src/include/nodes/nodetags.h` will be used.
-
 - `postgresql-hacker-helper.pg_bsd_indentPath` - Path to `pg_bsd_indent`
 
   Path to `pg_bsd_indent` tool. Required for formatting support. Use it if you have `pg_bsd_indent` installed globally or want to use specific version.

package.json

@@ -179,7 +179,8 @@
                     "title": "Files with NodeTags",
                     "type": "array",
                     "default": null,
-                    "description": "Files, where NodeTag values defined. It will be used to check if variable can have NodeTag.\nCan be either relative or absolute path. Relative paths will be applied with base path of `srcPath` setting"
+                    "description": "Files, where NodeTag values defined. It will be used to check if variable can have NodeTag.\nCan be either relative or absolute path. Relative paths will be applied with base path of `srcPath` setting",
+                    "deprecationMessage": "This is not used any more due to significant performance impact.\nPlease, use \"nodetags\" parameter in extension's configuration file."
                 },
                 "postgresql-hacker-helper.logLevel": {
                     "title": "Log level",

src/configuration.ts

@@ -18,6 +18,8 @@ export interface VariablesConfiguration {
     simpleHashTableTypes?: vars.SimplehashEntryInfo[];
     /* Enum values for integer fields */
     bitmaskEnumMembers?: vars.BitmaskMemberInfo[];
+    /* Extra NodeTags */
+    nodetags?: string[];
 }
 
 export interface PgindentConfiguration {
@@ -456,6 +458,32 @@ export function parseVariablesConfiguration(configFile: unknown): VariablesConfi
 
         return members;
     };
+    
+    const parseNodeTags = (obj: unknown): string[] | undefined => {
+        if (!Array.isArray(obj)) {
+            return;
+        }
+        
+        const result: string[] = [];
+        for (let o of obj) {
+            if (typeof o !== 'string') {
+                continue;
+            }
+            
+            if (o.startsWith('T_')) {
+                o = o.substring(2);
+            }
+
+            o = o.trim();
+            if (!utils.isValidIdentifier(o)) {
+                continue;
+            }
+
+            result.push(o);
+        }
+        
+        return result;
+    };
 
     if (!(typeof configFile === 'object' && configFile)) {
         return;
@@ -487,20 +515,25 @@ export function parseVariablesConfiguration(configFile: unknown): VariablesConfi
     const bitmaskEnumMembers = 'enums' in configFile 
         ? parseEnumBitmasks(configFile.enums)
         : undefined;
+    const nodetags = 'nodetags' in configFile
+        ? parseNodeTags(configFile.nodetags)
+        : undefined;
 
     if (   arrayInfos?.length
         || aliasInfos?.length
         || customListTypes?.length
         || htabTypes?.length
         || simpleHashTableTypes?.length
-        || bitmaskEnumMembers?.length) {
+        || bitmaskEnumMembers?.length
+        || nodetags?.length) {
         return {
             arrayInfos,
             aliasInfos,
             customListTypes,
             htabTypes,
             simpleHashTableTypes,
             bitmaskEnumMembers,
+            nodetags,
         };
     }
 }

src/extension.ts

@@ -496,35 +496,45 @@ export function setupExtension(context: vscode.ExtensionContext) {
     /* Variables view */
     const pgvars = setupPgVariablesView(context);
 
-    /* Completion support for postgresql.conf */
-    setupPgConfSupport(context);
-    
-    /* Setup debugger specific function */
-    dbg.setupDebugger(context, pgvars);
-    
     /* Formatter */
     setupFormatting();
-    
+
+    /* Completion support for postgresql.conf */
+    setupPgConfSupport(context);
+
     /* Miscellaneous (remaining) commands */
     registerCommands(context, pgvars);
 }
 
 function setupPgVariablesView(context: vscode.ExtensionContext) {
     const pgvars = createPgVariablesView(context);
 
-    /* TODO: unused - remove */
-    const nodeVars = new vars.NodeVarRegistry();
-    setupNodeTagFiles(context, nodeVars);
+    /* Setup debugger specific function */
+    dbg.setupDebugger(context, pgvars);
 
     return pgvars;
 }
 
 function setupConfigurationFile(context: vscode.ExtensionContext) {
     /* Mark configuration dirty when user changes it - no eager parsing */
-    const configFileWatcher = vscode.workspace.createFileSystemWatcher(Configuration.ExtensionSettingsFileName, false, false, true);
-    context.subscriptions.push(configFileWatcher);
-    configFileWatcher.onDidChange(markConfigFileDirty, undefined, context.subscriptions);
-    configFileWatcher.onDidCreate(markConfigFileDirty, undefined, context.subscriptions);
+    const registerFolderWatcher = (folder: vscode.WorkspaceFolder) => {
+        const pattern = new vscode.RelativePattern(
+            folder, `.vscode/${Configuration.ExtensionSettingsFileName}`);
+        const configFileWatcher = vscode.workspace.createFileSystemWatcher(
+            pattern, false, false, false);
+        context.subscriptions.push(configFileWatcher);
+        configFileWatcher.onDidChange(markConfigFileDirty, undefined, context.subscriptions);
+        configFileWatcher.onDidCreate(markConfigFileDirty, undefined, context.subscriptions);
+        configFileWatcher.onDidDelete(markConfigFileDirty, undefined, context.subscriptions);  
+    };
+    
+    if (vscode.workspace.workspaceFolders?.length) {
+        vscode.workspace.workspaceFolders.forEach(registerFolderWatcher);
+    } else {
+        vscode.workspace.onDidChangeWorkspaceFolders(e => {
+            e.added.forEach(registerFolderWatcher);
+        }, undefined, context.subscriptions);
+    }
 }
 
 function registerCommands(context: vscode.ExtensionContext, pgvars: vars.PgVariablesViewProvider) {
@@ -627,6 +637,7 @@ function registerCommands(context: vscode.ExtensionContext, pgvars: vars.PgVaria
                             simplehash: [],
                             enums: [],
                             typedefs: [],
+                            nodetags: [],
                         },
                         undefined, '    '));
                 } catch (err: unknown) {
@@ -719,77 +730,7 @@ function registerCommands(context: vscode.ExtensionContext, pgvars: vars.PgVaria
     registerCommand(Configuration.Commands.FindCustomTypedefsLists, findCustomTypedefsListCmd);
 }
 
-async function setupNodeTagFiles(context: vscode.ExtensionContext,
-                                 nodeVars: vars.NodeVarRegistry) {
-    /* TODO: remove this thing with setting */
-    const getNodeTagFiles = () => {
-        /* TODO: remove this setting */
-        const customNodeTagFiles = Configuration.getCustomNodeTagFiles();
-        if (customNodeTagFiles?.length) {
-            return customNodeTagFiles;
-        }
-
-        return [
-            /* TODO: use getWorkspacePgSrcFile */
-            utils.getPgSrcFile('src', 'include', 'nodes', 'nodes.h'),
-            utils.getPgSrcFile('src', 'include', 'nodes', 'nodetags.h'),
-        ];
-    };
-    
-    const handleNodeTagFile = async (path: vscode.Uri) => {
-        if (!await utils.fileExists(path)) {
-            return;
-        }
-
-        logger.debug('processing %s NodeTags file', path.fsPath);
-        const document = await vscode.workspace.openTextDocument(path);
-        try {
-            const added = nodeVars.updateNodeTypesFromFile(document);
-            logger.debug('added %i NodeTags from %s file', added, path.fsPath);
-        } catch (err: unknown) {
-            logger.error('could not initialize node tags array', err);
-        }
-    };
-
-    const setupSingleFolder = async (folder: vscode.WorkspaceFolder) => {
-        const nodeTagFiles = getNodeTagFiles();
-
-        for (const filePath of nodeTagFiles) {
-            const file = utils.joinPath(folder.uri, filePath);
-            await handleNodeTagFile(file);
-            const pattern = new vscode.RelativePattern(folder, filePath);
-            const watcher = vscode.workspace.createFileSystemWatcher(pattern,
-                                                                     false, false, 
-                                                                     /* ignoreDeleteEvents */ true);
-            watcher.onDidChange(async uri => {
-                logger.info('detected change in NodeTag file: %s', uri);
-                await handleNodeTagFile(uri);
-            }, context.subscriptions);
-            watcher.onDidCreate(async uri => {
-                logger.info('detected creation of NodeTag file: %s', uri);
-                await handleNodeTagFile(uri);
-            }, context.subscriptions);
-    
-            context.subscriptions.push(watcher);
-        }
-    };
-
-    if (vscode.workspace.workspaceFolders?.length) {
-        /* TODO: throttle */
-        await Promise.all(
-            vscode.workspace.workspaceFolders.map(async folder =>
-                await setupSingleFolder(folder),
-            ),
-        );
-    }
-
-    vscode.workspace.onDidChangeWorkspaceFolders(async e => {
-        for (const folder of e.added) {
-            await setupSingleFolder(folder);
-        }
-    }, undefined, context.subscriptions);
-}
-
+/* TODO: move to configuration.ts */
 export class Configuration {
     static ExtensionName = 'postgresql-hacker-helper';
     static ExtensionPrettyName = 'PostgreSQL Hacker Helper';

src/variables.ts

@@ -5485,6 +5485,18 @@ export class PgVariablesViewProvider implements vscode.TreeDataProvider<Variable
                 logger.error('error occurred during adding enum bitmask types', e);
             }
         }
+
+        if (config.nodetags?.length) {
+            logger.debug('adding %i custom NodeTags');
+            try {
+                /* TODO: add command to parse NodeTag files and find custom */
+                for (const tag of config.nodetags) {
+                    context.nodeVarRegistry.nodeTags.add(tag);
+                }
+            } catch (err) {
+                logger.error('could not add custom NodeTags', err);
+            }
+        }
     }
 
     async tryGetPgVersion(frameId: number) {