Merge branch 'master' into capacities

Author: LesterLyu

.github/workflows/alpha.yml

@@ -0,0 +1,58 @@
+name: Deploy Alpha
+
+on:
+  push:
+    branches: [ alpha ]
+
+jobs:
+  build-frontend:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Write SSH keys
+        run: |
+          install -m 600 -D /dev/null ~/.ssh/id_rsa
+          echo "${{ secrets.ALPHA_SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
+          echo "${{ vars.ALPHA_SSH_KNOWN_HOSTS }}" > ~/.ssh/known_hosts
+
+      - name: Use Node.js 16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache-dependency-path: |
+            frontend/yarn.lock
+            backend/yarn.lock
+          cache: 'yarn'
+
+      - name: Install Frontend Dependencies
+        working-directory: frontend
+        run: yarn install --frozen-lockfile
+
+      - name: Build Frontend
+        working-directory: frontend
+        run: CI=false yarn build; cp build/index.html build/404.html
+
+      - name: Install Docs Dependencies
+        working-directory: doc
+        run: yarn install
+
+      - name: Build Docs
+        working-directory: doc
+        run: yarn build; mv ./dist ../frontend/build/docs
+
+      - name: Make sure remote folder exists
+        run: ssh ${{vars.ALPHA_SSH_USER}}@${{vars.ALPHA_SSH_HOST}} -p ${{vars.ALPHA_SSH_PORT}} "mkdir -p SNM-I"
+
+      - name: Rsync built frontend
+        run: rsync -rvz -e "ssh -p ${{vars.ALPHA_SSH_PORT}}" --progress --delete ./frontend/build/* ${{vars.ALPHA_SSH_USER}}@${{vars.ALPHA_SSH_HOST}}:/home/ubuntu/SNM-I/frontend-build
+
+      - name: Rsync backend
+        run: rsync -rvz -e "ssh -p ${{vars.ALPHA_SSH_PORT}}" --progress --delete ./backend ${{vars.ALPHA_SSH_USER}}@${{vars.ALPHA_SSH_HOST}}:/home/ubuntu/SNM-I/
+
+      - name: Rsync scripts
+        run: rsync -rvz -e "ssh -p ${{vars.ALPHA_SSH_PORT}}" --progress --delete ./scripts ${{vars.ALPHA_SSH_USER}}@${{vars.ALPHA_SSH_HOST}}:/home/ubuntu/SNM-I/
+
+      - name: Update & Restart Backend
+        run: ssh ${{vars.ALPHA_SSH_USER}}@${{vars.ALPHA_SSH_HOST}} -p ${{vars.ALPHA_SSH_PORT}} "cd SNM-I && ./scripts/redeploy.sh"

README.md

@@ -11,3 +11,8 @@
 - URL: https://socialneedsmarketplace.ca
 
 - Docs: https://www.socialneedsmarketplace.ca/docs/
+
+#### `alpha` Branch
+- URL: https://alpha.socialneedsmarketplace.ca
+
+- Docs: https://alpha.socialneedsmarketplace.ca/docs/

backend/.env.example

@@ -9,6 +9,7 @@ MAIL_PASSWORD="password"
 GRAPHDB_ADDRESS="http://127.0.0.1:7200"
 GRAPHDB_USERNAME="username"
 GRAPHDB_PASSWORD="password"
+GRAPHDB_REPO="snmi"
 
 # Custom MongoDB connection string
 MONGODB_ADDRESS="mongodb://127.0.0.1:27017/snmi"

backend/config/index.js

@@ -7,6 +7,7 @@ if (isProduction)
 const config = {
   graphdb: {
     addr: isProduction ? 'http://127.0.0.1:7200' : `http://${isDocker ? 'host.docker.internal' : '127.0.0.1'}:7200`,
+    repositoryName: process.env.GRAPHDB_REPO || (process.env.test ? "snmiTest" : "snmi")
   },
   mongodb: {
     addr: isProduction ? 'mongodb://localhost:27017/snmi' : `mongodb://localhost:27017/${process.env.test ? "snmiTest" : "snmi"}`
@@ -18,6 +19,7 @@ const config = {
     'http://localhost:3002',
     'https://www.socialneedsmarketplace.ca',
     'https://beta.socialneedsmarketplace.ca',
+    'https://alpha.socialneedsmarketplace.ca',
     'https://www.snmi.ca'],
 
   frontend: {

backend/loaders/graphDB.js

@@ -436,7 +436,7 @@ INSERT DATA {
 
   let url;
   for (let query of query_list){
-    url = `${graphdb.addr}/repositories/snmi/statements?update=${encodeURIComponent(query)}`;
+    url = `${graphdb.addr}/repositories/${graphdb.repositoryName}/statements?update=${encodeURIComponent(query)}`;
 
     const response = await fetch(url, {
       method: 'POST',
@@ -464,7 +464,8 @@ async function load() {
     password: graphdb.password,
     namespaces,
     // The repository name, a new repository will be created if it does not exist.
-    repositoryName: process.env.test ? "snmiTest" : "snmi",
+    repositoryName: graphdb.repositoryName,
+    // Set to true if you want to see SPARQL queries
     debug: false
   });
 

backend/routes/serviceProviders.js

@@ -1,11 +1,12 @@
 const express = require('express');
 const {createSingleServiceProvider, fetchMultipleServiceProviders, fetchSingleServiceProvider,
-  deleteSingleServiceProvider, updateServiceProvider, searchMultipleServiceProviders
+  deleteSingleServiceProvider, updateServiceProvider, fetchHomeServiceProvider, searchMultipleServiceProviders
 } = require("../services/genericData/serviceProvider");
 const router = express.Router();
 
 router.post('/providers', createSingleServiceProvider);
 router.get('/providers', fetchMultipleServiceProviders);
+router.get('/providers/home', fetchHomeServiceProvider);
 router.get('/providers/search', searchMultipleServiceProviders);
 router.get('/providers/:id', fetchSingleServiceProvider);
 router.delete('/providers/:id', deleteSingleServiceProvider);

backend/services/genericData/serviceProvider.js

@@ -294,7 +294,21 @@ const deleteSingleServiceProvider = async (req, res, next) => {
 
 };
 
+const fetchHomeServiceProvider = async (req, res, next) => {
+  try {
+    const homeOrganization = await GDBOrganizationModel.findOne({status: 'Home'}, {populates: []});
+    if (!homeOrganization) {
+      return res.status(400).json({message: 'This deployment has no home organization'})
+    }
+    const provider = await GDBServiceProviderModel.findOne({organization: homeOrganization});
+    provider.organization = homeOrganization;
+    return res.status(200).json({provider, success: true});
+  } catch (e) {
+    next(e);
+  }
+};
+
 module.exports = {
-    createSingleServiceProvider, fetchMultipleServiceProviders, fetchSingleServiceProvider, deleteSingleServiceProvider,
-    updateServiceProvider, searchMultipleServiceProviders, getProviderById
+  createSingleServiceProvider, fetchMultipleServiceProviders, fetchSingleServiceProvider, deleteSingleServiceProvider,
+  updateServiceProvider, getProviderById, fetchHomeServiceProvider, searchMultipleServiceProviders
 };

doc/src/content/docs/guides/deployment.md

@@ -2,32 +2,99 @@
 title: Deployment Guide
 ---
 
-## Deploy to any server
-
-### Remote Server Preparations
-> We will initialize a server and set up an automatic deployment from GitHub Actions.
->
-> This setup assumes the SNM-I deployment server is behind a reverse proxy,
-> we also need to set up ssh port forwarding on the reverse proxy to make the ssh server accessible from the public.
->
-### GitHub Secrets and Variable to Set up
-
-| KEY                     | Example Value                                      | Variable or Secret? |
-|-------------------------|----------------------------------------------------|---------------------|
-| RELEASE_SSH_HOST        | 206.12.97.46                                       | Variable            |
-| RELEASE_SSH_KNOWN_HOSTS | [206.12.97.46]:14572 ecdsa-sha2-nistp256 AAAAE2... | Variable            |
-| RELEASE_SSH_PORT        | 14572                                              | Variable            |
-| RELEASE_SSH_USER        | ubuntu                                             | Variable            |
-| RELEASE_SSH_PRIVATE_KEY | -----BEGIN OPENSSH PRIVATE KEY-----\nb3Blbn....    | **Secret**          |
-
-#### Remote Server Requirement
+# Deploy to any server
+A push to the relative branch triggers the GitHub Actions to compile the frontend, and run tests if existed.
+Then it ssh into the remote server to executive a sequence of commands to update the code & compiled frontend.
+
+## Things you might what to know
+- Docker and how to install Docker Engine
+- Understand Docker Compose
+- GitHub Actions and GitHub Workflow file
+- GitHub Secrets/variables to store credentials/configurations
+- How to set up SSH with the private key
+- How to preconfigure the SSH `know_hosts` in an CI environment
+- How to ssh and execute commands on a remote server in an CI environment
+- Use rsync to synchronize files to remote servers
+- How to host static files (compiled react frontend) in Caddy
+- How to use iptables to do a port forward (In the server that hosts a reverse proxy)
+
+## GitHub Secrets and Variable to Set up
+
+We will go through each of the variables/secrets.
+
+| KEY                   | Example Value                                      | Variable or Secret? |
+|-----------------------|----------------------------------------------------|---------------------|
+| BETA_SSH_HOST         | 206.12.97.46                                       | Variable            |
+| BETA_SSH_KNOWN_HOSTS  | [206.12.97.46]:14572 ecdsa-sha2-nistp256 AAAAE2... | Variable            |
+| BETA_SSH_PORT         | 14572                                              | Variable            |
+| BETA_SSH_USER         | ubuntu                                             | Variable            |
+| BETA_SSH_PRIVATE_KEY  | -----BEGIN OPENSSH PRIVATE KEY-----\nb3Blbn....    | **Secret**          |
+
+
+## Remote Servers Overview
+We will initialize a server for SNM-I and set up an automatic deployment from GitHub Actions.
+
+This setup assumes the SNM-I deployment server is behind a reverse proxy,
+we also need to set up ssh port forwarding on the reverse proxy to make the ssh server accessible from the public.
+
+The following example assumes:
+- The SNM-I is hosted on the subdomain `beta.socialneedsmarketplace.ca`.
+- SNM-I server has an internal IP **192.168.41.202**.
+- Reverse proxy server has an internal IP **192.168.41.156** and external IP **206.12.97.46**.
+
+
+### SSH port forward
+ssh to `206.12.97.46:14572` goes directly into the SNM-I server.
+```text
+---------------------         ------------------------ 
+| SNM-I Server      |         | Reverse Proxy Server | 
+| 192.168.41.202:22 |   <->   | 192.168.41.156:14572 | 
+|                   |         | 206.12.97.46:14572   |    <->   Internet
+---------------------         ------------------------
+```
+
+### Webserver reverse proxy
+
+#### Frontend includes docs
+The compiled frontend and docs are hosted on port 80.
+```text
+beta.socialneedsmarketplace.ca -> 192.168.41.202:80
+```
+
+#### Backend API
+The Node.js Backend opens a port 5000 for api calls.
+```text
+beta.socialneedsmarketplace.ca/api/* -> 192.168.41.202:5000
+```
+
+
+## SNM-I Server Preparations
 Recommended OS: Ubuntu 22.04 or above
 
-Follow [Docker Engine Installation](https://docs.docker.com/engine/install/ubuntu/).
+### Setup Docker
+> Follow the [official guide](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
+```shell
+# Add Docker's official GPG key:
+sudo apt-get update
+sudo apt-get install ca-certificates curl
+sudo install -m 0755 -d /etc/apt/keyrings
+sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
+sudo chmod a+r /etc/apt/keyrings/docker.asc
+
+# Add the repository to Apt sources:
+echo \
+  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
+  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+sudo apt-get update
+
+# Install the latest version
+sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+```
 
 Create an `.env` in the root directory `~/` that specifies the correct email server and graphdb server location & credentials. 
 
-#### Generate SSH KEY on Remote Server
+### Generate SSH KEY on Remote Server
 ```shell
 ssh-keygen
 ```
@@ -41,11 +108,12 @@ Your identification has been saved in /home/ubuntu/.ssh/id_rsa
 Your public key has been saved in /home/ubuntu/.ssh/id_rsa.pub
 ...
 ```
-#### Add to `authorized_keys`
+### Add to `authorized_keys`
+This authorizes the generated key.
 ```shell
 cat ./.ssh/id_rsa.pub >> ./.ssh/authorized_keys
 ```
-#### Copy the private key `id_rsa` to GitHub Secret
+### Copy the private key `id_rsa` to GitHub Secret
 ```shell
 cat ./.ssh/id_rsa
 ```
@@ -58,17 +126,13 @@ b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
 ```
 1. Navigate to "SNM-I Repo Setting" -> "Security" -> "Secrets and variables" -> "Actions" -> ["Secrets"](https://github.com/csse-uoft/SNM-I/settings/secrets/actions).
 1. Click "New repository secret"
-1. Set the name to `RELEASE_SSH_PRIVATE_KEY` and copy the whole private key to the secret field.
-#### Set `RELEASE_SSH_KNOWN_HOSTS`
-On Windows or Ubuntu, ssh to the server and disconnect. Open `~/.ssh/known_hosts`. Copy the line for the remote server.
-```text
-[206.12.97.46]:14572 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBBxpcp7MHTdVfkaFHitfrRdvmXBXDLC+s4FcFb75oaAmxPAj2FeEEwRRaVv0/jXhiaPqsHl92OdY2xiRVHkZsMM=
-```
-1. Navigate to "SNM-I Repo Setting" -> "Security" -> "Secrets and variables" -> "Actions" -> ["Variables"](https://github.com/csse-uoft/SNM-I/settings/variables/actions).
-1. Click "New repository variable"
-1. Set the name to `RELEASE_SSH_KNOWN_HOSTS` and copy the whole line to the secret field.
+1. Set the name to `BETA_SSH_PRIVATE_KEY` and copy the whole private key to the secret field.
 
-#### Set up ssh port forwarding on **Reverse Proxy Server**
+
+
+## Reverse Proxy Server Setup
+
+### Set up ssh port forwarding on **Reverse Proxy Server**
 > The following command should be executed on the reverse proxy server.
 Consider the following setup:
 ```text
@@ -93,30 +157,61 @@ Add `net.ipv4.ip_forward = 1` to the bottom. Apply the change.
 sysctl -p
 ```
 
-
 Add `PREROUTING` and `POSTROUTING` rules to `iptables`:
 ```shell
 # ens3 is the network interface that has the public ip
 # Forward all requests of 206.12.97.46:14572 to 192.168.41.202:22
 sudo iptables -t nat -A PREROUTING -i ens3 -p tcp --dport 14572 -j DNAT --to-destination 192.168.41.202:22
-sudo iptables -t nat -A POSTROUTING -p tcp --dport 22 -j SNAT --to-source 192.168.41.156
+sudo iptables -t nat -A POSTROUTING -d 192.168.41.202 -p tcp --dport 22 -j SNAT --to-source 192.168.41.156
 ```
 Make the iptables config persistent.
 ```shell
 sudo apt update && sudo apt install iptables-persistent
+sudo sh -c '/sbin/iptables-save > /etc/iptables/rules.v4'
+```
+### Setup Caddy Reverse Proxy
+```text
+beta.socialneedsmarketplace.ca {
+    handle /api* {
+        reverse_proxy 192.168.41.202:5000
+    }
+    reverse_proxy 192.168.41.202:80
+}
 ```
 
-#### Set Other Variables
+### Add DNS Record
+```text
+Host name                       Type  TTL       Data
+beta.socialneedsmarketplace.ca  A     1 hour    206.12.97.46
+```
+
+## Set Other Variables
 Add the following Variables as well according to how you ssh to the remote server by using port forwarding:
-- `RELEASE_SSH_HOST`: 206.12.97.46
-- `RELEASE_SSH_PORT`: 14572
-- `RELEASE_SSH_USER`: ubuntu
+- `BETA_SSH_HOST`: 206.12.97.46
+- `BETA_SSH_PORT`: 14572
+- `BETA_SSH_USER`: ubuntu
 
-### Add GitHub Workflow
-https://github.com/csse-uoft/SNM-I/blob/master/.github/workflows/release.yml
+### Set `BETA_SSH_KNOWN_HOSTS`
+If the ssh port forward is correctly configured, you can generate the `known_hosts` by:
+```shell
+ssh-keyscan -p 14572 -t ecdsa-sha2-nistp256 206.12.97.46
+```
+Output (The second line is `BETA_SSH_KNOWN_HOSTS`)
+```text
+# 206.12.97.46:14572 SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.6
+[206.12.97.46]:14572 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBBxpcp7MHTdVfkaFHitfrRdvmXBXDLC+s4FcFb75oaAmxPAj2FeEEwRRaVv0/jXhiaPqsHl92OdY2xiRVHkZsMM=
+```
+1. Navigate to "SNM-I Repo Setting" -> "Security" -> "Secrets and variables" -> "Actions" -> ["Variables"](https://github.com/csse-uoft/SNM-I/settings/variables/actions).
+1. Click "New repository variable"
+1. Set the name to `BETA_SSH_KNOWN_HOSTS` and copy the whole line to the secret field.
+
+
+## Add GitHub Workflow
+https://github.com/csse-uoft/SNM-I/blob/master/.github/workflows/beta.yml
 Remember to change the branch name:
 ```yml
 on:
   push:
-    branches: [ master ]
-```
+    branches: [ beta ]
+...
+```

frontend/src/api/providersApi.js

@@ -26,3 +26,7 @@ export async function searchMultipleProviders(searchitem) {
 export async function deleteSingleProvider(id) {
   return deleteJson(`/api/providers/${id}`);
 }
+
+export async function fetchHomeServiceProvider() {
+  return getJson(`/api/providers/home`);
+}