OBLS-310 Backend for Pick up allocation #5694

druchniewicz · 2025-12-18T23:37:25Z

No description provided.

druchniewicz · 2025-12-18T23:38:14Z

Totally first initial version of allocation API.

I added support for AUTO/MANUAL modes.
In AUTO mode I just create pick list based on order item (without distinction between display/warehouse pick).
in MANUAL mode I create pick list based on array of allocations where one object contains inventoryItemId, binLocationId, quantity).

codecov · 2025-12-18T23:47:49Z

Codecov Report

❌ Patch coverage is 5.03597% with 132 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (feature/obaf-integration@7ce4dc5). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
...h/warehouse/outboundOrder/AllocationService.groovy	0.00%	84 Missing ⚠️
...se/outboundOrder/OutboundOrderApiController.groovy	0.00%	24 Missing ⚠️
...g/pih/warehouse/requisition/RequisitionItem.groovy	0.00%	15 Missing ⚠️
...ovy/org/pih/warehouse/api/StockMovementItem.groovy	0.00%	3 Missing ⚠️
...-app/domain/org/pih/warehouse/core/Location.groovy	66.66%	2 Missing ⚠️
...ih/warehouse/outboundOrder/AllocationStrategy.java	0.00%	2 Missing ⚠️
...arehouse/outboundOrder/AllocationDetailsDto.groovy	0.00%	1 Missing ⚠️
...g/pih/warehouse/outboundOrder/AllocationDto.groovy	0.00%	1 Missing ⚠️

Additional details and impacted files

@@                    Coverage Diff                     @@
##             feature/obaf-integration   #5694   +/-   ##
==========================================================
  Coverage                            ?   9.53%           
  Complexity                          ?    1343           
==========================================================
  Files                               ?     780           
  Lines                               ?   48765           
  Branches                            ?   11629           
==========================================================
  Hits                                ?    4651           
  Misses                              ?   43420           
  Partials                            ?     694

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

jmiranda

The was a first pass code review from yesterday. Just got around to posting it. Sorry!

jmiranda · 2025-12-19T14:45:57Z

grails-app/services/org/pih/warehouse/outboundOrder/OutboundOrderService.groovy

