Octane Tracking Issue #17234

MelSumner · 2018-11-28T04:18:54Z

Summary

The purpose of this issue is to provide an overall issue to track the status of the work necessary to ship the Octane Edition of Ember.js.

If anyone wants to work on any of the items in this list, please check in the #st-octane channel of our Discord chat first.

The following to-do list will be updated to include links to individual issues as they are created. The issues themselves will contain more details for each item on this list.

Goals from Roadmap RFC

Finish What We Started (Part 1 of 2)

As per the 2018 Roadmap RFC, there is commitment and focus to finishing the things we've already started.

Broccoli 2.0 in ember-cli
~~Module Unification [Tracking Issue]~~ - De-scoped from this edition as per https://blog.emberjs.com/2019/03/11/update-on-module-unification-and-octane.html
Glimmer Components as the default component API
Native JavaScript Classes as the default object model
~~Native JavaScript modules~~ - De-scoped from this edition
- exposing modules in the build pipeline
- publishing Ember as npm packages
- importing npm packages

Octane Edition Features (Part 2 of 2)

As per the roadmap RFC, these are the goals for the Octane edition; however it should be noted that
"the final timeline and feature set of Ember Octane will be determined by the core teams and are not set in stone in this RFC."

No jQuery by default
~~Svelte Builds~~ (moved to next edition)
Native JavaScript Classes
Glimmer components
~~Incremental rendering and rehydration~~ (moved to next edition)
~~Treeshaking~~ (moved to next edition)
Eliminating the runloop (removing the need for developers to use Ember.run)
~~Stabilizing Ember Data~~ (moved to next edition)

Practical Implementation of Roadmap RFC

Decorators

Core Team Champion: Tom Dale | Status: completed 🎉

