Jedi Autocomplete #3114

JamesXNelson · 2022-11-28T15:58:28Z

No description provided.

docker/server-jetty/src/main/docker/Dockerfile

JamesXNelson · 2022-11-28T15:59:15Z

docker/server-jetty/build.gradle

@@ -10,6 +10,7 @@ def targetArch = Architecture.targetArchitecture(project)

 def baseMapAmd64 = [
        'server-base': 'server-jetty',
+        'all-ai-base': 'server-all-ai-jetty',


this is what I've been doing for community deployments. Does not really belong in this branch.

I'm going to leave it in unless someone complains. Just makes doing deployments that build deephaven-core easier / possible.

docker/server/src/main/docker/Dockerfile

py/server/deephaven/completer/__init__.py

jmao-denver · 2022-11-29T16:16:19Z

py/server/deephaven/completer/__init__.py

+class Completer(object):
+


This seems to be a 'private' class for creating a singleton, if so, change it to _Completer ?

Java actually holds onto this object and calls into its methods, but the consumer would probably only care about jedi_settings and not Completer. Will rename it.

Still need direction on this.

Also, should I move it to its own file, or leave things in __init__.py. Most others, init seems very sparse, if you'd rather structure it differently, please lmk

If we don't think there will likely be more modules in the completer sub-package, I would just have _completer.py and keep the class name as it is.

jmao-denver · 2022-11-29T16:17:56Z

py/server/deephaven/completer/__init__.py

+jedi_settings = Completer()
+
+if jedi_settings.mode == CompleterMode.off:
+    print('No jedi library installed on system path, disabling autocomplete')


Is this safe? Does it go into the server log?

I should probably just move the logging out of python and into the calling code's logger

It goes to the console log in the gui

Moving the logging info into the calling code makes sense. The current code looks a little odd as it only logs in one case.

done. I just deleted it since there was a similar method already printing effectively the same message to java logs.

py/server/deephaven/completer/__init__.py

niloc132 · 2022-11-29T17:00:16Z

server/src/main/java/io/deephaven/server/console/completer/PythonAutoCompleteObserver.java

+                String totalNano = Long.toString(System.nanoTime() - startNano);
+                // lets track how long completions take, as it's known that some
+                // modules like numpy can cause slow completion, and we'll want to know what was causing them
+                log.info().append("Jedi completions took ")


debug probably, or guarded with a flag or a "this was shorter than 100ms, so we don't want to bother logging an INFO for it"

also, logging should be pulled out of here, since we probably a) don't want to count IO in the jedi time, and b) don't want to fail to log time if IO blew up

cleaned up the logging and set it to TRACE.

Also, if I'm only logging > 100ms, I can probably make stronger guesses about string length and simplify the toString ugliness too...
Also, where should I move logging to make it not-count?
Also, who is counting / cares about how long this method takes?

I did the logging part after the work part completed, so if there is a better location / way to do this, you'll have to point me at it explicitly.

server/src/main/java/io/deephaven/server/console/completer/PythonAutoCompleteObserver.java

niloc132 · 2022-11-29T17:18:38Z

server/src/main/java/io/deephaven/server/console/completer/PythonAutoCompleteObserver.java

