Merge pull request #399 from aspirepress/issue-359/import-package-endpoint

Author: chuckadams

app/Actions/Admin/API/V1/BulkPackageImport.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions\Admin\API\V1;
+
+use App\Http\JsonLines;
+use App\Http\JsonResponses;
+use App\Models\Package;
+use App\Values\Packages\FairMetadata;
+use App\Values\Packages\PackageData;
+use Exception;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Pipeline\Pipeline;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Log;
+
+use function Safe\ini_set;
+
+class BulkPackageImport
+{
+    use JsonResponses;
+    use JsonLines;
+
+    public function __invoke(Request $request, Pipeline $pipeline): JsonResponse
+    {
+        ini_set('memory_limit', '2G');
+        ini_set('max_execution_time', '300');
+
+        $currentLine = 0;
+        $imported = 0;
+        $errors = [];
+
+        $request_info = ['userid' => auth()->user()->id, 'ip' => $request->ip()];
+
+        Log::info('Beginning package import', $request_info);
+
+        foreach ($this->lazyJsonLines($request) as $metadata) {
+            $currentLine++;
+            try {
+                $package = DB::transaction(fn() => $this->loadOne($metadata));
+                Log::debug(
+                    "Imported {$package->did}",
+                    ['slug' => $package->slug, 'type' => $package->type],
+                );
+                $imported++;
+            } catch (Exception $e) {
+                $errors[$currentLine] = $e->getMessage();
+            }
+        }
+
+        Log::info('Bulk import complete', [...$request_info, 'imported' => $imported, 'errors' => $errors]);
+
+        return $errors ? $this->error(compact('errors', 'imported')) : $this->success(['imported' => $imported]);
+    }
+
+    /** @param array<string, mixed> $metadata */
+    private function loadOne(array $metadata): Package
+    {
+        $did = $metadata['id'];
+
+        $package = Package::query()->where('did', $did)->first();
+        $package?->delete();
+
+        $fairMetadata = FairMetadata::from($metadata);
+        return Package::fromPackageData(PackageData::from($fairMetadata));
+    }
+}

app/Services/Packages/PackageImportService.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Services\Packages;
+
+use App\Models\Package;
+use App\Values\Packages\PackageData;
+use App\Values\Packages\FairMetadata;
+
+class PackageImportService
+{
+    public function importPackage(string $json, bool $validateOnly = false, bool $newOnly = false): ?Package
+    {
+        $metadata = \Safe\json_decode($json, true);
+        // Force validation.
+        $fairMetadata = FairMetadata::from($metadata);
+
+        if ($validateOnly) {
+            return null;
+        }
+
+        $did = $metadata['id'];
+
+        $package = Package::query()->where('did', $did)->first();
+        if ($package && $newOnly) {
+            return null;
+        }
+        $package?->delete();
+
+        //$this->info("LOAD: $did");
+
+        $package = Package::fromPackageData(PackageData::from($fairMetadata));
+        return $package;
+    }
+}

app/Values/Packages/PackageImportRequest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Values\Packages;
+
+use App\Values\DTO;
+use Bag\Attributes\StripExtraParameters;
+use Bag\Attributes\Transforms;
+use Illuminate\Http\Request;
+
+#[StripExtraParameters]
+readonly class PackageImportRequest extends DTO
+{
+    public const ACTION = 'package_import';
+
+    public function __construct(
+        public string $data,
+    ) {}
+
+    /** @return array<string, mixed> */
+    #[Transforms(Request::class)]
+    public static function fromRequest(Request $request): array
+    {
+        // Bag throws 500 (RuntimeException) for missing fields, this throws a friendlier 422
+        return $request->validate(['data' => 'required']);
+    }
+}

routes/inc/admin-api.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use App\Actions\Admin\API\V1\BulkImport;
+use App\Actions\Admin\API\V1\BulkPackageImport;
 use App\Auth\Permission;
 use App\Http\Middleware\RequireJson;
 use Illuminate\Routing\Router;
@@ -16,6 +17,7 @@
     ])
     ->group(function (Router $router) {
         $router->post('/import', BulkImport::class)->can(Permission::BulkImport);
+        $router->post('/packages/import', BulkPackageImport::class)->can(Permission::BulkImport);
     });