(este é um post bem técnico, que involve linguagens de programação de gosto duvidoso. prossiga com precaução)

Estava brincando com a plataforma Magento (um CMS específico para e-commerce) e fiquei preso por um tempo maior do que eu gostaria de admitir num comportamento não esperado de um dos seus plugins. Como não achei esta solução na internet, vou deixá-la aqui para que alguém mais se beneficie dela ou critique vorazmente, já que minha solução foi praticamente chutada:

Um dos pontos altos da plataforma Magento são seus plugins. Existem vários plugins que podem ser achados no Magento Connect (o market place deles) e em seguida instalados em seu site. O problema é que há várias versões do Magento em produção. A versão que está em desenvolvimento hoje em dia é  a 1.6, mas já vi gente usando mesmo a 1.2 em alguns forums.

Como o site que estava configurando ia utilizar o UOL PagSeguro como opção de pagamento, baixei o plugin no site do PagSeguro para Magento. Porém na época, a versão do plugin do PagSeguro não era compatível com a versão 1.5 do Magento. Achei então uma versão alternativa, uma modificação do plugin oficial pelo colega programador Bruno Assarisse.

Esta versão funcionou perfeitamente, levando as informações de compra, frete e até endereço do cliente para o PagSeguro, viabilizando a entrada em produção do negócio. Porém – se não tivesse um porém eu não estaria escrevendo este artigo – faltava um detalhe: a contabilização no Google Analytics.

O Google Analytics é uma ferramenta excelente para monitorar o uso de seu site. Uma de suas funcionalidades é a do site de e-commerce enviar o conteúdo dos carrinhos de compra que forem confirmados para que o Analytics faça o acompanhamento das ‘conversões’ (vendas efetivas).
Por exemplo quando você faz uma compra, vai colocando os itens no carrinho de compras virtual. Quando chega no final do processo de compra, informa seus dados de cobrança (número do cartão de crédito, ou gera um boleto bancário). Quando a compra é validada, os ítens que estavam no seu carrinho são enviados para o Google Analytics. Desta forma é possível entender melhor quem é seu cliente, de onde ele veio e que possíveis motivos o fizeram realizar sua compra.

Quando fiz testes usando o método de compra do Paypal esta informação chegava perfeitamente no Google Analytics, mas assim que passamos a usar o plugin do Bruno Assarisse esta informação sumiu! Demorei bastante para identificar o que tinha acontecido, pois basicamente poderia ter quebrado em qualquer lugar! Eu também tinha instalado o plugin Google Analytics Plus, para fazer o tracking dos passos do processo de checkout em Ajax. Então, era o GA Plus? Era o PagSeguro? Era uma edição mal feita de algum arquivo do Magento? Muitas possibilidades…

Resolvi então analisar o problema de trás pra frente. O processo de pagamento utilizando o PagSeguro acontece da seguinte forma:

1. Cliente coloca ítens no carrinho
2. Cliente decide finalizar seu processo de compra (checkout)
3. Cliente preenche endereço de entrega, de cobrança e é redirecionado ao site do PagSeguro
4. A mágica do pagamento acontece do site do PagSeguro
5. Depois de uma contagem regressiva o usuário é levado de volta ao site da sua loja
6. Uma página de ‘muchas gracias’ é apresentada ao cliente. Neste momento é feita a chamada que envia a lista de compras pro Analytics

Comecei pelo passo 6. O Magento 1.5 já tem suporte ao Analytics. O arquivo responsável pela criação do javascript do Analytics é o app/code/core/Mage/GoogleAnalytics/Block/Ga.php. O método que formata as informações da compra é o _getOrdersTrackingCode. Nele havia uma checagem logo no início que verificar se o array $orderIds existia e não estava vazio. Alterei o retorno desta checagem para:

return '/*'.$orderIds.'*/';

Esta mudança não quebra o site, pois retorna um comentário que será inserido no javascript do Google, não acarretando em efeito colateral, e ainda me permitia visualizar o valor de $orderIds. Como esperado, o resultado foi um singelo:

/**/

O que indicava que $this->getOrderIds() estava retornando um array vazio! Ótimo, agora eu já sabia qual era o problema. Algum progresso. E agora? Bom, recorri ao meu Google-fu e sem muita informação recorri ao que tinha e mandei um:

magento empty getOrderIds

O quarto resultado era do StackOverflow, não preciso dizer que foi meu primeiro click! Deixei até um comentário na resposta salvadora do BrianVPS:

I have fixed the problem. We use a 3rd party extension for checkout and it needed to be updated for 1.5.0.1 compatibility. The dispatcher of the *checkout_onepage_controller_success_action* event needs to send an array of the order ids as well. This wasn’t necessary in 1.4.2.0. I updated the extension and it’s working great now! I hope this helps anyone else with a similar issue.

Maravilha. Plugins que funcionavam no Magento 1.4 e não funcionavam mais no 1.5. Parece ter a ver com o meu problema! O próximo passo então seria achar um dispatcher do evento checkout_onepage_controller_success_action e fazer o que ele faz, de dentro do plugin do Assarisse! Fazendo um grep pelo nome do evento, cheguei no arquivo:

app/code/core/Mage/Checkout/controllers/OnepageController.php

Neste arquivo, o disparo do evento era feito no método successAction:

#... $this->_initLayoutMessages('checkout/session'); Mage::dispatchEvent('checkout_onepage_controller_success_action', array('order_ids' => array($lastOrderId))); $this->renderLayout(); #...

Ok, será que o plugin do Assarisse teria uma método successAction? Grep nele:

$ grep -isrl successAction app/code/community/BrunoAssarisse/PagSeguro/* app/code/community/BrunoAssarisse/PagSeguro/controllers/PayController.php

Voilá! Tamos chegando perto! No método successAction deste arquivo PayController.php há um ‘if’ que verifica se a página de retorno do PagSeguro seria uma página tipo CMS ou não. Caso não seja uma página CMS (o meu caso), ele carrega o layout da página de destino e a apresenta. Inseri meu código no meio dele então:

} else { # esta é a linha 183 do arquivo $this->loadLayout(); # cyberama $session = $this->getCheckout(); $lastOrderId = $session->getLastOrderId(); Mage::dispatchEvent('checkout_onepage_controller_success_action', array('order_ids' => array($lastOrderId))); # /cyberama $this->renderLayout(); }

1. Investigamos o final do processo de compra (Ga.php) e o pedido estava chegando em branco na função que escreve o javascript do Analytics.
2. Procuramos no Google alguma informação sobre ‘getOrderIds‘ vazio
3. Achamos no StackOverflow uma direção: procure por ‘checkout_onepage_controller_success_action‘
4. Alguém mais já ativava este evento, passando um id de compra. Pegamos o código emprestado e
5. Alteramos o plugin do PagSeguro para disparar este evento, passando o id da compra

Ainda existem alguns pontos em aberto, que gostaria de trocar idéia com vocês:

1. Se a pessoa escolhe pagar por boleto, vamos contabilizar a compra no Analytics, sendo que o boleto pode não ter sido pago
2. Se a pessoa escolhe pagar por cartão de crédito, vamos contabilizar a compra no Analytics, porém a compra pode ser declinada pela operadora de cartão
3. Se a pessoa fecha a página do PagSeguro durante a contagem regressiva de 20 segundos, não vamos contabilizar a venda no Analytics

Se vocês acharam soluções para estes cenários, por favor deixem o link nos comentários!