Skip to content

Latest commit

 

History

History
442 lines (337 loc) · 20.8 KB

UPGRADE-1.0.md

File metadata and controls

442 lines (337 loc) · 20.8 KB
Raw

UPGRADE FROM 1.0.1 TO 1.0.2

  1. The return types of Sylius\RefundPlugin\Entity\CustomerBillingDataInterface method has been changed:

    +   public function getFirstName(): ?string;
-   public function getFirstName(): string;
+   public function getLastName(): ?string;
-   public function getLastName(): string;
+   public function getStreet(): ?string;
-   public function getStreet(): string;
+   public function getPostcode(): ?string;
-   public function getPostcode(): string;
+   public function getCountryCode(): ?string;
-   public function getCountryCode(): string;
+   public function getCity(): ?string;
-   public function getCity(): string;

  2. The return types of Sylius\RefundPlugin\Entity\CreditMemoInterface method has been changed:

    +   public function getNumber(): ?string;
-   public function getNumber(): string;
+   public function getOrder(): ?OrderInterface;
-   public function getOrder(): OrderInterface;
+   public function getCurrencyCode(): ?string;
-   public function getCurrencyCode(): string;
+   public function getLocaleCode(): ?string;
-   public function getLocaleCode(): string;
+   public function getChannel(): ?ChannelInterface;
-   public function getChannel(): ChannelInterface;
+   public function getComment(): ?string;
-   public function getComment(): string;
+   public function getIssuedAt(): ?\DateTimeImmutable;
-   public function getIssuedAt(): \DateTimeImmutable;
+   public function getFrom(): ?CustomerBillingDataInterface;
-   public function getFrom(): CustomerBillingDataInterface;

UPGRADE FROM 1.0.0-RC.11 TO 1.0.0

  1. orderNumber field on Sylius\RefundPlugin\Entity\Refund and Sylius\RefundPlugin\Entity\RefundPayment has been removed and replaced with relation to Order entity.

  2. Sylius\RefundPlugin\Entity\RefundInterface::getOrderNumber function is left due to easier and smoother upgrades, but is also deprecated and will be removed in the v1.0.0 release. Use Sylius\RefundPlugin\Entity\RefundInterface::getOrder instead.

  3. Sylius\RefundPlugin\Entity\RefundPaymentInterface::getOrderNumber function is left due to easier and smoother upgrades, but is also deprecated and will be removed in the v1.0.0 release. Use Sylius\RefundPlugin\Entity\RefundPaymentInterface::getOrder instead.

  4. Sylius\RefundPlugin\Creator\RefundCreator takes Sylius\Component\Core\Repository\OrderRepositoryInterface as the 3rd argument.

  5. Sylius\RefundPlugin\ProcessManager\RefundPaymentProcessManager takes Sylius\Component\Core\Repository\OrderRepositoryInterface as the 4th argument.

  6. Sylius\RefundPlugin\Provider\OrderRefundedTotalProviderInterface::invoke takes OrderInterface $order as an argument instead of string $orderNumber

  7. Sylius\RefundPlugin\Factory\RefundPaymentFactory::createWithData takes OrderInterface $order as an argument instead of string $orderNumber

  8. The constructor of Sylius\RefundPlugin\Provider\DefaultRelatedPaymentIdProvider has been removed.

  9. Constructor of Sylius\RefundPlugin\Entity\CustomerBillingData has been removed and now CustomerBillingData entity is created by Sylius\RefundPlugin\Factory\CustomerBillingDataFactory.

  10. Constructor of Sylius\RefundPlugin\Entity\ShopBillingData has been removed and now ShopBillingData entity is created by Sylius\RefundPlugin\Factory\ShopBillingDataFactory.

  11. The constructor of Sylius\RefundPlugin\Generator\CreditMemoGenerator has been changed:

        public function __construct(
        LineItemsConverterInterface $lineItemsConverter,
        LineItemsConverterInterface $shipmentLineItemsConverter,
        TaxItemsGeneratorInterface $taxItemsGenerator,
        CreditMemoFactoryInterface $creditMemoFactory,
+       CustomerBillingDataFactoryInterface $customerBillingDataFactory,
+       ShopBillingDataFactoryInterface $shopBillingDataFactory
    ) {
        ...
    }

  12. The id method from Sylius\RefundPlugin\Entity\CustomerBillingData has its return type removed:

    -   public function id(): ?int;
