feat: handle errors in Alchemy response for getWalletNfts

app/Data/Web3/Web3NftData.php

@@ -40,6 +40,8 @@ public function __construct(
         public array $traits,
         public int $mintedBlock,
         public ?Carbon $mintedAt,
+        public ?bool $hasError,
+        public ?string $error,
     ) {
     }
 

app/Enums/NftErrors.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Enums;
+
+enum NftErrors: string
+{
+    case MetadataOutdated = 'METADATA_OUTDATED';
+}

app/Http/Client/Alchemy/AlchemyPendingRequest.php

@@ -13,6 +13,7 @@
 use App\Enums\Chains;
 use App\Enums\CryptoCurrencyDecimals;
 use App\Enums\ImageSize;
+use App\Enums\NftErrors;
 use App\Enums\TokenType;
 use App\Enums\TraitDisplayType;
 use App\Exceptions\ConnectionException;
@@ -33,6 +34,7 @@
 use Illuminate\Http\Client\Response;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
 use stdClass;
 use Throwable;
@@ -208,7 +210,7 @@ public function getWalletNfts(Wallet $wallet, Network $network, string $cursor =
         $ownedNfts = Arr::get($data, 'ownedNfts', []);
 
         $nfts = collect($ownedNfts)
-            ->filter(fn ($nft) => $this->filterNft($nft))
+            ->filter(fn ($nft) => $this->filterNft($nft, false))
             ->map(fn ($nft) => $this->parseNft($nft, $network->id))
             ->values();
 
@@ -364,7 +366,7 @@ public function getContractMetadataBatch(array $contactAddresses, Network $netwo
     public function parseNft(array $nft, int $networkId, bool $convertTokenNumber = true): Web3NftData
     {
         $extractedFloorPrice = $this->tryExtractFloorPrice($nft);
-        $collectionName = $this->collectionName($nft);
+        $collectionName = $this->collectionName($nft) ?? Arr::get($nft, 'contractMetadata.symbol');
         $description = $nft['description'] ?? null;
         $supply = Arr::get($nft, 'contractMetadata.totalSupply');
         if (is_numeric($supply)) {
@@ -395,11 +397,29 @@ public function parseNft(array $nft, int $networkId, bool $convertTokenNumber =
 
         $tokenNumber = $convertTokenNumber === true ? CryptoUtils::hexToBigIntStr($nft['id']['tokenId']) : $nft['id']['tokenId'];
 
+        $error = Arr::get($nft, 'error');
+        $nftError = null;
+        $collectionAddress = Arr::get($nft, 'contract.address');
+
+        if (! empty($error)) {
+            Log::info('AlchemyPendingRequest: Filter NFT', [
+                'error' => $error,
+                'collection_name' => $collectionName,
+                'collection_address' => $collectionAddress,
+                'nft_id' => $tokenNumber,
+            ]);
+
+            // if metadata stuff is empty, is empty object or empty array
+            if (empty($nft['metadata']) || empty($nft['metadata']['metadata']) || is_object($nft['metadata']['metadata']) && count((array) $nft['metadata']['metadata'])) {
+                $nftError = NftErrors::MetadataOutdated->value;
+            }
+        }
+
         return new Web3NftData(
             tokenAddress: $nft['contract']['address'],
             tokenNumber: $tokenNumber,
             networkId: $networkId,
-            collectionName: $collectionName ?? Arr::get($nft, 'contractMetadata.symbol'),
+            collectionName: $collectionName,
             collectionSymbol: Arr::get($nft, 'contractMetadata.symbol') ?? $collectionName,
             collectionImage: Arr::get($nft, 'contractMetadata.openSea.imageUrl') ?? Arr::get($nft, 'media.0.thumbnail') ?? Arr::get($nft, 'media.0.gateway'),
             collectionWebsite: Arr::get($nft, 'contractMetadata.openSea.externalUrl') ?? Arr::get($nft, 'metadata.external_url'),
@@ -421,6 +441,8 @@ public function parseNft(array $nft, int $networkId, bool $convertTokenNumber =
             traits: $this->extractTraits($nft),
             mintedBlock: $nft['contractMetadata']['deployedBlockNumber'],
             mintedAt: $mintTimestamp !== null ? Carbon::createFromTimestampMs($mintTimestamp) : null,
+            hasError: ! empty($error),
+            error: $nftError,
         );
     }
 
@@ -681,13 +703,13 @@ private function getNftV2ApiUrl(): string
         return 'https://'.self::$apiUrlPlaceholder.'.g.alchemy.com/nft/v2/';
     }
 
-    private function filterNft(mixed $nft): bool
+    private function filterNft(mixed $nft, bool $filterError = true): bool
     {
         if (Arr::get($nft, 'spamInfo.isSpam', false)) {
             return false;
         }
 
-        if (Arr::has($nft, 'error')) {
+        if (Arr::has($nft, 'error') && $filterError) {
             return false;
         }
 

app/Http/Client/Moralis/MoralisPendingRequest.php

@@ -170,6 +170,8 @@ public function getWalletNfts(Wallet $wallet, Network $network, ?string $cursor)
                 traits: [],
                 mintedBlock: (int) $nft['block_number_minted'],
                 mintedAt: null,
+                hasError: false,
+                error: null,
             );
         })->values();
 

app/Services/Web3/Fake/FakeWeb3DataProvider.php

@@ -86,6 +86,8 @@ public function getWalletNfts(Wallet $wallet, Network $network, string $cursor =
                 traits: [],
                 mintedBlock: random_int(1, 10000),
                 mintedAt: now(),
+                hasError: false,
+                error: null,
             );
         });
 

app/Support/Web3NftHandler.php

@@ -65,6 +65,12 @@ public function store(Collection $nfts, bool $dispatchJobs = false): void
                 $attributes['opensea_slug'] = $nftData->collectionOpenSeaSlug;
             }
 
