This is an API for the v4 autograder. The main purpose of this project is to act as an in-between for the containers doing the autograding, and the users submitting assignments.
- Node - A javascript interpreter to run JS outside of the browser
- Docker (this is for the DB) - Containerization
For now the only reason we're including docker is to more easily control the development database. In the future we may very well dockerize the api itself for ease of development and deployment, but for now this writeup is expecting it to be running directly on your machine via node.
Once you've got these installed, we can build our container and run it
docker run \
--name typeorm-postgres \
-p 5432:5432 \
-e POSTGRES_PASSWORD=password \
-e POSTGRES_DB=typescript_api \
-e POSTGRES_USER=typescript_user \
-d postgres
Install all node dependancies. All of the database environment variables can change, and can be set as environment variables on your machine if you want to overwrite the defaults
npm install
Run the setup script to create local development auth keys. These are used in local development for signing and authenticating JWTs.
npm run generate-config
Run the initial migrations to setup our DB schema
npm run typeorm -- migration:run
Once you've got all the dependencies installed you can run the project via
npm start
By default the project runs at localhost:3001, but you can change the port by setting an alternate port by setting the PORT environment variable.
If you're working in vscode, a configuration has been included to allow for debugging. Open up the VS Code Run and Debug section and click Debug API.
The project has some nice devtools built into it that will make your life easier. Leaving these here to hopefully help make the engineering process a bit smoother as well as keep someone a bit more sane.
environment.ts: This is a rollup file for all the environment variables that the project uses as well as their fallbacks if none are provided. What this means is you can overwrite any of there easily without having to change code if you ever have a need to do so. Here's a command-line tip: you can set temporary environment variables on a per process basis by adding them before the command you want to run. Example: If we wish to set some value for LOG_DB temporarily, we can run the api like:
LOG_DB=1 npm start # this is a helpful command if you wish to log all sql commands to the DB when developing
Use VSCode as your text editor/ IDE. There's already a debugging script setup in the repository that allows you to run this project through VSCode (the vscode script is called Debug API). Once running through VSCode you can set debug to your hearts content (SERIOUSLY IF YOU'RE CODING WITH console.log STOP THAT).
Prettier is a library that's already installed and deals with code formatting. It will format all of your code on commit so that you never have to worry about style matching to the project. If you wish to see your code styled in real time, VSCode has a prettier plugin that will format on save for you (you don't have to do this, it'll still format on commit). Alternatively, you can manually format all of the code in the project with:
npm run format
Use Azure Data Studio (or some other sql client) for easier sql queries/ testing while developing. We're using PostgresSQL so keep that in mind while googling how to query things as the syntax and features can be slightly different across sql flavors. AZURE DATA STUDIO REQUIRES A POSTGRES PLUGIN TO WORK WITH POSTGRESQL. So if you want to use Azure Data Studio, you'll have to install that extension.
If you're looking for more information on how to setup auth for your developement environment, check out more info here
This project is built using
- Typescript - A superset of JavaScript. The language of the applciation
- Express - A Node REST framework.
- TypeORM - A Typescript ORM (manages the DB and all DB calls)
For those unfamiliar with Express, I'll attempt to give a brief rundown before talking about the project structure as a whole.
Express is a REST framework for node. Devs new to express will likely find one of the most perplexing parts of Express to be how it handles middleware. For those unfamiliar with what middleware is, it's largely a catch all term for code that connects together pieces of code in the api. In Express's context, middleware is basically everything that runs within each router; here's an example:
Router.get('/:id', asInt(), UserController.detail)In express, all of the functions added after the route's path are considered middleware and each route can have as many middleware as is needed. In this project we separate out controllers into their own directory though they are still considered middleware.
Express's middleware is always a function with three arguments
function middlwareName(req: Reques, res: Response, next: NextFunction)Here's what you need to know:
- Middlewares are called sequentially in the order of the arguments list
- You pass data between middlewares by adding whatever you want to pass to the
reqobject.- es
req.users = userResponse - Because we're in typescript you'll have to add whatever parameter you're passing to
@types/express/index.d.s
- es
- Calling
next()moves you to the next piece of middleware in the chain- Calling
nextwith any arguments is considered throwing an error and will stop you from going to the next middleware, and it will bubble back the chain to theglobalErrorHandler.
- Calling
Here's the basic layout of the application
Let's take this from the top
index.ts: where the application is bootstrapped from, controls all global server controls and middlewaresrouters/index.ts: largely a rollup for all the other routers. Can be used to add router specific middleware to routes/ subroutesrouters/route.ts: Individual routes for each resource, where the list of middleware can be found. All routers call unique middleware- Middleware: The above diagram is a bit of a misnomer. Not every endpoint will have auth, validators, and controllers. Some will have all of those, some may have none. Each route will have at least one middleware, and the last middleware will deal with returning the requested data
- Auth: checks the access/ refresh tokens
- Validators: validates the bodies of requests
- Controllers: deals with setting status codes, and directing to services. For the most part, controllers should be the last piece of middleware in the chain.
- Services: Workhorse of the application. Deals with all major application logic and database calls
The database models live outside of this control flow as they don't deal with any buisness logic. However services will use them to access the database. You can largely think of the models as a 1:1 map to database tables.
This project uses shared modules between it and it's client. What this means is that there exists code that operates in both this project and it's client. That project is being imported here as devu-shared-modules.
The project can be found here.
When developing if you need to update the modules, you can do so by updating the branch or SHA on the package url in the package.json. As an example, if you wanted to use shared modules from the auth branch, you could change the dependency line in the package.json to:
"devu-shared-modules": "github:UBAutograding/devu-shared#auth",
then rerun
npm install
to install the updated package
If you were to make changes to your shared branch and push it to the remote, you can update what version your local files are looking at via
npm update devu-shared-modules
We're using jest as our testing framework of choice. To run the entire test suite, use:
npm test
Keep in mind that when testing, jest is looking for *.test.ts files, so be sure to include the .test portion in those filenames.
If durring development, you want to only run a single test file (via command line), you can do so by adding a string to the end of the test command. That string will be used as a regex against the filename(s). So as an example, if we wanted to run all of the controller tests, you could do so by:
npm test "controller"
Alternatively, if you're wanting to just run the user.controller tests, you can do so via
npm test "users.controller"
And lastly, if you want to narrow it down to running less than a single test file (even down to a single test), you can do so via the -t argument. (Small pro tip, when running an npm script you can pass it extra command line arguments by passing a -- first, that's what's happening here)
npm test -- -t "some test description or name"
I wouldn't recommend digging that far down as the of tests should be more human-readable, and therefore not super great to grab via a regex; but if you really wish to do so, you can.
If the schema needs to be updated, you can do so by updating the models and running
npm run typeorm -- migration:generate -n generatedMigrationName
Doing so will attempt to create an auto migration from any changes within the src/models directory and add it to src/migrations. If an auto migration is generated for you (always check your auto migrations), you can run it with the above migration command
npm run typeorm -- migration:run
And revert the latest migration with
npm run typeorm -- migration:revert
Most of the API's configuraiton options live in a file called environment.ts. That file is bootstrapped at startup using the [config library]https://www.npmjs.com/package/config), as well as some environment variables.
What this means for you (the developer) is that you can control certain api options via environment variables at runtime, or by using your config/default.yml. To see which environment.ts options support using environment variables directly, open that file and see which are using process.env.*; everything else should be configurable via your default.yml
If you update your default.yml be sure to hard restart your API, as changing the config options does not update until you rebootstrap the API.
While we use prettier to control most of the style choices for the application, it is not a silver bullet. Here we'll list a few conventions that will (hopefully) make working in the API a little bit more sane.
When importing stuff we try to keep things in a certain order. Example
import Libraries
import RootLevelStuff
import Controllers
import Middleware
import Routers
import Utils
The important thing here is once you get into the modules (models/ controllers/ routers/ etc), import them alphebetically with a single empty line inbetween them.
You can build the project as a production build
npm run build
This throws the production build into ./build and can be run with
node index.js