openapi client generation

src/materia/app/app.py

@@ -5,6 +5,7 @@ from typing import AsyncIterator, TypedDict, Self, Optional
 
 import uvicorn
 from fastapi import FastAPI
+from fastapi.routing import APIRoute
 from fastapi.middleware.cors import CORSMiddleware
 from materia.core import (
     Config,
@@ -15,6 +16,7 @@ from materia.core import (
     Cron,
 )
 from materia import routers
+from materia.core.misc import optional, optional_string
 
 
 class Context(TypedDict):
@@ -57,7 +59,7 @@ class Application:
             await app.prepare_database()
             await app.prepare_cache()
             await app.prepare_cron()
-            await app.prepare_server()
+            app.prepare_server()
         except Exception as e:
             app.logger.error(" ".join(e.args))
             sys.exit()
@@ -99,7 +101,7 @@ class Application:
             self.config.cron.workers_count, backend_url=url, broker_url=url
         )
 
-    async def prepare_server(self):
+    def prepare_server(self):
         @asynccontextmanager
         async def lifespan(app: FastAPI) -> AsyncIterator[Context]:
             yield Context(
@@ -129,6 +131,13 @@ class Application:
         self.backend.include_router(routers.resources.router)
         self.backend.include_router(routers.root.router)
 
+        for route in self.backend.routes:
+            if isinstance(route, APIRoute):
+                route.operation_id = (
+                    optional_string(optional(route.tags.__getitem__, 0), "{}_")
+                    + route.name
+                )
+
     async def start(self):
         self.logger.info(f"Spinning up cron workers [{self.config.cron.workers_count}]")
         self.cron.run_workers()

src/materia/app/cli.py

@@ -5,6 +5,7 @@ from materia.core.config import Config
 from materia.core.logging import Logger
 from materia.app import Application
 import asyncio
+import json
 
 
 @click.group()
@@ -112,5 +113,36 @@ def config_check(path: Path):
         logger.info("OK.")
 
 
+@cli.group()
+def export():
+    pass
+
+
+@export.command("openapi", help="Export an OpenAPI specification.")
+@click.option(
+    "--path",
+    "-p",
+    type=Path,
+    default=Path.cwd().joinpath("openapi.json"),
+    help="Path to the file.",
+)
+def export_openapi(path: Path):
+    path = path.resolve()
+    logger = Logger.new()
+    config = Config()
+    app = Application(config)
+    app.prepare_server()
+
+    logger.info("Writing file at {}", path)
+
+    try:
+        with open(path, "w") as io:
+            json.dump(app.backend.openapi(), io, sort_keys=False)
+    except Exception as e:
+        logger.error("{}", e)
+
+    logger.info("All done.")
+
+
 if __name__ == "__main__":
     cli()

src/materia/core/cron.py

@@ -34,10 +34,14 @@ class Cron:
     ):
         cron = Cron(
             workers_count,
+            # TODO: change log level
+            # TODO: exclude pickle
+            # TODO: disable startup banner
             Celery(
                 "cron",
                 backend=backend_url,
                 broker=broker_url,
+                broker_connection_retry_on_startup=True,
                 task_serializer="pickle",
                 accept_content=["pickle", "json"],
                 **kwargs,

src/materia/routers/api/file.py

@@ -68,7 +68,23 @@ class FileSizeValidator:
             raise HTTPException(status.HTTP_413_REQUEST_ENTITY_TOO_LARGE)
 
 
-@router.post("/file")
+@router.post("/file", openapi_extra={
+    "requestBody" : {
+        "content": {
+            "multipart/form-data": {
+                "schema": {
+                    "required": ["file", "path"],
+                    "type": "object",
+                    "properties": {
+                        "file": { "type": "string", "format": "binary" },
+                        "path": { "type": "string", "format": "path", "example": "/"}
+                    }
+                }
+            }
+        },
+        "required": True
+    }
+})
 async def create(
     request: Request,
     repository: Repository = Depends(middleware.repository),

tests/conftest.py

@@ -129,27 +129,7 @@ async def api_client(
     app.database = database
     app.cache = cache
     app.cron = cron
-    await app.prepare_server()
+    app.prepare_server()
-
-    # logger = make_logger(api_config)
-
-    # @asynccontextmanager
-    # async def lifespan(app: FastAPI) -> AsyncIterator[AppContext]:
-    #    yield AppContext(
-    #        config=api_config, database=database, cache=cache, logger=logger
-    #    )
-
-    # app = FastAPI(lifespan=lifespan)
-    # app.include_router(routers.api.router)
-    # app.include_router(routers.resources.router)
-    # app.include_router(routers.root.router)
-    # app.add_middleware(
-    #    CORSMiddleware,
-    #    allow_origins=["*"],
-    #    allow_credentials=True,
-    #    allow_methods=["*"],
-    #    allow_headers=["*"],
-    # )
 
     async with LifespanManager(app.backend) as manager:
         async with AsyncClient(

workspaces/frontend/.gitignore

@@ -9,3 +9,6 @@ __pycache__/
 node_modules/
 *.tsbuildinfo
 *.mjs
+*.log
+
+src/client

workspaces/frontend/package-lock.json

@@ -24,6 +24,7 @@
                 "@vitejs/plugin-vue-jsx": "^3.1.0",
                 "@vue/tsconfig": "^0.5.0",
                 "npm-run-all2": "^6.1.1",
+                "openapi-typescript-codegen": "^0.29.0",
                 "typescript": "~5.3.0",
                 "vite": "^5.0.10",
                 "vue-tsc": "^2.0.29"
@@ -53,6 +54,23 @@
                 "node": ">=6.0.0"
             }
         },
+        "node_modules/@apidevtools/json-schema-ref-parser": {
+            "version": "11.7.0",
+            "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.7.0.tgz",
+            "integrity": "sha512-pRrmXMCwnmrkS3MLgAIW5dXRzeTv6GLjkjb4HmxNnvAKXN1Nfzp4KmGADBQvlVUcqi+a5D+hfGDLLnd5NnYxog==",
+            "dev": true,
+            "dependencies": {
+                "@jsdevtools/ono": "^7.1.3",
+                "@types/json-schema": "^7.0.15",
+                "js-yaml": "^4.1.0"
+            },
+            "engines": {
+                "node": ">= 16"
+            },
+            "funding": {
+                "url": "https://github.com/sponsors/philsturgeon"
+            }
+        },
         "node_modules/@babel/code-frame": {
             "version": "7.23.5",
             "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.23.5.tgz",
@@ -920,6 +938,12 @@
                 "@jridgewell/sourcemap-codec": "^1.4.14"
             }
         },
+        "node_modules/@jsdevtools/ono": {
+            "version": "7.1.3",
+            "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz",
+            "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==",
+            "dev": true
+        },
         "node_modules/@nodelib/fs.scandir": {
             "version": "2.1.5",
             "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
@@ -1142,6 +1166,12 @@
             "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==",
             "dev": true
         },
+        "node_modules/@types/json-schema": {
+            "version": "7.0.15",
+            "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
+            "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==",
+            "dev": true
+        },
         "node_modules/@types/node": {
             "version": "18.19.24",
             "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.24.tgz",
@@ -1437,6 +1467,12 @@
             "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz",
             "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg=="
         },
+        "node_modules/argparse": {
+            "version": "2.0.1",
+            "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+            "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
+            "dev": true
+        },
         "node_modules/asynckit": {
             "version": "0.4.0",
             "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
@@ -1479,9 +1515,9 @@
             }
         },
         "node_modules/axios": {
-            "version": "1.6.8",
+            "version": "1.7.5",
-            "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.8.tgz",
+            "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.5.tgz",
-            "integrity": "sha512-v/ZHtJDU39mDpyBoFVkETcd/uNdxrWRrg3bKpOKzXFA6Bvqopts6ALSMU3y6ijYxbw2B+wPrIv46egTzJXCLGQ==",
+            "integrity": "sha512-fZu86yCo+svH3uqJ/yTdQ0QHpQu5oL+/QE+QPSv6BZSkDAoky9vytxp7u5qk83OJFS3kEBcesWni9WTZAv3tSw==",
             "dependencies": {
                 "follow-redirects": "^1.15.6",
                 "form-data": "^4.0.0",
@@ -1944,6 +1980,20 @@
                 "url": "https://github.com/sponsors/rawify"
             }
         },
+        "node_modules/fs-extra": {
+            "version": "11.2.0",
+            "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.2.0.tgz",
+            "integrity": "sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==",
+            "dev": true,
+            "dependencies": {
+                "graceful-fs": "^4.2.0",
+                "jsonfile": "^6.0.1",
+                "universalify": "^2.0.0"
+            },
+            "engines": {
+                "node": ">=14.14"
+            }
+        },
         "node_modules/fsevents": {
             "version": "2.3.3",
             "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
@@ -2015,6 +2065,33 @@
                 "node": ">=4"
             }
         },