+   public function id();

  13. The getter methods of Sylius\RefundPlugin\Entity\CustomerBillingData are now deprecated and will be replaced with:

    -   public function id(): ?int
+   public function getId()
-   public function firstName(): string
+   public function getFirstName(): string
-   public function lastName(): string
+   public function getLastName(): string
-   public function fullName(): string
+   public function getFullName(): string
-   public function street(): string
+   public function getStreet(): string
-   public function postcode(): string
+   public function getPostcode(): string
-   public function city(): string
+   public function getCity(): string
-   public function company(): ?string
+   public function getCompany(): ?string
-   public function provinceName(): ?string
+   public function getProvinceName(): ?string
-   public function provinceCode(): ?string
+   public function getProvinceCode(): ?string

  14. sylius_refund_plugin.block_event_listener.account.order_show and sylius_refund_plugin.block_event_listener.order_show.credit_memos listeners have been replaced by sylius_ui configuration

  15. Sylius\RefundPlugin\Factory\RefundPaymentFactoryInterface and Sylius\RefundPlugin\Factory\RefundPaymentFactory service definitions have been removed and replaced by default resource factory sylius_refund.factory.refund_payment

  16. The constructor of Sylius\RefundPlugin\Factory\RefundPaymentFactory has been changed:

    -   public function __construct(PaymentMethodRepositoryInterface $paymentMethodRepository)
+   public function __construct(string $className)
    {
-       $this->paymentMethodRepository = $paymentMethodRepository;
+       $this->className = $className;
    }

  17. The createWithData method of Sylius\RefundPlugin\Factory\RefundPaymentFactoryInterface has been changed:

        public function createWithData(
        OrderInterface $order,
        int $amount,
        string $currencyCode,
        string $state,
-       int $paymentMethodId
+       PaymentMethodInterface $paymentMethod
    ): RefundPaymentInterface;

  18. The definition of Sylius\RefundPlugin\ProcessManager\RefundPaymentProcessManager has been changed:

        <service id="Sylius\RefundPlugin\ProcessManager\RefundPaymentProcessManager">
        <argument type="service" id="Sylius\RefundPlugin\StateResolver\OrderFullyRefundedStateResolverInterface" />
        <argument type="service" id="Sylius\RefundPlugin\Provider\RelatedPaymentIdProviderInterface" />
-       <argument type="service" id="Sylius\RefundPlugin\Factory\RefundPaymentFactoryInterface" />
+       <argument type="service" id="sylius_refund.factory.refund_payment" />
        <argument type="service" id="sylius.repository.order" />
+       <argument type="service" id="sylius.repository.payment_method" />
        <argument type="service" id="doctrine.orm.default_entity_manager" />
        <argument type="service" id="sylius.event_bus" />
        <tag name="sylius_refund.units_refunded.process_step" priority="50" />
    </service>

  19. The constructor of Sylius\RefundPlugin\Creator\RefundUnitsCommandCreator has been changed:

    -   public function __construct(UnitRefundTotalCalculatorInterface $unitRefundTotalCalculator)
