Skip Navigation
Perchance - Create a Random Text Generator @lemmy.world VioneT @lemmy.world
Bug/Suggestion

[Bug/Suggestion] create-instance-plugin Doesn't Fix Deep Properties with Same Level Lists

Suppose we have the following list:

createInstance = {import:create-instance-plugin}

person
  name = [this.nameList]
  nameList
    Salman
    Manny
    Rhian
  age = {31-49}
  child = [this.child_obj]
  child_obj
    name = [this.nameList]
    nameList
      Anne
      Arram
      Amelia
    age = {3-17}

If we output:

[p = createInstance(person, "deep"), p.name] [p.age] [p.name] [p.age]

We can see that it has fixed the name and the age property on the instance. However, if we output:

[p = createInstance(person, "deep"), p.child.name] [p.child.age] [p.child.name] [p.child.age]

It would throw undefined. Now looking at similar list:

person
  name = {Salman|Manny|Rhian}
  age = {31-49}
  child = [this.child_obj]
  child_obj
    name = {Anne|Arram|Amelia}
    age = {3-17}

output
  [p = createInstance(person, "deep"), p.child.name] [p.child.age] [p.child.name] [p.child.age]

This would have the values fixed and working.

Looking at the code of the create-instance-plugin, it would only allow the 'deep' fixing of properties if there isn't any items/lists in it. What that means is the following:

child_obj
  name = [this.nameList]
  nameList
    Anne
    Arram
    Amelia
  age = {3-17}

This object/list, has a list ( nameList) within it as well as properties (name and age), while:

child_obj
  name = {Anne|Arram|Amelia}
  age = {3-17}

Only has properties. and based on Line 22 of the create-instance-plugin:

...
} else if(propValue.getPropertyKeys && propValue.getPropertyKeys.length > 0 && propValue.getLength === 0) {
...

If the list to be fixed has a list within it other than the properties i.e. propValue.getLength is not zero, then it wouldn't fix the properties within it.

The first child_obj has a nameList with it, and upon calling propValue.getLength it would have 1 while the second child_obj will return a propValue.getLength of 0 since it doesn't have any lists.

Thus, the solution for the problem is just removing the propValue.getLength === 0 check OR create another check without it.

TLDR; propValue.getLength === 0 at Line 22 of the create-instance-plugin can be removed to allow properties that rely on same level lists to be fixed. Here is the demo of the problem with a 'remixed' create instance plugin with the fix.

6
6 comments

  • Thanks for this! I was just looking into it, and I noticed this comment at the bottom of the code in create-instance-plugin:

    // Important counter-intuitive thing to take note of: https://www.reddit.com/r/perchance/comments/nh31xq/the_best_hack_for_methods_in_list_instances/gz0rebt
// the "deep" option of the createInstance plugin is kinda messed up. I should warn people that the [child] list should ONLY have properties - no sub-lists. That basically solves everything, but it's a bit annoying in many cases. Ideally I'd have only called selectOne on a list if it has no properties (i.e. with equals sign). If it has properties it should be treated just as part of the hierarchical blueprint, and those sub-items should get fixed, rather than having selectOne called on it.
// I basically need a new plugin. createInstance2 = {import:create-instance-2-plugin}
// That's the ideal solution here.
// https://perchance.org/hiad2okk9w

    Which, IIUC, is exactly what you're talking about here.

    So I was reluctant to make that change back then due to potentially breaking peoples' generators. With the number of generators that use this, it's possible that people are "using" this ~bug. On the other hand, it is hard to see why someone would use "deep", and not want the deep properties fixed. It does seem like the current behavior would be causing more pain to people trying to use it right now than the pain caused by breaking old generators that actually wanted random sub-sub-properties even though they used the "deep" mode.

    I.e. seems like the generator would already have to be "buggy" for this change to cause any issues. Hmm. Yeah, on balance this does seem like it should be categorized as a bug, and fixed. The lower-level lists should be treated just like the upper-level lists - intuitively, that's exactly what is meant by "deep". Thoughts?

    • Hmm. Thinking about this more, I'm really reluctant to do this in case it breaks old generators - even though it's hard to imagine someone relying on this 'bug' on purpose. So what I might do instead is expose a new window.generatorLastEditTime variable (like window.generatorName and window.generatorPublicId), and only enable the new behavior if the last save time of the generator is newer than today. So if people are still actively working on their generator now then they'll get the new behavior, and if it does break something they'll be able to notice and fix it. But for old generators, they get to keep the old behavior until the author comes back to it and makes an edit.

      I think that strikes a good balance here. What do you think?

      • I think that is a nice idea. I think, if the generator is not updated recently, maybe create an alert() to alert the generator owner that it might give bugs if they update their generator,? also to let them know that a change has been made and it 'might' break their generator if they update.

        EDIT: I think that it wouldn't break much since with the current create-instance-plugin they wouldn't actually be able to use lists in deeper instances since it would automatically return undefined, which would mean the users that tried to do what I did, didn't do it since it throws undefined in their code. So, I would hope that it wouldn't break generators much.

  • @[email protected] pinging dev

6 comments