[PLA-1872] Beam pack feature

[enjinabner]

PR Type

Enhancement, Tests

---

Description

• Added BeamPackFactory for generating BeamPack model instances.
• Added multiple migrations for beam_packs table, is_pack column in beams table, and beam_pack_id column in beam_claims table.
• Added CreateBeamPackMutation for creating beam packs via GraphQL.
• Added ClaimTokenPackInputType for handling claim token pack input.
• Updated DispatchCreateBeamClaimsJobs to handle packId.
• Added BeamPack model class with relationships and factory.
• Updated MaxTokenSupply rule to handle pack quantity.
• Added methods in BeamService for creating beam packs and claims packs.

---

Changes walkthrough 📝

Relevant files

Enhancement

17 files BeamPackFactory.php Add BeamPackFactory for BeamPack model                                      database/factories/BeamPackFactory.php Added BeamPackFactory class for generating BeamPack model instances. Defined default state for is_claimed attribute. +28/-0    2024_07_01_011034_add_is_pack_column_to_beams_table.php Add is_pack column to beams table                                                database/migrations/2024_07_01_011034_add_is_pack_column_to_beams_table.php Added migration to add is_pack column to beams table. +27/-0    2024_07_01_020155_create_beam_packs_table.php Create beam_packs table migration                                                database/migrations/2024_07_01_020155_create_beam_packs_table.php Added migration to create beam_packs table. Defined columns and relationships for beam_packs table. +28/-0    2024_07_01_020426_add_beam_pack_id_to_beam_claims_table.php Add beam_pack_id column to beam_claims table                          database/migrations/2024_07_01_020426_add_beam_pack_id_to_beam_claims_table.php Added migration to add beam_pack_id column to beam_claims table. +27/-0    input_type.php Add description for claim_token_pack input type                    lang/en/input_type.php Added description for claim_token_pack input type. +1/-0      mutation.php Add descriptions for create_beam_pack mutation                      lang/en/mutation.php Added descriptions for create_beam_pack mutation and its arguments. +2/-0      type.php Add description for create_beam_pack type                                lang/en/type.php Added description for create_beam_pack type. +1/-0      BeamServiceProvider.php Register migration for is_pack column                                        src/BeamServiceProvider.php Registered new migration for adding is_pack column to beams table. +1/-0      CreateBeamPackMutation.php Add CreateBeamPackMutation for creating beam packs              src/GraphQL/Mutations/CreateBeamPackMutation.php Added CreateBeamPackMutation class for creating beam packs. Defined attributes, arguments, and resolve method for the mutation. +165/-0  ClaimTokenPackInputType.php Add ClaimTokenPackInputType for claim token packs                src/GraphQL/Types/Input/ClaimTokenPackInputType.php Added ClaimTokenPackInputType class for handling claim token pack input. Defined fields and attributes for the input type. +59/-0    DispatchCreateBeamClaimsJobs.php Update DispatchCreateBeamClaimsJobs to handle packId          src/Jobs/DispatchCreateBeamClaimsJobs.php Updated job to handle packId for beam claims. +4/-1      BeamPack.php Add BeamPack model class                                                                  src/Models/BeamPack.php Added BeamPack model class. +7/-0      Beam.php Add is_pack attribute and packTokens relationship to Beam model src/Models/Laravel/Beam.php Added is_pack attribute to Beam model. Added packTokens relationship to Beam model. +9/-0      BeamClaim.php Add beam_pack_id attribute and beamPack relationship to BeamClaim model src/Models/Laravel/BeamClaim.php Added beam_pack_id attribute to BeamClaim model. Added beamPack relationship to BeamClaim model. +9/-0      BeamPack.php Add BeamPack model class with relationships                            src/Models/Laravel/BeamPack.php Added BeamPack model class with relationships and factory. +69/-0    MaxTokenSupply.php Update MaxTokenSupply rule for pack quantity                          src/Rules/MaxTokenSupply.php Updated MaxTokenSupply rule to handle pack quantity. +7/-5      BeamService.php Add methods for creating beam packs and claims packs          src/Services/BeamService.php Added createPack method for creating beam packs. Added createClaimsPack method for creating beam claims packs. +69/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	4
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	Possible Bug: The createClaimsPack method in BeamService.php might not handle file closure properly if an exception occurs during file reading. Consider using a try-finally block to ensure the file is always closed.
	Data Integrity: The createPack method in BeamService.php creates multiple beam packs and claims in a single transaction. Ensure that all edge cases are handled, such as partial failures or rollbacks, to maintain data integrity.
	Performance Concern: The method createClaimsPack processes token uploads and claims creation in a loop which could lead to performance issues with large data sets. Consider optimizing the data handling or processing in batches.

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Maintainability	Add error handling in the 'createPack' method to ensure data integrity during transactions Ensure that the 'createPack' method handles exceptions or errors during the database transactions to prevent partial data persistence and maintain data integrity. src/Services/BeamService.php [89] -return DB::transaction(fn () => $beam->createPack($args)->code, 3); +return DB::transaction(function () use ($args, $beam) { + try { + return $beam->createPack($args)->code; + } catch (\Exception $e) { + // Handle exception (e.g., log the error, notify system administrators) + throw new \Exception("Failed to create beam pack: " . $e->getMessage()); + } +}, 3); Suggestion importance[1-10]: 9 Why: Adding error handling in the 'createPack' method is crucial for maintaining data integrity and ensuring that partial data is not persisted in case of an error. This is an important improvement for maintainability.	9
Performance	Add an index to the 'is_pack' column to enhance query performance Consider adding an index to the 'is_pack' column in the 'beams' table to improve query performance, especially if this column will be frequently used in WHERE clauses or joins. database/migrations/2024_07_01_011034_add_is_pack_column_to_beams_table.php [14] -$table->boolean('is_pack')->default(false); +$table->boolean('is_pack')->default(false)->index(); Suggestion importance[1-10]: 8 Why: Adding an index to the 'is_pack' column can significantly improve query performance, especially if this column is frequently used in queries. This is a good suggestion for enhancing performance.	8
Security	Limit the maximum allowable quantity for creating beam packs to prevent misuse Add validation for the 'quantity' field to ensure it does not exceed a reasonable limit, preventing potential misuse or system overload. src/GraphQL/Mutations/CreateBeamPackMutation.php [103] -'quantity' => ['integer', 'min:1', 'max:1000'], +'quantity' => ['integer', 'min:1', 'max:100'], Suggestion importance[1-10]: 7 Why: Limiting the maximum allowable quantity for creating beam packs is a good security measure to prevent potential misuse or system overload. However, the suggested limit of 100 might be too restrictive depending on the use case.	7
Enhancement	Implement soft deletes in the 'BeamPack' model for better data management Add soft delete functionality to the 'BeamPack' model to allow for recoverable deletion of records, enhancing data management capabilities. src/Models/Laravel/BeamPack.php [14] -use HasFactory; +use HasFactory, SoftDeletes; Suggestion importance[1-10]: 6 Why: Implementing soft deletes in the 'BeamPack' model is a useful enhancement for better data management. However, it is not critical and depends on the specific requirements of the application.	6