Sprint 3 - FGA-GCES/BotFlow GitHub Wiki

Botflow

SPRINT 3 - (11/03/2021 - 25/03/2021)

Divisão de issues

Número da Issue Descrição Responsáveis
#142 Exported files are invalid Kalebe Lopes
#144 Remove empty balloons when inserting/editing utters Francisco Heronildo
#148 Review README info Lude Ribeiro
#152 Handle API errors on the frontend Miguel Alves
#171 Create Unit tests for backend Amanda Muniz e Letícia Karla Araújo
#12 Support localization Gabriel Filipe Manso
#48 Document API endpoit usage Gabriel Filipe Manso
#168 Create CI (back-end) Gabriel Filipe Manso

Issues Mantidas - Sprint 3

Número da Issue Descrição Motivo de ser mantida Responsável
#152 Handle API errors on the frontend Esta issue se revelou uma surpresa por conta da complexidade e tamanho dos processos requeridos. Ela não se trata somente do trato e apresentação dos erros ao usuário, mas possui tasks que indicam a necessidade de uma reflexão sobre o estado atual de funcionamento do software e quais mudanças poderiam ocorrer para evitar erros. Além disso, indica que outras issues podem ser geradas para implementar tais mudanças. E só então, após isso, devemos tratar e apresentar os erros ao usuário através do front-end da aplicação. Um documento foi gerado contendo todos os erros lançados pela API (que competem ao usuário) e indicando o que os ocasiona (Tabela Anexo1) Miguel Alves e Lude

Dívidas Técnicas - Sprint 2 -> Sprint 3

Número da Issue Descrição Responsáveis
#152 Handle API errors on the frontend Miguel Alves
#170 Create CI (front-end) Gabriel Filipe Manso
#148 Review README info Lude Ribeiro
#142 Exported files are invalid Kalebe Lopes
#144 Remove empty balloons when inserting/editing utters Francisco Heronildo
#171 Create Unit tests for backend Amanda Muniz e Letícia Karla Araújo

Dívidas Técnicas - Sprint 3 -> Sprint 4

Número da Issue Descrição Responsáveis
#48 Document API endpoit usage Gabriel Filipe Manso
#168 (WIP) CI workflow (back-end) Gabriel Filipe Manso
#12 (WIP) Support localization Gabriel Filipe Manso
#142 Exported files are invalid Kalebe Lopes
#144 Remove empty balloons when inserting/editing utters Francisco Heronildo

PRs Abertos - Sprint 3

Número da Issue Descrição Número do PR Responsáveis
#171 Create Unit tests backend #30 Amanda Muniz e Letícia Karla Araújo
#169 FIX Changing Dockerfile to fix django import #26 Amanda Muniz
#149 Remove all LAPPIS and TAIS info from code #25 Gabriel Filipe Manso
#170 CI workflow (front-end) #166 Gabriel Filipe Manso
#168 (WIP) CI workflow (back-end) #27 Gabriel Filipe Manso
#12 (WIP) Support localization #173 Gabriel Filipe Manso
#148 Review README info #172 Lude Ribeiro

Tabela Anexo 1

 

Endpoint

Method

Response Status Code

Error message

Error cause

/intents

GET

200

-

Not an error

404

-

Could not found the object of the request / The page is unvaliable

POST

201

-

Not an error

400

‘Missing keys’

There is a key missing or both of them.

‘name’ or ‘samples’

‘Name should contain no special characters other than underscore’

The user added a invalid character to the ‘name’

‘There should be at least one sample’

There are no valid samples provided

404

-

Could not found the object of the request/ The page is unvaliable

DELETE

204

-

Not an error

404

-

Could not found the object of the request/ The page is unvaliable

PUT

200

-

Not an error

400

‘Missing keys’

There is a key missing or both of them.

‘name’ or ‘samples’

‘Name should contain no special characters other than underscore’

The user added a invalid character to the ‘name’

‘There should be at least one sample’

There are no valid samples provided

404

-

Could not found the object of the request/ The page is unvaliable

 

 

Endpoint

Method

Response Status Code

Error message

Error cause

/utters

GET

200

-

Not an error

404

-

Could not found the object of the request / The page is unvaliable

POST

201

-

Not an error

400

‘Missing keys’

At least one of ‘name’, ‘multiple_alternatives’ or ‘alternatives’ is not provided

‘Name should contain no special characters other than underscore’

The user added a invalid character to the ‘name’

‘Multiple alternatives field should be a boolean’

This error has a strange way to happen. It considers that the ‘multiple_alternatives’ parameter is not a boolean. But, through normal usage of the app, this is not possible. This error helps to protect the app of breaking through bad intentional usage of its endpoints.

‘Invalid alternatives’

No utter content was provided

404

-

Could not found the object of the request / The page is unvaliable

DELETE

204

-

Not an error

404

-

Could not found the object of the request / The page is unvaliable

PUT

200

-

Not an error

400

‘Missing keys’

At least one of ‘name’, ‘multiple_alternatives’ or ‘alternatives’ is not provided

‘Name should contain no special characters other than underscore’

The user added a invalid character to the ‘name’

‘Multiple alternatives field should be a boolean’

This error has a strange way to happen. It considers that the ‘multiple_alternatives’ parameter is not a boolean. But, through normal usage of the app, this is not possible. This error helps to protect the app of breaking through bad intentional usage of its endpoints.

‘Invalid alternatives’

No utter content was provided

404

-

Could not found the object of the request / The page is unvaliable

 

Endpoint

Method

Response Status Code

Error message

Error cause

/stories

GET

200

-

Not an error

404

-

Could not found the object of the request / The page is unvaliable

POST

201

-

Not an error

400

‘Invalid data’

No stories content was provided

‘Invalid content array’

The content provided doesnt have the correct form

404

-

Could not found the object of the request / The page is unvaliable

DELETE

204

-

Not an error

404

-

Could not found the object of the request / The page is unvaliable

PUT

200

-

Not an error

400

‘Invalid data’

No stories content was provided

‘Invalid content array’

The content provided doesnt have the correct form

404

-

Could not found the object of the request / The page is unvaliable

 

⚠️ **GitHub.com Fallback** ⚠️