RFC Decorators rfcs#408
- Supplemental RFC - Decorator support - [RFC #440]
Implementation
Documentation
enable feature flag
- ember-cli-babel needs to transpile them by default

Glimmer Components (as the default component API)

Core Team Champion: Tom Dale | Status: completed 🎉

RFC Glimmer Components rfcs#416
Implementation [PR]
Documentation (PR'd to Octane guides)

Tracked Properties

Core Team Champion: Tom Dale | Status: completed 🎉

Element Modifiers

Core Team Champion: Tom Dale | Status: completed 🎉

Editions

Core Team Champion: @tomdale | Status: on track ✅

Remove jQuery by Default

Core Team Champion: Robert Jackson (@rwjblue) | Status: completed 🎉

Native JS Classes

Core Team Champion: Robert Jackson | Status: completed 🎉

Broccoli 2.0

Core Team Champion: Robert Jackson (@rwjblue) | Status: on track ✅

Implementation
Documentation
- Broccoli website for more in-depth guides (@oligriffiths - https://broccoli.build/)
- Broccoli basics added to Ember guides [Tracking issue] (in-progress, @oligriffiths)

Ember Guides Updates

Core Team Champion: Jen Weber (@jenweber) | Status: on track ✅

RFC to update the table of contents [RFC #431]
Current Guides Analysis [Project]
Update guides to use Angle Bracket invocation [tracking issue]
Octane preview guides MVP [tracking issue]
Switch to built-in components on Octane branch [tracking issue]
Octane stable release Guides MVP quest issue
Octane Components Guide (v2) tracking issue @wycats

Website Re-design

Core Team Champion: Leah Silber (@wifelette) & Mel Sumner (@MelSumner) | Status: delayed

RFC Website Redesign RFC rfcs#425
Implementation (goal: August 2019) Repo: ember-styleguide - want to help? Ping in #dev-ember-learning channel in Discord.
Documentation (update ember-learn/handbook)

Scope Creep

These are new items that we discovered were necessary to add while implementing Octane features.

`on` modifier

Core Team Champion: Robert Jackson (@rwjblue) | Status: completed 🎉

RFC {{on}} Modifier rfcs#471 [tracking issue]
Implementation (polyfill complete, implementation in Ember in-progress)
Documentation (@pzuraq )

`fn` helper

Core Team Champion: Robert Jackson (@rwjblue) | Status: completed 🎉

RFC {{fn}} Helper rfcs#470 [tracking issue]
Implementation (polyfill in-progress)
Documentation (@pzuraq )

Injection Parameter Normalization (owner tunnel/class portal)

Core Team Champion: Robert Jackson (@rwjblue) | Status: completed 🎉

RFC Injection Parameter Normalization rfcs#451 [tracking issue]
Implementation (in-progress, PR [FEATURE] Implement injection parameter normalization RFC. #17858)
Documentation

`@classic` decorator

Core Team Champion: Robert Jackson (@rwjblue) | Status: on track

RFC @classic Decorator rfcs#468
Implementation (will be an addon)
Documentation (WIP being documented in Ember Atlas instead of official guides) (@pzuraq )

Ember Inspector

[Tracking Issue]

Supporting TODOs

Contextual Helpers and Modifiers RFC (FCP - 1/25/19](Contextual Helpers and Modifiers (a.k.a. "first-class helpers/modifiers") rfcs#432) (@chancancode)
Implementation: Octane Blueprint for ember-cli
- Addon MVP - https://github.com/NullVoxPopuli/ember-octane-blueprint
- move addon to ember-cli org (@NullVoxPopuli) (https://github.com/ember-cli/ember-octane-blueprint)
Documentation: CLI optional feature flags introduced by new features in Octane edition (documented in regular guides, not CLI guides)
(optimization) Guarding the optional feature flags for file size savings

Stretch Goals/De-scoped items

These are items that were de-scoped from Octane and are now being tracked as stretch goals.

Project Management

Details

Upgrading Apps to Octane

Required

Dependencies

ember-source@3.??.0
ember-data@3.??.0

Optional Features

application-template-wrapper to false
jquery-integration to false
template-only-glimmer-components to true

`.ember-cli`

Default ember generate component to include (per RFC #481):
- --no-component-class
- --component-structure=flat

Optional / Incremental

Migrate Ember components to Glimmer components
Migrate from EmberObject.extend() to native classes
Migrate from computed properties to tracked properties

Final Checklist

Add Octane blueprint as the default to ember-cli (once it's determined that it works as intended)
Publish blog post & include: render modifiers clarification, codemods, upgrade guides
Remove blueprint references from the Guides and tutorial
Merge guides into master

The text was updated successfully, but these errors were encountered:

tomdale · 2018-12-04T20:50:30Z

@MelSumner We should track the build pipeline improvements in https://github.com/embroider-build/embroider as well.

oligriffiths · 2018-12-05T15:10:20Z

@MelSumner https://broccoli.build and https://github.com/broccolijs/broccolijs.github.io for the new broccoli site and docs

knownasilya · 2018-12-06T16:55:06Z

Tracked properties RFC can be checked off and link updated.

tomdale · 2018-12-11T19:16:17Z

We talked about auditing what gets included in the default app blueprint. See related issues:

rwjblue · 2018-12-11T20:39:53Z

FWIW, @tomdale that seems quite orthogonal to the Octane Edition to me (not saying we shouldn't be more careful and have better checks/balances, just that its not related to octane at all)...

mike-north · 2018-12-11T21:14:52Z

its not related to octane at all

My reasoning for bringing this up recently is that a default blueprint that supports multiple programming models (i.e., a future default octane blueprint) may include extra cruft that a pure "classic" app or pure "octane" app doesn't need at all.

If we can validate that this is not a concern, I agree that this isn't very closely related to octane

NullVoxPopuli · 2018-12-11T21:39:50Z

imo, the octane blueprint, https://github.com/ember-cli/ember-octane-blueprint should be the ideal brand new / shiny app. I don't think the old programming model should be involved in the blueprint. :-\

rwjblue · 2018-12-23T16:05:40Z

@MelSumner - I think we need to get some MU related things here in this checklist (I don't spot any, but AFAICT MU is still considered part of the octane feature set...).

gossi · 2018-12-23T18:41:50Z

It's already been called Octane layout instead of MU layout ... and the more I think about it the more it makes sense!

MelSumner · 2019-01-02T20:36:43Z

@MelSumner - I think we need to get some MU related things here in this checklist (I don't spot any, but AFAICT MU is still considered part of the octane feature set...).

@rwjblue we linked to the MU quest issue in the first section- "Finish What We Started" - is there more that you think we should track?

gossi · 2019-01-07T15:14:33Z

Regarding ember-cli-create I put this issue together: ember-cli/ember-cli#8343. Depending on how much of the embroider spec will be implemented as part of octane (= publication format), the issue I linked is mainly speaking about the authoring format which can be complementary to the publishing format.

Personally, I wouldn't see ember-cli-create as part of octane while the authoring format could be (which basically sets the foundation for ember-cli-create).

Let me know, if that would make a good addition or better postpone it to post-octane release or how I can help with that.

NullVoxPopuli · 2019-01-09T11:09:03Z

octane blueprint > move addon to ember-cli org can be checked off :)

jenweber · 2019-01-12T02:33:59Z

Update, here's a quest issue for tracking the Angle Brackets conversion in the guides ember-learn/guides-source#139

simonihmig · 2019-01-12T12:07:16Z

The Remove jQuery RFC can be checked off! ✅
I also created a tracking issue, which we can link to maybe: #17476

mike-north · 2019-01-15T20:17:16Z

User story around feature flags and optional features, as it pertains to the octane blueprint

As a workshop instructor, I need to know the default values for various optional/feature flags in the octane blueprint, in order to understand concretely what my students will get when they run ember new, and build material around ember new that remains valid over a significant period of time.

rwjblue · 2019-01-29T14:38:28Z

FYI - I just published @ember/render-modifiers 1.0.0 with support back to Ember 2.12 (by way of ember-modifier-manager-polyfill). There is still a bit of work to do (need tons more documentation), but its a good start...

ppcano · 2019-02-01T21:50:50Z

@MelSumner I will work on the Native JS Classes blueprints.

mike-north · 2019-02-02T02:58:10Z

Has anyone put thought into what should happen for https://github.com/ember-cli/ember-new-output in the Classic+Octane world?

rwjblue · 2019-02-03T03:01:14Z

The output in that repo will match the output of ember new, which according to our current plans will change to octane blueprint “when it’s ready”.

michaelrkn · 2019-02-03T17:57:53Z

It looks like module unification is missing from the "Practical Implementation of Roadmap RFC" section.

MelSumner · 2019-02-04T16:37:43Z

It looks like module unification is missing from the "Practical Implementation of Roadmap RFC" section.

I believe that Template Imports are the major piece that hasn't shipped yet, so that's the bit that we're tracking in this issue. Does that help, @michaelrkn ?

michaelrkn · 2019-02-04T23:19:56Z

@MelSumner Got it, thanks!

simonihmig · 2019-02-08T09:53:48Z

Hey everybody, the implementation of the "Remove jQuery" RFC is mostly done (at least as far as the first Ember 3.x stage is concerned, see #17476). What's still open and blocking the (default, non-octane) blueprints to switch to no jQuery by default is the built-in ability of ember-data to work with fetch instead of $.ajax (without having to apply the ember-data patch mixin), see the WIP PR: emberjs/data#5386.

Just to let you know... maybe this should be addressed at one of the next core team meetings, to help bring this over the finish line?

NullVoxPopuli · 2019-02-08T13:56:43Z

a couple things related to ember-cli that I would like to be added to the list:

addons need some hooks for installing custom types, for example

moduleConfig.collections = Object.assign(moduleConfig.collections, {
  // ember-simple-auth
  authenticators: {
    types: ['authenticator'],
    defaultType: 'authenticator'
  }
});

(the above, courtesy of @sly7-7 :D )
and

moduleConfig.types = Object.assign(moduleConfig.types, {
  // ember-intl
  'ember-intl@adapter': { definitiveCollection: 'main' },
  'ember-intl@translation': { definitiveCollection: 'main' },
  translation: { definitiveCollection: 'main' },
  formats: { definitiveCollection: 'main' },
  cldr: { definitiveCollection: 'main' },
  'util:intl': { definitiveCollection: 'utils' },
  'intl:util': { definitiveCollection: 'utils' },

  // ember-gestures
  'ember-gesture': { definitiveCollection: 'main' },
});

and then the other thing also related to ember-cli is supporting multiple dummy apps.
So far we have some design proposals here:

Also, not sure how to track this, but with @miguelcobain 's ember-paper library, I'd like to coordinate with getting the octane setup process super simple (currently it's not simple to use ember-paper in octane apps)

octane / module unification support miguelcobain/ember-paper#883
/cc @ppcano (you have some stake here as well)

seems like it mostly has to do with there styles get exposed to the host app. idk if there is something simple we can do so that existing style addons can "just work", or if we're going to make all the style addons add an octane / isModuleUnification condition?

MelSumner · 2019-02-08T14:02:04Z

@NullVoxPopuli

the lack of hooks should be filed as a bug (as detailed as possible) (and we can add the octane label to it)
we don't intend to track specific addons here (this issue is trying to stay focused on tracking the items listed in the roadmap RFC), but maybe we can figure out a way to share an "upgrade your addon" guide? Maybe we could convince @miguelcobain to write one for the emberjs.com blog. ;)

MelSumner · 2019-02-08T15:03:20Z

Hey everybody, the implementation of the "Remove jQuery" RFC is mostly done (at least as far as the first Ember 3.x stage is concerned, see #17476). What's still open and blocking the (default, non-octane) blueprints to switch to no jQuery by default is the built-in ability of ember-data to work with fetch instead of $.ajax (without having to apply the ember-data patch mixin), see the WIP PR: emberjs/data#5386.

Just to let you know... maybe this should be addressed at one of the next core team meetings, to help bring this over the finish line?

@dgeb / @igorT can you help with this blocker?

igorT · 2019-02-15T19:00:24Z

@MelSumner Yup, brought this up at the ED meeting, we are gonna follow up and refactor the ember-fetch PR emberjs/data#5386

ppcano · 2019-02-17T05:21:00Z

@MelSumner

Update blueprints for each object type to use native JS classes has been merged at #17621. Initially, the blueprints will generate Native Classes only when using the octane blueprints.

lifeart · 2019-02-21T16:05:02Z

@tomdale, @MelSumner, @rwjblue

Template Imports ( Working Draft )

knownasilya/ember-template-imports#10

Panman82 · 2019-05-06T15:17:30Z

FYI, the Component Templates Co-locations RFC is not on this tracking issue yet. :)

emberjs/rfcs#481

MelSumner · 2019-05-21T18:23:14Z

@Panman8201 correct- it's outside of the scope for Octane. :)

auvipy · 2019-12-24T13:27:56Z

I think this need to bee updated with ember octane 3.15+ release :)

MelSumner · 2020-01-02T15:59:50Z

Since we've shipped Octane, going to close this issue.

MelSumner created this issue from a note in Edition: Octane (To do) Nov 28, 2018

MelSumner added the Octane label Nov 28, 2018

MelSumner mentioned this issue Nov 28, 2018

[OCTANE] Craft Glimmer Component RFC emberjs/rfcs#405

Closed

MelSumner self-assigned this Nov 28, 2018

This was referenced Nov 28, 2018

Add Broccoli basics to guides ember-learn/cli-guides#62

Open

[OCTANE] Remove synchronous rendering from tests emberjs/rfcs#406

Closed

pixelhandler added the Meta label Nov 30, 2018

MelSumner added the Help Wanted label Dec 4, 2018

ppcano mentioned this issue Feb 9, 2019

octane / module unification support miguelcobain/ember-paper#883

Open

NullVoxPopuli mentioned this issue Feb 9, 2019

WIP: add hook for addons to add to the resolver config ember-cli/ember-cli#8419

Closed

This was referenced Feb 15, 2019

Set EMBER_VERSION env variable to OCTANE ember-cli/ember-octane-blueprint#36

Merged

Update blueprints to use native JS classes #17621

Merged

ppcano mentioned this issue Feb 16, 2019

ember-simple-auth can't resolve 'session' type ember-cli/ember-resolver#331

Closed

ppcano mentioned this issue Feb 17, 2019

Angle Bracket invocation on blueprints #17625

Closed

MelSumner removed the Help Wanted label Feb 28, 2019

ghost mentioned this issue Mar 4, 2019

[octane] update octane component blueprint to extend from glimmer components #17701

Closed

kpfefferle mentioned this issue Mar 7, 2019

2019 Update Tracking Issue Addepar/emberconf-schedule-2019#32

Closed

16 tasks

This was referenced Mar 8, 2019

Linked Ember data using jQuery ember-cli/ember-octane-blueprint#66

Closed

Addons can provide their resolver module configuration via resolverConfig() ember-cli/ember-resolver#348

Closed

ghost mentioned this issue Jun 17, 2019

Create an Octane Upgrade strategy guide ember-learn/guides-source#849

Closed

MelSumner closed this as completed Jan 2, 2020

Edition: Octane automation moved this from To do to Done Jan 2, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Octane Tracking Issue #17234

Octane Tracking Issue #17234

MelSumner commented Nov 28, 2018 •

edited

tomdale commented Dec 4, 2018

oligriffiths commented Dec 5, 2018

knownasilya commented Dec 6, 2018

tomdale commented Dec 11, 2018

rwjblue commented Dec 11, 2018

mike-north commented Dec 11, 2018

NullVoxPopuli commented Dec 11, 2018

rwjblue commented Dec 23, 2018

gossi commented Dec 23, 2018

MelSumner commented Jan 2, 2019

gossi commented Jan 7, 2019

NullVoxPopuli commented Jan 9, 2019

jenweber commented Jan 12, 2019

simonihmig commented Jan 12, 2019

mike-north commented Jan 15, 2019 •

edited

rwjblue commented Jan 29, 2019

ppcano commented Feb 1, 2019

mike-north commented Feb 2, 2019

rwjblue commented Feb 3, 2019

michaelrkn commented Feb 3, 2019

MelSumner commented Feb 4, 2019

michaelrkn commented Feb 4, 2019

simonihmig commented Feb 8, 2019

NullVoxPopuli commented Feb 8, 2019 •

edited

MelSumner commented Feb 8, 2019

MelSumner commented Feb 8, 2019

igorT commented Feb 15, 2019

ppcano commented Feb 17, 2019

lifeart commented Feb 21, 2019

Panman82 commented May 6, 2019

MelSumner commented May 21, 2019

auvipy commented Dec 24, 2019

MelSumner commented Jan 2, 2020

Octane Tracking Issue #17234

Octane Tracking Issue #17234

Comments

MelSumner commented Nov 28, 2018 • edited

Summary

Goals from Roadmap RFC

Finish What We Started (Part 1 of 2)

Octane Edition Features (Part 2 of 2)

Practical Implementation of Roadmap RFC

Decorators

Glimmer Components (as the default component API)

Tracked Properties

Element Modifiers

Editions

Remove jQuery by Default

Native JS Classes

Broccoli 2.0

Ember Guides Updates

Website Re-design

Scope Creep

on modifier

fn helper

Injection Parameter Normalization (owner tunnel/class portal)

@classic decorator

Ember Inspector

Supporting TODOs

Stretch Goals/De-scoped items

Project Management

Upgrading Apps to Octane

Required

Dependencies

Optional Features

.ember-cli

Optional / Incremental

Final Checklist

tomdale commented Dec 4, 2018

oligriffiths commented Dec 5, 2018

knownasilya commented Dec 6, 2018

tomdale commented Dec 11, 2018

rwjblue commented Dec 11, 2018

mike-north commented Dec 11, 2018

NullVoxPopuli commented Dec 11, 2018

rwjblue commented Dec 23, 2018

gossi commented Dec 23, 2018

MelSumner commented Jan 2, 2019

gossi commented Jan 7, 2019

NullVoxPopuli commented Jan 9, 2019

jenweber commented Jan 12, 2019

simonihmig commented Jan 12, 2019

mike-north commented Jan 15, 2019 • edited

rwjblue commented Jan 29, 2019

ppcano commented Feb 1, 2019

mike-north commented Feb 2, 2019

rwjblue commented Feb 3, 2019

michaelrkn commented Feb 3, 2019

MelSumner commented Feb 4, 2019

michaelrkn commented Feb 4, 2019

simonihmig commented Feb 8, 2019

NullVoxPopuli commented Feb 8, 2019 • edited

MelSumner commented Feb 8, 2019

MelSumner commented Feb 8, 2019

igorT commented Feb 15, 2019

ppcano commented Feb 17, 2019

lifeart commented Feb 21, 2019

Template Imports ( Working Draft )

Panman82 commented May 6, 2019

MelSumner commented May 21, 2019

auvipy commented Dec 24, 2019

MelSumner commented Jan 2, 2020

MelSumner commented Nov 28, 2018 •

edited

`on` modifier

`fn` helper

`@classic` decorator

`.ember-cli`

mike-north commented Jan 15, 2019 •

edited

NullVoxPopuli commented Feb 8, 2019 •

edited