Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 3.1 KB

README.md

File metadata and controls

72 lines (51 loc) · 3.1 KB
Raw

Secret server

This application allows a user to store a secret key and retireve it. Additionally every key can have a maxinum number of allowed views after which it key is not available anymore. An optional expiry time for the secret can also be specified to assign TTL to it.

Usage

Running

go run . if not already compiled, ./secret-server if compiled already

Saving the key

The following curl requests adds a secret abc which allows a maximum of 5 views and has an expiry time of NOW + 5 minutes

curl --request POST \
  --url http://localhost/v1/secret \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data secret=abc \
  --data expireAfterViews=5 \
  --data expireAfter=5

secret is the actual secret text we are storing expireAfterViews specifies the maximum number of allowed views. expireAfter specified number of minutes the secret should be available for, starting from NOW. Setting the value to 0 will mean that the secret never expires

Retrieving the key

An example of retieving the token stored under 176bd4fd-c312-43bf-91f7-03bde6326e6e hash:

curl --request GET --url http://localhost/v1/secret/176bd4fd-c312-43bf-91f7-03bde6326e6e

Content type

This app is a polyglot, different content types can be asked for when talking to the server. Currently, the following are supported:

  • application/json
  • application/xml

Testing

The usual go test ./... will do the trick. Test suites were written using Gingko testing framework.

Prometheus Profiling

Prometheus-compatible profiling is under the /metrics endpoint. Apart of the standard stats, the following custom ones are present

# HELP http_PersistSecret POST /secret
# TYPE http_PersistSecret summary
http_PersistSecret{quantile="0.5"} 1135.147
http_PersistSecret{quantile="0.95"} 1221.2900000000002
http_PersistSecret{quantile="0.99"} 11313.705
http_PersistSecret_sum 53868.27700000001
http_PersistSecret_count 40
# HELP http_ViewSecret GET /secret/{hash}
# TYPE http_ViewSecret summary
http_ViewSecret{quantile="0.5"} 646.195
http_ViewSecret{quantile="0.95"} 1135.2140000000002
http_ViewSecret{quantile="0.99"} 1249.079
http_ViewSecret_sum 32707.387000000006
http_ViewSecret_count 46

Considerations

I implemented CQRS to some extent, although I did not go as far as adding domain events due to the scope of the task and the time contraints. The commands and events are clearly separated, making it easy to test and understand the business logic in the Secret domain. The limitation of such approach is that when the secret is retrieved, the stale view is created. I made the assumption that this is acceptable sacrifice command query segragation required. I also assumed that failing to deduct the number of remaining views is not critical for secret to be retrieved, it is logged but it does not stop the secret from being server to the end user.

For the same reasons, I use in memory storage for end to end testing, not Mongo.

OpenAPI spec did not specify error code for the unrecoverable runtime error, but I took the liberty to return properly formatted 500 error in such a case.