Feature/async prediction #541

fberanizo · 2021-10-27T13:53:32Z

Adds a new Service "PredictionApi" …
Performs prediction tasks (fetch, create, and interrupt).
Also removes prediction actions that were at DeploymentsApi.js

Adds a new store 'prediction' to handle prediction actions …
These actions are similar to actions at 'testDeployment' store, but
predictions are now async.

Removes unused store 'testDeployment' …
This store was replaced by the new store 'prediction', which performs
similar actions, but asynchronously.

Updates containers to use actions of new store 'prediction' …

Removes occurrences of 'testDeployment' store
Adds a polling that checks for prediction results.

Renames remaining occurrences of 'testDeployment' to 'createPrediction' …
Ensures same descriptions are used across the project.

Performs prediction tasks (fetch, create, and interrupt). Also removes prediction actions that were at DeploymentsApi.js

These actions are similar to actions at 'testDeployment' store, but predictions are now async.

This store was replaced by the new store 'prediction', which performs similar actions, but asynchronously.

- Removes occurrences of 'testDeployment' store - Adds a polling that checks for prediction results.

Ensures same descriptions are used across the project.

github-actions · 2021-10-27T13:54:22Z

Dicas para revisão de código

Commits

Título (1a linha do commit): apresentar resumo do que foi alterado/adicionado/removido.
ex: adiciona action que salva parametros no backend; exibe rótulo no componente de selecao de dataset;
Descrição (outras linhas): dar mais detalhes de cada alteração:
- motivos das alterações
  ex: havia um bug que causava...; nova funcionalidade que faz isso...; código foi movido para...;
- bibliotecas adicionadas e versões (package.json)
  ex: atualiza para antd v4.6;
- testes unitários criados/alterados
  ex: adiciona testes para a action fetchProjectSuccess;
Mensagens auto-explicativas! Quem revisa o código deve entender o que foi feito (e porque foi feito) sem perguntar para quem fez o commit.
Não devem ter conflitos. Solicitar que sejam resolvidas as ocorrências de "This branch has conflicts that must be resolved".

SonarCloud Quality Gate

Coverage > 80.0%, e sempre que possível = 100%
0 Bugs, 0 Code Smells, 0 Vulnerabilities

Build Github actions COM SUCESSO

ReactJS

Usar Node 12 ou 14.
Remover console.log.
Não deixar código-fonte comentado.
Pasta de módulos devem ser escritas em lower case
Pasta de componentes devem ser escritas em camel case
Nunca utilizar spread em retorno de reducer sem alteração
Sempre utilizar hooks ao invés de HOCs
Itens em uma lista devem ser renderizados com uma chave única (preferir uuid)
Comentar apenas códigos que não estão muito claros
Não utilizar comentários para blocos
Action types devem conter @

Redux

As instruções a seguir foram retiradas do Redux Style Guide.

Sempre retorne o newState no reducer. Outros valores irão causar problemas inesperados.
ex: return message.error(error); (ERRADO)
NÃO faça atribuições de valores no state. Crie e retorne um newState.
ex: state.data = action.data; return state; (ERRADO)
No reducer use apenas o state e o action. Não dispare ações ou funções assíncronas.
No state, armazene tipos simples (int, String, ...), Array e plain Object. NÃO armazene function, Promise, class instances.
Evite arrays aninhados no estado. Prefira armazená-los numa "forma normalizada".
Nomeie as actions como "eventos", não como "setters".
ex: SET_TASK_NAME SET_TASK_DESCRIPTION (ERRADO). TASK_DETAILS_EDITED (CORRETO).
Utilize nomes auto-explicativos para as actions. Evite nomes como SET_DATA e UPDATE_DATA.

src/containers/DeploymentTestResultModalContainer/DeploymentTestResultModalContainer.jsx

src/store/prediction/prediction.actions.js

fberanizo · 2021-10-27T16:41:34Z

Não entendi porque o sonar identificou status e 'started' como tipos diferentes :x

src/containers/DeploymentTestResultModalContainer/DeploymentTestResultModalContainer.jsx

src/store/prediction/index.js

src/store/prediction/prediction.actions.js

LuanEdCosta · 2021-10-29T13:34:20Z

@fberanizo Também não entendi aquele erro do sonar, mas pode ser por causa do != antes dele. Em JS geralmente usamos === ou na negação !==.

https://stackoverflow.com/questions/42517721/difference-between-and

It's not the final solution tough. Modal still blocks the access to the 'Interrupt' button. Results should be displayed in a different interface, maybe the logs/message section.

Removes action 'createPredictionWithFile' (it was replaced by 'createPredictionWithDataset'). Removes 'dataset' from payload of 'CREATE_PREDICTION_WITH_DATASET_REQUEST' actionType. Remover selector 'getFile'

Tests, actions, actionTypes, reducer and selectors.

