[autofix.ci] apply automated fixes

Sma1lboy · Jan 24, 2025 · 19af1ec · 19af1ec
1 parent 55deed8
commit 19af1ec
Show file tree

Hide file tree

Showing 5 changed files with 611 additions and 714 deletions.
diff --git a/backend/src/build-system/__tests__/mock/test_files/Backend_Requirements_Node.md b/backend/src/build-system/__tests__/mock/test_files/Backend_Requirements_Node.md
@@ -1,7 +1,10 @@
 # overview
+
 #### 1. System Overview
+
 - **Project Name**: Spotify-like Music Web
 - **Technology Stack**
+
   - **Core technology choices**: JavaScript (Node.js), Express.js for the backend framework, using RESTful API design principles for remote communication.
   - **Framework architecture**: Employ an MVC architecture to separate concerns between models (data handling), views (data representation), and controllers (business logic).
   - **Key dependencies and their purposes**:
@@ -12,6 +15,7 @@
     - **cors**: To enable Cross-Origin Resource Sharing for frontend and backend communication.
 
 - **Architecture Patterns**
+
   - Framework-specific patterns: Implements middleware for logging, validation, and error handling; uses Promises and/or async/await for asynchronous operations.
   - Project structure: Organized into folders such as `models`, `routes`, `controllers`, `middleware`, and `utils`.
   - Dependency management: Utilize npm for managing packages, specifying versions in package.json to ensure consistent setup across environments.
@@ -32,212 +36,215 @@ Method: POST
 Purpose: Create a new user account
 Frontend Usage: page_view_signup
 Data Requirements:
-  - Required data transformations: Validate and hash password before saving the user.
-  - Caching requirements: None.
-  - Real-time update needs: Immediate response needed.
-Request:
+
+- Required data transformations: Validate and hash password before saving the user.
+- Caching requirements: None.
+- Real-time update needs: Immediate response needed.
+  Request:
   Headers: {
-    "Content-Type": "application/json"
+  "Content-Type": "application/json"
   }
   Params: {}
   Query: {}
   Body: {
-    "username": "String",
-    "email": "String",
-    "password": "String",
-    "profilePicture": "String (optional)"
+  "username": "String",
+  "email": "String",
+  "password": "String",
+  "profilePicture": "String (optional)"
   }
-Response:
+  Response:
   Success: {
-    "userId": "Integer",
-    "username": "String",
-    "email": "String"
+  "userId": "Integer",
+  "username": "String",
+  "email": "String"
   }
   Errors: {
-    "400": "Bad request, validation failed",
-    "409": "Conflict, email or username already exists"
-  }
-Required Auth: No
-Rate Limiting: None
-Cache Strategy: None
-Route: /api/users/login
-Method: POST
-Purpose: Authenticate user and receive an access token.
-Frontend Usage: page_view_login
-Data Requirements:
-  - Required data transformations: Validate username/email and password, generate JWT upon success.
-  - Caching requirements: None.
-  - Real-time update needs: Immediate response needed.
-Request:
+  "400": "Bad request, validation failed",
+  "409": "Conflict, email or username already exists"
+  }
+  Required Auth: No
+  Rate Limiting: None
+  Cache Strategy: None
+  Route: /api/users/login
+  Method: POST
+  Purpose: Authenticate user and receive an access token.
+  Frontend Usage: page_view_login
+  Data Requirements:
+- Required data transformations: Validate username/email and password, generate JWT upon success.
+- Caching requirements: None.
+- Real-time update needs: Immediate response needed.
+  Request:
   Headers: {
-    "Content-Type": "application/json"
+  "Content-Type": "application/json"
   }
   Params: {}
   Query: {}
   Body: {
-    "identifier": "String (username/email)",
-    "password": "String"
+  "identifier": "String (username/email)",
+  "password": "String"
   }
-Response:
+  Response:
   Success: {
-    "token": "String",
-    "userId": "Integer",
-    "username": "String"
+  "token": "String",
+  "userId": "Integer",
+  "username": "String"
   }
   Errors: {
-    "401": "Unauthorized, invalid credentials"
+  "401": "Unauthorized, invalid credentials"
   }
-Required Auth: No
-Rate Limiting: None
-Cache Strategy: None
+  Required Auth: No
+  Rate Limiting: None
+  Cache Strategy: None
 
 **Playlist Management**
 Route: /api/playlists
 Method: POST
 Purpose: Create a new playlist for a user
 Frontend Usage: page_view_playlist_management
 Data Requirements:
-  - Required data transformations: Validate incoming playlist data.
-  - Caching requirements: Cache newly created playlists.
-  - Real-time update needs: N/A, but notify the user upon successful creation.
-Request:
+
+- Required data transformations: Validate incoming playlist data.
+- Caching requirements: Cache newly created playlists.
+- Real-time update needs: N/A, but notify the user upon successful creation.
+  Request:
   Headers: {
-    "Authorization": "Bearer {token}",
-    "Content-Type": "application/json"
+  "Authorization": "Bearer {token}",
+  "Content-Type": "application/json"
   }
   Params: {}
   Query: {}
   Body: {
-    "userId": "Integer",
-    "playlistName": "String",
-    "description": "String (optional)"
+  "userId": "Integer",
+  "playlistName": "String",
+  "description": "String (optional)"
   }
