Test file sharing

.github/workflows/ci.yml → .github/workflows/backend.yml

@@ -1,16 +1,18 @@
-name: Build and Test
+name: Backend
 on:
   pull_request:
-    types: [ opened, synchronize, reopened, closed ]
+    types: [opened, synchronize, reopened, closed]
     branches:
       - main
+      - prod
     paths:
-      - 'application/backend/**'
+      - "application/backend/**"
   push:
     branches:
       - main
+      - prod
     paths:
-      - 'application/backend/**'
+      - "application/backend/**"
 jobs:
   build-and-test:
     runs-on: ubuntu-latest

.github/workflows/frontend.yml

@@ -0,0 +1,33 @@
+name: Frontend
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    branches:
+      - main
+      - prod
+    paths:
+      - "application/frontend/**"
+  push:
+    branches:
+      - main
+      - prod
+    paths:
+      - "application/frontend/**"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Set up Node 20.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          cache: "npm"
+          cache-dependency-path: application/frontend/package-lock.json
+      - name: Install dependencies
+        working-directory: application/frontend
+        run: npm ci
+      - name: Build
+        working-directory: application/frontend
+        run: npm run build:production

.github/workflows/next-frontend.yml

@@ -0,0 +1,59 @@
+name: Next Frontend
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    branches:
+      - main
+      - prod
+    paths:
+      - "application/next-frontend/**"
+  push:
+    branches:
+      - main
+      - prod
+    paths:
+      - "application/next-frontend/**"
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Set up Node 20.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          cache: "npm"
+          cache-dependency-path: application/next-frontend/package-lock.json
+      - name: Install dependencies
+        working-directory: application/next-frontend
+        run: npm ci
+      - name: Linting
+        working-directory: application/next-frontend
+        run: npm run lint
+      - name: Typechecking
+        working-directory: application/next-frontend
+        run: npm run typecheck
+
+  # Test that the project compiles
+  test-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Set up Node 20.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          cache: "npm"
+          cache-dependency-path: application/next-frontend/package-lock.json
+      - name: Install dependencies
+        working-directory: application/next-frontend
+        run: npm ci
+      - name: Build
+        working-directory: application/next-frontend
+        run: npm run build
+        env:
+          # Prevents the build from failing, but doesn't do anything when testing build
+          NEXT_PUBLIC_BACKEND_URI: http://somerandomurl.test

.github/workflows/versioning.yml

@@ -5,50 +5,38 @@ on:
       - closed
     branches:
       - main
