Skip to content
This repository has been archived by the owner on Oct 30, 2018. It is now read-only.

Latest commit

 

History

History
1502 lines (1151 loc) · 63.8 KB

HISTORY.md

File metadata and controls

1502 lines (1151 loc) · 63.8 KB
Raw

version 0.9.8

Features

  • Updated to the latest version of YUI (3.18.x).

Bug Fixes

  • Action context now inherits the addons required by any yui module required by a controller.

version 0.9.7

Features

  • Controllers, models, and binders can be defined as a function with a prototype.
  • Support for easily extending YUI modules in a different mojit, by using Y.mojito.Util.extend. Y.mojito.Util.extend, defined in 'mojito-util', is the equivalent of Y.extend, and can accept object literals in addition to functions.
  • Controllers inherit the addons of any controller that is listed in its requires array.
  • Mojit dependencies can be specified in defaults.json, which ensures that required dependencies are loaded when resourceStore.lazyMojits is set to true.

Below is an example where the ImageResult controller extends the Result controller:

mojits/Result/controller.server.js

YUI.add('ResultController', function (Y, NAME) {
    Y.namespace('mojito.controllers')[NAME] = {
        index: function (ac) {
            var result = this.createResultObject(ac);
            ac.done({
                result: result
            });
        },
        createResultObject: function (ac) {
            return {
                title: ac.config.get('title'),
                text: ac.config.get('text')
            };
        }
    };
}, '0.0.1', {
    requires: [
        'mojito-config-addon'
    ]
});

mojits/ImageResult/controller.server.js

YUI.add('ImageResultController', function (Y, NAME) {
    var ResultController = Y.mojito.controllers.ResultController,
        // Constructor for this controller.
        ImageResultController = function () {
            // Hook into the original createResultObject method, in order
            // to call this controller's augmentResult method.
            Y.Do.after(this.augmentResult, this, 'createResultObject')
        };

    Y.namespace('mojito.controllers')[NAME] = ImageResultController;

    // Extend the ResultController, adding the augmentResult custom method.
    Y.mojito.Util.extend(ImageResultController, ResultController, {
        augmentResult: function () {
            Y.Do.currentRetVal.image = {
                src: 'myImage'
            };
        }
    });
}, '0.0.1', {
    requires: [
        'ResultController',
        'mojito-util'
    ]
});

The ImageResult controller uses Y.mojito.Util.extend in order to extend the Result controller and add custom methods. The controller is defined as a function that serves as a constructor. In this function, the controller hooks into createResultObject in order to call augmentResult after. Notice that the ImageResult controller does not have to re-specify the config addon in its requires array since this addon is inferred from the required ResultController.

Note: If resourceStore.lazyMojits is set to true, then mojits that depend on the resources of other mojits must let Mojito know of the dependencies. This ensures that once a mojit is lazy loaded, its dependency mojits are also loaded. Dependencies can be specified in the mojit's defaults.json. Below is how ImageResult's defaults.json would specify that it depends on resources in the Result mojit:

ImageResult/defaults.json

[{
    "settings": ["master"],
    "dependencies": ["Result"]
}]

version 0.9.6

Features

  • Clearer and more specific error messages regarding invalid mojits and exceptions.
  • Routes.json now accepts an annotations object (see express annotations). Also the "client" annotation can be used to specify whether to expose the route to the client; by default, routes are exposed to the client.

Ex. routes.json:

...
"route": {
     "verbs": ["get"],
     "path": "/path",
     "call": "spec.action",
     "annotations": {
        "client": false
     }
}
...

Bug Fixes

  • Catching any uncaught exception during binder execution. This prevents binder errors from interfering with other binders and the mojito client.

version 0.9.5

Notes

  • Reduced start up time by up to 25% by capturing YUI module details and executing them in one step instead of two.
  • Now YUI modules are only executed once, with the real runtime YUI object scoped.
  • Syntax errors are now reported with line numbers after failing to compile YUI modules.
  • Better handling of translations in the Intl addon, which finds the best available lang while avoiding potential interference from a previously set language.

Bug Fixes

  • Fixed issue where application start up would crash due to syntax errors in a YUI module.

version 0.9.4

Features

  • Added the lazyLangs and lazyMojits options, which significantly reduce start up time. By default these options are set to false, and can be set to true under the resourceStore option in application.json. lazyLangs only loads the lang files necessary for a given request's lang context; this substantially reduces start up time for application that have many lang files. Note that lazyLangs requires lang files to follow proper naming conventions ({mojitName}_{locale}.js or {mojitName}.js for default lang, e.g. Main_es-ES.js or Main.js); default langs are specified with the empty string within the lang file. lazyMojits only loads mojits as they appear during a request; this option is especially useful for applications with many mojits that don't appear often. After a resource is lazy loaded, it does not need to be loaded again in subsequent requests. lazyLangs/lazyMojits are ideal options for large applications during development when developers often have to restart an application and don't necessarily use all mojits or languages.

Bug Fixes

  • Fixed issue where the mojito-handler-static middleware was sometimes setting the header max-age value to NaN.

version 0.9.3

Notes

  • Various improvements to the Resource Store, which reduce start up time by 30% to 50%.
  • YUI dependency was upgraded to yui@3.16.x
  • Request dependency was upgraded to request@2.34.x
  • Yahoo Arrow devDependency was upgraded to yahoo-arrow@0.5.x

version 0.9.2

Notes

version 0.9.1

Notes

version 0.9.0

Notes

This release introduces a set of new APIs and concepts.

Please refer to some of the examples apps under the examples/ folder to get an overview of what has changed.

Deprecations, Removals

  • Mojito no longer supports index.js and server.js to start up the server. Applications will instead instantiate Mojito as follows:

    var libmojito = require('mojito'),
    express = require('express'),
    app;

app = express();
libmojito.extend(app, { /* context */ });
// at this point, access mojito instance via `app.mojito`

  • appPort configuration is no longer supported via application.json. Instead, the Express app instance should call listen() when ready.

  • Middleware configuration is no longer supported via application.json. Applications can register their middleware using the Express API. To enable Mojito default list of middleware, use the following:

    app.use(libmojito.middleware());

    If you want to have more granular control, use the following:

    app.use(libmojito.middleware['mojito-handler-static']());
