Skip to content

Pre-optimise routes at indexing time #605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jviotti merged 1 commit into from
Jan 5, 2026
Merged

Pre-optimise routes at indexing time #605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/index/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::alterschema
target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::editorschema)
target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::parallel)
target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::options)
target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::uritemplate)
target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::blaze::compiler)
target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::blaze::evaluator)
target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::blaze::output)
Expand Down
13 changes: 13 additions & 0 deletions src/index/generators.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#include <sourcemeta/core/json.h>
#include <sourcemeta/core/jsonpointer.h>
#include <sourcemeta/core/jsonschema.h>
#include <sourcemeta/core/uritemplate.h>

#include <sourcemeta/blaze/compiler.h>
#include <sourcemeta/blaze/evaluator.h>
Expand Down Expand Up @@ -408,6 +409,18 @@ struct GENERATE_STATS {
}
};

struct GENERATE_URITEMPLATE_ROUTES {
using Context = sourcemeta::core::URITemplateRouter;
static auto
handler(const std::filesystem::path &destination,
const sourcemeta::core::BuildDependencies<std::filesystem::path> &,
const sourcemeta::core::BuildDynamicCallback<std::filesystem::path> &,
const Context &router) -> void {
std::filesystem::create_directories(destination.parent_path());
sourcemeta::core::URITemplateRouterView::save(router, destination);
}
};

} // namespace sourcemeta::one

#endif
43 changes: 43 additions & 0 deletions src/index/index.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#include <sourcemeta/core/options.h>
#include <sourcemeta/core/parallel.h>
#include <sourcemeta/core/uri.h>
#include <sourcemeta/core/uritemplate.h>

#include <sourcemeta/one/configuration.h>
#include <sourcemeta/one/resolver.h>
Expand Down Expand Up @@ -470,6 +471,48 @@ static auto index_main(const std::string_view &program,
concurrency);
}

/////////////////////////////////////////////////////////////////////////////
// (12) Generate the pre computed routes
/////////////////////////////////////////////////////////////////////////////

