Merge branch 'master' into optimize-tool

.github/workflows/docs.yml

@@ -25,5 +25,6 @@ jobs:
           toolchain: ${{ env.RUST_TOOLCHAIN }}
       - run: cargo install snipdoc --features exec
       - run: snipdoc check
+        continue-on-error: true
         env:
           SNIPDOC_SKIP_EXEC_COMMANDS: true

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Unreleased
+
+* `loco doctor` now checks for app-specific minimum dependency versions. This should help in upgrades. `doctor` also supports "production only" checks which you can run in production with `loco doctor --production`. This, for example, will check your connections but will not check dependencies.
+* 
+
 ## v0.12.0
 
 This release have been primarily about cleanups and simplification.

Cargo.toml

@@ -55,20 +55,21 @@ sea-orm = { version = "1.1.0", features = [
 ], optional = true }
 
 tokio = { version = "1.33.0", default-features = false }
+tokio-util = "0.7.10"
 # the rest
 
 serde = { workspace = true }
 serde_json = { workspace = true }
 serde_yaml = "0.9"
 serde_variant = "0.1.2"
+toml = "0.8"
 
 
 async-trait = { workspace = true }
 
 axum = { workspace = true }
 axum-extra = { version = "0.9", features = ["cookie"] }
 regex = { workspace = true }
-lazy_static = { workspace = true }
 fs-err = "2.11.0"
 # mailer
 tera = "1.19.1"
@@ -142,7 +143,6 @@ regex = "1"
 thiserror = "1"
 serde = "1"
 serde_json = "1"
-lazy_static = "1.4.0"
 async-trait = { version = "0.1.74" }
 axum = { version = "0.7.5", features = ["macros"] }
 tower = "0.4"

DEVELOPMENT.md

@@ -1,3 +1,21 @@
+## Blessed depdenencies maintenance and `loco doctor`
+
+Loco contain a few major and "blessed" dependencies, these appear **both** in an app that was generated at the surface level in their `Cargo.toml` and in the core Loco framework.
+
+If stale, may require an upgrade as a must.
+
+Example for such dependencies:
+
+* The `sea-orm-cli` - while Loco uses `SeaORM`, it uses the `SeaORM` CLI to generate entities, and so there may be an incompatibility if `SeaORM` has a too large breaking change between their CLI (which ships separately) and their framework. 
+* `axum`
+* etc.
+
+This is why we are checking these automatically as part of `loco doctor`.
+
+We keep minimal version requirements for these. As a maintainer, you can update these **minimal** versions, only if required in [`doctor.rs`](src/doctor.rs).
+
+
+
 ## Running Tests
 
 Before running tests make sure that:

docs-site/content/docs/extras/pluggability.md

@@ -192,20 +192,13 @@ After you've implemented your own initializer, you should implement the `initial
 
 <!-- <snip id="app-initializers" inject_from="code" template="rust"> -->
 ```rust
-    async fn initializers(ctx: &AppContext) -> Result<Vec<Box<dyn Initializer>>> {
-        let mut initializers: Vec<Box<dyn Initializer>> = vec![
+    async fn initializers(_ctx: &AppContext) -> Result<Vec<Box<dyn Initializer>>> {
+        let initializers: Vec<Box<dyn Initializer>> = vec![
             Box::new(initializers::axum_session::AxumSessionInitializer),
             Box::new(initializers::view_engine::ViewEngineInitializer),
             Box::new(initializers::hello_view_engine::HelloViewEngineInitializer),
-            Box::new(loco_extras::initializers::normalize_path::NormalizePathInitializer),
         ];
 
-        if ctx.environment != Environment::Test {
-            initializers.push(Box::new(
-                loco_extras::initializers::prometheus::AxumPrometheusInitializer,
-            ));
-        }
-
         Ok(initializers)
     }
 ```

docs-site/content/docs/infrastructure/deployment.md

@@ -137,6 +137,13 @@ auth:
 ```
 <!-- </snip>-->
 
+## Running `loco doctor`
+
+You can run `loco doctor` in your server to check the connection health of your environment. 
+
+```sh
+$ myapp doctor --production
+```
 
 ## Generate
 

examples/demo/src/app.rs

@@ -42,8 +42,8 @@ impl Hooks for App {
     }
 
     // <snip id="app-initializers">
-    async fn initializers(ctx: &AppContext) -> Result<Vec<Box<dyn Initializer>>> {
-        let mut initializers: Vec<Box<dyn Initializer>> = vec![
+    async fn initializers(_ctx: &AppContext) -> Result<Vec<Box<dyn Initializer>>> {
+        let initializers: Vec<Box<dyn Initializer>> = vec![
             Box::new(initializers::axum_session::AxumSessionInitializer),
             Box::new(initializers::view_engine::ViewEngineInitializer),
             Box::new(initializers::hello_view_engine::HelloViewEngineInitializer),

examples/demo/tests/cmd/cli.trycmd

@@ -131,6 +131,8 @@ $ demo_app-cli doctor
 ✅ SeaORM CLI is installed
 ✅ DB connection: success
 ✅ redis queue: queue connection: success
+✅ Dependencies
+
 
 ```
 