app.use(libmojito.middleware['mojito-parser-body']());
app.use(libmojito.middleware['mojito-parser-cookies']());
app.use(myCustomContextualizerMiddleware());
app.use(libmojito.middleware['mojito-contextualizer']());
app.use(libmojito.middleware['mojito-handler-tunnel']());
app.use(anotherCustomMiddleware());

  • routes.json configuration is no longer loaded by default. To tell Mojito to do so, use the following:

    app.mojito.attachRoutes();

    Applications can also pass in an array of route configuration names if needed.

  • ac.url.make() and Y.mojito.RouteMaker.make() no longer throws exception. Instead, the api returns null in order to provide the application more control on how best to handle this error.

  • The ac.url.find() and Y.mojito.RouteMaker.find() methods are now deprecated and will be removed in a future version.

    Applications that rely on this API should familiarize with the express-map package by querying the route object by name or path.

  • Expanded metadata is now removed. This means we will not longer support synthetic modules that were expanded by default, e.g.: loader-yui3-base, loader-yui3-expanded and loader-app-resolved. If you are using any of those 3 entries in the YUI configuration, you should use loader-app and loader-app-base as your seed modules. In fact we recommend to not customize yui.config.seed in your application.json

Features

  • To register Mojito routes programmatically instead of using routes.json:
// app.js
app.get('/foo', mojito.dispatch('foo.index'));
app.map('/foo', 'foo');
app.map('/foo', 'get#foo.index');

In addition to setting up the path /foo to be routed to the Mojito dispatcher, setup 2 additional "aliases". The second alias is the HTTP method concatenated with the call value using the # delimiter.

This is equivalent to doing this in routes.json in previous releases.

[{
    "settings": [ "master" ],
    "foo": {
        verbs: [ "get" ],
        path: "/foo",
        call: "foo.index",
        params: { /* optional prams */ }
    }
}]

For more detail information, please check any of the applications under examples/ folder.

New Dependencies

version 0.8.3

Bug Fixes

  • Issue #1306: ac.partial.render() throws error for handlebar custom helper

version 0.8.2

Bug Fixes

  • Issue #1280: Composite.execute cannot be called multiple times in the same mojit

version 0.8.1

Features

  • Handle invalid context exceptions with output handler
  • Allow merging of YCB configs with the same context (by using ycb@1.1.0)

Bug Fixes

  • fix issue #1254 Allow the same context to be used multiple times in configuration

Acknowledgements

Special thanks to David Gomez for his contributions to this release.

version 0.8.0

Notes

  • !IMPORTANT! This release contains a notable backward-incompatible change. See "Deprecations, Removals" below.

Deprecations, Removals

  • !Backwards-Incompatible Change! Getting model instance by passing model YUI module name to ac.models.get has been removed.
  • Cleanup: The archetypes directory containing boilerplate template code has been removed from the mojito package because the template code is located in mojito-cli-create.

Features

  • Contextualized model support is added: ac.models.get(modelName) will take the model's logical name (filename minus the affinity and context parts) and return contextualized model instance.

    For example: Different model files can be provided for different context settings under models directory: .../models/ mymodel.common.iphone.js mymodel.common.js

    Calling ac.models.get('mymodel') will return the model which is appropriate for the current context.

Bug Fixes

  • Issue #1251: easy way to get contextualized models
  • PR #1264: better output handler response header check
  • PR #1270: removed archetypes directory and boilerplate template code for apps/mojits.
  • PR #1278: added middleware and updated app configs so that apps can use mocked models.

Acknowledgements

Special thanks to Jacques Arnoux for contributing to this release.

version 0.7.5

Bug Fixes

  • Issue #1215: [regression] lang collection in metas is missing for controller
  • Issue #1238 Lower Resource Store log messages for duplicate resources from "info" to "debug"

version 0.7.4

Features

  • The lib/store.js has a new getAppConfig() function. This is a better choice for reading the static application configuration than createStore().
  • The resource store now exposes the server's runtime YUI instance via the runtimeYUI member. Resource store addons can access it via this.get('host').runtimeYUI.

version 0.7.3

Features

  • PR #1195: New resourceStore.lazyResolve:true option in application.json. Normally, the resource store at server start pre-calculates the details for all mojits for all contexts/selectors (it's optimized to only do this for dimensions/selectors that are actually used). By setting this new option the resource store will skip this calculation at server start and instead do it at runtime "lazily" (as needed). This might be a good option to use if you have a large number of dimensions defined in dimensions.json and a lot of selectors defined in application.json, yet your app will only serve traffic from a subset of those, or the synchronous computation of all resolutions would make your app too slow to start. This option evens-out that process in time by only triggering it the first time it's needed and caching the result.

Acknowledgements

Thanks to Jacques Arnoux and David Gomez for contributing to this release.

version 0.7.2

Bug Fixes

  • PR #1196: fix runtime:server is not set by default when booting the app
  • Issue #1071: Putting a README.md in the mojits/ directory causes mojito to not load

version 0.7.1

Notes

The resource store now exposes a method loadConfigs() and an event "loadConfigs", for planned add-on authoring support.

Acknowledgements

Thanks to David Gomez and Jacques Arnoux for contributing to this release.

version 0.7.0

Notes

  • YUI dependency was upgraded to yui@3.10.3

Deprecations, Removals

  • The mojito command line tools included in the mojito repository were deprecated in May. Mojito Developers were asked to install and use the mojito-cli npm package. With this release, the command line tools have been removed from Mojito. Use of the commands with the latest mojito-cli works as before. Also, deprecated commands "profiler" and "gv" cli commands were moved to separate packages.

Note that if an application's continuous integration environment (i.e. Jenkins, Screwdriver) depends on the code for these commands to be included as part of the mojito package, the application package.json will need to be updated.

CLI change summary:

  • Developers should continue to install mojito-cli globally in their development environments to use "mojito" commands from the console. This remains the case for any recent version of Mojito.
  • Mojito applications depending on mojito@0.7.0 and doing CI with Screwdriver need to add mojito-cli as a devDependency.
  • mojito profiler was re-packaged and can be installed separately.
  • mojito gv was re-packaged and can be installed separately.

