Next release

.github/workflows/go.yml

@@ -20,12 +20,12 @@ jobs:
     steps:
 
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v6
 
     - name: Set up Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v6
       with:
-        go-version: '1.24'
+        go-version: '1.25'
         cache-dependency-path: "**/go.sum"
 
     - name: Setup
@@ -34,14 +34,14 @@ jobs:
     - name: Check
       run: make check
 
-    - name: Build
-      run: make build
-
     - name: Test
       env:
         MONGODB_URI: ${{ secrets.MONGODB_URI }}
       run: make test
 
+    - name: Build
+      run: make build
+
   build_windows:
     runs-on: windows-latest
     defaults:
@@ -67,10 +67,10 @@ jobs:
     - name: Check
       run: .\build.bat checks
 
-    - name: Build
-      run: .\build.bat build
-
     - name: Test
       env:
         MONGODB_URI: ${{ secrets.MONGODB_URI }}
       run: .\build.bat test
+
+    - name: Build
+      run: .\build.bat build

README.md

@@ -9,7 +9,7 @@ Project maintained by [Nebula Labs](https://about.utdnebula.com).
 
 Documentation for the current production API can be found [here.](https://api.utdnebula.com/swagger/index.html)
 
-## How to use
+## How to use Nebula API in your own project
 
 - Visit our [Discord](https://discord.utdnebula.com) and ask to be provisioned an API key (please provide details on your use case)
 - Read the documentation listed above (and authenticate with your key for interactive demos)
@@ -21,7 +21,8 @@ Contributions are welcome!
 
 This project uses the MIT License.
 
-Please visit our [Discord](https://discord.utdnebula.com) and talk to us if you'd like to contribute!
+Please visit our [Discord](https://discord.utdnebula.com) and talk to us if you'd like to contribute! Don't be afraid to ask for help!
+
 ### How to Contribute
 
 Create your own fork by [forking this repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#forking-a-repository)
@@ -32,7 +33,7 @@ Submit proposed changes via a [Pull Request](https://docs.github.com/en/pull-req
 
 ## Building
 ### Requirements
-- [Golang 1.23 or Higher](https://go.dev/dl/)
+- [Golang 1.24 or Higher](https://go.dev/dl/)
 
 ### Building for Windows
 cd into `nebula-api\api`
@@ -43,6 +44,8 @@ Setup Go Dependencies with
 Build with
 `.\build.bat build`
 
+This will create an executable named `go-api.exe` in the `api` directory
+
 Run with
 `.\go-api.exe`
 > Note: some have experienced issues with Windows Defender or other antivirus blocking `go-api.exe` from reading files, editing files, or causing slowed performance. Consider adding a exception to your `nebula-api` folder.
@@ -56,17 +59,23 @@ Setup Go dependencies with
 Build with
 `make build`
 
+This will create an executable named `go-api` in the `api` directory
+
+> Note: If Make fails with "swag: No such file or directory" or similar, you may need to add GOPATH/bin to your path to your path, On Mac, use ``echo 'export PATH=${PATH}:`go env GOPATH`/bin' >> ~/.zshrc && source ~/.zshrc`` to add it permanently to your .zshrc 
+
 Run with
 `./go-api`
 
-## Running to API locally
+## Running API locally
 Copy `.env.template` to `.env` with
 `cp .env.template .env`
 
-Enter Nebula MongoDB URI in `.env`
+Enter Nebula MongoDB URI in `.env` (ask for help in the [Discord](https://discord.utdnebula.com))
 
 Run `go-api`
 
 Check command output to see the route serving traffic. It's likely port 8080
 
 Visit `http://localhost:8080` to access nebula-api locally
+
+> Storage and email routes require additional environment variables. If you're working on these routes, ask for help in the [Discord](https://discord.utdnebula.com)

api/.env.template

@@ -1,3 +1,5 @@
+# See README.MD for more information
+
 # DATABASE URI
 MONGODB_URI=
 CLUBS_DB_URI=
@@ -9,9 +11,21 @@ CLUBS_DB_URI=
 #PORT=
 #GIN_MODE=release
 
-# CLOUD STORAGE (internal use only)
+# SENRTY
+SENTRY_ENVIRONMENT=development
+
+# For Google Cloud Routes /storage /email (internal use only)
 GOOGLE_APPLICATION_CREDENTIALS=
 STORAGE_ROUTE_KEY=
+# MAX_UPLOAD_SIZE=104857600
+EMAIL_SEND_ROUTE_KEY=
+EMAIL_QUEUE_ROUTE_KEY=
 
-# SENRTY
-SENTRY_ENVIRONMENT=
+# For SMTP email sending
+SMTP_HOST=smtp.gmail.com
+SMTP_USERNAME=
+SMTP_PASSWORD=
+
+# For Email Google Cloud Task Queueing 
+GCLOUD_EMAIL_QUEUE_PATH=
+GCLOUD_EMAIL_QUEUE_URL=

api/Dockerfile

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1
 
-FROM docker.io/golang:1.24 AS builder
+FROM docker.io/golang:1.25 AS builder
 WORKDIR /build
 
 COPY ./configs ./configs

api/Makefile

@@ -17,14 +17,14 @@ check:
 	gofmt -w ./..
 	goimports -w ./..
 
+test:
+	go test ./... -count=1
+
 build: server.go
 	swag fmt
 	swag init -g server.go --outputTypes yaml,go
 	go build -o $(EXEC_NAME) server.go
 
-test:
-	go test ./...
-
 clean: $(EXEC_NAME)
 	rm $(EXEC_NAME)
 

api/build.bat

@@ -38,17 +38,18 @@ echo Checks done!
 echo[
 if "%1"=="checks" exit
 
+:test
+echo Testing...
+go test ./... -count=1
+if ERRORLEVEL 1 exit /b %ERRORLEVEL% :: fail if error occurred
+echo Testing complete!
+echo[
+if "%1"=="build" exit
+
 :build
 echo Building...
 go build -o %EXEC_NAME% server.go
 if ERRORLEVEL 1 exit /b %ERRORLEVEL% :: fail if error occurred
 echo Build complete!
 echo[
-if "%1"=="build" exit
-
-:test
-echo Testing...
-go test ./...
-if ERRORLEVEL 1 exit /b %ERRORLEVEL% :: fail if error occurred
-echo Testing complete!
-echo[
+if "%1"=="build" exit

api/configs/env.go

@@ -71,3 +71,26 @@ func GetEnvLimit() int64 {
 
 	return limit
 }
+
+func GetEnvMaxUploadSize() int64 {
+	const (
+		defaultLimit int64 = 30 * 1024 * 1024
+		hardCapLimit int64 = 50 * 1024 * 1024
+	)
+
+	limitString, exist := os.LookupEnv("MAX_UPLOAD_SIZE")
+	if !exist {
+		return defaultLimit
+	}
+
+	limit, err := strconv.ParseInt(limitString, 10, 64)
+	if err != nil {
+		return defaultLimit
+	}
+
+	if limit > hardCapLimit {
+		return hardCapLimit
+	}
+
+	return limit
+}

api/controllers/astra.go

@@ -28,7 +28,7 @@ var astraCollection *mongo.Collection = configs.GetCollection("astra")
 // @Success		200		{object}	schema.APIResponse[schema.MultiBuildingEvents[schema.AstraEvent]]	"All AstraEvents with events on the inputted date"
 // @Failure		500		{object}	schema.APIResponse[string]											"A string describing the error"
 func AstraEvents(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	date := c.Param("date")
@@ -61,7 +61,7 @@ func AstraEvents(c *gin.Context) {
 // @Failure		500			{object}	schema.APIResponse[string]											"A string describing the error"
 // @Failure		404			{object}	schema.APIResponse[string]											"A string describing the error"
 func AstraEventsByBuilding(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	date := c.Param("date")
@@ -120,7 +120,7 @@ func AstraEventsByBuilding(c *gin.Context) {
 // @Failure		500			{object}	schema.APIResponse[string]											"A string describing the error"
 // @Failure		404			{object}	schema.APIResponse[string]											"A string describing the error"
 func AstraEventsByBuildingAndRoom(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	date := c.Param("date")

api/controllers/autocomplete.go

@@ -25,7 +25,7 @@ var DAGCollection *mongo.Collection = configs.GetCollection("DAG")
 // @Success		200	{object}	schema.APIResponse[[]schema.Autocomplete]	"An aggregation of courses for use in generating autocomplete DAGs"
 // @Failure		500	{object}	schema.APIResponse[string]					"A string describing the error"
 func AutocompleteDAG(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 30*time.Second)
 	defer cancel()
 
 	var autocompleteDAG []schema.Autocomplete

api/controllers/calendar.go

@@ -30,7 +30,7 @@ var cometCalendarCollection *mongo.Collection = configs.GetCollection("cometCale
 // @Success		200		{object}	schema.APIResponse[schema.MultiBuildingEvents[schema.Event]]	"All CometCalendarEvents with events on the inputted date"
 // @Failure		500		{object}	schema.APIResponse[string]										"A string describing the error"
 func CometCalendarEvents(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	date := c.Param("date")
@@ -63,7 +63,7 @@ func CometCalendarEvents(c *gin.Context) {
 // @Failure		500			{object}	schema.APIResponse[string]										"A string describing the error"
 // @Failure		404			{object}	schema.APIResponse[string]										"A string describing the error"
 func CometCalendarEventsByBuilding(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	date := c.Param("date")
@@ -135,7 +135,7 @@ func CometCalendarEventsByBuilding(c *gin.Context) {
 // @Failure		500			{object}	schema.APIResponse[string]							"A string describing the error"
 // @Failure		404			{object}	schema.APIResponse[string]							"A string describing the error"
 func CometCalendarEventsByBuildingAndRoom(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	date := c.Param("date")

api/controllers/club.go

@@ -23,7 +23,7 @@ import (
 // @Failure		500	{object}	schema.APIResponse[string]		"A string describing the error"
 // @Failure		400	{object}	schema.APIResponse[string]		"A string describing the error"
 func ClubDirectoryInfo(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	var clubsDatabase *sql.DB = configs.ConnectClubsDB()
@@ -88,7 +88,7 @@ func ClubDirectoryInfo(c *gin.Context) {
 // @Failure		500	{object}	schema.APIResponse[string]			"A string describing the error"
 // @Failure		400	{object}	schema.APIResponse[string]			"A string describing the error"
 func ClubSearch(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	var clubsDatabase *sql.DB = configs.ConnectClubsDB()

api/controllers/controller_utils.go

@@ -31,7 +31,7 @@ func respond[T any](c *gin.Context, status int, message string, data T) {
 func getQuery[T any](flag string, c *gin.Context) (bson.M, error) {
 	switch flag {
 	case "Search":
-		query, err := schema.FilterQuery[T](c)
+		query, err := schema.FilterQuery[T](c.Request.URL.Query())
 		if err != nil {
 			respond(c, http.StatusBadRequest, "Invalid query parameters", err.Error())
 			return nil, err

api/controllers/course.go

@@ -41,10 +41,7 @@ var courseCollection *mongo.Collection = configs.GetCollection("courses")
 // @Failure		500						{object}	schema.APIResponse[string]			"A string describing the error"
 // @Failure		400						{object}	schema.APIResponse[string]			"A string describing the error"
 func CourseSearch(c *gin.Context) {
-	//name := c.Query("name")            	// value of specific query parameter: string
-	//queryParams := c.Request.URL.Query() 	// map of all query params: map[string][]string
-
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	var courses []schema.Course
@@ -122,7 +119,7 @@ func CourseById(c *gin.Context) {
 // @Success		200	{object}	schema.APIResponse[[]schema.Course]	"All courses"
 // @Failure		500	{object}	schema.APIResponse[string]			"A string describing the error"
 func CourseAll(c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 30*time.Second)
 	defer cancel()
 
 	var courses []schema.Course
@@ -223,7 +220,7 @@ func CourseProfessorById(c *gin.Context) {
 
 // courseAggregate is a generic function that gets a specified field of the courses, filters depending on the flag
 func courseAggregate[T any](flag string, c *gin.Context) {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Second)
 	defer cancel()
 
 	var queryResults []T
@@ -243,6 +240,7 @@ func courseAggregate[T any](flag string, c *gin.Context) {
 	}
 
 	// Determine the endpoint based on the type of the desired query results
+
 	var zero T
 	var endpoint string
 	switch any(zero).(type) {
@@ -295,7 +293,7 @@ func buildCoursePipeline(endpoint string, courseQuery bson.M, paginate map[strin
 	var lookupStages, dedupStages mongo.Pipeline
 	switch endpoint {
 	case "sections":
-		lookupStages, dedupStages = mongo.Pipeline{}, mongo.Pipeline{}
+		// No extra stages middle stages
 
 	case "professors":
 		// Lookup the list of professors from the list of sections
@@ -336,7 +334,6 @@ func buildCoursePipeline(endpoint string, courseQuery bson.M, paginate map[strin
 	middleStages := append(append(lookupStages, replaceStages...), dedupStages...)
 
 	paginateStages := mongo.Pipeline{
-		// Keep order deterministic between calls
 		bson.D{{Key: "$sort", Value: bson.D{{Key: "_id", Value: 1}}}},
 
 		paginate["latter_offset"],