Skip to content

Latest commit

 

History

History
193 lines (151 loc) · 6.05 KB

README.md

File metadata and controls

193 lines (151 loc) · 6.05 KB

HMPPS Visit Scheduler API

CircleCI

This is a Spring Boot application, written in Kotlin, providing visit schedule information. Used by Visit Someone in Prison.

Posted event Specification Event docs

Building

To build the project (without tests):

./gradlew clean build -x test

Testing

Run:

./gradlew test

Running

Create a Spring Boot run configuration with active profile of dev/local, to run against te development environment.

Alternatively the service can be run using docker-compose with client 'book-a-prison-visit-client' and the usual dev secret.

docker-compose up -d

or for particular compose files

docker-compose -f docker-compose-local.yml up -d

Ports

Service Port
visit-scheduler 8080
visit-scheduler-db 5432
hmpps-auth 8090
prison-api 8091

To create a Token (local):

curl --location --request POST "http://localhost:8081/auth/oauth/token?grant_type=client_credentials" --header "Authorization: Basic $(echo -n {Client}:{ClientSecret} | base64)"

Call info endpoint:

$ curl 'http://localhost:8080/info' -i -X GET

Swagger v3

Visit Scheduler

http://localhost:8080/swagger-ui/index.html

Export Spec

http://localhost:8080/v3/api-docs?group=full-api

Application Tracing

The application sends telemetry information to Azure Application Insights which allows log queries and end-to-end request tracing across services

Application Insights Events

Show all significant prison visit events

customEvents 
| where cloud_RoleName == 'visit-scheduler' 
| where name startswith "visit-scheduler-prison" 
| summarize count() by name

Available custom events

  • session-template-created - a session template was created. It will contain the template id

  • session-template-deleted - a session template was deleted. It will contain the template id

  • visit-slot-reserved - a visit slot was reserved. It will contain the visit's application reference and basic information about the visit

  • visit-slot-changed - a visit change was started. It will contain the visit's application reference, reference and status

  • visit-changed - a booked visit was being changed. It will contain the visit's application reference, reference and basic information about the visit

  • visit-booked - a visit was booked. It will contain the visit's application reference, reference, status and an isUpdated flag to denote if it's a new or an updated visit

  • visit-expired-visits-deleted - expired visits were deleted. It will contain the list of expired application references that were deleted

  • visit-cancelled - a visit was cancelled. It will contain the visit's reference, status and outcome status

  • visit-migrated - a visit was migrated. It will contain the visit's reference and basic information about the visit

  • visit.booked-event - indicates a visit booked event was published. It will contain the message id and visit reference

  • visit.cancelled-event - indicates a visit cancelled event was published. It will contain the message id and visit reference

  • visit-publish-event-error - indicates publish visit event failed. It will contain the available exception message and cause

  • visit-access-denied-error - Access Denied Error. It will contain the available exception message and cause

  • visit-bad-request-error - Bad Request Error. It will contain the available exception message and cause

  • visit-internal-server-error - Internal Error. It will contain the available exception message and cause

customEvents 
| where cloud_RoleName == 'visit-scheduler' 
| where name == 'visit-migrated'
| extend reference_ = tostring(customDimensions.reference)
| extend prisonerId_ = tostring(customDimensions.prisonerId)
| extend visitStatus_ = tostring(customDimensions.visitStatus)
Example queries

Requests

requests 
| where cloud_RoleName == 'visit-scheduler' 
| summarize count() by name

Performance

requests
| where cloud_RoleName == 'visit-scheduler' 
| summarize RequestsCount=sum(itemCount), AverageDuration=avg(duration), percentiles(duration, 50, 95, 99) by operation_Name // you can replace 'operation_Name' with another value to segment by a different property
| order by RequestsCount desc // order from highest to lower (descending)

Charts

requests
| where cloud_RoleName == 'visit-scheduler' 
| where timestamp > ago(12h) 
| summarize avgRequestDuration=avg(duration) by bin(timestamp, 10m) // use a time grain of 10 minutes
| render timechart

Common gradle tasks

To list project dependencies, run:

./gradlew dependencies

To check for dependency updates, run:

./gradlew dependencyUpdates --warning-mode all

To run an OWASP dependency check, run:

./gradlew clean dependencyCheckAnalyze --info

To upgrade the gradle wrapper version, run:

./gradlew wrapper --gradle-version=<VERSION>

To automatically update project dependencies, run:

./gradlew useLatestVersions

Ktlint Gradle Tasks

To run Ktlint check:

./gradlew ktlintCheck

To run Ktlint format:

./gradlew ktlintFormat

To apply ktlint styles to intellij

./gradlew ktlintApplyToIdea

To register pre-commit check to run Ktlint format:

./gradlew ktlintApplyToIdea addKtlintFormatGitPreCommitHook

...or to register pre-commit check to only run Ktlint check:

./gradlew ktlintApplyToIdea addKtlintCheckGitPreCommitHook

Build checks

To run the CircleCI trivy scan locally download and install trivy, build the visit-scheduler docker image and run:

trivy image visit-scheduler_visit-scheduler