Como iniciadores e revisores realizam uma revisão de código - DataWorks: Central de Documentação do Alibaba Cloud

A revisão de código é um processo manual para otimizar o código de produção, melhorar a qualidade do código das tarefas de agendamento de produção e garantir que o código no ambiente de produção atenda aos padrões exigidos. É possível exigir uma revisão de código antes da implantação das tarefas no ambiente de produção. Se a revisão obrigatória de código estiver ativada, apenas as tarefas aprovadas na revisão poderão ser implantadas no ambiente de produção.

Visão geral

No DataWorks, ative a revisão obrigatória de código para evitar falhas em tarefas causadas por código não compatível e prevenir o desperdício de recursos de computação. Quando esse recurso está ativado, os revisores devem verificar rigorosamente a qualidade do código das tarefas, impedindo a implantação de códigos com erros sem aprovação.

Revisão obrigatória desativada: Ao enviar um nó, ainda é possível iniciar manualmente uma revisão. No entanto, o nó pode ser implantado independentemente do resultado da revisão.
Revisão obrigatória ativada: Ao enviar um nó, selecione um revisor qualificado para revisar o código.
- Se a revisão for aprovada, o nó prossegue com o envio e a implantação.
- Se a revisão não for aprovada, o nó não poderá ser enviado ou implantado. Modifique o código com base nos comentários da revisão e inicie uma nova revisão. O nó só poderá ser implantado após a aprovação da nova revisão.

Além disso, ao processar um ticket de revisão, o revisor pode usar IA para analisar inteligentemente as alterações de código e obter rapidamente uma sugestão de conclusão da revisão, um resumo das alterações e uma lista de problemas para auxiliar na tomada de decisão manual. A IA fornece apenas sugestões; o revisor toma a decisão final sobre a aprovação.

Limitações

O recurso de revisão de código está disponível apenas no DataWorks Professional Edition e versões posteriores. Certifique-se de ter ativado o DataWorks Professional Edition ou uma versão posterior. Para obter mais informações sobre os recursos das diferentes edições, consulte Edições do DataWorks.
Somente uma conta Alibaba Cloud, um Workspace Administrator ou um usuário RAM com a permissão AliyunDataWorksFullAccess pode ativar ou desativar a revisão de código para um workspace. Para obter mais informações, consulte Usuários, funções e permissões.
Não é possível iniciar uma revisão de código para tipos especiais de nós, como nós compostos (do-while e for-each), ou para arquivos de resource que não sejam Python.

(Opcional) Administrador: Ativar revisão obrigatória de código

Um administrador de workspace pode ativar a revisão obrigatória de código para um workspace na página de configurações do Data Studio seguindo as etapas abaixo.

Nota

Se a revisão obrigatória de código estiver desativada, ainda é possível iniciar uma revisão, mas ela não bloqueará o processo de implantação.
A exclusão de um nó não aciona uma revisão de código no momento do envio.

Acessar Security Settings and Others

Acesse a página Workspaces no console do DataWorks. Na barra de navegação superior, selecione a região desejada. Encontre o workspace desejado e escolha Shortcuts > Data Studio na coluna Actions.
Acesse a página de configurações do Data Studio.
1. No canto inferior esquerdo, clique em e selecione Data Studio Settings para abrir a página de configurações do Data Studio.
2. Navegue até Security Settings and Others.
  
  Na página de configurações do Data Studio, alterne para a aba Security Settings and Others.

Ativar revisão de código

Na aba Security Settings and Others, ative Code Review > Mandatory Review.

Importante

Se a opção Mandatory Review não estiver visível na aba Security Settings and Others, verifique sua edição do DataWorks. O recurso de revisão de código está disponível apenas no DataWorks Professional Edition e versões posteriores.

