Fix autocomplete suggesting erratically & add more suggestions #866

krishnangovindraj · 2025-05-26T18:53:59Z

Release notes: product changes

We fix a bug where the suggestions of variables & labels were unpredictable, and implement more suggestions in an extensible, but ad-hoc way.
We enable suggestions based on a datastructure representing the schema, allowing labels to be suggested based on the schema. The schema is loaded both from the database and from the editor state.

Motivation

Better autocomplete.

Implementation

We walk up the tree till we find a node we want to do a suggestion at. We're provided with a "prefix". This is the union of the direct children of every node on the path from this suggesting node to the node being parsed*. The nodes on the path are excluded.
E.g. If we reach ClauseMatch where ClauseMatch { MATCH Patterns }; Pattern { (Pattern SEMICOLON)+ } on our climb,
match $x isa person; $y , prefix would be [MATCH, Pattern, SEMICOLON, VAR].

(Any children to the right of th e parse point are ignored, because we could be editing in-between nodes)

Ideally, we'd be able to partially generate suggestions from the grammar. Lezer provides a grammar for lezer grammar files.

Manually testing the schema-based suggestions

# Run the following query.
match $default-owner owns $default-owned; limit 1;
match $default-relation relates $default-related; limit 1;
match $default-player plays $default-played; limit 1;
match

{ $owner owns $owned; $relation is $default-relation; $related is $default-related; $player is $default-player; $played is $default-played; } or 
{ $owner is $default-owner; $owned is $default-owned; $relation relates $related; $player is $default-player; $played is $default-played; } or
{ $owner is $default-owner; $owned is $default-owned; $relation is $default-relation; $related is $default-related; $player plays $played; };

And this in the JS console:
_updateSchemaFromDB(_lastQueryAnswers, _lastQueryAnswers, _lastQueryAnswers)

netlify · 2025-05-26T18:54:12Z

✅ Deploy Preview for typedb-studio ready!

Name	Link
🔨 Latest commit	`d9c6388`
🔍 Latest deploy log	https://app.netlify.com/projects/typedb-studio/deploys/68594932f4fc6c000842609b
😎 Deploy Preview	https://deploy-preview-866--typedb-studio.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

krishnangovindraj

quick self review

package.json

krishnangovindraj · 2025-06-12T12:54:42Z

src/framework/codemirror-lang-typeql/complete.ts

This is a rather generic framework for autocomplete. I don't know its limitations.
You should not have to change this file to add new suggestions, just update typeql_suggestions.ts

krishnangovindraj · 2025-06-12T14:42:19Z

src/framework/codemirror-lang-typeql/typeQLAutocompleteSchema.ts

