Feature: custom queries #32

This commit enhances previous one to:
 - not fail if configuration file does not contain custom_queries part
 - ensure, that .config folder can be created in docker container as well
 - ensure, that a docker container can be stopped on SIGTERM
 - ensure, that right default logging setting is given.

Author: monofox

Dockerfile

@@ -26,11 +26,12 @@ RUN echo "NoExtract = !usr/share/doc/timew/*" >> /etc/pacman.conf \
  && pacman -S --noconfirm task timew cronie vi \
  && pacman -S --noconfirm python-pip \
  && useradd -m -d /app task && passwd -d task \
- && chown -R task:task /app && chmod -R 775 /app \
  && mkdir -p /app/bin \
  && mkdir -p /app/taskdata \
  && mkdir -p /app/.task/hooks \
  && mkdir -p /app/.timewarrior/data/ \
+ && mkdir -p /app/.config/taskwarrior-web/ \
+ && chown -R task:task /app && chmod -R 775 /app \
  && systemctl enable cronie.service \
  && cp /usr/share/doc/timew/ext/on-modify.timewarrior /app/.task/hooks/on-modify.timewarrior \
  && chmod +x /app/.task/hooks/on-modify.timewarrior \
@@ -67,6 +68,7 @@ EXPOSE 3000
 # Taskwarrior data volume
 VOLUME /app/taskdata/
 VOLUME /app/.timewarrior/
+VOLUME /app/.config/taskwarrior-web/
 
 ENV TASKRC="/app/.taskrc"
 ENV TASKDATA="/app/taskdata"

README.md

@@ -59,10 +59,11 @@ That should do it.
 
 The docker shares following directories as volumes to store data:
 
-| Volume path       | Purpose                                        |
-| ----------------- | ---------------------------------------------- |
-| /app/taskdata     | Stores task data (mostly taskchampion.sqlite3) |
-| /app/.timewarrior | Stores timewarrior data                        |
+| Volume path                  | Purpose                                        |
+| -----------------            | ---------------------------------------------- |
+| /app/taskdata                | Stores task data (mostly taskchampion.sqlite3) |
+| /app/.timewarrior            | Stores timewarrior data                        |
+| /app/.config/taskwarrior-web | Stores taskwarrior-web configuration file      |
 
 It is recommend to specify the corresponding volume in order to persist the data.
 
@@ -114,17 +115,13 @@ That should be it! Now you have the server running at `localhost:3000` accessibl
 
 ### Troubleshooting
 
-if you are receiving the following error in step 5
-
+By default the log level is set to `INFO`. If a more detailed log is required, the application can be run with DEBUG or even TRACE messages.
+For debug messages, just set the environment "RUST_LOG" to "DEBUG":
 ```shell
-
-  thread 'main' panicked at build.rs:7:19:
-  called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }
-  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
-
+env RUST_LOG="DEBUG" cargo run
 ```
 
-It's because, `tailwindcss-cli` is missing
+If a fine granular configuration is desired - the application log itself is captured with the name `taskwarrior_web`.
 
 ## Customizing
 
@@ -260,7 +257,7 @@ As soon as one of the other reports like `next`, `pending` or others are selecte
 
 Beside of a configuration file, it is possible to configure via environment variables as well:
 ```shell
-env TWK_custom_queries__one_query__fixed_key=ni TWK_custom_queries__one_query__query="end.after:today-1wk and status:completed" TWK_custom_queries__one_query__description="completed last 7days" RUST_LOG="INFO" cargo run
+env TWK_custom_queries__one_query__fixed_key=ni TWK_custom_queries__one_query__query="end.after:today-1wk and status:completed" TWK_custom_queries__one_query__description="completed last 7days" cargo run
 ```
 
 The same way it is possible to configure the docker container accordingly.

docker/start.sh

@@ -17,4 +17,7 @@ if [[ ! -f "$TASKRC" ]]; then
 fi
 
 cd $HOME/bin
-exec ./taskwarrior-web
+exec ./taskwarrior-web &
+pid=$!
+trap 'kill -SIGTERM $pid; wait $pid' SIGTERM
+wait $pidh

src/core/config.rs

@@ -15,6 +15,7 @@ pub struct CustomQuery {
 
 #[derive(serde::Deserialize, Clone, Debug)]
 pub struct AppSettings {
+    #[serde(default)]
     pub custom_queries: HashMap<String, CustomQuery>,
 }
 

src/main.rs

@@ -85,7 +85,7 @@ fn init_tracing() {
     tracing_subscriber::registry()
         .with(
             tracing_subscriber::EnvFilter::try_from_default_env()
-                .unwrap_or_else(|_| "org_me=debug,tower_http=debug".into()),
+                .unwrap_or_else(|_| "taskwarrior_web=info,tower_http=info".into()),
         )
         .with(tracing_subscriber::fmt::layer().with_line_number(true))
         .init();