digital-blueprint/relay-checkin-bundle

Symfony bundle to handle check-ins to places and contact tracing for warning about COVID-19 cases.

DbpRelayCheckinBundle

GitHub | Packagist | Frontend Application | Check-in Website

This bundle handles check-ins to places and contact tracing for warning about COVID-19 cases.

You will need to install and set up the Digital Blueprint fork of CampusQR, the open source system for contact tracing at universities.

See Check-in Website for more information.

There is a corresponding frontend application that uses this API at Check-in Frontend Application.

Bundle installation

You can install the bundle directly from packagist.org.

composer require dbp/relay-checkin-bundle

Integration into the Relay API Server

• Add the bundle to your config/bundles.php in front of DbpRelayCoreBundle:

...
Dbp\Relay\CheckinBundle\DbpRelayCheckinBundle::class => ['all' => true],
Dbp\Relay\CoreBundle\DbpRelayCoreBundle::class => ['all' => true],
];

• Run composer install to clear caches

Configuration

The bundle has a campus_qr_url and a campus_qr_token configuration value that you can specify in your app, either by hardcoding it, or by referencing an environment variable.

For this create config/packages/dbp_relay_checkin.yaml in the app with the following content:

dbp_relay_checkin:
  campus_qr_url: 'https://campusqr.your.domain'
  # campus_qr_url: '%env(CAMPUS_QR_URL)%'
  campus_qr_token: 'secret token'
  # campus_qr_token: '%env(CAMPUS_QR_TOKEN)%'

If you were using the DBP API Server Template as template for your Symfony application, then the configuration file should have already been generated for you.

To handle locking you need to configure locking in the core bundle.

You also need to configure the Symfony Messenger in the core bundle to check out guests after a certain amount of time.

For more info on bundle configuration see https://symfony.com/doc/current/bundles/configuration.html.

Roles

This bundle needs the roles ROLE_SCOPE_LOCATION-CHECK-IN and ROLE_SCOPE_LOCATION-CHECK-IN-GUEST assigned to the user to get permissions for the api.

relay-checkin-bundle's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Detected empty commit - aborting git push

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): lock file maintenance

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

• fix(deps): update all non-major dependencies (patch) (dbp/relay-base-person-bundle, dbp/relay-core-bundle, friendsofphp/php-cs-fixer, phpstan/phpstan)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all non-major dependencies (minor) (friendsofphp/php-cs-fixer, phpstan/phpstan, phpstan/phpstan-phpunit, phpstan/phpstan-symfony)

Detected dependencies

composer

composer.json

• php >=8.1
• api-platform/core ^2.7.11 || ^3.2
• dbp/relay-base-person-bundle ^0.2.28
• dbp/relay-core-bundle ^0.1.153
• guzzlehttp/guzzle ^7.0
• kevinrob/guzzle-cache-middleware ^3.3 || ^4.0 || ^5.0
• league/uri ^6.4 || ^7.4
• symfony/framework-bundle ^5.4 || ^6.4
• symfony/lock ^5.4 || ^6.4
• symfony/messenger ^5.4 || ^6.4
• league/uri-interfaces ^2.3.0 || ^7.4.0
• psr/http-message ^1.0 || ^2.0
• symfony/http-kernel ^5.4 || ^6.4
• symfony/dependency-injection ^5.4 || ^6.4
• symfony/config ^5.4 || ^6.4
• symfony/http-foundation ^5.4 || ^6.4
• psr/log ^1.1.4 || ^2.0.0 || ^3.0.0
• friendsofphp/php-cs-fixer ^3.50
• phpstan/phpstan ^1.10.59
• phpstan/phpstan-phpunit ^1.3.16
• phpstan/phpstan-symfony ^1.3.7
• phpunit/phpunit ^9.6.17
• symfony/browser-kit ^5.4 || ^6.4
• symfony/http-client ^5.4 || ^6.4
• symfony/monolog-bundle ^3.10
• symfony/phpunit-bridge ^5.4 || ^6.4
• vimeo/psalm ^5.22.2
• symfony/monolog-bridge v5.4 || ^6.4

github-actions

.github/workflows/test.yml

• shivammathur/setup-php v2
• actions/checkout v4
• actions/cache v4
• shivammathur/setup-php v2
• actions/checkout v4
• actions/cache v4

---

• Check this box to trigger a request for Renovate to run again on this repository

Add health check for more APIs

During setup we forgot to give the API user all the required rights in the campus-qr dashboard. This made certain endpoints return 403 and was confusing.

We currently use /location/list for a health check which works without any rights.
The endpoint that failed for us was /report/listActiveCheckIns.

Ideally all checkpoints that could potentially fail due to being miss-configured should be checked.