+
+    static fromDriver(driver: DriverState, database: string): TypeQLAutocompleteSchemaImpl | null {
+        function runQuery(driver: DriverState, database: string, query: string): ConceptRowAnswer[] {
+            // todo: Help please alex


@alexjpwalker , This is the function I don't know how to implement in the current state of studio. Can you sketch me an implementation? (or do it if you think it's faster that way).

You did tell me to add a subscriber in the constructor of (schema-state-service iirc) and it works.

krishnangovindraj · 2025-06-12T14:50:18Z

src/framework/codemirror-lang-typeql/index.ts

+  return autocompletion({ override: [wrappedAutocomplete] });
+}
+
+function updateSchemaFromDB(driver: DriverState, database: string) {


Actually, this is the function that needs to be called when the user wants to reload the schema

krishnangovindraj · 2025-06-12T19:20:13Z

src/module/query/query-tool.component.ts

    readonly TypeQL = TypeQL;
    readonly linter = otherExampleLinter;
+    readonly typeqlAutocompleteExtension = typeqlAutocompleteExtension;
+    readonly codeEditorKeymap = keymap.of([...defaultKeymap, {key: "Alt-Space", run: startCompletion, preventDefault: true}]);


I added this for mac. I couldn't get the default combination to work.

krishnangovindraj · 2025-06-12T19:20:44Z

src/framework/graph-visualiser/index.ts

        if (isApiErrorResponse(res)) return;
-
        if (res.ok.answerType == "conceptRows" && res.ok.query != null) {
+            (window as any)._lastQueryAnswers = res.ok.answers;


Sneak this into the global namespace for testing schema based suggestions.

krishnangovindraj · 2025-06-12T19:20:54Z

src/framework/codemirror-lang-typeql/typeql_suggestions.ts

+        { suffixes: [ [tokens.PLAYS] ], suggestions: [ suggestRoleTypeLabelsScoped ] },
+        { suffixes: [ [tokens.RELATES] ], suggestions: [ suggestRoleTypeLabelsUnscoped ] },
+    ],
+    // TODO: ...


Anything we find missing.

krishnangovindraj · 2025-06-17T09:34:11Z

src/framework/codemirror-lang-typeql/typeQLAutocompleteSchema.ts

This file will ideally go away and be replaced by the schema state built for the schema tree.

Now that schema state is merged can we do this refactor?

No, we need to keep it since it wraps two instances of the tree.
One that originates from the DB and one from the editor-state

krishnangovindraj · 2025-06-17T09:35:11Z

src/framework/codemirror-lang-typeql/typeql_suggestions.ts

~~This file will have to be updated to use your state instead of mine.~~
Doesn't, since my state now wraps two instances of your state.

krishnangovindraj · 2025-06-18T13:07:44Z

src/framework/codemirror-lang-typeql/index.ts

+  return autocompletion({ override: [wrappedAutocomplete] });
+}
+
+function updateSchemaFromDB(schema: Schema) {


How do I call this on schema change, Alex?

package.json

alexjpwalker · 2025-06-23T10:42:16Z

src/framework/codemirror-lang-typeql/typeQLAutocompleteSchema.ts

Now that schema state is merged can we do this refactor?

krishnangovindraj self-assigned this May 26, 2025

krishnangovindraj added the domain: text-editor label May 26, 2025

krishnangovindraj added the type: feature label May 26, 2025

krishnangovindraj force-pushed the update-typeql-autocomplete branch 3 times, most recently from 8d72c22 to 9cd1f7f Compare June 12, 2025 14:40

krishnangovindraj commented Jun 12, 2025

View reviewed changes

krishnangovindraj marked this pull request as ready for review June 12, 2025 19:28

krishnangovindraj requested review from alexjpwalker and flyingsilverfin as code owners June 12, 2025 19:28

krishnangovindraj commented Jun 13, 2025

View reviewed changes

krishnangovindraj force-pushed the update-typeql-autocomplete branch from 778b45f to 6d40872 Compare June 18, 2025 13:06

krishnangovindraj commented Jun 18, 2025

View reviewed changes

krishnangovindraj force-pushed the update-typeql-autocomplete branch 2 times, most recently from 7982e8c to 6150679 Compare June 22, 2025 15:34

krishnangovindraj added 13 commits June 23, 2025 16:10

Update autocomplete

321227a

Cleanup some comments

288a0e8

Eeps. Why can't i select autocomplete stuff

8c34fda

OOf, works somewhat ok

1227834

Rearrange

1f4abe9

More clenaups, esp with navigation helpers

52acba1

Suggestions for has and links constraints are nicely scoped

cdbbc8a

Fix boost in variables not being used

80c0101

Minor refactors

5fde472

Add TODO to remove window.OC_lastQueryAnswers

150f613

Retry CI

8d0bc18

Post rebase working in

7297973

Update deriving partial schema from text editor state

79d49e5

krishnangovindraj added 4 commits June 23, 2025 16:10

Plug in schema from schema state to autocomplete

0c7cd20

Small cleanup of todos and unused imports

edca4e1

Move lezer to the appropriate line in devDependencies

a7ce29c

Update names for rebase

0f6b708

krishnangovindraj force-pushed the update-typeql-autocomplete branch from 6150679 to 0f6b708 Compare June 23, 2025 10:40

alexjpwalker requested changes Jun 23, 2025

View reviewed changes

krishnangovindraj added 2 commits June 23, 2025 16:22

run pnpm install

6b76ebb

Cleanup comment from index.ts

d9c6388

alexjpwalker approved these changes Jun 23, 2025

View reviewed changes

alexjpwalker merged commit 5df465f into typedb:development Jun 23, 2025
4 checks passed

Fix autocomplete suggesting erratically & add more suggestions #866

Fix autocomplete suggesting erratically & add more suggestions #866

Uh oh!

Conversation

krishnangovindraj commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release notes: product changes

Motivation

Implementation

Manually testing the schema-based suggestions

Uh oh!

netlify bot commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typedb-studio ready!

Uh oh!

krishnangovindraj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krishnangovindraj Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

krishnangovindraj commented May 26, 2025 •

edited

Loading

netlify bot commented May 26, 2025 •

edited

Loading

krishnangovindraj Jun 17, 2025 •

edited

Loading