laburnum 1.17.1

An LSP framework for building language servers and compilers, powered by an incremental query tree with content-addressed storage, task-based dataflow, and parallel queries.
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
// Copyright Two Neutron Stars Incorporated and contributors
// SPDX-License-Identifier: BlueOak-1.0.0

use {
  super::common::*,
  crate::{
    scheduler::{
      lanes::{
        ASYNC_LANE1,
        DEFAULT_LANE,
        RPC_LANE_3,
        RPC_LANE_HIGH_IDX,
        RPC_LANE_LOW_IDX,
        SYNC_LANE,
      },
      task::LaburnumTask,
    },
    connect::lsp::ClientId,
  },
  macro_rules_attribute::apply,
  std::{
    sync::{
      Arc,
      atomic::{
        AtomicUsize,
        Ordering,
      },
    },
    time::Duration,
  },
};

#[test]
fn rpc_queue_bubbles_up_oldest_tasks() {
  let (scheduler, _conn) = test_scheduler();

  let counter = Arc::new(AtomicUsize::new(0));

  let task_a = {
    let c = counter.clone();
    LaburnumTask::new(
      scheduler.clone(),
      move |_ctx| {
        async move {
          c.fetch_add(1, Ordering::SeqCst);
          None
        }
      },
      RPC_LANE_3,
      ClientId::INTERNAL,
    )
  };

  let task_b = {
    let c = counter.clone();
    LaburnumTask::new(
      scheduler.clone(),
      move |_ctx| {
        async move {
          c.fetch_add(1, Ordering::SeqCst);
          None
        }
      },
      RPC_LANE_3,
      ClientId::INTERNAL,
    )
  };

  let task_c = {
    let c = counter.clone();
    LaburnumTask::new(
      scheduler.clone(),
      move |_ctx| {
        async move {
          c.fetch_add(1, Ordering::SeqCst);
          None
        }
      },
      RPC_LANE_3,
      ClientId::INTERNAL,
    )
  };

  scheduler.queue_rpc_task(task_a.clone());
  scheduler.queue_rpc_task(task_b.clone());
  scheduler.queue_rpc_task(task_c.clone());

  let lane_7_len = scheduler.lane_queues[RPC_LANE_HIGH_IDX].len();
  let lane_8_len = scheduler.lane_queues[RPC_LANE_HIGH_IDX + 1].len();
  let lane_9_len = scheduler.lane_queues[RPC_LANE_HIGH_IDX + 2].len();
  let lane_10_len = scheduler.lane_queues[RPC_LANE_LOW_IDX].len();

  assert_eq!(
    lane_7_len, 0,
    "Lane 7 (highest priority) should be empty - needs 4+ insertions to fill"
  );
  assert_eq!(
    lane_8_len, 1,
    "Lane 8 should have oldest task (A) after 3 insertions"
  );
  assert_eq!(
    lane_9_len, 1,
    "Lane 9 should have middle task (B) after 3 insertions"
  );
  assert_eq!(
    lane_10_len, 1,
    "Lane 10 (lowest priority) should have newest task (C)"
  );
}

#[test]
fn rpc_queue_inserts_at_lowest_priority() {
  let (scheduler, _conn) = test_scheduler();

  let task =
    LaburnumTask::new(scheduler.clone(), |_ctx| async { None }, RPC_LANE_3, ClientId::INTERNAL);

  scheduler.queue_rpc_task(task);

  assert_eq!(
    scheduler.lane_queues[RPC_LANE_LOW_IDX].len(),
    1,
    "New RPC task should be in lowest priority lane (lane 10)"
  );
  assert!(
    scheduler.lane_queues[RPC_LANE_HIGH_IDX].is_empty(),
    "Highest priority lane (lane 7) should be empty for single insertion"
  );
}

