Metas feature by BrunoMog · Pull Request #26 · pauloborba/teaching-assistant-react

BrunoMog · 2025-12-09T15:18:56Z

Pull Request - Teaching Assistant

📝 Descrição

O que foi feito:
Implementação completa da funcionalidade de Criação e Manutenção de Metas de Avaliação por turma.

Frontend: Criação de modal e interface para adicionar metas na tela de Turmas. Melhorias de acessibilidade nos botões de fechar modais.
Backend: Refatoração profunda do modelo Class e Classes para encapsular a lógica de metas, validação e persistência, removendo lógica de negócio do controlador (server.ts).
Testes: Adição de cenários de teste E2E (Cucumber) cobrindo tanto a interface gráfica (GUI) quanto a API (Server).

Por que foi feito:
Para permitir que cada turma tenha seus próprios critérios de avaliação (metas) de forma independente, flexibilizando o sistema que antes não suportava essa personalização. Além disso, a refatoração foi necessária para garantir a integridade dos dados (evitando o uso de any e garantindo o estado de "bloqueio" das metas após a criação).

📌 Observações

Impacto:

🟢 Baixo - Mudança isolada, sem efeitos colaterais
🟡 Médio - Afeta algumas funcionalidades (Modelo de Turmas e Persistência)
🔴 Alto - Mudanças críticas ou estruturais

Riscos identificados:

Compatibilidade com turmas antigas salvas no JSON (tratado no método fromJSON com lógica de fallback).

📦 Área afetada

Frontend (Client - React):

🖥️ Componentes React (Classes.tsx)
🔌 Services/API
📝 Types/Interfaces TypeScript
🎨 Estilos e UI

Backend (Server - Express/Node.js):

🔌 API Routes/Endpoints
📊 Models e lógica de negócio (Class.ts, Classes.ts)
💾 Persistência de dados

Funcionalidades:

Infraestrutura:

🔧 Configurações (cucumber.js, tsconfig.test.json)
📦 Dependências (package.json)
🚀 Scripts de build/deploy
📝 Documentação (README, guias)

🔧 Tipo de mudança

🐛 Correção de bug (fix)
✨ Nova funcionalidade (feature)
♻️ Refatoração de código (Encapsulamento em Class.ts e remoção de any)
📚 Atualização de documentação
✅ Adição/atualização de testes
🎨 Melhorias de UI/UX (Acessibilidade em modais)
🔒 Correção de segurança
⚡ Melhoria de performance

🧪 Testes

Testes automatizados

Por nível de teste:

🔬 Testes Unitários (Jest) - Classes e funções isoladas
- Validada lógica de construtores e serialização JSON em Class.ts
🔗 Testes de Integração - Interação entre componentes/serviços
🎯 Testes End-to-End (Cucumber) - Fluxos completos da aplicação
- Cenários de GUI e Server implementados e passando
🌐 Testes de Sistema - Ambiente completo de produção

Por área testada:

🖥️ Testes de GUI (interface do usuário)
📊 Testes de Classes/Models (lógica de negócio)
🔌 Testes de Services/API (comunicação e endpoints)

Cobertura:

Cobertura de testes mantida/aumentada
Casos de erro e edge cases cobertos (Metas duplicadas, vazias, bloqueio de edição)

Como revisar e testar

Testes Unitários (Server):

cd server
npm install
npm test

Testes E2E (Client):

cd client
npm install
npm start                   # Terminal 1: iniciar app
npm run test:cucumber       # Terminal 2: executar testes

Testar manualmente:

Servidor: http://localhost:3000
Cliente: http://localhost:3004

📸 Screenshots/GIFs

✅ Checklist

Código segue os padrões do projeto
Realizei self-review do código
Comentei código em áreas complexas
Atualizei a documentação (se necessário)
Mudanças não geram warnings
Adicionei testes que provam que a correção/feature funciona
Testes novos e existentes passam localmente
Mudanças dependentes foram merged e publicadas

🔗 Issues relacionadas

Closes #
Relacionado a #

…s nas features

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

