feat(backend): sync item history with current_location #23

d-p35 · 2025-12-01T17:34:03Z

Summary

Implements automatic synchronization between ItemHistory events and CollectionItem location fields. When location-changing history events are created (INITIAL, ARRIVED, VERIFIED, LOCATION_CORRECTION), the item's current_location and is_on_floor fields are automatically updated via Django signals. Also includes a management command for rebuilding all item locations from history.

Related Issues

Closes Implement Item History Service to Sync 'current_location' #11 (Implement Item History Service)

Changes

Auto-sync Logic:

Added Django post_save signal on ItemHistory model to automatically trigger location updates
Signal updates current_location and is_on_floor fields when location-changing events are created (INITIAL, ARRIVED, VERIFIED, LOCATION_CORRECTION)

Maintenance Command:

Created rebuild_item_locations Django management command for data recovery and consistency checks
Command supports --item-id flag to rebuild single items or processes all items when no flag provided

Testing & Code Quality:

Added 6 comprehensive test cases covering signal behavior, location updates, and management command

How to Test

cd backend

# Run all inventory tests
python manage.py test inventory.tests

# Test the management command
python manage.py rebuild_item_locations --item-id 1
python manage.py rebuild_item_locations

… implement signal for history updates

vivjd

Looks good overall! Please review copilot's comments and re-request review!

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ON_CHANGING_EVENTS before updating

d-p35 · 2026-01-07T00:00:21Z

Instead of creating another copy of LOCATION_CHANGING_EVENTS (already used in utils.py), I extracted it in a separate file called constants.py and imported it for the usages. I couldn't directly import it from utils.py because it would create a circular dependency.

Copilot

Pull request overview

Copilot reviewed 5 out of 7 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-07T00:02:33Z

backend/inventory/models.py

+        try:
+            item: CollectionItem = instance.item
+            item.update_location_from_history()
+        except Exception as e:
+            # Log error but don't raise to prevent disrupting the original save
+            logger.error(f"Failed to update item location for item {instance.item_id}: {e}")


The bare except catching all Exception types could hide critical bugs or system errors. Consider either catching more specific exceptions (e.g., DatabaseError, ValidationError) or re-raising certain critical exceptions after logging. This ensures that genuine system errors don't get silently swallowed.

Copilot · 2026-01-07T00:02:33Z

backend/inventory/management/commands/rebuild_item_locations.py

+
+            for item in items:
+                try:
+                    item.update_location_from_history()
+                    updated_count += 1
+                except Exception as e:
+                    self.stdout.write(self.style.ERROR(f"Error updating item {item.id}: {e}"))
+
+            self.stdout.write(self.style.SUCCESS(f"Updated {updated_count} items"))


The command tracks updated_count for successful updates but doesn't track or report the number of failures. Consider adding a failed_count variable and including it in the final summary message to give users complete visibility into the rebuild operation results.

Suggested change

for item in items:

try:

item.update_location_from_history()

updated_count += 1

except Exception as e:

self.stdout.write(self.style.ERROR(f"Error updating item {item.id}: {e}"))

self.stdout.write(self.style.SUCCESS(f"Updated {updated_count} items"))

failed_count = 0

for item in items:

try:

item.update_location_from_history()

updated_count += 1

except Exception as e:

failed_count += 1

self.stdout.write(self.style.ERROR(f"Error updating item {item.id}: {e}"))

self.stdout.write(

self.style.SUCCESS(

f"Updated {updated_count} items, {failed_count} failures"

)

)

Copilot · 2026-01-07T00:02:33Z

backend/inventory/tests.py

+    def test_command_all_items(self):
+        """Test command rebuilds all items."""
+        out = StringIO()
+        call_command("rebuild_item_locations", stdout=out)
+
+        output = out.getvalue()
+        self.assertIn("Updated", output)


The test only verifies that the success message is printed but doesn't verify that the item's location fields were actually updated correctly. Consider adding assertions to check that current_location and is_on_floor were updated based on the item's history.

Copilot · 2026-01-07T00:02:33Z

backend/inventory/tests.py

