Design executable notebook service APIs

Q: Design executable notebook service APIs

This is a System Design interview question from Google for Software Engineer roles. View the full question and solution on PracHub.

Q: How do I approach System Design interview questions?

System Design questions require understanding of core concepts and practice. PracHub provides solutions with explanations to help you master system design interviews.

Question

Design: Collaborative Notebook with Executable User Functions (JAR Upload)

Context

Design a collaborative, browser-based code notebook service. The system must support real-time editing, execution of user-submitted functions, and a proxy that fetches execution results/logs and returns them to the browser.

Users can upload custom Java JARs, specify a fully-qualified class and method as the entrypoint, and submit executions with arguments. The system must be secure, scalable, and support streaming logs/results.

Requirements

Define RESTful endpoints and request/response schemas for:
1. Uploading user code (JARs) and registering entrypoints
2. Submitting executions (sync/async, with args)
3. Fetching logs and results (polling and streaming)
4. Cancelling executions
Discuss:
- Sandboxing and isolation for untrusted code
- Dependency management for user JARs (Maven coordinates, shading, etc.)
- Resource limits and quotas
- Concurrency model and scheduling
- Streaming logs/results to the browser via a proxy

Make minimal assumptions where the prompt is ambiguous (e.g., use Java 17, JSON over HTTP, and an API Gateway/Proxy).

Design executable notebook service APIs

Design: Collaborative Notebook with Executable User Functions (JAR Upload)

Context

Requirements

Solution (Locked)

Comments (0)