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.

Sign up for GitHub

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

Final changes #275

Merged
merged 3 commits into from
Nov 27, 2024
Merged

Final changes #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c99de53
fix: redis config + AI review scanning
AryanK1511 Nov 26, 2024
3f3007f
chore: remove additional seed funcs
AryanK1511 Nov 27, 2024
abf8279
fix: seeding, using the host machine for redis, updating course summa…
AryanK1511 Nov 27, 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
257 changes: 143 additions & 114 deletions app/api/reviews/courses/[courseCode]/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,16 @@ import ProfessorCourse from '@/database/models/ProfessorCourse';
import Professor from '@/database/models/Professor';
import Question from '@/database/models/Question';
import Course from '@/database/models/Course';
import Policy from '@/database/models/Policy';
import { logger } from '@/utils';
import CourseTerm from '@/database/models/CourseTerm';
import { calculateAverageRating, processReviews, getFirstTenComments } from '@/utils/funcs';
import ReviewPolicyViolationLog from '@/database/models/ReviewPolicyViolationLog';
import {
calculateAverageRating,
processReviews,
getFirstTenComments,
getReviewResponses,
} from '@/utils/funcs';
// @ts-ignore
import redisClient from '@/database/redisInstance';
import { ReviewEvaluator } from '@/utils/ai';
Expand Down Expand Up @@ -48,91 +55,84 @@ export const GET = async function fetch_reviews_by_course_code(
let reviews: any[] = [];
let tags: string[] = [];

if (cachedData) {
const cachedReviews = JSON.parse(cachedData);
reviews = cachedReviews.reviews;
tags = cachedReviews.tags;
} else {
reviews = await Review.findAll({
where: {
review_type_id: 1,
review_status_id: 2,
reviews = await Review.findAll({
where: {
review_type_id: 1,
review_status_id: 2,
},
include: [
{
model: User,
attributes: ['user_id', 'full_name', 'email'],
},
include: [
{
model: User,
attributes: ['user_id', 'full_name', 'email'],
},
{
model: ReviewQuestion,
include: [
{
model: ReviewAnswer,
attributes: ['answer'],
},
{
model: Question,
attributes: ['question_id', 'question_text', 'is_rating'],
},
],
attributes: ['review_question_id'],
},
{
model: ProfessorCourse,
required: true,
attributes: ['professor_course_id'],
include: [
{
model: Professor,
as: 'Professor',
attributes: ['first_name', 'last_name'],
},
{
model: Course,
where: { course_code: courseCode },
include: [
{
model: CourseTerm,
where:
Object.keys(courseTermConditions).length > 0
? courseTermConditions
: undefined,
},
],
attributes: ['course_code', 'course_section'],
},
],
},
],
});
{
model: ReviewQuestion,
include: [
{
model: ReviewAnswer,
attributes: ['answer'],
},
{
model: Question,
attributes: ['question_id', 'question_text', 'is_rating'],
},
],
attributes: ['review_question_id'],
},
{
model: ProfessorCourse,
required: true,
attributes: ['professor_course_id'],
include: [
{
model: Professor,
as: 'Professor',
attributes: ['first_name', 'last_name'],
},
{
model: Course,
where: { course_code: courseCode },
include: [
{
model: CourseTerm,
where:
Object.keys(courseTermConditions).length > 0 ? courseTermConditions : undefined,
},
],
attributes: ['course_code', 'course_section'],
},
],
},
],
});

const processedReviews = processReviews(reviews);
const processedReviews = processReviews(reviews);

if (cachedData) {
const cachedDataJson = JSON.parse(cachedData);
tags = cachedDataJson.tags;
} else {
const reviewEvaluator = new ReviewEvaluator();

if (reviews.length > 0) {
const tagResponse: { tags: string[] } = await reviewEvaluator.generateTags(
getFirstTenComments(processedReviews.reviews)
);
const tags = tagResponse.tags.length > 5 ? tagResponse.tags.slice(0, 5) : tagResponse.tags;

tags = tagResponse.tags.length > 5 ? tagResponse.tags.slice(0, 5) : tagResponse.tags;

// @ts-ignore
await redisClient.set(
// Set the key-value pair of the review
// - key: its course code and term
// - value: reviews + tags
`reviews:${courseCode}:${season}:${year}`,
JSON.stringify({ reviews: processedReviews, tags })
);
await redisClient.set(`reviews:${courseCode}:${season}:${year}`, JSON.stringify({ tags }));
}
}

console.log(reviews);

log.info('Reviews and tags fetched successfully');
return NextResponse.json(createSuccessResponse({ reviewContent: reviews, tags }), {
return NextResponse.json(createSuccessResponse({ reviewContent: processedReviews, tags }), {
status: 200,
});
} catch (error) {
console.error(error);
log.error('Error fetching reviews', { error });
return NextResponse.json(
createErrorResponse(500, 'Something went wrong. A server-side issue occurred.'),
Expand Down Expand Up @@ -164,26 +164,37 @@ export const POST = async function post_course_review(req: NextRequest): Promise
});
}

log.error(
{
courseReviewData,
},
'Received course review data'
);

const professorId = parseInt(courseReviewData.professorId);
const courseCode = courseReviewData.courseName;
const [season, year] = courseReviewData.term.split(' ');

if (!professorId) {
return NextResponse.json(createErrorResponse(400, 'Professor not provided'), {
status: 400,
});
}

if (!courseCode) {
return NextResponse.json(createErrorResponse(400, 'Course code not provided'), {
status: 400,
});
}

//const reviewEvaluator = new ReviewEvaluator();
if (!season) {
return NextResponse.json(createErrorResponse(400, 'Season not provided'), {
status: 400,
});
}

if (!year) {
return NextResponse.json(createErrorResponse(400, 'Year not provided'), {
status: 400,
});
}

// Create a placeholder that stores the review created so that it can be reused later in the AI scanning part
let postedReviewData: any = null;

// Start a transaction to ensure all operations succeed or fail together
const postTransaction = await sequelizeInstance.transaction();

try {
Expand All @@ -194,30 +205,6 @@ export const POST = async function post_course_review(req: NextRequest): Promise

const userInstanceJson = userInstance.toJSON();

// let policiesData = await Policy.findAll<any>();
// let policies = [];
// let reviewStatus = 1;

// if (!policiesData.length) {
// log.info('No policies found in the database.');
// policies = [];
// }

// policies = policiesData.map((policy) => {
// return `${policy.policy_name}: ${policy.policy_description}`;
// });

// const reviewResponses = getReviewResponses(courseReviewData);

// const evaluationResult = await reviewEvaluator.evaluateMultipleReviews(
// reviewResponses,
// policies
// );

// if (!evaluationResult.approvedByModel) {
// reviewStatus = 3;
// }

const course = await Course.findOne<any>({
where: { course_code: courseCode },
include: [
Expand All @@ -243,12 +230,12 @@ export const POST = async function post_course_review(req: NextRequest): Promise

const professorCourseJson = professorCourse.toJSON();

const averageRating: number = calculateAverageRating(courseReviewData?.questions);
const averageRating: number = Math.floor(calculateAverageRating(courseReviewData?.questions));

const review = await Review.create(
{
review_type_id: 1,
review_status_id: 1,
review_status_id: 1, // Review is set to the "pending" state by default waiting for the AI to approve/flag it
professor_course_id: professorCourseJson.professor_course_id,
user_id: userInstanceJson.user_id,
rating: averageRating,
Expand All @@ -261,6 +248,8 @@ export const POST = async function post_course_review(req: NextRequest): Promise

const reviewJson = review.toJSON();

postedReviewData = reviewJson;

// Add questions and answers if provided
if (courseReviewData.questions && courseReviewData.questions.length > 0) {
for (const { question_id, answer } of courseReviewData.questions) {
Expand All @@ -286,16 +275,55 @@ export const POST = async function post_course_review(req: NextRequest): Promise

await postTransaction.commit();

// Log the violation if any at the end when everything is created
// if (reviewStatus === 3) {
// const reason = evaluationResult.reason || 'No specific reason provided.';
// await ReviewPolicyViolationLog.create({
// review_id: reviewJson.review_id,
// policy_id: evaluationResult.violatedPolicyIndex + 1,
// reason: reason,
// });
// }
const reviewEvaluationTransaction = await sequelizeInstance.transaction();

const reviewEvaluator = new ReviewEvaluator();

// Get the review that was recently posted => postedReviewData
// Get all the policies that we have from the database
let policiesData = await Policy.findAll<any>();
let policies = [];

if (!policiesData.length) {
log.info('No policies found in the database.');
policies = [];
}

policies = policiesData.map((policy) => {
return `${policy.policy_name}: ${policy.policy_description}`;
});

const reviewResponses = getReviewResponses(courseReviewData);

const evaluationResult = await reviewEvaluator.evaluateMultipleReviews(
reviewResponses,
policies
);

if (evaluationResult.approvedByModel) {
// Update the review that we just posted and change the status ID to pending => 2
await Review.update(
{ review_status_id: 2 },
{
where: {
review_id: postedReviewData.review_id,
},
transaction: reviewEvaluationTransaction,
}
);
} else {
// Log the violation
const reason = evaluationResult.reason || 'No specific reason provided.';
await ReviewPolicyViolationLog.create({
review_id: postedReviewData.review_id,
policy_id: evaluationResult.violatedPolicyIndex + 1 || 1,
reason,
});
}

await reviewEvaluationTransaction.commit();

// START REDIS LOGIC: DELETE PREVIOUSLY CACHED DATA
const redisKeyPattern = `reviews:${courseCode}:*`; // This pattern will match all keys starting with 'reviews:{courseCode}:'

try {
Expand All @@ -310,9 +338,11 @@ export const POST = async function post_course_review(req: NextRequest): Promise
console.log('No keys found to delete.');
}
} catch (error) {
console.error('Error deleting keys:', error);
log.error('Error deleting keys:', error);
}

// END REDIS LOGIC: DELETE PREVIOUSLY CACHED DATA

log.info('Review successfully created and associated with course and professor.');
return NextResponse.json(
createSuccessResponse({ message: 'Course review successfully created.' }),
Expand All @@ -330,7 +360,6 @@ export const POST = async function post_course_review(req: NextRequest): Promise
// Start another transaction with regards to changing the review_status_id
// const aiTransaction = await sequelizeInstance.transaction();
} catch (error) {
console.error(error);
log.error('Error posting the course review', { error });

return NextResponse.json(
Expand Down
3 changes: 3 additions & 0 deletions app/courses/[courseCode]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ export default function CoursePage({ params }: { params: { courseCode: string }
}, [courseCode, selectedTerm]);
const { data: reviewResponse, error: reviewResponseError } = useSWR(reviewsURL, apiFetcher);

console.log('reviewResponse');
console.log(reviewResponse);

// For review form modal
const {
isOpen: isCourseReviewFormOpen,
Expand Down
8 changes: 4 additions & 4 deletions components/ConfirmationModal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ interface ConfirmationModalProps {
isOpen: boolean;
closeFormModal: () => void;
closeConfirmModal: () => void;
// resetForm: () => void;
isWarning?: boolean;
title: string;
message?: string;
Expand All @@ -26,18 +25,19 @@ const ConfirmationModal: React.FC<ConfirmationModalProps> = ({
isOpen,
closeFormModal,
closeConfirmModal,
// resetForm,
isWarning,
title,
message,
confirmBtnText,
}) => {
const flexStyle = useFlexStyle();

const confirmCloseAndReset = () => {
// resetForm();
// reset to default form values should be handled in the parent component's useEffect
closeConfirmModal();
closeFormModal();
if (!isWarning) {
window.location.reload();
}
};
return (
<Modal isOpen={isOpen} onClose={closeConfirmModal} isCentered>
Expand Down
Loading