+class ItemLocationTest(TestCase):
+    """Test the item location functionality."""
+
+    def setUp(self):
+        self.user = User.objects.create_user(email="test@example.com", name="Test User", password="testpass", role="VOLUNTEER")
+        self.location_storage = Location.objects.create(name="Storage A", location_type="STORAGE")
+        self.location_floor = Location.objects.create(name="Main Floor", location_type="FLOOR")
+        self.item = CollectionItem.objects.create(
+            item_code="TEST001", title="Test Item", current_location=self.location_storage
+        )
+
+    def test_update_location_from_history_initial_event(self):
+        """Test location update with INITIAL event."""
+        # Create INITIAL history event
+        ItemHistory.objects.create(item=self.item, event_type="INITIAL", to_location=self.location_storage, acted_by=self.user)
+
+        # Update location using model method
+        self.item.update_location_from_history()
+
+        self.assertEqual(self.item.current_location, self.location_storage)
+        self.assertFalse(self.item.is_on_floor)
+
+    def test_update_location_from_history_floor_move(self):
+        """Test location update when item moves to floor."""
+        # Create events
+        ItemHistory.objects.create(item=self.item, event_type="INITIAL", to_location=self.location_storage)
+        ItemHistory.objects.create(
+            item=self.item, event_type="ARRIVED", from_location=self.location_storage, to_location=self.location_floor
+        )
+
+        self.item.update_location_from_history()
+
+        self.assertEqual(self.item.current_location, self.location_floor)
+        self.assertTrue(self.item.is_on_floor)
+
+    def test_signal_triggers_on_location_changing_event(self):
+        """Test that signal updates item location for location-changing events."""
+        # Create ARRIVED event - should trigger signal
+        ItemHistory.objects.create(
+            item=self.item, event_type="ARRIVED", to_location=self.location_floor, from_location=self.location_storage
+        )
+
+        # Refresh item from database
+        self.item.refresh_from_db()
+
+        # Verify location was updated by signal
+        self.assertEqual(self.item.current_location, self.location_floor)
+        self.assertTrue(self.item.is_on_floor)
+
+    def test_signal_does_not_update_location_for_workflow_events(self):
+        """Test that signal triggers but doesn't update location for workflow-only events."""
+        original_location = self.item.current_location
+        original_is_on_floor = self.item.is_on_floor
+
+        # Create MOVE_REQUESTED event - should NOT trigger signal
+        ItemHistory.objects.create(
+            item=self.item, event_type="MOVE_REQUESTED", to_location=self.location_floor, from_location=self.location_storage
+        )
+
+        # Refresh item from database
+        self.item.refresh_from_db()
+
+        # Verify location was NOT updated
+        self.assertEqual(self.item.current_location, original_location)
+        self.assertEqual(self.item.is_on_floor, original_is_on_floor)


Test coverage is missing for VERIFIED and LOCATION_CORRECTION event types, which are defined as location-changing events in LOCATION_CHANGING_EVENTS. Consider adding test cases to verify that these event types also trigger the signal and correctly update the item's location.

feat(inventory): add management command to rebuild item locations and…

a075733

… implement signal for history updates

d-p35 marked this pull request as ready for review December 1, 2025 22:45

Copilot AI review requested due to automatic review settings December 1, 2025 22:45

Copilot started reviewing on behalf of d-p35 December 1, 2025 22:45 View session

Copilot finished reviewing on behalf of d-p35 December 1, 2025 22:49

This comment was marked as outdated.

Sign in to view

vivjd requested changes Dec 11, 2025

View reviewed changes

Update naming in backend/inventory/tests.py

018daaf

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings January 6, 2026 23:45

Copilot started reviewing on behalf of d-p35 January 6, 2026 23:45 View session

This comment was marked as outdated.

Sign in to view

remove unncessary imports and check if itemHistory entry is in LOCATI…

cad774f

…ON_CHANGING_EVENTS before updating

d-p35 requested review from Copilot and vivjd January 6, 2026 23:57

Copilot started reviewing on behalf of d-p35 January 6, 2026 23:58 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(backend): sync item history with current_location #23

feat(backend): sync item history with current_location #23

Uh oh!

d-p35 commented Dec 1, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

vivjd left a comment

Uh oh!

This comment was marked as outdated.

Uh oh!

d-p35 commented Jan 7, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 7, 2026

Uh oh!

Copilot AI Jan 7, 2026

Uh oh!

Copilot AI Jan 7, 2026

Uh oh!

Copilot AI Jan 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat(backend): sync item history with current_location #23

Are you sure you want to change the base?

feat(backend): sync item history with current_location #23

Uh oh!

Conversation

d-p35 commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issues

Changes

How to Test

Uh oh!

This comment was marked as outdated.

Uh oh!

vivjd left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

d-p35 commented Jan 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

d-p35 commented Dec 1, 2025 •

edited

Loading