+   public function __construct(RefundUnitsConverterInterface $refundUnitsConverter)
    {
-       $this->unitRefundTotalCalculator = $unitRefundTotalCalculator;
+       $this->refundUnitsConverter = $refundUnitsConverter;
    }

  20. The constructor of Sylius\RefundPlugin\Twig\OrderRefundsExtension has been changed:

        public function __construct(
        OrderRefundedTotalProviderInterface $orderRefundedTotalProvider,
        UnitRefundedTotalProviderInterface $unitRefundedTotalProvider,
        UnitRefundingAvailabilityCheckerInterface $unitRefundingAvailabilityChecker,
        OrderRepositoryInterface $orderRepository,
        RepositoryInterface $refundPaymentRepository
        RepositoryInterface $refundPaymentRepository,
+       RefundTypeFactoryInterface $refundTypeFactory
    ) {
        ...
    }

  21. Return type on getType method of Sylius\RefundPlugin\Entity\Refund and Sylius\RefundPlugin\Entity\RefundInterface has been changed from RefundType to RefundTypeInterface

  22. Return type on convertToPHPValue method of Sylius\RefundPlugin\Entity\Type\RefundEnumType has been changed from RefundType to RefundTypeInterface

  23. We replaced RefundType with RefundTypeInterface in the given list of classes:

    • Sylius\RefundPlugin\Creator\RefundCreator
    • Sylius\RefundPlugin\Checker\UnitRefundingAvailabilityChecker
    • Sylius\RefundPlugin\Entity\Type\RefundEnumType
    • Sylius\RefundPlugin\Entity\Refund
    • Sylius\RefundPlugin\Factory\RefundFactory
    • Sylius\RefundPlugin\Provider\RemainingTotalProvider
    • Sylius\RefundPlugin\Provider\UnitRefundedTotalProvider
    • Sylius\RefundPlugin\Validator\RefundAmountValidator

  24. Sylius\RefundPlugin\Model\RefundType implements Sylius\RefundPlugin\Model\RefundTypeInterface and consts ORDER_ITEM_UNIT and SHIPMENT has been moved to RefundTypeInterface

  25. Service Sylius\RefundPlugin\Twig\OrderRefundsExtension has been changed:

        <service id="Sylius\RefundPlugin\Twig\OrderRefundsExtension">
        <argument type="service" id="Sylius\RefundPlugin\Provider\OrderRefundedTotalProviderInterface" />
        <argument type="service" id="Sylius\RefundPlugin\Provider\UnitRefundedTotalProviderInterface" />
        <argument type="service" id="Sylius\RefundPlugin\Checker\UnitRefundingAvailabilityCheckerInterface" />
        <argument type="service" id="sylius.repository.order" />
        <argument type="service" id="sylius_refund.repository.refund_payment" />
+       <argument type="service" id="Sylius\RefundPlugin\Factory\RefundTypeFactoryInterface" />
        <tag name="twig.extension"/>
    </service>

  26. The constructor of Sylius\RefundPlugin\Twig\OrderRefundsExtension has been changed:

        public function __construct(
        OrderRefundedTotalProviderInterface $orderRefundedTotalProvider,
        UnitRefundedTotalProviderInterface $unitRefundedTotalProvider,
        UnitRefundingAvailabilityCheckerInterface $unitRefundingAvailabilityChecker,
        OrderRepositoryInterface $orderRepository,
        RepositoryInterface $refundPaymentRepository
        RepositoryInterface $refundPaymentRepository,
+       RefundTypeFactoryInterface $refundTypeFactory
    ) {
        ...
    }

UPGRADE FROM 1.0.0-RC.9 TO 1.0.0-RC.10

  1. Support for Sylius 1.8 has been dropped, upgrade your application to Sylius 1.9 or Sylius 1.10.

  2. Remove usage of:

    • Sylius\RefundPlugin\Entity\AdjustmentInterface
    • Sylius\RefundPlugin\Entity\AdjustmentTrait
    • Sylius\RefundPlugin\Entity\ShipmentInterface
    • Sylius\RefundPlugin\Entity\ShipmentTrait

  3. Delete removed migrations from the migrations table by running:

    bin/console doctrine:migrations:version Sylius\\RefundPlugin\\Migrations\\Version20201208105207 --delete
