palvelutarjotin-admin

Staff interface for Palvelutarjotin

Environments

Production environment:

https://kultus-admin.hel.fi/
Triggered by creation of release-* tag, e.g. release-v0.1.0
- Needs to be manually approved in pipeline to be deployed

Staging environment:

https://kultus-admin-ui.stage.hel.ninja/
Automatically deployed by creation of release-* tag, e.g. release-v0.1.0

Testing environment:

https://kultus-admin-ui.test.hel.ninja/
Automatically deployed by any change to master branch

Requirements

Node 20.x
Yarn
Git
Docker

Available Scripts

In the project directory, you can run:

`yarn dev`

Runs the app in the development mode.
Open http://localhost:3000/ to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

`yarn test:watch`

Runs the tests and watches for changes in interactive watch mode.
See the section about running tests for more information.

`yarn test:changed`

Run tests against uncommitted changes (including staged and unstaged).

`yarn test:staged`

Run tests against staged changes, used in husky git commit hook.

`yarn test:coverage`

Run tests and generate coverage report

`yarn ci`

Run tests and generate coverage report, meant for Continuous Integration (CI) pipeline use.

`yarn test:debug`

Debug tests

`yarn browser-test`

Run TestCafe browser tests, meant for development use.

`yarn browser-test:ci`

Run TestCafe browser tests, meant for Continuous Integration (CI) pipeline use.

`yarn build`

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

`yarn codegen`

Codegen settings in codegen.yml

Generate static types for GraphQL queries by using the schema from the backend server. url to backend server is defined to VITE_APP_API_URI in .env.development.local
Generate react hooks for GraphQL queries from query.ts and mutation.ts files.

Versioning

This project uses Release Please with Conventional Commits and Semantic Versioning.

To create a new release, merge changes through a pull request to the master branch with commit title starting with:

"feat" (raises minor version in major.minor.patch version number)
"fix" (raises patch version in major.minor.patch version number)
"feat!" (raises major version in major.minor.patch version number)
"fix!" (raises major version in major.minor.patch version number)

And then merge the release-please pull request that should've been created by the release-please action having been run in GitHub.

Browser tests

Browser tests are written in TypeScript with TestCafe framework.

Setting up development environment locally with docker

Set tunnistamo hostname

Add the following line to your hosts file (/etc/hosts on mac and linux):

127.0.0.1 tunnistamo-backend

Create a new OAuth app on GitHub

Go to https://github.com/settings/developers/ and add a new app with the following settings:

Application name: can be anything, e.g. local tunnistamo
Homepage URL: http://tunnistamo-backend:8000
Authorization callback URL: http://tunnistamo-backend:8000/accounts/github/login/callback/

Save. You'll need the created Client ID and Client Secret for configuring tunnistamo in the next step.

Install local tunnistamo

Clone https://github.com/City-of-Helsinki/tunnistamo/.

Follow the instructions for setting up tunnistamo locally. Before running docker-compose up set the following settings in tunnistamo roots docker-compose.env.yaml:

SOCIAL_AUTH_GITHUB_KEY: Client ID from the GitHub OAuth app
SOCIAL_AUTH_GITHUB_SECRET: Client Secret from the GitHub OAuth app

To get silent renew to work locally you also need to set:

ALLOW_CROSS_SITE_SESSION_COOKIE=True
- NOTE: Using this breaks login to Django admin interface, see tunnistamo issue #269.
- By leaving out the ALLOW_CROSS_SITE_SESSION_COOKIE=True or setting it to False, you can login to Django admin interface but silent renew will not work.

After you've got tunnistamo running locally, ssh to the tunnistamo docker container:

docker-compose exec django bash

and execute the following four commands inside your docker container:

./manage.py add_oidc_client -n palvelutarjotin-admin -t "id_token token" -u "http://localhost:3000/callback" "http://localhost:3000/silent-callback" -i https://api.hel.fi/auth/palvelutarjotin-admin -m github -s dev
./manage.py add_oidc_client -n palvelutarjotin-api -t "code" -u http://localhost:8081/return -i https://api.hel.fi/auth/palvelutarjotin -m github -s dev -c
./manage.py add_oidc_api -n palvelutarjotin -d https://api.hel.fi/auth -s email,profile -c https://api.hel.fi/auth/palvelutarjotin
./manage.py add_oidc_api_scope -an palvelutarjotin -c https://api.hel.fi/auth/palvelutarjotin-admin -n "Palvelutarjotin Admin" -d "Lorem ipsum"

Also add http://localhost:3000/ to Post Logout Redirect URIs of palvelutarjotin-admin client on Tunnistamo Django admin http://tunnistamo-backend:8000/admin/oidc_provider/client/

Install Palvelutarjotin GraphQl server locally

Clone the palvelutarjotin repository and follow the instructions for running palvelutarjotin with docker. Before running docker-compose up set the following settings in palvelutarjotin root's docker-compose.env.yaml:

DEBUG=1
CORS_ORIGIN_ALLOW_ALL=1
APPLY_MIGRATIONS=1
TOKEN_AUTH_AUTHSERVER_URL=http://tunnistamo-backend:8000/openid

If you do not have a super user / admin to administrate the API yet, you can create one with docker compose run django python manage.py add_admin_user -u admin -p admin -e admin@example.com.