env

env.example.ts

@@ -1,10 +1,11 @@
+import { resolve } from 'node:path'
 import { defineBackendConfig, env, safeEnv } from './src/server/env'
 
 /**
  * recommend: edit this config with typescript supported editor, you will get immediate type check.
  * if you don't have the editor, you can run command `yarn check-backend-config` instead.
  *
- * you can use env('key') to read from environment variables. It will raise error if env not found.
+ * you can use env('key') to read from environment variables. It will raise an error if env not found.
  *
  * you can also use safeEnv('key'). it will not raise any error, but instead returns undefined.
  * for a required field this will raise an compiler error.
@@ -14,18 +15,19 @@ import { defineBackendConfig, env, safeEnv } from './src/server/env'
 export default defineBackendConfig({
 
   article: {
-    location: 'article',
+    location: resolve('articles'), // must be a resolved path. Put absolute path or use 'resolve()' here.
   },
 
   sessionStore: 'redis',
   leaderboardSource: 'redis',
 
-  redisURL: safeEnv('REDIS_URL') || 'redis://localhost',
+  redisURL: safeEnv('REDIS_URL') ?? 'redis://localhost',
   dsn: env('DB_DSN'),
 
   avatar: {
+    // must be a resolved path. Put absolute path or use 'resolve()' here.
     location: '/path/to/avatars/folder',
-    domain: '//a.dev.ppy.sb',
+    domain: 'a.dev.ppy.sb',
   },
 
   api: {

src/server/backend/$base/env.ts

@@ -1,4 +1,6 @@
+import { resolve } from 'node:path'
 import { discriminatedUnion, literal, object, string } from 'zod'
+import { zodPath } from '~/server/trpc/shapes'
 import env from '~~/env'
 
 export const redisURL = string().url()
@@ -10,7 +12,7 @@ export const validator = discriminatedUnion('sessionStore', [
   object({ redisURL, sessionStore: redis }),
 ]).and(object({
   article: object({
-    location: string().default('articles'),
+    location: zodPath.default(resolve('articles')),
   }),
 }))
 

src/server/backend/bancho.py/env.ts

@@ -1,5 +1,5 @@
 import { discriminatedUnion, literal, object, string } from 'zod'
-import { zodFQDN, zodPath } from '~/server/trpc/shapes'
+import { zodFQDN as FQDN, zodPath as path } from '~/server/trpc/shapes'
 import { validator as base, redis, redisURL } from '$base/env'
 import env from '~~/env'
 
@@ -18,8 +18,8 @@ export const leaderboard = discriminatedUnion('leaderboardSource', [
 ])
 
 export const avatar = object({
-  location: zodPath,
-  domain: zodFQDN,
+  location: path,
+  domain: FQDN,
 })
 
 export const apiEndpoint = object({

src/server/trpc/shapes/index.ts

@@ -89,7 +89,7 @@ export const zodPath = string().trim().superRefine((val, ctx) => {
   if (!existsSync(val)) {
     ctx.addIssue({
       code: ZodIssueCode.custom,
-      message: 'invalid path: Guccho cannot access the path you provided',
+      message: `invalid path: Guccho cannot access the path you provided: ${val}`,
     })
   }
 })