Add Logout Callback Functionality

[Zingzy]

Overview

This PR introduces the ability to register and execute callback functions upon user logout in the SimpleLogin class. This enhancement allows users to perform custom actions, such as logging events or clearing additional session data, immediately after a user logs out.

Changes

• Modified logout Method:

  • The logout method now iterates over a list of registered callbacks and executes each one after clearing the session and flashing the logout message.

• New Method register_on_logout_callback:

  • Added a new method register_on_logout_callback to allow users to register their custom callback functions.

• Updated Tests:

  • Enhanced the existing logout test to verify that the registered callbacks are executed upon logout.

Code Example

Here's how users can register their custom callbacks:

def my_post_logout_callback():
    print("User has logged out")

def another_post_logout_callback():
    print("Another action after logout")

app = Flask(__name__)
simple_login = SimpleLogin(app)
simple_login.register_on_logout_callback(my_post_logout_callback)
simple_login.register_on_logout_callback(another_post_logout_callback)

Testing

• Manual Testing:

  • Verified the functionality by running a local Flask application and observing the console output upon logout.

• Automated Testing:

  • Updated the test suite to include checks for the new callback functionality.
  • Ran the tests using pytest to ensure all tests pass successfully.

Additional Notes

• Users can register multiple callbacks, and they will be executed in the order they were registered.

This PR addresses issue #36

[Zingzy]

Hello @cuducos please review this pr 😄

[cuducos]

Thank you for the great PR description! I appreciate the effort you put into it.

I kindly ask that you refrain from commenting for reviews, as it adds unnecessary noise to my inbox. I have a full-time job and a personal life, along with my involvement in this and other open-source projects. Please rest assured that I will review your code as soon as possible, but I do have other priorities now. Thank you for your understanding 💜

[Zingzy]

Thank you for the great PR description! I appreciate the effort you put into it.

I kindly ask that you refrain from commenting for reviews, as it adds unnecessary noise to my inbox. I have a full-time job and a personal life, along with my involvement in this and other open-source projects. Please rest assured that I will review your code as soon as possible, but I do have other priorities now. Thank you for your understanding 💜

Hey, I am really sorry, I do understand... Please take your time to review this PR 😀

[cuducos]

This PR is great, thank you so much.

Before moving forward, I would like to ask you two things:

• Can you add something about the new feature to the docs? You have great content as the PR description you could just move there
• Are you familiar with unittest.mock? I suggest we refactor the test you added

None of my comments are blocking, I just wanna you to let me know if you are ki to address them, so I can keep this PR open. Otherwise, I'll merge and fix them in follow up work.

[Zingzy]

This PR is great, thank you so much.

Before moving forward, I would like to ask you two things:

• Can you add something about the new feature to the docs? You have great content as the PR description you could just move there
• Are you familiar with unittest.mock? I suggest we refactor the test you added

None of my comments are blocking, I just wanna you to let me know if you are ki to address them, so I can keep this PR open. Otherwise, I'll merge and fix them in follow up work.

Hey @cuducos thank you for reviewing my PR, I would like to fix all of the issues 😄

[Zingzy]

@cuducos could you please specify which part of the existing documentation should I add the docs about this feature and which things do I need to mention there?

[cuducos]

I was thinking about a section in Configuring. The examples there should give you an idea about what to include, right?

[cuducos]

Looks great ✨ Thank you so much, @Zingzy 💜