MusicBrainz entity loader library

[jesus2099]

In order to, among other things, limit the amount of requests that is made, all scripts could share the loading of a single entity Web Service request.

• Like a singleton factory (if it’s called this way), at first request, the Web Service is called and some loading flag is set in localStorage so that further requests will wait and use the same result, once available.
• It manages retry on fail (will help #199 and #195)
• Once the result is obtained, the entity is stringified in the document so that all scripts can see it.
• It is also timestamped and cached in localStorage to avoid requesting the same thing several times in the same, let’s say, minute.
• Once the result is obtained, the entity is JSON stringified, timestamped and cached in localStorage to avoid requesting the same thing several times by any user script in the same, let’s say, minute.
• There could be some refresh button somewhere, especially for cached ones.
• Daily local storage clean‐up system.

  Script that requested WS entities (draft)

User script	Entity	Frequency	Cache
ALL LINKS	artist*	artist page*	yes
INLINE STUFF	release	release page	yes
INLINE TRACK ARTIST	recording	recording page	yes
MERGE HELPOR 2	artist, release group or release	merge page	no
RECORDING_LENGHT_COLUMN (SUPER TURBO)	artist\ or work	artist recordings and work page	yes
RELEASE_EVENT_COLUMN (SUPER TURBO)	artist\ or label	artist recordings and label page	yes

* all in the future (#187) \ those are shared request already

[loujine]

I'm really interested by this idea, I should also decrease the number of requests made by my scripts. Let me know if I can help

[jesus2099]

Oh so you also stumbled upon that ticket! Great! :) I think it's my next task, to work on this...

[jesus2099]

@loujine tell me if you have other ideas or if some ideas are wrong or anything (the notes in the first post).

[jesus2099]

I first thought of waiting for a few seconds delay to gather all client scripts requirements in terms of &inc= they need and then the WS call would only ask for those minimum set of &inc= that is enough for all scripts. But it seems simpler/faster/easier/etc. to just call the entity WS with all possible &inc=, always. What do you think, @loujine? :)