2019-10-24 01:06:54 +08:00
|
|
|
import Controller from "@ember/controller";
|
2016-06-16 01:49:57 +08:00
|
|
|
import { ajax } from "discourse/lib/ajax";
|
DEV: Remove usage of {{action}} modifiers - Take 2 (#18476)
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
2022-10-05 20:08:54 +08:00
|
|
|
import { action } from "@ember/object";
|
2019-10-31 04:28:29 +08:00
|
|
|
import { alias } from "@ember/object/computed";
|
2019-11-08 05:38:28 +08:00
|
|
|
import discourseComputed from "discourse-common/utils/decorators";
|
2016-06-16 01:49:57 +08:00
|
|
|
import { popupAjaxError } from "discourse/lib/ajax-error";
|
|
|
|
|
|
2019-10-24 01:06:54 +08:00
|
|
|
export default Controller.extend({
|
2016-09-14 07:54:53 +08:00
|
|
|
pingDisabled: false,
|
2019-10-31 04:28:29 +08:00
|
|
|
incomingCount: alias("incomingEventIds.length"),
|
2016-09-14 07:54:53 +08:00
|
|
|
|
2019-05-28 18:15:12 +08:00
|
|
|
init() {
|
|
|
|
|
this._super(...arguments);
|
|
|
|
|
|
|
|
|
|
this.incomingEventIds = [];
|
|
|
|
|
},
|
|
|
|
|
|
2019-11-08 05:38:28 +08:00
|
|
|
@discourseComputed("incomingCount")
|
2016-09-14 07:54:53 +08:00
|
|
|
hasIncoming(incomingCount) {
|
|
|
|
|
return incomingCount > 0;
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
subscribe() {
|
|
|
|
|
this.messageBus.subscribe(
|
|
|
|
|
`/web_hook_events/${this.get("model.extras.web_hook_id")}`,
|
|
|
|
|
(data) => {
|
|
|
|
|
if (data.event_type === "ping") {
|
|
|
|
|
this.set("pingDisabled", false);
|
2018-06-15 23:03:24 +08:00
|
|
|
}
|
2016-09-14 07:54:53 +08:00
|
|
|
this._addIncoming(data.web_hook_event_id);
|
|
|
|
|
}
|
|
|
|
|
);
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
unsubscribe() {
|
|
|
|
|
this.messageBus.unsubscribe("/web_hook_events/*");
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
_addIncoming(eventId) {
|
2019-05-27 16:15:39 +08:00
|
|
|
const incomingEventIds = this.incomingEventIds;
|
2016-09-14 07:54:53 +08:00
|
|
|
|
2022-07-18 02:48:36 +08:00
|
|
|
if (!incomingEventIds.includes(eventId)) {
|
2016-09-14 07:54:53 +08:00
|
|
|
incomingEventIds.pushObject(eventId);
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
|
DEV: Remove usage of {{action}} modifiers - Take 2 (#18476)
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
2022-10-05 20:08:54 +08:00
|
|
|
@action
|
|
|
|
|
showInserted(event) {
|
|
|
|
|
event?.preventDefault();
|
|
|
|
|
const webHookId = this.get("model.extras.web_hook_id");
|
|
|
|
|
|
|
|
|
|
ajax(`/admin/api/web_hooks/${webHookId}/events/bulk`, {
|
|
|
|
|
type: "GET",
|
|
|
|
|
data: { ids: this.incomingEventIds },
|
|
|
|
|
}).then((data) => {
|
|
|
|
|
const objects = data.map((webHookEvent) =>
|
|
|
|
|
this.store.createRecord("web-hook-event", webHookEvent)
|
|
|
|
|
);
|
|
|
|
|
this.model.unshiftObjects(objects);
|
|
|
|
|
this.set("incomingEventIds", []);
|
|
|
|
|
});
|
|
|
|
|
},
|
|
|
|
|
|
2016-06-16 01:49:57 +08:00
|
|
|
actions: {
|
|
|
|
|
loadMore() {
|
2019-05-27 16:15:39 +08:00
|
|
|
this.model.loadMore();
|
2016-06-16 01:49:57 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
ping() {
|
2016-09-14 07:54:53 +08:00
|
|
|
this.set("pingDisabled", true);
|
|
|
|
|
|
2016-09-19 16:43:06 +08:00
|
|
|
ajax(
|
|
|
|
|
`/admin/api/web_hooks/${this.get("model.extras.web_hook_id")}/ping`,
|
|
|
|
|
{
|
2016-09-14 07:54:53 +08:00
|
|
|
type: "POST",
|
|
|
|
|
}
|
|
|
|
|
).catch((error) => {
|
|
|
|
|
this.set("pingDisabled", false);
|
|
|
|
|
popupAjaxError(error);
|
|
|
|
|
});
|
|
|
|
|
},
|
2016-06-16 01:49:57 +08:00
|
|
|
},
|
|
|
|
|
});
|