Student Clubs (#388)

* implemented a student club scraping cronjob and db-migration * implemented a GRPC access to said table * tested if weird joinging of the ORM is now better
TUM-Dev · Jul 20, 2024 · d77fd75 · d77fd75
1 parent 0a14f38
commit d77fd75
Show file tree

Hide file tree

Showing 18 changed files with 4,566 additions and 225 deletions.
diff --git a/server/api/tumdev/campus_backend.pb.go b/server/api/tumdev/campus_backend.pb.go
diff --git a/server/api/tumdev/campus_backend.pb.gw.go b/server/api/tumdev/campus_backend.pb.gw.go
diff --git a/server/api/tumdev/campus_backend.proto b/server/api/tumdev/campus_backend.proto
@@ -146,6 +146,11 @@ service Campus {
   rpc DeleteDevice(DeleteDeviceRequest) returns (DeleteDeviceReply) {
     option (google.api.http) = {delete: "/device/{device_id}"};
   }
+
+  // Delete a device from push notifications
+  rpc ListStudentClub(ListStudentClubRequest) returns (ListStudentClubReply) {
+    option (google.api.http) = {delete: "/student_clubs"};
+  }
 }
 
 enum DeviceType {
@@ -559,3 +564,22 @@ message GetCanteenHeadCountReply {
   // A time stamp indicating how up to date the response is. Only valid in case percent != -1.
   google.protobuf.Timestamp timestamp = 4;
 }
+message ListStudentClubRequest {}
+message ListStudentClubReply {
+  repeated StudentClubCollection collections = 1;
+}
+message StudentClub {
+  // The name of the club
+  string name = 1;
+  // How the club describes itsself
+  optional string description = 2;
+  // Where the clubs main internet presence is
+  optional string link_url = 3;
+  // Where to find a image for this club
+  optional string cover_url = 4;
+}
+message StudentClubCollection {
+  string title = 1;
+  string description = 2;
+  repeated StudentClub clubs = 3;
+}
diff --git a/server/api/tumdev/campus_backend.swagger.json b/server/api/tumdev/campus_backend.swagger.json
@@ -787,6 +787,29 @@
         ]
       }
     },
+    "/student_clubs": {
+      "delete": {
+        "summary": "Delete a device from push notifications",
+        "operationId": "Campus_ListStudentClub",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/apiListStudentClubReply"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "tags": [
+          "Campus"
+        ]
+      }
+    },
     "/updatenote/{version}": {
       "get": {
         "operationId": "Campus_GetUpdateNote",
@@ -1315,6 +1338,18 @@
         }
       }
     },
+    "apiListStudentClubReply": {
+      "type": "object",
+      "properties": {
+        "collections": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/apiStudentClubCollection"
+          }
+        }
+      }
+    },
     "apiMovie": {
       "type": "object",
       "properties": {
@@ -1551,6 +1586,45 @@
         }
       }
     },
+    "apiStudentClub": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "title": "The name of the club"
+        },
+        "description": {
+          "type": "string",
+          "title": "How the club describes itsself"
+        },
+        "linkUrl": {
+          "type": "string",
+          "title": "Where the clubs main internet presence is"
+        },
+        "coverUrl": {
+          "type": "string",
+          "title": "Where to find a image for this club"
+        }
+      }
+    },
+    "apiStudentClubCollection": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "clubs": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/apiStudentClub"
+          }
+        }
+      }
+    },
     "apiTagsOverview": {
       "type": "object",
       "properties": {

diff --git a/server/api/tumdev/campus_backend_grpc.pb.go b/server/api/tumdev/campus_backend_grpc.pb.go
diff --git a/server/backend/cron/cronjobs.go b/server/backend/cron/cronjobs.go
@@ -27,6 +27,7 @@ const (
 	CanteenHeadcount = "canteenHeadCount"
 	MovieType        = "movie"
 	FeedbackEmail    = "feedbackEmail"
+	StudentClubType  = "scrapeStudentClubs"
 
 	/* MensaType      = "mensa"
 	AlarmType      = "alarm" */
@@ -46,14 +47,15 @@ func (c *CronService) Run() error {
 		var res []model.Crontab
 
 		c.db.Model(&model.Crontab{}).
-			Find(&res, "`interval` > 0 AND (lastRun+`interval`) < ? AND type IN (?, ?, ?, ?, ?, ?)",
+			Find(&res, "`interval` > 0 AND (lastRun+`interval`) < ? AND type IN (?, ?, ?, ?, ?, ?, ?)",
 				time.Now().Unix(),
 				NewsType,
 				FileDownloadType,
 				DishNameDownload,
 				CanteenHeadcount,
 				MovieType,
 				FeedbackEmail,
+				StudentClubType,
 			)
 
 		for _, cronjob := range res {
@@ -66,6 +68,8 @@ func (c *CronService) Run() error {
 
 			// Run each job in a separate goroutine, so we can parallelize them
 			switch cronjob.Type.String {
+			case StudentClubType:
+				g.Go(func() error { return c.studentClubCron() })
 			case NewsType:
 				// if this is not copied here, this may not be threads save due to go's guarantees
 				// loop variable cronjob captured by func literal (govet)