add feature to prevent invalid tunables

changes to scripts.js

dont let users save invalud key or value

move tunables.json and add feature

Document allowed tunables and error handling

Added section on allowed tunables and their validation process.

Exclude tunables.json from RAT and prettier

Author: Adedoyin Ogunjobi

constants/tunables.json

@@ -0,0 +1,35 @@
+{
+    "allowExpressionResultCoercion": "boolean",
+    "allowExternalPathExpressions": "boolean",
+    "allowSignedIntegerLength1Bit": "boolean",
+  
+    "blobChunkSizeInBytes": "number",
+  
+    "defaultEmptyElementParsePolicy": "string",
+  
+    "escalateWarningsToErrors": "boolean",
+  
+    "generatedNamespacePrefixStem": "string",
+  
+    "initialElementOccurrencesHint": "number",
+    "initialRegexMatchLimitInCharacters": "number",
+  
+    "infosetWalkerSkipMin": "number",
+    "infosetWalkerSkipMax": "number",
+  
+    "invalidRestrictionPolicy": "string",
+  
+    "maxBinaryDecimalVirtualPoint": "number",
+    "maxByteArrayOutputStreamBufferSizeInBytes": "number",
+    "maxDataDumpSizeInBytes": "number",
+    "maxHexBinaryLengthInBytes": "number",
+  
+    "maxOccursBounds": "number",
+  
+    "parseUnparsePolicy": "string",
+  
+    "releaseUnneededInfoset": "boolean",
+  
+    "requireBitOrderProperty": "boolean",
+    "requireEmptyElementParsePolicyProperty": "boolean"
+  }

doc/Wiki.md

@@ -372,12 +372,21 @@ Tunables are configured using **Key** and **Value** fields in the launch configu
 
 Use the **“+ Add Tunable”** button to add additional entries. Each row can be removed using the **“X”** button.
 
+Tunables are case sensitive, and only allowed tunables will be allowed to be saved in the wizard.
+
 Tunables control runtime behavior and performance characteristics. Most tunables have default values, so you only need to specify a value if you want to override them.
 
 <img width="790" height="176" alt="tunables_gui" src="https://github.com/user-attachments/assets/f78d5471-bfff-4cfb-b6cf-62c787a8e31b" />
 
 <img width="360" height="177" alt="tunables_launchjson" src="https://github.com/user-attachments/assets/0d70044d-d04c-4f47-958c-175c6e67f3f9" />
 
+### List of allowed Tunables
+
+In order to prevent unexpected tunables from being ran, there is a list of allowed tunables at `constants/tunables.json` which contains all valid tunables. Tunables are case sensitive and the values type must match what is expected. For example boolean values will only allow true or false. If a invalid tunable is saved in the `launch.json` , when you attempt to run daffodil you will encounter a error saying `Cancel` or `Ignore invalid tunable`. Cancel will send you back where you fix the error, and Ignore invalid tunable runs daffodil but does not register the invalid tunable. The tunable will stay in your launch.json however. The tunables.json file will be updated as new tunables are added and removed.
+
+<img width="914" height="718" alt="image" src="https://github.com/user-attachments/assets/22b24b29-de7e-4ec9-b012-85fe8f1bb54c" />
+
+
 ### Reference
 - https://daffodil.apache.org/tunables/
 

project/Rat.scala

