Merge pull request #1361 from echen67/echen/WC-1473

cloudflare · Aug 22, 2023 · 3b0a9e3 · 3b0a9e3
2 parents d38ba6c + f491187
commit 3b0a9e3
Show file tree

Hide file tree

Showing 10 changed files with 322 additions and 32 deletions.
diff --git a/.changelog/1361.txt b/.changelog/1361.txt
@@ -0,0 +1,7 @@
+```release-note:enhancement
+workers: Add support for retrieving and uploading only script content.
+```
+
+```release-note:enhancement
+workers: Add support for retrieving and uploading only script metadata.
+```
diff --git a/workers.go b/workers.go
@@ -87,6 +87,49 @@ func (p CreateWorkerParams) RequiresMultipart() bool {
 	return false
 }
 
+type UpdateWorkersScriptContentParams struct {
+	ScriptName string
+	Script     string
+
+	// DispatchNamespaceName uploads the worker to a WFP dispatch namespace if provided
+	DispatchNamespaceName *string
+
+	// Module changes the Content-Type header to specify the script is an
+	// ES Module syntax script.
+	Module bool
+}
+
+type UpdateWorkersScriptSettingsParams struct {
+	ScriptName string
+
+	// Logpush opts the worker into Workers Logpush logging. A nil value leaves
+	// the current setting unchanged.
+	//
+	// Documentation: https://developers.cloudflare.com/workers/platform/logpush/
+	Logpush *bool
+
+	// TailConsumers specifies a list of Workers that will consume the logs of
+	// the attached Worker.
+	// Documentation: https://developers.cloudflare.com/workers/platform/tail-workers/
+	TailConsumers *[]WorkersTailConsumer
+
+	// Bindings should be a map where the keys are the binding name, and the
+	// values are the binding content
+	Bindings map[string]WorkerBinding
+
+	// CompatibilityDate is a date in the form yyyy-mm-dd,
+	// which will be used to determine which version of the Workers runtime is used.
+	//  https://developers.cloudflare.com/workers/platform/compatibility-dates/
+	CompatibilityDate string
+
+	// CompatibilityFlags are the names of features of the Workers runtime to be enabled or disabled,
+	// usually used together with CompatibilityDate.
+	//  https://developers.cloudflare.com/workers/platform/compatibility-dates/#compatibility-flags
+	CompatibilityFlags []string
+
+	Placement *Placement
+}
+
 // WorkerScriptParams provides a worker script and the associated bindings.
 type WorkerScriptParams struct {
 	ScriptName string
@@ -162,6 +205,12 @@ type WorkerScriptResponse struct {
 	WorkerScript `json:"result"`
 }
 
+// WorkerScriptSettingsResponse wrapper struct for API response to worker script settings calls.
+type WorkerScriptSettingsResponse struct {
+	Response
+	WorkerMetaData
+}
+
 type ListWorkersParams struct{}
 
 type DeleteWorkerParams struct {
@@ -181,7 +230,7 @@ type Placement struct {
 
 // DeleteWorker deletes a single Worker.
 //
-// API reference: https://api.cloudflare.com/#worker-script-delete-worker
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-delete-worker
 func (api *API) DeleteWorker(ctx context.Context, rc *ResourceContainer, params DeleteWorkerParams) error {
 	if rc.Level != AccountRouteLevel {
 		return ErrRequiredAccountLevelResourceContainer
@@ -210,7 +259,7 @@ func (api *API) DeleteWorker(ctx context.Context, rc *ResourceContainer, params
 // GetWorker fetch raw script content for your worker returns string containing
 // worker code js.
 //
-// API reference: https://developers.cloudflare.com/workers/tooling/api/scripts/
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-download-worker
 func (api *API) GetWorker(ctx context.Context, rc *ResourceContainer, scriptName string) (WorkerScriptResponse, error) {
 	if rc.Level != AccountRouteLevel {
 		return WorkerScriptResponse{}, ErrRequiredAccountLevelResourceContainer
@@ -253,7 +302,7 @@ func (api *API) GetWorker(ctx context.Context, rc *ResourceContainer, scriptName
 
 // ListWorkers returns list of Workers for given account.
 //
-// API reference: https://developers.cloudflare.com/workers/tooling/api/scripts/
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-list-workers
 func (api *API) ListWorkers(ctx context.Context, rc *ResourceContainer, params ListWorkersParams) (WorkerListResponse, *ResultInfo, error) {
 	if rc.Level != AccountRouteLevel {
 		return WorkerListResponse{}, &ResultInfo{}, ErrRequiredAccountLevelResourceContainer
@@ -280,7 +329,7 @@ func (api *API) ListWorkers(ctx context.Context, rc *ResourceContainer, params L
 
 // UploadWorker pushes raw script content for your Worker.
 //
-// API reference: https://api.cloudflare.com/#worker-script-upload-worker
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-upload-worker-module
 func (api *API) UploadWorker(ctx context.Context, rc *ResourceContainer, params CreateWorkerParams) (WorkerScriptResponse, error) {
 	if rc.Level != AccountRouteLevel {
 		return WorkerScriptResponse{}, ErrRequiredAccountLevelResourceContainer
@@ -325,6 +374,144 @@ func (api *API) UploadWorker(ctx context.Context, rc *ResourceContainer, params
 	return r, nil
 }
 
+// GetWorkersScriptContent returns the pure script content of a worker.
+//
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-get-content
+func (api *API) GetWorkersScriptContent(ctx context.Context, rc *ResourceContainer, scriptName string) (string, error) {
+	if rc.Level != AccountRouteLevel {
+		return "", ErrRequiredAccountLevelResourceContainer
+	}
+
+	if rc.Identifier == "" {
+		return "", ErrMissingAccountID
+	}
+
+	uri := fmt.Sprintf("/accounts/%s/workers/scripts/%s/content/v2", rc.Identifier, scriptName)
+	res, err := api.makeRequestContextWithHeadersComplete(ctx, http.MethodGet, uri, nil, nil)
+	if err != nil {
+		return "", err
+	}
+
+	return string(res.Body), nil
+}
+
+// UpdateWorkersScriptContent pushes only script content, no metadata.
+//
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-put-content
+func (api *API) UpdateWorkersScriptContent(ctx context.Context, rc *ResourceContainer, params UpdateWorkersScriptContentParams) (WorkerScriptResponse, error) {
+	if rc.Level != AccountRouteLevel {
+		return WorkerScriptResponse{}, ErrRequiredAccountLevelResourceContainer
+	}
+
+	if rc.Identifier == "" {
+		return WorkerScriptResponse{}, ErrMissingAccountID
+	}
+
+	body := []byte(params.Script)
+	var (
+		contentType = "application/javascript"
+		err         error
+	)
+
+	if params.Module {
+		var formattedParams CreateWorkerParams
+		formattedParams.Script = params.Script
+		formattedParams.ScriptName = params.ScriptName
+		formattedParams.Module = params.Module
+		formattedParams.DispatchNamespaceName = params.DispatchNamespaceName
+		contentType, body, err = formatMultipartBody(formattedParams)
+		if err != nil {
+			return WorkerScriptResponse{}, err
+		}
+	}
+
+	uri := fmt.Sprintf("/accounts/%s/workers/scripts/%s/content", rc.Identifier, params.ScriptName)
+	if params.DispatchNamespaceName != nil {
+		uri = fmt.Sprintf("/accounts/%s/workers/dispatch_namespaces/%s/scripts/%s/content", rc.Identifier, *params.DispatchNamespaceName, params.ScriptName)
+	}
+
+	headers := make(http.Header)
+	headers.Set("Content-Type", contentType)
+	res, err := api.makeRequestContextWithHeaders(ctx, http.MethodPut, uri, body, headers)
+
+	var r WorkerScriptResponse
+	if err != nil {
+		return r, err
+	}
+
+	err = json.Unmarshal(res, &r)
+	if err != nil {
+		return r, fmt.Errorf("%s: %w", errUnmarshalError, err)
+	}
+
+	return r, nil
+}
+
+// GetWorkersScriptSettings returns the metadata of a worker.
+//
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-get-settings
+func (api *API) GetWorkersScriptSettings(ctx context.Context, rc *ResourceContainer, scriptName string) (WorkerScriptSettingsResponse, error) {
+	if rc.Level != AccountRouteLevel {
+		return WorkerScriptSettingsResponse{}, ErrRequiredAccountLevelResourceContainer
+	}
+
+	if rc.Identifier == "" {
+		return WorkerScriptSettingsResponse{}, ErrMissingAccountID
+	}
+
+	uri := fmt.Sprintf("/accounts/%s/workers/scripts/%s/settings", rc.Identifier, scriptName)
+	res, err := api.makeRequestContextWithHeaders(ctx, http.MethodGet, uri, nil, nil)
+	var r WorkerScriptSettingsResponse
+	if err != nil {
+		return r, err
+	}
+
+	err = json.Unmarshal(res, &r)
+	if err != nil {
+		return r, fmt.Errorf("%s: %w", errUnmarshalError, err)
+	}
+
+	r.Success = true
+
+	return r, nil
+}
+
+// UpdateWorkersScriptSettings pushes only script metadata.
+//
+// API reference: https://developers.cloudflare.com/api/operations/worker-script-patch-settings
+func (api *API) UpdateWorkersScriptSettings(ctx context.Context, rc *ResourceContainer, params UpdateWorkersScriptSettingsParams) (WorkerScriptSettingsResponse, error) {
+	if rc.Level != AccountRouteLevel {
+		return WorkerScriptSettingsResponse{}, ErrRequiredAccountLevelResourceContainer
+	}
+
+	if rc.Identifier == "" {
+		return WorkerScriptSettingsResponse{}, ErrMissingAccountID
+	}
+
+	body, err := json.Marshal(params)
+	if err != nil {
+		return WorkerScriptSettingsResponse{}, err
+	}
+	headers := make(http.Header)
+	headers.Set("Content-Type", "application/json")
+
+	uri := fmt.Sprintf("/accounts/%s/workers/scripts/%s/settings", rc.Identifier, params.ScriptName)
+	res, err := api.makeRequestContextWithHeaders(ctx, http.MethodPatch, uri, body, headers)
+	var r WorkerScriptSettingsResponse
+	if err != nil {
+		return r, err
+	}
+
+	err = json.Unmarshal(res, &r)
+	if err != nil {
+		return r, fmt.Errorf("%s: %w", errUnmarshalError, err)
+	}
+
+	r.Success = true
+
+	return r, nil
+}
+
 // Returns content-type, body, error.
 func formatMultipartBody(params CreateWorkerParams) (string, []byte, error) {
 	var buf = &bytes.Buffer{}

diff --git a/workers_account_settings.go b/workers_account_settings.go
@@ -32,7 +32,7 @@ type WorkersAccountSettingsResponse struct {
 
 // CreateWorkersAccountSettings sets the account settings for Workers.
 //
-// API reference: https://api.cloudflare.com/#worker-account-settings-create-worker-account-settings
+// API reference: https://developers.cloudflare.com/api/operations/worker-account-settings-create-worker-account-settings
 func (api *API) CreateWorkersAccountSettings(ctx context.Context, rc *ResourceContainer, params CreateWorkersAccountSettingsParameters) (WorkersAccountSettings, error) {
 	if rc.Identifier == "" {
 		return WorkersAccountSettings{}, ErrMissingAccountID
@@ -58,7 +58,7 @@ func (api *API) CreateWorkersAccountSettings(ctx context.Context, rc *ResourceCo
 
 // WorkersAccountSettings returns the current account settings for Workers.
 //
-// API reference: https://api.cloudflare.com/#worker-account-settings-fetch-worker-account-settings
+// API reference: https://developers.cloudflare.com/api/operations/worker-account-settings-fetch-worker-account-settings
 func (api *API) WorkersAccountSettings(ctx context.Context, rc *ResourceContainer, params WorkersAccountSettingsParameters) (WorkersAccountSettings, error) {
 	if rc.Identifier == "" {
 		return WorkersAccountSettings{}, ErrMissingAccountID

diff --git a/workers_cron_triggers.go b/workers_cron_triggers.go
@@ -40,7 +40,7 @@ type UpdateWorkerCronTriggersParams struct {
 // ListWorkerCronTriggers fetches all available cron triggers for a single Worker
 // script.
 //
-// API reference: https://api.cloudflare.com/#worker-cron-trigger-get-cron-triggers
+// API reference: https://developers.cloudflare.com/api/operations/worker-cron-trigger-get-cron-triggers
 func (api *API) ListWorkerCronTriggers(ctx context.Context, rc *ResourceContainer, params ListWorkerCronTriggersParams) ([]WorkerCronTrigger, error) {
 	if rc.Level != AccountRouteLevel {
 		return []WorkerCronTrigger{}, ErrRequiredAccountLevelResourceContainer
@@ -66,7 +66,7 @@ func (api *API) ListWorkerCronTriggers(ctx context.Context, rc *ResourceContaine
 
 // UpdateWorkerCronTriggers updates a single schedule for a Worker cron trigger.
 //
-// API reference: https://api.cloudflare.com/#worker-cron-trigger-update-cron-triggers
+// API reference: https://developers.cloudflare.com/api/operations/worker-cron-trigger-update-cron-triggers
 func (api *API) UpdateWorkerCronTriggers(ctx context.Context, rc *ResourceContainer, params UpdateWorkerCronTriggersParams) ([]WorkerCronTrigger, error) {
 	if rc.Level != AccountRouteLevel {
 		return []WorkerCronTrigger{}, ErrRequiredAccountLevelResourceContainer

diff --git a/workers_domain.go b/workers_domain.go
@@ -53,7 +53,7 @@ type WorkersDomainListResponse struct {
 
 // ListWorkersDomains lists all Worker Domains.
 //
-// API reference: https://api.cloudflare.com/#worker-domain-list-domains
+// API reference: https://developers.cloudflare.com/api/operations/worker-domain-list-domains
 func (api *API) ListWorkersDomains(ctx context.Context, rc *ResourceContainer, params ListWorkersDomainParams) ([]WorkersDomain, error) {
 	if rc.Identifier == "" {
 		return []WorkersDomain{}, ErrMissingAccountID
@@ -75,7 +75,7 @@ func (api *API) ListWorkersDomains(ctx context.Context, rc *ResourceContainer, p
 
 // AttachWorkersDomain attaches a worker to a zone and hostname.
 //
-// API reference: https://api.cloudflare.com/#worker-domain-attach-to-domain
+// API reference: https://developers.cloudflare.com/api/operations/worker-domain-attach-to-domain
 func (api *API) AttachWorkersDomain(ctx context.Context, rc *ResourceContainer, domain AttachWorkersDomainParams) (WorkersDomain, error) {
 	if rc.Identifier == "" {
 		return WorkersDomain{}, ErrMissingAccountID
@@ -113,7 +113,7 @@ func (api *API) AttachWorkersDomain(ctx context.Context, rc *ResourceContainer,
 
 // GetWorkersDomain gets a single Worker Domain.
 //
-// API reference: https://api.cloudflare.com/#worker-domain-get-a-domain
+// API reference: https://developers.cloudflare.com/api/operations/worker-domain-get-a-domain
 func (api *API) GetWorkersDomain(ctx context.Context, rc *ResourceContainer, domainID string) (WorkersDomain, error) {
 	if rc.Identifier == "" {
 		return WorkersDomain{}, ErrMissingAccountID
@@ -135,7 +135,7 @@ func (api *API) GetWorkersDomain(ctx context.Context, rc *ResourceContainer, dom
 
 // DetachWorkersDomain detaches a worker from a zone and hostname.
 //
-// API reference: https://api.cloudflare.com/#worker-domain-detach-from-domain
+// API reference: https://developers.cloudflare.com/api/operations/worker-domain-detach-from-domain
 func (api *API) DetachWorkersDomain(ctx context.Context, rc *ResourceContainer, domainID string) error {
 	if rc.Identifier == "" {
 		return ErrMissingAccountID