feat(fmt): lsp find references #4934

Druue · 2024-06-20T17:33:30Z

I left details on testing this locally in the language-tools pr here

closes https://github.com/prisma/team-orm/issues/1201

Screen.Recording.2024-06-26.at.14.29.33.mov

Screen.Recording.2024-06-26.at.14.27.22.mov

closes https://github.com/prisma/team-orm/issues/1196

Screen.Recording.2024-06-26.at.14.22.53.mov

These only apply to models and views. Composite types have uniques, indices, so on defined in their containing model / view.

closes https://github.com/prisma/team-orm/issues/1200

codspeed-hq · 2024-06-20T17:37:36Z

CodSpeed Performance Report

Merging #4934 will not alter performance

_{Comparing feat/references (3b70d69) with main (34ace0e)}

Summary

✅ 11 untouched benchmarks

github-actions · 2024-06-20T17:38:32Z

WASM Query Engine file Size

Engine	This PR	Base branch	Diff
Postgres	2.044MiB	2.044MiB	255.000B
Postgres (gzip)	814.777KiB	814.575KiB	207.000B
Mysql	2.014MiB	2.014MiB	241.000B
Mysql (gzip)	801.034KiB	801.013KiB	21.000B
Sqlite	1.915MiB	1.915MiB	241.000B
Sqlite (gzip)	763.149KiB	762.983KiB	170.000B

test views on name and as type

Add AttributePosition::ArgumentValue(...)

prisma-schema-wasm/src/lib.rs

… for completions (from engines) so we're now capable of offering completions based on partial text :)

Druue · 2024-06-26T12:11:21Z

psl/schema-ast/src/ast/find_at_position/attribute.rs

