Restrições de versão para dependências opcionais

Vamos imaginar a seguinte situação:

Estou desenvolvendo na Extensão A e incluí a Extensão B como uma dependência opcional. Fiz algumas alterações na lógica da Extensão A que exigem uma versão recente da Extensão B (se estiver habilitada). O problema que me levou a escrever este post é que, às vezes, esqueço de atualizar a versão da Extensão B, o que acabou (de certa forma) quebrando minhas instâncias de desenvolvimento locais algumas vezes.

Portanto, proponho que seja exigida a definição e implementação de uma restrição de versão para dependências opcionais em extensões, assim como ocorre com dependências obrigatórias e de desenvolvimento. Embora, na maioria das situações, a restrição com curinga *possa ser utilizada.

Opiniões? Isso seria desejável para a versão 2.0?

Esse post parece ser a tradução de uma discussão do fórum oficial: Version constraints for optional dependencies, de 2024, com 3 respostas. Não consegui abrir as respostas, então vale ler lá o que a equipe disse sobre o 2.0.

Como se proteger hoje

Enquanto não existe suporte nativo, dá para usar o composer.json da Extensão A:

• conflict: bloqueia versões incompatíveis da B, mas só quando ela estiver instalada. Isso se encaixa bem no caso de dependência opcional.

"conflict": {
    "vendor/extension-b": "<2.1.0"
}

• suggest: só documenta a recomendação, sem impedir nada.

Com o conflict, o Composer recusa a atualização se a B estiver numa versão antiga. Isso evita o problema de esquecer de atualizar.

Na prática

Para o Flarum aplicar a restrição ao habilitar a extensão, o ExtensionManager teria de ler optional-dependencies com versão. Hoje a lista é só de nomes. Por isso a sua proposta faz sentido, e o conflict é um bom paliativo até lá.

Quer que eu procure se o Flarum 2.0 já mudou algo nessa parte?

Aline Quer que eu procure se o Flarum 2.0 já mudou algo nessa parte?

Sim, por favor

Ramon Pesquisei no fórum oficial e não achei nada que confirme essa mudança no Flarum 2.0.

• O único tópico sobre o assunto é o Version constraints for optional dependencies, de março de 2024, com 3 respostas. Pelos trechos da busca, não dá para saber o que foi respondido sobre o 2.0.
• Outro tópico relacionado é o Optional/conditional database migrations, de 2022. Ele fala de dependências opcionais, mas não de restrição de versão.
• As buscas não trouxeram anúncio, changelog nem discussão que diga que o 2.0 passou a aceitar versão em dependências opcionais.

O que fazer agora

1. Abra o tópico original e leia as 3 respostas. É lá que a equipe pode ter comentado sobre o 2.0.
2. Confira o código do ExtensionManager e a documentação do 2.0 no GitHub do flarum/framework. Esse é o jeito mais seguro de saber se mudou.
3. Enquanto isso, use o conflict no composer.json, como falei antes. Ele já evita o problema de esquecer de atualizar a Extensão B.

Se a mudança não existir, vale abrir uma issue no flarum/framework com a sua proposta e citar o tópico antigo.

Aline Confira o código do ExtensionManager e a documentação do 2.0 no GitHub do flarum/framework. Esse é o jeito mais seguro de saber se mudou.

Isso resolveu, obrigado! 😉

Ramon De nada, Ramon! 🎉

Se no código do ExtensionManager ainda não houver suporte a versão em optional-dependencies, abra uma issue no flarum/framework. Cite o tópico original e o exemplo do conflict como paliativo. Isso ajuda a equipe a ver que existe demanda.

Se quiser, conte aqui o que você encontrou. Pode ajudar quem passar pelo mesmo problema.

Aline Se quiser, conte aqui o que você encontrou. Pode ajudar quem passar pelo mesmo problema.

Isso já me ajudou, muito obrigado!

Ramon Que bom que ajudou, Ramon! 🙌

Para quem chegar aqui depois, o resumo é este:

1. Use conflict no composer.json da Extensão A para bloquear versões antigas da B. Ele só vale se a B estiver instalada, o que combina com dependência opcional.
2. Veja no código do ExtensionManager e na documentação do 2.0 se já existe suporte nativo a versão em optional-dependencies.
3. Se não existir, abra uma issue no flarum/framework citando o tópico original.

Se você descobrir algo no código, volte e conte aqui. Boa sorte no desenvolvimento! 🚀