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

Changes made so the websocket proxy can work with buffered stores. #25

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
38 changes: 33 additions & 5 deletions WebSocket.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,12 @@ Ext.define('Ext.ux.data.proxy.WebSocket', {
/**
* @cfg {Boolean} keepUnsentMessages Keep unsent messages and try to send them back after the connection is open again.
*/
keepUnsentMessages: true
keepUnsentMessages: true,

/**
* Callback counter for buffered stores.
*/
callbackCounter: 1
},

/**
Expand Down Expand Up @@ -441,6 +446,9 @@ Ext.define('Ext.ux.data.proxy.WebSocket', {
*/
read: function (operation) {
this.runTask(this.getApi().read, operation);

// return value required for buffered store.
return 1;
},

/**
Expand Down Expand Up @@ -472,10 +480,18 @@ Ext.define('Ext.ux.data.proxy.WebSocket', {
var me = this ,
data = {} ,
ws = me.getWebsocket() ,
i = 0;
i = 0, callback;

// buffered store.
if (operation._limit){
callback = action + "_" + this.callbackCounter;
this.callbackCounter ++;
} else {
callback = action;
}

// Callbacks store
me.callbacks[action] = {
me.callbacks[callback] = {
operation: operation
};

Expand All @@ -487,6 +503,10 @@ Ext.define('Ext.ux.data.proxy.WebSocket', {

// copy any sorters, filters etc into the params so they can be sent over the wire
Ext.applyIf(data, me.getParams(operation));

// Copy read operation callback name to match.
if (operation._limit)
Ext.apply(data, {"callback": callback});
}
// Create, Update, Destroy
else {
Expand All @@ -508,12 +528,20 @@ Ext.define('Ext.ux.data.proxy.WebSocket', {
* Completes a pending operation (push/pull)
* @private
*/
completeTask: function (action, event, data) {
completeTask: function (action, e, data) {
var me = this ,
event,
resultSet = me.getReader().read(data);

// Data for buffered stores should have a callback parameter matching the request because the buffered store can do multiple reads at the same time.
if (data.callback){
event = data.callback;
} else {
event = e;
}

// Server push case: the store is get up-to-date with the incoming data
if (!me.callbacks[event]) {
if (!data.callback || !me.callbacks[event]){
var store = Ext.StoreManager.lookup(me.getStoreId());

if (typeof store === 'undefined') {
Expand Down
42 changes: 42 additions & 0 deletions demo/demo.js
Original file line number Diff line number Diff line change
Expand Up @@ -172,4 +172,46 @@ Ext.onReady(function () {
height: 300,
store: treeStore
});

var bufferedStore = Ext.create('Ext.data.Store',{
storeId: 'myBufferedStore',
autoLoad: true,
buffered: true,
pageSize: 50,
loadingBufferZone: 150,
trailingBufferZone: 150,
remoteSort: true,
remoteFilter: true,
fields:['id','name'],
proxy: {
type: 'websocket',
url: 'ws://localhost:9001',
storeId: 'myBufferedStore',
api: {
read: 'buffered/read'
},
reader: {
type: 'json',
rootProperty: 'data',
totalProperty: 'totalCount'
}
}
});

var bufferedGrid = Ext.create('Ext.grid.GridPanel',{
renderTo: Ext.getBody(),
store: bufferedStore,
title: 'WebSocketed Infinite Scrolling',
width: 500,
height: 300,
columns: [{
dataIndex: 'name',
header: 'name',
flex: 1
}],
viewConfig: {
loadMask: false,
reserveScrollbar: true
}
});
});
18 changes: 18 additions & 0 deletions demo/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,24 @@ wss.on('connection', function (ws) {
}
}));
}
else if (event === 'buffered/read'){
var dat = [];
for (var t=0; t<message.data.limit; t++){
dat.push({
id: Faker.Helpers.randomNumber(1000000),
name: Faker.Name.firstName() + " " + Faker.Name.lastName()
});
}
ws.send(JSON.stringify({
event: event,
data: {
callback: message.data.callback,
data: dat,
totalCount: "10000",
success: true
}
}));
}
else if (event === 'update') {
message.data.forEach(function (user) {
var index = -1;
Expand Down