Quiz Bowl Capstone Repository - Functions

Description

This repository contains the Azure Functions code for the Quiz Bowl API, a crucial part of the Quiz Bowl project. The code in this repository is the same code as is in the "qzblapi" Function App in the Azure Portal. Any deployments made to the main branch will automatically redeploy on the qzblapi app (AKA PRODUCTION) on the Azure platform.

File Structure & Pre-Requisites

This entire repository contains a single Functions app. The src folder contains all of the individual Functions that are part of this app. Each function is contained in its own js file.

Pre-requisities

In order to run this repository locally, you'll need the following tools:

• NodeJS (at least version 18.17.0 or higher)
• Azure Functions Core Tools.

To run Functions apps locally for testing, some tools need to be installed and the repo needs to be set up correctly.

1. Clone the repository to your local machine.

2. Open a terminal window and navigate to the folder you cloned the repo to. Inside the folder, run the following command to install all necessary software packages: npm install

3. Run the Functions app locally by using the following command: func start

Accessing The Database

All functions take a connection string as input in order to connect to the database.

To set the connection string, create or edit a file called local.settings.json and paste this inside of it:

{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "node",
    "AzureWebJobsFeatureFlags": "EnableWorkerIndexing",
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "dbconn": "Server=(url);Persist Security Info=False;User ID=(userID);Password=(putpasswordhere);MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=60;"
  }
}

Note that the connection string for this database can be found by going to the Azure Portal page for the Quiz Bowl database and copying the authentication string marked "ADO.NET (SQL authentication)". Note that you will need to replace the password in the connection string with the known password for connecting to the database.

This file allows you to set environment variables that can then be referenced later. For the production Functions app, environment variables can be managed in the Azure Portal under Settings > Configuration. You might have noticed that each function has a section at the end where if a variable called "local" is set to false, Sentry monitoring will be enabled. This environment variable is present on the production deployment, but should not be present in local development testing, as it can clog up logs.

Database Structure

The database consists of two tables inside of a SQL Server service instance on the Azure Platform. The tables are as follows:

• accounts (stores user accounts for Quizpedia):

  • username (varchar - maxlength 64 - primary key - unique key)
  • password (varchar - maxlength 64)
  • uid (int - length 11-12)
  • admin (true/false boolean flag, 0 = not admin, 1 = admin)

• quizQuestions (stores question data):

  • question (varchar - maxlength 256)
  • answer (varchar - maxlength 256)
  • species
  • level
  • resource
  • topic
  • lastusedbydate
  • lastusedevent
  • lastupdated
  • qid

Using This Repository

To use this repository, the following commands can be run in the terminal from the repository folder:

func new --template "Http Trigger" --name "name here"

Creates a new function inside of this application. Select Node for runtime and Javascript for language if prompted.

func start

Runs the function app locally for testing. The app will give you individual local URLs that you can use to call the local functions.

Other functions

For full information, check out the Azure Functions Core Tools Dev Reference.