+                List<CompletionItem.Builder> completionResults_ = new ArrayList<>();
+                List<CompletionItem.Builder> completionResults__ = new ArrayList<>();
+                for (PyObject completion : completes) {
+                    String completionName = completion.getAttribute("name").getStringValue();


future cleanup, i don't see an easy/obvious way to address this right away: with so many calls into and out of python, we're going to be taking and releasing the GIL a lot, plus N JNI calls per completion item (and i dont see anything obvious that limits the results passed back to java) though i'm more worried about the GIL.

Instead, it would be nice if we could translate each item into a dict while in python, then hijack the copyPythonDictToJavaMap or the like to translate the data to java before giving up the GIL to begin with.

Note that high GIL contention is also going to throw off the perf numbers collected below - seems likely we should measure just the .complete() call above, and possibly separately measure the marshalling, IO. I think that's the only action item I'd have about this...

Another option for GIL management is to use the new PyLib.ensureGil(() -> {...}); wrapped around all of the code that actually reads and builds results.

I actually got about 85% of the way to moving it all into python. I'll just finish that and delete this mess. I knew crossing the gil like that was terrible, I just did it as proof of concept. The whole point of the python module in this PR is to move the result processing into python, and just send back a glob (arrays of arrays) of strings and ints for java to process all at once.

I'll wrap that up since it's close and this, as-is, is terrible.

This was completed, you can see the brains in completer/__init__.py

Also tells docker it's not allowed to download jedi from pypi, as it is now included in base images.

niloc132 · 2022-12-01T20:06:30Z

server/src/main/java/io/deephaven/server/console/completer/PythonAutoCompleteObserver.java

+                log.trace().append("Ignoring completion request because jedi is disabled").endl();
+                // send back an empty response. We may want to include a "don't ask again" flag in the response...
+                safelyExecuteLocked(responseObserver,
+                        () -> responseObserver.onNext(AutoCompleteResponse.newBuilder().build()));


need to have the completed items response in here, with success=false, and requestId for the client to match the failure to

niloc132 · 2022-12-01T20:10:37Z

server/src/main/java/io/deephaven/server/console/completer/PythonAutoCompleteObserver.java

+                // in the future we may want to get more interesting info from jedi to pass back to client
+                final List<PyObject> items = result.asList();
+                String completionName = items.get(0).getStringValue();
+                int start = items.get(1).getIntValue();


Hmm. I think we're still paying for each GIL trip, to do the getStringValue, getIntValue calls. Plus, each List.get call is a python __getitem__ invoke.

I still think we can punt on this, but will want to revisit

strange that it wouldn't just say "sending a list of primitives, lets do this all at once".

Maybe if I sent two lists, one of string, one of int, I could convince jpy to give me String[], int[] in two shots...
But, yes... for another day. I'll open some issues to track next steps.

I've confirmed the timing is as you suspect, and will open a ticket w/ an idea how to improve it.

devinrsmith

py/server/setup.py needs to be updated with the appropriate jedi dependency.

I'm not seeing method completion like I would expect to see. Not sure if I'm doing something wrong.

devinrsmith · 2022-12-02T00:54:23Z

server/src/main/java/io/deephaven/server/console/ConsoleServiceGrpcImpl.java

+                    scriptSession.evaluateScript("from deephaven.completer import jedi_settings");
+                    settings[0] = (PyObject) scriptSession.getVariable("jedi_settings");


IMO, we shouldn't be modifying the users' scope. By importing via script here we are modifying it. We can import with org.jpy.PyModule#importModule, and get access specific to us.

As we discussed offline, your patch which handles this is ideal, but don't wanna pull in too much when we're this close to the finish line.

devinrsmith · 2022-12-02T00:56:16Z

server/src/main/java/io/deephaven/server/console/completer/PythonAutoCompleteObserver.java

+                ChangeDocumentRequest request = value.getChangeDocument();
+                final VersionedTextDocumentIdentifier text = request.getTextDocument();
+
+                PyObject completer = (PyObject) scriptSession.get().getVariable("jedi_settings");


Assuming this is set on the script session is fragile. del jedi_settings breaks auto complete.

We should be able to pass in a PyObject as part of the constructor, I would think, so PythonAutoCompleteObserver can own it.

May be worthwhile to get a proxy around it so you don't need to do .callMethod(...) (org.jpy.PyObject#createProxy(java.lang.Class<T>).

The canonical location is deephaven.completer.jedi_settings, but how I'm accessing it from the scope here IS dangerous / bad. Your work to wrap it in a proxy object looks way better.

devinrsmith · 2022-12-02T17:28:43Z

I've got some suggestions from JamesXNelson#9

chipkent · 2022-12-02T19:41:53Z

py/server/deephaven/completer/__init__.py

+from deephaven.completer._completer import Completer
+from jedi import preload_module, Interpreter
+
+jedi_settings = Completer()


Needs sphinx doc string.

chipkent · 2022-12-02T19:42:53Z

py/server/deephaven/completer/__init__.py

@@ -0,0 +1,25 @@
+#


If this needs to be public, I would prefer it is called autocomplete, since that is more clear to the user looking at the package.

chipkent · 2022-12-02T19:43:48Z

py/server/deephaven/completer/_completer.py

+    off = 'off'
+    safe = 'safe'
+    strong = 'strong'


I assume these should be caps, since they are enum values.

chipkent · 2022-12-02T19:45:08Z

py/server/deephaven/completer/_completer.py

+from jedi import Interpreter, Script
+
+
+class CompleterMode(Enum):


Everything here needs appropriate docs.

devinrsmith

Couple of follow ups we can handle in another PR:

config to disable auto-complete
move code to deephaven_internal
add autocomplete dependency for deephaven-server

chipkent

Fix my comments in future commits

deephaven-internal · 2022-12-02T20:22:13Z

Labels indicate documentation is required. Issues for documentation have been opened:

How-to: https://github.com/deephaven/deephaven.io/issues/1930
Conceptual: https://github.com/deephaven/deephaven.io/issues/1932
Reference: https://github.com/deephaven/deephaven.io/issues/1933
Blog: https://github.com/deephaven/deephaven.io/issues/1931

JamesXNelson requested review from devinrsmith, jcferretti and rcaudy as code owners November 28, 2022 15:58

JamesXNelson commented Nov 28, 2022

View reviewed changes

jmao-denver requested changes Nov 29, 2022

View reviewed changes

rcaudy requested a review from niloc132 November 29, 2022 17:07

niloc132 reviewed Nov 29, 2022

View reviewed changes

devinrsmith and others added 8 commits November 30, 2022 13:21

Bump base images to pick up jedi dependency

d1a4b61

Add jetty all-ai image for demo

cb6c66d

WIP: let our jetty build download dependencies

ae37b62

hack in installation of jedi

3587dfe

Hack in testable version of jedi

7e4fa95

Wire jedi into python autocomplete "proper"ly

888e8ff

Analyze jedi results in python instead of java

2a335a6

Merge remote-tracking branch 'devin/bump-images-for-jedi' into jxn/jedi

e0249c3

JamesXNelson force-pushed the jxn/jedi branch from 17004ad to e0249c3 Compare December 1, 2022 19:22

JamesXNelson added 4 commits December 1, 2022 13:54

Use web version w/ document version in completion requests

f6a6ead

Also tells docker it's not allowed to download jedi from pypi, as it is now included in base images.

Minor logging cleanup

38c4e26

Update jetty-all-ai requirements.txt

fdfaedc

Use official web docker images

96a57a5

JamesXNelson requested review from niloc132 and jmao-denver December 1, 2022 20:12

niloc132 reviewed Dec 1, 2022

View reviewed changes

JamesXNelson added 5 commits December 1, 2022 17:13

code review comments

5ba99bb

Cleanup logging and warm jedi up a little

a512424

Merge remote-tracking branch 'dh/main' into jxn/jedi

64c75ae

Ditch whitespace change

c30e795

spotless fixups

f9abec8

JamesXNelson added DocumentationNeeded ReleaseNotesNeeded Release notes are needed labels Dec 2, 2022

devinrsmith requested changes Dec 2, 2022

View reviewed changes

JamesXNelson added 5 commits December 2, 2022 12:22

save a copy of globals() while we have it in scope

97b4b0c

woops, fix typo

1a24e89

add optional dependency on jedi from deephaven server

ed99c5d

spotless fixups

733d8be

fix failing test

0ad8d98

devinrsmith self-requested a review December 2, 2022 19:40

chipkent requested changes Dec 2, 2022

View reviewed changes

devinrsmith approved these changes Dec 2, 2022

View reviewed changes

chipkent approved these changes Dec 2, 2022

View reviewed changes

jmao-denver approved these changes Dec 2, 2022

View reviewed changes

devinrsmith merged commit 0bb8eac into deephaven:main Dec 2, 2022

github-actions bot locked and limited conversation to collaborators Dec 2, 2022

		scriptSession.evaluateScript("from deephaven.completer import jedi_settings");
		settings[0] = (PyObject) scriptSession.getVariable("jedi_settings");

		from jedi import Interpreter, Script


		class CompleterMode(Enum):

Jedi Autocomplete #3114

Jedi Autocomplete #3114

Conversation

JamesXNelson commented Nov 28, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devinrsmith left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devinrsmith commented Dec 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devinrsmith left a comment

Choose a reason for hiding this comment

chipkent left a comment

Choose a reason for hiding this comment

deephaven-internal commented Dec 2, 2022