Skip to content

G
gitlab-ce
Commit ea072b6b authored by Phil Hughes's avatar Phil Hughes
Browse files
Options

Merge branch '12221-revert-workaround-for-missing-dependency-list-pagination-ee' into 'master' 

Revert "Work around missing pagination headers"

Closes #12221

See merge request gitlab-org/gitlab-ee!14220
parents 6c3bd9a1 a7be2823
Hide whitespace changes
Inline Side-by-side
Showing with 32 additions and 321 deletions
ee/app/assets/javascripts/dependencies/components/app.vue
View file @ ea072b6b
......@@ -55,12 +55,10 @@ export default {
},
created() {
this.setDependenciesEndpoint(this.endpoint);
this.fetchDependenciesPagination()
.then(() => this.fetchDependencies())
.catch(() => {});
this.fetchDependencies();
},
methods: {
...mapActions(['setDependenciesEndpoint', 'fetchDependenciesPagination', 'fetchDependencies']),
...mapActions(['setDependenciesEndpoint', 'fetchDependencies']),
fetchPage(page) {
this.fetchDependencies({ page });
},
......
ee/app/assets/javascripts/dependencies/store/actions.js
View file @ ea072b6b
......@@ -9,43 +9,7 @@ import { __ } from '~/locale';
export const setDependenciesEndpoint = ({ commit }, endpoint) =>
commit(types.SET_DEPENDENCIES_ENDPOINT, endpoint);
export const requestDependenciesPagination = ({ commit }) =>
commit(types.REQUEST_DEPENDENCIES_PAGINATION);
export const receiveDependenciesPaginationSuccess = ({ commit }, payload) =>
commit(types.RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS, payload);
export const receiveDependenciesPaginationError = ({ commit }) =>
commit(types.RECEIVE_DEPENDENCIES_PAGINATION_ERROR);
export const fetchDependenciesPagination = ({ state, dispatch }) => {
const onError = error => {
dispatch('receiveDependenciesPaginationError', error);
createFlash(FETCH_ERROR_MESSAGE);
throw error;
};
dispatch('requestDependenciesPagination');
if (!state.endpoint) {
return Promise.reject(new Error('endpoint_missing')).catch(onError);
}
return axios
.get(state.endpoint)
.then(response => {
if (isValidResponse(response)) {
const total = response.data.dependencies.length;
dispatch('receiveDependenciesPaginationSuccess', total);
} else {
throw new Error(__('Invalid server response'));
}
})
.catch(onError);
};
export const requestDependencies = ({ commit }, payload) =>
commit(types.REQUEST_DEPENDENCIES, payload);
export const requestDependencies = ({ commit }) => commit(types.REQUEST_DEPENDENCIES);
export const receiveDependenciesSuccess = ({ commit }, { headers, data }) => {
const normalizedHeaders = normalizeHeaders(headers);
......@@ -63,15 +27,14 @@ export const fetchDependencies = ({ state, dispatch }, params = {}) => {
return;
}
const page = params.page || state.pageInfo.page || 1;
dispatch('requestDependencies', { page });
dispatch('requestDependencies');
axios
.get(state.endpoint, {
params: {
sort_by: state.sortField,
sort: state.sortOrder,
page,
page: state.pageInfo.page || 1,
...params,
},
})
......
ee/app/assets/javascripts/dependencies/store/constants.js
View file @ ea072b6b
......@@ -21,5 +21,3 @@ export const REPORT_STATUS = {
export const FETCH_ERROR_MESSAGE = __(
'Error fetching the dependency list. Please check your network connection and try again.',
);
export const DEPENDENCIES_PER_PAGE = 20;
ee/app/assets/javascripts/dependencies/store/mutation_types.js
View file @ ea072b6b
export const SET_DEPENDENCIES_ENDPOINT = 'SET_DEPENDENCIES_ENDPOINT';
export const REQUEST_DEPENDENCIES_PAGINATION = 'REQUEST_DEPENDENCIES_PAGINATION';
export const RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS = 'RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS';
export const RECEIVE_DEPENDENCIES_PAGINATION_ERROR = 'RECEIVE_DEPENDENCIES_PAGINATION_ERROR';
export const REQUEST_DEPENDENCIES = 'REQUEST_DEPENDENCIES';
export const RECEIVE_DEPENDENCIES_SUCCESS = 'RECEIVE_DEPENDENCIES_SUCCESS';
export const RECEIVE_DEPENDENCIES_ERROR = 'RECEIVE_DEPENDENCIES_ERROR';
......
ee/app/assets/javascripts/dependencies/store/mutations.js
View file @ ea072b6b
......@@ -5,30 +5,13 @@ export default {
[types.SET_DEPENDENCIES_ENDPOINT](state, payload) {
state.endpoint = payload;
},
[types.REQUEST_DEPENDENCIES_PAGINATION](state) {
state.isLoading = true;
},
[types.RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS](state, total) {
state.pageInfo.total = total;
},
[types.RECEIVE_DEPENDENCIES_PAGINATION_ERROR](state) {
state.isLoading = false;
state.errorLoading = true;
state.dependencies = [];
state.pageInfo = {};
state.reportInfo = {
status: REPORT_STATUS.ok,
jobPath: '',
};
state.initialized = true;
},
[types.REQUEST_DEPENDENCIES](state, { page }) {
[types.REQUEST_DEPENDENCIES](state) {
state.isLoading = true;
state.errorLoading = false;
state.pageInfo.page = page;
},
[types.RECEIVE_DEPENDENCIES_SUCCESS](state, { dependencies, reportInfo }) {
[types.RECEIVE_DEPENDENCIES_SUCCESS](state, { dependencies, reportInfo, pageInfo }) {
state.dependencies = dependencies;
state.pageInfo = pageInfo;
state.isLoading = false;
state.errorLoading = false;
state.reportInfo.status = reportInfo.status;
......
ee/app/assets/javascripts/dependencies/store/state.js
View file @ ea072b6b
import { REPORT_STATUS, SORT_FIELDS, SORT_ORDER, DEPENDENCIES_PER_PAGE } from './constants';
import { REPORT_STATUS, SORT_FIELDS, SORT_ORDER } from './constants';
export default () => ({
endpoint: '',
......@@ -6,11 +6,7 @@ export default () => ({
isLoading: false,
errorLoading: false,
dependencies: [],
pageInfo: {
page: 1,
perPage: DEPENDENCIES_PER_PAGE,
total: 0,
},
pageInfo: {},
reportInfo: {
status: REPORT_STATUS.ok,
jobPath: '',
......
ee/spec/frontend/dependencies/components/app_spec.js
View file @ ea072b6b
......@@ -22,7 +22,7 @@ describe('DependenciesApp component', () => {
const localVue = createLocalVue();
store = createStore();
jest.spyOn(store, 'dispatch').mockImplementation(() => Promise.resolve());
jest.spyOn(store, 'dispatch').mockImplementation();
wrapper = shallowMount(DependenciesApp, {
localVue,
......@@ -52,7 +52,6 @@ describe('DependenciesApp component', () => {
it('dispatches the correct initial actions', () => {
expect(store.dispatch.mock.calls).toEqual([
['setDependenciesEndpoint', basicAppProps.endpoint],
['fetchDependenciesPagination'],
['fetchDependencies'],
]);
});
......
ee/spec/frontend/dependencies/store/actions_spec.js
View file @ ea072b6b
......@@ -52,108 +52,15 @@ describe('Dependencies actions', () => {
));
});
describe('requestDependenciesPagination', () => {
it('commits the REQUEST_DEPENDENCIES_PAGINATION mutation', () =>
testAction(
actions.requestDependenciesPagination,
undefined,
getInitialState(),
[
{
type: types.REQUEST_DEPENDENCIES_PAGINATION,
},
],
[],
));
});
describe('receiveDependenciesPaginationSuccess', () => {
const total = 123;
it('commits the RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS mutation', () =>
testAction(
actions.receiveDependenciesPaginationSuccess,
total,
getInitialState(),
[
{
type: types.RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS,
payload: total,
},
],
[],
));
});
describe('receiveDependenciesPaginationError', () => {
it('commits the RECEIVE_DEPENDENCIES_PAGINATION_ERROR mutation', () =>
testAction(
actions.receiveDependenciesPaginationError,
undefined,
getInitialState(),
[
{
type: types.RECEIVE_DEPENDENCIES_PAGINATION_ERROR,
},
],
[],
));
});
describe('fetchDependenciesPagination', () => {
let mock;
let state;
beforeEach(() => {
state = getInitialState();
state.endpoint = `${TEST_HOST}/dependencies`;
mock = new MockAdapter(axios);
});
afterEach(() => {
mock.restore();
});
describe('on success', () => {
beforeEach(() => {
mock.onGet(state.endpoint).replyOnce(200, mockDependenciesResponse);
});
it('dispatches the correct actions', () =>
testAction(
actions.fetchDependenciesPagination,
undefined,
state,
[],
[
{
type: 'requestDependenciesPagination',
},
{
type: 'receiveDependenciesPaginationSuccess',
payload: mockDependenciesResponse.dependencies.length,
},
],
));
});
/**
* Tests for error conditions are in
* `ee/spec/javascripts/dependencies/store/actions_spec.js`. They cannot be
* tested here due to https://gitlab.com/gitlab-org/gitlab-ce/issues/63225.
*/
});
describe('requestDependencies', () => {
const page = 4;
it('commits the REQUEST_DEPENDENCIES mutation', () =>
testAction(
actions.requestDependencies,
{ page },
undefined,
getInitialState(),
[
{
type: types.REQUEST_DEPENDENCIES,
payload: { page },
},
],
[],
......@@ -227,11 +134,10 @@ describe('Dependencies actions', () => {
describe('on success', () => {
describe('given no params', () => {
let paramsDefault;
beforeEach(() => {
state.pageInfo = { ...pageInfo };
paramsDefault = {
const paramsDefault = {
sort_by: state.sortField,
sort: state.sortOrder,
page: state.pageInfo.page,
......@@ -251,7 +157,6 @@ describe('Dependencies actions', () => {
[
{
type: 'requestDependencies',
payload: { page: paramsDefault.page },
},
{
type: 'receiveDependenciesSuccess',
......@@ -279,7 +184,6 @@ describe('Dependencies actions', () => {
[
{
type: 'requestDependencies',
payload: { page: paramsGiven.page },
},
{
type: 'receiveDependenciesSuccess',
......@@ -295,9 +199,7 @@ describe('Dependencies actions', () => {
${'an invalid response'} | ${[200, { foo: 'bar' }]}
${'a response error'} | ${[500]}
`('given $responseType', ({ responseDetails }) => {
let page;
beforeEach(() => {
({ page } = state.pageInfo);
mock.onGet(state.endpoint).replyOnce(...responseDetails);
});
......@@ -310,7 +212,6 @@ describe('Dependencies actions', () => {
[
{
type: 'requestDependencies',
payload: { page },
},
{
type: 'receiveDependenciesError',
......
ee/spec/frontend/dependencies/store/mutations_spec.js
View file @ ea072b6b
......@@ -7,18 +7,6 @@ import { TEST_HOST } from 'helpers/test_constants';
describe('Dependencies mutations', () => {
let state;
const errorLoadingState = () => ({
isLoading: false,
errorLoading: true,
dependencies: [],
pageInfo: {},
initialized: true,
reportInfo: {
status: REPORT_STATUS.ok,
jobPath: '',
},
});
beforeEach(() => {
state = getInitialState();
});
......@@ -31,47 +19,14 @@ describe('Dependencies mutations', () => {
});
});
describe(types.REQUEST_DEPENDENCIES_PAGINATION, () => {
beforeEach(() => {
mutations[types.REQUEST_DEPENDENCIES_PAGINATION](state);
});
it('correctly mutates the state', () => {
expect(state.isLoading).toBe(true);
});
});
describe(types.RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS, () => {
const total = 123;
beforeEach(() => {
mutations[types.RECEIVE_DEPENDENCIES_PAGINATION_SUCCESS](state, total);
});
it('correctly mutates the state', () => {
expect(state.pageInfo.total).toBe(total);
});
});
describe(types.RECEIVE_DEPENDENCIES_PAGINATION_ERROR, () => {
beforeEach(() => {
mutations[types.RECEIVE_DEPENDENCIES_PAGINATION_ERROR](state);
});
it('correctly mutates the state', () => {
expect(state).toEqual(expect.objectContaining(errorLoadingState()));
});
});
describe(types.REQUEST_DEPENDENCIES, () => {
const page = 4;
beforeEach(() => {
mutations[types.REQUEST_DEPENDENCIES](state, { page });
mutations[types.REQUEST_DEPENDENCIES](state);
});
it('correctly mutates the state', () => {
expect(state.isLoading).toBe(true);
expect(state.errorLoading).toBe(false);
expect(state.pageInfo.page).toBe(page);
});
});
......@@ -82,27 +37,21 @@ describe('Dependencies mutations', () => {
status: REPORT_STATUS.jobFailed,
job_path: 'foo',
};
let originalPageInfo;
beforeEach(() => {
originalPageInfo = state.pageInfo;
mutations[types.RECEIVE_DEPENDENCIES_SUCCESS](state, { dependencies, reportInfo, pageInfo });
});
it('correctly mutates the state', () => {
expect(state).toEqual(
expect.objectContaining({
isLoading: false,
errorLoading: false,
dependencies,
pageInfo: originalPageInfo,
initialized: true,
reportInfo: {
status: REPORT_STATUS.jobFailed,
jobPath: 'foo',
},
}),
);
expect(state.isLoading).toBe(false);
expect(state.errorLoading).toBe(false);
expect(state.dependencies).toBe(dependencies);
expect(state.pageInfo).toBe(pageInfo);
expect(state.initialized).toBe(true);
expect(state.reportInfo).toEqual({
status: REPORT_STATUS.jobFailed,
jobPath: 'foo',
});
});
});
......@@ -112,7 +61,15 @@ describe('Dependencies mutations', () => {
});
it('correctly mutates the state', () => {
expect(state).toEqual(expect.objectContaining(errorLoadingState()));
expect(state.isLoading).toBe(false);
expect(state.errorLoading).toBe(true);
expect(state.dependencies).toEqual([]);
expect(state.pageInfo).toEqual({});
expect(state.initialized).toBe(true);
expect(state.reportInfo).toEqual({
status: REPORT_STATUS.ok,
jobPath: '',
});
});
});
......
ee/spec/javascripts/dependencies/store/actions_spec.js deleted 100644 → 0
View file @ 6c3bd9a1
import axios from 'axios';
import MockAdapter from 'axios-mock-adapter';
import testAction from 'spec/helpers/vuex_action_helper';
import { TEST_HOST } from 'spec/test_constants';
import actionsModule, * as actions from 'ee/dependencies/store/actions';
import getInitialState from 'ee/dependencies/store/state';
import { FETCH_ERROR_MESSAGE } from 'ee/dependencies/store/constants';
describe('Dependencies actions', () => {
/**
* This file only contains tests for failure conditions. Tests for success
* conditions are in `ee/spec/frontend/dependencies/store/actions_spec.js`.
* The split is due to https://gitlab.com/gitlab-org/gitlab-ce/issues/63225.
*/
describe('fetchDependenciesPagination', () => {
const failureScenarios = [
{
context: 'an invalid response',
endpoint: TEST_HOST,
responseDetails: [200, { foo: 'bar' }],
},
{
context: 'a response error',
endpoint: TEST_HOST,
responseDetails: [500],
},
{
context: 'no endpoint',
endpoint: '',
responseDetails: [],
},
];
failureScenarios.forEach(({ context, endpoint, responseDetails }) => {
describe(`given ${context}`, () => {
let state;
let flashSpy;
let mock;
beforeEach(() => {
mock = new MockAdapter(axios);
state = getInitialState();
flashSpy = spyOnDependency(actionsModule, 'createFlash');
state.endpoint = endpoint;
if (endpoint) {
mock.onGet(state.endpoint).replyOnce(...responseDetails);
}
});
afterEach(() => {
mock.restore();
});
it('dispatches the correct actions and creates a flash', done => {
testAction(
actions.fetchDependenciesPagination,
undefined,
state,
[],
[
{
type: 'requestDependenciesPagination',
},
{
type: 'receiveDependenciesPaginationError',
payload: jasmine.any(Error),
},
],
)
.then(done.fail)
.catch(() => {
expect(flashSpy).toHaveBeenCalledTimes(1);
expect(flashSpy).toHaveBeenCalledWith(FETCH_ERROR_MESSAGE);
done();
});
});
});
});
});
});
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7