bin/console doctrine:migrations:version Sylius\\RefundPlugin\\Migrations\\Version20201130071338 --delete
bin/console doctrine:migrations:version Sylius\\RefundPlugin\\Migrations\\Version20201204071301 --delete

  4. Command bus sylius_refund_plugin.command_bus has been replaced with sylius.command_bus.

  5. Event bus sylius_refund_plugin.event_bus has been replaced with sylius.event_bus.

  6. Sylius\RefundPlugin\Grid\Filter\ChannelFilter and Sylius\RefundPlugin\Form\Type\ChannelFilterType services have been removed and channel filter configuration in grid has been replaced by entity filter.

  7. Constructor of Sylius\RefundPlugin\Entity\CreditMemo has been removed and now CreditMemo entity is created by Sylius\RefundPlugin\Factory\CreditMemoFactory.

  8. The constructor of Sylius\RefundPlugin\Generator\CreditMemoGenerator has been changed:

        public function __construct(
        LineItemsConverterInterface $lineItemsConverter,
        LineItemsConverterInterface $shipmentLineItemsConverter,
        TaxItemsGeneratorInterface $taxItemsGenerator,
-       NumberGenerator $creditMemoNumberGenerator,
-       CurrentDateTimeImmutableProviderInterface $currentDateTimeImmutableProvider,
-       CreditMemoIdentifierGeneratorInterface $uuidCreditMemoIdentifierGenerator
+       CreditMemoFactoryInterface $creditMemoFactory
    ) {
        ...
    }

  9. Post-units refunded process (containing credit memo and refund payment generation) was changed to synchronous step. Refund payment is therefore always generated after credit memo. Technical changes:

    • Sylius\RefundPlugin\ProcessManager\CreditMemoProcessManager and Sylius\RefundPlugin\ProcessManager\RefundPaymentProcessManager no longer directly listen to Sylius\RefundPlugin\Event\UnitsRefunded event. Sylius\RefundPlugin\ProcessManager\UnitsRefundedProcessManager uses them to facilitate post-units refunding process.
    • Their __invoke methods were replaced by Sylius\RefundPlugin\ProcessManager\UnitsRefundedProcessStepInterface::next(UnitsRefunded $unitsRefunded).

  10. Sylius\RefundPlugin\Generator\NumberGenerator has been changed to Sylius\RefundPlugin\Generator\CreditMemoNumberGeneratorInterface and its method has been changed from public function generate(): string to public function generate(OrderInterface $order, \DateTimeInterface $issuedAt): string.

  11. Service name and definition has been changed from Sylius\RefundPlugin\Generator\SequentialNumberGenerator to Sylius\RefundPlugin\Generator\SequentialCreditMemoNumberGenerator and its last argument CurrentDateTimeImmutableProviderInterface $currentDateTimeImmutableProvider has been removed from constructor.

UPGRADE FROM 1.0.0-RC.7 TO 1.0.0-RC.8

  1. The fully_refunded state and the refund transition have been removed from sylius_order state machine.

  2. Sylius\RefundPlugin\Provider\LabelBasedTaxRateProvider has been changed to Sylius\RefundPlugin\Provider\TaxRateProvider.

  3. The method Sylius\RefundPlugin\Provider\TaxRateProviderInterface has been changed from provide(OrderItemUnitInterface $orderItemUnit): ?string to provide(AdjustableInterface $adjustable): ?string.

  4. The TaxRateProviderInterface $taxRateProvider has been added as the second argument in constructor of Sylius\RefundPlugin\Converter\ShipmentLineItemsConverter

  5. Service definition for Sylius\RefundPlugin\Converter\ShipmentLineItemsConverter has been changed from Sylius\RefundPlugin\Converter\ShipmentLineItemsConverterInterface to Sylius\RefundPlugin\Converter\ShipmentLineItemsConverter

  6. Sylius\RefundPlugin\Converter\LineItemsConverter has been changed to Sylius\RefundPlugin\Converter\OrderItemUnitLineItemsConverter and its service definition has been changed from Sylius\RefundPlugin\Converter\LineItemsConverterInterface to Sylius\RefundPlugin\Converter\OrderItemUnitLineItemsConverter

  7. The suffix Exception has been removed from classes:

    • Sylius\RefundPlugin\Exception\InvalidRefundAmountException
    • Sylius\RefundPlugin\Exception\OrderNotAvailableForRefundingException
    • Sylius\RefundPlugin\Exception\UnitAlreadyRefundedException

UPGRADE FROM 1.0.0-RC.5 TO 1.0.0-RC.6

  1. The Version20201208105207.php migration was added which extends existing adjustments with additional details (context). Depending on the type of adjustment, additionally defined information are:
  • Taxation details (percentage and relation to tax rate)
  • Shipping details (shipping relation)
  • Taxation for shipping (combined details of percentage and shipping relation)

This data is fetched based on two assumptions:

  • Order level taxes relates to shipping only (default Sylius behaviour)
  • Tax rate name has not change since the time, the first order has been placed