eu sem querer fiz as ultimas alterações na main ao invés da branch da feature

Copilot

Pull request overview

This PR implements a complete feature for creating and managing class-specific assessment goals (metas) within the Teaching Assistant system. The implementation includes:

Frontend: Added a modal interface in the Classes component for adding and managing metas, with improved accessibility for modal close buttons
Backend: Significant refactoring of the Class and Classes models to encapsulate metas logic, validation, and persistence, removing business logic from the controller
Testing: Comprehensive E2E test coverage using Cucumber for both GUI and API interactions

Reviewed changes

Copilot reviewed 19 out of 21 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
server/src/server.ts	Added new API endpoints (GET/POST) for managing class metas and updated class creation/loading to support metas
server/src/models/Classes.ts	Added methods for retrieving and adding metas to classes
server/src/models/Class.ts	Major refactoring: added metas properties, validation logic, locking mechanism, and updated serialization
server/data/app-data.json	Updated test data with metas fields and simplified enrollment data
client/src/types/Class.ts	Added metas and metasLocked properties to Class interface
client/src/step-definitions/student-steps.ts	Refactored to use shared setup scope for browser/page management
client/src/step-definitions/setup.ts	New shared setup file for Cucumber test configuration
client/src/step-definitions/server-student-steps.ts	Commented out duplicate timeout setting
client/src/step-definitions/server-criacao-metas.steps.ts	New E2E tests for server-side metas API
client/src/step-definitions/criacao-metas.steps.ts	New E2E tests for GUI-based metas management
client/src/services/ClassService.ts	Added setMetas method and updated type usage
client/src/features/server-criacao-metas.feature	Feature file defining server-side metas scenarios
client/src/features/criacao-metas.feature	Feature file defining GUI metas scenarios
client/src/components/Evaluations.tsx	Updated to use class-specific metas instead of hardcoded goals
client/src/components/Classes.tsx	Added metas modal UI and management logic
client/src/App.tsx	Added success message state and handler
client/src/App.css	Added styles for metas UI components and success messages
client/package.json	Updated Cucumber version and added type definitions
client/cucumber.js	Added TS_NODE_PROJECT environment variable

Files not reviewed (1)

client/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

server/src/models/Classes.ts

server/src/models/Class.ts

Copilot · 2025-12-09T15:27:25Z

server/src/models/Class.ts

+    const isLocked = data.metasLocked !== undefined 
+      ? data.metasLocked 
+      : (data.metas && data.metas.length > 0);


The fallback logic (data.metas && data.metas.length > 0) for determining lock status could lead to incorrect behavior. If metasLocked is explicitly set to false but metas exist, this fallback won't be used. Consider using data.metasLocked ?? (data.metas && data.metas.length > 0) to only apply the fallback when the property is actually undefined.

Suggested change

const isLocked = data.metasLocked !== undefined

? data.metasLocked

: (data.metas && data.metas.length > 0);

const isLocked = data.metasLocked ?? (data.metas && data.metas.length > 0);

Copilot · 2025-12-09T15:27:25Z

server/data/app-data.json

+        "Requisitos",
+        "Testes de software"
+      ],
+      "metasLocked": false,


The test data shows metasLocked: false when metas exist (lines 29-32). This contradicts the business logic in Class.ts where setMetas automatically sets metasLocked to true. Test data should reflect the actual system behavior.

Suggested change

"metasLocked": false,

"metasLocked": true,

Copilot · 2025-12-09T15:27:26Z

client/src/step-definitions/criacao-metas.steps.ts

+    await scope.page.waitForSelector(SELECTORS.metaInput, { timeout: 1500 });
+    await scope.page.click(SELECTORS.metaInput, { clickCount: 3 });
+    await scope.page.focus(SELECTORS.metaInput);
+    await scope.page.keyboard.down('Control'); await scope.page.keyboard.press('A'); await scope.page.keyboard.up('Control');


The keyboard combination for text selection is hard-coded for Control+A, which won't work on macOS where Command+A is used. Consider using a cross-platform approach or detecting the operating system.

Suggested change

