Skip to content

feat(client-core): add signal option to support abort fetch #9539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

woai3c
Copy link

@woai3c woai3c commented May 2, 2025

Check List

  • Tests have been run in packages where changes made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet
  • Docs have been added / updated if required

Description of Changes Made

This PR adds the ability to abort requests in @cubejs-client/core by introducing support for the AbortController signal. The implementation:

  1. Extends the HttpTransport constructor and request method to accept a signal parameter
  2. Adds signal support to CubeApi's constructor and all request methods (load, meta, sql, dryRun)
  3. Implements priority handling where method-specific signals override constructor signals
  4. Adds comprehensive test coverage for all signal-related functionality

These changes allow users to cancel in-flight requests by using the AbortController API:

// Example usage
const controller = new AbortController();
const { signal } = controller;

// Pass signal in constructor (affects all requests)
const cubeApi = new CubeApi('token', {
  apiUrl: '...',
  signal
});

// Or pass signal to specific methods
const resultSet = await cubeApi.load(query, { signal });

// To abort the request at any time
controller.abort();

@woai3c woai3c requested a review from a team as a code owner May 2, 2025 09:53
@github-actions github-actions bot added the pr:community Contribution from Cube.js community members. label May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr:community Contribution from Cube.js community members.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant