Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update survey titles and labels for clarity: reflect focus on Copilot impact and time savings #73

Merged
merged 18 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
8dac4c6
Update survey titles and labels for clarity: reflect focus on Copilot…
MattG57 Nov 30, 2024
06fbc6e
added scrolling reasons from colleagues
MattG57 Nov 30, 2024
71497fd
Tweaks
MattG57 Nov 30, 2024
9fbfe6b
Merge branch 'main' into Nomenclature-for-Developer-Estimates-plus-Fo…
austenstone Dec 3, 2024
2e8b1c9
Add recent surveys retrieval with good reasons and kudos feature
MattG57 Dec 3, 2024
3085220
Add GitHub survey update functionality and new survey route
austenstone Dec 3, 2024
04408a3
Add kudos field to Survey model
austenstone Dec 3, 2024
8dc6e25
Refactor backend entry point, update Docker and compose configuration…
MattG57 Dec 3, 2024
1611030
Merge branch 'Nomenclature-for-Developer-Estimates-plus-Form-behavior…
MattG57 Dec 3, 2024
3d5a946
Implement member retrieval by login, enhance recent surveys query, an…
MattG57 Dec 4, 2024
5cbd8cd
Refactor chart labels and settings form, implement thousand separator…
MattG57 Dec 4, 2024
e8a2522
Remove VSCode settings, update logging level in database configuratio…
austenstone Dec 5, 2024
dfdc06e
Add Value Modeling component, update & routing change
MattG57 Dec 5, 2024
338b2f5
Refactor survey component headers, update layout styles, and enhance …
austenstone Dec 6, 2024
4b6d442
Merge branch 'Nomenclature-for-Developer-Estimates-plus-Form-behavior…
austenstone Dec 6, 2024
50fc071
Remove ThousandSeparatorPipe and SharedModule; update settings compon…
austenstone Dec 6, 2024
4e4b5d3
Fix type assertion in survey controller and service for improved type…
austenstone Dec 6, 2024
00e92ca
Refactor type assertions in survey controller and service to use Wher…
austenstone Dec 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "node --enable-source-maps dist/index.js | bunyan -o short -l info",
"test": "jest",
"build": "tsc",
"dev": "tsx watch src/index.ts | bunyan -o short -l debug",
"dev": "tsx watch src/index.ts | bunyan -o short -l info",
"lint": "eslint src/**/*.ts",
"db:start": "docker-compose -f ../compose.yml up -d db",
"dotenv": "cp -n .env.example .env || true"
Expand Down
108 changes: 76 additions & 32 deletions backend/src/controllers/survey.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,17 @@ import app from '../index.js';