More info at the mojito-cli wiki.

  • mojito-carrier-addon and mojito-device-addon are moved to y_mojito package for Yahoo internal developer use only.

Features

  • PR #1163: Rehydration of data from server to client and from client to server. Any data set thru mojitProxy.data.set() or ac.data.set() will travel back and forward between the client and server runtime to preserve the state of the mojit instance when using the rpc tunnel.

Bug Fixes

  • Issue #1159: tunnel request fails if mojito-data-addon is required on the server side controller.

Acknowledgements

version 0.6.1

Notes

  • Mojito contributors can now use the following npm run-script shortcuts when working inside the mojito repo:
    • npm test
    • npm run unit
    • npm run func
  • YUI dependency was upgraded to yui@3.10.1
  • Arrow devDependency was upgraded to yahoo-arrow@~0.0.77
  • YCB dependency was upgraded to ycb@~1.0.5

Deprecations, Removals

Features

Bug Fixes

  • fix #1151 client-side route-maker error IE6-8
  • fix #1146 use perf.logFile from app.json:perf.logFile if applicable
  • fix callback handling in mojito start sequence

Acknowledgements

Thanks to @chetanankola for discovering and helping with issue #1151.

version 0.6.0

Notes

  • ac.config.getAppConfig() was reworked to improve performance by computing the app config once per request, and reuse across all the mojit instances in the same page using the mojito-config-addon. This means you have to be extra careful if you attempt to change that object, because it might affects other mojits in the same page.
  • ac.config.getRoutes() was reworked to improve performance by computing the app config once per request, and reuse across all the mojit instances in the same page using the mojito-url-addon. This means you have to be extra careful if you attempt to change that object, because it might affects other mojits in the same page.
  • Using Y.Model.Vanilla class on the server side for ac.data and ac.pageData, while using Y.Model on the client side. This is a performance optimization, and while the API is still the same, but on the server we do not support events on those model instances, while in the client, you might want to listen for changes in the model from the binder. In the future Y.Model.Vanilla will be replace with Y.Model.Base when it becomes available in core.

