Skip to content

Commit 5c07315

Browse files
Copilotbrunoborges
Copilot
and
brunoborges
committed
Port upstream changes: clientName, deny-by-default permissions, PermissionHandler.APPROVE_ALL
Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>
1 parent b1d11d2 commit 5c07315

11 files changed

Lines changed: 230 additions & 25 deletions

‎CHANGELOG.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
88
99
## [Unreleased]
1010

11-
> **Upstream sync:** [`github/copilot-sdk@e40d57c`](https://github.com/github/copilot-sdk/commit/e40d57c86e18b495722adbf42045288c03924342)
11+
> **Upstream sync:** [`github/copilot-sdk@c263dfc`](https://github.com/github/copilot-sdk/commit/c263dfc69055f9f28ee2d4b121cf617fca5a42dc)
12+
13+
### Added
14+
15+
- `SessionConfig.setClientName(String)` / `getClientName()` — identifies the application using the SDK; included in the User-Agent header for API requests (upstream: [`397ef66`](https://github.com/github/copilot-sdk/commit/397ef66))
16+
- `ResumeSessionConfig.setClientName(String)` / `getClientName()` — same for resumed sessions
17+
- `PermissionHandler.APPROVE_ALL` — pre-built handler that approves all permission requests (upstream: [`3e2d2b2`](https://github.com/github/copilot-sdk/commit/3e2d2b2))
18+
19+
### Changed
20+
21+
- **Breaking:** permissions are now denied by default when no `OnPermissionRequest` handler is provided. The `requestPermission` flag is always sent as `true` so the server calls back for every permission request; the SDK returns a deny result when no handler is registered (upstream: [`3e2d2b2`](https://github.com/github/copilot-sdk/commit/3e2d2b2))
1222

1323
## [1.0.9] - 2026-02-16
1424

‎src/main/java/com/github/copilot/sdk/SessionRequestBuilder.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,14 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config) {
3737

3838
request.setModel(config.getModel());
3939
request.setSessionId(config.getSessionId());
40+
request.setClientName(config.getClientName());
4041
request.setReasoningEffort(config.getReasoningEffort());
4142
request.setTools(config.getTools());
4243
request.setSystemMessage(config.getSystemMessage());
4344
request.setAvailableTools(config.getAvailableTools());
4445
request.setExcludedTools(config.getExcludedTools());
4546
request.setProvider(config.getProvider());
46-
request.setRequestPermission(config.getOnPermissionRequest() != null ? true : null);
47+
request.setRequestPermission(true);
4748
request.setRequestUserInput(config.getOnUserInputRequest() != null ? true : null);
4849
request.setHooks(config.getHooks() != null && config.getHooks().hasHooks() ? true : null);
4950
request.setWorkingDirectory(config.getWorkingDirectory());
@@ -77,13 +78,14 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo
7778
}
7879

7980
request.setModel(config.getModel());
81+
request.setClientName(config.getClientName());
8082
request.setReasoningEffort(config.getReasoningEffort());
8183
request.setTools(config.getTools());
8284
request.setSystemMessage(config.getSystemMessage());
8385
request.setAvailableTools(config.getAvailableTools());
8486
request.setExcludedTools(config.getExcludedTools());
8587
request.setProvider(config.getProvider());
86-
request.setRequestPermission(config.getOnPermissionRequest() != null ? true : null);
88+
request.setRequestPermission(true);
8789
request.setRequestUserInput(config.getOnUserInputRequest() != null ? true : null);
8890
request.setHooks(config.getHooks() != null && config.getHooks().hasHooks() ? true : null);
8991
request.setWorkingDirectory(config.getWorkingDirectory());

‎src/main/java/com/github/copilot/sdk/json/CreateSessionRequest.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ public final class CreateSessionRequest {
3131
@JsonProperty("sessionId")
3232
private String sessionId;
3333

34+
@JsonProperty("clientName")
35+
private String clientName;
36+
3437
@JsonProperty("reasoningEffort")
3538
private String reasoningEffort;
3639

@@ -105,6 +108,16 @@ public void setSessionId(String sessionId) {
105108
this.sessionId = sessionId;
106109
}
107110

111+
/** Gets the client name. @return the client name */
112+
public String getClientName() {
113+
return clientName;
114+
}
115+
116+
/** Sets the client name. @param clientName the client name */
117+
public void setClientName(String clientName) {
118+
this.clientName = clientName;
119+
}
120+
108121
/** Gets the reasoning effort. @return the reasoning effort level */
109122
public String getReasoningEffort() {
110123
return reasoningEffort;

‎src/main/java/com/github/copilot/sdk/json/PermissionHandler.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@
2828
* };
2929
* }</pre>
3030
*
31+
* <p>
32+
* A pre-built handler that approves all requests is available as
33+
* {@link #APPROVE_ALL}.
34+
*
3135
* @see SessionConfig#setOnPermissionRequest(PermissionHandler)
3236
* @see PermissionRequest
3337
* @see PermissionRequestResult
@@ -36,6 +40,14 @@
3640
@FunctionalInterface
3741
public interface PermissionHandler {
3842

43+
/**
44+
* A pre-built handler that approves all permission requests.
45+
*
46+
* @since 1.0.11
47+
*/
48+
PermissionHandler APPROVE_ALL = (request, invocation) -> CompletableFuture
49+
.completedFuture(new PermissionRequestResult().setKind("approved"));
50+
3951
/**
4052
* Handles a permission request from the assistant.
4153
* <p>

‎src/main/java/com/github/copilot/sdk/json/ResumeSessionConfig.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
@JsonInclude(JsonInclude.Include.NON_NULL)
3434
public class ResumeSessionConfig {
3535

36+
private String clientName;
3637
private String model;
3738
private List<ToolDefinition> tools;
3839
private SystemMessageConfig systemMessage;
@@ -76,6 +77,29 @@ public ResumeSessionConfig setModel(String model) {
7677
return this;
7778
}
7879

80+
/**
81+
* Gets the client name used to identify the application using the SDK.
82+
*
83+
* @return the client name, or {@code null} if not set
84+
*/
85+
public String getClientName() {
86+
return clientName;
87+
}
88+
89+
/**
90+
* Sets the client name to identify the application using the SDK.
91+
* <p>
92+
* This value is included in the User-Agent header for API requests.
93+
*
94+
* @param clientName
95+
* the client name
96+
* @return this config for method chaining
97+
*/
98+
public ResumeSessionConfig setClientName(String clientName) {
99+
this.clientName = clientName;
100+
return this;
101+
}
102+
79103
/**
80104
* Gets the custom tools for this session.
81105
*
@@ -491,6 +515,7 @@ public ResumeSessionConfig setInfiniteSessions(InfiniteSessionConfig infiniteSes
491515
@Override
492516
public ResumeSessionConfig clone() {
493517
ResumeSessionConfig copy = new ResumeSessionConfig();
518+
copy.clientName = this.clientName;
494519
copy.model = this.model;
495520
copy.tools = this.tools != null ? new ArrayList<>(this.tools) : null;
496521
copy.systemMessage = this.systemMessage;

‎src/main/java/com/github/copilot/sdk/json/ResumeSessionRequest.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ public final class ResumeSessionRequest {
2929
@JsonProperty("sessionId")
3030
private String sessionId;
3131

32+
@JsonProperty("clientName")
33+
private String clientName;
34+
3235
@JsonProperty("model")
3336
private String model;
3437

@@ -99,6 +102,16 @@ public void setSessionId(String sessionId) {
99102
this.sessionId = sessionId;
100103
}
101104

105+
/** Gets the client name. @return the client name */
106+
public String getClientName() {
107+
return clientName;
108+
}
109+
110+
/** Sets the client name. @param clientName the client name */
111+
public void setClientName(String clientName) {
112+
this.clientName = clientName;
113+
}
114+
102115
/** Gets the model name. @return the model */
103116
public String getModel() {
104117
return model;

‎src/main/java/com/github/copilot/sdk/json/SessionConfig.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
public class SessionConfig {
3535

3636
private String sessionId;
37+
private String clientName;
3738
private String model;
3839
private String reasoningEffort;
3940
private List<ToolDefinition> tools;
@@ -76,6 +77,29 @@ public SessionConfig setSessionId(String sessionId) {
7677
return this;
7778
}
7879

80+
/**
81+
* Gets the client name used to identify the application using the SDK.
82+
*
83+
* @return the client name, or {@code null} if not set
84+
*/
85+
public String getClientName() {
86+
return clientName;
87+
}
88+
89+
/**
90+
* Sets the client name to identify the application using the SDK.
91+
* <p>
92+
* This value is included in the User-Agent header for API requests.
93+
*
94+
* @param clientName
95+
* the client name
96+
* @return this config instance for method chaining
97+
*/
98+
public SessionConfig setClientName(String clientName) {
99+
this.clientName = clientName;
100+
return this;
101+
}
102+
79103
/**
80104
* Gets the AI model to use.
81105
*
@@ -529,6 +553,7 @@ public SessionConfig setConfigDir(String configDir) {
529553
public SessionConfig clone() {
530554
SessionConfig copy = new SessionConfig();
531555
copy.sessionId = this.sessionId;
556+
copy.clientName = this.clientName;
532557
copy.model = this.model;
533558
copy.reasoningEffort = this.reasoningEffort;
534559
copy.tools = this.tools != null ? new ArrayList<>(this.tools) : null;

‎src/test/java/com/github/copilot/sdk/ConfigCloneTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@ void copilotClientOptionsEnvironmentIndependence() {
6868
void sessionConfigCloneBasic() {
6969
SessionConfig original = new SessionConfig();
7070
original.setSessionId("my-session");
71+
original.setClientName("my-app");
7172
original.setModel("gpt-4o");
7273
original.setStreaming(true);
7374

7475
SessionConfig cloned = original.clone();
7576

7677
assertEquals(original.getSessionId(), cloned.getSessionId());
78+
assertEquals(original.getClientName(), cloned.getClientName());
7779
assertEquals(original.getModel(), cloned.getModel());
7880
assertEquals(original.isStreaming(), cloned.isStreaming());
7981
}

‎src/test/java/com/github/copilot/sdk/HooksTest.java‎

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import org.junit.jupiter.api.Test;
2020

2121
import com.github.copilot.sdk.json.MessageOptions;
22+
import com.github.copilot.sdk.json.PermissionHandler;
2223
import com.github.copilot.sdk.json.PostToolUseHookInput;
2324
import com.github.copilot.sdk.json.PreToolUseHookInput;
2425
import com.github.copilot.sdk.json.PreToolUseHookOutput;
@@ -67,11 +68,12 @@ void testInvokePreToolUseHookWhenModelRunsATool() throws Exception {
6768
var preToolUseInputs = new ArrayList<PreToolUseHookInput>();
6869
final String[] sessionIdHolder = new String[1];
6970

70-
var config = new SessionConfig().setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> {
71-
preToolUseInputs.add(input);
72-
assertEquals(sessionIdHolder[0], invocation.getSessionId());
73-
return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());
74-
}));
71+
var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
72+
.setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> {
73+
preToolUseInputs.add(input);
74+
assertEquals(sessionIdHolder[0], invocation.getSessionId());
75+
return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());
76+
}));
7577

7678
try (CopilotClient client = ctx.createClient()) {
7779
CopilotSession session = client.createSession(config).get();
@@ -106,11 +108,12 @@ void testInvokePostToolUseHookAfterModelRunsATool() throws Exception {
106108
var postToolUseInputs = new ArrayList<PostToolUseHookInput>();
107109
final String[] sessionIdHolder = new String[1];
108110

109-
var config = new SessionConfig().setHooks(new SessionHooks().setOnPostToolUse((input, invocation) -> {
110-
postToolUseInputs.add(input);
111-
assertEquals(sessionIdHolder[0], invocation.getSessionId());
112-
return CompletableFuture.completedFuture(null);
113-
}));
111+
var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
112+
.setHooks(new SessionHooks().setOnPostToolUse((input, invocation) -> {
113+
postToolUseInputs.add(input);
114+
assertEquals(sessionIdHolder[0], invocation.getSessionId());
115+
return CompletableFuture.completedFuture(null);
116+
}));
114117

115118
try (CopilotClient client = ctx.createClient()) {
116119
CopilotSession session = client.createSession(config).get();
@@ -147,13 +150,14 @@ void testInvokeBothHooksForSingleToolCall() throws Exception {
147150
var preToolUseInputs = new ArrayList<PreToolUseHookInput>();
148151
var postToolUseInputs = new ArrayList<PostToolUseHookInput>();
149152

150-
var config = new SessionConfig().setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> {
151-
preToolUseInputs.add(input);
152-
return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());
153-
}).setOnPostToolUse((input, invocation) -> {
154-
postToolUseInputs.add(input);
155-
return CompletableFuture.completedFuture(null);
156-
}));
153+
var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
154+
.setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> {
155+
preToolUseInputs.add(input);
156+
return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());
157+
}).setOnPostToolUse((input, invocation) -> {
158+
postToolUseInputs.add(input);
159+
return CompletableFuture.completedFuture(null);
160+
}));
157161

158162
try (CopilotClient client = ctx.createClient()) {
159163
CopilotSession session = client.createSession(config).get();
@@ -192,11 +196,12 @@ void testDenyToolExecutionWhenPreToolUseReturnsDeny() throws Exception {
192196

193197
var preToolUseInputs = new ArrayList<PreToolUseHookInput>();
194198

195-
var config = new SessionConfig().setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> {
196-
preToolUseInputs.add(input);
197-
// Deny all tool calls
198-
return CompletableFuture.completedFuture(PreToolUseHookOutput.deny());
199-
}));
199+
var config = new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
200+
.setHooks(new SessionHooks().setOnPreToolUse((input, invocation) -> {
201+
preToolUseInputs.add(input);
202+
// Deny all tool calls
203+
return CompletableFuture.completedFuture(PreToolUseHookOutput.deny());
204+
}));
200205

201206
try (CopilotClient client = ctx.createClient()) {
202207
CopilotSession session = client.createSession(config).get();

0 commit comments

Comments
 (0)