+            if ($nftData->hasError) {
+                $attributes = array_filter($attributes, function ($value) {
+                    return $value !== null;
+                });
+            }
+
             return [
                 $nftData->tokenAddress,
                 $nftData->networkId,
@@ -124,22 +130,32 @@ public function store(Collection $nfts, bool $dispatchJobs = false): void
                 return $this->shouldKeepNft($collection);
             });
 
-            $valuesToUpsert = $nfts->map(fn ($nft) => [
-                'wallet_id' => $this->wallet?->id,
-                'collection_id' => $groupedByAddress->get(Str::lower($nft->tokenAddress))->id,
-                'token_number' => $nft->tokenNumber,
-                'name' => $nft->name,
-                'extra_attributes' => json_encode($nft->extraAttributes),
-                'deleted_at' => null,
-                'metadata_fetched_at' => $now,
-            ])->toArray();
+            $valuesToUpsert = $nfts->map(function ($nft) use ($groupedByAddress, $now) {
+                $collection = $groupedByAddress->get(Str::lower($nft->tokenAddress));
+
+                $values = [
+                    'wallet_id' => $this->wallet?->id,
+                    'collection_id' => $collection->id,
+                    'token_number' => $nft->tokenNumber,
+                    'name' => $nft->name,
+                    'extra_attributes' => json_encode($nft->extraAttributes),
+                    'deleted_at' => null,
+                    'metadata_fetched_at' => $now,
+                    'error' => $nft->hasError ? $nft->error : null,
+                ];
+
+                return $values;
+            })->toArray();
 
             $uniqueBy = ['collection_id', 'token_number'];
 
-            $valuesToUpdateIfExists = ['name', 'extra_attributes', 'deleted_at', 'metadata_fetched_at'];
+            $valuesToUpdateIfExists = ['deleted_at', 'error'];
+            $valuesToCheck = ['name', 'extra_attributes', 'metadata_fetched_at', 'wallet_id'];
 
-            if ($this->wallet !== null) {
-                $valuesToUpdateIfExists[] = 'wallet_id';
+            foreach ($valuesToCheck as $value) {
+                if (array_filter($valuesToUpsert, fn ($v) => $v[$value] !== null)) {
+                    $valuesToUpdateIfExists[] = $value;
+                }
             }
 
             Nft::upsert($valuesToUpsert, $uniqueBy, $valuesToUpdateIfExists);

database/migrations/2023_10_17_084040_add_error_column_to_nfts_table.php

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

database/seeders/LiveUserSeeder.php

@@ -173,6 +173,8 @@ traits: array_map(fn ($trait) => [
             ], $nft['traits']),
             mintedAt: Carbon::parse($nft['mintedAt']),
             mintedBlock: $nft['mintedBlock'],
+            hasError: false,
+            error: null,
         ));
     }
 

resources/types/generated.d.ts

