Skip to content

Latest commit

 

History

History
338 lines (241 loc) · 13.1 KB

README.md

File metadata and controls

338 lines (241 loc) · 13.1 KB
Raw

cjms

Coverage Status Security audit

Micro-service supporting VPN activities

Endpoints

AIC - Affiliate Identifier Cookie

/aic:

  • POST only
  • Accepts: JSON data with flow_id (required), cj_id (required)
  • Returns: JSON data with aic_id, expires (a timestamp)
  • A cookie should then be set with the stated expiration time and the returned aic_id
  • Success - 201
  • All errors - 500

/aic/<aicID> endpoint:

  • PUT only
  • Accepts: JSON data with flow_id (required), cj_id (optional)
  • Returns: JSON data with aic_id, expires (a timestamp)
  • A cookie should then be set with the stated expiration time and the returned aic_id
  • Success - 201
  • Unknown aicID - 404
  • All other errors - 500

Settings

The required settings are listed in settings.yaml.example. There may be other local setting needs (see "Auto-magic behavior based on environment" below).

  • aic_expiration_days: How long for an aic cookie to expire
  • authentication: Used for basic_auth on the the corrections detail page
  • cj_api_access_token: For CJ querying
  • cj_cid: For CJ S2S configuration
  • cj_sftp_user: For CJ corrections
  • cj_signature: For CJ S2S configuration
  • cj_subid: For CJ corrections
  • cj_type: For CJ S2S configuration
  • database_url: the database url for connecting to postgres database
  • environment: the environment (see "Auto-magic behavior based on envrionment" below)
  • gcp_project: the gcp project where the big query data lives that the check_subscriptions binary pulls from
  • host: the host the web service runs on
  • log_level: The lowest priority log level that is logged to the output sink. Value can be one of error, warn, info, debug, or trace.
  • port: the port the web service runs on
  • sentry_dsn: The DSN identifier for the Sentry instance
  • sentry_environment: The environment passed to Sentry. Should be the same as environment.
  • statsd_host: The host of the statsd server.
  • statsd_port: The port of the statsd server.

Development pre-requisites

Rust

https://www.rust-lang.org/tools/install

We use clippy and fmt which can be added with rustup component add clippy rustfmt.

Many optional utilities are useful when developing cjms and can be installed with cargo install. e.g. cargo install cargo-edit adds the ability to add dependencies to the project by running cargo add <name of package>. Consider the following additions:

  • cargo-edit
  • cargo-audit
  • cargo-tarpaulin
  • cargo-udeps (requires nightly compiler toolchain)

I have found the VSCode extension rust-analyzer to give me the richest experience while developing.

Postgres

https://www.postgresql.org/docs/14/index.html

  • Have postgres running on your machine.
  • Know your database url postgres://${DB_USER}:${DB_PASSWORD}@localhost:${DB_PORT}/${DB_NAME}
  • The user will need permission to create databases (at a minimum, used by integration tests) - ALTER USER username CREATEDB;
  • Install sqlx-cli cargo install sqlx-cli
  • If needed create your database sqlx database create --database-url="<database url>"

When adding migrations, create reversible migrations using sqlx migrate add -r <name>.

Run server

You can configure cjms and tests either with environment variables or a settings file.

To use a settings file, copy settings.yaml.example to settings.yaml and update with your local settings values. You will also need a version.yaml which can be made by running cargo run --bin make_version_file.

Then run the server:

cargo run --bin web

If configuring with environment variables, all variables, listed in settings.yaml.example must be available.

Auto-magic behavior based on environment

Valid values for environment are: local | dev | stage | prod.

  • If using local, you must have BQ_ACCESS_TOKEN set in your environment when running bins that access big query.
  • CORS changes based on environment (see appconfig)

Run tests

With nextest

We have a few flaky tests due to the challenges of mocking time in rust.

Nextest makes your tests run faster and does automatic retries.

Install nextest: https://nexte.st/book/pre-built-binaries.html

Run tests with nextest: cargo nextest run

Without nextest

cargo test

Integration tests go under tests folder, unit tests go into associated files under src.

Test databases

Running the integration tests will cause lots of test databases with the prefix <your_db_name>_test_<random id> to be created in your local database. If you want to remove them, you can use a bash script along the lines of:

for db in `psql -U cjms -c '\l' | grep cjms_test_ | cut -d '|' -f 1`; do psql -U cjms -c "drop database \"$db\" "; done

In this case my db_name is cjms and my user is cjms and my password is in the environment variables export PGPASSWORD=<>.

Tips

VSCode Settings

{
	"files.trimTrailingWhitespace": true,
	"files.insertFinalNewline": true,
    "rust-analyzer.diagnostics.disabled": [
        "unresolved-macro-call"
    ]
}

Git hooks

To save time in CI, add a pre-commit or pre-push git hook locally that runs, at least, clippy and fmt.

For example, in .git/hooks/ copy pre-push.sample to pre-push. Update the file, so that the end of the file reads:

if ! cargo fmt -- --check; then
    exit 1
fi
if ! cargo clippy --all-targets --all-features -- -D warnings; then
    exit 1
fi
if ! cargo sqlx prepare --check -- --bin cjms; then
    exit 1
fi

exit 0

Note: I've found the cargo sqlx prepare check to not work as expected for me and always suggest that a new prepare is needed :(

Working with sqlx

In general, be mindful of the difference between compile time checks and running the app.

sqlx does compile time checks. For these to work one of two things has to be true:

  • There is a DATABASE_URL in the environment pointing to a database that is fully migrated
  • There is NOT a DATABASE_URL in the environment and then sqlx-cli will run in "offline" mode and use sqlx-data.json.

sqlx does some implicit things looking for the DATABASE_URL in your environment, which includes looking for a .env file. If things aren't working as expected make sure you don't have a rogue .env file or environment variables.

