mirror of
https://github.com/apache/superset.git
synced 2024-09-19 12:09:42 -04:00
4d329071a1
* Generate JWT in Flask app * Refactor chart data API query logic, add JWT validation and async worker * Add redis stream implementation, refactoring * Add chart data cache endpoint, refactor QueryContext caching * Typing, linting, refactoring * pytest fixes and openapi schema update * Enforce caching be configured for async query init * Async query processing for explore_json endpoint * Add /api/v1/async_event endpoint * Async frontend for dashboards [WIP] * Chart async error message support, refactoring * Abstract asyncEvent middleware * Async chart loading for Explore * Pylint fixes * asyncEvent middleware -> TypeScript, JS linting * Chart data API: enforce forced_cache, add tests * Add tests for explore_json endpoints * Add test for chart data cache enpoint (no login) * Consolidate set_and_log_cache and add STORE_CACHE_KEYS_IN_METADATA_DB flag * Add tests for tasks/async_queries and address PR comments * Bypass non-JSON result formats for async queries * Add tests for redux middleware * Remove debug statement Co-authored-by: Ville Brofeldt <33317356+villebro@users.noreply.github.com> * Skip force_cached if no queryObj * SunburstViz: don't modify self.form_data * Fix failing annotation test * Resolve merge/lint issues * Reduce polling delay * Fix new getClientErrorObject reference * Fix flakey unit tests * /api/v1/async_event: increment redis stream ID, add tests * PR feedback: refactoring, configuration * Fixup: remove debugging * Fix typescript errors due to redux upgrade * Update UPDATING.md * Fix failing py tests * asyncEvent_spec.js -> asyncEvent_spec.ts * Refactor flakey Python 3.7 mock assertions * Fix another shared state issue in Py tests * Use 'sub' claim in JWT for user_id * Refactor async middleware config * Fixup: restore FeatureFlag boolean type Co-authored-by: Ville Brofeldt <33317356+villebro@users.noreply.github.com>
266 lines
7.3 KiB
TypeScript
266 lines
7.3 KiB
TypeScript
/**
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
import fetchMock from 'fetch-mock';
|
|
import sinon from 'sinon';
|
|
import * as featureFlags from 'src/featureFlags';
|
|
import initAsyncEvents from 'src/middleware/asyncEvent';
|
|
|
|
jest.useFakeTimers();
|
|
|
|
describe('asyncEvent middleware', () => {
|
|
const next = sinon.spy();
|
|
const state = {
|
|
charts: {
|
|
123: {
|
|
id: 123,
|
|
status: 'loading',
|
|
asyncJobId: 'foo123',
|
|
},
|
|
345: {
|
|
id: 345,
|
|
status: 'loading',
|
|
asyncJobId: 'foo345',
|
|
},
|
|
},
|
|
};
|
|
const events = [
|
|
{
|
|
status: 'done',
|
|
result_url: '/api/v1/chart/data/cache-key-1',
|
|
job_id: 'foo123',
|
|
channel_id: '999',
|
|
errors: [],
|
|
},
|
|
{
|
|
status: 'done',
|
|
result_url: '/api/v1/chart/data/cache-key-2',
|
|
job_id: 'foo345',
|
|
channel_id: '999',
|
|
errors: [],
|
|
},
|
|
];
|
|
const mockStore = {
|
|
getState: () => state,
|
|
dispatch: sinon.stub(),
|
|
};
|
|
const action = {
|
|
type: 'GENERIC_ACTION',
|
|
};
|
|
const EVENTS_ENDPOINT = 'glob:*/api/v1/async_event/*';
|
|
const CACHED_DATA_ENDPOINT = 'glob:*/api/v1/chart/data/*';
|
|
const config = {
|
|
GLOBAL_ASYNC_QUERIES_TRANSPORT: 'polling',
|
|
GLOBAL_ASYNC_QUERIES_POLLING_DELAY: 500,
|
|
};
|
|
let featureEnabledStub: any;
|
|
|
|
function setup() {
|
|
const getPendingComponents = sinon.stub();
|
|
const successAction = sinon.spy();
|
|
const errorAction = sinon.spy();
|
|
const testCallback = sinon.stub();
|
|
const testCallbackPromise = sinon.stub();
|
|
testCallbackPromise.returns(
|
|
new Promise(resolve => {
|
|
testCallback.callsFake(resolve);
|
|
}),
|
|
);
|
|
|
|
return {
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
testCallback,
|
|
testCallbackPromise,
|
|
};
|
|
}
|
|
|
|
beforeEach(() => {
|
|
fetchMock.get(EVENTS_ENDPOINT, {
|
|
status: 200,
|
|
body: { result: [] },
|
|
});
|
|
fetchMock.get(CACHED_DATA_ENDPOINT, {
|
|
status: 200,
|
|
body: { result: { some: 'data' } },
|
|
});
|
|
featureEnabledStub = sinon.stub(featureFlags, 'isFeatureEnabled');
|
|
featureEnabledStub.withArgs('GLOBAL_ASYNC_QUERIES').returns(true);
|
|
});
|
|
afterEach(() => {
|
|
fetchMock.reset();
|
|
next.resetHistory();
|
|
featureEnabledStub.restore();
|
|
});
|
|
afterAll(fetchMock.reset);
|
|
|
|
it('should initialize and call next', () => {
|
|
const { getPendingComponents, successAction, errorAction } = setup();
|
|
getPendingComponents.returns([]);
|
|
const asyncEventMiddleware = initAsyncEvents({
|
|
config,
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
});
|
|
asyncEventMiddleware(mockStore)(next)(action);
|
|
expect(next.callCount).toBe(1);
|
|
});
|
|
|
|
it('should fetch events when there are pending components', () => {
|
|
const {
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
testCallback,
|
|
testCallbackPromise,
|
|
} = setup();
|
|
getPendingComponents.returns(Object.values(state.charts));
|
|
const asyncEventMiddleware = initAsyncEvents({
|
|
config,
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
processEventsCallback: testCallback,
|
|
});
|
|
|
|
asyncEventMiddleware(mockStore)(next)(action);
|
|
|
|
return testCallbackPromise().then(() => {
|
|
expect(fetchMock.calls(EVENTS_ENDPOINT)).toHaveLength(1);
|
|
});
|
|
});
|
|
|
|
it('should fetch cached when there are successful events', () => {
|
|
const {
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
testCallback,
|
|
testCallbackPromise,
|
|
} = setup();
|
|
fetchMock.reset();
|
|
fetchMock.get(EVENTS_ENDPOINT, {
|
|
status: 200,
|
|
body: { result: events },
|
|
});
|
|
fetchMock.get(CACHED_DATA_ENDPOINT, {
|
|
status: 200,
|
|
body: { result: { some: 'data' } },
|
|
});
|
|
getPendingComponents.returns(Object.values(state.charts));
|
|
const asyncEventMiddleware = initAsyncEvents({
|
|
config,
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
processEventsCallback: testCallback,
|
|
});
|
|
|
|
asyncEventMiddleware(mockStore)(next)(action);
|
|
|
|
return testCallbackPromise().then(() => {
|
|
expect(fetchMock.calls(EVENTS_ENDPOINT)).toHaveLength(1);
|
|
expect(fetchMock.calls(CACHED_DATA_ENDPOINT)).toHaveLength(2);
|
|
expect(successAction.callCount).toBe(2);
|
|
});
|
|
});
|
|
|
|
it('should call errorAction for cache fetch error responses', () => {
|
|
const {
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
testCallback,
|
|
testCallbackPromise,
|
|
} = setup();
|
|
fetchMock.reset();
|
|
fetchMock.get(EVENTS_ENDPOINT, {
|
|
status: 200,
|
|
body: { result: events },
|
|
});
|
|
fetchMock.get(CACHED_DATA_ENDPOINT, {
|
|
status: 400,
|
|
body: { errors: ['error'] },
|
|
});
|
|
getPendingComponents.returns(Object.values(state.charts));
|
|
const asyncEventMiddleware = initAsyncEvents({
|
|
config,
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
processEventsCallback: testCallback,
|
|
});
|
|
|
|
asyncEventMiddleware(mockStore)(next)(action);
|
|
|
|
return testCallbackPromise().then(() => {
|
|
expect(fetchMock.calls(EVENTS_ENDPOINT)).toHaveLength(1);
|
|
expect(fetchMock.calls(CACHED_DATA_ENDPOINT)).toHaveLength(2);
|
|
expect(errorAction.callCount).toBe(2);
|
|
});
|
|
});
|
|
|
|
it('should handle event fetching error responses', () => {
|
|
const {
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
testCallback,
|
|
testCallbackPromise,
|
|
} = setup();
|
|
fetchMock.reset();
|
|
fetchMock.get(EVENTS_ENDPOINT, {
|
|
status: 400,
|
|
body: { message: 'error' },
|
|
});
|
|
getPendingComponents.returns(Object.values(state.charts));
|
|
const asyncEventMiddleware = initAsyncEvents({
|
|
config,
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
processEventsCallback: testCallback,
|
|
});
|
|
|
|
asyncEventMiddleware(mockStore)(next)(action);
|
|
|
|
return testCallbackPromise().then(() => {
|
|
expect(fetchMock.calls(EVENTS_ENDPOINT)).toHaveLength(1);
|
|
});
|
|
});
|
|
|
|
it('should not fetch events when async queries are disabled', () => {
|
|
featureEnabledStub.restore();
|
|
featureEnabledStub = sinon.stub(featureFlags, 'isFeatureEnabled');
|
|
featureEnabledStub.withArgs('GLOBAL_ASYNC_QUERIES').returns(false);
|
|
const { getPendingComponents, successAction, errorAction } = setup();
|
|
getPendingComponents.returns(Object.values(state.charts));
|
|
const asyncEventMiddleware = initAsyncEvents({
|
|
config,
|
|
getPendingComponents,
|
|
successAction,
|
|
errorAction,
|
|
});
|
|
|
|
asyncEventMiddleware(mockStore)(next)(action);
|
|
expect(getPendingComponents.called).toBe(false);
|
|
});
|
|
});
|