Chirp Server

Remote deploy doc: https://docs.google.com/document/d/1IonmV_BOxkqI56iw6IVp4ZT0CnO6Tb7wae3rO7opB3M/edit

Project Index Doc

Setup Locally

This is going to be your best option for regular development. It will continue to be the case until I have a process for setting up through Vagrant

Database Setup

• Make sure you have a mariadb build installed on your computer. Stop after step 6.

• After step 6 (run brew services start mariadb and mariadb-install-db). Follow instructions to set a root password.

• Access mariadb with mariadb -u root -p.
• Create the chime database CREATE DATABASE chime;
• Exit mariadb, then navigate to the chime-server directory and import the structure mysql -u root -p chime < chime.sql (sudo may be required for this operation)
• Repeat the previous two steps but create an additional empty database (CREATE DATABASE chimetest) for the sake of testing mysql -u root -p chimetest < chime.sql
• Choose a username and password for a test user, and a username and password for a test super user
• Add both test users to the chimetest database with CREATE USER '<username>'@localhost IDENTIFIED BY '<password>'; (you'll run this twice, once for each username and password pair from the previous step)
• Grant the super user all permissions using GRANT ALL PRIVILEGES ON *.* TO 'username'@'localhost';
• Set the credentials of the super user to DB_SUPERUSER and DB_SUPERUSERPW in .env
• Set the credentials of the user to DB_USER and DB_USERPW in .env

Potential Issues

If you have messed up downloading mariadb or want to fresh install and reset all local databases and mariadb data, use the following steps

• log into mariadb using mariadb -u <username> -p
• run Select @@datadir to find the location that data is being stored
• copy the location of the displayed directory
• Exit mariadb
• run brew servives stop mariadb
• delete the directory at the previously copied location. For reference, on Dec 9, 2024 this was /opt/homebrew/var/mysql on my Macbook Pro
• reinstall mariadb using the above instructions

Server Setup

The chime server runs on node.js, to set up your dependencies, navigate into the directory and run: npm install to start the server, run: npm start

Env Structure

If you do not already have a .env in Chime/chime_server/ then create one touch Chime/chime_server/.env

Insert the following structure into that file.

SESSION_SECRET="<random_string>"
SERVER_HOST="<server_host_ip>"
SERVER_PORT="<server_port_number>"
DB_HOST="<database_host>"
USAGE_PERIOD_EXPIRATION="<random_string>"
DB_NAME="<chime_database_name>"
DB_USER="<chime_user_name>"
DB_USERPW="<chime_user_password>"
DB_SUPERUSER="<superuser_name>"
DB_SUPERUSERPW="<superuser_password>"

Endpoint Overview

endpoint	method	body	returns
/user	post	token (string)	userID: internal userid
/login	post	token (string)	userID: internal userid
/usage_period	post	null	usagePeriodID: usage_period id
/usage_period/end	post	null	null
/post	post	main_emoji (string) story_emojis (string)	post_id (int)
/post/:post_id/reaction	post	post_id (int) - id of post reacting on react_emoji (string) - emoji reacting with react_time (timestamp) - user local time	react_id (int)
/post/:post_id/reaction	delete	post_id(int) - id of post removing reaction react_emoji (string) - emoji removing	null
/user/posts	get	null	reverse chronological table of given user posts [post id, time posted, main emoji, story emojis]
/user/:id	get	null	[username, avatar]
/posts	get	num_posts (int) - max # of posts to return last_post_id (int) - id of last post you have (lowest post_id) (-1 if fetching most recent posts)	reverse chronological list of [post id, poster username, poster id, poster avatar, post timestamp, main emoji, story emojis, react type, count of react type on this post, current user react (NULL if none)])

Testing

Testing is done using mocha Run the test suite with npm test

Errors are disabled temporarily by the testing suite, if you would like to see errors, disable this error muting in tests.js, which acts as a test manager.

Make sure that DB_SUPERUSER and DB_PASSWORD are both set in your .env file according to the credentials of your root mariadb user.

Notes

• IDs are assigned automatically by an increment function, so retrieving items with ID greater than n will fetch items created after the item with ID n.

• If you get error 1449, go into chime.sql and make sure the definer under each view is set to 'youruser'@'yourhost'.

• Two middlewares exist within the project

  • authenticate.js will throw an error if the user is not logged in.
  • update_usage_period.js will either update an existing usage period if it has not expired, or it will generate a new usage period if the existing usage period has expired.

• All timestamps are UTC

Environment

.env example:

# String used to secure session data
SESSION_SECRET="chickenzrule"
# Name of database
DB_NAME="chime"
# Name of database user
DB_USER="username"
# Password for database
DB_USERPW="password"
# Database host
DB_HOST="localhost"
# Superuser username for database (used for testing)
DB_SUPERUSER="superusername"
# Superuser password for database (used for testing)
DB_SUPERUSERPW="superpassword"
# Time for usage period to expire in ms
USAGE_PERIOD_EXPIRATION=5000
# Server hostname
SERVER_HOST="localhost"
# Server port on host
SERVER_PORT=3000

DEPRECATED:

Setup Through Docker

This is the best option for testing frontend, but is not good for modifying/testing backend. This will run the version of chimeserver _on your local machine with the same OS/settings as the server. It will also automatically set up the database. Note that every time you run this it will reset the database to empty.

• download and install Docker https://hub.docker.com/editions/community/docker-ce-desktop-mac/
• Ask Talie for the docker-compose.yaml file and put it one level up (in Chime, on the same level as chime_server)
• Navigate to /Chime and run docker-compose up
• If you make changes to chime_server, cancel out of docker-compose up, run docker-compose build, then re-run docker-compose up