LC0098 - Add object type for event subscribing naming format

[ernestasjuska]

Hi,

LC0098 does not allow us to configure our event subscriber naming convention: ({Object Type} {Object Name}) {Event Name}, e.g. (Codeunit System Initialization) OnAfterLoginor(Table Sales Line) OnAfterModifyRecordEvent`.

For events subscribers that refer to same object we use (Self) or (This), e.g. internal event subscriber (Self) OnGetSelf. These are rare, so supporting this is nice to have.

Please add Object Type specifier.

Thanks.

[Arthurvdv]

Hi @ernestasjuska, thanks for raising this. I want to make sure I understand exactly what you're after before scoping anything, because there's a bit to unpack here.

The way LC0098 works today, SubscriberNamingPattern is a template of placeholders + literal text, so the (…) … structure you're after is mostly expressible already. The placeholders are {Event Source} (the subscribed object's name), {Event Name} and {Element Name}, plus […] optional groups and casing variants — but there is no placeholder for the object type (Codeunit, Table, …).

So for an example like:

[EventSubscriber(ObjectType::Codeunit, Codeunit::"System Initialization", 'OnAfterLogin', '', false, false)]

• Today you can already get (System Initialization) OnAfterLogin with a template such as ({Event Source}) {Event Name}.
• To get (Codeunit System Initialization) OnAfterLogin I'd need to add a new {Object Type} placeholder that renders the subscribed object's type.

That last part is the core of your request as I read it — could you confirm that's right?

Two things I'd like to pin down before I look at scope:

1. Where does the element name go? Your examples don't have one, but many subscribers do — e.g. field validation events:

[EventSubscriber(ObjectType::Table, Database::"Sales Line", 'OnAfterValidateEvent', 'No.', false, false)]

How would you want that named under your convention — e.g. (Table Sales Line) OnAfterValidateEvent No., or something else? I want to match your intent rather than guess.

2. (Self) / (This) — what exactly triggers it? I read this as: when the subscribing object is the object being subscribed to, use (Self)/(This) instead of (Codeunit …). Can you confirm that's the rule — i.e. compare the subscriber's own object against the subscribed object — and whether you'd want Self vs This fixed or configurable?

It would really help if you could share a few concrete AL code examples of subscribers together with the exact procedure name you'd expect for each — including a field event and a (Self)/(This) case. That would give me a much clearer and more complete picture of what you have in mind.

[ernestasjuska]

Yes, same event name can be used in different object types so that part is important, eg.:

[EventSubscribe(ObjectType::Codeunit, Codeunit::"LBCLIC License", OnBeforeGetDescription, '', false, false)]
local procedure "(Codeunit LBCLIC License) OnBeforeGetDescription"(var Description: Text; var Handled: Boolean)
begin
    // ...
end;

[EventSubscribe(ObjectType::Codeunit, Codeunit::"LBCLIC License", OnBeforeGetDescription, '', false, false)]
local procedure "(Table LBCLIC License) OnBeforeGetDescription"(var Description: Text; var Handled: Boolean)
begin
    // ...
end;

Without object type part, you get procedure name collision and will do so thing like adding suffix "2".

(This), (Self) is for event subscribers that are in the same codeunit, e.g.:

[InternalEvent(true, false)]
local procedure OnGetSelf(var SelfLicense: Codeunit "LBCLIC License")
begin
end;

// "(Self) OnGetSelf", "(This) OnGetSelf", "(Table LBCLIC License) OnGetSelf" are all acceptable in this case.
[EventSubscribe(ObjectType::Codeunit, Codeunit::"LBCLIC License", OnGetSelf, '', false, false)]
local procedure "(Self) OnGetSelf"(var Sender: Codeunit "LBCLIC License"; var SelfLicense: Codeunit "LBCLIC License")
begin
    SelfLicense := Sender;
end;

Thanks.

[MODUSCarstenScholling]

Thank you very much for the explanation. In general, it makes sense to me.

However, I would limit the correction to {Object Type} and its subtypes and not implement a special case for Self. There would be too many possibilities that would then need to be configurable: self, this, current, instance, me, owner... You mentioned this as optional in the beginning. Do you agree @ernestasjuska ?