Fazer uma mudança em uma interface que afeta todos os seus consumidores exige dois modos de pensamento: a execução da mudança em si e depois a atualização de todos os seus usos. Isso pode ser difícil quando você tenta fazer as duas coisas ao mesmo tempo, especialmente se a mudança é em uma InterfacePublicada (ou PublishedInterface) com vários clientes ou clientes externos.
Mudança paralela, também conhecida como expansão e contração, é um padrão para implementar mudanças que quebram compatibilidade prévia de uma interface de uma forma segura, separando a execução da mudança em três fases distintas: expansão, migração e contração.
Para entender o padrão, vamos usar um exemplo de uma classe Grid simples que armazena e fornece informações sobre as suas células, usando um par de coordenadas inteiras x e y. As células são armazenadas internamente em uma matriz bidimensional e seus clientes podem usar os métodos addCell(), fetchCell() e isEmpty() para interagir com o Grid.
class Grid {
private Cell[][] cells;
…
public void addCell(int x, int y, Cell cell) {
cells[x][y] = cell;
}
public Cell fetchCell(int x, int y) {
return cells[x][y];
}
public boolean isEmpty(int x, int y) {
return cells[x][y] == null;
}
}
Durante uma refatoração, detectamos que x e y são um AglomeradoDeDados (ou DataClump) e decidimos introduzir uma nova classe Coordinate. No entanto, esta será uma mudança que quebra a compatibilidade da classe Grid para seus clientes. Ao invés de mudar todos os métodos e a estrutura de dados interna de uma só vez, decidimos aplicar o padrão de mudança paralela.
Na fase de expansão você aumenta a interface para que ela suporte tanto a antiga quanto a nova versão. Em nosso exemplo, vamos adicionar uma nova estrutura de dados Map<Coordinate, Cell> e novos métodos que recebem instâncias de Coordinate sem alterar o código existente.
class Grid {
private Cell[][] cells;
private Map newCells;
…
public void addCell(int x, int y, Cell cell) {
cells[x][y] = cell;
}
public void addCell(Coordinate coordinate, Cell cell) {
newCells.put(coordinate, cell);
}
public Cell fetchCell(int x, int y) {
return cells[x][y];
}
public Cell fetchCell(Coordinate coordinate) {
return newCells.get(coordinate);
}
public boolean isEmpty(int x, int y) {
return cells[x][y] == null;
}
public boolean isEmpty(Coordinate coordinate) {
return !newCells.containsKey(coordinate);
}
}
Os clientes já existentes continuarão a consumir a versão antiga e as novas mudanças poderão ser introduzidas de forma incremental, sem afetá-los.
Durante a fase de Migração você atualiza todos os clientes que estão usando a versão antiga para usarem a nova versão. Isso pode ser feito de forma gradual e em caso de clientes externos, essa será a fase mais longa.
Uma vez que todos os usos foram migrados para a nova versão, a fase de contração é executada para remover a versão antiga e alterar a interface para que ela suporte apenas a nova versão.
No nosso exemplo, uma vez que a matriz bidimensional interna não é mais utilizada, depois de apagar os métodos antigos, pode-se remover com segurança a estrutura de dados e renomear newCells de volta a cells.
class Grid {
private Map cells;
…
public void addCell(Coordinate coordinate, Cell cell) {
cells.put(coordinate, cell);
}
public Cell fetchCell(Coordinate coordinate) {
return cells.get(coordinate);
}
public boolean isEmpty(Coordinate coordinate) {
return !cells.containsKey(coordinate);
}
}
Este padrão é particularmente útil quando se pratica a Entrega Contínua, porque permite que seu código seja liberado em qualquer uma dessas três fases. Ele também reduz o risco da mudança, permitindo que você migre os clientes e teste a nova versão de forma incremental.
Mesmo quando você tem o controle de todos os usos da interface, ainda assim é útil seguir esse padrão, para evitar espalhar quebras por todo o código de uma só vez. A fase de migração pode ser curta, mas essa é uma alternativa ao uso do compilador para encontrar todos os usos que precisam ser corrigidos.
Alguns exemplos da aplicação desse padrão são:
- Refatoração: quando se muda a assinatura de um método ou função, especialmente ao fazer uma refatoração de longo prazo, ou quando se muda uma InterfacePublicada. Uma variação da implementação deste padrão durante uma refatoração é implementar o método antigo em termos da nova API e fazer um inline método (InlineMethod) para atualizar todos os usos de uma só vez. Delegar o método antigo para o novo método também é uma outra forma de quebrar a fase de migração em etapas menores e mais seguras, permitindo que você mude primeiramente a implementação interna antes de alterar a API exposta aos clientes. Isto é útil quando a fase de migração é mais longa, para que você não precise dar manutenção em duas implementações separadas.
- Refatoração de banco de dados: esse é um ingrediente chave para o design evolutivo de banco de dados. A maioria das refatorações de banco de dados seguem o padrão de mudança paralela, onde a fase de migração é o período de transição entre o schema original e o novo schema, até que todo o código de acesso ao banco de dados seja atualizado para trabalhar com o novo schema.
- Deployments (ou implantações): técnicas de implantação como canary releases e BlueGreenDeployment são aplicações do padrão de mudança paralela, onde você tem as versões antiga e nova do código implantado lado a lado e você gradativamente migra usuários de uma versão para outra, diminuindo assim os riscos da mudança. Em uma arquitetura de microserviços (microservices architecture), esta técnica pode também eliminar a necessidade de uma orquestração de implantação complexa entre diversos serviços devido a dependências de versão entre eles.
- Evolução de API remota: a mudança paralela pode ser usada para evoluir uma API remota (por exemplo, um web service REST) quando não é possível fazer a mudança de forma a manter compatibilidade prévia com seus consumidores. Esta é uma alternativa ao uso de uma versão explícita na API exposta. Você pode aplicar o padrão ao fazer uma alteração no conteúdo aceito ou retornado pela API em um determinado endpoint, ou você pode introduzir um novo endpoint para distinguir entre as versões nova e antiga. No caso de usar a mudança paralela em um mesmo endpoint, seguir a Lei de Postel é uma boa técnica para evitar que os clientes quebrem quando o conteúdo da mensagem é expandido.
Durante a fase de migração, uma FeatureToggle pode ser usada para controlar qual versão da interface é utilizada. Um recurso de alternância no lado do cliente permite que ele seja compatível com a versão futura do fornecedor, que pode ter a sua release separada da release do cliente.
Ao implementar BranchPorAbstração (ou BranchByAbstraction), a mudança paralela é uma boa maneira de introduzir a camada de abstração entre os clientes e o fornecedor. Também é uma forma alternativa de realizar uma mudança em grande escala sem a necessidade de introduzir a camada de abstração para substituição no lado do fornecedor. Entretanto, quando se tem um grande número de clientes, usar BranchByAbstraction é a melhor estratégia para reduzir a superfície de mudança e reduzir a confusão durante a fase de migração.
A desvantagem de usar mudança paralela é que durante a fase de migração o fornecedor precisa suportar duas versões diferentes e os clientes podem ficar confusos sobre qual versão é a nova e qual é a velha. Se a fase de contração não for executada, você pode acabar em um estado pior do que quando você começou, portanto você precisa de disciplina para concluir a transição com sucesso. A adição de comentários de descontinuação, documentação ou comentários TODO podem ajudar a informar os clientes e os outros desenvolvedores que trabalham na mesma base de código sobre qual versão está em vias de ser substituída.
Leitura adicional
O álbum de refatoração da Industrial Logic documenta e demonstra um exemplo de execução de uma mudança paralela.
Agradecimentos
Esta técnica foi documentada como uma estratégia de refatoração pela primeira vez em 2006 por Joshua Kerievsky e apresentada em sua palestra The Limited Red Society na Lean Software and Systems Conference em 2010.
Agradecimentos ao Joshua Kerievsky por dar feedback no primeiro rascunho deste artigo. Além disso, agradeço os diversos colegas ThoughtWorkers pelo feedback: Greg Dutcher, Badrinath Janakiraman, Praful Todkar, Rick Carragher, Filipe Esperandio, Jason Yip, Tushar Madhukar, Pete Hodgson, e Kief Morris.
Este post foi originalmente publicado em inglês no Bliki do Martin Fowler.