@@ -491,6 +491,8 @@ declare namespace App.Data.Web3 {
         traits: Array<any>;
         mintedBlock: number;
         mintedAt: string | null;
+        hasError: boolean | null;
+        error: string | null;
     };
     export type Web3NftTransfer = {
         contractAddress: string;

tests/App/Http/Client/Alchemy/AlchemyPendingRequestTest.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use App\Enums\NftErrors;
 use App\Exceptions\ConnectionException;
 use App\Exceptions\RateLimitException;
 use App\Models\Collection;
@@ -94,3 +95,80 @@
 
     expect($fetchedNfts->nfts)->toHaveCount(1);
 });
+
+it('should add a flag in case of responses with errors', function () {
+    Alchemy::fake([
+        'https://polygon-mainnet.g.alchemy.com/nft/v2/*' => Http::sequence()
+            ->push(fixtureData('alchemy.nfts_array_with_error'), 200),
+    ]);
+
+    $wallet = Wallet::factory()->create();
+    $network = Network::polygon();
+
+    $collection = Alchemy::getWalletNfts($wallet, $network);
+    expect($collection->nfts[0]->hasError)->toBetrue();
+});
+
+it('should not add a flag in case of valid responses', function () {
+    Alchemy::fake([
+        'https://polygon-mainnet.g.alchemy.com/nft/v2/*' => Http::sequence()
+            ->push(fixtureData('alchemy.nfts_array_valid'), 200),
+    ]);
+
+    $wallet = Wallet::factory()->create();
+    $network = Network::polygon();
+
+    $collection = Alchemy::getWalletNfts($wallet, $network);
+    expect($collection->nfts[0]->hasError)->not->toBeTrue();
+});
+
+it('should not filter nfts with errors if the flag is set as true', function () {
+    Alchemy::fake([
+        'https://polygon-mainnet.g.alchemy.com/nft/v2/*' => Http::sequence()
+            ->push(fixtureData('alchemy.nfts_array_with_error'), 200),
+    ]);
+
+    $wallet = Wallet::factory()->create();
+    $network = Network::polygon();
+
+    $collection = Alchemy::getWalletNfts($wallet, $network);
+    expect($collection->nfts)->toHaveCount(1);
+});
+
+it('should filter nfts with errors by default', function () {
+    $user = createUser();
+
+    $network = Network::polygon();
+    $collection = Collection::factory()->create(['network_id' => $network->id]);
+
+    $nfts = collect();
+    $nft = Nft::factory()->create([
+        'wallet_id' => $user->wallet,
+        'collection_id' => $collection,
+    ]);
+
+    $nfts->push($nft);
+
+    Alchemy::fake([
+        'https://polygon-mainnet.g.alchemy.com/nft/v2/*' => Http::response(fixtureData('alchemy.nft_batch_metadata_with_error'), 200),
+    ]);
+
+    $fetchedNfts = Alchemy::nftMetadataBatch($nfts, $network);
+
+    expect($fetchedNfts->nfts)->toHaveCount(0);
+});
+
+it('should return error field with METADATA_OUTATED if metadata object is empty', function () {
+    Alchemy::fake([
+        'https://polygon-mainnet.g.alchemy.com/nft/v2/*' => Http::sequence()
+            ->push(fixtureData('alchemy.nfts_array_with_error_and_empty_metadata_object'), 200),
+    ]);
+
+    $wallet = Wallet::factory()->create();
+    $network = Network::polygon();
+
+    $collection = Alchemy::getWalletNfts($wallet, $network);
+    print_r($collection);
+    expect($collection->nfts[0]->hasError)->toBetrue();
+    expect($collection->nfts[0]->error)->toBe(NftErrors::MetadataOutdated->value);
+});

tests/App/Jobs/DetermineCollectionMintingDateTest.php

@@ -53,6 +53,8 @@
         traits: [],
         mintedBlock: 1000,
         mintedAt: null,
+        hasError: false,
+        error: null,
     );
 
     $job = new DetermineCollectionMintingDate($nft);
@@ -103,6 +105,8 @@ traits: [],
         traits: [],
         mintedBlock: 1000,
         mintedAt: null,
+        hasError: false,
+        error: null,
     );
 
     $job = new DetermineCollectionMintingDate($nft);
@@ -136,6 +140,8 @@ traits: [],
         traits: [],
         mintedBlock: 1000,
         mintedAt: null,
+        hasError: false,
+        error: null,
     );
 
     $job = new DetermineCollectionMintingDate($nft);
@@ -167,6 +173,8 @@ traits: [],
         traits: [],
         mintedBlock: 1000,
         mintedAt: null,
+        hasError: false,
+        error: null,
     );
 
     $job = new DetermineCollectionMintingDate($nft);