Merge pull request #62 from pennlabs/aag/predeploy-backend-fixes

Aag/predeploy backend fixes

Author: AaDalal

.devcontainer/Dockerfile

@@ -0,0 +1,3 @@
+FROM --platform=linux/amd64 ubuntu:22.04
+ARG IMAGE_NAME=pennlabs/courses-devcontainer
+RUN apt-get update && apt-get install -y wget curl gcc python3-dev libpq-dev

.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+{
+	"name": "Penn Courses",
+	"build": { "dockerfile": "Dockerfile" },
+	"containerUser": "otis",
+	"features": {
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {},
+		"ghcr.io/devcontainers/features/python:1": {
+			"version": "3.11"
+		},
+		"ghcr.io/devcontainers/features/node:1": {},
+		"ghcr.io/devcontainers/features/common-utils:2": {
+			"configureZshAsDefaultShell": true,
+			"username": "otis"
+		},
+		"git-lfs": "latest",
+		"terraform": {
+			"version": "latest",
+			"tflint": "latest",
+			"terragrunt": "latest"
+		}
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": ["esbenp.prettier-vscode"]
+		}
+	}
+}

.github/workflows/shared-build-deploy.yaml

@@ -15,7 +15,7 @@ jobs:
       path: backend
       flake: true
       black: true
-      pythonVersion: 3.10-buster
+      pythonVersion: 3.11-buster
 
   publish-backend:
     uses: pennlabs/shared-actions/.github/workflows/[email protected]
@@ -55,6 +55,7 @@ jobs:
         product: [review, plan, alert]
     with:
       path: frontend/${{ matrix.product }}
+      nodeVersion: 18.19.0
 
   publish-frontend:
     uses: pennlabs/shared-actions/.github/workflows/[email protected]

.gitignore

@@ -1,7 +1,4 @@
 .env*
-.yarn/build-state.yml
-.yarn/unplugged
-.yarn/install-state.gz
 .vscode
 .idea/
 .DS_Store
@@ -26,4 +23,4 @@ pcr-backup*
 ./Pipfile
 ./Pipfile.lock
 ./package.json
-./yarn.lock
+./yarn.lock

Pipfile

@@ -1,4 +1,4 @@
-# Penn Courses with Penn Degree Plan
+# Penn Courses
 ![Workflow](https://github.com/pennlabs/penn-courses/workflows/Workflow/badge.svg)
 [![Coverage Status](https://codecov.io/gh/pennlabs/penn-courses/branch/master/graph/badge.svg)](https://codecov.io/gh/pennlabs/penn-courses)
 
@@ -10,6 +10,27 @@ This is the unified home of all [Penn Courses](https://penncourses.org) products
 
 Note that you need the backend to run the frontend.
 
+### Using Dev Containers
+
+This repository has a built-in dev container that you can use to develop the project. To use it, you need to have [Docker](https://www.docker.com/products/docker-desktop) and [VSCode](https://code.visualstudio.com/) installed.
+
+Press the remote container button in the bottom left of the window and select "Reopen in Container". This will build the dev container and open the project in a new window.
+
+This container is designed to work with both backend and frontend development. Some additional steps are required, like installing `pipenv` dependencies and setting up the database and running the frontend server. Please read and follow the instructions in the backend and frontend READMEs.
+
+For more information, visit dev container [documentation](https://code.visualstudio.com/docs/remote/containers).
+
+#### Pushing Code
+
+You can use `ssh-add` to make your SSH keys available to the dev container. This will allow you to push code to GitHub.
+
+```
+ssh-add ~/.ssh/id_rsa
+```
+
+
+
+
 ## API Documentation
 API Docs can be found at `/api/documentation` on the back-end server. Also check out the code for more explanations
 and documentation! We've tried to keep it up-to-date.

README.md

@@ -1,4 +1,4 @@
-FROM pennlabs/django-base:9c4f31bf1af44219d0f9019271a0033a222291c2-3.10.1
+FROM pennlabs/django-base:b269ea1613686b1ac6370154debbb741b012de1a-3.11
 
 LABEL maintainer="Penn Labs"
 

backend/Dockerfile

@@ -664,8 +664,7 @@ def update_tag(old_tag, new_tag):
             all_list = all([("list" in v["operationId"].lower()) for v in tag_to_dicts[tag]])
             if all_list:  # if all views in tag are lists, pluralize tag name
                 tag = update_tag(
-                    tag,
-                    " ".join(tag.split(" ")[:-1] + [pluralize_word(tag.split(" ")[-1])]),
+                    tag, " ".join(tag.split(" ")[:-1] + [pluralize_word(tag.split(" ")[-1])])
                 )
             if tag in custom_tag_names.keys():  # rename custom tags
                 tag = update_tag(tag, custom_tag_names[tag])
@@ -852,10 +851,7 @@ def fail(param, hint):
                     fail(param_name, f"The {param_name} kwarg must be a dict.")
                 for dictionary in param_dict.values():
                     if not isinstance(dictionary, dict):
-                        fail(
-                            param_name,
-                            f"All values of the {param_name} dict must be dicts.",
-                        )
+                        fail(param_name, f"All values of the {param_name} dict must be dicts.")
                     for nested_dictionary in dictionary.values():
                         if param_name == "custom_parameters":
                             if not isinstance(nested_dictionary, list):

backend/PennCourses/docs_settings.py

@@ -49,7 +49,6 @@
     "options.apps.OptionsConfig",
     "django.contrib.admindocs",
     "django_extensions",
-    "django_filters",
     "alert",
     "courses",
     "plan",
@@ -201,11 +200,6 @@
         "rest_framework.authentication.BasicAuthentication",
         "accounts.authentication.PlatformAuthentication",
     ],
-    "DEFAULT_PARSER_CLASSES": (
-        "rest_framework.parsers.JSONParser",
-        "rest_framework.parsers.FormParser",
-        "rest_framework.parsers.MultiPartParser",
-    ),
 }
 
 STATS_WEBHOOK = os.environ.get("STATS_WEBHOOK", None)

backend/PennCourses/settings/base.py

@@ -31,6 +31,9 @@
         "LOCATION": REDIS_URL,
         "OPTIONS": {
             "CLIENT_CLASS": "django_redis.client.DefaultClient",
+            "IGNORE_EXCEPTIONS": True,  # ignore Redis connection errors
+            "SOCKET_CONNECT_TIMEOUT": 1,
+            "SOCKET_TIMEOUT": 1,
         },
     }
 }