allowing plugins to clear their local storage
hey everyone :3
i am trying to write a plugin that kinda has an eye out for one with how much time one spends on fedi.
anyways part of that is writing some stuff to local storage with Mk:save as i think provided by packages/frontend/src/scripts/aiscript/api.ts. now it would be great to be able to clear them because from my understanding they would just kinda acrew given i'd use a date for the key. avoiding setting too many of those keys would mean doing something like setting the key to anything constant really instead of the date, then setting the value to something like the string interpolated (idk gitlab markdown parsing not following the spec here?) {date}:{actual_value} in the value, splitting that and then doing the thingies. which would be slightly evil.
so i'd like to propose adding something like:
'Mk:remove': values.FN_NATIVE(([key]) => {
utils.assertString(key);
miLocalStorage.removeItem(`aiscript:${opts.storageKey}:${key.value}`);
return values.NULL;
}),i think this works like i havent tested it or anything though. uhnm and i hope this is fine to propose kinda outta the loop with where everything is at, yes uhnm would be nice.
edit: and if anyone has a good way with which i could check if the window is in focus that would be
great as well, the other ideas i had for checking the activity were a bit cursed.
edit edit (for the case anyone finds this when looking it up umhn doing stuff with the Plugin:register_*_interruptor things works great :>
Activity
first of all, it's always fine to ask questions and suggest improvements, so thank you for this ticket.
secondly: we could, as you suggest, easily add a "remove" function, but then your plugin would only work with Sharkey and not with other Misskey forks. This may or may not be a concern for you.
as an alternative, you could store a more complex data structure under a single key: instead of
Mk::save('2024-05-16',1);Mk:save('2024-05-17',2)you couldMk:save('date-values',{'2024-05-16':1, '2024-05-17':2})(or whatever the proper syntax is, I'm not really familiar with AiScript, but from the source code I see nothing that would stop you from saving a complex data structure)about the focus: I don't think it's possible…
@Leah is our resident AiScript expert, she can probably correct me.
ah okay, i see, thanks, yeah thats probably the way to go then. do you think it makes sense to raise this to 'upstream' misskey? i mean it doesn't seem like a big improvement. i mean it is generally nice i'd think but yeah not nearly as relevant as i assumed then.
(also i figured out a good way for the focus :> i put it in the description)
edit: also ig feel free to close the issue then :> i think this is resolved for me, thanks again!
Yes and while there is no direct delete you can always set it to null if you want to clear it. Im not quite sure if this actually deletes the entry (Probably just sets it to null but if you use your storage smartly then this should be fine). I have not run into any limits so far with this.
Yes, this would probably be better raised to upstream if we want aiscript stuff to function everywhere. If we were to implement something id like it to work universally. Perhaps setting it to null actually clears the key (especially since if you Mk:load a key that doesn't exist its null so it wouldn't matter). This is something we could implement without breaking compatibility.
As for what dakkar said to store json objects. While I have not tested this if worst comes to worst you can stringify them and parse them.
Also regarding checking if the window is in focus: I can't think of any way to do that sadly. Unfortunately, this language and its APIs are quite lacking but adding to it means Sharkey plugins won't work on any other *key. There are also quite a few changes and fixes that need doing but again it would be best to elevate them if possible otherwise we would want to find a way to add stuff that won't crash on other *key's.
-
btw not related to this issue but I wrote a blog that should help you with AIscript if you are ever stuck... and if not at the bottom I have a collection of useful links, docs, and more https://blog.winter-software.com/2024/04/01/Making_Your_First_Misskey_Plugin
@Leah as in the edit and maybe for your future use(?) idk like registering all interruptors catches most cases and you can check with
Async. i'm pretty happy with this solution(also i dont have anything else for this issue, so i mean yes depending on overwriting setting null -> delete as an idea that might be open but yis, otherwise please feel free to close the issue)