…redictionRequest FETCH_PREDICTION_FAIL: don't set values in the state fetchPredictionRequest: when prediction is still in progress, don't set status/predictionResult.

…is closed) We have to do this because the user may have closed the modal, and there's no other way to reopen it.

sonarqubecloud · 2021-11-06T15:58:43Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

68.4% Coverage
0.0% Duplication

LuanEdCosta

Para mim está OK, mas realmente o modal não parece ser a melhor forma de fazer a funcionalidade de prediction.

Tive algumas ideias para o testar fluxo:

Podemos criar uma visualização abaixo ou acima de monitoramentos
Podemos fazer um outro botão de dropdown ao lado do botão de testar fluxo 🔽
Podemos mostrar em um dropdown de notificações.

fberanizo · 2021-11-11T16:21:45Z

Para mim está OK, mas realmente o modal não parece ser a melhor forma de fazer a funcionalidade de prediction.

Tive algumas ideias para o testar fluxo:

Podemos criar uma visualização abaixo ou acima de monitoramentos

Podemos fazer um outro botão de dropdown ao lado do botão de testar fluxo 🔽

Podemos mostrar em um dropdown de notificações.

@LuanEdCosta acho que faremos com o Dropdown de notificações, sim!
No protótipo tem algumas coisas:

Vou dar merge neste PR e criar uma tarefa pra implementar essas melhorias.

fberanizo added 5 commits October 27, 2021 10:40

Adds a new Service "PredictionApi"

895a111

Performs prediction tasks (fetch, create, and interrupt). Also removes prediction actions that were at DeploymentsApi.js

Adds a new store 'prediction' to handle prediction actions

913b32d

These actions are similar to actions at 'testDeployment' store, but predictions are now async.

Removes unused store 'testDeployment'

c080343

This store was replaced by the new store 'prediction', which performs similar actions, but asynchronously.

Updates containers to use actions of new store 'prediction'

b7d47a0

- Removes occurrences of 'testDeployment' store - Adds a polling that checks for prediction results.

Renames remaining occurrences of 'testDeployment' to 'createPrediction'

208e55f

Ensures same descriptions are used across the project.

fberanizo commented Oct 27, 2021

View reviewed changes

src/containers/DeploymentTestResultModalContainer/DeploymentTestResultModalContainer.jsx Outdated Show resolved Hide resolved

src/store/prediction/prediction.actions.js Outdated Show resolved Hide resolved

LuanEdCosta suggested changes Oct 29, 2021

View reviewed changes

fberanizo added 6 commits November 6, 2021 08:50

Renames prediction.Reducer.js to lowercase 'prediction.reducer.js'

871fb80

Implements part of "Interrupt prediction"

13addbc

It's not the final solution tough. Modal still blocks the access to the 'Interrupt' button. Results should be displayed in a different interface, maybe the logs/message section.

Removes unused actions and payload arguments

c72f0c6

Removes action 'createPredictionWithFile' (it was replaced by 'createPredictionWithDataset'). Removes 'dataset' from payload of 'CREATE_PREDICTION_WITH_DATASET_REQUEST' actionType. Remover selector 'getFile'

Creates unittests for Prediction store

cedfef4

Tests, actions, actionTypes, reducer and selectors.

Adds unittests for actionType FETCH_PREDICTION_FAIL and action fetchP…

f189f5c

…redictionRequest FETCH_PREDICTION_FAIL: don't set values in the state fetchPredictionRequest: when prediction is still in progress, don't set status/predictionResult.

Shows test result modal when prediction results are ready (and modal …

1d1d96e

…is closed) We have to do this because the user may have closed the modal, and there's no other way to reopen it.

fberanizo requested a review from LuanEdCosta November 6, 2021 15:56

LuanEdCosta approved these changes Nov 10, 2021

View reviewed changes

fberanizo merged commit 44490d8 into master Nov 11, 2021

LuanEdCosta deleted the feature/async-prediction branch February 22, 2022 13:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/async prediction #541

Feature/async prediction #541

fberanizo commented Oct 27, 2021

github-actions bot commented Oct 27, 2021

fberanizo commented Oct 27, 2021

LuanEdCosta commented Oct 29, 2021

sonarqubecloud bot commented Nov 6, 2021

LuanEdCosta left a comment

fberanizo commented Nov 11, 2021

Feature/async prediction #541

Feature/async prediction #541

Conversation

fberanizo commented Oct 27, 2021

github-actions bot commented Oct 27, 2021

Dicas para revisão de código

Commits

SonarCloud Quality Gate

Build Github actions COM SUCESSO

ReactJS

Redux

fberanizo commented Oct 27, 2021

LuanEdCosta commented Oct 29, 2021

sonarqubecloud bot commented Nov 6, 2021

LuanEdCosta left a comment

Choose a reason for hiding this comment

fberanizo commented Nov 11, 2021