workers_tail.go

package cloudflare

import (
	"context"
	"errors"
	"fmt"
	"net/http"
	"time"

	"github.com/goccy/go-json"
)

var (
	ErrMissingScriptName = errors.New("required script name missing")
	ErrMissingTailID     = errors.New("required tail id missing")
)

type WorkersTail struct {
	ID        string     `json:"id"`
	URL       string     `json:"url"`
	ExpiresAt *time.Time `json:"expires_at"`
}

type StartWorkersTailResponse struct {
	Response
	Result WorkersTail
}

type ListWorkersTailParameters struct {
	AccountID  string
	ScriptName string
}

type ListWorkersTailResponse struct {
	Response
	Result WorkersTail
}

// StartWorkersTail Starts a tail that receives logs and exception from a Worker.
//
// API reference: https://developers.cloudflare.com/api/operations/worker-tail-logs-start-tail
func (api *API) StartWorkersTail(ctx context.Context, rc *ResourceContainer, scriptName string) (WorkersTail, error) {
	if rc.Identifier == "" {
		return WorkersTail{}, ErrMissingAccountID
	}

	if scriptName == "" {
		return WorkersTail{}, ErrMissingScriptName
	}

	uri := fmt.Sprintf("/accounts/%s/workers/scripts/%s/tails", rc.Identifier, scriptName)
	res, err := api.makeRequestContext(ctx, http.MethodPost, uri, nil)
	if err != nil {
		return WorkersTail{}, err
	}

	var workerstailResponse StartWorkersTailResponse
	if err := json.Unmarshal(res, &workerstailResponse); err != nil {
		return WorkersTail{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
	}

	return workerstailResponse.Result, nil
}

// ListWorkersTail Get list of tails currently deployed on a Worker.
//
// API reference: https://developers.cloudflare.com/api/operations/worker-tail-logs-list-tails
func (api *API) ListWorkersTail(ctx context.Context, rc *ResourceContainer, params ListWorkersTailParameters) (WorkersTail, error) {
	if rc.Identifier == "" {
		return WorkersTail{}, ErrMissingAccountID
	}

	if params.ScriptName == "" {
		return WorkersTail{}, ErrMissingScriptName
	}

	uri := fmt.Sprintf("/accounts/%s/workers/scripts/%s/tails", rc.Identifier, params.ScriptName)
	res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
	if err != nil {
		return WorkersTail{}, err
	}

	var workerstailResponse ListWorkersTailResponse
	if err := json.Unmarshal(res, &workerstailResponse); err != nil {
		return WorkersTail{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
	}

	return workerstailResponse.Result, nil
}

// DeleteWorkersTail Deletes a tail from a Worker.
//
// API reference: https://developers.cloudflare.com/api/operations/worker-tail-logs-delete-tail
func (api *API) DeleteWorkersTail(ctx context.Context, rc *ResourceContainer, scriptName, tailID string) error {
	if rc.Identifier == "" {
		return ErrMissingAccountID
	}

	if scriptName == "" {
		return ErrMissingScriptName
	}

	if tailID == "" {
		return ErrMissingTailID
	}

	uri := fmt.Sprintf("/accounts/%s/workers/scripts/%s/tails/%s", rc.Identifier, scriptName, tailID)
	_, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
	if err != nil {
		return err
	}

	return nil
}