Design and implement a local client API #2780
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a Client API Server for Pelican that exposes client functionality through a RESTful API over Unix domain sockets. This enables programmatic access to Pelican transfer capabilities without directly invoking the CLI.
Key Changes:
- Job-based transfer management with asynchronous execution and progress tracking
- RESTful API endpoints for transfer operations (get, put, copy, stat, list, delete)
- Unix domain socket communication for secure local IPC
- CLI integration with serve, stop, and status subcommands
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| cmd/client_api.go | CLI commands for managing the API server (serve, stop, status) |
| client_api/transfer_manager.go | Core transfer job management with concurrency control and progress tracking |
| client_api/server.go | HTTP server setup, Unix socket handling, and lifecycle management |
| client_api/handlers.go | REST API endpoint handlers for all operations |
| client_api/models.go | Request/response data structures and constants |
| client_api/middleware.go | Logging and recovery middleware |
| client_api/integration_test.go | End-to-end integration tests with test federation |
| client_api/handlers_test.go | Unit tests for API handlers |
| client_api/README.md | Comprehensive API documentation and usage examples |
| client_api/IMPLEMENTATION.md | Implementation summary and technical details |
| client_api/DESIGN-CLIENT-API-SERVER.md | Detailed design document for the feature |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Increase test file size to prevent it from completing before cancellation. - Decrease test name length to prevent generated unix socket from being on too-long path.
bbockelm
added
client
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At some level, this is also an experiment in providing significant standalone functionality through the use of agentic AI ... I was driving the code and overseeing the implementation but didn't write any of the generated code.
This PR provides a "local client server"; listening on a domain socket, the client-api server listens for incoming requests and performs them. Multiple clients can connect to the server and benefit from it executing work in the background.