Merge pull request #68 from CS3219-AY2425S1/collab-post-ms6

Add online indicator status for collab editor, and fixed various other services

Author: WZWren

.gitignore

@@ -1 +1,4 @@
-**/.env
+**/.env
+.idea
+*.log
+main.exe

.husky/pre-commit

@@ -0,0 +1 @@
+cd ./peerprep && npx lint-staged

.lefthook.yml

@@ -0,0 +1,10 @@
+#pre-commit:
+#  parallel: true
+#  commands:
+#    golangci-lint:
+#      glob: "*.go"
+#      run: golangci-lint run {staged_files}
+#    lint-staged:
+#      root: "peerprep/"
+#      glob: "*.(ts|tsx|css|scss|md|json)"
+#      run: npx lint-staged

backend/common/question_struct.go

@@ -1,4 +1,4 @@
-// defines the JSON format of quesitons.
+// defines the JSON format of questions.
 package common
 
 type Question struct {
@@ -17,3 +17,8 @@ type FrontendQuestion struct {
 	TopicTags  []string `json:"topicTags"`
 	Content    string   `json:"content"`
 }
+
+type MatchingQuestion struct {
+	TopicTags []string `json:"topicTags"`
+	Difficulty string `json:"difficulty"`
+}

backend/database/database_interactions.go

@@ -10,6 +10,7 @@ import (
 	"peerprep/common"
 
 	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 )
 
@@ -34,6 +35,36 @@ func (db *QuestionDB) GetAllQuestionsWithQuery(
 	return questions, nil
 }
 
+func (db *QuestionDB) GetOneQuestionWithQuery(
+	logger *common.Logger,
+	filter bson.D,
+) (*common.Question, error) {
+	// Define the aggregation pipeline with the $match and $sample stages
+	pipeline := mongo.Pipeline{
+		{{Key: "$match", Value: filter}},
+		{{Key: "$sample", Value: bson.D{{Key: "size", Value: 1}}}},
+	}
+
+	// Execute the aggregation pipeline
+	cursor, err := db.questions.Aggregate(context.Background(), pipeline)
+	if err != nil {
+		logger.Log.Error("Error retrieving questions: ", err.Error())
+		return nil, err
+	}
+
+	var questions []common.Question
+	if err = cursor.All(context.Background(), &questions); err != nil {
+		logger.Log.Error("Error decoding questions: ", err.Error())
+		return nil, err
+	}
+	
+	if len(questions) == 0 {
+		return nil, nil
+	}
+
+	return &questions[0], nil
+}
+
 func (db *QuestionDB) AddQuestion(logger *common.Logger, question *common.Question) (int, error) {
 	if db.QuestionExists(question) {
 		logger.Log.Warn("Cannot add question: question already exists")

backend/main.go

@@ -1,4 +1,3 @@
-// this is the main file to run the server
 package main
 
 import (

backend/transport/get_random_matching_question.go

@@ -0,0 +1,43 @@
+package transport
+
+import (
+	"net/http"
+	"peerprep/common"
+	"peerprep/database"
+
+	"github.com/gin-gonic/gin"
+	"go.mongodb.org/mongo-driver/bson"
+)
+
+func GetRandomMatchingQuestion(db *database.QuestionDB, logger *common.Logger) (gin.HandlerFunc) {
+	return func(ctx *gin.Context) {
+		var request common.MatchingQuestion
+
+		err := ctx.BindJSON(&request)
+
+		if err != nil {
+			ctx.JSON(http.StatusBadGateway, "error binding request from JSON")
+			logger.Log.Error("Error converting JSON to matching request:", err.Error())
+			return
+		}
+		
+		filter := bson.D{
+			{Key: "topicTags", Value: bson.D{{Key: "$in", Value: request.TopicTags}}},
+			{Key: "difficulty", Value: request.Difficulty},
+		}
+		question, err := db.GetOneQuestionWithQuery(logger, filter)
+
+		if err != nil {
+			ctx.JSON(http.StatusBadGateway, "error retrieving questions from database")
+			return
+		}
+
+		if question == nil {
+			ctx.JSON(http.StatusNotFound, "no questions found matching the request")
+			return
+		}	
+		
+		ctx.JSON(http.StatusOK, question)
+		logger.Log.Info("matching-service request handled successfully")
+	}
+}

backend/transport/question_http_requests.go

@@ -19,12 +19,13 @@ func SetAllEndpoints(router *gin.Engine, db *database.QuestionDB, logger *common
 	router.DELETE("/questions/delete/:id", DeleteQuestionWithLogger(db, logger))
 	router.PUT("/questions/replace/:id", ReplaceQuestionWithLogger(db, logger))
 	router.GET("/health", HealthCheck(logger))
+	router.POST("/match", GetRandomMatchingQuestion(db, logger))
 }
 
 // enable CORS for the frontend
 func SetCors(router *gin.Engine, origin string) {
 	router.Use(cors.New(cors.Config{
-		AllowOrigins:     []string{origin},
+		AllowOrigins:     []string{"http://host.docker.internal", origin},
 		AllowMethods:     []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
 		AllowHeaders:     []string{"Origin", "Content-Type", "Content-Length", "Authorization"},
 		ExposeHeaders:    []string{"Content-Length"},

backend/transport/replace_question.go

@@ -33,21 +33,21 @@ func ReplaceQuestionWithLogger(db *database.QuestionDB, logger *common.Logger) g
 			return
 		}
 
-		if id_param >= db.FindNextQuestionId() {
-			logger.Log.Info(
-				"Attempting to update a question with an ID greater than next ID, creating a new question",
-			)
-			status, err := db.AddQuestion(logger, &new_question)
-
-			if err != nil {
-				ctx.JSON(status, err.Error())
-				return
-			}
-
-			ctx.JSON(status, "Question added successfully")
-			logger.Log.Info("Question added successfully")
-			return
-		}
+		//if id_param >= db.FindNextQuestionId() {
+		//	logger.Log.Info(
+		//		"Attempting to update a question with an ID greater than next ID, creating a new question",
+		//	)
+		//	status, err := db.AddQuestion(logger, &new_question)
+		//
+		//	if err != nil {
+		//		ctx.JSON(status, err.Error())
+		//		return
+		//	}
+		//
+		//	ctx.JSON(status, "Question added successfully")
+		//	logger.Log.Info("Question added successfully")
+		//	return
+		//}
 
 		logger.Log.Info("Replacing question with ID: ", id_param)
 		new_question.Id = id_param

collab/Dockerfile

@@ -0,0 +1,16 @@
+FROM golang:1.20
+
+WORKDIR /collab
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+# Build
+RUN CGO_ENABLED=0 GOOS=linux go build -o /collab/app
+
+EXPOSE 4000
+
+# Run
+CMD ["/collab/app"]