Bugfix issue 254: Make identifier nullable on product variant and order line

packages/core/database/migrations/2023_09_20_211200_make_identifier_nullable_on_order_lines.php

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Lunar\Base\Migration;
+
+class MakeIdentifierNullableOnOrderLines extends Migration
+{
+    public function up()
+    {
+        Schema::table($this->prefix.'order_lines', function (Blueprint $table) {
+            $table->string('identifier')->nullable()->change();
+        });
+    }
+
+    public function down()
+    {
+        Schema::table($this->prefix.'order_lines', function (Blueprint $table) {
+            $table->string('identifier')->nullable(false)->change();
+        });
+    }
+}

packages/core/src/Base/Purchasable.php

@@ -55,7 +55,7 @@ public function getOption();
     /**
      * Return a unique string which identifies the purchasable item.
      *
-     * @return string
+     * @return ?string
      */
     public function getIdentifier();
 

packages/core/src/Models/ProductVariant.php

@@ -189,7 +189,10 @@ public function getOptions()
      */
     public function getIdentifier()
     {
-        return $this->sku;
+        // TODO: It is better if this is coupled somehow to the config from the admin package
+        // There product identifiers are set and we cen return the one specified there
+        // Which will be more fool proof than this workaround
+        return $this->sku ?? $this->gtin ?? $this->mpn ?? $this->ean ?? null;
     }
 
     public function images()

packages/core/tests/Unit/Actions/Carts/CreateOrderTest.php

@@ -3,6 +3,7 @@
 namespace Lunar\Tests\Unit\Actions\Carts;
 
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Config;
 use Lunar\Actions\Carts\CreateOrder;
 use Lunar\DataTypes\Price as PriceDataType;
 use Lunar\DataTypes\ShippingOption;
@@ -744,4 +745,99 @@ public function can_create_order_with_customer()
 
         $this->assertDatabaseHas((new Order())->getTable(), $datacheck);
     }
+
+    /** @test */
+    public function it_should_create_order_when_no_identifier_is_set_on_product_variant()
+    {
+        CustomerGroup::factory()->create([
+            'default' => true,
+        ]);
+
+        $billing = CartAddress::factory()->make([
+            'type' => 'billing',
+            'country_id' => Country::factory(),
+            'first_name' => 'Santa',
+            'line_one' => '123 Elf Road',
+            'city' => 'Lapland',
+            'postcode' => 'BILL',
+        ]);
+
+        $shipping = CartAddress::factory()->make([
+            'type' => 'shipping',
+            'country_id' => Country::factory(),
+            'first_name' => 'Santa',
+            'line_one' => '123 Elf Road',
+            'city' => 'Lapland',
+            'postcode' => 'SHIPP',
+        ]);
+
+        $taxClass = TaxClass::factory()->create();
+
+        $currency = Currency::factory()->create([
+            'decimal_places' => 2,
+        ]);
+
+        $cart = Cart::factory()->create([
+            'currency_id' => $currency->id,
+        ]);
+
+        $taxClass = TaxClass::factory()->create([
+            'name' => 'Foobar',
+        ]);
+
+        $taxClass->taxRateAmounts()->create(
+            TaxRateAmount::factory()->make([
+                'percentage' => 20,
+                'tax_class_id' => $taxClass->id,
+            ])->toArray()
+        );
+
+        $purchasable = ProductVariant::factory()->create([
+            'tax_class_id' => $taxClass->id,
+            'unit_quantity' => 1,
+            'sku' => null,
+            'gtin' => null,
+            'mpn' => null,
+            'ean' => null,
+        ]);
+
+        Price::factory()->create([
+            'price' => 100,
+            'tier' => 1,
+            'currency_id' => $currency->id,
+            'priceable_type' => get_class($purchasable),
+            'priceable_id' => $purchasable->id,
+        ]);
+
+        $cart->lines()->create([
+            'purchasable_type' => get_class($purchasable),
+            'purchasable_id' => $purchasable->id,
+            'quantity' => 1,
+        ]);
+
+        $cart->addresses()->createMany([
+            $billing->toArray(),
+            $shipping->toArray(),
+        ]);
+
+        $shippingOption = new ShippingOption(
+            name: 'Basic Delivery',
+            description: 'Basic Delivery',
+            identifier: 'BASDEL',
+            price: new PriceDataType(500, $cart->currency, 1),
+            taxClass: $taxClass
+        );
+
+        ShippingManifest::addOption($shippingOption);
+
+        $cart->shippingAddress->update([
+            'shipping_option' => $shippingOption->getIdentifier(),
+        ]);
+
+        $cart->shippingAddress->shippingOption = $shippingOption;
+
+        $order = $cart->createOrder();
+
+        $this->assertNull($order->lines->first()->identifier);
+    }
 }

packages/core/tests/Unit/Models/ProductVariantTest.php

@@ -248,4 +248,84 @@ public function can_get_correct_price_inc_tax_based_on_tax_class()
         $this->assertEquals(416, $foodProductVariant->pricing()->currency($currency)->get()->matched->priceIncTax()->value);
         $this->assertEquals(9760, $genericProductVariant->pricing()->qty(20)->currency($currency)->get()->matched->priceIncTax()->value);
     }
+
+    /** @test */
+    public function it_should_use_gtin_when_sku_is_null()
+    {
+        // Given
+        $product = Product::factory()->create();
+        $gtin = '123';
+        $productVariant = ProductVariant::factory()->create([
+            'product_id' => $product->id,
+            'sku' => null,
+            'gtin' => $gtin
+        ]);
+
+        // When
+        $identifier = $productVariant->getIdentifier();
+
+        // Then
+        $this->assertEquals($gtin, $identifier);
+    }
+
+    /** @test */
+    public function it_should_use_mpn_when_sku_and_gtin_are_null()
+    {
+        // Given
+        $product = Product::factory()->create();
+        $mpn = '123';
+        $productVariant = ProductVariant::factory()->create([
+            'product_id' => $product->id,
+            'sku' => null,
+            'gtin' => null,
+            'mpn' => $mpn
+        ]);
+
+        // When
+        $identifier = $productVariant->getIdentifier();
+
+        // Then
+        $this->assertEquals($mpn, $identifier);
+    }
+
+    /** @test */
+    public function it_should_use_ean_when_sku_gtin_and_mpn_are_null()
+    {
+        // Given
+        $product = Product::factory()->create();
+        $ean = '123';
+        $productVariant = ProductVariant::factory()->create([
+            'product_id' => $product->id,
+            'sku' => null,
+            'gtin' => null,
+            'mpn' => null,
+            'ean' => $ean
+        ]);
+
+        // When
+        $identifier = $productVariant->getIdentifier();
+
+        // Then
+        $this->assertEquals($ean, $identifier);
+    }
+
+    /** @test */
+    public function it_should_return_null_when_all_identifiers_are_null()
+    {
+        // Given
+        $product = Product::factory()->create();
+        $productVariant = ProductVariant::factory()->create([
+            'product_id' => $product->id,
+            'sku' => null,
+            'gtin' => null,
+            'mpn' => null,
+            'ean' => null
+        ]);
+
+        // When
+        $identifier = $productVariant->getIdentifier();
+
+        // Then
+        $this->assertEquals(null, $identifier);
+    }
 }