shape-runtime 0.3.2

Bytecode compiler, builtins, and runtime infrastructure for Shape
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
//! Provider registry for managing named data providers
//!
//! This module provides a registry system that allows multiple data providers
//! to be registered by name and accessed at runtime. This enables:
//! - Multiple data sources (data, CSV, APIs, future plugins)
//! - Provider selection in Shape code via module-scoped calls
//!   (for example, `provider.load({...})`)
//! - Default provider for convenience

use crate::data::SharedAsyncProvider;
use crate::plugins::{
    CapabilityKind, LoadedPlugin, ParsedModuleSchema, ParsedOutputSchema, ParsedQuerySchema,
    PluginDataSource, PluginLoader, PluginModule,
};
use shape_ast::error::{Result, ShapeError};
use shape_wire::WireValue;
use std::collections::HashMap;
use std::path::Path;
use std::sync::{Arc, RwLock};

/// Registry of named data providers
///
/// Allows registration of multiple providers and selection by name.
/// Thread-safe for use in concurrent contexts.
///
/// # Example
///
/// ```ignore
/// let mut registry = ProviderRegistry::new();
///
/// // Register market data provider
/// let md_provider = Arc::new(DataFrameAdapter::new(...));
/// registry.register("data", md_provider);
///
/// // Register an additional provider
/// let alt_provider = Arc::new(AnotherProvider::new(...));
/// registry.register("alt", alt_provider);
///
/// // Set default
/// registry.set_default("data")?;
///
/// // Get provider by name
/// let provider = registry.get("data")?;
/// ```
#[derive(Clone)]
pub struct ProviderRegistry {
    /// Map of provider name to provider instance
    providers: Arc<RwLock<HashMap<String, SharedAsyncProvider>>>,
    /// Name of the default provider
    default_provider: Arc<RwLock<Option<String>>>,
    /// Map of plugin name to plugin data source wrapper
    extension_sources: Arc<RwLock<HashMap<String, Arc<PluginDataSource>>>>,
    /// Map of plugin name to plugin module-capability wrapper.
    extension_modules: Arc<RwLock<HashMap<String, Arc<PluginModule>>>>,
    /// Metadata for all loaded extension modules (not just data-source modules).
    loaded_extensions: Arc<RwLock<HashMap<String, LoadedPlugin>>>,
    /// Plugin loader for dynamic plugins
    extension_loader: Arc<RwLock<PluginLoader>>,
    /// Map of language identifier to loaded language runtime
    language_runtimes:
        Arc<RwLock<HashMap<String, Arc<crate::plugins::language_runtime::PluginLanguageRuntime>>>>,
}

