Remote resolve improvements #minor (#80)

* Added additional properties to remote custom field type, added aditional endpoint for remote cf resolution

* Apply fixes from StyleCI

* Added response caching

* Apply fixes from StyleCI

Co-authored-by: Josip Milotić <[email protected]>
Co-authored-by: StyleCI Bot <[email protected]>

Author: 3 people

config/asseco-custom-fields.php

@@ -90,4 +90,14 @@
         'prefix'     => 'api',
         'middleware' => ['api'],
     ],
+
+    /**
+     * Determines if the response from resolving a remote custom field should be cached.
+     */
+    'should_cache_remote' => false,
+
+    /**
+     * Number of seconds that the remote custom field response should remain in cache.
+     */
+    'remote_cache_ttl' => 3600,
 ];

migrations/2022_11_16_081022_update_custom_field_remote_types_table.php

@@ -0,0 +1,37 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('custom_field_remote_types', function (Blueprint $table) {
+            $table->string('data_path')->nullable()->after('mappings');
+            $table->string('identifier_property')->nullable()->after('mappings');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('custom_field_remote_types', function (Blueprint $table) {
+            $table->dropColumn('data_path');
+        });
+
+        Schema::table('custom_field_remote_types', function (Blueprint $table) {
+            $table->dropColumn('identifier_property');
+        });
+    }
+};

routes/api.php

@@ -46,6 +46,7 @@
             Route::apiResource('remote', RemoteCustomFieldController::class)->only(['index', 'store']);
             Route::match(['put', 'patch'], 'remote/{remote_type}', [RemoteCustomFieldController::class, 'update'])->name('remote.update');
             Route::get('remote/{remote_type}/resolve', [RemoteCustomFieldController::class, 'resolve'])->name('remote.resolve');
+            Route::get('remote/{remote_type}/resolve/{identifier_value}', [RemoteCustomFieldController::class, 'resolveByIdentifierValue'])->name('remote.resolveByIdentifierValue');
 
             Route::get('selection', [SelectionCustomFieldController::class, 'index'])->name('selection.index');
             Route::post('selection/{plain_type}', [SelectionCustomFieldController::class, 'store'])->name('selection.store');

src/App/Http/Controllers/RemoteCustomFieldController.php

@@ -10,11 +10,9 @@
 use Asseco\CustomFields\App\Http\Requests\RemoteCustomFieldRequest;
 use Asseco\CustomFields\App\Http\Requests\RemoteTypeRequest;
 use Asseco\CustomFields\App\Traits\TransformsOutput;
-use Illuminate\Http\Client\Response;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\DB;
-use Illuminate\Support\Facades\Http;
 
 /**
  * @group Remote Custom Fields
@@ -104,14 +102,31 @@ public function update(RemoteTypeRequest $request, RemoteType $remoteType): Json
      */
     public function resolve(RemoteType $remoteType): JsonResponse
     {
-        /**
-         * @var Response $response
-         */
-        $response = Http::withHeaders($remoteType->headers ?: [])
-            ->withBody($remoteType->body, 'application/json')
-            ->{$remoteType->method}($remoteType->url);
-
-        $transformed = $this->transform($response->json(), json_decode($remoteType->mappings, true));
+        $data = $remoteType->getRemoteData();
+
+        $data = $remoteType->data_path ? Arr::get($data, $remoteType->data_path) : $data;
+
+        $transformed = $this->transform($data, json_decode($remoteType->mappings, true));
+
+        return response()->json($transformed);
+    }
+
+    /**
+     * Display the specified resource.
+     *
+     * @param  RemoteType  $remoteType
+     * @param  string  $identifierValue
+     * @return JsonResponse
+     */
+    public function resolveByIdentifierValue(RemoteType $remoteType, string $identifierValue): JsonResponse
+    {
+        $data = $remoteType->getRemoteData();
+
+        $data = $remoteType->data_path ? Arr::get($data, $remoteType->data_path) : $data;
+
+        $data = collect($data)->where($remoteType->identifier_property, $identifierValue)->first();
+
+        $transformed = $this->mapSingle($remoteType->mappings, $data);
 
         return response()->json($transformed);
     }

src/App/Models/RemoteType.php

@@ -8,11 +8,15 @@
 use Asseco\CustomFields\Database\Factories\RemoteTypeFactory;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Http;
 
 class RemoteType extends ParentType implements \Asseco\CustomFields\App\Contracts\RemoteType
 {
     use HasFactory;
 
+    protected const CACHE_PREFIX = 'remote_custom_field_';
+
     protected $table = 'custom_field_remote_types';
 
     protected $guarded = ['id', 'created_at', 'updated_at'];
@@ -39,4 +43,21 @@ public function getNameAttribute()
     {
         return 'remote';
     }
+
+    public function getRemoteData()
+    {
+        $cacheKey = 'remote_custom_field_' . $this->id;
+
+        if (config('asseco-custom-fields.should_cache_remote') && Cache::has($cacheKey)) {
+            return Cache::get($cacheKey);
+        }
+
+        $response = Http::withHeaders($this->headers ?: [])
+            ->withBody($this->body, 'application/json')
+            ->{$this->method}($this->url)->json();
+
+        Cache::put($cacheKey, $response, config('asseco-custom-fields.remote_cache_ttl'));
+
+        return $response;
+    }
 }