Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Varnish invalidation on subresource

Abierto
  • ¿Algo no está bien?
#8,123 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
25/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php
Área
api, backend

Línea de trabajo

Empieza reproduciendo el comportamiento de la caché de Varnish con la colección /suppliers/{id}/delivery_days y un POST a /delivery_days. Sigue el servicio de invalidación de caché y la configuración de la ruta de la colección descritos en el issue. La tarea está terminada cuando se invalida la caché de la colección del subrecurso sin exponer una ruta de colección predeterminada no deseada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

http State

API Platform version(s) affected: 3.3.6

Description
Varnish cache is not released on a subresource.
For example purposes, I use a Supplier and a DeliveryDay entity.

Supplier:

#[ORM\Entity(repositoryClass: SupplierRepository::class)]
#[ApiResource(
    operations: [
        new Post(),
        new Get(),
        new GetCollection(),
        new Put(),
        new Delete(),
    ],
    normalizationContext: ['groups' => ['supplier:read']],
    denormalizationContext: ['groups' => ['supplier:write']],
)]
class Supplier
{

    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    #[Groups(groups: ['supplier:read'])]
    private ?int $id = null;

    #[ORM\Column(length: 128)]
    #[Groups(groups: ['supplier:read', 'supplier:write'])]
    #[Assert\NotBlank]
    #[Assert\Length(max: 128)]
    public string $name = '';

    #[ORM\OneToMany(targetEntity: DeliveryDay::class, mappedBy: 'supplier', orphanRemoval: true)]
    private Collection $deliveryDays;

    public function __construct()
    {
        $this->deliveryDays = new ArrayCollection();
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    /**
     * @return Collection<int, DeliveryDay>
     */
    public function getDeliveryDays(): Collection
    {
        return $this->deliveryDays;
    }

    public function addDeliveryDay(DeliveryDay $deliveryDay): static
    {
        if (!$this->deliveryDays->contains($deliveryDay)) {
            $this->deliveryDays->add($deliveryDay);
            $deliveryDay->setSupplier($this);
        }

        return $this;
    }

    public function removeDeliveryDay(DeliveryDay $deliveryDay): static
    {
        if ($this->deliveryDays->removeElement($deliveryDay)) {
            // set the owning side to null (unless already changed)
            if ($deliveryDay->getSupplier() === $this) {
                $deliveryDay->setSupplier(null);
            }
        }

        return $this;
    }
}

DeliveryDay:

#[ORM\Entity]
#[ApiResource(
    operations: [
        new Post(),
        new Get(),
        new GetCollection(
            uriTemplate: '/suppliers/{id}/delivery_days',
            uriVariables: [
                'id' => new Link(
                    fromProperty: 'deliveryDays',
                    fromClass: Supplier::class
                ),
            ]
        ),
        new Put(),
        new Delete(),
    ],
    normalizationContext: ['groups' => ['delivery_day:read']],
    denormalizationContext: ['groups' => ['delivery_day:write']],
)]
class DeliveryDay
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    #[Groups(groups: ['delivery_day:read'])]
    private ?int $id = null;

    #[ORM\ManyToOne(inversedBy: 'deliveryDays')]
    #[ORM\JoinColumn(nullable: false)]
    #[Groups(groups: ['delivery_day:read', 'delivery_day:write'])]
    private ?Supplier $supplier = null;

    #[ORM\Column(length: 64)]
    #[Groups(groups: ['delivery_day:read', 'delivery_day:write'])]
    #[Assert\NotBlank]
    #[Assert\Length(max: 64)]
    public string $day = '';

    #[ORM\Column(length: 64)]
    #[Groups(groups: ['delivery_day:read', 'delivery_day:write'])]
    #[Assert\NotBlank]
    #[Assert\Length(max: 64)]
    public string $region = '';

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getSupplier(): ?Supplier
    {
        return $this->supplier;
    }

    public function setSupplier(?Supplier $supplier): static
    {
        $this->supplier = $supplier;

        return $this;
    }
}

How to reproduce
If you now use /suppliers/{id}/delivery_days, Varnish caches that response.
If you then make a POST request to /delivery_days, the cache from the collection route is not invalidated.

Possible Solution
If you add a default GetCollection:

new GetCollection(),
new GetCollection(
    uriTemplate: '/suppliers/{id}/delivery_days',
    uriVariables: [
        'id' => new Link(
            fromProperty: 'deliveryDays',
            fromClass: Supplier::class
        ),
    ]
),

It works, but then there is a route exposed that you don't really want.

So, I would suggest always adding a default cache tag to a collection.
In this case, that would be /delivery_days (even when the route doesn't exist)
and also add this tag to the invalidation service (even if the route doesn't exist).

end word
If I'm doing something that is not intended or missed some docs, please point me in the right direction.
I would like to help resolve this issue by contributing, but I have never done that before.
I would appreciate some help or guidance to get started.

Lenguaje dominante
PHP
Estrellas
2.6k
Forks
989
Merge medio
2 d 1 h
PR fusionados (30 d)
104

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de api-platform/core

Todos los issues de api-platform/core

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.