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. This is not fully integrated and does not have an effect yet. It can be manually tested.
We add a build step to generate the parser from the grammar into our build system, so the code is properly integrated into studio.

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)

## Release notes: product changes ### New features - **Simple graph visualization** We add simple graph visualization. To try it, run a query that returns ConceptRows and select the graph output type. - **Better visual feedback on startup connection, query errors and switching database** Auto-reconnection on startup, query errors, and switching database now all trigger popup notifications in addition to their usual behaviour. ### Bugs fixed - **Correctly render attribute values in log output** - **Fix some buttons having no state change on hover** - **If creating a database fails, show the error** - **Add field validation to database creation dialog** - **Add field validation to connection address** --------- Co-authored-by: Krishnan Govindraj <[email protected]>

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

❌ Deploy Preview for typedb-studio failed. Why did it fail? →

Name	Link
🔨 Latest commit	`7982e8c`
🔍 Latest deploy log	https://app.netlify.com/projects/typedb-studio/deploys/685303a9ce2d6a0008abcebe

krishnangovindraj

quick self review

krishnangovindraj · 2025-06-12T12:51:52Z

package.json

@@ -3,6 +3,7 @@
  "version": "3.4.0-ad30523694ad2b07d11ed0a406b3fe3676358705",
  "scripts": {
    "ng": "ng",
+    "generate-grammar": "lezer-generator --typeScript src/framework/codemirror-lang-typeql/typeql.grammar -o src/framework/codemirror-lang-typeql/generated/typeql.grammar.generated",


We have to run this step every time we update the typeql.grammar file. I should probably add a comment in that file.

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).

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

@@ -128,4 +131,6 @@ export class QueryToolComponent implements OnInit, AfterViewInit, OnDestroy {
    readonly JSON = JSON;
    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 (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.

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.

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?

alexjpwalker and others added 8 commits April 30, 2025 16:39

Merge branch 'development'

057c08a

Merge branch 'development'

2458fb1

Merge branch 'development'

ea03618

Merge branch 'development'

845388a

Merge branch 'development'

4c83b95

Merge branch 'development'

3618375

Merge branch 'development'

8cfe668

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

alexjpwalker added 2 commits May 29, 2025 15:53

Merge branch 'development'

da83ee8

Merge branch 'development'

5ad6ef6

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

Introduce schema tree view on Query page

7d600c5

krishnangovindraj commented Jun 13, 2025

View reviewed changes

alexjpwalker added 2 commits June 17, 2025 13:33

Merge branch 'development' into schema-tree

a880ed6

Enrich schema tree view with owns, plays and relates links

d75f7c4

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

alexjpwalker added 2 commits June 18, 2025 16:23

Represent schema as a map of labels to concepts. Standardise terminology

0a2ea88

Clear schema tool window on unloading schema

9cd9551

alexjpwalker and others added 20 commits June 18, 2025 16:27

Clean up comments

1db29e8

Typo squatting

7ff002a

Schema tool window scrolling behaviour

55b4533

Schema tool window: add top border to scrollable area when scrolled

6947f73

Update autocomplete

9b9b565

Cleanup some comments

3f120a7

Eeps. Why can't i select autocomplete stuff

6b802e4

OOf, works somewhat ok

9e735df

Rearrange

16edf3d

More clenaups, esp with navigation helpers

1255bd3

Suggestions for has and links constraints are nicely scoped

ba9299f

Fix boost in variables not being used

3ce4391

Minor refactors

4269c36

Add TODO to remove window.OC_lastQueryAnswers

9107094

Retry CI

e456b05

Post rebase working in

4477aba

Update deriving partial schema from text editor state

fa6b1d7

Plug in schema from schema state to autocomplete

e292510

Small cleanup of todos and unused imports

463cefe

Move lezer to the appropriate line in devDependencies

c9990bb

krishnangovindraj force-pushed the update-typeql-autocomplete branch from 55561a1 to c9990bb Compare June 18, 2025 18:17

Update names for rebase

7982e8c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix autocomplete suggesting erratically & add more suggestions #866

Fix autocomplete suggesting erratically & add more suggestions #866

Uh oh!

krishnangovindraj commented May 26, 2025 •

edited

Loading

Uh oh!

netlify bot commented May 26, 2025 •

edited

Loading

Uh oh!

krishnangovindraj left a comment

Uh oh!

krishnangovindraj Jun 12, 2025

Uh oh!

krishnangovindraj Jun 12, 2025

Uh oh!

krishnangovindraj Jun 12, 2025

Uh oh!

krishnangovindraj Jun 12, 2025

Uh oh!

krishnangovindraj Jun 12, 2025

Uh oh!

krishnangovindraj Jun 12, 2025

Uh oh!

krishnangovindraj Jun 12, 2025

Uh oh!

krishnangovindraj Jun 17, 2025

Uh oh!

krishnangovindraj Jun 17, 2025

Uh oh!

krishnangovindraj Jun 18, 2025

Uh oh!

Uh oh!

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

Fix autocomplete suggesting erratically & add more suggestions #866

Are you sure you want to change the base?

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 failed. Why did it fail? →

Uh oh!

krishnangovindraj left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

krishnangovindraj commented May 26, 2025 •

edited

Loading

netlify bot commented May 26, 2025 •

edited

Loading