Standardize environment variables on DOCSRS_

This changes the following env variables used in prod:

- CRATESFYI_PREFIX
- CRATESFYI_DATABASE_URL
- CRATESFYI_GITHUB_ACCESSTOKEN
- CRATESFYI_RUSTWIDE_WORKSPACE
- CRATESFYI_TOOLCHAIN
- DOCS_RS_BUILD_CPU_LIMIT

Before deploying, we should set the new names of all these variables.
After deploying, we can delete the old names.

Author: jyn514

.env.sample

@@ -1,5 +1,5 @@
-CRATESFYI_PREFIX=ignored/cratesfyi-prefix
-CRATESFYI_DATABASE_URL=postgresql://cratesfyi:password@localhost:15432
+DOCSRS_PREFIX=ignored/cratesfyi-prefix
+DOCSRS_DATABASE_URL=postgresql://cratesfyi:password@localhost:15432
 DOCSRS_LOG=docs_rs,rustwide=info
 AWS_ACCESS_KEY_ID=cratesfyi
 AWS_SECRET_ACCESS_KEY=secret_key

.github/workflows/ci.yml

@@ -58,12 +58,12 @@ jobs:
         run: |
           cp .env.sample .env
           . .env
-          mkdir -p ${CRATESFYI_PREFIX}/public-html
+          mkdir -p ${DOCSRS_PREFIX}/public-html
           docker-compose up -d db s3
           # Give the database enough time to start up
           sleep 5
           # Make sure the database is actually working
-          psql "${CRATESFYI_DATABASE_URL}"
+          psql "${DOCSRS_DATABASE_URL}"
 
       - name: run tests
         shell: bash

README.md

@@ -58,7 +58,7 @@ git clone https://github.com/rust-lang/docs.rs.git docs.rs
 cd docs.rs
 # Configure the default settings for external services
 cp .env.sample .env
-# Create the CRATESFYI_PREFIX directory
+# Create the DOCSRS_PREFIX directory
 mkdir -p ignored/cratesfyi-prefix/crates.io-index
 # Builds the docs.rs binary
 cargo build
@@ -101,7 +101,7 @@ cargo test
 ```
 
 Most tests require access to the database. To run them, set the
-`CRATESFYI_DATABASE_URL` in `.env` to the url of a PostgreSQL database,
+`DOCSRS_DATABASE_URL` in `.env` to the url of a PostgreSQL database,
 and set the `AWS_ACCESS_KEY_ID`, `S3_ENDPOINT`, and `AWS_SECRET_ACCESS_KEY` variables.
 We have some reasonable default parameters in `.env.sample`.
 
@@ -188,7 +188,7 @@ cargo run -- build crate --local /path/to/source
 cargo run -- database add-directory <DIRECTORY> [PREFIX]
 
 # Updates repository stats for crates.
-# You need to set the CRATESFYI_GITHUB_ACCESSTOKEN
+# You need to set the DOCSRS_GITHUB_ACCESSTOKEN
 # environment variable in order to run this command.
 # Set DOCSRS_GITLAB_ACCESSTOKEN to raise the rate limit for GitLab repositories,
 # or leave it blank to fetch repositories at a slower rate.
@@ -200,7 +200,7 @@ with the `psql` command.
 
 ```sh
 . .env
