diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-29 00:10:01 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-29 00:10:01 +0300 |
commit | 66e86bca7a31391e8ecf1ef84c7915ec70110c47 (patch) | |
tree | e07d28b1de6729832f38d1bcec908cebed6b7063 /app/assets/javascripts/releases | |
parent | 52e32e255f7d868c4ec952a201bb8813b5e03703 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'app/assets/javascripts/releases')
7 files changed, 204 insertions, 155 deletions
diff --git a/app/assets/javascripts/releases/queries/create_release.mutation.graphql b/app/assets/javascripts/releases/queries/create_release.mutation.graphql new file mode 100644 index 00000000000..56bfe7c23d6 --- /dev/null +++ b/app/assets/javascripts/releases/queries/create_release.mutation.graphql @@ -0,0 +1,10 @@ +mutation createRelease($input: ReleaseCreateInput!) { + releaseCreate(input: $input) { + release { + links { + selfUrl + } + } + errors + } +} diff --git a/app/assets/javascripts/releases/queries/create_release_link.mutation.graphql b/app/assets/javascripts/releases/queries/create_release_link.mutation.graphql new file mode 100644 index 00000000000..4bdfc79dbc4 --- /dev/null +++ b/app/assets/javascripts/releases/queries/create_release_link.mutation.graphql @@ -0,0 +1,5 @@ +mutation createReleaseAssetLink($input: ReleaseAssetLinkCreateInput!) { + releaseAssetLinkCreate(input: $input) { + errors + } +} diff --git a/app/assets/javascripts/releases/queries/delete_release_link.mutation.graphql b/app/assets/javascripts/releases/queries/delete_release_link.mutation.graphql new file mode 100644 index 00000000000..a75eddcd288 --- /dev/null +++ b/app/assets/javascripts/releases/queries/delete_release_link.mutation.graphql @@ -0,0 +1,5 @@ +mutation deleteReleaseAssetLink($input: ReleaseAssetLinkDeleteInput!) { + releaseAssetLinkDelete(input: $input) { + errors + } +} diff --git a/app/assets/javascripts/releases/queries/update_release.mutation.graphql b/app/assets/javascripts/releases/queries/update_release.mutation.graphql new file mode 100644 index 00000000000..9c6a861d2f1 --- /dev/null +++ b/app/assets/javascripts/releases/queries/update_release.mutation.graphql @@ -0,0 +1,5 @@ +mutation updateRelease($input: ReleaseUpdateInput!) { + releaseUpdate(input: $input) { + errors + } +} diff --git a/app/assets/javascripts/releases/stores/modules/edit_new/actions.js b/app/assets/javascripts/releases/stores/modules/edit_new/actions.js index 8dc2083dd2b..2c41ddb3e33 100644 --- a/app/assets/javascripts/releases/stores/modules/edit_new/actions.js +++ b/app/assets/javascripts/releases/stores/modules/edit_new/actions.js @@ -1,14 +1,12 @@ -import api from '~/api'; import { deprecatedCreateFlash as createFlash } from '~/flash'; import { redirectTo } from '~/lib/utils/url_utility'; import { s__ } from '~/locale'; -import oneReleaseQuery from '~/releases/queries/one_release.query.graphql'; -import { - releaseToApiJson, - apiJsonToRelease, - gqClient, - convertOneReleaseGraphQLResponse, -} from '~/releases/util'; +import createReleaseMutation from '~/releases/queries/create_release.mutation.graphql'; +import createReleaseAssetLinkMutation from '~/releases/queries/create_release_link.mutation.graphql'; +import deleteReleaseAssetLinkMutation from '~/releases/queries/delete_release_link.mutation.graphql'; +import oneReleaseForEditingQuery from '~/releases/queries/one_release_for_editing.query.graphql'; +import updateReleaseMutation from '~/releases/queries/update_release.mutation.graphql'; +import { gqClient, convertOneReleaseGraphQLResponse } from '~/releases/util'; import * as types from './mutation_types'; export const initializeRelease = ({ commit, dispatch, getters }) => { @@ -24,38 +22,25 @@ export const initializeRelease = ({ commit, dispatch, getters }) => { return Promise.resolve(); }; -export const fetchRelease = ({ commit, state, rootState }) => { +export const fetchRelease = async ({ commit, state }) => { commit(types.REQUEST_RELEASE); - if (rootState.featureFlags?.graphqlIndividualReleasePage) { - return gqClient - .query({ - query: oneReleaseQuery, - variables: { - fullPath: state.projectPath, - tagName: state.tagName, - }, - }) - .then((response) => { - const { data: release } = convertOneReleaseGraphQLResponse(response); - - commit(types.RECEIVE_RELEASE_SUCCESS, release); - }) - .catch((error) => { - commit(types.RECEIVE_RELEASE_ERROR, error); - createFlash(s__('Release|Something went wrong while getting the release details.')); - }); - } - - return api - .release(state.projectId, state.tagName) - .then(({ data }) => { - commit(types.RECEIVE_RELEASE_SUCCESS, apiJsonToRelease(data)); - }) - .catch((error) => { - commit(types.RECEIVE_RELEASE_ERROR, error); - createFlash(s__('Release|Something went wrong while getting the release details.')); + try { + const fetchResponse = await gqClient.query({ + query: oneReleaseForEditingQuery, + variables: { + fullPath: state.projectPath, + tagName: state.tagName, + }, }); + + const { data: release } = convertOneReleaseGraphQLResponse(fetchResponse); + + commit(types.RECEIVE_RELEASE_SUCCESS, release); + } catch (error) { + commit(types.RECEIVE_RELEASE_ERROR, error); + createFlash(s__('Release|Something went wrong while getting the release details.')); + } }; export const updateReleaseTagName = ({ commit }, tagName) => @@ -94,9 +79,9 @@ export const removeAssetLink = ({ commit }, linkIdToRemove) => { commit(types.REMOVE_ASSET_LINK, linkIdToRemove); }; -export const receiveSaveReleaseSuccess = ({ commit }, release) => { +export const receiveSaveReleaseSuccess = ({ commit }, urlToRedirectTo) => { commit(types.RECEIVE_SAVE_RELEASE_SUCCESS); - redirectTo(release._links.self); + redirectTo(urlToRedirectTo); }; export const saveRelease = ({ commit, dispatch, getters }) => { @@ -105,83 +90,130 @@ export const saveRelease = ({ commit, dispatch, getters }) => { dispatch(getters.isExistingRelease ? 'updateRelease' : 'createRelease'); }; -export const createRelease = ({ commit, dispatch, state, getters }) => { - const apiJson = releaseToApiJson( - { - ...state.release, - assets: { - links: getters.releaseLinksToCreate, - }, - }, - state.createFrom, - ); +/** + * Tests a GraphQL mutation response for the existence of any errors-as-data + * (See https://docs.gitlab.com/ee/development/fe_guide/graphql.html#errors-as-data). + * If any errors occurred, throw a JavaScript `Error` object, so that this can be + * handled by the global error handler. + * + * @param {Object} gqlResponse The response object returned by the GraphQL client + * @param {String} mutationName The name of the mutation that was executed + * @param {String} messageIfError An message to build into the error object if something went wrong + */ +const checkForErrorsAsData = (gqlResponse, mutationName, messageIfError) => { + const allErrors = gqlResponse.data[mutationName].errors; + if (allErrors.length > 0) { + const allErrorMessages = JSON.stringify(allErrors); + throw new Error(`${messageIfError}: ${allErrorMessages}`); + } +}; - return api - .createRelease(state.projectId, apiJson) - .then(({ data }) => { - dispatch('receiveSaveReleaseSuccess', apiJsonToRelease(data)); - }) - .catch((error) => { - commit(types.RECEIVE_SAVE_RELEASE_ERROR, error); - createFlash(s__('Release|Something went wrong while creating a new release')); +export const createRelease = async ({ commit, dispatch, state, getters }) => { + try { + const response = await gqClient.mutate({ + mutation: createReleaseMutation, + variables: getters.releaseCreateMutatationVariables, }); + + checkForErrorsAsData( + response, + 'releaseCreate', + `Something went wrong while creating a new release with projectPath "${state.projectPath}" and tagName "${state.release.tagName}"`, + ); + + dispatch('receiveSaveReleaseSuccess', response.data.releaseCreate.release.links.selfUrl); + } catch (error) { + commit(types.RECEIVE_SAVE_RELEASE_ERROR, error); + createFlash(s__('Release|Something went wrong while creating a new release.')); + } }; -export const updateRelease = ({ commit, dispatch, state, getters }) => { - const apiJson = releaseToApiJson({ - ...state.release, - assets: { - links: getters.releaseLinksToCreate, +/** + * Deletes a single release link. + * Throws an error if any network or validation errors occur. + */ +const deleteReleaseLinks = async ({ state, id }) => { + const deleteResponse = await gqClient.mutate({ + mutation: deleteReleaseAssetLinkMutation, + variables: { + input: { id }, }, }); - let updatedRelease = null; - - return ( - api - .updateRelease(state.projectId, state.tagName, apiJson) - - /** - * Currently, we delete all existing links and then - * recreate new ones on each edit. This is because the - * REST API doesn't support bulk updating of Release links, - * and updating individual links can lead to validation - * race conditions (in particular, the "URLs must be unique") - * constraint. - * - * This isn't ideal since this is no longer an atomic - * operation - parts of it can fail while others succeed, - * leaving the Release in an inconsistent state. - * - * This logic should be refactored to use GraphQL once - * https://gitlab.com/gitlab-org/gitlab/-/issues/208702 - * is closed. - */ - .then(({ data }) => { - // Save this response since we need it later in the Promise chain - updatedRelease = data; - - // Delete all links currently associated with this Release - return Promise.all( - getters.releaseLinksToDelete.map((l) => - api.deleteReleaseLink(state.projectId, state.release.tagName, l.id), - ), - ); - }) - .then(() => { - // Create a new link for each link in the form - return Promise.all( - apiJson.assets.links.map((l) => - api.createReleaseLink(state.projectId, state.release.tagName, l), - ), - ); - }) - .then(() => { - dispatch('receiveSaveReleaseSuccess', apiJsonToRelease(updatedRelease)); - }) - .catch((error) => { - commit(types.RECEIVE_SAVE_RELEASE_ERROR, error); - createFlash(s__('Release|Something went wrong while saving the release details')); - }) + checkForErrorsAsData( + deleteResponse, + 'releaseAssetLinkDelete', + `Something went wrong while deleting release asset link for release with projectPath "${state.projectPath}", tagName "${state.tagName}", and link id "${id}"`, ); }; + +/** + * Creates a single release link. + * Throws an error if any network or validation errors occur. + */ +const createReleaseLink = async ({ state, link }) => { + const createResponse = await gqClient.mutate({ + mutation: createReleaseAssetLinkMutation, + variables: { + input: { + projectPath: state.projectPath, + tagName: state.tagName, + name: link.name, + url: link.url, + linkType: link.linkType.toUpperCase(), + }, + }, + }); + + checkForErrorsAsData( + createResponse, + 'releaseAssetLinkCreate', + `Something went wrong while creating a release asset link for release with projectPath "${state.projectPath}" and tagName "${state.tagName}"`, + ); +}; + +export const updateRelease = async ({ commit, dispatch, state, getters }) => { + try { + /** + * Currently, we delete all existing links and then + * recreate new ones on each edit. This is because the + * backend doesn't support bulk updating of Release links, + * and updating individual links can lead to validation + * race conditions (in particular, the "URLs must be unique") + * constraint. + * + * This isn't ideal since this is no longer an atomic + * operation - parts of it can fail while others succeed, + * leaving the Release in an inconsistent state. + * + * This logic should be refactored to take place entirely + * in the backend. This is being discussed in + * https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50300 + */ + const updateReleaseResponse = await gqClient.mutate({ + mutation: updateReleaseMutation, + variables: getters.releaseUpdateMutatationVariables, + }); + + checkForErrorsAsData( + updateReleaseResponse, + 'releaseUpdate', + `Something went wrong while updating release with projectPath "${state.projectPath}" and tagName "${state.tagName}"`, + ); + + // Delete all links currently associated with this Release + await Promise.all( + getters.releaseLinksToDelete.map(({ id }) => deleteReleaseLinks({ state, id })), + ); + + // Create a new link for each link in the form + await Promise.all( + getters.releaseLinksToCreate.map((link) => createReleaseLink({ state, link })), + ); + + dispatch('receiveSaveReleaseSuccess', state.release._links.self); + } catch (error) { + commit(types.RECEIVE_SAVE_RELEASE_ERROR, error); + createFlash(s__('Release|Something went wrong while saving the release details.')); + } +}; diff --git a/app/assets/javascripts/releases/stores/modules/edit_new/getters.js b/app/assets/javascripts/releases/stores/modules/edit_new/getters.js index 831037c8861..d83ec05872a 100644 --- a/app/assets/javascripts/releases/stores/modules/edit_new/getters.js +++ b/app/assets/javascripts/releases/stores/modules/edit_new/getters.js @@ -103,3 +103,39 @@ export const isValid = (_state, getters) => { const errors = getters.validationErrors; return Object.values(errors.assets.links).every(isEmpty) && !errors.isTagNameEmpty; }; + +/** Returns all the variables for a `releaseUpdate` GraphQL mutation */ +export const releaseUpdateMutatationVariables = (state) => { + const name = state.release.name?.trim().length > 0 ? state.release.name.trim() : null; + + // Milestones may be either a list of milestone objects OR just a list + // of milestone titles. The GraphQL mutation requires only the titles be sent. + const milestones = (state.release.milestones || []).map((m) => m.title || m); + + return { + input: { + projectPath: state.projectPath, + tagName: state.release.tagName, + name, + description: state.release.description, + milestones, + }, + }; +}; + +/** Returns all the variables for a `releaseCreate` GraphQL mutation */ +export const releaseCreateMutatationVariables = (state, getters) => { + return { + input: { + ...getters.releaseUpdateMutatationVariables.input, + ref: state.createFrom, + assets: { + links: getters.releaseLinksToCreate.map(({ name, url, linkType }) => ({ + name, + url, + linkType: linkType.toUpperCase(), + })), + }, + }, + }; +}; diff --git a/app/assets/javascripts/releases/util.js b/app/assets/javascripts/releases/util.js index 44d177bc260..22d5fb4f620 100644 --- a/app/assets/javascripts/releases/util.js +++ b/app/assets/javascripts/releases/util.js @@ -1,50 +1,7 @@ import { pick } from 'lodash'; import createGqClient, { fetchPolicies } from '~/lib/graphql'; -import { - convertObjectPropsToCamelCase, - convertObjectPropsToSnakeCase, -} from '~/lib/utils/common_utils'; import { truncateSha } from '~/lib/utils/text_utility'; -/** - * Converts a release object into a JSON object that can sent to the public - * API to create or update a release. - * @param {Object} release The release object to convert - * @param {string} createFrom The ref to create a new tag from, if necessary - */ -export const releaseToApiJson = (release, createFrom = null) => { - const name = release.name?.trim().length > 0 ? release.name.trim() : null; - - // Milestones may be either a list of milestone objects OR just a list - // of milestone titles. The API requires only the titles be sent. - const milestones = (release.milestones || []).map((m) => m.title || m); - - return convertObjectPropsToSnakeCase( - { - name, - tagName: release.tagName, - ref: createFrom, - description: release.description, - milestones, - assets: release.assets, - }, - { deep: true }, - ); -}; - -/** - * Converts a JSON release object returned by the Release API - * into the structure this Vue application can work with. - * @param {Object} json The JSON object received from the release API - */ -export const apiJsonToRelease = (json) => { - const release = convertObjectPropsToCamelCase(json, { deep: true }); - - release.milestones = release.milestones || []; - - return release; -}; - export const gqClient = createGqClient({}, { fetchPolicy: fetchPolicies.NO_CACHE }); const convertScalarProperties = (graphQLRelease) => @@ -125,8 +82,7 @@ const convertMilestones = (graphQLRelease) => ({ /** * Converts a single release object fetched from GraphQL - * into a release object that matches the shape of the REST API - * (the same shape that is returned by `apiJsonToRelease` above.) + * into a release object that matches the general structure of the REST API * * @param graphQLRelease The release object returned from a GraphQL query */ |