Skip to content

Remove actions that only commit from Vuex guide (docs)

Inactive Account requested to merge winh-vuex-action-pattern-docs into master

What does this MR do?

Remove synchronous actions like

export const requestUsers = ({ commit }) => commit(types.REQUEST_USERS);

and commit() the mutation directly from the asynchronous action.

The old pattern required us to create three synchronous actions for every asynchronous action along with unit tests for those. This increases the amount of code for each asynchronous operation to almost twice as much without a clear benefit.

In general more code means

Additionally, the old pattern was not following the example from the Vuex documentation (https://vuex.vuejs.org/guide/actions.html#dispatching-actions) and also not corresponding to the Redux pattern that had inspired it (https://gitlab.com/gitlab-org/gitlab-ce/issues/53338#note_171193876).

Related issues

closes https://gitlab.com/gitlab-org/gitlab-ce/issues/53338

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Inactive Account

Merge request reports