Writing new queries

It took me a long time to figure out the mechanics of working with sqlx. Here's the key points:

  • We want to use the macro functions like query_as! so that we get compile time checks as we're developing.
  • They require DATABASE_URL to be in the environment. Either exposed in the environment or in a .env file.
  • This works by sqlx connecting to a live database to check the queries at compile time. So the database that's listed in your DATABASE_URL must be available and migrated to the latest migrations as needed. This is not the same as the dynamically generated test databases.
  • However, in CI where the final compile will happen this won't be the case, so we use sqlx's offline mode. This works by running a command that generates the necessary data into sqlx-data.json. This can then be used at compile time instead of the database being available.
  • The command cargo sqlx prepare -- --bin cjms will auto generate sqlx-data.json for you (make sure DATABASE_URL is available).
  • But, it only runs against one target so sql queries in the integration tests do not work. So, I've established a pattern where all sql queries as functions in the relevant model and the integration tests call functions on the model. While this is somewhat polluting production code with test code it was the best tradeoff I could find.

The general steps that I took:

  • Add a .env file with my database url
  • Run sqlx migrate run and sometimes sqlx migrate revert (and then run) to get my database correctly migrated
  • Once everythings working as expected, run cargo sqlx prepare -- --bin cjms to update sqlx-data.json. If you don't CI will fail at compile time so this should be fairly easy to spot.

Links to sqlx cli information including offline mode https://github.com/launchbadge/sqlx/blob/v0.5.11/sqlx-cli/README.md.

If you have forgotten to prepare, CI will fail with error messages like:

Failed to compile tests! Error: cjms: failed to find data for query UPDATE aic
            SET flow_id = $1
            WHERE id = $2
			RETURNING *
Error: "Failed to compile tests! Error: cjms: failed to find data for query UPDATE aic\n            SET flow_id = $1\n            WHERE id = $2\n\t\t\tRETURNING *"

or

error: failed to find data for query UPDATE aic
                   SET flow_id = $1
                   WHERE id = $2
                   RETURNING *
  --> src/models/aic.rs:40:9
   |
40 | /         query_as!(
41 | |             AIC,
42 | |             r#"UPDATE aic
43 | |             SET flow_id = $1
...  |
47 | |             id,
48 | |         )
   | |_________^
   |
   = note: this error originates in the macro `$crate::sqlx_macros::expand_query` (in Nightly builds, run with -Z macro-backtrace for more info)

Version compatibility

One thing that took me a while to figure out was I was using sqlx features like "time" or "uuid" but I was getting error messages like expected struct sqlx::types::time::OffsetDateTime, found struct time::OffsetDateTime. This was confusing because I was using the modules as documented and the whole point is that these types become magically compatible.

In both cases the reason was because the versions of time and uuid that I had installed were ahead of what sqlx currently supports. This meant that the, I think, trait implementations for them to interoperate weren't present.

Working with logs and metrics

The telemetry module contains utilities for writing out logs and metrics. The most common pattern we use it to use a macro that writes out a log with a pre-defined key, while at the same time incrementing a statsd counter with the same name. The name of the log key should be a known value in the LogKey macro.

For example:

info_and_incr!(
    StatsD::new(&settings),
    LogKey::CleanupAicArchive,
    key = "value",
    "Some log message"
)

The value of the LogKey enum will be stringified to kebab case before it is sent to the logger and statsd. Additionally statsd adds a project prefix. So for this example, the final result will be to write a Mozlog-compatible log message to stdout with a type value of cleanup-aic-archive, and increment a statsd counter with the name cjms.cleanup-aic-archive.

Running a local statsd client

If configured using the defaults from settings.yaml.example, the statsd client will send metrics to a statsd server on localhost at UDP port 8125. Since statsd doesn't actually check if the metrics have been received by the server, this will work even if you don't have a local statsd server configured. However, it is trivial to run statsd and graphite locally for debugging purposes. A Docker container can be run using the following command:

docker run -d \
 --name graphite \
 --restart=always \
 -p 80:80 \
 -p 2003-2004:2003-2004 \
 -p 2023-2024:2023-2024 \
 -p 8125:8125/udp \
 -p 8126:8126 \
 graphiteapp/graphite-statsd

The graphite server is exposed at localhost:80.

Deployment

Service is deployed using docker containers.

Install docker.

To build, for example

docker build -t cjms:latest .

To run, set environment variables (can be done with a file) and forward ports e.g.

docker run -e HOST=0.0.0.0 -e PORT=8484 -p 8484:8484 cjms:latest

Version numbers

Pre 1.0

Version numbers will increment 0.1, 0.2 etc as pre-releases as we work towards launch.

1.0+

Version numbering will follow the guardian schema:

  • version numbers will increase v1.1, v1.2 etc
  • in emergency situations a minor release e.g. v1.2.1 will be made for a patch release
  • release candidates will have a "b" suffix e.g. ahead of v1.1 release we will push v1.1.b1, v1.1.b2 to staging for QA to review

2.0+

A major version bump from 1.x to 2.x would happen in the case of a breaking change to APIs we provide.

For CJMS, this is unlikely to happen.

Release, branching, and merging

Pre 1.0

All development will happen against main

1.0+

main should reflect the state of production code.

At the start of a new development cycle a release branch is made and development continues against that branch. A draft PR is opened that proposes a merge of the whole release branch into main. The supports the following workflow elements:

  • The test suite reviews the complete set of changes in the release branch
  • The release PR should only be merged after QA sign-off and the QA report should be linked in the commit
  • If a patch release is needed, make a new release branch off main and when completed cherry pick into the active release branch

PRs should be squash merged into the release branch.

Release branch should be merged with a merge commit into main.