Add the ID type selection in the entitlement manager

[gonzalesedwin1123]

• In the entitlement manager, an ID type is added to select the type of ID to be used in generating entitlements.
• The ID type is also added in the "Create Program Wizard".
• When entitlements are generated, the beneficiaries ID documents are check for the ID type set in the entitlement manager. If the beneficiary have the ID type its ID number will be stored in the id_number field of the entitlements.

[jeremi]

@CodiumAI-Agent /review

[CodiumAI-Agent]

PR Analysis

• 🎯 Main theme: Adding ID type selection in the entitlement manager
• 📝 PR summary: This PR introduces the ability to select an ID type in the entitlement manager, which is then used in generating entitlements. The ID type is also added in the "Create Program Wizard". When entitlements are generated, the beneficiaries' ID documents are checked for the ID type set in the entitlement manager. If the beneficiary has the ID type, its ID number will be stored in the id_number field of the entitlements.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 4, because the PR involves changes in multiple files and the logic is moderately complex. It also introduces new fields and methods which need to be reviewed carefully.
• 🔒 Security concerns: No security concerns found

PR Feedback

• 💡 General suggestions: The PR seems to be well-structured and the changes are logically grouped. However, it would be beneficial to add some unit tests to ensure the new functionality works as expected. Additionally, it would be good to handle the case when the selected ID type is not found among the beneficiary's ID documents.

• 🤖 Code feedback:

  • relevant file: g2p_entitlement_cash/models/entitlement_manager.py
    suggestion: Consider handling the case when the selected ID type is not found among the beneficiary's ID documents. Currently, if the ID type is not found, the function simply returns None. It might be better to log a warning or raise an exception in this case. [important]
    relevant line: if id_docs:

  • relevant file: spp_entitlement_in_kind/models/entitlement_manager.py
    suggestion: Similar to the previous suggestion, consider handling the case when the selected ID type is not found among the beneficiary's ID documents. [important]
    relevant line: if id_docs:

  • relevant file: spp_programs/models/managers/entitlement_manager_default.py
    suggestion: It seems that the function _get_addl_entitlement_fields is duplicated in multiple files. Consider moving this function to a common module or class to avoid code duplication. [medium]
    relevant line: def _get_addl_entitlement_fields(self, beneficiary_id):

  • relevant file: spp_programs/models/managers/entitlement_manager.py
    suggestion: Consider adding a validation check for the id_type field. If it is None, the function _get_addl_entitlement_fields might fail. [medium]
    relevant line: id_type = fields.Many2one("g2p.id.type", "ID Type to store in entitlements")

How to use

Tag me in a comment '@CodiumAI-Agent' and add one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.