+                let arr = arg.value.as_array().unwrap();
+                let expr = arr.0.iter().find(|expr| expr.span().contains(position));
+                if let Some(expr) = expr {
+                    return Self::ArgumentValue(arg.name(), expr.to_string());


Problem: when using nested composite type fields in attributes, i.e.

model User { id String @id @map("_id") @db.String address Address @@unique([address.poBox.name]) } type Address { street String @db.String city String poBox POBox } type SubType { name String }

We retrieve the whole string that is defined, i.e.

"address.poBox.name"

and dont have more granular understanding of if the cursor is inside address, poBox or name.

This PR already supports finding fields from non-nested fields in block attributes, but I'm not sure what to do with this.

This seems like it would require modification to this pest grammar:

expression = { function_call | array_expression | numeric_literal | string_literal | path } string_literal = ${ "\"" ~ string_content ~ "\"" } string_content = @{ (string_escape | !("\"" | ASCII_CONTROL_CHARACTER) ~ ANY)* }

But I'm not fully sure of the ramifications of changing the pest grammar like this. If this is something we want to explore, I think it should be in a follow-up PR as a stretch goal.

We could maybe make string literal an option of string content or string array content 🤔

The string literal rule is irrelevant here, it matches a quoted string literal in source code of the schema and there are no quotes here. The relevant rule is path, and it is already defined as

identifier = @{ ASCII_ALPHANUMERIC ~ ( "_" | "-" | ASCII_ALPHANUMERIC)* } path = @{ identifier ~ ("." ~ path?)* }

so no modifications are necessary in the grammar, it is already defined the way you need.

You need to modify the Rule::path case in parse_expression in psl/schema-ast/src/parser/parse_expression.rs to recurse into path and create a separate span for each identifier token instead of converting the whole subtree to string as it does now.

Druue · 2024-06-26T15:43:08Z

prisma-schema-wasm/src/lib.rs

+/// `CodeActionParams` object and the response being a list of
+/// `CodeActionOrCommand` objects.
+#[wasm_bindgen]
+pub fn references(schema: String, params: String) -> String {


new wasm endpoint for references to be used by language-tools

Druue · 2024-06-26T15:44:05Z

prisma-fmt/src/references.rs

+    Vec::new()
+}
+
+pub(crate) fn references(schema_files: Vec<(String, SourceFile)>, params: ReferenceParams) -> Vec<Location> {


This is where we actually handle finding all the references

Druue · 2024-06-26T15:45:10Z

psl/psl-core/src/builtin_connectors/postgres_datamodel_connector.rs

@@ -495,7 +495,7 @@ impl Connector for PostgresDatamodelConnector {
                ast::ModelPosition::ModelAttribute(
                    "index",
                    attr_id,
-                    ast::AttributePosition::FunctionArgument(field_name, "ops"),


changed to line-up with changes in find_at_position

psl/psl-core/src/builtin_connectors/mssql_datamodel_connector.rs

Druue · 2024-06-26T15:50:38Z

prisma-fmt/src/text_document_completion.rs

@@ -85,19 +86,47 @@ fn push_ast_completions(ctx: CompletionContext<'_>, completion_list: &mut Comple
        .relation_mode()
        .unwrap_or_else(|| ctx.connector().default_relation_mode());

-    match ctx.db.ast(ctx.initiating_file_id).find_at_position(position) {
+    let find_at_position = ctx.db.ast(ctx.initiating_file_id).find_at_position(position);


In the process of updating find_at_position for references I broke completions for referential actions. However, due to the changes in find_at_position we are now able to offer completions on partial values:

Screen.Recording.2024-06-25.at.22.47.11.mov

Druue · 2024-06-26T15:53:30Z

prisma-schema-wasm/src/lib.rs

@@ -86,7 +86,7 @@ pub fn preview_features() -> String {
 }

 /// The API is modelled on an LSP [completion
-/// request](https://github.com/microsoft/language-server-protocol/blob/gh-pages/_specifications/specification-3-16.md#textDocument_completion).
+/// request](https://github.com/microsoft/language-server-protocol/blob/gh-pages/_specifications/specification-3-16.md#completion-request-leftwards_arrow_with_hook).


These docs links were outdated, they now link to the correct sections :)

Weakky

Nice work, there's a couple of things you can improve

prisma-fmt/src/references.rs

psl/psl-core/src/builtin_connectors/mssql_datamodel_connector.rs

psl/schema-ast/src/ast/argument.rs

prisma-fmt/src/references.rs

find_where_used_* - return iterators instead of immediately collecting to vecs - Note: these then have to be immediately collected by the caller as rust otherwise complains about opaque types. Can be revisited later if we see fit. find_where_used_in_model - rename *_as_field_name - now returns an optional identifier instead of a vec - cut down iteration - finding the model / view is now infallible find_where_used_as_field_type - general clean up - remove fields allocation find_where_used_as_top_name - use top interner instead of iterating everything - return Option of identifier instead of iterator Co-authored-by: Flavian Desverne <flavian.dsv@gmail.com>

…of `@default`

prisma-fmt/src/references.rs

...a-fmt/tests/text_document_completion/scenarios/referential_actions_in_progress_2/result.json

prisma-fmt/tests/references/scenarios/model_as_type/result.json

string interning seems to not support datasources

added find_source

Weakky

Great work 👍

* companion pr to prisma/prisma-engines#4934 * test references in LT --------- Co-authored-by: Serhii Tatarintsev <tatarintsev@prisma.io>

Druue added 2 commits June 24, 2024 19:06

prep-work for references

40da783

references

e1b602d

Druue force-pushed the feat/references branch from fa6d979 to e1b602d Compare June 24, 2024 17:06

Druue added 7 commits June 24, 2024 19:36

rmv duplicate name

dfdc2cd

Added test api for references

cbf4605

test views on name and as type

test enums on name and as type

80c08de

test composite types on name and as type

2ef3aa4

test models on name and as type

0c2fa93

test datasource on name and as attribute

891eddd

Actually use AttributePosition

7d528fe

Add AttributePosition::ArgumentValue(...)

Druue commented Jun 25, 2024

View reviewed changes

prisma-schema-wasm/src/lib.rs Outdated Show resolved Hide resolved

Druue added 7 commits June 25, 2024 22:50

In the process of adding more granularity for references, fixed a bug…

69556c7

… for completions (from engines) so we're now capable of offering completions based on partial text :)

find field in model from field in relation fields

cf09ea0

find field in model from field in relation references

36bbb34

support finding fields from relations in views

cebc7eb

find field from block attribute index & unique

17a8531

find datasource from native type

e2fe053

Update docs links

65bdf1b

Druue added this to the 5.17.0 milestone Jun 26, 2024

Druue commented Jun 26, 2024

View reviewed changes

Druue added 2 commits June 26, 2024 14:19

clippy

95625aa

clean-up

fffaaee

Druue marked this pull request as ready for review June 26, 2024 15:39

Druue requested a review from a team as a code owner June 26, 2024 15:39

Druue requested review from Weakky and removed request for a team June 26, 2024 15:39

Druue commented Jun 26, 2024

View reviewed changes

psl/psl-core/src/builtin_connectors/mssql_datamodel_connector.rs Show resolved Hide resolved

Druue commented Jun 26, 2024

View reviewed changes

Druue added a commit to prisma/language-tools that referenced this pull request Jun 26, 2024

companion pr to prisma/prisma-engines#4934

598057c

Druue mentioned this pull request Jun 26, 2024

feat(LS): references prisma/language-tools#1775

Merged

Weakky suggested changes Jul 2, 2024

View reviewed changes

Druue and others added 3 commits July 2, 2024 12:26

map should be offered when we aren't in a specific part of an attribute

28a71e4

test that mssql default map doesn't show up inside specific sections …

1d337ab

…of `@default`

Weakky reviewed Jul 2, 2024

View reviewed changes

prisma-fmt/src/references.rs Outdated Show resolved Hide resolved

Weakky reviewed Jul 2, 2024

View reviewed changes

...a-fmt/tests/text_document_completion/scenarios/referential_actions_in_progress_2/result.json Show resolved Hide resolved

Weakky reviewed Jul 2, 2024

View reviewed changes

prisma-fmt/tests/references/scenarios/model_as_type/result.json Show resolved Hide resolved

Druue added 4 commits July 2, 2024 18:15

consume split instead of collecting

1cb0fa7

string interning seems to not support datasources

correctly retrieve datasource identifier

dc1be2a

added find_source

clippy

5d25b91

don't unwrap split

3b70d69

Weakky approved these changes Jul 3, 2024

View reviewed changes

Druue merged commit 9b8d05f into main Jul 3, 2024
206 checks passed

Druue deleted the feat/references branch July 3, 2024 21:34

Druue added a commit to prisma/language-tools that referenced this pull request Jul 4, 2024

companion pr to prisma/prisma-engines#4934

707b7bc

Druue added a commit to prisma/language-tools that referenced this pull request Jul 4, 2024

feat(LS): references (#1775)

ca5d029

* companion pr to prisma/prisma-engines#4934 * test references in LT --------- Co-authored-by: Serhii Tatarintsev <tatarintsev@prisma.io>

This was referenced Jul 18, 2024

Highlight and let me navigate to back relation belonging to a relation prisma/language-tools#1167

Open

Support fetching references for a model prisma/language-tools#982

Closed

Druue linked an issue Jul 18, 2024 that may be closed by this pull request

Support fetching references for a model prisma/language-tools#982

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(fmt): lsp find references #4934

feat(fmt): lsp find references #4934

Druue commented Jun 20, 2024 •

edited

Loading

codspeed-hq bot commented Jun 20, 2024 •

edited

Loading

github-actions bot commented Jun 20, 2024 •

edited

Loading

Druue Jun 26, 2024 •

edited

Loading

aqrln Jun 26, 2024

Druue Jun 26, 2024

Druue Jun 26, 2024

Druue Jun 26, 2024

Druue Jun 26, 2024

Druue Jun 26, 2024

Weakky left a comment

Weakky left a comment

feat(fmt): lsp find references #4934

feat(fmt): lsp find references #4934

Conversation

Druue commented Jun 20, 2024 • edited Loading

codspeed-hq bot commented Jun 20, 2024 • edited Loading

CodSpeed Performance Report

Merging #4934 will not alter performance

Summary

github-actions bot commented Jun 20, 2024 • edited Loading

WASM Query Engine file Size

Druue Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

aqrln Jun 26, 2024

Choose a reason for hiding this comment

Druue Jun 26, 2024

Choose a reason for hiding this comment

Druue Jun 26, 2024

Choose a reason for hiding this comment

Druue Jun 26, 2024

Choose a reason for hiding this comment

Druue Jun 26, 2024

Choose a reason for hiding this comment

Druue Jun 26, 2024

Choose a reason for hiding this comment

Weakky left a comment

Choose a reason for hiding this comment

Weakky left a comment

Choose a reason for hiding this comment

Druue commented Jun 20, 2024 •

edited

Loading

codspeed-hq bot commented Jun 20, 2024 •

edited

Loading

github-actions bot commented Jun 20, 2024 •

edited

Loading

Druue Jun 26, 2024 •

edited

Loading