+                stockMovementService.createOrUpdatePicklistItem(
+                        orderItem.requisitionItem,
+                        null,
+                        InventoryItem.get(itemToAllocate.inventoryItemId),


Should use load() here so there's no database query. However, the only bummer is that we won't know if the record exists or not until we save the picklist item (which isn't a big deal as long as the validation for the picklist item works properly - i.e. fails if fks are null).

jmiranda · 2025-12-19T14:56:21Z

grails-app/services/org/pih/warehouse/outboundOrder/OutboundOrderService.groovy

+        }
+
+        if (mode.equalsIgnoreCase(AllocationType.AUTO.name())) {
+            stockMovementService.createPicklist(orderItem, false)


I assume this creates a picklist if one does not exist?

@awalkowiak The one thing we haven't discussed / designed is whether the requisition / picklist state machine can handle the fact that items might not be allocated yet.

In other words, we usually move all items from state to state at the same time. The pickup allocation flow changes that as we'll have some items that have been allocated and others that have not. So there are going to be gaps in multiple state machine that require us to be somewhat defensive about moving ALL items from state to state.

An example would be a pick up order like this. We cannot move this order to "complete" until all items are either fulfilled (which probably means each item has been "staged" but i need to double check the requirements).

Requisition Item 1

Status: Staged

Requested: 10

Allocated: 10

Picked: 10

Staged: 10

Requisition Item 2

Status: Requested

Requested: 5

Allocated: 0

Picked: 0

Staged: 0

Canceled: 0

Requisition Item 3

Status: Canceled due to stock out

Requested: 2

Allocated: 0

Picked: 0

Staged: 0

Canceled: 2

jmiranda · 2025-12-19T15:09:14Z

grails-app/services/org/pih/warehouse/outboundOrder/OutboundOrderService.groovy

+                        orderItem.requisitionItem,
+                        null,
+                        InventoryItem.get(itemToAllocate.inventoryItemId),
+                        Location.get(itemToAllocate.binLocationId),


jmiranda · 2025-12-19T15:11:32Z

grails-app/services/org/pih/warehouse/outboundOrder/OutboundOrderService.groovy

+    }
+
+    void allocate(StockMovementItem orderItem, Map data = [:]) {
+        String mode = data.mode as AllocationType


This should be

AllocationType mode = data.mode as AllocationType

And what is AllocationType? Did we define that previously? I think I called this AllocationMode in the design, so let's go with that.

jmiranda · 2025-12-20T20:14:19Z

Totally first initial version of allocation API.

This looks great

(without distinction between display/warehouse pick).

That's fine for now. Getting allocation working in general is the key here so we can move forward with picking and staging. When you get a change, please create a ticket to add a separate AllocationService that calls an AllocationStrategy (FEFO, DISPLAY_FIRST, WAREHOUSE_FIRST, etc)? I'll probably need to add some additional specification to that ticket before you can get started but feel free to implement the display vs warehouse as you see fit.

…tions

…etermine allocation quantity and statuses

druchniewicz · 2026-01-07T17:33:08Z

grails-app/domain/org/pih/warehouse/requisition/RequisitionItem.groovy

+    }
+
+    String getAllocationStatus() {
+        if (isAllocated()) return "ALLOCATED"


consider any enum for these statuses? or extend the existing RequistionItemStatus enum

yeah an AllocationStatus enum sounds good

druchniewicz · 2026-01-07T17:34:37Z

grails-app/services/org/pih/warehouse/outboundOrder/OutboundOrderService.groovy

+
+        outboundOrder.lineItems.each { StockMovementItem item ->
+            item.availableItems = stockMovementService.getAvailableItems(outboundOrder.origin, RequisitionItem.get(item.id), false)
+            item.allocationStatus = RequisitionItem.get(item.id).getAllocationStatus()


this probably can be refactored i.e. add new fields to StockMovementItem view domain class and set these fields during StockMovementItem creation (from RequisitionItem)

hmm, probably it will not be that trivial as I initially thought. Data in RequisitionItem like quantity allocated, allocation status etc. are also calculated on the fly, they are not stored in Requisition Item entity so in stock-movement-item.sql I cannot just use "select requisition_item.quantity_allocated" etc.
I leave it as it is for now

jmiranda

I just realized my comments weren't posted yet. Sorry about that. I added these awhile ago.

jmiranda · 2026-01-08T06:10:19Z

grails-app/controllers/org/pih/warehouse/outboundOrder/OutboundOrderApiController.groovy

+            throw new IllegalArgumentException("Order item with id ${params.itemId} not found")
+        }
+
+        outboundOrderService.allocate(orderItem, jsonBody)


I think we should just call this AllocationService. And I don't love the jsonBody being passed here. Let's make the arguments explicits or use the AllocationRequest class to pass in all of the properties need to make a decision.

AllocationResult allocate(AllocationRequest request)

The AllocationService should eventually delegate to allocation strategies as described in the PUA ticket. I don't think we necessarily need that just yet, but wanted to explain what will eventually happen.

Alos, the AllocationResult is a list of allocations. But we might just be call these Allocation or AllocationItems (instead of ItemToAllocate)

jmiranda · 2026-01-08T06:11:38Z

grails-app/services/org/pih/warehouse/outboundOrder/OutboundOrderService.groovy

+        if (mode.equalsIgnoreCase(AllocationType.AUTO.name())) {
+            stockMovementService.createPicklist(orderItem, false)
+        } else if (mode.equalsIgnoreCase(AllocationType.MANUAL.name())) {
+            List<ItemToAllocate> allocations = data.allocations as List<ItemToAllocate>


yeah let's just call it an Allocation for now

…efactor

druchniewicz · 2026-01-09T00:16:07Z

grails-app/services/org/pih/warehouse/outboundOrder/AllocationService.groovy

+
+        outboundOrder.lineItems.each { StockMovementItem item ->
+            RequisitionItem requisitionItem = RequisitionItem.get(item.id)
+            item.availableItems = stockMovementService.getAvailableItems(outboundOrder.origin, requisitionItem, false)


I'm fetching outboundOrder (StockMovement) first and then adding all required data to particular line item like availableItems, allocations, allocationStatus, quantityAllocated. Thanks to this when I trigger fetch order endpoint I have all required data which I need to display in the mobile application and I don't need to make multiple requests to fetch all needed data

druchniewicz · 2026-01-09T00:19:57Z

grails-app/services/org/pih/warehouse/outboundOrder/AllocationService.groovy

+        return outboundOrder
+    }
+
+    AllocationDetailsDto allocate(String requisitionItemId, AllocationType mode, List<AllocationDto> allocations) {


it supports create and update. AllocationDto contains "id" field (PicklistItem id). When this id is sent by the mobile app it looks for existing picklist item, finds and updates it, otherwise picklistItem = null is sent to createOrUpdatePicklistItem method and new pick list item is created

druchniewicz · 2026-01-09T18:27:11Z

@jmiranda @awalkowiak can you take a look at PR? I assume that can be much remarks requested from you to change but I tried to implement +/- first working version of PUA (backend + frontend). I shared the video on slack how it currently works and looks. You can take a look. I didn't test any special/edge cases etc.

OBLS-310 Allocation API for PUA

46b1ab2

druchniewicz requested review from awalkowiak and jmiranda December 18, 2025 23:37

github-actions bot added the domain: backend Changes or discussions relating to the backend server label Dec 18, 2025

druchniewicz mentioned this pull request Dec 18, 2025

[WIP] OBLS-310 Initial PUA API #5692

Closed

druchniewicz changed the title ~~OBLS-310 Allocation API for PUA~~ [WIP] OBLS-310 Allocation API for PUA Dec 18, 2025

druchniewicz marked this pull request as draft December 18, 2025 23:39

OBLS-310 Returning date created with time to display in the mobile app

5b0f8ea

jmiranda reviewed Dec 20, 2025

View reviewed changes

OBLS-310 Added helper methods for checking allocable and display loca…

a5258ac

…tions

github-actions bot added domain: l10n Changes or discussions relating to localization & Internationalization stakeholder: vvg Issues or topics relating to VVG (velocity vehicle group) labels Dec 22, 2025

OBLS-310 Added few helper fields and methods to Requisition Item to d…

456186e

…etermine allocation quantity and statuses

druchniewicz commented Jan 7, 2026

View reviewed changes

jmiranda reviewed Jan 8, 2026

View reviewed changes

druchniewicz added 2 commits January 8, 2026 14:09

OBLS-310 Small code refactor

0489958

OBLS-310 Extended PUA API, handled manual allocations updates, code r…

7613ad8

…efactor

druchniewicz commented Jan 9, 2026

View reviewed changes

OBLS-310 Handled auto allocation for full display/warehouse pick

32a3193

druchniewicz marked this pull request as ready for review January 9, 2026 18:19

druchniewicz changed the title ~~[WIP] OBLS-310 Allocation API for PUA~~ OBLS-310 Allocation API for PUA Jan 9, 2026

druchniewicz changed the title ~~OBLS-310 Allocation API for PUA~~ OBLS-310 Allocation backend for PUA Jan 9, 2026

druchniewicz changed the title ~~OBLS-310 Allocation backend for PUA~~ OBLS-310 Backend for Pick up allocation Jan 9, 2026

druchniewicz requested a review from jmiranda January 9, 2026 18:20

Uh oh!

OBLS-310 Backend for Pick up allocation #5694

Are you sure you want to change the base?

OBLS-310 Backend for Pick up allocation #5694

Uh oh!

Conversation

druchniewicz commented Dec 18, 2025

Uh oh!

druchniewicz commented Dec 18, 2025

Uh oh!

codecov bot commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jmiranda left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmiranda commented Dec 20, 2025

Uh oh!

druchniewicz Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmiranda left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

druchniewicz commented Jan 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Dec 18, 2025 •

edited

Loading

druchniewicz Jan 7, 2026 •

edited

Loading