Add Reexport Field to Suggestions

[4e6]

Pull Request Description

close #1670

PR adds the reexport field to suggestions. It contains a fully qualified module name of the outermost module (module with the shortest path) that re-exports the suggestion.

Changelog:

• feat: add new suggestion type Module. Previously modules were represented as atom suggestions
• feat: add reexport field to suggestions
• feat: extract the list of re-exported symbols from a module during compilation
• feat: implement diff algorithm between exported symbols of two modules (before and after edit)
• feat: apply updates with module exports to suggestions database
• misc: suggestions handler applies suggestion database updates in a sequence
• misc: update SQLite dependency

Important Notes

⚠️ PR is not backward-compatible with IDE because of the new suggestion variant Module

Changes in the Language Server protocol.

1. Added new Suggestion type: Module

 // A type of suggestion entries.
 type SuggestionEntry =
+  // A module
+  | SuggestionEntryModule
   // A value constructor
   | SuggestionEntryAtom
   // A method defined on a type
@@ -409,6 +411,12 @@ type SuggestionEntry =
   // A local value
   | SuggestionEntryLocal;

+interface SuggestionEntryModule {
+  module: string;
+  documentation?: string;
+  reexport?: string;
+}

2. Module, Atom and Mehod suggestions have an optional reexport field.

interface SuggestionEntryAtom {
   externalId?: UUID;
   name: string;
@@ -416,6 +424,7 @@ interface SuggestionEntryAtom {
   arguments: SuggestionEntryArgument[];
   returnType: string;
   documentation?: string;
+  reexport?: string;
 }

 interface SuggestionEntryMethod {
@@ -426,6 +435,7 @@ interface SuggestionEntryMethod {
   selfType: string;
   returnType: string;
   documentation?: string;
+  reexport?: string;
 }

3. reexport field can be modified.

/**
 * The kind of the suggestions database update.
 */
type SuggestionsDatabaseUpdate = Add | Remove | Modify;

@@ -675,6 +796,11 @@ interface Modify {
    * The scope to update.
    */
   scope?: FieldUpdate<SuggestionEntryScope>;
+
+  /**
+   * The reexport field to update.
+   */
+  reexport?: FieldUpdate<String>;
 }

Checklist

Please include the following checklist in your PR:

• The documentation has been updated if necessary.
• All code conforms to the Scala, Java, and Rust style guides.
• All documentation and configuration conforms to the markdown and YAML style guides.
• All code has been tested where possible.

[radeusgd]

Looks good to me, but in some places additional documentation explaining the mechanisms would be helpful to understand the intentions behind the code

[radeusgd]

Why is this queue mutable? It feels like an anti-pattern to store a mutable queue in a state that is meant to be immutable and is explicitly modified. If the queue is to be mutable, it could just as well be stored in a member variable of the object instead of this state, no?

[4e6]

I agree, in general, a mutable state in actor it's an antipattern and can be refactored by making it an argument of a receive function. This works well with single values, but this case is a bit different. On startup, we receive a burst of suggestion updates. Updating a mutable queue is more efficient than copying the queue on every update.