examples/demo/tests/requests/notes.rs

@@ -3,7 +3,6 @@ use insta::{assert_debug_snapshot, with_settings};
 use loco_rs::testing;
 use rstest::rstest;
 use sea_orm::entity::prelude::*;
-use serde_json;
 use serial_test::serial;
 
 // TODO: see how to dedup / extract this to app-local test utils
@@ -34,7 +33,7 @@ async fn can_get_notes(#[case] test_name: &str, #[case] params: serde_json::Valu
 
         with_settings!({
             filters => {
-                 let mut combined_filters = testing::CLEANUP_DATE.to_vec();
+                 let mut combined_filters = testing::get_cleanup_date().clone();
                     combined_filters.extend(vec![(r#"\"id\\":\d+"#, r#""id\":ID"#)]);
                     combined_filters
             }
@@ -62,7 +61,7 @@ async fn can_add_note() {
 
         with_settings!({
             filters => {
-                 let mut combined_filters = testing::CLEANUP_DATE.to_vec();
+                 let mut combined_filters = testing::get_cleanup_date().clone();
                     combined_filters.extend(vec![(r#"\"id\\":\d+"#, r#""id\":ID"#)]);
                     combined_filters
             }
@@ -87,7 +86,7 @@ async fn can_get_note() {
 
         with_settings!({
             filters => {
-                 let mut combined_filters = testing::CLEANUP_DATE.to_vec();
+                 let mut combined_filters = testing::get_cleanup_date().clone();
                     combined_filters.extend(vec![(r#"\"id\\":\d+"#, r#""id\":ID"#)]);
                     combined_filters
             }
@@ -113,7 +112,7 @@ async fn can_delete_note() {
 
         with_settings!({
             filters => {
-                 let mut combined_filters = testing::CLEANUP_DATE.to_vec();
+                 let mut combined_filters = testing::get_cleanup_date().clone();
                     combined_filters.extend(vec![(r#"\"id\\":\d+"#, r#""id\":ID"#)]);
                     combined_filters
             }

loco-cli/src/messages.rs

@@ -37,7 +37,7 @@ pub fn for_options(
     match assetopt {
         AssetsOption::Clientside => res.push(format!(
             "{}: You've selected `{}` for your asset serving configuration.\n\nNext step, build \
-             your frontend:\n  $ cd {}\n  $ npm install && npm build\n",
+             your frontend:\n  $ cd {}\n  $ npm install && npm run build\n",
             "assets".underline(),
             "clientside".yellow(),
             "frontend/".yellow()

loco-gen/Cargo.toml

@@ -14,7 +14,6 @@ path = "src/lib.rs"
 
 [dependencies]
 
-lazy_static = { workspace = true }
 rrgen = "0.5.3"
 serde = { workspace = true }
 serde_json = { workspace = true }

loco-gen/src/lib.rs

@@ -2,7 +2,6 @@
 // TODO: should be more properly aligned with extracting out the db-related gen
 // code and then feature toggling it
 #![allow(dead_code)]
-use lazy_static::lazy_static;
 use rrgen::{GenResult, RRgen};
 use serde::{Deserialize, Serialize};
 use serde_json::json;
@@ -14,7 +13,7 @@ mod model;
 mod scaffold;
 #[cfg(test)]
 mod testutil;
-use std::str::FromStr;
+use std::{str::FromStr, sync::OnceLock};
 
 const CONTROLLER_T: &str = include_str!("templates/controller.t");
 const CONTROLLER_TEST_T: &str = include_str!("templates/request_test.t");
@@ -109,11 +108,13 @@ impl Mappings {
     }
 }
 
-lazy_static! {
-    static ref MAPPINGS: Mappings = {
+static MAPPINGS: OnceLock<Mappings> = OnceLock::new();
+
+fn get_mappings() -> &'static Mappings {
+    MAPPINGS.get_or_init(|| {
         let json_data = include_str!("./mappings.json");
         serde_json::from_str(json_data).expect("JSON was not well-formatted")
-    };
+    })
 }
 
 #[derive(clap::ValueEnum, Clone, Debug)]

loco-gen/src/model.rs

@@ -6,11 +6,12 @@ use rrgen::RRgen;
 use serde_json::json;
 
 use super::{Error, Result};
+use crate::get_mappings;
 
 const MODEL_T: &str = include_str!("templates/model.t");
 const MODEL_TEST_T: &str = include_str!("templates/model_test.t");
 
-use super::{collect_messages, AppInfo, MAPPINGS};
+use super::{collect_messages, AppInfo};
 
 /// skipping some fields from the generated models.
 /// For example, the `created_at` and `updated_at` fields are automatically
@@ -44,11 +45,12 @@ pub fn generate(
             // user, user_id
             references.push((fname, fkey));
         } else {
-            let schema_type = MAPPINGS.schema_field(ftype.as_str()).ok_or_else(|| {
+            let mappings = get_mappings();
+            let schema_type = mappings.schema_field(ftype.as_str()).ok_or_else(|| {
                 Error::Message(format!(
                     "type: {} not found. try any of: {:?}",
                     ftype,
-                    MAPPINGS.schema_fields()
+                    mappings.schema_fields()
                 ))
             })?;
             columns.push((fname.to_string(), schema_type.as_str()));

loco-gen/src/scaffold.rs

@@ -1,7 +1,7 @@
 use rrgen::RRgen;
 use serde_json::json;
 
-use crate as gen;
+use crate::{self as gen, get_mappings};
 
 const API_CONTROLLER_SCAFFOLD_T: &str = include_str!("templates/scaffold/api/controller.t");
 const API_CONTROLLER_TEST_T: &str = include_str!("templates/scaffold/api/test.t");
@@ -22,7 +22,7 @@ const HTML_VIEW_CREATE_SCAFFOLD_T: &str = include_str!("templates/scaffold/html/
 const HTML_VIEW_SHOW_SCAFFOLD_T: &str = include_str!("templates/scaffold/html/view_show.t");
 const HTML_VIEW_LIST_SCAFFOLD_T: &str = include_str!("templates/scaffold/html/view_list.t");
 
-use super::{collect_messages, model, AppInfo, Error, Result, MAPPINGS};
+use super::{collect_messages, model, AppInfo, Error, Result};
 
 pub fn generate(
     rrgen: &RRgen,
@@ -35,6 +35,7 @@ pub fn generate(
     // - never run with migration_only, because the controllers will refer to the
     //   models. the models only arrive after migration and entities sync.
     let model_messages = model::generate(rrgen, name, false, false, fields, appinfo)?;
+    let mappings = get_mappings();
 
     let mut columns = Vec::new();
     for (fname, ftype) in fields {
@@ -46,11 +47,11 @@ pub fn generate(
             continue;
         }
         if ftype != "references" {
-            let schema_type = MAPPINGS.rust_field(ftype.as_str()).ok_or_else(|| {
+            let schema_type = mappings.rust_field(ftype.as_str()).ok_or_else(|| {
                 Error::Message(format!(
                     "type: {} not found. try any of: {:?}",
                     ftype,
-                    MAPPINGS.rust_fields()
+                    mappings.rust_fields()
                 ))
             })?;
             columns.push((fname.to_string(), schema_type.as_str(), ftype));

loco-gen/src/templates/controller/api/test.t

@@ -2,7 +2,7 @@
 {% set module_name = file_name | pascal_case -%}
 to: tests/requests/{{ file_name }}.rs
 skip_exists: true
-message: "Tests for controller `{{module_name}}` was added successfully. Run `cargo run test`."
+message: "Tests for controller `{{module_name}}` was added successfully. Run `cargo test`."
 injections:
 - into: tests/requests/mod.rs
   append: true
@@ -16,7 +16,7 @@ use serial_test::serial;
 #[serial]
 async fn can_get_{{ name | plural | snake_case }}() {
     testing::request::<App, _, _>(|request, _ctx| async move {
-        let res = request.get("/{{ name | plural | snake_case }}/").await;
+        let res = request.get("/api/{{ name | plural | snake_case }}/").await;
         assert_eq!(res.status_code(), 200);
 
         // you can assert content like this:

loco-gen/src/templates/request_test.t

@@ -2,7 +2,7 @@
 {% set module_name = file_name | pascal_case -%}
 to: tests/requests/{{ file_name }}.rs
 skip_exists: true
-message: "Tests for controller `{{module_name}}` was added successfully. Run `cargo run test`."
+message: "Tests for controller `{{module_name}}` was added successfully. Run `cargo test`."
 injections:
 - into: tests/requests/mod.rs
   append: true