#[test]
fn rpc_queue_rotation_is_thread_safe() {
  let (scheduler, _conn) = test_scheduler();
  let scheduler = Arc::new(scheduler);

  let handles: Vec<_> = (0..10)
    .map(|_i| {
      let sched = scheduler.clone();
      std::thread::spawn(move || {
        for _j in 0..100 {
          let task = LaburnumTask::new(
            (*sched).clone(),
            |_ctx| async { None },
            RPC_LANE_3,
            ClientId::INTERNAL,
          );
          sched.queue_rpc_task(task);
        }
      })
    })
    .collect();

  for h in handles {
    h.join().unwrap();
  }

  let total: usize = (RPC_LANE_HIGH_IDX..=RPC_LANE_LOW_IDX)
    .map(|idx| scheduler.lane_queues[idx].len())
    .sum();

  assert_eq!(total, 1000, "All 1000 RPC tasks should be queued");
}

#[test]
fn sync_lane_preempts_rpc_lanes() {
  let (scheduler, _conn) = test_scheduler();

  let rpc_task =
    LaburnumTask::new(scheduler.clone(), |_ctx| async { None }, RPC_LANE_3, ClientId::INTERNAL);
  scheduler.queue_rpc_task(rpc_task);

  let sync_task =
    LaburnumTask::new(scheduler.clone(), |_ctx| async { None }, SYNC_LANE, ClientId::INTERNAL);
  scheduler.queue_task(sync_task);

  let mut first_task_lane = None;
  for lane_idx in 0..31 {
    if let Ok(task) = scheduler.lane_queues[lane_idx].pop() {
      first_task_lane = Some(task.lane);
      break;
    }
  }

  assert_eq!(
    first_task_lane,
    Some(SYNC_LANE),
    "Sync task should be stolen before RPC tasks"
  );
}

#[test]
fn rpc_queue_maintains_fifo_within_priority() {
  let (scheduler, _conn) = test_scheduler();

  for _ in 0..5 {
    let task =
      LaburnumTask::new(scheduler.clone(), |_ctx| async { None }, RPC_LANE_3, ClientId::INTERNAL);
    scheduler.queue_rpc_task(task);
  }

  let lane_7 = scheduler.lane_queues[RPC_LANE_HIGH_IDX].len();
  let lane_8 = scheduler.lane_queues[RPC_LANE_HIGH_IDX + 1].len();
  let lane_9 = scheduler.lane_queues[RPC_LANE_HIGH_IDX + 2].len();
  let lane_10 = scheduler.lane_queues[RPC_LANE_LOW_IDX].len();

  assert_eq!(lane_7, 2, "Lane 7 should have 2 oldest tasks");
  assert_eq!(lane_8, 1, "Lane 8 should have 1 task");
  assert_eq!(lane_9, 1, "Lane 9 should have 1 task");
  assert_eq!(lane_10, 1, "Lane 10 should have 1 newest task");
}

#[apply(smol_macros::test!)]
#[test_log::test]
async fn worker_steals_rpc_tasks_oldest_first() {
  let (scheduler, _conn) = test_scheduler();

  let execution_order = Arc::new(parking_lot::Mutex::new(Vec::new()));

  for i in 0..4 {
    let order = execution_order.clone();
    let task = LaburnumTask::new(
      scheduler.clone(),
      move |_ctx| {
        let order = order.clone();
        async move {
          order.lock().push(i);
          None
        }
      },
      RPC_LANE_3,
      ClientId::INTERNAL,
    );
    scheduler.queue_rpc_task(task);
  }

  scheduler.spawn_workers();

  assert!(
    wait_for(|| execution_order.lock().len() == 4, Duration::from_secs(5))
      .await,
    "Not all RPC tasks completed"
  );

  let order = execution_order.lock().clone();
  assert_eq!(
    order,
    vec![0, 1, 2, 3],
    "RPC tasks should execute oldest first (FIFO via bubble-up)"
  );
}

