Method ExecuteDesktopAction

codersdk/workspacesdk/agentconn.go:691–734

10 MB ExecuteDesktopAction executes a mouse/keyboard/scroll action on the agent's desktop.

(ctx context.Context, action DesktopAction)

// ExecuteDesktopAction executes a mouse/keyboard/scroll action on the
// agent's desktop.
func (c *agentConn) ExecuteDesktopAction(ctx context.Context, action DesktopAction) (DesktopActionResponse, error) {
	ctx, span := tracing.StartSpan(ctx)
	defer span.End()

	host := net.JoinHostPort(
		c.agentAddress().String(),
		strconv.Itoa(AgentHTTPAPIServerPort),
	)

	body, err := json.Marshal(action)
	if err != nil {
		return DesktopActionResponse{}, xerrors.Errorf("marshal action: %w", err)
	}

	url := fmt.Sprintf("http://%s/api/v0/desktop/action", host)
	req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(body))
	if err != nil {
		return DesktopActionResponse{}, xerrors.Errorf("create request: %w", err)
	}
	req.Header.Set("Content-Type", "application/json")
	c.headersMu.RLock()
	if len(c.extraHeaders) > 0 {
		for k, v := range c.extraHeaders {
			req.Header[k] = v
		}
	}
	c.headersMu.RUnlock()

	resp, err := c.apiClient().Do(req)
	if err != nil {
		return DesktopActionResponse{}, xerrors.Errorf("action request: %w", err)
	}
	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		return DesktopActionResponse{}, codersdk.ReadBodyAsError(resp)
	}

	var result DesktopActionResponse
	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
		return DesktopActionResponse{}, xerrors.Errorf("decode action response: %w", err)
	}
	return result, nil
}

// StartDesktopRecording starts a desktop recording session on the
// agent with the given recording ID. The recording ID is