'Push'ing data to a super forum key

[Todge]

I'm in the middle of a plugin that uses a Super Forum key to hold an array, and need to push data to the end of the key data when posting, but I have an issue..

If the key is empty, pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData); will start the key array with keyData being at position 0, as expected.

BUT, if I then try to pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData); again with another post, instead of appending the new keyData to the end of the array, the key is being overwritten with 'push'.

Am I doing something wrong, or have I discovered a bug?

[Wormopolis]

I didnt even know that was active yet..

[P̌̓aͧś̀t̀u͒le͆o͂2̀3̃̓]

Mar 18, 2014 17:49:44 GMT -8 Todge said:

I'm in the middle of a plugin that uses a Super Forum key to hold an array, and need to push data to the end of the key data when posting, but I have an issue..

If the key is empty, pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData); will start the key array with keyData being at position 0, as expected.

BUT, if I then try to pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData); again with another post, instead of appending the new keyData to the end of the array, the key is being overwritten with 'push'.

Am I doing something wrong, or have I discovered a bug?

The problem is that when you use the command set_on
It will use the action set. Not push.
(You think you are pushing, but your just setting. Which is functioning normally by overwriting all data)
You would need a push_on command (not developed by proboards)
Your 'push' should be the object id of the user. Except a Forum Key does Not Use an Object ID at all. 
MY SOLUTION
pb.plugin.key("updated_threads").push({value: keyData, error: function(error) {if(error.code == 64){ var newarray = $.grep(Array(),function(n){ return(n) }); pb.plugin.key('updated_threads').set({value: newarray, success: function(){pb.plugin.key("updated_threads").push({value: keyData}) } });} } });


I use a less elegant solution to set a Super Forum Key.
It pushes to the key, and if the data type is error 64, it will set the key to a blank array so that it can be pushed to.
Now if you made some kind of attachment to the button they use to set the data, or possibly an ajaxcomplete or $(document).on (granted proboards sees it as 'setting a key by a user action'):
The result would be a key that stores data without the possibility of overwriting data.
Otherwise (the cheating way, Granted it should have updated data if an ajax request has been made right before you initiate. But I'm not sure if all ajax requests update a forum key's data)
It would look something like Every Time keyData Changes:
var originalkey =pb.plugin.key('updated_threads').get()
if(originalkey == undefined)
{keyData = [keyData]}
else {keyData = originalkey.push(keyData)} //assuming keyData was a string and now an array
pb.plugin.key('updated_threads').set_on('post_new', null, keyData);

I would assume an approach like that would work.
If you like something I have posted feel free to use, no permission required.
If you have further questions or understanding of a forum key/keys just tag me in a post, I use two forum keys in the Eshop plugin, so I have worked with them for around 4 months.

The real trick I have is how to remove an item from the middle of an array without overwriting or losing data
Also I would note that you should check and do some experimenting to find the size limit of your forum key and putting in a function that will prevent writing to the key before it overloads/explodes and kills your plugins

[Tim Camara]

Mar 18, 2014 17:49:44 GMT -8 Todge said:

pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData);

That functionality doesn't exist yet.

[Bob]

Mar 19, 2014 7:45:33 GMT -8 Tim Camara said:

Mar 18, 2014 17:49:44 GMT -8 Todge said:

pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData);

That functionality doesn't exist yet.

Can we take this as indication that such functionality will exist in the near future?

[Wormopolis]

Mar 19, 2014 7:45:33 GMT -8 Tim Camara said:

Mar 18, 2014 17:49:44 GMT -8 Todge said:

pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData);

That functionality doesn't exist yet.

well now I know I didnt miss a memo..

when this does get released, can the thread about keys get updated to explain usage?   

[Tim Camara]

Mar 19, 2014 11:00:05 GMT -8 Bob said:

Mar 19, 2014 7:45:33 GMT -8 Tim Camara said:

That functionality doesn't exist yet.

Can we take this as indication that such functionality will exist in the near future?

You absolutely can!  Plugin enhancements are high on my list of tasks to work on as soon as our large project is finished.

Mar 19, 2014 11:38:00 GMT -8 Wormopolis said:

Mar 19, 2014 7:45:33 GMT -8 Tim Camara said:

That functionality doesn't exist yet.

well now I know I didnt miss a memo..

when this does get released, can the thread about keys get updated to explain usage?   

It will be updated, along with the API (which should be the new go-to for this kind of stuff).

[Todge]

Mar 18, 2014 22:13:28 GMT -8 Wormopolis said:

I didnt even know that was active yet..

Mar 19, 2014 7:45:33 GMT -8 Tim Camara said:

Mar 18, 2014 17:49:44 GMT -8 Todge said:

pb.plugin.key('updated_threads').set_on('post_new', 'push', keyData);

That functionality doesn't exist yet.

I didn't think it did either, but decided to give it a go and see.. When the first attempt with an empty key worked I thought 'Woohoo... Here we go then...', but then, after the second attempt to push data ended in a key's element length of 4 instead of 2 totally threw me, and had me scratching my head for maybe an hour until I realised it was no longer an array but the absolute length.

Ho-hum.

Mar 19, 2014 1:11:03 GMT -8 P̌̓aͧś̀t̀u͒le͆o͂2̀3̃̓ said:

The problem is that when you use the command set_on
It will use the action set. Not push.
(You think you are pushing, but your just setting. Which is functioning normally by overwriting all data)
You would need a push_on command (not developed by proboards)
Your 'push' should be the object id of the user. Except a Forum Key does Not Use an Object ID at all. 
MY SOLUTION
pb.plugin.key("updated_threads").push({value: keyData, error: function(error) {if(error.code == 64){ var newarray = $.grep(Array(),function(n){ return(n) }); pb.plugin.key('updated_threads').set({value: newarray, success: function(){pb.plugin.key("updated_threads").push({value: keyData}) } });} } });


I use a less elegant solution to set a Super Forum Key.
It pushes to the key, and if the data type is error 64, it will set the key to a blank array so that it can be pushed to.
Now if you made some kind of attachment to the button they use to set the data, or possibly an ajaxcomplete or $(document).on (granted proboards sees it as 'setting a key by a user action'):
The result would be a key that stores data without the possibility of overwriting data.
Otherwise (the cheating way, Granted it should have updated data if an ajax request has been made right before you initiate. But I'm not sure if all ajax requests update a forum key's data)
It would look something like Every Time keyData Changes:
var originalkey =pb.plugin.key('updated_threads').get()
if(originalkey == undefined)
{keyData = [keyData]}
else {keyData = originalkey.push(keyData)} //assuming keyData was a string and now an array
pb.plugin.key('updated_threads').set_on('post_new', null, keyData);

I would assume an approach like that would work.
If you like something I have posted feel free to use, no permission required.
If you have further questions or understanding of a forum key/keys just tag me in a post, I use two forum keys in the Eshop plugin, so I have worked with them for around 4 months.

The real trick I have is how to remove an item from the middle of an array without overwriting or losing data
Also I would note that you should check and do some experimenting to find the size limit of your forum key and putting in a function that will prevent writing to the key before it overloads/explodes and kills your plugins

Thanks for the suggestion P̌̓aͧś̀t̀u͒le͆o͂2̀3̃̓, but if I can't push to the key directly I may as well just recreate the array with the changes needed and re-write the key with a normal set_on('post_new') call. My reason for not doing this anyway was to stop the chance of posts being lost if someone sat on the posting page while other posts were being made elsewhere.

As for the key length, I have that in hand. Super Forum keys are 32,000 bytes available for storage, and as only one plugin is allowed to access any key one key, it's a simple matter of keeping tabs on the amount of data the plugin is trying to store.

Thanks again though.