marionettejs/backbone.radio

Automated cleanup of Commands and Requests?

Open

#117 opened on Jul 29, 2014

View on GitHub
 (22 comments) (0 reactions) (1 assignee)JavaScript (53 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (494 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

See: http://backbonejs.org/#Events-listenTo

In the case of Backbone's eventing system, listeners are registered on objects and cleaned up automatically on destruction. Such a feature would be a really nice addition to Backbone.Radio, removing the work involved in managing clean-up of every registered event, command, and request handler.

For example, in a view that needs to exchange information with a flash player:

var SomeView = Backbone.View.extend({
  initialize: function() {
    var flashChannel = Backbone.Radio.channel('flash');

    this.listenTo(flashChannel, 'tick', this.onTick);
    this.comply(flashChannel, 'play', this.play);
    this.reply(flashChannel, 'currentTime', this.currentTime);
  },
  onTick: ...
  play: ...
  currentTime: ...
});

If it simplifies matters, perhaps when needing to hand a channel in as an argument the functions can be given new names that indicate the intention to register them for later destruction - complyWith and replyTo, to go along with listenTo.

Lastly, we could wrap the remove function to include stopComplying and stopReplying functions, in addition to stopListening.

Thoughts?

Contributor guide

Research direction
Examine the current implementation of `comply`, `reply`, and `stopListening` in Backbone.Radio. Propose a design to add `complyWith` and `replyTo` methods that automatically clean up when the listener's object is destroyed, similar to Backbone's `listenTo`. Consider wrapping the `remove` function to include cleanup of commands and requests.
Tech stack
javascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptBackbone.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50