Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extract code into separate rpc client #1433

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Extract code into separate rpc client #1433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cef7483
Factored code from command client into rpc client
AndreasArvidsson May 10, 2024
369e935
Merge branch 'main' into rpc_client
nriley May 11, 2024
4ac7981
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
226 changes: 16 additions & 210 deletions apps/vscode/command_client/command_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,9 @@
import json
import os
import time
from dataclasses import dataclass
from pathlib import Path
from tempfile import gettempdir
from typing import Any
from uuid import uuid4

from talon import Context, Module, actions, speech_system

# How old a request file needs to be before we declare it stale and are willing
# to remove it
STALE_TIMEOUT_MS = 60_000

# The amount of time to wait for application to perform a command, in seconds
RPC_COMMAND_TIMEOUT_SECONDS = 3.0

# When doing exponential back off waiting for application to perform a command, how
# long to sleep the first time
MINIMUM_SLEEP_TIME_SECONDS = 0.0005
from .rpc_client import get_communication_dir_path, run_rpc_command

# Indicates whether a pre-phrase signal was emitted during the course of the
# current phrase
Expand Down Expand Up @@ -46,73 +31,6 @@ class NoFileServerException(Exception):
pass


def write_json_exclusive(path: Path, body: Any):
"""Writes jsonified object to file, failing if the file already exists

Args:
path (Path): The path of the file to write
body (Any): The object to convert to json and write
"""
with path.open("x") as out_file:
out_file.write(json.dumps(body))


@dataclass
class Request:
command_id: str
args: list[Any]
wait_for_finish: bool
return_command_output: bool
uuid: str

def to_dict(self):
return {
"commandId": self.command_id,
"args": self.args,
"waitForFinish": self.wait_for_finish,
"returnCommandOutput": self.return_command_output,
"uuid": self.uuid,
}


def write_request(request: Request, path: Path):
"""Converts the given request to json and writes it to the file, failing if
the file already exists unless it is stale in which case it replaces it

Args:
request (Request): The request to serialize
path (Path): The path to write to

Raises:
Exception: If another process has an active request file
"""
try:
write_json_exclusive(path, request.to_dict())
request_file_exists = False
except FileExistsError:
request_file_exists = True

if request_file_exists:
handle_existing_request_file(path)
write_json_exclusive(path, request.to_dict())


def handle_existing_request_file(path):
stats = path.stat()

modified_time_ms = stats.st_mtime_ns / 1e6
current_time_ms = time.time() * 1e3
time_difference_ms = abs(modified_time_ms - current_time_ms)

if time_difference_ms < STALE_TIMEOUT_MS:
raise Exception(
"Found recent request file; another Talon process is probably running"
)

print("Removing stale request file")
robust_unlink(path)


def run_command(
command_id: str,
*args,
Expand All @@ -138,142 +56,29 @@ def run_command(
# variable argument lists
args = [x for x in args if x is not NotSet]

communication_dir_path = get_communication_dir_path()
dir_name = actions.user.command_server_directory()
communication_dir_path = get_communication_dir_path(dir_name)

if not communication_dir_path.exists():
if args or return_command_output:
raise Exception("Must use command-server extension for advanced commands")
raise NoFileServerException("Communication directory not found")

request_path = communication_dir_path / "request.json"
response_path = communication_dir_path / "response.json"
trigger_execution = lambda: actions.user.trigger_command_server_command_execution()

# Generate uuid that will be mirrored back to us by command server for
# sanity checking
uuid = str(uuid4())
payload = {
"command_id": command_id,
"args": args,
}

request = Request(
command_id=command_id,
args=args,
wait_for_finish=wait_for_finish,
return_command_output=return_command_output,
uuid=uuid,
return run_rpc_command(
communication_dir_path,
trigger_execution,
wait_for_finish,
return_command_output,
payload,
)

# First, write the request to the request file, which makes us the sole
# owner because all other processes will try to open it with 'x'
write_request(request, request_path)

# We clear the response file if it does exist, though it shouldn't
if response_path.exists():
print("WARNING: Found old response file")
robust_unlink(response_path)

# Then, perform keystroke telling application to execute the command in the
# request file. Because only the active application instance will accept
# keypresses, we can be sure that the active application instance will be the
# one to execute the command.
actions.user.trigger_command_server_command_execution()

try:
decoded_contents = read_json_with_timeout(response_path)
finally:
# NB: We remove response file first because we want to do this while we
# still own the request file
robust_unlink(response_path)
robust_unlink(request_path)

if decoded_contents["uuid"] != uuid:
raise Exception("uuids did not match")

for warning in decoded_contents["warnings"]:
print(f"WARNING: {warning}")

if decoded_contents["error"] is not None:
raise Exception(decoded_contents["error"])

actions.sleep("25ms")

return decoded_contents["returnValue"]


def get_communication_dir_path():
"""Returns directory that is used by command-server for communication

Returns:
Path: The path to the communication dir
"""
suffix = ""

# NB: We don't suffix on Windows, because the temp dir is user-specific
# anyways
if hasattr(os, "getuid"):
suffix = f"-{os.getuid()}"

return Path(gettempdir()) / f"{actions.user.command_server_directory()}{suffix}"


def robust_unlink(path: Path):
"""Unlink the given file if it exists, and if we're on windows and it is
currently in use, just rename it

Args:
path (Path): The path to unlink
"""
try:
path.unlink(missing_ok=True)
except OSError as e:
if hasattr(e, "winerror") and e.winerror == 32:
graveyard_dir = get_communication_dir_path() / "graveyard"
graveyard_dir.mkdir(parents=True, exist_ok=True)
graveyard_path = graveyard_dir / str(uuid4())
print(
f"WARNING: File {path} was in use when we tried to delete it; "
f"moving to graveyard at path {graveyard_path}"
)
path.rename(graveyard_path)
else:
raise e


def read_json_with_timeout(path: Path) -> Any:
"""Repeatedly tries to read a json object from the given path, waiting
until there is a trailing new line indicating that the write is complete

Args:
path (str): The path to read from

Raises:
Exception: If we timeout waiting for a response

Returns:
Any: The json-decoded contents of the file
"""
timeout_time = time.perf_counter() + RPC_COMMAND_TIMEOUT_SECONDS
sleep_time = MINIMUM_SLEEP_TIME_SECONDS
while True:
try:
raw_text = path.read_text()

if raw_text.endswith("\n"):
break
except FileNotFoundError:
# If not found, keep waiting
pass

actions.sleep(sleep_time)

time_left = timeout_time - time.perf_counter()

if time_left < 0:
raise Exception("Timed out waiting for response")

# NB: We use minimum sleep time here to ensure that we don't spin with
# small sleeps due to clock slip
sleep_time = max(min(sleep_time * 2, time_left), MINIMUM_SLEEP_TIME_SECONDS)

return json.loads(raw_text)


@mod.action_class
class Actions:
Expand Down Expand Up @@ -382,7 +187,8 @@ def get_signal_path(name: str) -> Path:
Returns:
Path: The signal path
"""
communication_dir_path = get_communication_dir_path()
dir_name = actions.user.command_server_directory()
communication_dir_path = get_communication_dir_path(dir_name)

if not communication_dir_path.exists():
raise MissingCommunicationDir()
Expand Down
Loading