@@ -52,6 +52,7 @@ object Rat {
     file("build/package/NOLICENSE"),
     file("build/package/NONOTICE"),
     file("src/tests/data/test.txt"),
+    file("constants/tunables.json"),
     file("debugger/src/test/data/emptyData.xml"),
     file("debugger/src/test/data/emptyInfoset.xml"),
     file("debugger/src/test/data/notInfoset.xml"),

src/adapter/activateDaffodilDebug.ts

@@ -18,6 +18,7 @@ import * as rootCompletion from '../rootCompletion'
 import { tmpdir } from 'os'
 import JSZip from 'jszip'
 import { rm } from 'node:fs/promises'
+import { getTunables } from './extension'
 
 import {
   CancellationToken,
@@ -766,16 +767,15 @@ class DaffodilConfigurationProvider
   constructor(context: vscode.ExtensionContext) {
     this.context = context
   }
-
   /**
    * Massage a debug configuration just before a debug session is being launched,
    * e.g. add all missing attributes to the debug configuration.
    */
-  resolveDebugConfiguration(
+  async resolveDebugConfiguration(
     folder: WorkspaceFolder | undefined,
     config: DebugConfiguration,
     token?: CancellationToken
-  ): ProviderResult<DebugConfiguration> {
+  ): Promise<DebugConfiguration | undefined> {
     // if launch.json is missing or empty
     if (!config.type && !config.request && !config.name) {
       config = getConfig({ name: 'Launch', request: 'launch', type: 'dfdl' })
@@ -791,6 +791,31 @@ class DaffodilConfigurationProvider
       data: config.data || '${command:AskForDataName}',
     }
 
+    const validTunables = getTunables(this.context)
+    const currentTunables = config.tunables ?? {}
+    const invalidTunables = Object.keys(currentTunables).filter(
+      (name) => !validTunables.includes(name)
+    )
+
+    if (invalidTunables.length > 0) {
+      const choice = await vscode.window.showWarningMessage(
+        `Invalid tunables found:\n\n${invalidTunables.join('\n')}`,
+        { modal: true },
+        'Ignore Invalid Tunables'
+      )
+
+      // If the user dismisses the checkbox in anyway it will exit. so Cancel , Esc or unexpected values will exit
+      // Only pressing ignore invalid tunables will proceed with the launch and remove the invalid tunables from the config sent to the debug adapter
+      if (choice !== 'Ignore Invalid Tunables') {
+        return undefined
+      }
+      //Copies the tunables , then deletes the invalid tunables from the copied config so that the user can still see the invalid tunables in their launch.json but they won't be sent to the debug adapter and cause errors
+      config.tunables = { ...config.tunables }
+
+      for (const invalid of invalidTunables) {
+        delete config.tunables[invalid]
+      }
+    }
     let dataFolder = config.data
 
     if (

src/adapter/extension.ts

@@ -19,6 +19,8 @@
 
 import * as vscode from 'vscode'
 import * as position from '../position'
+import * as fs from 'fs'
+import * as path from 'path'
 import { ProviderResult } from 'vscode'
 import { DaffodilDebugSession } from './daffodilDebug'
 import {
@@ -45,6 +47,15 @@ export function deactivate() {
   position.deactivate()
 }
 
+export function getTunables(context: vscode.ExtensionContext): string[] {
+  const file = path.join(context.extensionPath, 'constants', 'tunables.json')
+
+  const data = fs.readFileSync(file, 'utf8')
+  const json = JSON.parse(data)
+
+  return Object.keys(json)
+}
+
 export class InlineDebugAdapterFactory
   implements vscode.DebugAdapterDescriptorFactory
 {

src/launchWizard/launchWizard.ts

@@ -22,6 +22,7 @@ import { DFDLDebugger } from '../classes/dfdlDebugger'
 import { VSCodeLaunchConfigArgs } from '../classes/vscode-launch'
 import { DataEditorConfig } from '../classes/dataEditor'
 import { parse as jsoncParse } from 'jsonc-parser'
+import * as path from 'path'
 
 let launchWizard: LaunchWizard | undefined
 
@@ -279,6 +280,20 @@ async function createWizard(ctx: vscode.ExtensionContext) {
   let panel = launchWiz.getPanel()
   panel.webview.html = launchWiz.getWebViewContent()
 
+  //Read in list of valid
+
+  const tunablesPath = path.join(
+    ctx.extensionPath,
+    'constants',
+    'tunables.json'
+  )
+
+  const tunables = JSON.parse(fs.readFileSync(tunablesPath, 'utf8'))
+  panel.webview.postMessage({
+    command: 'loadTunables',
+    tunables: tunables,
+  })
+
   panel.webview.onDidReceiveMessage(
     async (message) => {
       switch (message.command) {

src/launchWizard/script.js

@@ -348,6 +348,19 @@ function save() {
       )
   }
 
+  // Blocks save if tunable isnt valid. This means we have to always make sure the tunable list is valid.
+  // should we just warn the user that it will case errors and let them submit
+  validateTunablesTable()
+
+  const hasErrors = [
+    ...document.querySelectorAll('#tunablesTableBody .tunable-error'),
+  ].some((el) => el.textContent.trim())
+
+  if (hasErrors) {
+    console.warn('Cannot save: invalid tunables present')
+    return
+  }
+
   vscode.postMessage({
     command: 'saveConfig',
     data: JSON.stringify(obj, null, 4),
@@ -360,11 +373,14 @@ function addTunableRow() {
 
   const row = document.createElement('tr')
 
-  row.innerHTML = `
-    <td><input class="file-input" /></td>
-    <td><input class="file-input" /></td>
-    <td><button onclick="this.closest('tr').remove()">X</button></td>
-  `
+  row.innerHTML = row.innerHTML = `
+  <td>
+    <input class="file-input" />
+    <div class="tunable-error" style="color:red;font-size:12px"></div>
+  </td>
+  <td><input class="file-input" /></td>
+  <td><button onclick="this.closest('tr').remove()">X</button></td>
+`
 
   tableBody.appendChild(row)
 }
@@ -403,10 +419,19 @@ function renderTunables(tunables = {}) {
     const row = document.createElement('tr')
 
     row.innerHTML = `
-      <td><input class="file-input" value="${escapeHtml(key)}" /></td>
-      <td><input class="file-input" value="${escapeHtml(value)}" /></td>
-      <td><button onclick="this.closest('tr').remove()">X</button></td>
-    `
+  <td>
+    <input class="file-input" value="${escapeHtml(key)}" />
+    <div class="tunable-error" style="color:red;font-size:12px;"></div>
+  </td>
+
+  <td>
+    <input class="file-input" value="${escapeHtml(value)}" />
+  </td>
+
+  <td>
+    <button onclick="this.closest('tr').remove()">X</button>
+  </td>
+`
 
     tableBody.appendChild(row)
   })
@@ -463,6 +488,56 @@ function renderVariables(variables = {}) {
     tableBody.appendChild(row)
   })
 }
+let VALID_TUNABLES = {}
+
+// Validates tunables. validates against list of tunables and the value expected
+function validateTunablesTable() {
+  const rows = document.querySelectorAll('#tunablesTableBody tr')
+
+  rows.forEach((row) => {
+    const keyInput = row.children[0].querySelector('input')
+    const valueInput = row.children[1].querySelector('input')
+    const errorDiv = row.children[0].querySelector('.tunable-error')
+
+    if (!keyInput || !valueInput || !errorDiv) return
+
+    const key = keyInput.value.trim()
+    const value = valueInput.value.trim()
+
+    let error = ''
+
+    //Case sensitive check for valid tunables. If not valid, check for case insensitive match and suggest that to the user.
+    if (key && !VALID_TUNABLES[key]) {
+      const match = Object.keys(VALID_TUNABLES).find(
+        (t) => t.toLowerCase() === key.toLowerCase()
+      )
+
+      error = match
+        ? `Invalid tunable. Did you mean "${match}"? (case sensitive)`
+        : 'Invalid tunable'
+    } else if (key && value) {
+      const expectedType = VALID_TUNABLES[key]
+
+      if (expectedType === 'boolean') {
+        if (value !== 'true' && value !== 'false') {
+          error = 'Value must be boolean (true/false)'
+        }
+      }
+
+      if (expectedType === 'number') {
+        if (isNaN(Number(value))) {
+          error = 'Value must be a number'
+        }
+      }
+
+      if (expectedType === 'string') {
+        // strings are always valid
+      }
+    }
+
+    errorDiv.textContent = error
+  })
+}
 
 // Function to copy selected config
 function copyConfig() {
@@ -586,6 +661,12 @@ async function updateConfigValues(config) {
 
   renderTunables(config.tunables || {})
   renderVariables(config.variables || {})
+  document
+    .getElementById('tunablesTableBody')
+    ?.addEventListener('blur', validateTunablesTable, true) // remove true and change blur to input if we want this to validate on each key
+
+  // catches any invalid tunables on load.
+  validateTunablesTable()
   updateInfosetOutputType()
   updateTDMLAction()
 
@@ -615,6 +696,10 @@ async function updateDaffodilDebugClasspath(message) {
     const message = event.data
 
     switch (message.command) {
+      case 'loadTunables':
+        VALID_TUNABLES = message.tunables
+        // validateTunablesTable()
+        break
       case 'updateConfValues':
         await updateConfigValues(message.configValues)
         break