feat: enhance extension API (#1413)

This commit is contained in:
Levi authored and GitHub committed 2026-07-14 20:52:21 +08:00
1 parent 9fb3758203
commit fdfc6902a7
10 files changed
+96 -46

No files matched your search

+18
View File
@@ -25,6 +25,24 @@ type Request struct {
SkipVerifyCert bool `json:"skipVerifyCert"` SkipVerifyCert bool `json:"skipVerifyCert"`
} }
// SetLabels replaces all labels on the request.
func (r *Request) SetLabels(labels map[string]string) {
r.Labels = labels
}
// PutLabel sets a label on the request.
func (r *Request) PutLabel(key, value string) {
if r.Labels == nil {
r.Labels = make(map[string]string)
}
r.Labels[key] = value
}
// DelLabel deletes a label from the request.
func (r *Request) DelLabel(key string) {
delete(r.Labels, key)
}
func (r *Request) Validate() error { func (r *Request) Validate() error {
if r.URL == "" { if r.URL == "" {
return fmt.Errorf("invalid request url") return fmt.Errorf("invalid request url")
+23 -16
View File
@@ -42,35 +42,42 @@ type generationTestManager struct {
pauseOnce sync.Once pauseOnce sync.Once
} }
func TestExtensionTaskControlMethodsOnlyExistOnError(t *testing.T) { func TestExtensionTaskMethodsMatchEventCapabilities(t *testing.T) {
taskType := reflect.TypeOf((*Task)(nil)) taskType := reflect.TypeOf((*Task)(nil))
if _, ok := taskType.MethodByName("Continue"); ok { if _, ok := taskType.MethodByName("Continue"); ok {
t.Fatal("regular task unexpectedly exposes Continue") t.Fatal("regular task unexpectedly exposes Continue")
} }
if _, ok := taskType.MethodByName("Pause"); ok { if _, ok := taskType.MethodByName("SetUrl"); ok {
t.Fatal("regular task unexpectedly exposes Pause") t.Fatal("regular task unexpectedly exposes SetUrl")
} }
errorTaskType := reflect.TypeOf((*ExtensionTask)(nil)) extensionTaskType := reflect.TypeOf((*ExtensionTask)(nil))
if _, ok := extensionTaskType.MethodByName("SetUrl"); !ok {
t.Fatal("extension task does not expose SetUrl")
}
if _, ok := extensionTaskType.MethodByName("Continue"); ok {
t.Fatal("non-error extension task unexpectedly exposes Continue")
}
errorTaskType := reflect.TypeOf((*OnErrorExtensionTask)(nil))
if _, ok := errorTaskType.MethodByName("SetUrl"); !ok {
t.Fatal("onError task does not expose SetUrl")
}
if _, ok := errorTaskType.MethodByName("Continue"); !ok { if _, ok := errorTaskType.MethodByName("Continue"); !ok {
t.Fatal("onError task does not expose Continue") t.Fatal("onError task does not expose Continue")
} }
if _, ok := errorTaskType.MethodByName("Pause"); ok {
t.Fatal("onError task unexpectedly exposes Pause")
}
for name, contextType := range map[string]reflect.Type{ startTaskField, _ := reflect.TypeOf(OnStartContext{}).FieldByName("Task")
"onStart": reflect.TypeOf(OnStartContext{}), if startTaskField.Type != extensionTaskType {
"onDone": reflect.TypeOf(OnDoneContext{}), t.Fatalf("onStart does not inject the request mutation wrapper: %v", startTaskField.Type)
} { }
field, _ := contextType.FieldByName("Task") doneTaskField, _ := reflect.TypeOf(OnDoneContext{}).FieldByName("Task")
if field.Type != taskType { if doneTaskField.Type != taskType {
t.Fatalf("%s unexpectedly injects a control wrapper: %v", name, field.Type) t.Fatalf("onDone unexpectedly injects a mutation wrapper: %v", doneTaskField.Type)
}
} }
errorTaskField, _ := reflect.TypeOf(OnErrorContext{}).FieldByName("Task") errorTaskField, _ := reflect.TypeOf(OnErrorContext{}).FieldByName("Task")
if errorTaskField.Type != errorTaskType { if errorTaskField.Type != errorTaskType {
t.Fatalf("onError does not inject the Continue wrapper: %v", errorTaskField.Type) t.Fatalf("onError does not inject the recovery wrapper: %v", errorTaskField.Type)
} }
} }
+26 -11
View File
@@ -705,12 +705,12 @@ type OnResolveContext struct {
} }
type OnStartContext struct { type OnStartContext struct {
Task *Task `json:"task"` Task *ExtensionTask `json:"task"`
} }
type OnErrorContext struct { type OnErrorContext struct {
Task *ExtensionTask `json:"task"` Task *OnErrorExtensionTask `json:"task"`
Error error `json:"error"` Error error `json:"error"`
} }
type OnDoneContext struct { type OnDoneContext struct {
@@ -721,9 +721,15 @@ type OnDoneContext struct {
// Avoid extension scripts modifying task directly, use ExtensionTask to encapsulate task, // Avoid extension scripts modifying task directly, use ExtensionTask to encapsulate task,
// only some fields can be modified, such as request info. // only some fields can be modified, such as request info.
type ExtensionTask struct { type ExtensionTask struct {
*Task
}
// OnErrorExtensionTask adds error-recovery controls to ExtensionTask.
// Continue is intentionally only exposed to onError handlers.
type OnErrorExtensionTask struct {
download *Downloader download *Downloader
*Task *ExtensionTask
} }
func cloneExtensionTask(task *Task) *Task { func cloneExtensionTask(task *Task) *Task {
@@ -732,14 +738,18 @@ func cloneExtensionTask(task *Task) *Task {
return newTask return newTask
} }
func newOnStartExtensionTask(task *Task) *Task { func newExtensionTask(task *Task) *ExtensionTask {
return cloneExtensionTask(task) return &ExtensionTask{Task: cloneExtensionTask(task)}
} }
func newOnErrorExtensionTask(download *Downloader, task *Task) *ExtensionTask { func newOnStartExtensionTask(task *Task) *ExtensionTask {
return &ExtensionTask{ return newExtensionTask(task)
download: download, }
Task: cloneExtensionTask(task),
func newOnErrorExtensionTask(download *Downloader, task *Task) *OnErrorExtensionTask {
return &OnErrorExtensionTask{
download: download,
ExtensionTask: newExtensionTask(task),
} }
} }
@@ -747,7 +757,12 @@ func newOnDoneExtensionTask(task *Task) *Task {
return cloneExtensionTask(task) return cloneExtensionTask(task)
} }
func (t *ExtensionTask) Continue() error { // SetUrl replaces the task request URL.
func (t *ExtensionTask) SetUrl(url string) {
t.Meta.Req.URL = url
}
func (t *OnErrorExtensionTask) Continue() error {
return t.download.Continue(&TaskFilter{ return t.download.Continue(&TaskFilter{
IDs: []string{t.ID}, IDs: []string{t.ID},
}) })
+14 -3
View File
@@ -26,15 +26,26 @@ func TestDownloader_InstallExtensionByFolder(t *testing.T) {
if _, err := downloader.InstallExtensionByFolder("./testdata/extensions/basic", false); err != nil { if _, err := downloader.InstallExtensionByFolder("./testdata/extensions/basic", false); err != nil {
t.Fatal(err) t.Fatal(err)
} }
rr, err := downloader.Resolve(&base.Request{ req := &base.Request{
URL: "https://github.com/test", URL: "https://github.com/test",
}, nil) Labels: map[string]string{"original": "true"},
}
rr, err := downloader.Resolve(req, nil)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
if len(rr.Res.Files) == 1 { if len(rr.Res.Files) == 1 {
t.Fatal("resolve error") t.Fatal("resolve error")
} }
if req.Labels["replaced"] != "true" || req.Labels["modified"] != "true" {
t.Fatalf("request label methods did not update labels: %#v", req.Labels)
}
if _, ok := req.Labels["original"]; ok {
t.Fatalf("setLabels did not replace existing labels: %#v", req.Labels)
}
if _, ok := req.Labels["removed"]; ok {
t.Fatalf("delLabel did not remove label: %#v", req.Labels)
}
}) })
} }
+3
View File
@@ -1,4 +1,7 @@
gopeed.events.onResolve(async function (ctx) { gopeed.events.onResolve(async function (ctx) {
ctx.req.setLabels({ replaced: "true", removed: "true" });
ctx.req.putLabel("modified", "true");
ctx.req.delLabel("removed");
ctx.res = { ctx.res = {
name: "test", name: "test",
files: Array(2).fill(true).map((_, i) => ({ files: Array(2).fill(true).map((_, i) => ({
@@ -132,9 +132,8 @@ gopeed.events.onError(async function (ctx) {
return; return;
} }
req.url = createPayloadURL(source, false); ctx.task.setUrl(createPayloadURL(source, false));
req.labels = req.labels || {}; req.putLabel('started', 'true');
req.labels.started = 'true'; req.putLabel('rebuilt', 'true');
req.labels.rebuilt = 'true';
ctx.task.continue(); ctx.task.continue();
}); });
+2 -2
View File
@@ -40,7 +40,7 @@ gopeed.events.onError(async function (ctx) {
return; return;
} }
req.labels.recovered = "true"; req.putLabel("recovered", "true");
req.url = gopeed.runtime.blob.createObjectURL(new Blob(["ok\n"], { type: "text/plain" })); ctx.task.setUrl(gopeed.runtime.blob.createObjectURL(new Blob(["ok\n"], { type: "text/plain" })));
ctx.task.continue(); ctx.task.continue();
}); });
+4 -5
View File
@@ -41,18 +41,17 @@ gopeed.events.onError(async function (ctx) {
if (!req || !req.rawUrl || !req.url || !req.url.includes('/__blob/')) { if (!req || !req.rawUrl || !req.url || !req.url.includes('/__blob/')) {
return; return;
} }
req.labels = req.labels || {};
if (req.labels.rebuilt === 'true') { if (req.labels.rebuilt === 'true') {
return; return;
} }
try { try {
req.url = createRangeBlobUrl(req.rawUrl); ctx.task.setUrl(createRangeBlobUrl(req.rawUrl));
req.labels.started = 'true'; req.putLabel('started', 'true');
req.labels.rebuilt = 'true'; req.putLabel('rebuilt', 'true');
ctx.task.continue(); ctx.task.continue();
} catch (error) { } catch (error) {
req.labels.rebuildError = String(error); req.putLabel('rebuildError', String(error));
throw error; throw error;
} }
}); });
+1 -2
View File
@@ -1,7 +1,6 @@
gopeed.events.onError(async function (ctx) { gopeed.events.onError(async function (ctx) {
gopeed.logger.info("url", ctx.task.meta.req.url); gopeed.logger.info("url", ctx.task.meta.req.url);
gopeed.logger.info("error", ctx.error); gopeed.logger.info("error", ctx.error);
ctx.task.meta.req.url = "https://github.com"; ctx.task.setUrl("https://github.com");
ctx.task.continue(); ctx.task.continue();
}); });
+2 -3
View File
@@ -1,6 +1,5 @@
gopeed.events.onStart(async function (ctx) { gopeed.events.onStart(async function (ctx) {
gopeed.logger.info("url", ctx.task.meta.req.url); gopeed.logger.info("url", ctx.task.meta.req.url);
ctx.task.meta.req.url = "https://github.com"; ctx.task.setUrl("https://github.com");
ctx.task.meta.req.labels['modified'] = 'true'; ctx.task.meta.req.putLabel('modified', 'true');
}); });