Merge pull request #235 from makeopensource/75-ncag-question-types

ncag question types

Author: RA341

devU-api/README.md

@@ -11,104 +11,37 @@ For now the only reason we're including docker is to more easily control the dev
 
 ## Running the Project Locally
 
-### Getting Everything Started
-
-Once you've got these installed, we can build our container and run it
-
-#### Note to run the postgres container locally using the command below
-
-You have to modify `devU-api/src/environment.ts`
-
-change
-
-`dbHost: (load('database.host') || 'localhost') as string`
-
-to
-
-`dbHost: 'localhost'`
-
-This will probably be fixed in the future but for now the above steps are necessary
-
-#### Using docker compose
-
-We use [docker compose profiles](https://docs.docker.com/compose/profiles/) to selectively start services in the main docker-compose when developing.
-
-Assuming you are in api dir `devU-api`, To start all api services except the api run
-
-```
-npm run api-services
-```
-
-To stop the services
-
-```
-npm run api-services-stop
-```
-
-Then install dependencies using
-
-```
-npm install
-```
-
-Once you've got all the dependencies installed you can run the project via
-
-```
-npm start
-```
-
-#### Manually:
-
-```
-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 dependencies. 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
-
-```
-docker run \
-  --name minio \
-  -p 9002:9000 \
-  -p 9001:9001 \
-  -v /tmp/data:/data \
-  -e "MINIO_ROOT_USER=typescript_user" \
-  -e "MINIO_ROOT_PASSWORD=changeMe" \
-  -d minio/minio server /data --console-address ":9001"
-```
-
-Install all node dependencies. 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 -d src/database.ts
-```
-
-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`.
+### Quick Start
+
+The instructions below assume you are in the api dir `/devU-api/`
+
+You must have the following tools installed
+
+* Docker
+* Node >= v20
+
+Once you've got these installed,
+
+1. We use [docker compose profiles](https://docs.docker.com/compose/profiles/) 
+    to selectively start services in the main docker-compose when developing.
+    This starts all required services for the api depends (database, frontend etc.)
+    ```
+    npm run api-services
+    ```
+    
+    To remove all related containers 
+    ```
+    npm run api-services-stop
+    ```
+
+2. Install dependencies using
+    ```
+    npm install
+    ```
+3. Once you've got all the dependencies installed you can run the project via
+    ```
+    npm run start
+    ```
 
 ### Convenient Devtools
 
@@ -173,7 +106,7 @@ Here's what you need to know:
 
 Here's the basic layout of the application
 
-![control flow of the api](/docs/controlFlow.png 'Control Flow')
+![control flow of the api](./docs/controlFlow.png 'Control Flow')
 
 Let's take this from the top
 
@@ -218,9 +151,8 @@ When developing if you need to create a new type,
 
 This will update the types in `devU-api` and `devU-client` folders.
 
-**Note if the types are not being detected by your IDE**
-
-**Go to the `devU-api/` and `devU-client/` and run `npm install` in each folder to update the shared modules.**
+if the types are not being detected, Go to the `devU-api/` and `devU-client/` 
+and run `npm install` in each folder to update the shared modules.
 
 ### Testing
 
@@ -257,7 +189,7 @@ I wouldn't recommend digging that far down as the of tests should be more human-
 If the schema needs to be updated, you can do so by updating the models and running
 
 ```
-npm run typeorm migration:generate -- -d src/database src/migration/<generatedMigrationName>
+npm run create-migration someMeaningfulMigrationName
 ```
 
 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

devU-api/package.json

@@ -9,6 +9,7 @@
     "create-migrate": "npx typeorm-ts-node-commonjs migration:generate -d src/database.ts",
     "update-shared": "cd ../devU-shared && npm run build-local && cd ../devU-api && npm i",
     "typeorm": "typeorm-ts-node-commonjs",
+    "create-migration": "ts-node scripts/create-migration.ts",
     "test": "jest --passWithNoTests",
     "clean": "rimraf build/*",
     "lint": "tsc",
@@ -17,7 +18,7 @@
     "pre-commit": "lint-staged",
     "populate-db": "ts-node-dev ./scripts/populate-db.ts",
     "tango": "ts-node-dev ./src/tango/tests/tango.endpoint.test.ts",
-    "api-services": "docker compose -f ../docker-compose.yml --profile dev-api up",
+    "api-services": "docker compose -f ../docker-compose.yml --profile dev-api up --build",
     "api-services-stop": "docker compose -f ../docker-compose.yml --profile dev-api stop"
   },
   "lint-staged": {
@@ -67,6 +68,7 @@
     "cors": "^2.8.5",
     "devu-shared-modules": "./devu-shared-modules",
     "express": "^4.17.1",
+    "express-list-endpoints": "^7.1.1",
     "express-validator": "^6.14.2",
     "helmet": "^4.6.0",
     "jsonwebtoken": "^9.0.2",

devU-api/scripts/create-migration.ts

@@ -0,0 +1,26 @@
+import { exec } from 'child_process'
+
+// Get the migration name from command line arguments
+const migrationName = process.argv[2]
+
+if (!migrationName) {
+  console.error('Migration name is required!')
+  console.error('Usage: npm run create-mig MigrationName')
+  process.exit(1)
+}
+
+const command = `npm run typeorm -- migration:generate -d src/database.ts src/migration/${migrationName}`
+console.log(`Executing: ${command}`)
+
+// Execute the command
+exec(command, (error, stdout, stderr) => {
+  if (stdout) console.log(stdout)
+  if (stderr) console.error(stderr)
+
+  if (error) {
+    console.error(`Error: ${error.message}`)
+    process.exit(1)
+  }
+
+  console.log('Migration file created successfully!')
+})

devU-api/src/entities/nonContainerAutoGrader/nonContainerAutoGrader.model.ts

@@ -27,6 +27,9 @@ export default class NonContainerAutoGraderModel {
    *          type: integer
    *        question:
    *          type: string
+   *        metadata:
+   *          type: any
+   *          description: this contains a valid json string tha contains info about any arbitrary question type (MCQ, Fill in the blanks etc.)
    *        score:
    *          type: number
    *        correctString:
@@ -53,6 +56,9 @@ export default class NonContainerAutoGraderModel {
   @Column({ name: 'question', length: 128 })
   question: string
 
+  @Column({ name: 'metadata', type: 'jsonb', nullable: true, default: {} })
+  metadata: any // use any since this can be any arbitrary structure
+
   @Column({ name: 'score' })
   score: number
 

devU-api/src/entities/nonContainerAutoGrader/nonContainerAutoGrader.serializer.ts

@@ -8,6 +8,7 @@ export function serialize(nonContainerAutoGrader: NonContainerAutoGraderModel):
     assignmentId: nonContainerAutoGrader.assignmentId,
     question: nonContainerAutoGrader.question,
     score: nonContainerAutoGrader.score,
+    metadata: JSON.stringify(nonContainerAutoGrader.metadata ?? ''),
     correctString: nonContainerAutoGrader.correctString,
     isRegex: nonContainerAutoGrader.isRegex,
     createdAt: nonContainerAutoGrader.createdAt.toISOString(),

devU-api/src/index.ts

@@ -23,17 +23,11 @@ import { responseInterceptor } from './entities/webhooks/webhooks.middleware'
 
 const app = express()
 
-initializeMinio()
-  .then(() =>
-    dataSource.initialize()
-      .then(() => {
-        console.log('Data Source has been initialized!')
-      })
-      .catch(err => {
-        console.error('Error during Data Source initialization', err)
-      })
-  )
-  .then(_connection => {
+async function main() {
+  try {
+    await initializeMinio()
+    await dataSource.initialize()
+
     app.use(helmet())
     app.use(express.urlencoded({ extended: true }))
     app.use(express.json())
@@ -42,17 +36,19 @@ initializeMinio()
     app.use(morgan('combined'))
     app.use(passport.initialize())
 
-    console.log(`Api: ${environment.isDocker ? '' : 'not'} running in docker`)
-
-    app.use(responseInterceptor)
-
-    // Middleware;
+    console.log(`API${environment.isDocker ? '' : ' not'} running in docker`)
+    app.use(responseInterceptor) // webhooks
     app.use('/', router)
     app.use(errorHandler)
 
     app.listen(environment.port, () =>
-      console.log(`API listening at port - ${environment.port}\n
-    If you are running the full app, the front end should be accessible at http://localhost:9000`)
+      console.log(`API listening at port - ${environment.port}`),
     )