Parâmetro	Descrição
Mandatory Review	Defina se uma revisão de código é necessária antes da implantação das tarefas do workspace atual no ambiente de produção.
Project Code Reviewer	Personalize os revisores de código. Any Developer Role: Após o início de uma revisão de código para um nó, qualquer usuário com função de desenvolvedor no workspace pode ser selecionado para revisar o código. O revisor específico é determinado pela pessoa que implanta o nó. Specify development role users: Após o início de uma revisão de código para um nó, o nó só poderá ser enviado e implantado depois que os usuários especificados com funções de desenvolvedor aprovarem a revisão. Nota Apenas usuários com função de desenvolvedor no workspace atual podem ser selecionados como revisores. O DataWorks permite configurar um ou mais revisores de código. Quando vários revisores são configurados, a revisão é aprovada desde que um deles a aprove.
Specify Mandatory Code Review Baseline Scope	Especifica quais nós exigem revisão de código no momento do envio. Determine quais nós exigem revisão obrigatória de código com base na prioridade da baseline à qual os nós pertencem. A lógica é a seguinte: Quando o escopo de revisão de baseline está definido para tarefas sem baseline, as tarefas recém-criadas no workspace atual exigem aprovação. Quando o escopo de revisão de baseline está definido para tarefas de baseline de um nível específico, os nós nas baselines desse nível no workspace atual exigem aprovação no momento do envio. Um valor numérico maior de uma tarefa de baseline indica uma prioridade mais alta. Tarefas de baseline têm prioridade maior do que tarefas sem baseline. Nota Ao selecionar tarefas sem baseline, todos os nós recém-criados no workspace exigirão aprovação.
Code Review Notification Method	Após ativar a revisão obrigatória, configure mecanismos de notificação detalhados para garantir a entrega automática de informações importantes às pessoas relevantes: Para revisores: Quando uma nova tarefa de revisão é atribuída, o sistema envia automaticamente uma notificação para lembrar o revisor de tratá-la prontamente. Para remetentes: Quando o status da revisão das alterações de código muda (como aprovado ou rejeitado), o remetente recebe uma notificação de atualização de status em tempo real. Os seguintes métodos de notificação são suportados: SMS, DingTalk Group Robot Webhook, Mail, WeChat Group Webhook, Lark Webhook e Standard Webhook. Mensagens SMS de alerta e chamadas telefônicas geradas pela revisão de código contam para o uso de recursos de alerta. Visualize o uso de recursos de alerta do módulo de revisão de código na página Alert Resource no console de gerenciamento. Para obter mais informações, consulte Visualizar uso de recursos de alerta. Nota Standard Webhook está disponível apenas no DataWorks Enterprise Edition. A configuração de segurança de um robô de grupo do DingTalk suporta apenas verificação baseada em palavras-chave, e a palavra-chave deve conter `DataWorks`.

Iniciador da revisão: Iniciar uma revisão de código

Uma revisão de código é acionada quando você envia um nó. Após selecionar um revisor, um ticket de revisão é gerado. Se o administrador tiver ativado a revisão obrigatória de código, o processo de implantação será bloqueado na etapa de verificação de produção. O nó só poderá ser implantado no ambiente de produção após a aprovação da revisão de código.

Nota

Se um nó já tiver uma revisão de código em andamento e uma nova revisão for iniciada, o resultado da revisão anterior será invalidado automaticamente.
A exclusão de um nó não aciona uma revisão de código.

Implante a tarefa.
1. Clique em para salvar o nó de desenvolvimento de dados que deseja implantar e, em seguida, clique em para acessar a página Online publishing content.
2. Clique em Start Release Production para iniciar a implantação. Como a revisão obrigatória de código está ativada, o processo de implantação é bloqueado na etapa de verificação de produção. O nó só poderá ser implantado após a aprovação da revisão de código.

Inicie uma revisão de código.

Clique em Initiate Code Review. Na página de configuração de Code Review, configure Code Reviewer e Description of change.

Item de configuração	Descrição
Code Reviewer	Selecione o Project Code Reviewer configurado neste controle. Especifique um ou mais revisores de código.
Description of change	Descreva as alterações no código e outras informações relevantes.

Após concluir a configuração, clique em Confirm para enviar a revisão de código.

Revisor: Processar um ticket de revisão

Um revisor de código pode visualizar registros de revisão pendentes e processar tickets de revisão no menu Code Review List > Reviewed by Me.

Acesse a página de revisão de código.

Clique em no painel de navegação à esquerda da página do Data Studio para acessar a página Code Review List > Reviewed by Me, onde é possível visualizar os tickets de revisão de código atribuídos a você.
Processe um ticket de revisão de código.