+        "node_modules/graceful-fs": {
+            "version": "4.2.11",
+            "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
+            "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==",
+            "dev": true
+        },
+        "node_modules/handlebars": {
+            "version": "4.7.8",
+            "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz",
+            "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==",
+            "dev": true,
+            "dependencies": {
+                "minimist": "^1.2.5",
+                "neo-async": "^2.6.2",
+                "source-map": "^0.6.1",
+                "wordwrap": "^1.0.0"
+            },
+            "bin": {
+                "handlebars": "bin/handlebars"
+            },
+            "engines": {
+                "node": ">=0.4.7"
+            },
+            "optionalDependencies": {
+                "uglify-js": "^3.1.4"
+            }
+        },
         "node_modules/has-flag": {
             "version": "3.0.0",
             "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
@@ -2136,9 +2213,9 @@
             }
         },
         "node_modules/jiti": {
-            "version": "1.21.0",
+            "version": "1.21.6",
-            "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.0.tgz",
+            "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.6.tgz",
-            "integrity": "sha512-gFqAIbuKyyso/3G2qhiO2OM6shY6EPP/R0+mkDbyspxKazh8BXDC5FiFsUjlczgdNz/vfra0da2y+aHrusLG/Q==",
+            "integrity": "sha512-2yTgeWTWzMWkHu6Jp9NKgePDaYHbntiwvYuuJLbbN9vl7DC9DvXKOB2BC3ZZ92D3cvV/aflH0osDfwpHepQ53w==",
             "bin": {
                 "jiti": "bin/jiti.js"
             }
@@ -2149,6 +2226,18 @@
             "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
             "dev": true
         },
