extension_lsp_adapter.rs

  1use std::ops::Range;
  2use std::path::{Path, PathBuf};
  3use std::sync::Arc;
  4
  5use anyhow::{Context as _, Result};
  6use async_trait::async_trait;
  7use collections::{HashMap, HashSet};
  8use extension::{Extension, ExtensionLanguageServerProxy, WorktreeDelegate};
  9use futures::{FutureExt, future::join_all, lock::OwnedMutexGuard};
 10use gpui::{App, AppContext, AsyncApp, Task};
 11use language::{
 12    BinaryStatus, CodeLabel, DynLspInstaller, HighlightId, Language, LanguageName,
 13    LanguageServerBinaryLocations, LspAdapter, LspAdapterDelegate, Toolchain,
 14};
 15use lsp::{
 16    CodeActionKind, LanguageServerBinary, LanguageServerBinaryOptions, LanguageServerName,
 17    LanguageServerSelector, Uri,
 18};
 19use serde::Serialize;
 20use serde_json::Value;
 21use util::{ResultExt, fs::make_file_executable, maybe, rel_path::RelPath};
 22
 23use crate::{LanguageServerRegistryProxy, LspAccess};
 24
 25/// An adapter that allows an [`LspAdapterDelegate`] to be used as a [`WorktreeDelegate`].
 26struct WorktreeDelegateAdapter(pub Arc<dyn LspAdapterDelegate>);
 27
 28#[async_trait]
 29impl WorktreeDelegate for WorktreeDelegateAdapter {
 30    fn id(&self) -> u64 {
 31        self.0.worktree_id().to_proto()
 32    }
 33
 34    fn root_path(&self) -> String {
 35        self.0.worktree_root_path().to_string_lossy().into_owned()
 36    }
 37
 38    async fn read_text_file(&self, path: &RelPath) -> Result<String> {
 39        self.0.read_text_file(path).await
 40    }
 41
 42    async fn which(&self, binary_name: String) -> Option<String> {
 43        self.0
 44            .which(binary_name.as_ref())
 45            .await
 46            .map(|path| path.to_string_lossy().into_owned())
 47    }
 48
 49    async fn shell_env(&self) -> Vec<(String, String)> {
 50        self.0.shell_env().await.into_iter().collect()
 51    }
 52}
 53
 54impl ExtensionLanguageServerProxy for LanguageServerRegistryProxy {
 55    fn register_language_server(
 56        &self,
 57        extension: Arc<dyn Extension>,
 58        language_server_id: LanguageServerName,
 59        language: LanguageName,
 60    ) {
 61        self.language_registry.register_lsp_adapter(
 62            language.clone(),
 63            Arc::new(ExtensionLspAdapter::new(
 64                extension,
 65                language_server_id,
 66                language,
 67            )),
 68        );
 69    }
 70
 71    fn remove_language_server(
 72        &self,
 73        language: &LanguageName,
 74        language_server_name: &LanguageServerName,
 75        cx: &mut App,
 76    ) -> Task<Result<()>> {
 77        self.language_registry
 78            .remove_lsp_adapter(language, language_server_name);
 79
 80        let mut tasks = Vec::new();
 81        match &self.lsp_access {
 82            LspAccess::ViaLspStore(lsp_store) => lsp_store.update(cx, |lsp_store, cx| {
 83                let stop_task = lsp_store.stop_language_servers_for_buffers(
 84                    Vec::new(),
 85                    HashSet::from_iter([LanguageServerSelector::Name(
 86                        language_server_name.clone(),
 87                    )]),
 88                    cx,
 89                );
 90                tasks.push(stop_task);
 91            }),
 92            LspAccess::ViaWorkspaces(lsp_store_provider) => {
 93                if let Ok(lsp_stores) = lsp_store_provider(cx) {
 94                    for lsp_store in lsp_stores {
 95                        lsp_store.update(cx, |lsp_store, cx| {
 96                            let stop_task = lsp_store.stop_language_servers_for_buffers(
 97                                Vec::new(),
 98                                HashSet::from_iter([LanguageServerSelector::Name(
 99                                    language_server_name.clone(),
100                                )]),
101                                cx,
102                            );
103                            tasks.push(stop_task);
104                        });
105                    }
106                }
107            }
108            LspAccess::Noop => {}
109        }
110
111        cx.background_spawn(async move {
112            let results = join_all(tasks).await;
113            for result in results {
114                result?;
115            }
116            Ok(())
117        })
118    }
119
120    fn update_language_server_status(
121        &self,
122        language_server_id: LanguageServerName,
123        status: BinaryStatus,
124    ) {
125        log::debug!(
126            "updating binary status for {} to {:?}",
127            language_server_id,
128            status
129        );
130        self.language_registry
131            .update_lsp_binary_status(language_server_id, status);
132    }
133}
134
135struct ExtensionLspAdapter {
136    extension: Arc<dyn Extension>,
137    language_server_id: LanguageServerName,
138    language_name: LanguageName,
139}
140
141impl ExtensionLspAdapter {
142    fn new(
143        extension: Arc<dyn Extension>,
144        language_server_id: LanguageServerName,
145        language_name: LanguageName,
146    ) -> Self {
147        Self {
148            extension,
149            language_server_id,
150            language_name,
151        }
152    }
153}
154
155#[async_trait(?Send)]
156impl DynLspInstaller for ExtensionLspAdapter {
157    fn get_language_server_command(
158        self: Arc<Self>,
159        delegate: Arc<dyn LspAdapterDelegate>,
160        _: Option<Toolchain>,
161        _: LanguageServerBinaryOptions,
162        _: OwnedMutexGuard<Option<(bool, LanguageServerBinary)>>,
163        _: AsyncApp,
164    ) -> LanguageServerBinaryLocations {
165        async move {
166            let ret = maybe!(async move {
167                let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
168                let command = self
169                    .extension
170                    .language_server_command(
171                        self.language_server_id.clone(),
172                        self.language_name.clone(),
173                        delegate,
174                    )
175                    .await?;
176
177                // on windows, extensions might produce weird paths
178                // that start with a leading slash due to WASI
179                // requiring that for PWD and friends so account for
180                // that here and try to transform those paths back
181                // to windows paths
182                //
183                // if we don't do this, std will interpret the path as relative,
184                // which changes join behavior
185                let command_path: &Path = if cfg!(windows)
186                    && let Some(command) = command.command.to_str()
187                {
188                    let mut chars = command.chars();
189                    if chars.next().is_some_and(|c| c == '/')
190                        && chars.next().is_some_and(|c| c.is_ascii_alphabetic())
191                        && chars.next().is_some_and(|c| c == ':')
192                        && chars.next().is_some_and(|c| c == '\\' || c == '/')
193                    {
194                        // looks like a windows path with a leading slash, so strip it
195                        command.strip_prefix('/').unwrap().as_ref()
196                    } else {
197                        command.as_ref()
198                    }
199                } else {
200                    command.command.as_ref()
201                };
202                let path = self.extension.path_from_extension(command_path);
203
204                // TODO: This should now be done via the `zed::make_file_executable` function in
205                // Zed extension API, but we're leaving these existing usages in place temporarily
206                // to avoid any compatibility issues between Zed and the extension versions.
207                //
208                // We can remove once the following extension versions no longer see any use:
209                // - toml@0.0.2
210                // - zig@0.0.1
211                if ["toml", "zig"].contains(&self.extension.manifest().id.as_ref())
212                    && path.starts_with(&self.extension.work_dir())
213                {
214                    make_file_executable(&path)
215                        .await
216                        .context("failed to set file permissions")?;
217                }
218
219                Ok(LanguageServerBinary {
220                    path,
221                    arguments: command
222                        .args
223                        .into_iter()
224                        .map(|arg| {
225                            // on windows, extensions might produce weird paths
226                            // that start with a leading slash due to WASI
227                            // requiring that for PWD and friends so account for
228                            // that here and try to transform those paths back
229                            // to windows paths
230                            if cfg!(windows) {
231                                let mut chars = arg.chars();
232                                if chars.next().is_some_and(|c| c == '/')
233                                    && chars.next().is_some_and(|c| c.is_ascii_alphabetic())
234                                    && chars.next().is_some_and(|c| c == ':')
235                                    && chars.next().is_some_and(|c| c == '\\' || c == '/')
236                                {
237                                    // looks like a windows path with a leading slash, so strip it
238                                    arg.strip_prefix('/').unwrap().into()
239                                } else {
240                                    arg.into()
241                                }
242                            } else {
243                                arg.into()
244                            }
245                        })
246                        .collect(),
247                    env: Some(command.env.into_iter().collect()),
248                })
249            })
250            .await;
251            (ret, None)
252        }
253        .boxed_local()
254    }
255
256    async fn try_fetch_server_binary(
257        &self,
258        _: &Arc<dyn LspAdapterDelegate>,
259        _: PathBuf,
260        _: bool,
261        _: &mut AsyncApp,
262    ) -> Result<LanguageServerBinary> {
263        unreachable!("get_language_server_command is overridden")
264    }
265}
266
267#[async_trait(?Send)]
268impl LspAdapter for ExtensionLspAdapter {
269    fn name(&self) -> LanguageServerName {
270        self.language_server_id.clone()
271    }
272
273    fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
274        let code_action_kinds = self
275            .extension
276            .manifest()
277            .language_servers
278            .get(&self.language_server_id)
279            .and_then(|server| server.code_action_kinds.clone());
280
281        code_action_kinds.or(Some(vec![
282            CodeActionKind::EMPTY,
283            CodeActionKind::QUICKFIX,
284            CodeActionKind::REFACTOR,
285            CodeActionKind::REFACTOR_EXTRACT,
286            CodeActionKind::SOURCE,
287        ]))
288    }
289
290    fn language_ids(&self) -> HashMap<LanguageName, String> {
291        // TODO: The language IDs can be provided via the language server options
292        // in `extension.toml now but we're leaving these existing usages in place temporarily
293        // to avoid any compatibility issues between Zed and the extension versions.
294        //
295        // We can remove once the following extension versions no longer see any use:
296        // - php@0.0.1
297        if self.extension.manifest().id.as_ref() == "php" {
298            return HashMap::from_iter([(LanguageName::new_static("PHP"), "php".into())]);
299        }
300
301        self.extension
302            .manifest()
303            .language_servers
304            .get(&self.language_server_id)
305            .map(|server| server.language_ids.clone())
306            .unwrap_or_default()
307    }
308
309    async fn initialization_options(
310        self: Arc<Self>,
311        delegate: &Arc<dyn LspAdapterDelegate>,
312    ) -> Result<Option<serde_json::Value>> {
313        let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
314        let json_options = self
315            .extension
316            .language_server_initialization_options(
317                self.language_server_id.clone(),
318                self.language_name.clone(),
319                delegate,
320            )
321            .await?;
322        Ok(if let Some(json_options) = json_options {
323            serde_json::from_str(&json_options).with_context(|| {
324                format!("failed to parse initialization_options from extension: {json_options}")
325            })?
326        } else {
327            None
328        })
329    }
330
331    async fn workspace_configuration(
332        self: Arc<Self>,
333        delegate: &Arc<dyn LspAdapterDelegate>,
334        _: Option<Toolchain>,
335        _: Option<Uri>,
336        _cx: &mut AsyncApp,
337    ) -> Result<Value> {
338        let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
339        let json_options: Option<String> = self
340            .extension
341            .language_server_workspace_configuration(self.language_server_id.clone(), delegate)
342            .await?;
343        Ok(if let Some(json_options) = json_options {
344            serde_json::from_str(&json_options).with_context(|| {
345                format!("failed to parse workspace_configuration from extension: {json_options}")
346            })?
347        } else {
348            serde_json::json!({})
349        })
350    }
351
352    async fn additional_initialization_options(
353        self: Arc<Self>,
354        target_language_server_id: LanguageServerName,
355        delegate: &Arc<dyn LspAdapterDelegate>,
356    ) -> Result<Option<serde_json::Value>> {
357        let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
358        let json_options: Option<String> = self
359            .extension
360            .language_server_additional_initialization_options(
361                self.language_server_id.clone(),
362                target_language_server_id.clone(),
363                delegate,
364            )
365            .await?;
366        Ok(if let Some(json_options) = json_options {
367            serde_json::from_str(&json_options).with_context(|| {
368                format!(
369                    "failed to parse additional_initialization_options from extension: {json_options}"
370                )
371            })?
372        } else {
373            None
374        })
375    }
376
377    async fn additional_workspace_configuration(
378        self: Arc<Self>,
379        target_language_server_id: LanguageServerName,
380
381        delegate: &Arc<dyn LspAdapterDelegate>,
382
383        _cx: &mut AsyncApp,
384    ) -> Result<Option<serde_json::Value>> {
385        let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
386        let json_options: Option<String> = self
387            .extension
388            .language_server_additional_workspace_configuration(
389                self.language_server_id.clone(),
390                target_language_server_id.clone(),
391                delegate,
392            )
393            .await?;
394        Ok(if let Some(json_options) = json_options {
395            serde_json::from_str(&json_options).with_context(|| {
396                format!("failed to parse additional_workspace_configuration from extension: {json_options}")
397            })?
398        } else {
399            None
400        })
401    }
402
403    async fn labels_for_completions(
404        self: Arc<Self>,
405        completions: &[lsp::CompletionItem],
406        language: &Arc<Language>,
407    ) -> Result<Vec<Option<CodeLabel>>> {
408        let completions = completions
409            .iter()
410            .cloned()
411            .map(lsp_completion_to_extension)
412            .collect::<Vec<_>>();
413
414        let labels = self
415            .extension
416            .labels_for_completions(self.language_server_id.clone(), completions)
417            .await?;
418
419        Ok(labels_from_extension(labels, language))
420    }
421
422    async fn labels_for_symbols(
423        self: Arc<Self>,
424        symbols: &[(String, lsp::SymbolKind)],
425        language: &Arc<Language>,
426    ) -> Result<Vec<Option<CodeLabel>>> {
427        let symbols = symbols
428            .iter()
429            .cloned()
430            .map(|(name, kind)| extension::Symbol {
431                name,
432                kind: lsp_symbol_kind_to_extension(kind),
433            })
434            .collect::<Vec<_>>();
435
436        let labels = self
437            .extension
438            .labels_for_symbols(self.language_server_id.clone(), symbols)
439            .await?;
440
441        Ok(labels_from_extension(labels, language))
442    }
443
444    fn is_extension(&self) -> bool {
445        true
446    }
447}
448
449fn labels_from_extension(
450    labels: Vec<Option<extension::CodeLabel>>,
451    language: &Arc<Language>,
452) -> Vec<Option<CodeLabel>> {
453    labels
454        .into_iter()
455        .map(|label| {
456            let label = label?;
457            let runs = if label.code.is_empty() {
458                Vec::new()
459            } else {
460                language.highlight_text(&label.code.as_str().into(), 0..label.code.len())
461            };
462            build_code_label(&label, &runs, language)
463        })
464        .collect()
465}
466
467fn build_code_label(
468    label: &extension::CodeLabel,
469    parsed_runs: &[(Range<usize>, HighlightId)],
470    language: &Arc<Language>,
471) -> Option<CodeLabel> {
472    let mut text = String::new();
473    let mut runs = vec![];
474
475    for span in &label.spans {
476        match span {
477            extension::CodeLabelSpan::CodeRange(range) => {
478                let code_span = &label.code.get(range.clone())?;
479                let mut input_ix = range.start;
480                let mut output_ix = text.len();
481                for (run_range, id) in parsed_runs {
482                    if run_range.start >= range.end {
483                        break;
484                    }
485                    if run_range.end <= input_ix {
486                        continue;
487                    }
488
489                    if run_range.start > input_ix {
490                        let len = run_range.start - input_ix;
491                        output_ix += len;
492                        input_ix += len;
493                    }
494
495                    let len = range.end.min(run_range.end) - input_ix;
496                    runs.push((output_ix..output_ix + len, *id));
497                    output_ix += len;
498                    input_ix += len;
499                }
500
501                text.push_str(code_span);
502            }
503            extension::CodeLabelSpan::Literal(span) => {
504                let highlight_id = language
505                    .grammar()
506                    .zip(span.highlight_name.as_ref())
507                    .and_then(|(grammar, highlight_name)| {
508                        grammar.highlight_id_for_name(highlight_name)
509                    })
510                    .unwrap_or_default();
511                let ix = text.len();
512                runs.push((ix..ix + span.text.len(), highlight_id));
513                text.push_str(&span.text);
514            }
515        }
516    }
517
518    let filter_range = label.filter_range.clone();
519    text.get(filter_range.clone())?;
520    Some(CodeLabel::new(text, filter_range, runs))
521}
522
523fn lsp_completion_to_extension(value: lsp::CompletionItem) -> extension::Completion {
524    extension::Completion {
525        label: value.label,
526        label_details: value
527            .label_details
528            .map(lsp_completion_item_label_details_to_extension),
529        detail: value.detail,
530        kind: value.kind.map(lsp_completion_item_kind_to_extension),
531        insert_text_format: value
532            .insert_text_format
533            .map(lsp_insert_text_format_to_extension),
534    }
535}
536
537fn lsp_completion_item_label_details_to_extension(
538    value: lsp::CompletionItemLabelDetails,
539) -> extension::CompletionLabelDetails {
540    extension::CompletionLabelDetails {
541        detail: value.detail,
542        description: value.description,
543    }
544}
545
546fn lsp_completion_item_kind_to_extension(
547    value: lsp::CompletionItemKind,
548) -> extension::CompletionKind {
549    match value {
550        lsp::CompletionItemKind::TEXT => extension::CompletionKind::Text,
551        lsp::CompletionItemKind::METHOD => extension::CompletionKind::Method,
552        lsp::CompletionItemKind::FUNCTION => extension::CompletionKind::Function,
553        lsp::CompletionItemKind::CONSTRUCTOR => extension::CompletionKind::Constructor,
554        lsp::CompletionItemKind::FIELD => extension::CompletionKind::Field,
555        lsp::CompletionItemKind::VARIABLE => extension::CompletionKind::Variable,
556        lsp::CompletionItemKind::CLASS => extension::CompletionKind::Class,
557        lsp::CompletionItemKind::INTERFACE => extension::CompletionKind::Interface,
558        lsp::CompletionItemKind::MODULE => extension::CompletionKind::Module,
559        lsp::CompletionItemKind::PROPERTY => extension::CompletionKind::Property,
560        lsp::CompletionItemKind::UNIT => extension::CompletionKind::Unit,
561        lsp::CompletionItemKind::VALUE => extension::CompletionKind::Value,
562        lsp::CompletionItemKind::ENUM => extension::CompletionKind::Enum,
563        lsp::CompletionItemKind::KEYWORD => extension::CompletionKind::Keyword,
564        lsp::CompletionItemKind::SNIPPET => extension::CompletionKind::Snippet,
565        lsp::CompletionItemKind::COLOR => extension::CompletionKind::Color,
566        lsp::CompletionItemKind::FILE => extension::CompletionKind::File,
567        lsp::CompletionItemKind::REFERENCE => extension::CompletionKind::Reference,
568        lsp::CompletionItemKind::FOLDER => extension::CompletionKind::Folder,
569        lsp::CompletionItemKind::ENUM_MEMBER => extension::CompletionKind::EnumMember,
570        lsp::CompletionItemKind::CONSTANT => extension::CompletionKind::Constant,
571        lsp::CompletionItemKind::STRUCT => extension::CompletionKind::Struct,
572        lsp::CompletionItemKind::EVENT => extension::CompletionKind::Event,
573        lsp::CompletionItemKind::OPERATOR => extension::CompletionKind::Operator,
574        lsp::CompletionItemKind::TYPE_PARAMETER => extension::CompletionKind::TypeParameter,
575        _ => extension::CompletionKind::Other(extract_int(value)),
576    }
577}
578
579fn lsp_insert_text_format_to_extension(
580    value: lsp::InsertTextFormat,
581) -> extension::InsertTextFormat {
582    match value {
583        lsp::InsertTextFormat::PLAIN_TEXT => extension::InsertTextFormat::PlainText,
584        lsp::InsertTextFormat::SNIPPET => extension::InsertTextFormat::Snippet,
585        _ => extension::InsertTextFormat::Other(extract_int(value)),
586    }
587}
588
589fn lsp_symbol_kind_to_extension(value: lsp::SymbolKind) -> extension::SymbolKind {
590    match value {
591        lsp::SymbolKind::FILE => extension::SymbolKind::File,
592        lsp::SymbolKind::MODULE => extension::SymbolKind::Module,
593        lsp::SymbolKind::NAMESPACE => extension::SymbolKind::Namespace,
594        lsp::SymbolKind::PACKAGE => extension::SymbolKind::Package,
595        lsp::SymbolKind::CLASS => extension::SymbolKind::Class,
596        lsp::SymbolKind::METHOD => extension::SymbolKind::Method,
597        lsp::SymbolKind::PROPERTY => extension::SymbolKind::Property,
598        lsp::SymbolKind::FIELD => extension::SymbolKind::Field,
599        lsp::SymbolKind::CONSTRUCTOR => extension::SymbolKind::Constructor,
600        lsp::SymbolKind::ENUM => extension::SymbolKind::Enum,
601        lsp::SymbolKind::INTERFACE => extension::SymbolKind::Interface,
602        lsp::SymbolKind::FUNCTION => extension::SymbolKind::Function,
603        lsp::SymbolKind::VARIABLE => extension::SymbolKind::Variable,
604        lsp::SymbolKind::CONSTANT => extension::SymbolKind::Constant,
605        lsp::SymbolKind::STRING => extension::SymbolKind::String,
606        lsp::SymbolKind::NUMBER => extension::SymbolKind::Number,
607        lsp::SymbolKind::BOOLEAN => extension::SymbolKind::Boolean,
608        lsp::SymbolKind::ARRAY => extension::SymbolKind::Array,
609        lsp::SymbolKind::OBJECT => extension::SymbolKind::Object,
610        lsp::SymbolKind::KEY => extension::SymbolKind::Key,
611        lsp::SymbolKind::NULL => extension::SymbolKind::Null,
612        lsp::SymbolKind::ENUM_MEMBER => extension::SymbolKind::EnumMember,
613        lsp::SymbolKind::STRUCT => extension::SymbolKind::Struct,
614        lsp::SymbolKind::EVENT => extension::SymbolKind::Event,
615        lsp::SymbolKind::OPERATOR => extension::SymbolKind::Operator,
616        lsp::SymbolKind::TYPE_PARAMETER => extension::SymbolKind::TypeParameter,
617        _ => extension::SymbolKind::Other(extract_int(value)),
618    }
619}
620
621fn extract_int<T: Serialize>(value: T) -> i32 {
622    maybe!({
623        let kind = serde_json::to_value(&value)?;
624        serde_json::from_value(kind)
625    })
626    .log_err()
627    .unwrap_or(-1)
628}
629
630#[test]
631fn test_build_code_label() {
632    use util::test::marked_text_ranges;
633
634    let (code, code_ranges) = marked_text_ranges(
635        "«const» «a»: «fn»(«Bcd»(«Efgh»)) -> «Ijklm» = pqrs.tuv",
636        false,
637    );
638    let code_runs = code_ranges
639        .into_iter()
640        .map(|range| (range, HighlightId(0)))
641        .collect::<Vec<_>>();
642
643    let label = build_code_label(
644        &extension::CodeLabel {
645            spans: vec![
646                extension::CodeLabelSpan::CodeRange(code.find("pqrs").unwrap()..code.len()),
647                extension::CodeLabelSpan::CodeRange(
648                    code.find(": fn").unwrap()..code.find(" = ").unwrap(),
649                ),
650            ],
651            filter_range: 0.."pqrs.tuv".len(),
652            code,
653        },
654        &code_runs,
655        &language::PLAIN_TEXT,
656    )
657    .unwrap();
658
659    let (label_text, label_ranges) =
660        marked_text_ranges("pqrs.tuv: «fn»(«Bcd»(«Efgh»)) -> «Ijklm»", false);
661    let label_runs = label_ranges
662        .into_iter()
663        .map(|range| (range, HighlightId(0)))
664        .collect::<Vec<_>>();
665
666    assert_eq!(
667        label,
668        CodeLabel::new(label_text, label.filter_range.clone(), label_runs)
669    )
670}
671
672#[test]
673fn test_build_code_label_with_invalid_ranges() {
674    use util::test::marked_text_ranges;
675
676    let (code, code_ranges) = marked_text_ranges("const «a»: «B» = '🏀'", false);
677    let code_runs = code_ranges
678        .into_iter()
679        .map(|range| (range, HighlightId(0)))
680        .collect::<Vec<_>>();
681
682    // A span uses a code range that is invalid because it starts inside of
683    // a multi-byte character.
684    let label = build_code_label(
685        &extension::CodeLabel {
686            spans: vec![
687                extension::CodeLabelSpan::CodeRange(
688                    code.find('B').unwrap()..code.find(" = ").unwrap(),
689                ),
690                extension::CodeLabelSpan::CodeRange((code.find('🏀').unwrap() + 1)..code.len()),
691            ],
692            filter_range: 0.."B".len(),
693            code,
694        },
695        &code_runs,
696        &language::PLAIN_TEXT,
697    );
698    assert!(label.is_none());
699
700    // Filter range extends beyond actual text
701    let label = build_code_label(
702        &extension::CodeLabel {
703            spans: vec![extension::CodeLabelSpan::Literal(
704                extension::CodeLabelSpanLiteral {
705                    text: "abc".into(),
706                    highlight_name: Some("type".into()),
707                },
708            )],
709            filter_range: 0..5,
710            code: String::new(),
711        },
712        &code_runs,
713        &language::PLAIN_TEXT,
714    );
715    assert!(label.is_none());
716}