Merge pull request #1176 from jbw1991/jwheeler/queue-binding

Add queue binding type for workers scripts

.changelog/1176.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+workers: script upload now supports Queues bindings
+```

workers_bindings.go

@@ -39,6 +39,8 @@ const (
 	WorkerR2BucketBindingType WorkerBindingType = "r2_bucket"
 	// WorkerAnalyticsEngineBindingType is the type for Analytics Engine dataset bindings.
 	WorkerAnalyticsEngineBindingType WorkerBindingType = "analytics_engine"
+	// WorkerQueueBindingType is the type for queue bindings.
+	WorkerQueueBindingType WorkerBindingType = "queue"
 )
 
 type ListWorkerBindingsParams struct {
@@ -309,6 +311,34 @@ func (b WorkerAnalyticsEngineBinding) serialize(bindingName string) (workerBindi
 	}, nil, nil
 }
 
+// WorkerQueueBinding is a binding to a Workers Queue.
+//
+// https://developers.cloudflare.com/workers/platform/bindings/#queue-bindings
+type WorkerQueueBinding struct {
+	Binding string
+	Queue   string
+}
+
+// Type returns the type of the binding.
+func (b WorkerQueueBinding) Type() WorkerBindingType {
+	return WorkerQueueBindingType
+}
+
+func (b WorkerQueueBinding) serialize(bindingName string) (workerBindingMeta, workerBindingBodyWriter, error) {
+	if b.Binding == "" {
+		return nil, nil, fmt.Errorf(`Binding name for binding "%s" cannot be empty`, bindingName)
+	}
+	if b.Queue == "" {
+		return nil, nil, fmt.Errorf(`Queue name for binding "%s" cannot be empty`, bindingName)
+	}
+
+	return workerBindingMeta{
+		"type":       b.Type(),
+		"name":       b.Binding,
+		"queue_name": b.Queue,
+	}, nil, nil
+}
+
 // Each binding that adds a part to the multipart form body will need
 // a unique part name so we just generate a random 128bit hex string.
 func getRandomPartName() string {
@@ -377,6 +407,12 @@ func (api *API) ListWorkerBindings(ctx context.Context, rc *ResourceContainer, p
 			bindingListItem.Binding = WorkerKvNamespaceBinding{
 				NamespaceID: namespaceID,
 			}
+		case WorkerQueueBindingType:
+			queueName := jsonBinding["queue_name"].(string)
+			bindingListItem.Binding = WorkerQueueBinding{
+				Binding: name,
+				Queue:   queueName,
+			}
 		case WorkerWebAssemblyBindingType:
 			bindingListItem.Binding = WorkerWebAssemblyBinding{
 				Module: &bindingContentReader{

workers_test.go

@@ -896,3 +896,40 @@ func TestUploadWorker_WithCompatibilityFlags(t *testing.T) {
 	})
 	assert.NoError(t, err)
 }
+
+func TestUploadWorker_WithQueueBinding(t *testing.T) {
+	setup()
+	defer teardown()
+
+	handler := func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, http.MethodPut, r.Method, "Expected method 'PUT', got %s", r.Method)
+
+		mpUpload, err := parseMultipartUpload(r)
+		assert.NoError(t, err)
+
+		expectedBindings := map[string]workerBindingMeta{
+			"b1": {
+				"name":       "b1",
+				"type":       "queue",
+				"queue_name": "test-queue",
+			},
+		}
+		assert.Equal(t, workerScript, mpUpload.Script)
+		assert.Equal(t, expectedBindings, mpUpload.BindingMeta)
+
+		w.Header().Set("content-type", "application/json")
+		fmt.Fprint(w, uploadWorkerResponseData)
+	}
+	mux.HandleFunc("/accounts/"+testAccountID+"/workers/scripts/bar", handler)
+
+	_, err := client.UploadWorker(context.Background(), AccountIdentifier(testAccountID), CreateWorkerParams{
+		ScriptName: "bar",
+		Script:     workerScript,
+		Bindings: map[string]WorkerBinding{
+			"b1": WorkerQueueBinding{
+				Binding: "b1",
+				Queue:   "test-queue",
+			},
+		}})
+	assert.NoError(t, err)
+}