If these are not true, please adjust migration accordingly to your need. To exclude following migration from execution run following code: bin/console doctrine:migrations:version 'Sylius\RefundPlugin\Migrations\Version20201208105207' --add

  1. Add traits that enhance Adjustment and Shipment models from Sylius. These traits are not covered by the backward compatibility promise and it will be removed after update Sylius to 1.9. It is a duplication of a logic from Sylius to provide proper adjustments handling.
<?php

declare(strict_types=1);

namespace Tests\Sylius\RefundPlugin\Application\Entity;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Order\Model\Adjustment as BaseAdjustment;
use Sylius\RefundPlugin\Entity\AdjustmentInterface;
use Sylius\RefundPlugin\Entity\AdjustmentTrait;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_adjustment")
 */
class Adjustment extends BaseAdjustment implements AdjustmentInterface
{
    use AdjustmentTrait;
}
<?php

declare(strict_types=1);

namespace Tests\Sylius\RefundPlugin\Application\Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Sylius\Component\Core\Model\Shipment as BaseShipment;
use Sylius\RefundPlugin\Entity\ShipmentInterface;
use Sylius\RefundPlugin\Entity\ShipmentTrait;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_shipment")
 */
class Shipment extends BaseShipment implements ShipmentInterface
{
    use ShipmentTrait;

    public function __construct()
    {
        parent::__construct();

        /** @var ArrayCollection<array-key, BaseAdjustmentInterface> $this->adjustments */
        $this->adjustments = new ArrayCollection();
    }
}

UPGRADE FROM 1.0.0-RC.3 TO 1.0.0-RC.4

  1. Upgrade your application to Sylius 1.8.

  2. Remove previously copied migration files (You may check names of migrations to remove here).

UPGRADE FROM 1.0.0-RC.2 TO 1.0.0-RC.3

  1. Sylius\RefundPlugin\Entity\RefundPaymentInterface state constants values were changed to lowercase. Backward compatibility provided by migration.

  2. Adjust new templates from the plugin (ref. PR #198)

    ⚠️ Check in your git repository, what has changed and only adjust templates where needed

    cp -R vendor/sylius/refund-plugin/src/Resources/views/SyliusAdminBundle/* templates/bundles/SyliusAdminBundle/

  3. Copy new migrations

    cp -R vendor/sylius/refund-plugin/migrations/{Version20200306145439.php,Version20200306153205.php,Version20200310094633.php,Version20200310185620.php} src/Migrations

  4. Change usage of Sylius\RefundPlugin\Entity\SequenceInterface to Sylius\RefundPlugin\Entity\CreditMemoSequenceInterface

  5. Change usage of Sylius\RefundPlugin\Provider\CurrentDateTimeProviderInterface to Sylius\RefundPlugin\Provider\CurrentDateTimeImmutableProviderInterface

UPGRADE FROM 1.0.0-RC.1 TO 1.0.0-RC.2

  1. Sylius\RefundPlugin\Entity\CreditMemoUnit was changed to Sylius\RefundPlugin\Entity\LineItem which is a resource entity now.

  2. Sylius\RefundPlugin\Generator\CreditMemoUnitGeneratorInterface was changed to Sylius\RefundPlugin\Converter\LineItemsConverterInterface.

  3. Sylius\RefundPlugin\Generator\OrderItemUnitCreditMemoUnitGenerator was changed to Sylius\RefundPlugin\Converter\LineItemsConverter.

  4. Sylius\RefundPlugin\Generator\ShipmentCreditMemoUnitGenerator was changed to Sylius\RefundPlugin\Converter\ShipmentLineItemsConverter.

  5. Sylius\RefundPlugin\Entity\TaxItem became a resource entity.

There are no migrations that provide backward compatibility, save current credit memos before upgrading the version of plugin.

UPGRADE FROM 0.10.1 TO 1.0.0-RC.1

  1. OfflineRefundPaymentMethodsProvider renamed to SupportedRefundPaymentMethodsProvider with the supported gateways array as the 2nd argument (by default only offline gateway is passed and therefore supported).

UPGRADE FROM 0.8.0 TO 0.9.0

  1. Removed CreditMemoChannel and replaced by Sylius\Component\Core\Model\ChannelInterface.

  2. Replaced CustomerBillingData and ShopBillingData value objects by entities with CustomerBillingDataInterface and ShopBillingDataInterface interfaces.