Na página Code Review List > Reviewed by Me, visualize os detalhes das revisões de código e execute operações nos tickets de revisão.
- Na página da lista de revisão de código: Execute rapidamente as seguintes operações nos tickets de revisão: By, Reject, Abandoned, Reopen e Share.
- Na página de detalhes da revisão de código:
  1. Na página Code Review List > Reviewed by Me, clique em ticket de revisão de código que deseja revisar para acessar a página Code Review Details. Nesta página, visualize as alterações no código e nas configurações de agendamento em comparação com a versão de produção e decida se aprova a revisão de código.
  2. Na seção de operações de revisão, o revisor pode executar as seguintes operações de revisão no ticket:
    - : Aprovar.
    - : Rejeitar.
    - : Abandonar.
    - : Reabrir.
    - Comments.
  Nota
  - Abandoned: Abandona o processo de revisão atual. Após o abandono da revisão, a versão atual do nó pode ser enviada e implantada diretamente.
  - Reopen: Se desejar revisar novamente um processo de revisão abandonado, clique em Reopen.
  Após a conclusão da revisão de código, o iniciador da revisão pode visualizar os detalhes da revisão e gerenciar tickets de revisão na página Code Review List > Reviewed by Me.

Revisão inteligente por IA

Um revisor pode usar IA para analisar inteligentemente as alterações atuais de código e obter rapidamente uma sugestão de conclusão da revisão, um resumo das alterações e uma lista de problemas para auxiliar na tomada de decisão manual. A IA fornece apenas sugestões de revisão; o revisor toma a decisão final sobre a aprovação.

Gere uma sugestão de revisão por IA.

Na seção de operações de revisão, clique em ícone de revisão inteligente ao lado de Comment. A IA começa a analisar as alterações atuais de código. Após a conclusão da análise, o painel Generated Result é exibido.
Visualize o resultado gerado.

O painel Generated Result contém as seguintes informações:
- Sugestão de conclusão da revisão: A IA fornece uma sugestão de Recommend approval ou Recommend rejection.
- Resumo das alterações: Resume as principais alterações no código e nas configurações de agendamento.
Processe o resultado gerado.
- Accept: Adota a sugestão da IA. O comentário da revisão é preenchido automaticamente na caixa de comentários e a conclusão da revisão por IA é sincronizada. Envie a revisão após confirmação.
- Regenerate: Se não estiver satisfeito com o resultado, solicite que a IA reanalise as alterações e gere uma nova sugestão de revisão.
- Reject: Não adota a sugestão da IA. O painel é recolhido e a revisão prossegue manualmente.

Iniciador da revisão: Visualizar resultados da revisão

O iniciador da revisão pode visualizar os resultados da revisão e gerenciar tickets de revisão no menu Code Review List > Reviewed by Me > Created by Me.

Acesse a página de revisão de código.

Clique em no painel de navegação à esquerda da página do Data Studio para acessar a página de revisão de código, onde é possível visualizar os tickets de revisão de código Created by Me.
Confirme os resultados da revisão.

Na página Code Review List > Reviewed by Me > Created by Me, visualize os detalhes das revisões de código e execute operações nos tickets de revisão.
- Na página da lista de revisão de código: O iniciador da revisão pode visualizar rapidamente os resultados da revisão e executar as seguintes operações: Abandoned, Reopen ou Share.
  
  Nota
  Abandona o processo de revisão atual. Após o abandono da revisão, a versão atual do nó deve ser enviada para revisão novamente ou o ticket de revisão deve ser reaberto antes que o processo de implantação possa continuar.
- Na página de detalhes da revisão de código: Na página Code Review List > Reviewed by Me, clique em ticket de revisão de código correspondente para acessar a página Code Review Details, onde é possível decidir se deseja Reopen ou marcar como Abandoned a revisão de código.
Se a revisão não for aprovada, o nó não poderá ser enviado ou implantado. Modifique o código com base nos comentários da revisão e inicie uma nova revisão. O nó só poderá ser implantado após a aprovação da nova revisão.

Próxima etapa

Após a aprovação da revisão de código, prossiga com o processo de implantação. Se a revisão de código não for aprovada, ajuste o código com base nos comentários da revisão e inicie uma nova revisão de código.