ember-lifeline

ember-lifeline

Ember applications have long life-cycles. A user may navigate to several pages and use many different features before they leave the application. This makes JavaScript and Ember development unlike Rails development, where the lifecycle of a request is short and the environment disposed of after each request. It makes Ember development much more like iOS or video game development than traditional server-side web development.

This addon introduces several functional utility methods to help manage async, object lifecycles, and the Ember runloop. These tools should provide a simple developer experience that allows engineers to focus on the business domain, and think less about the weird parts of working in a long-lived app.

The documentation wiki contains more examples and API information.

Compatibility

• Ember.js v3.28 or above
• Ember CLI v3.28 or above
• Node.js v16 or above

Installation

ember install ember-lifeline

Usage

Ember Lifeline supports a functional API that enables entanglement - the association of async behavior to object instances. This allows you to write async code in your classes that can be automatically cleaned up for you when the object is destroyed.

Ember's runloop functions, like the example below, don't ensure that an object's async is cleaned up.

import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { run } from '@ember/runloop';

export default class Example extends Component {
  @tracked date;
  
  constructor() {
    super(...arguments);

    run.later(() => {
      this.date = new Date();
    }, 500);
  }
}

Using ember-lifeline's equivalent, in this case runTask, can help ensure that any active async is cleaned up once the object is destroyed.

import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { runTask } from 'ember-lifeline';

export default class Example extends Component {
  @tracked date;
  
  constructor() {
    super(...arguments);

    runTask(
      this,
      () => {
        this.date = new Date();
      },
      500
    );
  }
}

For more information and examples, please visit the documentation wiki.

Contributing

See the Contributing guide for details.

Credit

This addon was developed internally at Twitch, written originally by @mixonic and @rwjblue. It's since been further developed and maintained by scalvert.

The name ember-lifeline was suggested by @nathanhammod.

Changelog

v7.0.0 (2023-05-05)

:boom: Breaking Change

• ember-lifeline, test-app
  • #1174 Ember 4 Upgrade (@elwayman02)
  • #1141 Removed setup-lifeline-validation test util as it is no longer required. (@tgvrssanthosh)
• ember-lifeline
  • #1117 Renaming types and defaulting to Ember types (@scalvert)

:rocket: Enhancement

• ember-lifeline, test-app
  • #1140 Created timer util that returns a scaled-down timer value in test environments. (@tgvrssanthosh)

:memo: Documentation

• ember-lifeline, test-app
  • #1119 Adds missing cancel* docs (@scalvert)
• ember-lifeline
  • #1118 Updates jsdoc strings to represent Octane components (@scalvert)

:house: Internal

• ember-lifeline, test-app
  • #1174 Ember 4 Upgrade (@elwayman02)
• test-app
  • #1144 Renamed timer-test file (@tgvrssanthosh)
• ember-lifeline
  • #1107 Extracting utils from run-task (@scalvert)

Committers: 4

• Chris Krycho (@chriskrycho)
• Jordan Hawker (@elwayman02)
• Santhosh Venkata Rama Siva Thanakala Gani (@tgvrssanthosh)
• Steve Calvert (@scalvert)