impl ProviderRegistry {
    /// Create a new empty provider registry
    pub fn new() -> Self {
        Self {
            providers: Arc::new(RwLock::new(HashMap::new())),
            default_provider: Arc::new(RwLock::new(None)),
            extension_sources: Arc::new(RwLock::new(HashMap::new())),
            extension_modules: Arc::new(RwLock::new(HashMap::new())),
            loaded_extensions: Arc::new(RwLock::new(HashMap::new())),
            extension_loader: Arc::new(RwLock::new(PluginLoader::new())),
            language_runtimes: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Register a provider with a name
    ///
    /// # Arguments
    ///
    /// * `name` - Provider name (e.g., "data", "api", "warehouse")
    /// * `provider` - AsyncDataProvider implementation
    ///
    /// # Example
    ///
    /// ```ignore
    /// registry.register("data", Arc::new(DataFrameAdapter::new(...)));
    /// ```
    pub fn register(&self, name: &str, provider: SharedAsyncProvider) {
        let mut providers = self.providers.write().unwrap();
        providers.insert(name.to_string(), provider);
    }

    /// Get provider by name
    ///
    /// # Arguments
    ///
    /// * `name` - Provider name to lookup
    ///
    /// # Returns
    ///
    /// SharedAsyncProvider if found, None otherwise
    pub fn get(&self, name: &str) -> Option<SharedAsyncProvider> {
        let providers = self.providers.read().unwrap();
        providers.get(name).cloned()
    }

    /// Set default provider
    ///
    /// # Arguments
    ///
    /// * `name` - Name of provider to use as default
    ///
    /// # Errors
    ///
    /// Returns error if provider with given name is not registered
    pub fn set_default(&self, name: &str) -> Result<()> {
        let providers = self.providers.read().unwrap();
        if !providers.contains_key(name) {
            return Err(ShapeError::RuntimeError {
                message: format!("Cannot set default provider: '{}' is not registered", name),
                location: None,
            });
        }
        drop(providers);

        let mut default = self.default_provider.write().unwrap();
        *default = Some(name.to_string());
        Ok(())
    }

    /// Get default provider
    ///
    /// # Returns
    ///
    /// SharedAsyncProvider if a default is set, None otherwise
    pub fn get_default(&self) -> Option<SharedAsyncProvider> {
        let default = self.default_provider.read().unwrap();
        let name = default.as_ref().cloned();
        drop(default);

        name.and_then(|n| self.get(&n))
    }

    /// Get default provider name
    pub fn default_name(&self) -> Option<String> {
        let default = self.default_provider.read().unwrap();
        default.clone()
    }

    /// List all registered provider names
    ///
    /// # Returns
    ///
    /// Vector of provider names currently registered
    pub fn list_providers(&self) -> Vec<String> {
        let providers = self.providers.read().unwrap();
        providers.keys().cloned().collect()
    }

    /// Check if a provider is registered
    pub fn has_provider(&self, name: &str) -> bool {
        let providers = self.providers.read().unwrap();
        providers.contains_key(name)
    }

    /// Unregister a provider
    ///
    /// # Arguments
    ///
    /// * `name` - Provider name to remove
    ///
    /// # Returns
    ///
    /// true if provider was removed, false if not found
    pub fn unregister(&self, name: &str) -> bool {
        let mut providers = self.providers.write().unwrap();
        let removed = providers.remove(name).is_some();

        // Clear default if it was the removed provider
        if removed {
            let mut default = self.default_provider.write().unwrap();
            if default.as_ref().map(|s| s == name).unwrap_or(false) {
                *default = None;
            }
        }

        removed
    }

    /// Clear all providers
    pub fn clear(&self) {
        let mut providers = self.providers.write().unwrap();
        providers.clear();

        let mut default = self.default_provider.write().unwrap();
        *default = None;

        let mut extension_sources = self.extension_sources.write().unwrap();
        extension_sources.clear();

        let mut extension_modules = self.extension_modules.write().unwrap();
        extension_modules.clear();

        let mut loaded_extensions = self.loaded_extensions.write().unwrap();
        loaded_extensions.clear();

        let mut runtimes = self.language_runtimes.write().unwrap();
        runtimes.clear();
    }

    // ========================================================================
    // Extension Management
    // ========================================================================

    /// Load an extension module from a shared library
    ///
    /// # Arguments
    ///
    /// * `path` - Path to the extension shared library (.so, .dll, .dylib)
    /// * `config` - Configuration value for the extension
    ///
    /// # Returns
    ///
    /// Information about the loaded extension
    ///
    /// # Safety
    ///
    /// Loading modules executes arbitrary code. Only load from trusted sources.
    pub fn load_extension(&self, path: &Path, config: &serde_json::Value) -> Result<LoadedPlugin> {
        // Load the library and collect declared capabilities.
        let mut loader = self.extension_loader.write().unwrap();
        let loaded_info = loader.load(path)?;
        let name = loaded_info.name.clone();

        // If this module provides a data-source capability, initialize the
        // PluginDataSource wrapper for runtime query execution.
        if loaded_info.has_capability_kind(CapabilityKind::DataSource) {
            let vtable = loader.get_data_source_vtable(&name)?;
            let source = PluginDataSource::new(name.clone(), vtable, config)?;

            let mut sources = self.extension_sources.write().unwrap();
            sources.insert(name.clone(), Arc::new(source));
        } else {
            // Ensure stale data-source wrappers are removed if a module is reloaded
            // with a different capability set.
            let mut sources = self.extension_sources.write().unwrap();
            sources.remove(&name);
        }

        // If the plugin exposes a module capability (`shape.module`), bind its
        // functions so VM module namespaces can dispatch through capability
        // contracts.
        if let Ok(module_vtable) = loader.get_module_vtable(&name) {
            if let Ok(module) = PluginModule::new(name.clone(), module_vtable, config) {
                let mut modules = self.extension_modules.write().unwrap();
                modules.insert(name.clone(), Arc::new(module));
            }
        }

        // If this plugin provides a language runtime capability, initialize it.
        if loaded_info.has_capability_kind(CapabilityKind::LanguageRuntime) {
            let vtable = loader.get_language_runtime_vtable(&name)?;
            let runtime =
                crate::plugins::language_runtime::PluginLanguageRuntime::new(vtable, config)?;
            let lang_id = runtime.language_id().to_string();
            let mut runtimes = self.language_runtimes.write().unwrap();
            runtimes.insert(lang_id, Arc::new(runtime));
        }

        let mut loaded_extensions = self.loaded_extensions.write().unwrap();
        loaded_extensions.insert(name, loaded_info.clone());

        Ok(loaded_info)
    }

    /// Load an extension, merging claimed TOML section data into its init config.
    ///
    /// For each section claimed by the extension, looks it up in the project's
    /// `extension_sections` and merges the data as JSON into the config.
    /// Errors if a required section is missing.
    pub fn load_extension_with_sections(
        &self,
        path: &Path,
        config: &serde_json::Value,
        extension_sections: &std::collections::HashMap<String, toml::Value>,
        all_claimed: &mut std::collections::HashSet<String>,
    ) -> Result<LoadedPlugin> {
        // First, load the extension normally to get its section claims
        let mut loader = self.extension_loader.write().unwrap();
        let loaded_info = loader.load(path)?;
        let name = loaded_info.name.clone();

        // Collect claimed section names and check for collisions
        for claim in &loaded_info.claimed_sections {
            if !all_claimed.insert(claim.name.clone()) {
                return Err(ShapeError::RuntimeError {
                    message: format!(
                        "Section '{}' is claimed by multiple extensions (collision detected when loading '{}')",
                        claim.name, name
                    ),
                    location: None,
                });
            }
        }

        // Build merged config: start with the extension's own config, then
        // overlay any claimed section data.
        let mut merged_config = config.clone();
        if let serde_json::Value::Object(ref mut map) = merged_config {
            for claim in &loaded_info.claimed_sections {
                if let Some(section_value) = extension_sections.get(&claim.name) {
                    let json_value = crate::project::toml_to_json(section_value);
                    map.insert(claim.name.clone(), json_value);
                } else if claim.required {
                    return Err(ShapeError::RuntimeError {
                        message: format!(
                            "Extension '{}' requires section '[{}]' in shape.toml, but it is missing",
                            name, claim.name
                        ),
                        location: None,
                    });
                }
            }
        }

        // Now initialize data source / module capabilities with the merged config.
        if loaded_info.has_capability_kind(CapabilityKind::DataSource) {
            let vtable = loader.get_data_source_vtable(&name)?;
            let source = PluginDataSource::new(name.clone(), vtable, &merged_config)?;
            let mut sources = self.extension_sources.write().unwrap();
            sources.insert(name.clone(), Arc::new(source));
        } else {
            let mut sources = self.extension_sources.write().unwrap();
            sources.remove(&name);
        }

        if let Ok(module_vtable) = loader.get_module_vtable(&name) {
            if let Ok(module) = PluginModule::new(name.clone(), module_vtable, &merged_config) {
                let mut modules = self.extension_modules.write().unwrap();
                modules.insert(name.clone(), Arc::new(module));
            }
        }

        if loaded_info.has_capability_kind(CapabilityKind::LanguageRuntime) {
            let vtable = loader.get_language_runtime_vtable(&name)?;
            let runtime = crate::plugins::language_runtime::PluginLanguageRuntime::new(
                vtable,
                &merged_config,
            )?;
            let lang_id = runtime.language_id().to_string();
            let mut runtimes = self.language_runtimes.write().unwrap();
            runtimes.insert(lang_id, Arc::new(runtime));
        }

        let mut loaded_extensions = self.loaded_extensions.write().unwrap();
        loaded_extensions.insert(name, loaded_info.clone());

        Ok(loaded_info)
    }

    /// Get a language runtime by language identifier (e.g., "python").
    pub fn get_language_runtime(
        &self,
        language_id: &str,
    ) -> Option<Arc<crate::plugins::language_runtime::PluginLanguageRuntime>> {
        let runtimes = self.language_runtimes.read().unwrap();
        runtimes.get(language_id).cloned()
    }

    /// Return all loaded language runtimes, keyed by language identifier.
    pub fn language_runtimes(
        &self,
    ) -> std::collections::HashMap<
        String,
        Arc<crate::plugins::language_runtime::PluginLanguageRuntime>,
    > {
        let runtimes = self.language_runtimes.read().unwrap();
        runtimes.clone()
    }

    /// Return child-LSP configurations declared by loaded language runtimes.
    pub fn language_runtime_lsp_configs(
        &self,
    ) -> Vec<crate::plugins::language_runtime::RuntimeLspConfig> {
        let runtimes = self.language_runtimes.read().unwrap();
        let mut configs = Vec::new();

        for runtime in runtimes.values() {
            match runtime.lsp_config() {
                Ok(Some(config)) => configs.push(config),
                Ok(None) => {}
                Err(err) => {
                    tracing::warn!("failed to query language runtime LSP config: {}", err);
                }
            }
        }

        configs.sort_by(|left, right| left.language_id.cmp(&right.language_id));
        configs
    }

    /// Get an extension data source by name
    ///
    /// # Arguments
    ///
    /// * `name` - Extension name
    ///
    /// # Returns
    ///
    /// The PluginDataSource if found
    pub fn get_extension(&self, name: &str) -> Option<Arc<PluginDataSource>> {
        let sources = self.extension_sources.read().unwrap();
        sources.get(name).cloned()
    }

    /// Get extension module schema by module namespace name.
    pub fn get_extension_module_schema(&self, module_name: &str) -> Option<ParsedModuleSchema> {
        let modules = self.extension_modules.read().unwrap();
        modules
            .values()
            .find(|m| m.schema().module_name == module_name)
            .map(|m| m.schema().clone())
    }

    /// Build runtime extension modules from all loaded extension module capabilities.
    ///
    /// Strict-typing follow-up `plugin-typed-abi`: the `ValueWord`-typed
    /// dispatch shim was removed with the bulldozer; plugins are inert
    /// until they declare typed signatures at registration. See the
    /// 2026-05-06 entry in `docs/defections.md`.
    pub fn module_exports_from_extensions(&self) -> Vec<crate::module_exports::ModuleExports> {
        Vec::new()
    }

    /// Invoke a module-capability export by module namespace and function name.
    pub fn invoke_extension_module_wire(
        &self,
        module_name: &str,
        function: &str,
        args: &[WireValue],
    ) -> Result<WireValue> {
        let modules = self.extension_modules.read().unwrap();
        let module = modules
            .values()
            .find(|m| m.schema().module_name == module_name)
            .ok_or_else(|| ShapeError::RuntimeError {
                message: format!("Module namespace '{}' is not loaded", module_name),
                location: None,
            })?;
        module.invoke_wire(function, args)
    }

    /// Get query schema for an extension (for LSP autocomplete)
    ///
    /// # Arguments
    ///
    /// * `name` - Extension name
    ///
    /// # Returns
    ///
    /// The query schema if extension exists
    pub fn get_extension_query_schema(&self, name: &str) -> Option<ParsedQuerySchema> {
        let sources = self.extension_sources.read().unwrap();
        sources.get(name).map(|s| s.get_query_schema().clone())
    }

    /// Get output schema for an extension (for LSP autocomplete)
    ///
    /// # Arguments
    ///
    /// * `name` - Extension name
    ///
    /// # Returns
    ///
    /// The output schema if extension exists
    pub fn get_extension_output_schema(&self, name: &str) -> Option<ParsedOutputSchema> {
        let sources = self.extension_sources.read().unwrap();
        sources.get(name).map(|s| s.get_output_schema().clone())
    }

    /// List all plugins with their query schemas (for LSP)
    ///
    /// # Returns
    ///
    /// Vector of (plugin_name, query_schema) pairs
    pub fn list_extensions_with_schemas(&self) -> Vec<(String, ParsedQuerySchema)> {
        let sources = self.extension_sources.read().unwrap();
        sources
            .iter()
            .map(|(name, source)| (name.clone(), source.get_query_schema().clone()))
            .collect()
    }

    /// List all loaded extension names
    pub fn list_extensions(&self) -> Vec<String> {
        let loaded = self.loaded_extensions.read().unwrap();
        loaded.keys().cloned().collect()
    }

    /// Check if a plugin is loaded
    pub fn has_extension(&self, name: &str) -> bool {
        let loaded = self.loaded_extensions.read().unwrap();
        loaded.contains_key(name)
    }

    /// Unload an extension
    ///
    /// # Arguments
    ///
    /// * `name` - Extension name to unload
    ///
    /// # Returns
    ///
    /// true if plugin was unloaded, false if not found
    pub fn unload_extension(&self, name: &str) -> bool {
        let mut sources = self.extension_sources.write().unwrap();
        let removed_source = sources.remove(name).is_some();
        drop(sources);

        let mut modules = self.extension_modules.write().unwrap();
        let removed_module = modules.remove(name).is_some();
        drop(modules);

        let mut loaded_extensions = self.loaded_extensions.write().unwrap();
        let removed_plugin = loaded_extensions.remove(name).is_some();
        drop(loaded_extensions);

        if removed_plugin {
            let mut loader = self.extension_loader.write().unwrap();
            loader.unload(name);
        }

        removed_plugin || removed_source || removed_module
    }
}

impl Default for ProviderRegistry {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::data::async_provider::NullAsyncProvider;

    #[test]
    fn test_register_and_get() {
        let registry = ProviderRegistry::new();
        let provider = Arc::new(NullAsyncProvider) as SharedAsyncProvider;

        registry.register("test", provider.clone());

        assert!(registry.has_provider("test"));
        assert!(!registry.has_provider("nonexistent"));
        assert!(registry.get("test").is_some());
    }

    #[test]
    fn test_default_provider() {
        let registry = ProviderRegistry::new();
        let provider = Arc::new(NullAsyncProvider) as SharedAsyncProvider;

        registry.register("test", provider);

        assert!(registry.set_default("test").is_ok());
        assert!(registry.get_default().is_some());
        assert_eq!(registry.default_name(), Some("test".to_string()));
    }

    #[test]
    fn test_set_default_nonexistent() {
        let registry = ProviderRegistry::new();
        assert!(registry.set_default("nonexistent").is_err());
    }

    #[test]
    fn test_list_providers() {
        let registry = ProviderRegistry::new();
        let provider = Arc::new(NullAsyncProvider) as SharedAsyncProvider;

        registry.register("test1", provider.clone());
        registry.register("test2", provider);

        let mut names = registry.list_providers();
        names.sort();
        assert_eq!(names, vec!["test1", "test2"]);
    }

    #[test]
    fn test_unregister() {
        let registry = ProviderRegistry::new();
        let provider = Arc::new(NullAsyncProvider) as SharedAsyncProvider;

        registry.register("test", provider);
        registry.set_default("test").unwrap();

        assert!(registry.unregister("test"));
        assert!(!registry.has_provider("test"));
        assert!(registry.get_default().is_none());
    }

    #[test]
    fn test_clear() {
        let registry = ProviderRegistry::new();
        let provider = Arc::new(NullAsyncProvider) as SharedAsyncProvider;

        registry.register("test1", provider.clone());
        registry.register("test2", provider);
        registry.set_default("test1").unwrap();

        registry.clear();

        assert_eq!(registry.list_providers().len(), 0);
        assert!(registry.get_default().is_none());
    }

    // Plugin management tests

    #[test]
    fn test_plugin_not_loaded_by_default() {
        let registry = ProviderRegistry::new();

        assert!(!registry.has_extension("nonexistent"));
        assert!(registry.get_extension("nonexistent").is_none());
    }

    #[test]
    fn test_list_extensions_empty() {
        let registry = ProviderRegistry::new();

        let plugins = registry.list_extensions();
        assert!(plugins.is_empty());
    }

    #[test]
    fn test_list_extensions_with_schemas_empty() {
        let registry = ProviderRegistry::new();

        let schemas = registry.list_extensions_with_schemas();
        assert!(schemas.is_empty());
    }

    #[test]
    fn test_get_extension_query_schema_not_found() {
        let registry = ProviderRegistry::new();

        let schema = registry.get_extension_query_schema("nonexistent");
        assert!(schema.is_none());
    }

    #[test]
    fn test_get_extension_output_schema_not_found() {
        let registry = ProviderRegistry::new();

        let schema = registry.get_extension_output_schema("nonexistent");
        assert!(schema.is_none());
    }

    #[test]
    fn test_unload_plugin_not_loaded() {
        let registry = ProviderRegistry::new();

        // Unloading a non-existent plugin should return false
        assert!(!registry.unload_extension("nonexistent"));
    }

    #[test]
    fn test_clear_removes_plugins() {
        let registry = ProviderRegistry::new();

        // Clear should also clear plugin sources
        registry.clear();

        assert!(registry.list_extensions().is_empty());
    }
}