-Response:
+  Response:
   Success: {
-    "playlistId": "Integer",
-    "playlistName": "String",
-    "description": "String",
-    "createdDate": "DateTime"
+  "playlistId": "Integer",
+  "playlistName": "String",
+  "description": "String",
+  "createdDate": "DateTime"
   }
   Errors: {
-    "400": "Bad request, validations failed"
-  }
-Required Auth: Yes
-Rate Limiting: None
-Cache Strategy: Cache playlist lists.
-Route: /api/playlists/:playlistId
-Method: GET
-Purpose: Retrieve a specific playlist by ID
-Frontend Usage: page_view_playlist_details
-Data Requirements:
-  - Required data transformations: Retrieve playlist and its associated tracks.
-  - Caching requirements: Cache the playlist data for quick retrieval.
-  - Real-time update needs: N/A unless using collaborative features.
-Request:
+  "400": "Bad request, validations failed"
+  }
+  Required Auth: Yes
+  Rate Limiting: None
+  Cache Strategy: Cache playlist lists.
+  Route: /api/playlists/:playlistId
+  Method: GET
+  Purpose: Retrieve a specific playlist by ID
+  Frontend Usage: page_view_playlist_details
+  Data Requirements:
+- Required data transformations: Retrieve playlist and its associated tracks.
+- Caching requirements: Cache the playlist data for quick retrieval.
+- Real-time update needs: N/A unless using collaborative features.
+  Request:
   Headers: {
-    "Authorization": "Bearer {token}"
+  "Authorization": "Bearer {token}"
   }
   Params: {
-    "playlistId": "Integer"
+  "playlistId": "Integer"
   }
   Query: {}
   Body: {}
-Response:
+  Response:
   Success: {
-    "playlistId": "Integer",
-    "playlistName": "String",
-    "tracks": [
-      {
-        "trackId": "Integer",
-        "title": "String",
-        "artist": "String",
-        "album": "String",
-        "duration": "Integer"
-      }
-    ]
+  "playlistId": "Integer",
+  "playlistName": "String",
+  "tracks": [
+  {
+  "trackId": "Integer",
+  "title": "String",
+  "artist": "String",
+  "album": "String",
+  "duration": "Integer"
+  }
+  ]
   }
   Errors: {
-    "404": "Not found, invalid playlist ID"
+  "404": "Not found, invalid playlist ID"
   }
-Required Auth: Yes
-Rate Limiting: None
-Cache Strategy: Cache playlist details.
+  Required Auth: Yes
+  Rate Limiting: None
+  Cache Strategy: Cache playlist details.
 
 **Track Management**
 Route: /api/tracks
 Method: GET
 Purpose: Search for tracks based on queries
 Frontend Usage: page_view_search
 Data Requirements:
-  - Required data transformations: Filter and search for tracks.
-  - Caching requirements: Cache popular search results.
-  - Real-time update needs: N/A for static track data.
-Request:
+
+- Required data transformations: Filter and search for tracks.
+- Caching requirements: Cache popular search results.
+- Real-time update needs: N/A for static track data.
+  Request:
   Headers: {}
   Params: {}
   Query: {
-    "search": "String (title/album/artist)",
-    "limit": "Integer"
+  "search": "String (title/album/artist)",
+  "limit": "Integer"
   }
   Body: {}
-Response:
+  Response:
   Success: {
-    "tracks": [
-      {
-        "trackId": "Integer",
-        "title": "String",
-        "artist": "String",
-        "album": "String"
-      }
-    ]
+  "tracks": [
+  {
+  "trackId": "Integer",
+  "title": "String",
+  "artist": "String",
+  "album": "String"
   }
-  Errors: {
-    "400": "Bad request, validation failed"
+  ]
   }
-Required Auth: No
-Rate Limiting: None
-Cache Strategy: Cache search results for performance.
-Route: /api/tracks/:trackId
-Method: GET
-Purpose: Retrieve detailed information about a specific track
-Frontend Usage: page_view_playlist_details (when displaying track details)
-Data Requirements:
-  - Required data transformations: Retrieve track details.
-  - Caching requirements: Cache track details.
-  - Real-time update needs: N/A unless user interactions require it.
-Request:
+  Errors: {
+  "400": "Bad request, validation failed"
+  }
+  Required Auth: No
+  Rate Limiting: None
+  Cache Strategy: Cache search results for performance.
+  Route: /api/tracks/:trackId
+  Method: GET
+  Purpose: Retrieve detailed information about a specific track
+  Frontend Usage: page_view_playlist_details (when displaying track details)
+  Data Requirements:
+- Required data transformations: Retrieve track details.
+- Caching requirements: Cache track details.
+- Real-time update needs: N/A unless user interactions require it.
+  Request:
   Headers: {}
   Params: {
-    "trackId": "Integer"
+  "trackId": "Integer"
   }
   Query: {}
   Body: {}
-Response:
+  Response:
   Success: {
-    "trackId": "Integer",
-    "title": "String",
-    "artist": "String",
-    "album": "String",
-    "duration": "Integer",
-    "coverImage": "String"
+  "trackId": "Integer",
+  "title": "String",
+  "artist": "String",
+  "album": "String",
+  "duration": "Integer",
+  "coverImage": "String"
   }
   Errors: {
-    "404": "Not found, invalid track ID"
+  "404": "Not found, invalid track ID"
   }
-Required Auth: No
-Rate Limiting: None
-Cache Strategy: Cache track details.
+  Required Auth: No
+  Rate Limiting: None
+  Cache Strategy: Cache track details.
 
 # implementation
 
-
 # config
+
 ## language
+
 javascript
 
 ## framework
+
 express
 
 ## packages
-
-