sourcemeta::core::URITemplateRouter router;
router.add("/self/v1/api/list", sourcemeta::one::HANDLER_SELF_V1_API_LIST);
router.add("/self/v1/api/list/{+path}",
sourcemeta::one::HANDLER_SELF_V1_API_LIST_PATH);
router.add("/self/v1/api/schemas/dependencies/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_DEPENDENCIES);
router.add("/self/v1/api/schemas/health/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_HEALTH);
router.add("/self/v1/api/schemas/locations/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_LOCATIONS);
router.add("/self/v1/api/schemas/positions/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_POSITIONS);
router.add("/self/v1/api/schemas/stats/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_STATS);
router.add("/self/v1/api/schemas/metadata/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_METADATA);
router.add("/self/v1/api/schemas/evaluate/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_EVALUATE);
router.add("/self/v1/api/schemas/trace/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_TRACE);
router.add("/self/v1/api/schemas/search",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_SEARCH);
router.add("/self/v1/api/{+any}",
sourcemeta::one::HANDLER_SELF_V1_API_DEFAULT);

if (configuration.html.has_value()) {
router.add("/self/static/{+path}", sourcemeta::one::HANDLER_SELF_STATIC);
}

const auto routes_path{output.path() / "routes.bin"};
DISPATCH<sourcemeta::one::GENERATE_URITEMPLATE_ROUTES>(
routes_path, {mark_configuration_path, mark_version_path}, router, mutex,
"Producing", routes_path.string(), "routes", adapter, output);

/////////////////////////////////////////////////////////////////////////////
// Finish generation
/////////////////////////////////////////////////////////////////////////////

// TODO: Print the size of the output directory here

output.remove_unknown_files();
Expand Down
35 changes: 2 additions & 33 deletions src/server/server.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ static const Handler HANDLERS[] = {handle_default,
handle_self_api_not_found,
handle_self_static};

static auto dispatch(const sourcemeta::core::URITemplateRouter &router,
static auto dispatch(const sourcemeta::core::URITemplateRouterView &router,
const std::filesystem::path &base,
uWS::HttpResponse<true> *const raw_response,
uWS::HttpRequest *const raw_request) noexcept -> void {
Expand Down Expand Up @@ -306,38 +306,7 @@ auto main(int argc, char *argv[]) noexcept -> int {

const auto port{static_cast<std::uint32_t>(std::stoul(argv[2]))};
const auto base{std::filesystem::canonical(argv[1])};
const auto is_headless{!std::filesystem::exists(
base / "explorer" / SENTINEL / "directory-html.metapack")};

// TODO: Restore this from a URI Template binary view
sourcemeta::core::URITemplateRouter router;
router.add("/self/v1/api/list", sourcemeta::one::HANDLER_SELF_V1_API_LIST);
router.add("/self/v1/api/list/{+path}",
sourcemeta::one::HANDLER_SELF_V1_API_LIST_PATH);
router.add("/self/v1/api/schemas/dependencies/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_DEPENDENCIES);
router.add("/self/v1/api/schemas/health/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_HEALTH);
router.add("/self/v1/api/schemas/locations/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_LOCATIONS);
router.add("/self/v1/api/schemas/positions/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_POSITIONS);
router.add("/self/v1/api/schemas/stats/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_STATS);
router.add("/self/v1/api/schemas/metadata/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_METADATA);
router.add("/self/v1/api/schemas/evaluate/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_EVALUATE);
router.add("/self/v1/api/schemas/trace/{+schema}",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_TRACE);
router.add("/self/v1/api/schemas/search",
sourcemeta::one::HANDLER_SELF_V1_API_SCHEMAS_SEARCH);
router.add("/self/v1/api/{+any}",
sourcemeta::one::HANDLER_SELF_V1_API_DEFAULT);

if (!is_headless) {
router.add("/self/static/{+path}", sourcemeta::one::HANDLER_SELF_STATIC);
}
const sourcemeta::core::URITemplateRouterView router{base / "routes.bin"};

uWS::LocalCluster(
{}, [&router, &base, port, timestamp_start](uWS::SSLApp &app) -> void {
Expand Down
2 changes: 2 additions & 0 deletions test/cli/index/rebuild-cache.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Detecting: $(realpath "$TMP")/schemas/foo.json (#1)
(skip) Rendering: . [not-found]
(100%) Rendering: example/schemas/foo
(skip) Rendering: example/schemas/foo [schema]
(skip) Producing: $(realpath "$TMP")/output/routes.bin [routes]
EOF
diff "$TMP/output.txt" "$TMP/expected.txt"

Expand Down Expand Up @@ -128,6 +129,7 @@ Detecting: $(realpath "$TMP")/schemas/foo.json (#1)
( 75%) Rendering: .
(skip) Rendering: . [not-found]
(100%) Rendering: example/schemas/foo
(skip) Producing: $(realpath "$TMP")/output/routes.bin [routes]
EOF
diff "$TMP/output.txt" "$TMP/expected.txt"

Expand Down
2 changes: 2 additions & 0 deletions test/cli/index/rebuild-to-empty.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ cat << 'EOF' > "$TMP/new-expected.txt"
./explorer/%/directory.metapack.deps
./explorer/%/search.metapack
./explorer/%/search.metapack.deps
./routes.bin
./routes.bin.deps
./version.json
EOF

Expand Down
2 changes: 2 additions & 0 deletions test/sandbox/manifest-empty.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@
./explorer/%/directory.metapack.deps
./explorer/%/search.metapack
./explorer/%/search.metapack.deps
./routes.bin
./routes.bin.deps
./version.json
2 changes: 2 additions & 0 deletions test/sandbox/manifest-headless.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5399,6 +5399,8 @@
./explorer/test/v2.0/schema/%
./explorer/test/v2.0/schema/%/schema.metapack
./explorer/test/v2.0/schema/%/schema.metapack.deps
./routes.bin
./routes.bin.deps
./schemas
./schemas/self
./schemas/self/v1
Expand Down
2 changes: 2 additions & 0 deletions test/sandbox/manifest-html.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8101,6 +8101,8 @@
./explorer/test/v2.0/schema/%/schema-html.metapack.deps
./explorer/test/v2.0/schema/%/schema.metapack
./explorer/test/v2.0/schema/%/schema.metapack.deps
./routes.bin
./routes.bin.deps
./schemas
./schemas/self
./schemas/self/v1
Expand Down