[SW-827] Added alter hook for cardLinkEnhancer to handle the url belongs to other sites.

[MdNadimHossain]

Jira

https://digital-engagement.atlassian.net/browse/SW-827

Issue

For the card consolidation story, a new enhancer is added named cardLinkEnhancer. When an internal link is added to the card link field and the added links belong to another site, the FE throws an error on trying to access that link. There is a alter hook for tide_path_enhancer tide_site_tide_path_enhancer_undo_transform_alter that resolves this and the same functionality is need for the cardLinkEnhancer alter hook.

Changes

1. Added functionality in the cardLinkEnhancer alter hook to handle the link that belongs to other sites.

Related PRs -

dpc-sdp/tide_landing_page#131

Future work

A ticket is created to build a helper function which will be called in both of the alter hook for path enhancer and cardLinkEnhancer as they both are doing the same functionalities. It needs a solution direction and broader test case as the path enhancer is is used widely in all projects.
Ticket - https://digital-engagement.atlassian.net/browse/SDPA-5062
Testing PR- #83

[vincent-gao]

Hey @MdNadimHossain , I think you have to define your own alter API first, otherwise it wouldn't work, an example can be found here https://github.com/dpc-sdp/tide_core/blob/develop/modules/tide_workflow_notification/tide_workflow_notification.api.php.
correct me if I am wrong @GROwen .

[MdNadimHossain]

@vincent-gao yup it is already defined here - https://github.com/dpc-sdp/tide_landing_page/blob/80911c88485b21796c80eee6c8dd51016720095e/src/Plugin/jsonapi/FieldEnhancer/CardLinkEnhancer.php#L43

[vincent-gao]

I meant a tide_site.api.php or you can use drupal/symfony event system.

[MdNadimHossain]

Hey @vincent-gao actually it worked. These are the PR environments -
BE - https://nginx-php.pr-1056.content-vic.sdp1.sdp.vic.gov.au
FE - https://app.pr-838.vic-gov-au.sdp1.sdp.vic.gov.au

[vincent-gao]

@MdNadimHossain , just one question, where did you define hook_tide_card_link_enhancer_undo_transform_alter().?

it says Implements hook_tide_card_link_enhancer_undo_transform_alter(). ,but I cannot find the definition of this hook.
https://github.com/dpc-sdp/tide_site/pull/82/files#diff-1845b0bf3e6a368afb536e79493a96b8973e50352bb4cf725f0a1fb8b42752f9R805

[MdNadimHossain]

@MdNadimHossain , just one question, where did you define hook_tide_card_link_enhancer_undo_transform_alter().?

Hey @vincent-gao , here - https://github.com/dpc-sdp/tide_landing_page/blob/80911c88485b21796c80eee6c8dd51016720095e/src/Plugin/jsonapi/FieldEnhancer/CardLinkEnhancer.php#L43
isn't this defines the alter hook for a function - ModuleHandler::alter !

[vincent-gao]

@MdNadimHossain , just one question, where did you define hook_tide_card_link_enhancer_undo_transform_alter().?

Hey @vincent-gao , here - https://github.com/dpc-sdp/tide_landing_page/blob/80911c88485b21796c80eee6c8dd51016720095e/src/Plugin/jsonapi/FieldEnhancer/CardLinkEnhancer.php#L43
isn't this defines the alter hook for a function - ModuleHandler::alter !

Hi @MdNadimHossain , I think you might want to explicitly define a hook by create a {module_name}.api.php file. so other devs could be easily understand that they can use your API.

[MdNadimHossain]

@MdNadimHossain , just one question, where did you define hook_tide_card_link_enhancer_undo_transform_alter().?

Hey @vincent-gao , here - https://github.com/dpc-sdp/tide_landing_page/blob/80911c88485b21796c80eee6c8dd51016720095e/src/Plugin/jsonapi/FieldEnhancer/CardLinkEnhancer.php#L43
isn't this defines the alter hook for a function - ModuleHandler::alter !

Hi @MdNadimHossain , I think you might want to explicitly define a hook by create a {module_name}.api.php file. so other devs could be easily understand that they can use your API.

@vincent-gao good point, I will add it in the tide_landing_page module as this hook belongs to the landing page module.

[MdNadimHossain]

@vincent-gao I have added the hook info in tide_landing_page api here - dpc-sdp/tide_landing_page#135