+      - prod
     paths:
       - application/**
       - infrastructure/**
       - .github/workflows/versioning.yml
 jobs:
-  build:
+  commit-version:
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: ${{ github.sha }}
-        fetch-depth: '0'
-    - name: Set up Node.js
-      uses: actions/setup-node@v3
-    - name: Install dependencies
-      run: npm install
-      working-directory: application/frontend
-    - name: Build bundle
-      run: npm run build:production
-      working-directory: application/frontend
-      env:
-        BACKEND_URI: https://api.bot.blank.pizza
-    - name: Remove build gitignore
-      run: rm public/.gitignore
-      working-directory: application/frontend
-    - uses: stefanzweifel/git-auto-commit-action@v4
-      with:
-        commit_message: Automated Build
-        branch: build
-        push_options: '--force'
-        create_branch: true
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.sha }}
+          fetch-depth: "0"
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Automated Versioning
+          branch: build
+          push_options: "--force"
+          create_branch: true
 
   create-tag:
-    needs: build
+    needs: commit-version
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: build
-        fetch-depth: '0'
+      - uses: actions/checkout@v3
+        with:
+          ref: build
+          fetch-depth: "0"
 
-    - name: Bump version and push tag
-      uses: anothrNick/github-tag-action@1.55.0
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        WITH_V: true
-        DEFAULT_BRANCH: build
+      - name: Bump version and push tag
+        uses: anothrNick/github-tag-action@1.55.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WITH_V: true
+          DEFAULT_BRANCH: build

README.md

@@ -1,8 +1,9 @@
-# pizza-app
+# PizzaBot v3
 
-![Infrastructure Diagram](https://github.com//blankoslo/Pizza.v2/blob/main/README/infrastructure.png?raw=true)
+![Infrastructure Diagram](https://github.com//blankoslo/Pizza.v3/blob/main/README/infrastructure.png?raw=true)
 
 ## Slack App Bot setup
+
 1. Go to `https://api.slack.com/apps/`
 2. Click the `Create New App` button
 3. Choose `from scratch`
@@ -13,9 +14,9 @@
 8. Click `Event Subscriptions`
 9. Turn on `Enable Events`
 10. Open `Subscribe to bot events`
-11. Add the events `file_shared` `message.channels` `message.im`  `app_uninstalled` `tokens_revoked`
+11. Add the events `file_shared` `message.channels` `message.im` `app_uninstalled` `tokens_revoked` `member_left_channel` `member_joined_channel`
 12. Click `OAuth & Permissions` in the menu
-13. Go down to `Scopes` and click `Add an OAuth Scope` and add the scopes found in `/application/backend/api/slack`'s GET `/install` method.
+13. Go down to `Scopes` and click `Add an OAuth Scope` and add the scopes found in `/application/backend/app/api/slack`'s GET `/install` method.
 14. Go to `App Home`
 15. Go down to `Show Tabs` and switch on `Messages Tab` (to allow DMs)
 16. Go to `OAuth & Permissions` under `Redirect URLs`
@@ -25,52 +26,75 @@
 20. Click `Create new command`
 21. Fill in `/set-pizza-channel` under `command`, fill in `This sets the current channel as the pizza channel` under `Short Description`
 22. Click `save`
-23. Click `Basic Information` in the menu
-24. Under App Credentials, copy `SLACK_CLIENT_ID`, `SLACK_CLIENT_SECRET`, `SLACK_SIGNING_SECRET`
-25. You now have `SLACK_APP_TOKEN`, `SLACK_CLIENT_ID`, `SLACK_CLIENT_SECRET`, `SLACK_SIGNING_SECRET` which is needed in terraform or docker-compose
+23. Add another command `/pizzabot-admin-panel` under `command`, fill in `Link for administrating the pizzabot` under `Short Description`
+24. Click `Basic Information` in the menu
+25. Under App Credentials, copy `SLACK_CLIENT_ID`, `SLACK_CLIENT_SECRET`, `SLACK_SIGNING_SECRET`
+26. You now have `SLACK_APP_TOKEN`, `SLACK_CLIENT_ID`, `SLACK_CLIENT_SECRET`, `SLACK_SIGNING_SECRET` which is needed in terraform or docker-compose
 
 ## How to run the system
 
 ### Development
+
 The frontend, backend, bot, message queue and database can all be run with docker compose by running `docker-compose up`. Optionally you can do `docker-compose up -d [service]` to only start one or more service. During development all services run behind an nginx instance to simplify their interactions. The ports are 80 and 443.
 
 As we use Ouath2 for authentication we are forced to use https. Nginx needs valid ssl certificates, so you are gonna need to generate one with the command `openssl req -x509 -nodes -newkey rsa:4096 -keyout nginx-selfsigned.key -out nginx-selfsigned.crt -sha256 -days 365` and add it to `application/containers/development`
 
-**NB:** You'll need to supply the docker-compose file with slack credentials as mention in the `Slack App Bot setup` section. You'll also need to supply cloudinary credentials if you want the uninstall handler to properly delete images, you should also update the `upload_preset` in `handle_file_share` in `bot/src/slack/__init__.py` to point to your own cloudinary account.
+**NB:** You'll need to supply the docker-compose file with slack credentials as mention in the `Slack App Bot setup` section. These are defined in a `.env` file in `application/containers/development` folder of the project. This file is not commited to the repository, so you have to create it manually. You can use the `.env.example` file as a template inside `application/containers/development`. You'll also need to supply cloudinary credentials if you want the uninstall handler to properly delete images, you should also update the `upload_preset` in `handle_file_share` in `bot/src/slack/__init__.py` to point to your own cloudinary account.
+
+### Slack integration flow
+
+For flow of how the bot is added to a slack workspace, see digram in README/InstallFlow.png
+For flow of how login is handled with Slack, see diagram in README/LoginFlow.png
 
 ### Good to know
+
+The legacy React app from PizzaBot.v2 is located in application/frontend. This is only used as a reference point for the new frontend with Next.js
+
 Locales doesnt work properly in the alpine container used, meaning it's not a bug if stuff is localized wrong, such as the time string send in pizza event invites.
 
 ### Production
+
 #### Terraform Cloud
-This repository is connected to Terraform Cloud where it is automatically planned and then manually applied whenever a new tag is created.
-The branch used in Terraform Cloud is the `Build` branch, which gets created on every new version. This branch is the same as master, but it also contains the build files for the frontend application.
-A tag is automatically created through GitHub actions when a PR is merged into Main.
+
+This repository is connected to Terraform Cloud where it is planned and then manually applied whenever a new tag is created.
+
+Prod and staging live as separate workspaces in Terraform Cloud. The branch used in Terraform Cloud is `main` for the staging environment, and `prod` for the production environment. The `prod` branch is merged from main after the staging environment is tested. Terraform is not set up to automatically listen for changes on the branches (TODO), and a manual update of the target branch might be required to plan a new version.
+
+When a planned version is applied, the changed environments are pushed to Heroku
 
 #### Heroku
+
 We are using terraform to describe the infrastructure, which can be found in the `/infrastructure` folder. In addition to this the backend/bot have `Procfile`, `runtime.txt`, and `.locales` files that describe the process, heroku runtime and additional locales to include. While the frontend have `.static` in the `public` folder to indicate the application folder for the nginx buildpacker, and a `.gitignore` file to keep the files and folder in git.
 
 1. Go into the `infrastructure` folder and run `terraform apply` (not needed if using Terraform Cloud).
-2. Go to the app settings of the frontend app in Heroku at `https://dashboard.heroku.com/apps/pizzabot-v2-stag-frontend/settings` (where the text after `/apps/` will be your app's name) and under `Domains` copy the `DNS Target`.
-3. Go to the app settings of the backend app in Heroku at `https://dashboard.heroku.com/apps/pizzabot-v2-stag-backend/settings` (where the text after `/apps/` will be your app's name) and under `Domains` copy the `DNS Target`.
-4. Create a CNAME record with the hostname specified in the main terraform file for both the frontend and the backend and point them to the `DNS TARGET`s from heroku. After a while routing and SSL should work flawlesly.
+2. Go to the app settings of the frontend app in Heroku and under `Domains` copy the `DNS Target`.
+3. Go to the app settings of the backend app in Heroku and under `Domains` copy the `DNS Target`.
+4. Create a CNAME record with the hostname specified in the main terraform file for both the frontend and the backend and point them to the `DNS TARGET`s from heroku. After a while routing and SSL should work flawlessly.
 
 Infrastructure:
-* Backend-app: contains the database, papertrail instance, Rabbitmq instance, and backend application  
-* Bot-app: contains an attachement to the database, an attachement to the papertrail instance, an attachement to the Rabbitmq instance, the bot worker
-* Frontend-app: contains a nginx instance with the build files from the `public` folder
+
+- prod/stag-backend: contains the database, papertrail instance, Rabbitmq instance, and backend application
+- prod/stag-bot: contains an attachement to the database, an attachement to the papertrail instance, an attachement to the Rabbitmq instance, the bot worker
+- prod/stag-frontend: contains source code of the Next.js-application, which is automatically detected and built by Heroku. The app is then automatically launched using by heroku with `npm run start`, where the correct port is provided with the env-var `$PORT`.
+
+**NOTE** Promoting apps from staging to prod has not been tested. We manually apply new prod and staging instances using Terraform.
 
 ## Tests
+
 ### Backend
+
 The tests for this application were written using the pytest testing framework. The tests cover the blueprints, services, and broker handlers.
 
 To run the backend tests, navigate to the backend directory of the project and run the following command:
+
 ```
 python3 -m pytest tests
 ```
+
 Optionally you can add the options `-k [name of test suit or test function]` (to only run certain tests), `-s` (to show print statements) and `-v`/`-vv` (to make tests more verbose).
 
 ### Bot
+
 TODO
 
 ## Contributing Guidelines
@@ -86,11 +110,11 @@ Please follow these guidelines when contributing to this project:
 
 ## Code of Conduct
 
-We expect all contributors to adhere to our [Code of Conduct](https://github.com/blankoslo/Pizza.v2/blob/main/CODE_OF_CONDUCT.md). Please read it before contributing.
+We expect all contributors to adhere to our [Code of Conduct](https://github.com/blankoslo/Pizza.v3/blob/main/CODE_OF_CONDUCT.md). Please read it before contributing.
 
 ## Issue Tracker
 
-If you find any issues or have feature requests, please submit them on the [issue tracker](https://github.com/blankoslo/Pizza.v2/issues).
+If you find any issues or have feature requests, please submit them on the [issue tracker](https://github.com/blankoslo/Pizza.v3/issues).
 
 ## Contact
 
@@ -100,4 +124,4 @@ Thank you for your contributions!
 
 ## License
 
-By contributing to Pizza.v2, you agree that your contributions will be licensed under the GNU General Public License v3.0 license. Please see the [LICENSE](https://github.com/blankoslo/Pizza.v2/blob/main/LICENSE) file for more information.
+By contributing to Pizza.v3, you agree that your contributions will be licensed under the GNU General Public License v3.0 license. Please see the [LICENSE](https://github.com/blankoslo/Pizza.v3/blob/main/LICENSE) file for more information.