+        "node_modules/js-yaml": {
+            "version": "4.1.0",
+            "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+            "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+            "dev": true,
+            "dependencies": {
+                "argparse": "^2.0.1"
+            },
+            "bin": {
+                "js-yaml": "bin/js-yaml.js"
+            }
+        },
         "node_modules/jsesc": {
             "version": "2.5.2",
             "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz",
@@ -2182,6 +2271,18 @@
                 "node": ">=6"
             }
         },
+        "node_modules/jsonfile": {
+            "version": "6.1.0",
+            "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
+            "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
+            "dev": true,
+            "dependencies": {
+                "universalify": "^2.0.0"
+            },
+            "optionalDependencies": {
+                "graceful-fs": "^4.1.6"
+            }
+        },
         "node_modules/lilconfig": {
             "version": "2.1.0",
             "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-2.1.0.tgz",
@@ -2233,11 +2334,11 @@
             }
         },
         "node_modules/micromatch": {
-            "version": "4.0.5",
+            "version": "4.0.8",
-            "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
+            "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
-            "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+            "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
             "dependencies": {
-                "braces": "^3.0.2",
+                "braces": "^3.0.3",
                 "picomatch": "^2.3.1"
             },
             "engines": {
@@ -2277,6 +2378,15 @@
                 "url": "https://github.com/sponsors/isaacs"
             }
         },
+        "node_modules/minimist": {
+            "version": "1.2.8",
+            "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+            "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+            "dev": true,
+            "funding": {
+                "url": "https://github.com/sponsors/ljharb"
+            }
+        },
         "node_modules/minipass": {
             "version": "7.0.4",
             "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.4.tgz",
@@ -2324,6 +2434,12 @@
                 "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1"
             }
         },
