Add the pyright language server #2797

IamtherealBrian · 2024-08-21T01:31:10Z

This PR adds a flag to specify a language server for Python UDF. By default we use the pyright language server, and can switch to to the original language server called pylsp (python language server).

Key change:
-Add a flag to switch between pyright and pylsp
-Add the pyright language server

When the flag is set to use the pyright:

When the flag is set to use the pylsp:

Reason to add pyright:
-Performance on the basic language server function: Both Pyright and pylsp show comparable performance in fundamental language server functionalities, such as hover, go-to definition, and autocompletion. Thus the basic user experience remains the same regardless of the chosen language server.
-Pyright has a better ability to detect semantic errors: Pyright excels in identifying a broader range of syntax and semantic errors, particularly for code that includes type annotations. This strength makes it a valuable tool for developers who require more rigorous type checking and error detection in their Python code.

Evaluation between two language servers:
A detailed evaluation comparing the performance of two language servers on detecting basic semantic errors:

Differences between two language servers:
For a more in-depth comparison of the differences between Pyright and pylsp, please refer to this discussion:
python-lsp/python-lsp-server#90

Summary:
While Pyright offers the potential for an improved user experience, especially in terms of finding semantic errors, pylsp is widely used and well-documented within its developer community. To balance the benefits of both tools, we have chosen to retain pylsp for ongoing maintenance while also introducing Pyright. This PR includes a flag that allows users to switch between the two language servers, providing flexibility based on individual project needs.

yunyad

LGTM generally. I've left a few comments. However, please remove .gitignore and yarn.lock as they should not be submitted. Make only the necessary changes.

core/languageServer/startPyright.mjs

This reverts commit 515126b.

core/languageServer/startPyright.mjs

core/languageServer/yarn.lock

core/languageServer/startPyright.mjs

core/amber/src/main/scala/edu/uci/ics/amber/engine/common/AmberConfig.scala

yunyad

LGTM

Yicong-Huang

Thanks for the PR. The code needs some more change and please refer to the detailed comments.

For the PR description, please document the reason why we switch to pyright as the new default language server for python. The current reasoning "Its performance on detecting syntax and semantic error is better than pylsp" is too vague and maybe subjective. Please document the evaluations we did and references we found online to justify this. Make sure to use a neutral tone as this is an open source project, and comments are openly visible.

core/amber/src/main/scala/edu/uci/ics/amber/engine/common/AmberConfig.scala

core/amber/src/main/scala/edu/uci/ics/texera/web/TexeraWebApplication.scala

core/amber/src/main/resources/application.conf

core/amber/src/main/scala/edu/uci/ics/amber/engine/common/AmberConfig.scala

core/languageServer/package.json

core/amber/src/main/scala/edu/uci/ics/amber/engine/common/AmberConfig.scala

Yicong-Huang

LGTM. added some minor comments in code.

...scala/edu/uci/ics/texera/web/resource/pythonlanguageserver/PythonLanguageServerManager.scala

chenlica · 2024-09-03T04:51:25Z

We don't want to rely an external google doc for the comparison, as that URL may become obsolete. We could either include the comparison in this PR, or include it the corresponding blog. The former may be better.

chenlica

Please address my comments.

...scala/edu/uci/ics/texera/web/resource/pythonlanguageserver/PythonLanguageServerManager.scala

chenlica · 2024-09-03T05:02:57Z

We don't want to rely an external google doc for the comparison, as that URL may become obsolete. We could either include the comparison in this PR, or include it the corresponding blog. The former may be better.

We could generate a PDF for the comparison, and include the PDF in this PR, if that's allowed.

chenlica

LGTM.

