Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new App event "page", emitted when a new Page instance is created #640

Merged
merged 1 commit into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"mocha": "^10.0.0",
"prettier": "^3.0.1",
"racer": "^v2.0.0-beta.11",
"sinon": "^18.0.0",
"ts-node": "^10.9.2",
"typescript": "~5.1.3"
},
Expand Down
16 changes: 8 additions & 8 deletions src/App.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,13 @@ type Routes = [string, string, any][];
* APP EVENTS
*
'error', Error
'pageRendered', Page
'destroy'
'model', Model
'route', Page
'routeDone', Page, transition: boolean
'ready', Page
'load', Page
'destroyPage', Page
'model', Model - a new root model was created by the app, server and client
'page', Page - a new Page was created by the app, server and client
'ready', Page - app is ready to attach to server-rendered HTML, client only
'load', Page - app is fully loaded, client only
'destroyPage', Page - current Page is about to be destroyed, client only
'route', Page - app is about to invoke a route handler, client only
'routeDone', Page, routeType - app has finished running a route handler, client only
*/

export abstract class App extends EventEmitter {
Expand Down Expand Up @@ -427,6 +426,7 @@ export class AppForClient extends App {
const ClientPage = this.Page as unknown as typeof PageForClient;
const page = new ClientPage(this, this.model);
this.page = page;
this.emit('page', page);
return page;
}

Expand Down
1 change: 1 addition & 0 deletions src/AppForServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ export class AppForServer extends App {
});
page.on('error', next);
}
this.emit('page', page);
return page;
}

Expand Down
42 changes: 38 additions & 4 deletions test/all/App.mocha.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,48 @@
var expect = require('chai').expect;
var AppForClient = require('../../src/App').AppForClient;
const expect = require('chai').expect;
const racer = require('racer');
const sinon = require('sinon');
const AppForClient = require('../../src/App').AppForClient;
const { DerbyForClient } = require('../../src/Derby');
const { DerbyForServer } = require('../../src/DerbyForServer');

describe('App', () => {
afterEach(() => {
sinon.restore();
});

[DerbyForClient, DerbyForServer].forEach((DerbyClass) => {
describe(`from ${DerbyClass.name}`, () => {
it('createPage emits \'page\' event with newly created page', () => {
const derby = new DerbyClass();
// A properly working _init() requires a more complicated setup,
// especially for AppForClient, so stub it out since createPage()
// doesn't depend on anything in _init().
sinon.stub(derby.App.prototype, '_init');

const app = derby.createApp();
app.model = racer.createModel();

let pageFromEvent = null;
app.on('page', (page) => {
pageFromEvent = page;
});
const page1 = app.createPage({});
expect(pageFromEvent).to.equal(page1);
const page2 = app.createPage({});
expect(pageFromEvent).to.equal(page2);
});
});
});
});

describe('App._parseInitialData', () => {
it('parses simple json', () => {
var actual = AppForClient._parseInitialData('{"foo": "bar"}');
const actual = AppForClient._parseInitialData('{"foo": "bar"}');
expect(actual).to.deep.equal({ foo: 'bar' });
});

it('parses escaped json', () => {
var actual = AppForClient._parseInitialData('{"foo": "<\\u0021bar><\\/bar>"}');
const actual = AppForClient._parseInitialData('{"foo": "<\\u0021bar><\\/bar>"}');
expect(actual).to.deep.equal({ foo: '<!bar></bar>' });
});

Expand Down
Loading