checkin API does not support setting checkin date

[JonathonReinhart]

Snipe-IT Version

v5.3.7

Problem

When checking in an asset via the web UI, the following form fields exist:

• Asset Name
• Status (required)
• Location
• Checkin Date (required; pre-filled to today's date)
• Notes

However, the /hardware/:id/checkin API does not support all of these:

• Asset Name
  • ❓ Appears to be supported but is not documented (see /hardware/:id/checkin API reference omits some parameters #10551)
• Status
  • ❓ Appears to be supported but is not documented (see /hardware/:id/checkin API reference omits some parameters #10551)
  • Also, not required, which might cause weirdness
• Location
  • ✔️ - Supported
• Checkin Date
  • ❌ Not supported
• Notes
  • ✔️ Supported

Solution

Api/AssetsController.checkin() should add fields which match the names used by the normal UI controller

• checkin_at

Alternatives

None.

[JonathonReinhart]

I think it should be as easy as this, but I have not tried it yet:

diff --git a/app/Http/Controllers/Api/AssetsController.php b/app/Http/Controllers/Api/AssetsController.php
index 3b37a2875..859ec89eb 100644
--- a/app/Http/Controllers/Api/AssetsController.php
+++ b/app/Http/Controllers/Api/AssetsController.php
@@ -844,8 +844,13 @@ class AssetsController extends Controller
             $asset->status_id =  $request->input('status_id');
         }
 
+        $checkin_at = null;
+        if($request->filled('checkin_at')){
+            $checkin_at = $request->input('checkin_at');
+        }
+
         if ($asset->save()) {
-            event(new CheckoutableCheckedIn($asset, $target, Auth::user(), $request->input('note')));
+            event(new CheckoutableCheckedIn($asset, $target, Auth::user(), $request->input('note'), $checkin_at));
 
             return response()->json(Helper::formatStandardApiResponse('success', ['asset'=> e($asset->asset_tag)], trans('admin/hardware/message.checkin.success')));
         }

[JonathonReinhart]

I tested this out by adding the diff above, and confirmed it was being set properly (with a debug print). But now I can't see where the checkin date (CheckoutableCheckedIn::action_date) is actually used anywhere though:

• Not visible on asset Details page
• Asset History page always shows actual date of checkin/checkout, not the date specified during checkin/checkout:
  
• Event Listeners
  • LogListener::onCheckoutableCheckedIn() passes it to Loggable::logCheckin(), where it is subsequently ignored ($action_date is never used)
  • CheckoutableListener::onCheckedIn() never references $event->action_date.

Perhaps this worked previously but was broken?

Here's where it was originally added: #6733

cc @snipe @inietov @dmeltzer