OpenConext-Teams-NG

License

See the LICENSE file

Disclaimer

See the NOTICE file

System Requirements

• Java 21
• Maven 3
• MySQL 8
• node v14.17.3 (use for example nvm use to manage it - latest version of node does not work)
• yarn (note that later versions break the sass compiler)

If you use nvm ensure you have the correct npm installed locally in that version

cd ~/.nvm/versions/node/v6.2.2/lib/
npm install [email protected]

See https://stackoverflow.com/questions/9755841/how-can-i-change-the-version-of-npm-using-nvm

Building and running

Maven 3 is needed to build and run this project.

To build, first setup your local db:

Connect to your local mysql database: mysql -uroot

Execute the following:

DROP DATABASE IF EXISTS teams_ng;
CREATE DATABASE teams_ng CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci;

The teams-server

To run locally:

mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Dspring.profiles.active=dev,test"

Or run / debug the TeamsApplication and don't forget to set the active profile to dev otherwise the application uses the real VOOT client on the test environment.

The teams-gui

cd teams-gui

Initial setup if you do:

yarn install

Add new dependencies to devDependencies:

yarn add ${dep} --dev

To build:

./build.sh

To run locally:

yarn local

Browse to the application homepage.

Testing

To run the tests, just install both server and client:

mvn clean install

To run only the JS tests:

cd teams-gui
yarn test

Miscellaneous

If you add dependencies to the teams-gui with yarn you can see the impact on the production bundle:

cd teams-gui
rm -fr dist && yarn webpack-analyze | sed '1,6d' | sed '$d' | webpack-bundle-size-analyzer

API

The teams application has three API's:

1. Internal Teams API on api/teams for the teams GUI
2. VOOT API on api/voot for the VOOT server app
3. LifeCycle user management

The first one is secured with shibboleth and CSRF and the second and third one are secured with basic auth. For an example call:

curl  -u voot:secret https://teams.demo.openconext.org/api/voot/user/urn:collab:person:example.com:admin/groups  

LifeCycle Deprovisioning

Teams has a LifeCycle API to deprovision users. The preview endpoint:

curl -u life:secret http://localhost:8080/deprovision/urn:collab:person:surfnet.nl:jdoe | jq 

And the actual Deprovisioning of the user:

curl -X DELETE -u life:secret http://localhost:8080/deprovision/urn:collab:person:surfnet.nl:jdoe | jq

Migration to Invite

Teams GUI has functionality to migrate a team to the invite-database. You need to be super-user for this. There is also an endpoint to migrate teams:

curl -u teams:secret -X PUT -H 'Content-Type: application/json' -d '{"id":"35415"}'  "http://localhost:8080/api/v1/external/invite-app/migrate"