#[apply(smol_macros::test!)]
#[test_log::test]
async fn worker_processes_standard_lanes_before_rpc() {
  let (scheduler, _conn) = test_scheduler();

  let execution_order = Arc::new(parking_lot::Mutex::new(Vec::new()));

  let order = execution_order.clone();
  let rpc_task = LaburnumTask::new(
    scheduler.clone(),
    move |_ctx| {
      let order = order.clone();
      async move {
        order.lock().push("rpc");
        None
      }
    },
    RPC_LANE_3,
    ClientId::INTERNAL,
  );
  scheduler.queue_rpc_task(rpc_task);

  let order = execution_order.clone();
  scheduler.queue(
    move |_control| {
      let order = order.clone();
      async move {
        order.lock().push("default");
        None
      }
    },
    DEFAULT_LANE,
  );

  let order = execution_order.clone();
  scheduler.queue(
    move |_control| {
      let order = order.clone();
      async move {
        order.lock().push("sync");
        None
      }
    },
    SYNC_LANE,
  );

  scheduler.spawn_workers();

  assert!(
    wait_for(|| execution_order.lock().len() == 3, Duration::from_secs(5))
      .await,
    "Not all tasks completed"
  );

  let order = execution_order.lock().clone();
  assert_eq!(order[0], "sync", "SYNC_LANE should execute first");
  assert_eq!(
    order[1], "default",
    "DEFAULT_LANE should execute before RPC"
  );
  assert_eq!(order[2], "rpc", "RPC should execute last");
}

#[apply(smol_macros::test!)]
#[test_log::test]
async fn worker_processes_rpc_before_async_lanes() {
  let (scheduler, _conn) = test_scheduler();

  let execution_order = Arc::new(parking_lot::Mutex::new(Vec::new()));

  let order = execution_order.clone();
  scheduler.queue(
    move |_control| {
      let order = order.clone();
      async move {
        order.lock().push("async");
        None
      }
    },
    ASYNC_LANE1,
  );

  let order = execution_order.clone();
  let rpc_task = LaburnumTask::new(
    scheduler.clone(),
    move |_ctx| {
      let order = order.clone();
      async move {
        order.lock().push("rpc");
        None
      }
    },
    RPC_LANE_3,
    ClientId::INTERNAL,
  );
  scheduler.queue_rpc_task(rpc_task);

  scheduler.spawn_workers();

  assert!(
    wait_for(|| execution_order.lock().len() == 2, Duration::from_secs(5))
      .await,
    "Not all tasks completed"
  );

  let order = execution_order.lock().clone();
  assert_eq!(order[0], "rpc", "RPC should execute before ASYNC_LANE");
  assert_eq!(order[1], "async", "ASYNC_LANE should execute after RPC");
}

#[apply(smol_macros::test!)]
#[test_log::test]
async fn rpc_task_requeue_interleaves_fairly() {
  let (scheduler, _conn) = test_scheduler();

  let poll_sequence = Arc::new(parking_lot::Mutex::new(Vec::new()));
  let completed = Arc::new(AtomicUsize::new(0));

  let seq_a = poll_sequence.clone();
  let done = completed.clone();
  let task_a = LaburnumTask::new(
    scheduler.clone(),
    move |_ctx| {
      let seq = seq_a.clone();
      let done = done.clone();
      async move {
        for _ in 0..4 {
          seq.lock().push('A');
          futures_lite::future::yield_now().await;
        }
        done.fetch_add(1, Ordering::SeqCst);
        None
      }
    },
    RPC_LANE_3,
    ClientId::INTERNAL,
  );

  let seq_b = poll_sequence.clone();
  let done = completed.clone();
  let task_b = LaburnumTask::new(
    scheduler.clone(),
    move |_ctx| {
      let seq = seq_b.clone();
      let done = done.clone();
      async move {
        for _ in 0..4 {
          seq.lock().push('B');
          futures_lite::future::yield_now().await;
        }
        done.fetch_add(1, Ordering::SeqCst);
        None
      }
    },
    RPC_LANE_3,
    ClientId::INTERNAL,
  );

  scheduler.queue_rpc_task(task_a);
  scheduler.queue_rpc_task(task_b);

  scheduler.spawn_workers();

  assert!(
    wait_for(
      || completed.load(Ordering::SeqCst) == 2,
      Duration::from_secs(5)
    )
    .await,
    "Not all RPC tasks completed"
  );

  let sequence = poll_sequence.lock().clone();

  assert_eq!(
    sequence.len(),
    8,
    "Expected 8 polls total (4 per task), got {}",
    sequence.len()
  );

  let a_count = sequence.iter().filter(|&&c| c == 'A').count();
  let b_count = sequence.iter().filter(|&&c| c == 'B').count();
  assert_eq!(a_count, 4, "Task A should be polled 4 times");
  assert_eq!(b_count, 4, "Task B should be polled 4 times");

  let mut max_consecutive = 1;
  let mut current_consecutive = 1;
  for i in 1..sequence.len() {
    if sequence[i] == sequence[i - 1] {
      current_consecutive += 1;
      max_consecutive = max_consecutive.max(current_consecutive);
    } else {
      current_consecutive = 1;
    }
  }

  assert!(
    max_consecutive <= 2,
    "Tasks should interleave fairly. Max consecutive same-task polls: {}. Sequence: {:?}",
    max_consecutive,
    sequence
  );
}

