mirror of
https://github.com/discourse/discourse.git
synced 2025-02-09 04:44:59 +00:00
This PR enables the [`no-action-modifiers`](https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-action-modifiers.md) template lint rule and removes all usages of the `{{action}}` modifier in core. In general, instances of `{{action "x"}}` have been replaced with `{{on "click" (action "x")}}`. In many cases, such as for `a` elements, we also need to prevent default event handling to avoid unwanted side effects. While the `{{action}}` modifier internally calls `event.preventDefault()`, we need to handle these cases more explicitly. For this purpose, this PR also adds the [ember-event-helpers](https://github.com/buschtoens/ember-event-helpers) dependency so we can use the `prevent-default` handler. For instance: ``` <a href {{on "click" (prevent-default (action "x"))}}>Do X</a> ``` Note that `action` has not in general been refactored away as a helper yet. In general, all event handlers should be methods on the corresponding component and referenced directly (e.g. `{{on "click" this.doSomething}}`). However, the `action` helper is used extensively throughout the codebase and often references methods in the `actions` hash on controllers or routes. Thus this refactor will also be extensive and probably deserves a separate PR. Note: This work was done to complement #17767 by minimizing the potential impact of the `action` modifier override, which uses private API and arguably should be replaced with an AST transform. This is a followup to #18333, which had to be reverted because it did not account for the default treatment of modifier keys by the {{action}} modifier. Commits: * Enable `no-action-modifiers` template lint rule * Replace {{action "x"}} with {{on "click" (action "x")}} * Remove unnecessary action helper usage * Remove ctl+click tests for user-menu These tests now break in Chrome when used with addEventListener. As per the comment, they can probably be safely removed. * Prevent default event handlers to avoid unwanted side effects Uses `event.preventDefault()` in event handlers to prevent default event handling. This had been done automatically by the `action` modifier, but is not always desirable or necessary. * Restore UserCardContents#showUser action to avoid regression By keeping the `showUser` action, we can avoid a breaking change for plugins that rely upon it, while not interfering with the `showUser` argument that's been passed. * Revert EditCategoryTab#selectTab -> EditCategoryTab#select Avoid potential breaking change in themes / plugins * Restore GroupCardContents#showGroup action to avoid regression By keeping the `showGroup` action, we can avoid a breaking change for plugins that rely upon it, while not interfering with the `showGroup` argument that's been passed. * Restore SecondFactorAddTotp#showSecondFactorKey action to avoid regression By keeping the `showSecondFactorKey` action, we can avoid a breaking change for plugins that rely upon it, while not interfering with the `showSecondFactorKey` property that's maintained on the controller. * Refactor away from `actions` hash in ChooseMessage component * Modernize EmojiPicker#onCategorySelection usage * Modernize SearchResultEntry#logClick usage * Modernize Discovery::Categories#showInserted usage * Modernize Preferences::Account#resendConfirmationEmail usage * Modernize MultiSelect::SelectedCategory#onSelectedNameClick usage * Favor fn over action in SelectedChoice component * Modernize WizardStep event handlers * Favor fn over action usage in buttons * Restore Login#forgotPassword action to avoid possible regression * Introduce modKeysPressed utility Returns an array of modifier keys that are pressed during a given `MouseEvent` or `KeyboardEvent`. * Don't interfere with click events on links with `href` values when modifier keys are pressed
151 lines
3.6 KiB
JavaScript
151 lines
3.6 KiB
JavaScript
import Controller from "@ember/controller";
|
|
import EmberObject, { action } from "@ember/object";
|
|
import I18n from "I18n";
|
|
import discourseComputed from "discourse-common/utils/decorators";
|
|
import { exportEntity } from "discourse/lib/export-csv";
|
|
import { outputExportResult } from "discourse/lib/export-result";
|
|
import { scheduleOnce } from "@ember/runloop";
|
|
|
|
export default Controller.extend({
|
|
queryParams: ["filters"],
|
|
|
|
model: null,
|
|
filters: null,
|
|
userHistoryActions: null,
|
|
|
|
@discourseComputed("filters.action_name")
|
|
actionFilter(name) {
|
|
return name ? I18n.t("admin.logs.staff_actions.actions." + name) : null;
|
|
},
|
|
|
|
@discourseComputed("filters")
|
|
filtersExists(filters) {
|
|
return filters && Object.keys(filters).length > 0;
|
|
},
|
|
|
|
_refresh() {
|
|
this.store.findAll("staff-action-log", this.filters).then((result) => {
|
|
this.set("model", result);
|
|
|
|
if (!this.userHistoryActions) {
|
|
this.set(
|
|
"userHistoryActions",
|
|
result.extras.user_history_actions
|
|
.map((historyAction) => ({
|
|
id: historyAction.id,
|
|
action_id: historyAction.action_id,
|
|
name: I18n.t(
|
|
"admin.logs.staff_actions.actions." + historyAction.id
|
|
),
|
|
name_raw: historyAction.id,
|
|
}))
|
|
.sort((a, b) => a.name.localeCompare(b.name))
|
|
);
|
|
}
|
|
});
|
|
},
|
|
|
|
scheduleRefresh() {
|
|
scheduleOnce("afterRender", this, this._refresh);
|
|
},
|
|
|
|
resetFilters() {
|
|
this.setProperties({
|
|
model: EmberObject.create({ loadingMore: true }),
|
|
filters: EmberObject.create(),
|
|
});
|
|
this.scheduleRefresh();
|
|
},
|
|
|
|
changeFilters(props) {
|
|
this.set("model", EmberObject.create({ loadingMore: true }));
|
|
|
|
if (!this.filters) {
|
|
this.set("filters", EmberObject.create());
|
|
}
|
|
|
|
Object.keys(props).forEach((key) => {
|
|
if (props[key] === undefined || props[key] === null) {
|
|
this.filters.set(key, undefined);
|
|
delete this.filters[key];
|
|
} else {
|
|
this.filters.set(key, props[key]);
|
|
}
|
|
});
|
|
|
|
this.send("onFiltersChange", this.filters);
|
|
this.scheduleRefresh();
|
|
},
|
|
|
|
@action
|
|
filterActionIdChanged(filterActionId) {
|
|
if (filterActionId) {
|
|
this.changeFilters({
|
|
action_name: filterActionId,
|
|
action_id: this.userHistoryActions.findBy("id", filterActionId)
|
|
.action_id,
|
|
});
|
|
}
|
|
},
|
|
|
|
@action
|
|
clearFilter(key, event) {
|
|
event?.preventDefault();
|
|
if (key === "actionFilter") {
|
|
this.set("filterActionId", null);
|
|
this.changeFilters({
|
|
action_name: null,
|
|
action_id: null,
|
|
custom_type: null,
|
|
});
|
|
} else {
|
|
this.changeFilters({ [key]: null });
|
|
}
|
|
},
|
|
|
|
@action
|
|
clearAllFilters(event) {
|
|
event?.preventDefault();
|
|
this.set("filterActionId", null);
|
|
this.resetFilters();
|
|
},
|
|
|
|
@action
|
|
filterByAction(logItem, event) {
|
|
event?.preventDefault();
|
|
this.changeFilters({
|
|
action_name: logItem.get("action_name"),
|
|
action_id: logItem.get("action"),
|
|
custom_type: logItem.get("custom_type"),
|
|
});
|
|
},
|
|
|
|
@action
|
|
filterByStaffUser(acting_user, event) {
|
|
event?.preventDefault();
|
|
this.changeFilters({ acting_user: acting_user.username });
|
|
},
|
|
|
|
@action
|
|
filterByTargetUser(target_user, event) {
|
|
event?.preventDefault();
|
|
this.changeFilters({ target_user: target_user.username });
|
|
},
|
|
|
|
@action
|
|
filterBySubject(subject, event) {
|
|
event?.preventDefault();
|
|
this.changeFilters({ subject });
|
|
},
|
|
|
|
@action
|
|
exportStaffActionLogs() {
|
|
exportEntity("staff_action").then(outputExportResult);
|
|
},
|
|
|
|
@action
|
|
loadMore() {
|
|
this.model.loadMore();
|
|
},
|
|
});
|