class SurveyController {
async createSurvey(req: Request, res: Response): Promise<void> {
let survey: Survey;
try {
const _survey = await surveyService.updateSurvey({
const survey = await surveyService.createSurvey({
...req.body,
status: 'completed'
})
if (!_survey) throw new Error('Survey not found');
survey = _survey;
res.status(201).json(survey);
} catch (error) {
console.log(error);
res.status(500).json(error);
return;
}
try {
const { installation, octokit } = await app.github.getInstallation(survey.org);
const surveyUrl = new URL(`copilot/surveys/${survey.id}`, app.baseUrl);

if (!survey.repo || !survey.org || !survey.prNumber) {
logger.warn('Cannot process survey comment: missing survey data');
return;
}
const comments = await octokit.rest.issues.listComments({
owner: survey.org,
repo: survey.repo,
issue_number: survey.prNumber
});
const comment = comments.data.find(comment => comment.user?.login.startsWith(installation.app_slug));
if (comment) {
octokit.rest.issues.updateComment({
owner: survey.org,
repo: survey.repo,
comment_id: comment.id,
body: `Thanks for filling out the [copilot survey](${surveyUrl.toString()}) @${survey.userId}!`
});
} else {
logger.info(`No comment found for survey from ${survey.org}`);
}
} catch (error) {
logger.error('Error updating survey comment', error);
throw error;
}
}

async getAllSurveys(req: Request, res: Response): Promise<void> {
Expand All @@ -63,6 +33,16 @@ class SurveyController {
}
}

async getRecentSurveysWithGoodReasons(req: Request, res: Response): Promise<void> {
try {
const minReasonLength = parseInt(req.params.minReasonLength, 10) || 20;
const surveys = await surveyService.getRecentSurveysWithGoodReasons(minReasonLength);
res.status(200).json(surveys);
} catch (error) {
res.status(500).json(error);
}
}

async getSurveyById(req: Request, res: Response): Promise<void> {
try {
const { id } = req.params;
Expand Down Expand Up @@ -96,6 +76,70 @@ class SurveyController {
}
}

async updateSurveyGitHub(req: Request, res: Response): Promise<void> {
let survey: Survey;
try {
const _survey = await surveyService.updateSurvey({
...req.body,
status: 'completed'
})
if (!_survey) throw new Error('Survey not found');
survey = _survey;
res.status(201).json(survey);
} catch (error) {
res.status(500).json(error);
return;
}
try {
const { installation, octokit } = await app.github.getInstallation(survey.org);
const surveyUrl = new URL(`copilot/surveys/${survey.id}`, app.baseUrl);

if (!survey.repo || !survey.org || !survey.prNumber) {
logger.warn('Cannot process survey comment: missing survey data');
return;
}
const comments = await octokit.rest.issues.listComments({
owner: survey.org,
repo: survey.repo,
issue_number: survey.prNumber
});
const comment = comments.data.find(comment => comment.user?.login.startsWith(installation.app_slug));
if (comment) {
octokit.rest.issues.updateComment({
owner: survey.org,
repo: survey.repo,
comment_id: comment.id,
body: `Thanks for filling out the [copilot survey](${surveyUrl.toString()}) @${survey.userId}!`
});
} else {
logger.info(`No comment found for survey from ${survey.org}`);
}
} catch (error) {
logger.error('Error updating survey comment', error);
throw error;
}
}

async updateKudos(req: Request, res: Response): Promise<void> {
try {
const { id } = req.params;

const survey = await Survey.findByPk(id);
if (!survey) {
res.status(404).json({ error: 'Survey not found' });
return;
}

survey.kudos = (survey.kudos || 0) + 1;
await survey.save();

res.status(200).json(survey);
} catch (error) {
console.log(error);
res.status(500).json(error);
}
}

async deleteSurvey(req: Request, res: Response): Promise<void> {
try {
const { id } = req.params;
Expand Down
18 changes: 18 additions & 0 deletions backend/src/controllers/teams.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,24 @@ class TeamsController {
res.status(500).json(error);
}
}

async getMemberByLogin(req: Request, res: Response): Promise<void> {
try {
const { login } = req.params;
const member = await Member.findOne({
where: { login },
attributes: ['login', 'name', 'url', 'avatar_url']
});

if (member) {
res.json(member);
} else {
res.status(404).json({ message: 'User not found' });
}
} catch (error) {
res.status(500).json(error);
}
}
}

export default new TeamsController();
2 changes: 1 addition & 1 deletion backend/src/database.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class Database {
sequelize?: Sequelize;
options: Options = {
dialect: 'mysql',
logging: (sql) => logger.debug(sql),
logging: (sql) => logger.error(sql),
timezone: '+00:00', // Force UTC timezone
dialectOptions: {
timezone: '+00:00' // Force UTC for MySQL connection
Expand Down
8 changes: 8 additions & 0 deletions backend/src/models/survey.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ type SurveyType = {
percentTimeSaved: number;
timeUsedFor: string;
reason: string;
kudos?: number; // Add kudos property
createdAt?: Date;
kudos: number;
updatedAt?: Date;
}

Expand All @@ -28,8 +30,10 @@ class Survey extends Model<SurveyType> {
declare percentTimeSaved: number;
declare timeUsedFor: string;
declare reason: string;
declare kudos: number;
declare createdAt: CreationOptional<Date>;
declare updatedAt: CreationOptional<Date>;
declare kudos?: number; // Add kudos property

static initModel(sequelize: Sequelize) {
Survey.init({
Expand Down Expand Up @@ -81,6 +85,10 @@ class Survey extends Model<SurveyType> {
type: DataTypes.INTEGER,
allowNull: true,
},
kudos: {
type: DataTypes.INTEGER,
allowNull: true
},
createdAt: DataTypes.DATE,
updatedAt: DataTypes.DATE
}, {
Expand Down
6 changes: 5 additions & 1 deletion backend/src/routes/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@ router.get('/', (req: Request, res: Response) => {
router.get('/survey', surveyController.getAllSurveys);
router.post('/survey', surveyController.createSurvey);
router.get('/survey/:id', surveyController.getSurveyById);
router.put('/survey/:id', surveyController.updateSurvey);
router.put('/survey/:id', surveyController.updateSurvey); // put github survey logic here
router.delete('/survey/:id', surveyController.deleteSurvey);
router.get('/survey/recent-good-reasons/:minReasonLength', surveyController.getRecentSurveysWithGoodReasons);
router.put('/survey/:id/github', surveyController.updateSurveyGitHub);
router.put('/survey/kudos/:id', surveyController.updateKudos);

router.get('/usage', usageController.getUsage);

Expand All @@ -32,6 +35,7 @@ router.get('/seats/:id', SeatsController.getSeat);

router.get('/teams', teamsController.getAllTeams);
router.get('/members', teamsController.getAllMembers);
router.get('/members/:login', teamsController.getMemberByLogin);

router.get('/settings', settingsController.getAllSettings);
router.post('/settings', settingsController.createSettings);
Expand Down
18 changes: 18 additions & 0 deletions backend/src/services/survey.service.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Survey, SurveyType } from "../models/survey.model.js";
import { Op } from 'sequelize';

class SurveyService {
async createSurvey(survey: SurveyType) {
Expand All @@ -11,6 +12,23 @@ class SurveyService {
});
return await Survey.findByPk(survey.id);
}


async getRecentSurveysWithGoodReasons(minReasonLength: number): Promise<Survey[]> {
return Survey.findAll({
where: {
reason: {
[Op.and]: [
{ [Op.ne]: null },
{ [Op.ne]: '' },
{ [Op.gte]: minReasonLength }
]
}
},
order: [['updatedAt', 'DESC']],
limit: 20
});
}
}

export default new SurveyService();
1 change: 1 addition & 0 deletions frontend/src/app/app.routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export const routes: Routes = [
{ path: 'copilot/seats', component: CopilotSeatsComponent, title: 'Seats' },
{ path: 'copilot/seats/:id', component: CopilotSeatComponent, title: 'Seat' },
{ path: 'copilot/surveys', component: CopilotSurveysComponent, title: 'Surveys' },
{ path: 'copilot/surveys/new', component: NewCopilotSurveyComponent, title: 'New Survey' },
{ path: 'copilot/surveys/new/:id', component: NewCopilotSurveyComponent, title: 'New Survey' },
{ path: 'copilot/surveys/:id', component: CopilotSurveyComponent, title: 'Survey' },
{ path: 'copilot/predictive-modeling', component: PredictiveModelingComponent, title: 'Predictive Modeling' },
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="page-container" *ngIf="survey">
<div class="page-header">
<h1>Survey #{{ survey.id }}</h1>
<h1>Estimate of Copilot Impact #{{ survey.id }}</h1>
</div>
<mat-card appearance="outlined">
<mat-card-header>
Expand All @@ -17,7 +17,7 @@ <h1>Survey #{{ survey.id }}</h1>
<ng-container *ngIf="survey.status !== 'pending'">
<p><strong>Used Copilot: </strong>{{ survey.usedCopilot ? 'Yes' : 'No' }}</p>
<p><strong>Time Saved: </strong>{{ survey.percentTimeSaved }}%</p>
<p><strong>Reason: </strong>{{ survey.reason }}</p>
<p><strong>Reason: </strong><span matLine>{{ survey.reason }}</span></p>
<p><strong>Time Used For: </strong>{{ survey.timeUsedFor }}</p>
</ng-container>
<p><strong>PR: </strong><a [href]="'https://github.com/' + survey.org + '/' + survey.repo + '/pull/' + survey.prNumber">{{ survey.repo }}#{{ survey.prNumber }}</a></p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<div class="page-container">
<div class="page-header">
<h1>Surveys</h1>
<h1>Estimate Time Saved and Share Expertise</h1>
<span class="spacer"></span>
<!-- <p>
<p>
<a mat-flat-button color="primary" routerLink="/copilot/surveys/new">New Survey</a>
</p> -->
</p>
</div>
<app-table [data]="surveys!" [columns]="surveysColumns" [defaultSort]="{id: 'dateTime', start: 'desc', disableClear: false}" (rowClick)="onSurveyClick($event)"></app-table>
</div>
Loading
Loading