catberry / catberry Goto Github PK

Add profiles support to be able to implement different templates for several types of devices (smartphones, tables, desktop and etc) by their screen sizes.

Now module has not any user context, but should. There is only one client/server side way to do that - use cookies.

Implement something like context provider which can save some data per one request process. Main goal is to reuse data of one rendering process in another one.

We can render children of any placeholder in parallel at client-side and receive great performance improvement.

It is very useful to have http(s) request implementation for both client and server usage in modules. This new feature is called UHR (Universal HTTP request) and will be accessible for all modules via dependency injection and service locator.

Now if module handles hash event and change its placeholder states then after re-rendering placeholders will be in invalid state.

This module fully-independent and should be moved to separated package.

When link is "../some" or "some" it always reloads page but should use client-side routing.

Add basic assets building using gulp.

Every module has templates and some resources which need to process (copy, replace URLs, minify etc) and publish.

Catberry must execute all required gulp tasks.

Now any error in module stops page rendering on server-side. This is bad, it should only show error in placeholder where was error but whole page should be loaded on client.

Error handling should be the same on client and server and work in 2 modes:
Debug - all errors are shown with details and stack
Release - no errors are shown only special __error template or nothing.

Now every event on page should change URL hash. It is very useful for links sharing when you need to restore the same page state by link but in some situations events are just client-side events and not need to share it via links.

In this case it is needed to handle link clicks as just events without hash changes if "a" tag has data-event attribute.

Now modules can not update their placeholders by itself but there is situation when module should update some own placeholders because of push notification.

Need to add such Module API which solve this problem.

After refresh form data dependents hash events does not raise again.

Need to have ModuleBase constructor and userland modules should inherit ModuleBase.

ModuleBase should have:

• Auto render methods support (if placeholder name is such-wow-placeholder then render method renderSuchWowPlaceholder should be invoked)
• Auto handle methods support (same for events)
• Auto submit methods support (same for forms)

Now there is no ability in module to invoke some method after placeholder is rendered or event is handled or form is submitted. It is useful to have ability to set 'after' function in every callback.

When load page with hash in new tab and then click on link with client rendering it reloads page.

When submit special form on page (with special attributes) all form data should be sent to related module.

SAX parser is too complicated and slow for Catberry. It has too much functionality which Catberry does not need.

It will be a huge performance improvement to replace it with own simple parser which just search for HTML tags with ID attribute and raise event when it has found it.

Also need to implement pause/resume functionality or make this parser a stream.

When placeholder has HTML comments that end at the end of file it causes exception:

catberry/lib/server/streams/ParserDuplex.js:242
            var tag = String.concat(this._tagBuffer,
                             ^
TypeError: Object function String() { [native code] } has no method 'concat'
    at PlaceholderTransform.ParserDuplex._parseTokens (/Users/pragmadash/Projects/flamp/node_modules/catberry/lib/server/streams/ParserDuplex.js:242:21)
    at PlaceholderTransform.ParserDuplex._write (/Users/pragmadash/Projects/flamp/node_modules/catberry/lib/server/streams/ParserDuplex.js:107:7)
    at doWrite (_stream_writable.js:226:10)
    at writeOrBuffer (_stream_writable.js:216:5)
    at PlaceholderTransform.Writable.write (_stream_writable.js:183:11)
    at write (_stream_readable.js:583:24)
    at flow (_stream_readable.js:592:7)
    at _stream_readable.js:560:7
    at process._tickCallback (node.js:415:13)

Module should have ability to change page title when rendering placeholder.

Now CookiesManager support read/write operations but can be used only for read access. Need to remove all unused functionality and improve usability.

Every hashtag change on page should raise an event in related modules and when change to another raise "end" event.

URL mapping does not work this way and all module parameters are wrong.

This module fully-independent and should be moved to separated package.

Need to find all callback usages and replace it with promises.

RFC 2616 14.23 says that it is required header in HTTP 1.1.

Because of catberry modules receive its state from URL query string need to implement some kind of translator with URL mapping.

For example:

/rubrics?page=1

map to

/index?index_tab=rubrics?index_page=1

We can render all placeholders tree in parallel and receive dramatically performance improvement.

Now every link click in browser forces to re-render all placeholders except root placeholder. This is unnecessary. Only placeholders for changed parameters should be re-rendered.

LinkedIn has helpers library for dust here https://github.com/linkedin/dustjs-helpers
Need to include it to catberry because these helpers are very useful.

It should use Accept-, Content-, Host, Origin, Pragma, Referer, User-Agent headers with request to describe sending and receiving data. All POST and PUT queries should be in URL encoded format.

Now there is no way to ignore modules and to not include it to client bundle. Need to add it.

It is needed to filter content when render head element placeholder.
We can not update script and link tags because it causes javascript re-execution and style re-applying.

It is useful to have method in module API to get cookie value by name.

Add to catberry object such method that checks browser support for ECMAScript 5 and History API.

It will be used for "Please update your browser page"

It should get "checked" attribute value, but it gets value attribute "on".

Status object has object instead status code.
Headers are presented as string but should be an object.

One of key features of catberry will be isomorphic module implementation: one module will work at server-side and client-side.

Therefore need to implement client-side part of framework for placeholder rendering and module API support.

If form has no data dependents it stays disabled after submit method.

There is an error in client-side request router that breaks some link features.

Because browser use _top as default fragment identifier. Need to restore position after clear hash.

If current link has hash and you click on link without hash all hash-related event handling stops working.

Need to document all implemented features and show it in example application.

When server has expired or invalid certificate UHR returns error. But during debugging it is useful to do unsafe HTTPS requests.

Need to add config parameter that turns off certificate check.

As @dentrifonov reported
When start catberry on Windows get something like this:

[2014-05-25 16:56:17.443] [ERROR] catberry - { [Error: module "........catberry_modulesmainindex.js" not found from "C:\\Users\\Denis\\Documents\\Projects\\sample\\webapp\\node_modules\\catberry\\lib\\client\\__bundle_entr
y.js"]
  filename: '........catberry_modulesmainindex.js',
  parent: 'C:\\Users\\Denis\\Documents\\Projects\\sample\\webapp\\node_modules\\catberry\\lib\\client\\__bundle_entry.js' }
Error: module "........catberry_modulesmainindex.js" not found from "C:\\Users\\Denis\\Documents\\Projects\\sample\\webapp\\node_modules\\catberry\\lib\\client\\__bundle_entry.js"
    at notFound (C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\index.js:811:15)
    at C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\index.js:761:23
    at C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\node_modules\browser-resolve\index.js:185:24
    at C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\node_modules\resolve\lib\async.js:44:14
    at process (C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\node_modules\resolve\lib\async.js:113:43)
    at C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\node_modules\resolve\lib\async.js:122:21
    at load (C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\node_modules\resolve\lib\async.js:54:43)
    at C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\node_modules\resolve\lib\async.js:60:22
    at C:\Users\Denis\Documents\Projects\sample\webapp\node_modules\catberry\node_modules\browserify\node_modules\resolve\lib\async.js:16:47
    at Object.oncomplete (fs.js:107:15)

If put some elements inside "a" tag and click it then nothing happens.

Now when parent placeholder is re-rendering all children placeholders becomes empty until it will not receive data from API again. We can save last data context and render last representation of child placeholder very fast and then request new data context from API and after that replace last representation with new one.