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.

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

feat(frontend): Display runtime ID in the browser console if available #4978

Merged
merged 5 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions frontend/src/api/open-hands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,13 @@ class OpenHands {
static async getVSCodeUrl(): Promise<GetVSCodeUrlResponse> {
return request(`/api/vscode-url`, {}, false, false, 1);
}

static async getRuntimeId(): Promise<{ runtime_id: string }> {
const response = await request("/api/config");
const data = await response.json();

return data;
}
}

export default OpenHands;
25 changes: 23 additions & 2 deletions frontend/src/components/chat-interface.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,18 @@
import { Suggestions } from "./suggestions";
import { SUGGESTIONS } from "#/utils/suggestions";
import BuildIt from "#/icons/build-it.svg?react";
import { useWsClient } from "#/context/ws-client-provider";
import {
useWsClient,
WsClientProviderStatus,
} from "#/context/ws-client-provider";
import OpenHands from "#/api/open-hands";

const isErrorMessage = (
message: Message | ErrorMessage,
): message is ErrorMessage => "error" in message;

export function ChatInterface() {
const { send, isLoadingMessages } = useWsClient();
const { send, status, isLoadingMessages } = useWsClient();

const dispatch = useDispatch();
const scrollRef = React.useRef<HTMLDivElement>(null);
Expand All @@ -44,6 +48,23 @@
const [feedbackModalIsOpen, setFeedbackModalIsOpen] = React.useState(false);
const [messageToSend, setMessageToSend] = React.useState<string | null>(null);

React.useEffect(() => {
if (status === WsClientProviderStatus.ACTIVE) {
try {
OpenHands.getRuntimeId().then(({ runtime_id }) => {
// eslint-disable-next-line no-console
console.log(
"Runtime ID: %c%s",
"background: #444; color: #ffeb3b; font-weight: bold; padding: 2px 4px; border-radius: 4px;",
runtime_id,
);
});
} catch (e) {
console.warn("Runtime ID not available in this environment");

Check warning on line 63 in frontend/src/components/chat-interface.tsx

View workflow job for this annotation

GitHub Actions / Lint frontend

Unexpected console statement
}
}
}, [status]);

const handleSendMessage = async (content: string, files: File[]) => {
posthog.capture("user_message_sent", {
current_message_count: messages.length,
Expand Down
24 changes: 24 additions & 0 deletions openhands/server/listen.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
from pathspec import PathSpec
from pathspec.patterns import GitWildMatchPattern

from openhands.runtime.impl.remote.remote_runtime import RemoteRuntime
from openhands.security.options import SecurityAnalyzers
from openhands.server.data_models.feedback import FeedbackDataModel, store_feedback
from openhands.server.github import (
Expand Down Expand Up @@ -564,6 +565,29 @@ def sanitize_filename(filename):
return filename


@app.get('/api/config')
async def get_remote_runtime_config(request: Request):
"""Retrieve the remote runtime configuration.

Currently, this is the runtime ID.
"""
try:
runtime = request.state.conversation.runtime
if isinstance(runtime, RemoteRuntime):
return JSONResponse(content={'runtime_id': runtime.runtime_id})
else:
return JSONResponse(
status_code=status.HTTP_404_NOT_FOUND,
content={'error': 'Runtime ID not available in this environment'},
)
except Exception as e:
logger.error(e)
return JSONResponse(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
content={'error': 'Something went wrong'},
)


@app.post('/api/upload-files')
async def upload_file(request: Request, files: list[UploadFile]):
"""Upload a list of files to the workspace.
Expand Down
Loading