Deprecations, Removals

  • PR [#1103] Droping support for nodejs 0.6.
  • ac.staticAppConfig was a private api used by mojito to allocate static config for the app, and this is now removed. If you need access to the config, you can use mojito-config-addon to access ac.config.getAppConfig().

Features

  • PR [#1103] Bringing windows to the front row by adding partial support for mojito on windows. We plan to consolidate this going forward, but until after travis-ci.org supports windows environment as part of the build process to do sanity check, we cannot guarantee that everything will work on windows.
  • mojito-composite-addon and mojito-partial-addon support ac.flush from child mojits.
  • Command "npm test" is added to run all mojito unit and functional tests with Phantomjs. Test results can be found under /artifacts/arrowreport by default. "npm run unit", "npm run func", "npm run doc", "npm run lint" are also added.

Bug Fixes

Acknowledgements

version 0.5.9pr1

Notes

  • !IMPORTANT! This release contains a notable backward-incompatible change. See "Deprecations, Removals" below.
  • The PR #1059 adds the Mojito Quickstart Guide application to the examples directory. The application allows you to view documentation on different devices and serves as a reference application. You can view the live application at http://y.ahoo.it/mqsg. Also, see the wiki page Mojito Quickstart Guide: Intro for more information about the application.

Deprecations, Removals

  • !Backwards-Incompatible Change! Using ac.instance.config to send data from a controller to a binder has been removed. This was never the official approach but was a work-around mentioned in our FAQ until we could support something better. We now have an official data channel from controller to binder -- see "Features" below. This was removed because sending instance.config from the server to the client could possibly leak secure information.
  • The command line tools bundled with mojito have been deprecated. Rather than installing mojito globally, please install mojito-cli globally instead. Functionality should remain the same. See http://git.io/jJazAw
  • mojito compile command was removed. It has been deprecated since 0.5.1.
  • mojito profiler has been deprecated. It will be removed in a future release.

Features

Data Channel from Server to Client

Introducing mojito-data-addon for use in controllers. This AC addon is used to pass information from the controller to the binder. After requiring this addon in your controller you can use ac.data.set(name, value) to expose data to the binder. The binder accesses this data with mojitProxy.data.get(name).

The data set via ac.data.set() is also available in all templates. Any data given to ac.done() will be merged over the data given by ac.data.set(). (This is a shallow merge.)

Page-Level Data Store

mojito-data-addon also introduces the page data, which is accessible thru ac.pageData. This has a YUI Model API, i.e. ac.pageData.set(name, value) and ac.pageData.get(name). pageData is unique to each request, but is a single store for all mojits of the request, and you can use it to share data between mojits in a page. The binder accesses this data with mojitProxy.pageData.get(name).

The data set via ac.pageData.set() is also available in all templates thru this.page (for example {{page}} in handlebars templates). Keep in mind that if ac.done({page: 'something'}) is specified in your controller, the page key will override all data set via ac.pageData.

This data will be sent to the client side, and rehydrated since the page built at the server side will expand its scope to the client. In other words, pageData serve as a mechanism to share data between mojits and runtimes. ac.pageData and mojitProxy.pageData provides access to the same page model.

Bug Fixes

Acknowledgements

Special thanks to Steven Lu for contributing the Mojito Quickstart Guide app for this release.

version 0.5.8

Notes

  • The PR #1062 fixes the detection problems in YUI that where causing multiple issues with Y.JSON.parse and other components. In the current implementation, the app itself uses require('yui') in a traditional way to avoid any potential issues in the future with the detection system in YUI. It also re-enabled the ability to run YUI in debug mode in the server side if you happen to use filter="debug" in application.json which has been broken for a long time.

Deprecations

  • "hybridapp" code and resources have been removed. They were purpose built for use with other cocktails components outside mojito, but their development has recently stopped.

Bug Fixes

  • PR #1062: fixes the issue with Y.config.global after the upgrade to yui@3.9.1
  • removed a few unnecessary datastructure copies

version 0.5.7

Notes

  • A middleware called mojito-handler-error has been added to handle middleware errors. If you have redefined the middleware stack and do not have your own error handler, then it is your responsibility to add it so that errors can be handled appropriately.

  • An early preview of mojito-cli has been published. Users can choose to try it with npm install --global mojito-cli. There should be no significant changes in functionality. It is intended to replace the functionality provided by installing the mojito npm package globally (which has been deprecated). Notes:

    • users install mojito-cli package globally (if they choose to in this preview release period).
    • users should install the mojito package locally, as an npm dependency of their application.
    • all existing mojito command line commands should continue to operate in much the same way.
    • mojito create app Foo, when mojito-cli has been installed, will use npm to install mojito locally automatically after generating the app files and directories.

Features

  • Upgraded to YUI 3.9.1
  • issue #979:
    • The mojito-handler-tunnel middleware was refactored into a middleware substack that more loosens the coupling between the parsing and handling phases of a tunnel request. This means that applications will have an easier time overriding and customizing tunnel behavior.
    • The URL is now customizable per request using the tunnelUrl option for mojitProxy.invoke(), but is still subject to the tunnelPrefix restriction.

Bug Fixes

  • issue bz6160815: port argument must be an integer

version 0.5.6

Notes

  • Mojito cli commands will be moving to a separate package mojito-cli in upcoming releases, which will be for global installation. The core mojito package will be for bundling with your application.

Deprecations

  • Mojits shipped with Mojito (like HTMLFrame, tunnel, etc) will play by the same rules, no more conditions when we walk them. Before, those mojits were forced to not have res.url because they should not be used from the client side, that's not longer the case.

Bug Fixes

  • issue #812: only walk the first/shallowest version of each package
  • issue #1016: regression that prevented shaker for controllering CDN urls
  • issue #1026: compatibility with Node.js 0.10 by making all mojits to play by the same rules

version 0.5.5

Deprecations

Performance optimizations introduced in this release have resulted in internal API changes. This impacts 3rd party components that are using protected or internal store APIs, e.g. Shaker. A new Shaker version will be released very soon to address these changes. In the meantime, you can follow mojito-shaker#43.

Here are details of the API changes.

  • We removed store event getMojitTypeDetails. The replacement is resolveMojitDetails, though the datastructure is different.
  • We removed store event mojitResourcesResolved.
  • We removed store.getResources().
  • We added store.optimizeForEnvironment().
  • We added store.makeStaticHandlerDetails().
  • store.yui.getAllURLResources() is now called store.yui.getAllURLDetails() and returns a different datastructure.
  • For both store.getResourceContent() and store.procesResourceContent(), the datastructure representing the resource has changed.
  • store.getResourceVerions() should not be called during runtime. It can still be called during the events that happen during preload.
  • store.yui.getConfigShared() now just takes the env argument.
  • We removed store.yui.getConfigAllMojits(). Some users were calling getConfigAllMojits and using the results with getConfigShared to configure a YUI instance. Now instead we suggest using getModulesConfig() to replace this pair of calls.
  • We added store.yui.getModulesConfig().
  • We added store.yui.getYUIConfig().
  • store.yui.getAppSeedFiles() now takes a yui configuration as the second argument.
  • store.yui.getYUIURLResources() is now called store.yui.getYUIURLDetails() and returns a different datastructure.

Please see the API docs for details of each.

Features

  • Global models thru ac.models.expose() upgraded from experimental to beta.
  • Support for Handlebars helpers through mojito-helpers-addon and support for global Handlebars helpers using ac.helpers.expose(). This is an experimental feature!
  • Introducing error propagation in mojito-composite-addon by using the flag propagateFailure in a child.
  • Introduced a clear separation between YUI core modules and app-specific YUI modules. YUI core modules are now served from CDN by default; they are only served by the app origin server if staticHandling.serveYUIFromAppOrigin is set in application.json. This change optimizes the initial load time of the app as well as its offline capabilities when using mojito build html5app.
  • Improved Resource Store: minimized memory footprint.
  • Upgraded to YUI 3.8.1

Bug Fixes

  • #25 mojito-composite-addon error propagation
  • #293 HTMLFrameMojit should honor child metas
  • Fixes the Cache-Control header for static assets.
  • Fixed hybrid build issue
  • Fixed lingering occurrences of store.yui.getConfigAllMojits()
  • Fix for forceRelativePaths for YUI loader when using mojito build, making root and base to be relative when needed.
  • (sweetandsour2) Fix for client side hooks, bug fix in template hooks.

version 0.5.4

Deprecations

  • We dropped the Mu library in favor of Handlebars -- Handlebars is used everywhere, including for parsing Mu templates. Even though Mustache is a subset of Handlebars, this might introduce some encoding issues, especially because Handlebars does automatic encoding of {{}} sections to provide some basic security against script injections. If you are encoding data in your controller for your Mustache views, you no longer need to do so, and by using {{}} you will be covered. On the other hand, if you don't want Handlebars to apply the default encoding, just use {{{}}} to print the original value.

Features

  • Support for Handlebars partials
  • Dropped Mu library: any *.mu.html view/template will be processed using HB engine
  • Global models thru ad.models.registerGlobal
  • Templates warm-up thru preloadTemplates configuration for small apps.
  • Support for external URLs in yui.config.seed for custom YUI versions on the client side.

Bug Fixes

  • Solving conflits generated by the hook system.
  • lock yahoo-arrow version to 0.0.73
  • Revert "Reduced memory consumption at server start by removing an apparently unnecessary meta-data copy operation..."
  • adding support for a more flexible seed structure to support external urls. this helps to control the yui version on the client.
  • removing mustache engine in favor of handlebars based on #367 by @mridgway
  • supporting registration of global models
  • consolidating application.json->viewEngine->cacheTemplates as a static config across the board.
  • adding support for partials in the store. Views within partials/* folder are now considered partials.

version 0.5.3-1

Bug Fixes

  • Revert 3a5822a "Reduced memory consumption at server start by removing an apparently unnecessary meta-data copy operation"

version 0.5.3

Features

  • new mojito and mojito-app instrumentation hooks
  • performance improvements
  • simplification of the frame mojit to facilitate inheritance and brand new frames per app.

Bug Fixes

  • #919 Added examples of YAML configuration and linked…
  • #928 Remove Y! copyright from generated code
  • #954 fix for app failures when deploying to nodejitsu.

version 0.5.2

Features

Performance Improvements

From 0.5.1 to 0.5.2 we have implemented a series of micro-optimizations. As a result, Mojito is twice as fast, uses half the memory footprint, and takes half the time to boot the application based on our internal metrics. More information can be found on our Trello board. This improves the response time to ~40ms response time for an application with 52 mojits, which represents less than 1ms per mojit.

Comments in JSON files and YAML Support

Configuration files, including application.json, defaults.json, definition.json, etc., can become pretty big for complex applications, and not having comments can drastically impact productivity and on-boarding for new developers. As of this version, we support comments in those files. The comments are YAML comments, they start with #.

As well, we just brought back support for .yml and .yaml that was previously introduced in Mojito 0.4.x.

Logs Formatter

In 0.5.0, we removed the mojito logger and started using YUI Log in its pure form. As a result of the formatting process implemented by the yui-log-nodejs module, the logs were formatted even when the application was running in a runtime without tty. This was partially fixed in this new version (for runtime execution where performance is critical), and we plan to finish the migration for the Resource Store's logs in 0.5.3.

Bug Fixes

  • [bz5667423] Add support for including files in a configuration bundle
  • Added support for JavaScript-style comments in JSON files
  • [bz5964521] test output is always colorized -- includes escape codes when saved to file
  • micro-optimization: replacing runInNewContext with runInContext
  • fix two newsboxes unit tests, misc
  • update copyright to 2013
  • [doc] Added FAQ about setting expiration of a cookie.
  • update package.json in archetypes for mojito 0.5.x & node >0.6
  • do not colorize test.js output if there is no tty [gh809,bz5964521]
  • Functional test changes to support SD
  • jslint tests along with template for general cli testing
  • [bz6023234] prefix for hybridapp/crt "//yahoo.com"
  • Update docs/dev_guide/getting_started/mojito_getting_started_tutorial.rst
  • removed shelljs
  • honor --descriptor for --cli and --unit as well
  • Travis cleanup
  • [doc] Updated documentation for running Mojito's built-in unit/functional tests.
  • more unit tests for ActionContext
  • Update docs/dev_guide/intro/mojito_apps.rst
  • Add more unit tests for params.common and view engine handlebar
  • a little more careful about transforming ac.done() into a no-op
  • Update docs/dev_guide/intro/mojito_mvc.rst
  • [doc] Documentation for how to configure YUI for Mojito applications.
  • Update docs/dev_guide/intro/mojito_mvc.rst
  • unit tests for build/*.js
  • supporting yui.config.groups.app.comboSep=& without mangling
  • dispatcher coverage
  • .travis.yml debug, misc
  • Update docs/dev_guide/topics/mojito_testing.rst
  • Update docs/dev_guide/intro/mojito_binders.rst
  • Add more unit tests for util.
  • fixed client-side unit tests
  • Modify files to workaround a jslint error
  • [gh238] [bz5667423] support for multiple application configuration files
  • fix missing snapshot.packages in build hybridapp
  • [doc] Added links to archived docs.
  • unformatted logs when running in production systems
  • Update docs/dev_guide/code_exs/calling_yql.rst
  • add unit test for version
  • [doc] Docs add links to presentation given by Caridy at YUIConf 2012.
  • Update docs/dev_guide/reference/mojito_troubleshooting.rst
  • re-enable yaml support
  • [doc] Added FAQ discussing how to re-use and extend mojits.
  • workaround how arrow is tweaking with console.debug()

version 0.5.1

Notes

  • mojito compile rollups command is no longer needed and has been removed -- comboing is now done at request time.
  • mojito compile commands are deprecated in favor of Shaker
  • for hybridapp builds, the application.json config builds.hybridapp.forceRelativePaths: true is broken for the time being. This makes testing with a browser in a non-chrooted more difficult.
  • NOTICE: 0.5.x has various configuration and API changes from 0.4.x, please also review 0.5.0 release notes if you are upgrading your application from pre-0.5.x versions.

Features

  • comboing of mojito and application javascript files are at request time
  • improved performance/latency
  • improved internal test and testability
  • improved 0.5.x documentation

Bug Fixes

  • fix issue #835 more careful about caching results of expandInstanceForEnv()
  • adjusting ac.url.make routine to avoid accepting strings for querystring. avoiding any parsing or stringifing routine at…
  • fix mojito create -p option - add {{port}} to application.json
  • fix resolve loader config for hybridapp/IDE/CRT in 0.5.x
  • fix input handling and error message for jslint mojit command
  • better support of older browsers
  • HTMLFrameMojit title now says 'Powered by Mojito', not 'Powered by Mojito 0.2'

version 0.5.0

Notes

  • IMPORTANT This release contains notable backward-incompatible changes, all for the sake of significantly increased performance.

Backward Compatibility Changes

Mojito No Longer Adds Common ActionContext Addons

In the past, a subset of the addons provided by Mojito framework were attached on every ActionContext object (which are created per request, per mojit instance in the page). The specific list was mojito-config-addon, mojito-url-addon, mojito-assets-addon, mojito-cookie-addon, mojito-params-addon, mojito-composite-addon. This resulted in overhead for every mojit in the page. As part of 0.5.0, all requirements have to be specified in the controller definition. e.g:

YUI.add('Foo', function(Y, NAME) {

    Y.namespace('mojito.controllers')[NAME] = {

        index: function(ac) {
            // ac.params.* is now available
        }

    };

}, '0.0.1', {requires: ['mojito', 'mojito-params-addon']});

As of 0.5.0, no addon is attached unless it is required. The only public members of ActionContent object are ac.done, ac.error, and ac.flush.

Recommendations to upgrade:

  • check every controller in your app, and check if it is using ac.*, and add the corresponding requirements.
  • the most common addons are: config, params, url, assets.

Access to Models via a Property

Models are no longer computed and attached to ActionContext by default. In other words, ac.models.foo is no longer a valid way to access a model. Computing and attaching models automatically, even when they were not really needed, added overhead during the page rendering process. Instead, we want Mojito to be more strict in defining and exposing structures automatically.

In 0.5.0, if you need to use a model in a controller (defined at the mojit level, or at the application level), you need to:

  • require a new addon called mojito-models-addon in your controller.
  • require the module in your controller.
  • use ac.models.get('foo') to get a reference of the model.

Here is an example:

YUI.add('DemoModelFoo', function(Y, NAME) {
    Y.namespace('mojito.models')[NAME] = {
        init: function(config) {
            this.config = config;
        },
        getData: function(callback) {}
    };
}, '0.0.1', {requires: []});

YUI.add('Foo', function(Y, NAME) {
    Y.namespace('mojito.controllers')[NAME] = {
        index: function(ac) {
            ac.models.get('DemoModelFoo').getData(function (data) {
                // data from model available here
            });
        }
    };

}, '0.0.1', {requires: ['mojito', 'mojito-models-addon', 'DemoModelFoo']});

Note: the model name doesn't have to match the yui module name for the model anymore.

init Method in Controllers is Gone

The init method on the controller is now deprecated and should be removed. In many cases, the init method was just storing a reference of the config parameter to use it later on. This is no longer available, and the init method will not be executed.

If you need to access the mojit config in an actions, you should:

  • require mojito-config-addon in the controller.
  • use ac.config.get() to get the config

Note: do not try to store a reference of that config, as it is not safe, More details below.

ac.app.* is Gone

For performance reasons, to avoid computing app config per mojit instance, per request, when the majority of the time it is not needed, we completed the transition to mojito-config-addon add-on. This change affects ac.app.*, specifically ac.app.config which was commonly used to access the computed application.json configuration per context. If you need to access the application config in an action or another add-on, you should:

  • require mojito-config-addon in the controller.
  • use ac.config.getAppConfig() to get the former ac.app.config

Controllers Can No Longer Run Forever

Mojito now imposes a timeout on the dispatch of the action in the controllers. Starting with 0.5.0 there is a "reaper" which imposes a timeout. Actions must call ac.done() or ac.error() before the timer expires or the system will log a warning and invoke ac.error() with a timeout error.

This can be configured by the actionTimeout setting in application.json. It contains the maximum number of milliseconds that a controller action is allowed to run before the action is timed out. The default value is 60000 (60 seconds).

Mojit and AC Addon Naming Conventions Changes

Mojito is more restrictive in how you names mojits and add-ons. There are 4 new rules:

  • addon namespace should match the filename. E.g. ac.foo corresponds to addons/ac/foo.common.js.
  • The name of the mojit, which is the name of the folder, should match the language bundle, including the filename of the bundle and its definition. E.g. Foo mojit can have lang/Foo_da-DK.js, and the content should be YUI.add('lang/Foo_da-DK', function (Y) { Y.Intl.add('Foo', 'da-DK', {}); });
  • Controller YUI module name should be same as directory.
  • YUI modules need to have unique names, regardless of selector.

log Config in application.json is Gone

In previous versions, the console log was separated for client and server, and between Mojito and YUI. We decided to leverage the YUI Logger, and unify this setting under a single configuration, actually the YUI configuration in application.json:

"log": {
    "client": {
        "level": "error",
        "yui": false
    },
    "server": {
        "level": "error",
        "yui": false
    }
}

is now:

"yui": {
    "config": {
        "debug": true,
        "logLevel": "error"
    }
}

and we recommend this setting for production:

"yui": {
    "config": {
        "debug": false,
        "logLevel": "none"
    }
}

To customize this for client or server, you can use the runtime context. Also, you can now use logExclude and logInclude. More information at http://yuilibrary.com/yui/docs/api/classes/config.html.

Other Settings Changes in application.json

The following are gone:

  • embedJsFilesInHtmlFrame
  • shareYUIInstance
  • in the yui section:
    • base
    • dependencyCalculations
    • extraModules
    • loader
    • url
    • urlContains

mojito test No Longer Tests the Framework

In the past, mojito test without any other parameter was running all unit tests for mojito framework, and this is no longer the case. We moved all the tests to arrow, more details here: https://github.com/yahoo/mojito/tree/develop/tests

You can continue using mojito test app path/to/app and mojito test mojit path/to/mojit, and the behavior is still the same.

Note: this change is only relevant for contributors.

.guid is Gone

The .guid member of Mojito metadata (such as binder metadata) is now gone. Often there's an associated member which more specifically expresses the intent of the unique ID (for example .viewId or .instanceId).

Features

  • Speed: TODO more details.
  • Logging now uses Y.log() directly, instead of our own wrapper. This simplifies usage and enables subscribing to the YUI log events.
  • Upgraded yui dependency to 3.7.3 (or greater).
  • Combo handling is now built in to Mojito server.
  • New hybrid app archetype to help create apps for use in technologies such as phonegap.

Bug Fixes

  • #70 Simplify logging
  • #525 example unit tests crash or fail
  • #651 Expanded instances are bleeding
  • #736 Content Error in documentation
  • bz5472979 server resources in build
  • bz5886351 cli bin/mojito uses wrong copy
  • bz5892364 (archetype) mojito-client not loaded for hybrid app
  • bz5904449 garbled console output on node 0.8+
  • bz5914052 do real buffer calculus for better UTF8 and binary support

version 0.4.9

Notes

  • Command line warning and error output used to go to stdout, they now go to stderr.
  • Version 0.4.9-2 fixes the output of the test coverage report for mojito test -c app ., which was incorrect for 0.4.9.

Features

  • New mojito build hybridapp, requires snapshot name and tag options.

Bug Fixes

  • Add yuitest-coverage dependency.
  • Add yaml suport, including work from pr580 and pr670.
  • Fix bz4404935, including work from pr580 and pr670
  • Non-functional changes to cli fixes issue #715 typo in info error msg.
  • Fix bz5895425 resources for hybridapp/crt were 500/not found as web app.
  • Fix bz5904449 garbled console output on node 0.8+ if process.stdout is not a tty (i.e. a pipe) the console.log interpreted…
  • Fix bz5898249 merge source application.json's build.hybridapp.packages object into the build's ./appname/package.json dependencies…
  • Fix bz5472979 server resources in build server affinity resources do not need to be uri addressable. with this change store.getAllUrls()…
  • Fix bz5886351 cli bin/mojito uses wrong copy.
  • Fix bz5892364 (archetype) mojito-client not loaded for hybdridapp.
  • Fix bz5886351 cli: bin/mojito launches wrong copy the cli entry point bin/mojito should always load and run the code.

version 0.4.8

Notes

  • All performance regressions will be addressed in an upcoming release.

Features

  • #643 new hybrid archetype
    • new archetype: mojito create app hybrid myapp
    • new build type: mojito build hybrid path/to/packages/dir
    • new custom archetypes: mojito create custom path/to/your/archetype mything

Bug Fixes

  • #645, bz5472979 fix server resources in build
  • #650 [docs] Added a prereq for doing the code example, added a link
  • #546 multiple jslint errors in developer-guide and getting-started code examples
  • #547 errors in basic_yql example (getting-started-guide/part2)
  • #570 documentation - add api_key to the binders/index.js in the code example on Binding Events
  • fix path for create mojit.

version 0.4.7

Notes

  • IMPORTANT - server.js compatibility changes This release requires changes to any application's index.js file and server.js file to properly launch. The templates in mojito/lib/app/archetypes/app/default for index.js and server.js are the appropriate content to use in any existing applications. For new applications these files are automatically used when the mojito create app command is invoked to create a new application.

Features

  • #565 Added support for /crossdomain.xml and /robots.txt

Bug Fixes

  • #525 mojito test app|mojit failed for archetype-code…
  • #615 [doc] Added func/unit test instructions.
  • #546 multiple jslint errors in developer-guide
  • #621 [docs] Fixed a syntax issue for using run.js.
  • #624 Add getter to avoid exposing _app for Manhattan use.
  • #625 Move app init so any getHttpServer call returns initialized app instance...
  • #598 The routing configuration documentation covers the 'regex' property.
  • #628 Fix start logic.
  • #602 Rewrote item in the FAQ regarding passing data from the controller to the binder.

version 0.4.6

Notes

  • All performance regressions will be addressed in an upcoming release.

Deprecations

As of this release, Mojito has changed the way the application boots up. Update the file server.js that is at the root dir of your application. Here is an example:

var Mojito = require('mojito');
var app = Mojito.createServer({
    context: {}
});
// Mojito 0.4 and 0.5 compatibility...
module.exports = app.start ? app.start() : app;

Features

  • #265 Mojito can now be started using the standard node command.

Bug Fixes

None.

version 0.4.5

Notes

  • Some performance regressions remain from 0.4.0 and will be addressed in an upcoming release.

Features

  • Improved JavaScript parse error messages.
  • Improved functional test stability.

Bug Fixes

  • #13 ContextController cache never cleans up
  • #461 build html5app command - the "builds.html5app" key in "application.json" is not context aware
  • #482 improve error handling and messaging
  • #496 Compatibility with Node.js 0.8
  • #507 Add "hi" group in dimensions.json
  • #508 better error message for javascript parse errors
  • #519 Adds a --path option to run.js to allow specifying a path to find the test descriptors or applications
  • #522 fixed multiple typos in the code example as well as typo in explanation
  • #547 Updated YQL key used for examples

version 0.4.4

Notes

  • Some performance regressions remain from 0.4.0 and will be addressed in an upcoming release.

Features

Bug Fixes

  • #438 Shaker 2.0 compatibility
  • #78 Client resource store implementation
  • #77, #76 YUIDocs for resource store
  • #429 PUT requests not handled correctly
  • Fixed a browser incompatibility with XML output
  • fixed how commands instantiate the store
  • performance: use Y.mojito.util.copy() instead of Y.clone()
  • performance: removed Y.clone() from YCB library
  • fix multiple done() calls in client-side Handlebar renderer, consequence of fixing #408

version 0.4.3

Bug Fixes

  • Fix buffer mojito040
  • add node 0.8 compatibility
  • Travis CI Configuration
  • fix broken UTs in mojit skeletons
  • Fixed examples so that they should work with shareYUIInstance
  • Remove YCB and depend on ycb npm package
  • honoring context.lang in the loader
  • Fix for handlebar renderer when ac.flush() is called more than once
  • Moved fixtures; Migrated resource store addon tests
  • change example & fixture mojito dependency to >0.3
  • Store client url fix
  • Remove i13n from public mojito
  • fix store unit test
  • fix (and un-ignore) the resource store unit test for optional YUI modules
  • Remove i13n from public mojito
  • make nice names for the pids

version 0.4.2

Notes

  • This release is the bleeding edge of our development tree. To install the most stable, production-ready Mojito release, use npm install mojito@stable.

Features

Handlebars

Handlebars is now supported and is the default view engine for new projects. We are also recommending that projects change their view engine from Mustache to Handlebars for performance and stability reasons. Big thanks to Caridy Patino for this contribution.

  • Made handlebars the default renderer for new projects and all examples #365
  • Added deprecation warning for Mu #369
  • #270: Added unit tests for client and server handlebars engines
  • Added client side handlebars engine; Cleaned up jslint errors with server side engine
  • cleaning up the handlebar wrapper for mojito as a view engine for the server side.
  • adding support for handlebars for the server runtime only for now.

Reason Phrase

Providing the ability to provide a reasonPhrase property when calling ac.error.

shareYUIInstance

It was discovered that shareYUIInstance was not usable in previous versions. We have addressed some of the issues such that shareYUIInstance should be usable, although should be considered experimental. This configuration now works in the following way:

Default value is false at app level, mojits can override the app config by specifying shareYUIInstance in their defaults.json (parallel to the config key).

Docs

  • Reorganized the document, added links to images, section IDs, rewrote sections, and edited.
  • Adding architecture images.
  • Added a link to the RS from the selector property and an example that you cannot add the selector * property to the defaults.json file of a mojit.
  • Added the 'selector' property to the config docs and made a note in the RS docs that the selector can only be set in application.json.
  • Added the --context option to the build and start commands.
  • Added the tunnelTimeout property to the application config object.

Bug Fixes

  • fix #375, unified handling of frameworkName, appName, and prefix #383
  • Set server runtime when handling tunnel calls. #242 - Thanks Fabian Frank!
  • jslint command now uses node-jslint npm module; Fixed jslint errors from jslint upgrade #360
  • #352 archetypes now specify a version of mojito similar to that which uses them #355
  • when using the loader at the server side to generate combo urls we should pipe the yui config into the loader settings otherwise some settings will not be honored. #350
  • guard against missing edges in mojito gv #349
  • Removed DaliProxy and adding application configurable tunnel timeout #345
  • [Fix bz5712477] Make sure to callback when there is an error #338
  • Porting mojito doc over to the new yuidocjs #243 - Thanks Fabian Frank!
  • #270: Added unit tests for client and server handlebars engines
  • #357, #386: Fixed shareYUIInstance

version 0.4.0

Notes

  • This release contains a significant rewrite of an important subsystem of Mojito, the resource store. Also, with this release, the resource store becomes part of the public API of Mojito. It's an advanced feature, however, and is only needed if you intent to change how Mojito interprets and uses files on the filesystem.

Deprecations

  • You will now need to configure the iphone selector by hand ({"settings": ["device:iphone"], "selector":"iphone"}) in your application.json files. (This resource store no longer assumes the selector is just the device.)
  • In a mojit's package.json, the version check is now spelled engines.mojito instead of yahoo.mojito.version.
  • In a mojit's package.json, config.mojito is now spelled yahoo.mojito.
  • The second argument to serializeClientStore() is gone. (This was pretty much internal to mojito anyway, so likely no one will miss it.)
  • The second argument to getAppConfig() is gone. That method now just returns the application configuration (from application.json). (This was pretty much internal to mojito anyway.)

Bug Fixes

  • issue 10: Ensure Mojito can handle YUI module names with underscores
  • issue 32: "mojito compile rollups" using dot notation in the name of the css files will make compile to discard some of them
  • issue 50: mojito start loads tests from addons
  • issue 54: "mojito compile inlinecss" has unexpected behavior when there is a css file name that contains the string "iphone"
  • issue 59, bz 5380714: test files under addons/ac/ are loaded when mojito starts
  • issue 95, bz 4647440: Proper Mojito version number comparison
  • issue 109: Refactor certain complicated parts of the store
  • issue 110: Detect duplicate resource ids on cookdown
  • bz 4647169: considering making a utility YUI object in ResourceStore
  • bz 5362206: Need ability to select controller, view, model and binder based on context
  • bz 5495519: mojito is not loading - stuck retrieving all the datetype-date-format for each locale
  • bz 5530096: Mojito tries to parse .json~ files in [mojit]/specs/
  • bz 5541500: mojito not doing fallback
  • bz 5609501: L10n: Root strings file is not used by default when a non-root strings file is present

version 0.3.30

Notes

  • Mojito depends on the latest patch release of YUI, currently YUI 3.5.1-2. This version of YUI fixes a Y.io issue which appeared in the last release. Also, as with the last Mojito release, YUI 3.5.x has removed built-in jsdom support. Server code that depends on a DOM will cause Mojito to throw an exception on startup. A warning will now be issued for known DOM dependent modules matching this criteria. Folks are asked to either move DOM dependencies to client affinities or binders, or create the required host objects for your application's DOM requirements. See http://yuilibrary.com/yui/docs/yui/nodejs.html. There may also be other app-specific issues with the upgrade in YUI.

Deprecations

Features

  • Add --print option to jslint usage message
  • Performance Optimization: Defer RouteMaker Instantiation in URL Addon
  • yuitest cleanups
  • rm local copy of mime, use npm mime module instead
  • Remove local glob.js and replace with glob npm package
  • Added client-side unescape of escaped content
  • Adding namespacing to Mojito components
  • lots of documentation updates

Bug Fixes

  • Alter escaping to URI escaping to repair regressions
  • Make sure the callback signature is what the supplied Function expects
  • Use command-line context in "mojito build html5app" command

version 0.3.29

Notes

  • Mojito depends on the latest patch release of YUI, currently YUI 3.5.1-2. This version of YUI fixes a Y.io issue which appeared in the last release. Also, as with the last Mojito release, YUI 3.5.x has removed built-in jsdom support. Server code that depends on a DOM will cause Mojito to throw an exception on startup. A warning will now be issued for known DOM dependent modules matching this criteria. Folks are asked to either move DOM dependencies to client affinities or binders, or create the required host objects for your application's DOM requirements. See http://yuilibrary.com/yui/docs/yui/nodejs.html. There may also be other app-specific issues with the upgrade in YUI.
  • Because of the YUI situation, both the latest and stable tags on npm point to Mojito 0.3.26. To install this release you need to specify version 0.3.29 explicitly (either npm i mojito@0.3.29 or via package.json).

Bug Fixes

  • fixed the HelloMojit-tests in the default mojit archetype to prevent a test failure when running mojito test app . (as indicated in the Getting Started tutorial). The objects are not equal even if they have the same elements
  • updated controller.server.js and controller.server-tests.js code examples in getting_started to reflect the files generated by mojito 0.3.26
  • [bz5472517] Error on server doesn't propagate to client

version 0.3.28

Notes

  • Mojito depends on the latest patch release of YUI, currently YUI 3.5.1-2. This version of YUI fixes a Y.io issue which appeared in the last release. Also, as with the last Mojito release, YUI 3.5.x has removed built-in jsdom support. Server code that depends on a DOM will cause Mojito to throw an exception on startup. A warning will now be issued for known DOM dependent modules matching this criteria. Folks are asked to either move DOM dependencies to client affinities or binders, or create the required host objects for your application's DOM requirements. See http://yuilibrary.com/yui/docs/yui/nodejs.html. There may also be other app-specific issues with the upgrade in YUI.

Features

  • 726a2e4 Added -p option for jslint results to sdtout

Bug Fixes

  • #231 Update sys references to util references.
  • #219 [bz5651900] stop mojit data memory leak - record dynamically
  • #223 [bz5646042] log warning if server mojit has DOM dependency.
  • #232 [bz5649382] Fix for mojito test app.
  • fix dynamic mojit regression introduced in 2dd7313
  • fix unit test errors in build 130
  • [bz5491914] Fix client exception on ac.error()
  • [bz5649346] Updates yui and yuitest dependencies; +FreeBSD
  • [bz5494997] Fix for Mojito client throwing on tunnel timeout
  • More null fixes for Mustache
  • [bz5590319] Unicode and/or HTML escaping for config data.