-psql $CRATESFYI_DATABASE_URL
+psql $DOCSRS_DATABASE_URL
 ```
 
 The database contains a blacklist of crates that should not be built.

crates/metadata/build.rs

@@ -1,7 +1,7 @@
 fn main() {
     // Set the host target
     println!(
-        "cargo:rustc-env=DOCS_RS_METADATA_HOST_TARGET={}",
+        "cargo:rustc-env=DOCSRS_METADATA_HOST_TARGET={}",
         std::env::var("TARGET").unwrap(),
     );
     // This only needs to be rerun if the TARGET changed, in which case cargo reruns it anyway.

crates/metadata/lib.rs

@@ -50,7 +50,7 @@ use toml::Value;
 /// This is directly passed on from the Cargo [`TARGET`] variable.
 ///
 /// [`TARGET`]: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts
-pub const HOST_TARGET: &str = env!("DOCS_RS_METADATA_HOST_TARGET");
+pub const HOST_TARGET: &str = env!("DOCSRS_METADATA_HOST_TARGET");
 /// The targets that are built if no `targets` section is specified.
 ///
 /// Currently, this is guaranteed to have only [tier one] targets.

docker-compose.yml

@@ -16,8 +16,8 @@ services:
             - ".rustwide-docker:/opt/docsrs/rustwide"
             - "cratesio-index:/opt/docsrs/prefix/crates.io-index"
         environment:
-            CRATESFYI_RUSTWIDE_WORKSPACE: /opt/docsrs/rustwide
-            CRATESFYI_DATABASE_URL: postgresql://cratesfyi:password@db
+            DOCSRS_RUSTWIDE_WORKSPACE: /opt/docsrs/rustwide
+            DOCSRS_DATABASE_URL: postgresql://cratesfyi:password@db
             DOCSRS_STORAGE_BACKEND: s3
             S3_ENDPOINT: http://s3:9000
             AWS_ACCESS_KEY_ID: cratesfyi

dockerfiles/entrypoint.sh

@@ -2,9 +2,9 @@
 
 set -euv
 
-export CRATESFYI_PREFIX=/opt/docsrs/prefix
-export DOCS_RS_DOCKER=true
-export DOCSRS_LOG=${DOCSRS_LOG-cratesfyi,rustwide=info}
+export DOCSRS_PREFIX=/opt/docsrs/prefix
+export DOCSRS_DOCKER=true
+export DOCSRS_LOG=${DOCSRS_LOG-"docs-rs,rustwide=info"}
 export PATH="$PATH:/build/target/release"
 
 # Try migrating the database multiple times if it fails
@@ -27,10 +27,10 @@ while true; do
 done
 set -e
 
-if ! [ -d "${CRATESFYI_PREFIX}/crates.io-index/.git" ]; then
-    git clone https://github.com/rust-lang/crates.io-index "${CRATESFYI_PREFIX}/crates.io-index"
+if ! [ -d "${DOCSRS_PREFIX}/crates.io-index/.git" ]; then
+    git clone https://github.com/rust-lang/crates.io-index "${DOCSRS_PREFIX}/crates.io-index"
     # Prevent new crates built before the container creation to be built
-    git --git-dir="$CRATESFYI_PREFIX/crates.io-index/.git" branch crates-index-diff_last-seen
+    git --git-dir="$DOCSRS_PREFIX/crates.io-index/.git" branch crates-index-diff_last-seen
 fi
 
 cratesfyi build update-toolchain --only-first-time

src/config.rs

@@ -66,16 +66,16 @@ pub struct Config {
 
 impl Config {
     pub fn from_env() -> Result<Self, Error> {
-        let prefix: PathBuf = require_env("CRATESFYI_PREFIX")?;
+        let prefix: PathBuf = require_env("DOCSRS_PREFIX")?;
 
         Ok(Self {
             build_attempts: env("DOCSRS_BUILD_ATTEMPTS", 5)?,
 
-            prefix: prefix.clone(),
             registry_index_path: env("REGISTRY_INDEX_PATH", prefix.join("crates.io-index"))?,
             registry_url: maybe_env("REGISTRY_URL")?,
+            prefix,
 
-            database_url: require_env("CRATESFYI_DATABASE_URL")?,
+            database_url: require_env("DOCSRS_DATABASE_URL")?,
             max_pool_size: env("DOCSRS_MAX_POOL_SIZE", 90)?,
             min_pool_idle: env("DOCSRS_MIN_POOL_IDLE", 10)?,
 
@@ -90,7 +90,7 @@ impl Config {
             #[cfg(test)]
             s3_bucket_is_temporary: false,
 
-            github_accesstoken: maybe_env("CRATESFYI_GITHUB_ACCESSTOKEN")?,
+            github_accesstoken: maybe_env("DOCSRS_GITHUB_ACCESSTOKEN")?,
             github_updater_min_rate_limit: env("DOCSRS_GITHUB_UPDATER_MIN_RATE_LIMIT", 2500)?,
 
             gitlab_accesstoken: maybe_env("DOCSRS_GITLAB_ACCESSTOKEN")?,
@@ -106,12 +106,12 @@ impl Config {
 
             csp_report_only: env("DOCSRS_CSP_REPORT_ONLY", false)?,
 
-            rustwide_workspace: env("CRATESFYI_RUSTWIDE_WORKSPACE", PathBuf::from(".workspace"))?,
-            inside_docker: env("DOCS_RS_DOCKER", false)?,
-            docker_image: maybe_env("DOCS_RS_LOCAL_DOCKER_IMAGE")?
+            rustwide_workspace: env("DOCSRS_RUSTWIDE_WORKSPACE", PathBuf::from(".workspace"))?,
+            inside_docker: env("DOCSRS_DOCKER", false)?,
+            docker_image: maybe_env("DOCSRS_LOCAL_DOCKER_IMAGE")?
                 .or(maybe_env("DOCSRS_DOCKER_IMAGE")?),
-            toolchain: env("CRATESFYI_TOOLCHAIN", "nightly".to_string())?,
-            build_cpu_limit: maybe_env("DOCS_RS_BUILD_CPU_LIMIT")?,
+            toolchain: env("DOCSRS_TOOLCHAIN", "nightly".to_string())?,
+            build_cpu_limit: maybe_env("DOCSRS_BUILD_CPU_LIMIT")?,
             include_default_targets: env("DOCSRS_INCLUDE_DEFAULT_TARGETS", true)?,
             disable_memory_limit: env("DOCSRS_DISABLE_MEMORY_LIMIT", false)?,
         })