#[test]
fn rpc_queue_concurrent_push_and_pop() {
  let (scheduler, _conn) = test_scheduler();
  let scheduler = Arc::new(scheduler);

  let total_tasks = 500;
  let stolen = Arc::new(AtomicUsize::new(0));

  let push_handles: Vec<_> = (0..5)
    .map(|_| {
      let sched = scheduler.clone();
      std::thread::spawn(move || {
        for _ in 0..100 {
          let task = LaburnumTask::new(
            (*sched).clone(),
            |_ctx| async { None },
            RPC_LANE_3,
            ClientId::INTERNAL,
          );
          sched.queue_rpc_task(task);
        }
      })
    })
    .collect();

  let pop_handles: Vec<_> = (0..5)
    .map(|_| {
      let sched = scheduler.clone();
      let stolen = stolen.clone();
      std::thread::spawn(move || {
        let mut local_stolen = 0;
        for _ in 0..200 {
          for idx in RPC_LANE_HIGH_IDX..=RPC_LANE_LOW_IDX {
            if sched.lane_queues[idx].pop().is_ok() {
              local_stolen += 1;
            }
          }
          std::thread::yield_now();
        }
        stolen.fetch_add(local_stolen, Ordering::SeqCst);
      })
    })
    .collect();

  for h in push_handles {
    h.join().unwrap();
  }
  for h in pop_handles {
    h.join().unwrap();
  }

  let remaining: usize = (RPC_LANE_HIGH_IDX..=RPC_LANE_LOW_IDX)
    .map(|idx| scheduler.lane_queues[idx].len())
    .sum();
  let total_stolen = stolen.load(Ordering::SeqCst);

  assert_eq!(
    remaining + total_stolen,
    total_tasks,
    "All {} tasks should be accounted for: {} remaining + {} stolen",
    total_tasks,
    remaining,
    total_stolen
  );
}

#[test]
fn rpc_queue_no_task_loss_under_contention() {
  let (scheduler, _conn) = test_scheduler();
  let scheduler = Arc::new(scheduler);

  let task_ids =
    Arc::new(parking_lot::Mutex::new(std::collections::HashSet::new()));
  let completed_ids =
    Arc::new(parking_lot::Mutex::new(std::collections::HashSet::new()));

  for i in 0..100 {
    task_ids.lock().insert(i);
    let completed = completed_ids.clone();
    let task = LaburnumTask::new(
      (*scheduler).clone(),
      move |_ctx| {
        let completed = completed.clone();
        async move {
          completed.lock().insert(i);
          None
        }
      },
      RPC_LANE_3,
      ClientId::INTERNAL,
    );
    scheduler.queue_rpc_task(task);
  }

  let handles: Vec<_> = (0..4)
    .map(|_| {
      let sched = scheduler.clone();
      std::thread::spawn(move || {
        for _ in 0..50 {
          for idx in RPC_LANE_HIGH_IDX..=RPC_LANE_LOW_IDX {
            if let Ok(task) = sched.lane_queues[idx].pop() {
              let _ = task.poll_once();
            }
          }
          std::thread::yield_now();
        }
      })
    })
    .collect();

  for h in handles {
    h.join().unwrap();
  }

  for idx in RPC_LANE_HIGH_IDX..=RPC_LANE_LOW_IDX {
    while let Ok(task) = scheduler.lane_queues[idx].pop() {
      let _ = task.poll_once();
    }
  }

  let original = task_ids.lock().clone();
  let completed = completed_ids.lock().clone();

  assert_eq!(
    original,
    completed,
    "All queued tasks should complete. Missing: {:?}",
    original.difference(&completed).collect::<Vec<_>>()
  );
}