… UDF action (#2811) This PR introduces a new AI-based feature called "Add Type Annotation" that enhances the user experience of the Python UDF on top of the Pyright language server. The following are related PR's: -PR for the "Add the pyright language server" : #2797. -PR for the "[1/3] Add AI Assistant Service - Ai Flag" : #2808 -PR for the "[3/3] Add AI Assistant Service - add the "Add All Type Annotation" Python UDF action" : #2812 **Key changes:** Added a Monaco action in the frontend Python UDF editor to allow users to automatically add type annotations for an argument each time they select a single argument in their code. **Add Type Annotation:** This action requires the user to select a single argument in their Python UDF code. A UI with a suggestion for the selected argument will pop up. The user can choose to accept or decline the suggestion from OpenAI. If they accept the suggestion, it will be added to their code; otherwise, the code will remain unchanged. The suggestion is provided by OpenAI. After the backend receives the response from OpenAI, it will be forwarded to the frontend via a RESTful API. Example: https://github.com/user-attachments/assets/29cee6c8-c793-4d83-8b27-db64bcc636ae --------- Co-authored-by: Yicong Huang <17627829+Yicong-Huang@users.noreply.github.com> Co-authored-by: Yicong Huang <yicong.huang@observeinc.com>

…thon UDF action (#2857) This PR introduces another AI feature call "Add All Type Annotation" that enhance the user experience of the Python UDF after integrating with the Pyright language server. You can refer to the related PR here: -PR for the "Add the pyright language server" : #2797. -PR for the "[1/3] Add AI Assistant Service - Ai Flag" : #2808 -PR for the "[2/3] Add AI Assistant Service - add the "Add Type Annotation" Python UDF action" : #2811 **Key change:** Added another Monaco action in the frontend Python UDF editor to allow users to automatically add all type annotations for the arguments within their selected code block. **Add All Type Annotation:** This action requires the user to select a code block in their Python UDF code. The action will automatically identify all arguments without type annotations and provide type annotation suggestions for each argument sequentially. The selected code block will be sent to the backend for Python Abstract Syntax Tree (AST) analysis to locate arguments without type annotations, and the result will be sent back to the frontend via a RESTful API. If the user selects a code block that has no arguments or where all the arguments already have type annotations, the code will remain unchanged. Example: https://github.com/user-attachments/assets/d70c1b02-b309-4359-a267-0a5eef831316

This PR adds a flag to specify a language server for Python UDF. By default we use the `pyright` language server, and can switch to to the original language server called `pylsp` (python language server). **Key change**: -Add a flag to switch between `pyright` and `pylsp` -Add the `pyright` language server **When the flag is set to use the `pyright`**: ![image](https://github.com/user-attachments/assets/5f6d377c-93ad-40af-bd21-d1306e0e39f6) **When the flag is set to use the `pylsp`**: ![image](https://github.com/user-attachments/assets/7fd42c30-3043-4ab4-86f3-b9bd64b10aee) **Reason to add `pyright`**: -Performance on the basic language server function: Both `Pyright` and `pylsp` show comparable performance in fundamental language server functionalities, such as hover, go-to definition, and autocompletion. Thus the basic user experience remains the same regardless of the chosen language server. -Pyright has a better ability to detect semantic errors: `Pyright` excels in identifying a broader range of syntax and semantic errors, particularly for code that includes type annotations. This strength makes it a valuable tool for developers who require more rigorous type checking and error detection in their Python code. **Evaluation between two language servers**: A detailed evaluation comparing the performance of two language servers on detecting basic semantic errors: ![a315e35df6d225468073252e9c0cc47](https://github.com/user-attachments/assets/67e71e37-42e1-4175-8f57-e36d60ca9db3) **Differences between two language servers**: For a more in-depth comparison of the differences between Pyright and pylsp, please refer to this discussion: python-lsp/python-lsp-server#90 **Summary**: While `Pyright` offers the potential for an improved user experience, especially in terms of finding semantic errors, `pylsp` is widely used and well-documented within its developer community. To balance the benefits of both tools, we have chosen to retain `pylsp` for ongoing maintenance while also introducing `Pyright`. This PR includes a flag that allows users to switch between the two language servers, providing flexibility based on individual project needs.

… UDF action (#2811) This PR introduces a new AI-based feature called "Add Type Annotation" that enhances the user experience of the Python UDF on top of the Pyright language server. The following are related PR's: -PR for the "Add the pyright language server" : #2797. -PR for the "[1/3] Add AI Assistant Service - Ai Flag" : #2808 -PR for the "[3/3] Add AI Assistant Service - add the "Add All Type Annotation" Python UDF action" : #2812 **Key changes:** Added a Monaco action in the frontend Python UDF editor to allow users to automatically add type annotations for an argument each time they select a single argument in their code. **Add Type Annotation:** This action requires the user to select a single argument in their Python UDF code. A UI with a suggestion for the selected argument will pop up. The user can choose to accept or decline the suggestion from OpenAI. If they accept the suggestion, it will be added to their code; otherwise, the code will remain unchanged. The suggestion is provided by OpenAI. After the backend receives the response from OpenAI, it will be forwarded to the frontend via a RESTful API. Example: https://github.com/user-attachments/assets/29cee6c8-c793-4d83-8b27-db64bcc636ae --------- Co-authored-by: Yicong Huang <17627829+Yicong-Huang@users.noreply.github.com> Co-authored-by: Yicong Huang <yicong.huang@observeinc.com>

…thon UDF action (#2857) This PR introduces another AI feature call "Add All Type Annotation" that enhance the user experience of the Python UDF after integrating with the Pyright language server. You can refer to the related PR here: -PR for the "Add the pyright language server" : #2797. -PR for the "[1/3] Add AI Assistant Service - Ai Flag" : #2808 -PR for the "[2/3] Add AI Assistant Service - add the "Add Type Annotation" Python UDF action" : #2811 **Key change:** Added another Monaco action in the frontend Python UDF editor to allow users to automatically add all type annotations for the arguments within their selected code block. **Add All Type Annotation:** This action requires the user to select a code block in their Python UDF code. The action will automatically identify all arguments without type annotations and provide type annotation suggestions for each argument sequentially. The selected code block will be sent to the backend for Python Abstract Syntax Tree (AST) analysis to locate arguments without type annotations, and the result will be sent back to the frontend via a RESTful API. If the user selects a code block that has no arguments or where all the arguments already have type annotations, the code will remain unchanged. Example: https://github.com/user-attachments/assets/d70c1b02-b309-4359-a267-0a5eef831316

IamtherealBrian added 2 commits August 20, 2024 15:43

npm validator

515126b

PR1 for pyright language server

9ad13c7

IamtherealBrian requested a review from bobbai00 August 21, 2024 01:31

IamtherealBrian added 3 commits August 20, 2024 18:42

sbt scalafmtAll

09b337b

add languageServer folder

9effbf7

sbt scalafmtAll

9f9b259

IamtherealBrian requested a review from yunyad August 22, 2024 07:08

IamtherealBrian self-assigned this Aug 22, 2024

yunyad requested changes Aug 22, 2024

View reviewed changes

core/languageServer/startPyright.mjs Outdated Show resolved Hide resolved

IamtherealBrian added 2 commits August 22, 2024 13:51

Revert "npm validator"

75bfad6

This reverts commit 515126b.

Remove core/gui/yarn.lock from commit

48c4d43

IamtherealBrian force-pushed the minchongWu-pr1 branch from 4325d51 to 48c4d43 Compare August 22, 2024 21:19

IamtherealBrian added 4 commits August 22, 2024 14:23

update

d4157d0

ignore

fd7c2eb

change variable name

acd8923

remove .gitignore

345b1b6

yunyad reviewed Aug 23, 2024

View reviewed changes

core/languageServer/startPyright.mjs Outdated Show resolved Hide resolved

yunyad reviewed Aug 23, 2024

View reviewed changes

core/languageServer/yarn.lock Outdated Show resolved Hide resolved

yunyad reviewed Aug 23, 2024

View reviewed changes

core/languageServer/startPyright.mjs Outdated Show resolved Hide resolved

IamtherealBrian added 3 commits August 23, 2024 13:54

resolve conversation

515d67d

delete .env

715a2a0

update logger

b1b2225

yunyad reviewed Aug 23, 2024

View reviewed changes

core/amber/src/main/scala/edu/uci/ics/amber/engine/common/AmberConfig.scala Outdated Show resolved Hide resolved

yunyad reviewed Aug 24, 2024

View reviewed changes

core/amber/src/main/scala/edu/uci/ics/amber/engine/common/AmberConfig.scala Outdated Show resolved Hide resolved

yunyad reviewed Aug 24, 2024

View reviewed changes

core/amber/src/main/scala/edu/uci/ics/amber/engine/common/AmberConfig.scala Outdated Show resolved Hide resolved

resolve conversation

63ebb2a

yunyad approved these changes Aug 24, 2024

View reviewed changes

IamtherealBrian requested a review from Yicong-Huang August 24, 2024 04:32

Yicong-Huang requested changes Aug 24, 2024

View reviewed changes

grammar issue

8f66b4f

IamtherealBrian added 6 commits August 26, 2024 19:55

fmt

d4e7607

name

293c99d

name

f6a5fbd

name

a41e0fb

name

6ec0e38

comment

7706e04

This was referenced Aug 28, 2024

Add AI-Assistant flag and features #2801

Closed

[2/3] Add AI Assistant Service - add the “Add Type Annotation" Python UDF action #2811

Merged

[3/3] Add AI Assistant Service - add the "Add All Type Annotation" Python UDF action #2812

Closed

IamtherealBrian added 2 commits September 2, 2024 17:03

retry logic

e306bd8

fmt

3e29b4f

Yicong-Huang approved these changes Sep 3, 2024

View reviewed changes

IamtherealBrian and others added 4 commits September 2, 2024 23:31

Merge branch 'master' into minchongWu-pr1

45547c4

retry logic

8bdd03d

retry logic

6967af1

fmt

405aa43

IamtherealBrian requested a review from chenlica September 3, 2024 04:46

chenlica reviewed Sep 3, 2024

View reviewed changes

...scala/edu/uci/ics/texera/web/resource/pythonlanguageserver/PythonLanguageServerManager.scala Outdated Show resolved Hide resolved

add config

524e207

chenlica approved these changes Sep 3, 2024

View reviewed changes

IamtherealBrian merged commit 2be8711 into master Sep 3, 2024

IamtherealBrian deleted the minchongWu-pr1 branch September 3, 2024 05:26

IamtherealBrian mentioned this pull request Sep 21, 2024

[3/3] Add AI Assistant Service - add the "Add All Type Annotation" Python UDF action #2857

Merged

Add the pyright language server #2797

Add the pyright language server #2797

Uh oh!

Conversation

IamtherealBrian commented Aug 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yunyad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yunyad left a comment

Choose a reason for hiding this comment

Uh oh!

Yicong-Huang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Yicong-Huang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chenlica commented Sep 3, 2024

Uh oh!

chenlica left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chenlica commented Sep 3, 2024

Uh oh!

chenlica left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

IamtherealBrian commented Aug 21, 2024 •

edited

Loading