feat: add versioning for backend config

Author: LastLeaf

backend-configuration/sample.toml

@@ -1,3 +1,10 @@
+[glass-easel-backend-config]
+name = "sample"
+description = "Sample backend configuration."
+major-version = 1
+minor-version = 0
+
+
 [[global-attribute]]
 name = "tabindex"
 description = "The tab-index of the element."

backend-configuration/web/README.md

@@ -0,0 +1,19 @@
+# The web backend configuration
+
+This is a backend configuration generator by collecting data from MDN.
+
+
+## Usage
+
+To init local environment, use:
+
+`npm run init-dev`
+
+To build the result backend configuration (a.k.a. `web.toml` file), use:
+
+`npm run build`
+
+To update MDN data, use:
+
+`npm run update-mdn`
+

backend-configuration/web/extract.ts

@@ -179,6 +179,13 @@ fs.writeSync(
   '# See the license in [LICENSE](https://github.com/mdn/content/blob/main/LICENSE.md).\n',
 )
 fs.writeSync(outFile, '\n')
+fs.writeSync(outFile, `[glass-easel-backend-config]
+name = "web"
+description = "Backend configuration for web environment."
+build-timestamp = ${Math.floor(Date.now() / 1000)}
+major-version = 1
+minor-version = 0
+`)
 
 // enumerate global attributes
 fs.writeSync(outFile, `\n`)

backend-configuration/web/package.json

@@ -0,0 +1,12 @@
+{
+  "private": true,
+  "devDependencies": {
+    "@types/node": "~22.9.0",
+    "ts-node": "^10.9.2"
+  },
+  "scripts": {
+    "init-dev": "git submodule update --init mdn",
+    "update-mdn": "git submodule update --remote --init mdn",
+    "build": "ts-node extract.ts"
+  }
+}

backend-configuration/web/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "module": "CommonJS",
+    "target": "es2020",
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "lib": ["ES6", "ES7", "DOM", "ESNext"],
+    "types": ["node"],
+    "preserveConstEnums": true,
+    "stripInternal": true
+  },
+  "include": [
+      "**/*.ts"
+  ]
+}

backend-configuration/web/web.toml

@@ -2,6 +2,12 @@
 # The content is published under [CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).
 # See the license in [LICENSE](https://github.com/mdn/content/blob/main/LICENSE.md).
 
+[glass-easel-backend-config]
+name = "web"
+description = "Backend configuration for web environment."
+build-timestamp = 1762329893
+major-version = 1
+minor-version = 0
 
 [[global-attribute]]
 name = "accesskey"

pnpm-lock.yaml

@@ -1,3 +1,4 @@
 packages:
   - 'vscode-extension'
   - 'ts-server-bundled'
+  - 'backend-configuration/web'

pnpm-workspace.yaml

@@ -3,6 +3,8 @@ use lsp_types::Url;
 #[derive(Debug, Clone, Default, serde::Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub(crate) struct BackendConfig {
+    #[serde(default)]
+    pub(crate) glass_easel_backend_config: GlassEaselBackendConfig,
     #[serde(default)]
     pub(crate) element: Vec<ElementConfig>,
     #[serde(default)]
@@ -23,6 +25,21 @@ pub(crate) struct BackendConfig {
     pub(crate) style_property: Vec<StylePropertyConfig>,
 }
 
+#[derive(Debug, Clone, Default, serde::Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub(crate) struct GlassEaselBackendConfig {
+    #[serde(default)]
+    pub(crate) name: String,
+    #[serde(default)]
+    #[allow(dead_code)]
+    pub(crate) description: String,
+    #[serde(default)]
+    pub(crate) major_version: u32,
+    #[serde(default)]
+    #[allow(dead_code)]
+    pub(crate) minor_version: u32,
+}
+
 #[derive(Debug, Clone, serde::Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub(crate) struct ElementConfig {
@@ -108,6 +125,18 @@ pub(crate) struct EventConfig {
 }
 
 impl BackendConfig {
+    pub(crate) fn parse_str(s: &str) -> anyhow::Result<Self> {
+        let config: Self = toml::from_str(s)?;
+        let major_version = config.glass_easel_backend_config.major_version;
+        if major_version < 1 {
+            log::warn!("This backend configuration may be problematic. Please check the updates of it.");
+        } else if major_version > 1 {
+            Err(anyhow::Error::msg("The backend configuration is designed for a later version of glass-easel-analyzer."))?;
+        }
+        log::info!("Loaded backend configuration: {}", config.glass_easel_backend_config.name);
+        Ok(config)
+    }
+
     pub(crate) fn search_element(&self, tag_name: &str) -> Option<&ElementConfig> {
         self.element.iter().find(|x| x.tag_name == tag_name)
     }

src/context/backend_configuration.rs

@@ -400,32 +400,6 @@ async fn serve() -> anyhow::Result<()> {
     };
     connection.initialize_finish(initialize_id, serde_json::to_value(initialize_result)?)?;
 
-    // parse backend configuration
-    let mut backend_config_failure = None;
-    let has_backend_config = !initialize_params
-        .initialization_options
-        .backend_config
-        .is_empty();
-    let backend_config = if !has_backend_config {
-        Default::default()
-    } else {
-        match toml::from_str(&initialize_params.initialization_options.backend_config) {
-            Ok(x) => x,
-            Err(err) => {
-                backend_config_failure = Some(err);
-                Default::default()
-            }
-        }
-    };
-    tokio::spawn(async move {
-        tokio::time::sleep(std::time::Duration::from_secs(1)).await;
-        if !has_backend_config {
-            log::warn!("Missing glass-easel backend configuration");
-        } else if let Some(err) = backend_config_failure {
-            log::error!("Failed to parse glass-easel backend configuration: {}", err);
-        }
-    });
-
     // register capabilities
     let registrations = lsp_types::RegistrationParams {
         registrations: vec![lsp_types::Registration {
@@ -462,6 +436,24 @@ async fn serve() -> anyhow::Result<()> {
         }
     }
 
+    // parse backend configuration
+    let has_backend_config = !initialize_params
+        .initialization_options
+        .backend_config
+        .is_empty();
+    let backend_config = if !has_backend_config {
+        log::warn!("Missing glass-easel backend configuration");
+        Default::default()
+    } else {
+        match BackendConfig::parse_str(&initialize_params.initialization_options.backend_config) {
+            Ok(x) => x,
+            Err(err) => {
+                log::error!("Failed to parse glass-easel backend configuration: {}", err);
+                Default::default()
+            }
+        }
+    };
+
     // generate a `ServerContext`
     let Connection {
         sender: lsp_sender,
@@ -483,6 +475,8 @@ async fn serve() -> anyhow::Result<()> {
         );
         (server_context, sender)
     };
+
+    // from this on the log can be shown in the lsp client
     logger::set_trace(
         server_context.clone(),
         lsp_types::SetTraceParams {