Small action CustomComponent argument issue

Dev
1

I’m trying to optionally replace a post small action description with a CustomComponent.

However, the post is not correctly passed to the value transformer.

Core code

  @cached
  get CustomComponent() {
    return applyValueTransformer("post-small-action-custom-component", null, {
      actionCode: this.code,
      post: this.post,
    });
  }

My debugging code

  api.registerValueTransformer(
    "post-small-action-custom-component",
    (arg) => {
      console.log(arg);
    }
  );

Output:

context: Object { actionCode: "bid", post: undefined }
​​
The test does not check the parameters, so this goes unnoticed.

I guess the post parameter should be this.args.post and not this.post.

I’ve been trying a workaround by unconditionally adding the component and having it check itself what to do but unfortunately it seems like the arguments are not being passed correctly either so both the workaround and a normal implementation fail here as well:

              <this.CustomComponent
                @code={{this.code}}
                @post={{this.post}}
                @createdAt={{this.createdAt}}
                @path={{this.path}}
                @username={{this.username}}
              />

There are getters in PostSmallAction for code, createdAt and path, but (again) this.post does not exist and username() seems to have a bug as well (there is no action_code_who in this.args.post ?) , so those attributes stay empty.

I can’t find an existing “real world” implementation. Am I really the first one to use this ? :thinking:

2 Likes
2

I have made a PR that fixes this issue FIX: correct argument passing for small action post value transformer and custom component by communiteq · Pull Request #34915 · discourse/discourse · GitHub

@david @saquetim could you have a look please :pleading_face:

2 Likes
3

Thank you for noticing this issue.

You’re correct; the post parameter should be this.args.post instead of this.post.

username is a bit misleading here. action_code_who is indeed correct but is used by some plugins like the assign plugin, so it’s not always present in the post object. To get the user who created the small action, you can use @post.username

I wasn’t sure if I could push changes to your PR, so I opened the one below to address these issues:

  • fix the post argument passed both to the transformer and the custom component
  • rename the username argument to who minimizing the confusion around this argument
  • add tests to verify the arguments are passed correctly
4

I think you are. :smiley:

AFAIK, the old API wasn’t used in any of the customizations we track in the all-the-* repos. I only added this one to provide an alternative in case a self-hoster was using it.

5

:rocket: great!

Well, thank you for being proactive :slight_smile:
I think discourse-encrypt used-to-use it, and three (!) private plugins that we’re maintaining.

Thank you for explaining, I didn’t understand how this worked, and I do now.

Last favor to ask: could your fix be backported to stable as well?

6

The fix was backported to stable.

1 Like
7

This topic was automatically closed 24 hours after the last reply. New replies are no longer allowed.