-  })
-  .catch(err => console.log('TypeORM connection error:', err))
+  } catch (e: any) {
+    console.error(`Error during initialization ${e.toString()}`)
+  }
+}
+
+main().catch((err: any) => {
+  console.error(err)
+})

devU-api/src/migration/1741738490302-addMetadataToNCAG.ts

@@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class AddMetadataToNCAG1741738490302 implements MigrationInterface {
+    name = 'AddMetadataToNCAG1741738490302'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "nonContainerAutoGrader" ADD "metadata" jsonb DEFAULT '{}'`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "nonContainerAutoGrader" DROP COLUMN "metadata"`);
+    }
+
+}

devU-shared/src/types/grader.types.ts

@@ -1,8 +1,8 @@
-import { SubmissionProblemScore, SubmissionScore } from ".."
+import { SubmissionProblemScore } from './submissionProblemScore.types'
+import { SubmissionScore } from './submissionScore.types'
 
-export type GraderInfo = {
 
+export type GraderInfo = {
   submissionScore: SubmissionScore
   submissionProblemScores: SubmissionProblemScore[]
-
 }

devU-shared/src/types/nonContainerAutoGrader.types.ts

@@ -1,10 +1,11 @@
 export type NonContainerAutoGrader = {
     id?: number
+    createdAt?: string
+    updatedAt?: string
     assignmentId: number
     question: string
+    metadata: string,
     score:number
     correctString: string
     isRegex: boolean
-    createdAt?: string
-    updatedAt?: string
 }