await scope.page.keyboard.down('Control'); await scope.page.keyboard.press('A'); await scope.page.keyboard.up('Control');

if (process.platform === 'darwin') {

await scope.page.keyboard.down('Meta'); await scope.page.keyboard.press('A'); await scope.page.keyboard.up('Meta');

} else {

await scope.page.keyboard.down('Control'); await scope.page.keyboard.press('A'); await scope.page.keyboard.up('Control');

}

Copilot · 2025-12-09T15:27:26Z

client/src/components/Classes.tsx

+      const data = await ClassService.setMetas(classObj.id, localMetas);
+
+      // Show server message if provided
+      const serverMessage = data && (data.message || data.msg) ? (data.message || data.msg) : 'Metas criadas com sucesso!';


The fallback message is in Portuguese while many other parts of the UI are in English (e.g., 'Close', 'Edit', 'Delete'). Consider using consistent language throughout the application or providing internationalization support.

Suggested change

const serverMessage = data && (data.message || data.msg) ? (data.message || data.msg) : 'Metas criadas com sucesso!';

const serverMessage = data && (data.message || data.msg) ? (data.message || data.msg) : 'Goals created successfully!';

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

eu nao fiz as alteracoes na branch necessaria

Bruno Antonio dos Santos Bezerra and others added 12 commits November 17, 2025 08:43

implementação de metas em class

2c573f2

implementação das rotas de metas

a458307

Merge branch 'main' into metas_feature

b77338b

criação da feature metas no servidor, e adicionar os cenários de meta…

bb8f92d

…s nas features

implementação da features metas no cliente

ab1dead

primeiro teste de gui implementado

b8e4d27

implementação dos testes de gui

a219f3b

implementação dos testes de server, e refatoração

80fb97d

comitando as alterações no servidor

bcc39da

Update server/src/models/Classes.ts

ff2bc28

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

alterações sugeridas no pr pelo copilot

5f8c5a8

Merge branch 'main' into metas_feature

e7d4e88

eu sem querer fiz as ultimas alterações na main ao invés da branch da feature

Copilot AI review requested due to automatic review settings December 9, 2025 15:18

Copilot started reviewing on behalf of BrunoMog December 9, 2025 15:19 View session

Copilot AI reviewed Dec 9, 2025

View reviewed changes

BrunoMog and others added 3 commits December 10, 2025 06:09

Update server/src/models/Classes.ts

7a9ec75

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

testes unitários de metas

04513f0

Merge branch 'main' into metas_feature

503a4c2

eu nao fiz as alteracoes na branch necessaria

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Metas feature#26

Metas feature#26
BrunoMog wants to merge 15 commits intopauloborba:mainfrom
BrunoMog:metas_feature

BrunoMog commented Dec 9, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

-    await scope.page.keyboard.down('Control'); await scope.page.keyboard.press('A'); await scope.page.keyboard.up('Control');
+    if (process.platform === 'darwin') {
+      await scope.page.keyboard.down('Meta'); await scope.page.keyboard.press('A'); await scope.page.keyboard.up('Meta');
+    } else {
+      await scope.page.keyboard.down('Control'); await scope.page.keyboard.press('A'); await scope.page.keyboard.up('Control');
+    }

	const serverMessage = data && (data.message \|\| data.msg) ? (data.message \|\| data.msg) : 'Metas criadas com sucesso!';
	const serverMessage = data && (data.message \|\| data.msg) ? (data.message \|\| data.msg) : 'Goals created successfully!';

Conversation

BrunoMog commented Dec 9, 2025

Pull Request - Teaching Assistant

📝 Descrição

📌 Observações

Impacto:

Riscos identificados:

📦 Área afetada

Frontend (Client - React):

Backend (Server - Express/Node.js):

Funcionalidades:

Infraestrutura:

🔧 Tipo de mudança

🧪 Testes

Testes automatizados

Por nível de teste:

Por área testada:

Cobertura:

Como revisar e testar

📸 Screenshots/GIFs

✅ Checklist

🔗 Issues relacionadas

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant