feat: operation logs for enrollment requests

[julianramirez2]

Description

A logging system has been implemented to enable traceability of operations performed on Enrollment Requests. This system will describe the action focusing on the questions: "Who?" "When?" and "What?"

For each Enrollment Request accessed, a panel will appear on the right-hand side, displaying the history of actions carried out on the post.

Testing instructions

To test the entire functionality, the idea is to access the Enrollments Manager and create a new Enrollment Request. Then, make changes to it and compare the actions taken with the generated logs.

Checklist for Merge

• Tested in a remote environment
• Updated documentation
• Rebased master/main
• Squashed commits

[MaferMazu]

Looks good, but I have issues with the enrollment_request_type attribute because before, I had "Enroll," but the log said 1.
Another thing that is weird for me, but probably you have more experience with, is the order of the log. For some reason, I think the recent log should be at least not at the top, but I'm not sure what is the most intuitive form for WordPress operators. What do you think?

[julianramirez2]

Looks good, but I have issues with the enrollment_request_type attribute because before, I had "Enroll," but the log said 1. Another thing that is weird for me, but probably you have more experience with, is the order of the log. For some reason, I think the recent log should be at least not at the top, but I'm not sure what is the most intuitive form for WordPress operators. What do you think?

Initially, the idea of displaying the logs in this manner was based on how WooCommerce shows order notes, so it was most appropriate to follow that convention. However, considering the best UX practices, it is better to have the latest log displayed as the most recent one. It is more common and intuitive for users to read logs in this manner. Therefore, the correction was made, and now the logs are shown with the latest entry at the top and the oldest at the bottom.

[MaferMazu]

Thanks for taking that comment into account. And I think you mean the newer log at the bottom and the oldest at the top. Btw thanks for removing the general info field.

[MaferMazu]

I left you some comments. Please let me know what you think.

[MaferMazu]

@julianramirez2 remember to add the end line in includes/model/Openedx_Woocommerce_Plugin_Logs.php.

I test this in Stage and looks good. I have one comment: if we create an Enrollment Request always, the action is "Object Created," but if we create the object with another action, for example, "Process request," we lose that information. Maybe it's a good idea only use the "Object Created" if we don't have action and I created that object. What do you think?

The rest looks good to me ✨

I wonder if @jvegalo has some time to do a quick review of this.

[julianramirez2]

@julianramirez2 remember to add the end line in includes/model/Openedx_Woocommerce_Plugin_Logs.php.

I test this in Stage and looks good. I have one comment: if we create an Enrollment Request always, the action is "Object Created," but if we create the object with another action, for example, "Process request," we lose that information. Maybe it's a good idea only use the "Object Created" if we don't have action and I created that object. What do you think?

The rest looks good to me ✨

I wonder if @jvegalo has some time to do a quick review of this.

I just added a new field called "object_status" to clarify this. So, the request type will remain in the information, and we'll also have this new field indicating if an object is new with the message "Object Created" or if it has been modified with the message "Object Modified."

[MaferMazu]

I would like to know the opinion of @arangos since he knows more about good practices and quality in PHP than me. But for me looks good.

@arangos, do you have a chance to review this?

[arangos]

I would like to know the opinion of @arangos since he knows more about good practices and quality in PHP than me. But for me looks good.

@arangos, do you have a chance to review this?

Done

[MaferMazu]

Thanks for your contribution, @arangos.

[arangos]

@MaferMazu Ready for merge

[MaferMazu]

Looks good to me. Thanks for taking all into account @julianramirez2. Please add an end line in the CSS file and you can squash and merge.