linkrs-server 0.1.0

Linkrs network service layer (HTTP/gRPC)
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
use std::sync::Arc;
use std::time::Duration;

use log::{info, warn};
use parking_lot::RwLock;

#[cfg(feature = "vector")]
use linkrs_api::api_core::VectorApi;
use linkrs_api::api_core::{QueryApi, SyncApi};
use linkrs_core::event_dispatch::EventSubscriptions;
use linkrs_core::metadata::SchemaManager;
use linkrs_metrics::StatsManager;
use linkrs_query::query_manager::QueryManager;
use linkrs_query::SessionEvent;
#[cfg(feature = "vector")]
use linkrs_sync::backend::VectorBackend;
use linkrs_transaction::TransactionManager;

use super::GraphService;
use crate::auth::AuthenticatorFactory;
use crate::config::Config;
use crate::permission::{PermissionManager, GOD_SPACE_ID};
use crate::query::executor::streaming::pool::SharedScheduler;
use crate::query::executor::streaming::query_registry::QueryRegistry;
use crate::query::optimizer::PartitioningConfig;
use crate::session::GraphSessionManager;
use crate::storage::{
    StorageClient, StorageOperationContextOps, StorageSchemaContextOps, StorageSyncContextOps,
};

impl<
        S: StorageClient
            + StorageSchemaContextOps
            + StorageSyncContextOps
            + StorageOperationContextOps
            + Clone
            + 'static,
    > GraphService<S>
{
    /// Create a new GraphService (without a transaction manager, for use in a production environment).
    pub async fn new(config: Config, storage: Arc<S>) -> Arc<Self> {
        #[cfg(feature = "vector")]
        return Self::create_service(config, storage, None, true, None, None).await;
        #[cfg(not(feature = "vector"))]
        return Self::create_service(config, storage, None, true, None).await;
    }

    /// Create a new GraphService (without a transaction manager and without starting any background tasks, for testing purposes).
    pub async fn new_for_test(config: Config, storage: Arc<S>) -> Arc<Self> {
        #[cfg(feature = "vector")]
        return Self::create_service(config, storage, None, false, None, None).await;
        #[cfg(not(feature = "vector"))]
        return Self::create_service(config, storage, None, false, None).await;
    }

    /// Use the transaction manager to create a GraphService.
    pub async fn new_with_transaction_manager(
        config: Config,
        storage: Arc<S>,
        transaction_manager: Arc<TransactionManager>,
    ) -> Arc<Self> {
        #[cfg(feature = "vector")]
        return Self::create_service(config, storage, Some(transaction_manager), true, None, None)
            .await;
        #[cfg(not(feature = "vector"))]
        return Self::create_service(config, storage, Some(transaction_manager), true, None).await;
    }

    /// Use the transaction manager and external StatsManager to create a GraphService.
    pub async fn new_with_transaction_manager_and_stats(
        config: Config,
        storage: Arc<S>,
        transaction_manager: Arc<TransactionManager>,
        stats_manager: Arc<StatsManager>,
    ) -> Arc<Self> {
        #[cfg(feature = "vector")]
        {
            Self::create_service(
                config,
                storage,
                Some(transaction_manager),
                true,
                Some(stats_manager),
                None,
            )
            .await
        }
        #[cfg(not(feature = "vector"))]
        {
            Self::create_service(
                config,
                storage,
                Some(transaction_manager),
                true,
                Some(stats_manager),
            )
            .await
        }
    }

    /// Use the transaction manager, external StatsManager, and shared VectorBackend to create a GraphService.
    #[cfg(feature = "vector")]
    pub async fn with_shared_vector_backend(
        config: Config,
        storage: Arc<S>,
        transaction_manager: Arc<TransactionManager>,
        stats_manager: Arc<StatsManager>,
        backend: VectorBackend,
    ) -> Arc<Self> {
        Self::create_service(
            config,
            storage,
            Some(transaction_manager),
            true,
            Some(stats_manager),
            Some(backend),
        )
        .await
    }

    /// Internal constructor: Extracts the common logic
    ///
    /// # Parameters
    /// `start_cleanup_task` – Whether to initiate the background task for session cleanup
    /// `shared_vector_backend` – Optional shared VectorBackend to avoid duplicate initialization
    async fn create_service(
        config: Config,
        storage: Arc<S>,
        transaction_manager: Option<Arc<TransactionManager>>,
        start_cleanup_task: bool,
        external_stats_manager: Option<Arc<StatsManager>>,
        #[cfg(feature = "vector")] shared_vector_backend: Option<VectorBackend>,
    ) -> Arc<Self> {
        crate::query::executor::streaming::operators::source_operator::set_column_block_enabled(
            config.common.columnar.column_block_enabled,
        );

        let session_idle_timeout =
            Duration::from_secs(config.server.auth.session_idle_timeout_secs.max(1));
        let session_events = Arc::new(EventSubscriptions::<SessionEvent>::new());
        let query_manager = Arc::new(QueryManager::new_with_shared(session_events.clone()));
        query_manager.set_slow_query_threshold_ms(config.monitoring.slow_query_threshold_ms as i64);
        let session_manager = GraphSessionManager::new_with_shared(
            format!("{}:{}", config.database.host, config.database.port),
            config.database.max_sessions,
            session_idle_timeout,
            session_events.clone(),
        );
        session_manager.set_default_auto_commit(config.common.transaction.auto_commit);

        if start_cleanup_task {
            session_manager.start_cleanup_task().await;
        }

        let schema_manager: Option<Arc<SchemaManager>> = storage.get_schema_manager();

        let stats_manager = if let Some(ext_stats) = external_stats_manager {
            ext_stats
        } else {
            let slow_query_config = config.to_slow_query_config();
            let m = &config.monitoring;
            Arc::new(
                StatsManager::with_slow_query_logger(
                    m.enabled,
                    m.memory_cache_size,
                    m.slow_query_threshold_ms * 1000,
                    slow_query_config,
                )
                .expect("Failed to create StatsManager with slow query logger"),
            )
        };

        let runtime = crate::config::RuntimeConfig::file(config.storage_path());
        let cost_profile = config
            .common
            .optimizer
            .storage_cost_profile
            .resolve_for_runtime(&runtime);
        let cost_config = linkrs_api::api_core::cost_config_for_profile(cost_profile);
        info!(
            "Optimizer cost profile resolved to {:?} (random_page_cost={})",
            cost_profile, cost_config.random_page_cost,
        );
        let mut optimizer_engine = crate::query::OptimizerEngine::new(cost_config);
        optimizer_engine.set_partitioning_config(Self::partitioning_config_from(&config));
        {
            let rules = &config.common.optimizer.rules;
            for name in rules
                .disabled_rules
                .iter()
                .chain(rules.enabled_rules.iter())
            {
                if !Self::is_known_optimizer_rule(name) {
                    log::warn!("Unknown optimizer rule name '{name}' in [optimizer.rules]");
                }
            }
            optimizer_engine.set_rule_selection(&rules.disabled_rules, &rules.enabled_rules);
        }
        let shared_scheduler = Arc::new(SharedScheduler::new(
            optimizer_engine.partitioning_config().max_workers.max(1),
        ));
        let optimizer_engine = Arc::new(optimizer_engine);
        let query_registry = Arc::new(QueryRegistry::new());
        query_manager.set_query_registry(Arc::clone(&query_registry));
        info!(
            "Shared query scheduler created with {} worker(s)",
            shared_scheduler.max_workers()
        );

        #[cfg(feature = "vector")]
        let (query_api, vector_api) = if config.is_vector_enabled() {
            let backend = match shared_vector_backend {
                Some(backend) => backend,
                None => {
                    let engine = simvec::LocalVectorEngine::open(config.vector_data_dir())
                        .unwrap_or_else(|_| panic!("Failed to open local vector engine"));
                    if let Some(hnsw) =
                        linkrs_api::vector_config::local_hnsw_config(&config.vector_config().local)
                    {
                        engine.set_default_hnsw_config(hnsw);
                    }
                    if let Some(ivf) =
                        linkrs_api::vector_config::local_ivf_config(&config.vector_config().local)
                    {
                        engine.set_default_ivf_config(ivf);
                    }
                    if let Some(quant) = linkrs_api::vector_config::local_quantization_config(
                        &config.vector_config().local,
                    ) {
                        engine.set_default_quantization_config(quant);
                    }
                    linkrs_sync::backend::VectorBackend::local(engine)
                }
            };

            match QueryApi::with_vector_backend(
                Arc::new(RwLock::new((*storage).clone())),
                stats_manager.clone(),
                backend.clone(),
                schema_manager.clone(),
            )
            .await
            {
                Ok(mut api) => {
                    api = api
                        .with_statistics_settings(
                            config.common.optimizer.statistics_sample_limit,
                            config.common.optimizer.statistics_min_epoch_delta,
                        )
                        .with_default_cost_profile_label(format!("{cost_profile:?}"))
                        .with_space_cost_profiles(
                            &config.common.optimizer.space_cost_profiles,
                            &runtime,
                        )
                        .with_password_history_depth(
                            config.server.security.password_policy.history_size,
                        );
                    api.install_shared_scheduler(shared_scheduler.clone(), query_registry.clone());
                    api.install_query_manager(Arc::clone(&query_manager));
                    // The standalone VectorApi needs the sync manager that
                    // hosts the vector coordinator; without it the HTTP/gRPC
                    // vector endpoints cannot list indexes, so it is left
                    // unconfigured and those endpoints report unavailability
                    // instead of silently serving empty results.
                    let vector_api = storage.get_sync_manager().and_then(|sync_manager| {
                        sync_manager
                            .vector_coordinator()
                            .cloned()
                            .map(|coordinator| {
                                Arc::new(VectorApi::new(backend, coordinator, sync_manager))
                            })
                    });
                    (Arc::new(RwLock::new(api)), vector_api)
                }
                Err(e) => {
                    warn!(
                        "Failed to initialize vector search, falling back to basic QueryApi: {}",
                        e
                    );
                    let mut api = Self::build_query_api(
                        &storage,
                        &stats_manager,
                        schema_manager.as_ref(),
                        optimizer_engine.clone(),
                        &config.common.optimizer,
                        cost_profile,
                        &runtime,
                        config.server.security.password_policy.history_size,
                    );
                    api.install_shared_scheduler(shared_scheduler.clone(), query_registry.clone());
                    api.install_query_manager(Arc::clone(&query_manager));
                    (Arc::new(RwLock::new(api)), None)
                }
            }
        } else {
            let mut api = Self::build_query_api(
                &storage,
                &stats_manager,
                schema_manager.as_ref(),
                optimizer_engine.clone(),
                &config.common.optimizer,
                cost_profile,
                &runtime,
                config.server.security.password_policy.history_size,
            );
            api.install_shared_scheduler(shared_scheduler.clone(), query_registry.clone());
            api.install_query_manager(Arc::clone(&query_manager));
            (Arc::new(RwLock::new(api)), None)
        };

        #[cfg(not(feature = "vector"))]
        let query_api = {
            let mut api = Self::build_query_api(
                &storage,
                &stats_manager,
                schema_manager.as_ref(),
                optimizer_engine.clone(),
                &config.common.optimizer,
                cost_profile,
                &runtime,
                config.server.security.password_policy.history_size,
            );
            api.install_shared_scheduler(shared_scheduler.clone(), query_registry.clone());
            api.install_query_manager(Arc::clone(&query_manager));
            Arc::new(RwLock::new(api))
        };

        if start_cleanup_task {
            Self::spawn_startup_statistics_load(query_api.clone(), storage.clone());
        }

        let permission_manager = Arc::new(PermissionManager::new());
        Self::ensure_admin_seed_and_rebuild(&storage, &permission_manager, &config);

        let authenticator =
            AuthenticatorFactory::create_with_storage(&config.server.auth, Arc::clone(&storage));

        let sync_api = storage
            .get_sync_manager()
            .map(|sync_manager| Arc::new(SyncApi::new(sync_manager)));

        let service = Self {
            session_manager,
            query_api,
            authenticator,
            permission_manager,
            stats_manager,
            storage,
            #[cfg(feature = "vector")]
            vector_api,
            sync_api,
            transaction_manager,
            shared_scheduler,
            query_registry,
            query_manager,
            progress_rows_interval: config.monitoring.progress_report_rows_interval,
            next_query_id: std::sync::atomic::AtomicU64::new(1),
            bootstrap_config: config.server.bootstrap.clone(),
            security_config: config.server.security.clone(),
        };
        Arc::new(service)
    }

    /// Shared helper: build a QueryApi with optional SchemaManager, reusing the
    /// server-level optimizer engine so `[parallel]` settings take effect.
    fn build_query_api(
        storage: &Arc<S>,
        stats_manager: &Arc<StatsManager>,
        schema_manager: Option<&Arc<SchemaManager>>,
        optimizer_engine: Arc<crate::query::OptimizerEngine>,
        optimizer_config: &crate::config::OptimizerConfig,
        cost_profile: crate::config::StorageCostProfile,
        runtime: &crate::config::RuntimeConfig,
        password_history_depth: usize,
    ) -> QueryApi<S> {
        let inner = Arc::new(RwLock::new((**storage).clone()));
        QueryApi::with_optimizer_engine(
            inner,
            stats_manager.clone(),
            optimizer_engine,
            schema_manager.cloned(),
        )
        .with_statistics_settings(
            optimizer_config.statistics_sample_limit,
            optimizer_config.statistics_min_epoch_delta,
        )
        .with_default_cost_profile_label(format!("{cost_profile:?}"))
        .with_space_cost_profiles(&optimizer_config.space_cost_profiles, runtime)
        .with_password_history_depth(password_history_depth)
    }

    /// Whether a rule name is known to the physical heuristic registry.
    ///
    /// Accepts the type name with or without the `Rule` suffix, matching
    /// `RuleRegistry::filtered`.
    fn is_known_optimizer_rule(name: &str) -> bool {
        let trimmed = name.strip_suffix("Rule").unwrap_or(name);
        let registry = crate::query::optimizer::heuristic::rule_enum::RuleRegistry::default();
        let known = registry
            .iter()
            .any(|rule| rule.name().strip_suffix("Rule") == Some(trimmed));
        known
    }

    /// Map the `[parallel]` config section onto the query optimizer's
    /// partitioning configuration.
    fn partitioning_config_from(config: &Config) -> PartitioningConfig {
        let parallel = &config.common.parallel;
        PartitioningConfig {
            enabled: parallel.enabled,
            min_rows_per_partition: parallel.min_rows_per_partition,
            max_partitions: parallel.max_partitions,
            vertex_id_range: parallel.vertex_id_range(),
            max_workers: parallel.workers,
            max_buffered_chunks: parallel.max_buffered_chunks,
            // Economic gate stays inert in production until the overhead
            // terms are calibrated per hardware (follow-up config knobs).
            fixed_overhead_rows: 0,
            per_partition_rows: 0,
            exchange_row_per_mille: 0,
        }
    }

    /// Spawn a background task that collects optimizer statistics for all
    /// loaded spaces. Failure of any space is a warning only.
    fn spawn_startup_statistics_load(query_api: Arc<RwLock<QueryApi<S>>>, storage: Arc<S>) {
        tokio::spawn(async move {
            let spaces = match storage.list_spaces() {
                Ok(spaces) => spaces,
                Err(error) => {
                    warn!("Startup statistics load: failed to list spaces: {}", error);
                    return;
                }
            };
            for space in spaces {
                let result = query_api
                    .read()
                    .collect_statistics(&space.space_name, false);
                match result {
                    Ok(()) => info!("Startup statistics loaded for space '{}'", space.space_name),
                    Err(error) => warn!(
                        "Startup statistics load failed for space '{}': {}",
                        space.space_name, error
                    ),
                }
            }
        });
    }

    /// Seed the default admin on first start and rebuild role mappings.
    ///
    /// When the user table is empty, the resolved bootstrap credentials are
    /// hashed into a new admin with the global God role; the plaintext
    /// password is never compared afterwards. Otherwise permission state is
    /// rebuilt from the persisted role segment so restarts keep grants.
    ///
    /// The seed credentials are intentionally exempt from the password
    /// policy: the bootstrap password may be weak for local bootstrap and
    /// the account is forced through the must-change flow on first login
    /// instead.
    fn ensure_admin_seed_and_rebuild(
        storage: &Arc<S>,
        permission_manager: &Arc<PermissionManager>,
        config: &Config,
    ) {
        let mut handle = (**storage).clone();
        if handle.list_users().is_empty() {
            let username = config.server.auth.default_username.clone();
            let password = config.server.auth.bootstrap_password.clone();
            if !username.is_empty() && !password.is_empty() {
                match linkrs_core::types::UserInfo::new(username.clone(), password) {
                    Ok(info) => {
                        if let Err(error) = handle.create_user(&info) {
                            warn!("Admin seed failed for '{}': {}", username, error);
                        } else if let Err(error) =
                            handle.grant_role(&username, GOD_SPACE_ID, linkrs_core::RoleType::God)
                        {
                            warn!("Admin seed grant failed for '{}': {}", username, error);
                        } else {
                            info!("Seeded default admin '{}'", username);
                        }
                    }
                    Err(error) => warn!("Admin seed hashing failed: {}", error),
                }
            }
        }
        let roles = handle.list_all_user_roles();
        if !roles.is_empty() {
            permission_manager.rebuild_from_snapshot(roles);
        }
    }
}