+        "node_modules/neo-async": {
+            "version": "2.6.2",
+            "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
+            "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==",
+            "dev": true
+        },
         "node_modules/node-releases": {
             "version": "2.0.14",
             "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.14.tgz",
@@ -2407,6 +2523,31 @@
                 "node": ">= 6"
             }
         },
+        "node_modules/openapi-typescript-codegen": {
+            "version": "0.29.0",
+            "resolved": "https://registry.npmjs.org/openapi-typescript-codegen/-/openapi-typescript-codegen-0.29.0.tgz",
+            "integrity": "sha512-/wC42PkD0LGjDTEULa/XiWQbv4E9NwLjwLjsaJ/62yOsoYhwvmBR31kPttn1DzQ2OlGe5stACcF/EIkZk43M6w==",
+            "dev": true,
+            "dependencies": {
+                "@apidevtools/json-schema-ref-parser": "^11.5.4",
+                "camelcase": "^6.3.0",
+                "commander": "^12.0.0",
+                "fs-extra": "^11.2.0",
+                "handlebars": "^4.7.8"
+            },
+            "bin": {
+                "openapi": "bin/index.js"
+            }
+        },
+        "node_modules/openapi-typescript-codegen/node_modules/commander": {
+            "version": "12.1.0",
+            "resolved": "https://registry.npmjs.org/commander/-/commander-12.1.0.tgz",
+            "integrity": "sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==",
+            "dev": true,
+            "engines": {
+                "node": ">=18"
+            }
+        },
         "node_modules/path-browserify": {
             "version": "1.0.1",
             "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz",
@@ -2867,6 +3008,15 @@
                 "url": "https://github.com/sponsors/isaacs"
             }
         },
+        "node_modules/source-map": {
+            "version": "0.6.1",
+            "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+            "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+            "dev": true,
+            "engines": {
+                "node": ">=0.10.0"
+            }
+        },
         "node_modules/source-map-js": {
             "version": "1.2.0",
             "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.0.tgz",
@@ -3106,12 +3256,34 @@
                 "node": ">=14.17"
             }
         },
+        "node_modules/uglify-js": {
+            "version": "3.19.3",
+            "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz",
+            "integrity": "sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==",
+            "dev": true,
+            "optional": true,
+            "bin": {
+                "uglifyjs": "bin/uglifyjs"
+            },
+            "engines": {
+                "node": ">=0.8.0"
+            }
+        },
         "node_modules/undici-types": {
             "version": "5.26.5",
             "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
             "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
             "dev": true
         },
+        "node_modules/universalify": {
+            "version": "2.0.1",
+            "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz",
+            "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==",
+            "dev": true,
+            "engines": {
+                "node": ">= 10.0.0"
+            }
+        },
         "node_modules/update-browserslist-db": {
             "version": "1.0.13",
             "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.13.tgz",
@@ -3305,6 +3477,12 @@
                 "node": ">= 8"
             }
         },
+        "node_modules/wordwrap": {
+            "version": "1.0.0",
+            "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
+            "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==",
+            "dev": true
+        },
         "node_modules/wrap-ansi": {
             "version": "8.1.0",
             "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz",

workspaces/frontend/package.json

@@ -8,7 +8,8 @@
         "build-check": "run-p type-check \"build-only {@}\" --",
         "preview": "vite preview",
         "build": "vite build",
-        "type-check": "vue-tsc --build --force"
+        "type-check": "vue-tsc --build --force",
+        "generate-client": "openapi --input ./openapi.json --output ./src/client/ --client axios"
     },
     "dependencies": {
         "@catppuccin/tailwindcss": "^0.1.6",
@@ -27,6 +28,7 @@
         "@vitejs/plugin-vue-jsx": "^3.1.0",
         "@vue/tsconfig": "^0.5.0",
         "npm-run-all2": "^6.1.1",
+        "openapi-typescript-codegen": "^0.29.0",
         "typescript": "~5.3.0",
         "vite": "^5.0.10",
         "vue-tsc": "^2.0.29"