From ac4126b2af2b381f7ccace5727c0bb079e7beb25 Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Tue, 14 Oct 2025 17:59:56 -0700 Subject: [PATCH 01/45] #Added support for action buttons in the table component template. * A default edit and delete button can be included by specifying an "edit_url" or "delete_url" * Custom Column based action buttons can be added in the table header using json object array in the custom_actions column. * Custom action buttons can be defined on the row level by specifying _sqlpage_actions. --- .../sqlpage/migrations/01_documentation.sql | 168 +++++++++++++++++- sqlpage/templates/table.handlebars | 45 +++++ 2 files changed, 212 insertions(+), 1 deletion(-) diff --git a/examples/official-site/sqlpage/migrations/01_documentation.sql b/examples/official-site/sqlpage/migrations/01_documentation.sql index ee2b8b51..c9630fbf 100644 --- a/examples/official-site/sqlpage/migrations/01_documentation.sql +++ b/examples/official-site/sqlpage/migrations/01_documentation.sql @@ -810,11 +810,15 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('money', 'Name of a numeric column whose values should be displayed as currency amounts, in the currency defined by the `currency` property. This argument can be repeated multiple times.', 'TEXT', TRUE, TRUE), ('currency', 'The ISO 4217 currency code (e.g., USD, EUR, GBP, etc.) to use when formatting monetary values.', 'TEXT', TRUE, TRUE), ('number_format_digits', 'Maximum number of decimal digits to display for numeric values.', 'INTEGER', TRUE, TRUE), + ('edit_url', 'If set, an edit button will be added to each row. The value of this property should be a URL, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row. Clicking the edit button will take the user to that URL.', 'TEXT', TRUE, TRUE), + ('delete_url', 'If set, a delete button will be added to each row. The value of this property should be a URL, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row. Clicking the delete button will take the user to that URL.', 'TEXT', TRUE, TRUE), + ('custom_actions', 'If set, a column of custom action buttons will be added to each row. The value of this property should be a JSON array of objects, each object defining a button with the following properties: `name` (the text to display on the button), `icon` (the tabler icon name or image link to display on the button), `link` (the URL to navigate to when the button is clicked, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row), and `tooltip` (optional text to display when hovering over the button).', 'JSON', TRUE, TRUE), -- row level ('_sqlpage_css_class', 'For advanced users. Sets a css class on the table row. Added in v0.8.0.', 'TEXT', FALSE, TRUE), ('_sqlpage_color', 'Sets the background color of the row. Added in v0.8.0.', 'COLOR', FALSE, TRUE), ('_sqlpage_footer', 'Sets this row as the table footer. It is recommended that this parameter is applied to the last row. Added in v0.34.0.', 'BOOLEAN', FALSE, TRUE), - ('_sqlpage_id', 'Sets the id of the html tabler row element. Allows you to make links targeting a specific row in a table.', 'TEXT', FALSE, TRUE) + ('_sqlpage_id', 'Sets the id of the html tabler row element. Allows you to make links targeting a specific row in a table.', 'TEXT', FALSE, TRUE), + ('_sqlpage_actions', 'Sets custom action buttons for this specific row in addition to any defined at the table level, The value of this property should be a JSON array of objects, each object defining a button with the following properties: `name` (the text to display on the button), `icon` (the tabler icon name or image link to display on the button), `link` (the URL to navigate to when the button is clicked, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row), and `tooltip` (optional text to display when hovering over the button).', 'JSON', FALSE, TRUE) ) x; INSERT INTO example(component, description, properties) VALUES @@ -994,9 +998,171 @@ GROUP BY This will generate a table with the stores in the first column, and the items in the following columns, with the quantity sold in each store for each item. ', NULL + ), + ( + 'table', +'# Using row based custom actions in a table + +The table has a column of buttons, each button defined by the `_sqlpage_actions` column at the table level, and by the `_sqlpage_actions` property at the row level. + +```sql + SELECT + name, vendor, product_number, facility_name, + lot_number, status, date_of_expiration, + --Use the unique identifier of the row as the _sqlpage_id property + standard_id AS _sqlpage_id, + --Build an array of objects, each object defining a button with the following properties: name, icon, link, tooltip + json_array(--SQLite specific, refer to your database documentation for the equivalent JSON functions + --The {id} placeholder in the link property will be replaced by the value of the _sqlpage_id property for that row. + json_object(''name'', ''history'', ''tooltip'', ''View Standard History'', ''link'', ''./history.sql?standard_id={id}'', ''icon'', ''history''), + json_object(''name'', ''view_coa'', ''tooltip'', ''View Certificate of Analysis'', ''link'', c_of_a_path, ''icon'', ''file-type-pdf''), + json_object(''name'', ''edit'', ''tooltip'', ''Edit Standard'', ''link'', ''./update.sql?id={id}'', ''icon'', ''pencil''), + --We want different actions based on the status of the standard, so we use a CASE statement to build the appropriate action + CASE + WHEN status = ''Available'' THEN json_object( + ''name'',''Action'', + ''tooltip'',''Set In Use'', + ''link'',''./actions/set_in_use.sql?standard_id='' || standard_id, + ''icon'',''caret-right'' + ) + WHEN status = ''In Use'' THEN json_object( + ''name'',''Action'', + ''tooltip'',''Retire Standard'', + ''link'',''./actions/retire.sql?standard_id='' || standard_id, + ''icon'',''test-pipe-off'' + ) + WHEN status = ''Retired'' THEN json_object( + ''name'',''Action'', + ''tooltip'',''Discard Standard'', + ''link'',''./actions/discard.sql?standard_id='' || standard_id, + ''icon'',''flask-off'' + ) + -- Include an action with no link or icon as a placeholder to keep the buttons aligned and make sure the header is correct. + WHEN status = ''Discarded'' THEN json_object(''name'',''Action'') + + ELSE json_object(''name'',''Action'') + END + ) + AS _sqlpage_actions + FROM standard; + + ``` + + + ' + , + json('[ + { + "component": "table" + }, + { + "name": "CalStd", + "vendor": "PharmaCo", + "product_number": "P1234", + "facility_name": "A Plant", + "lot_number": "T23523", + "status": "Available", + "date_of_expiration": "2026-10-13", + "_sqlpage_id": 32, + "_sqlpage_actions": [ + { + "name": "history", + "tooltip": "View Standard History", + "link": "./history.sql?standard_id={id}", + "icon": "history" + }, + { + "name": "view_coa", + "tooltip": "View Certificate of Analysis", + "link": "/c_of_a\\2025-09-30_22h01m21s_B69baKoz.pdf", + "icon": "file-type-pdf" + }, + { + "name": "edit", + "tooltip": "Edit Standard", + "link": "./update.sql?id={id}", + "icon": "pencil" + }, + { + "name": "Action", + "tooltip": "Set In Use", + "link": "./actions/set_in_use.sql?standard_id=32", + "icon": "caret-right" + } + ] + }, + { + "name": "CalStd", + "vendor": "PharmaCo", + "product_number": "P1234", + "facility_name": "A Plant", + "lot_number": "T2352", + "status": "In Use", + "date_of_expiration": "2026-10-14", + "_sqlpage_id": 33, + "_sqlpage_actions": [ + { + "name": "history", + "tooltip": "View Standard History", + "link": "./history.sql?standard_id={id}", + "icon": "history" + }, + { + "name": "view_coa", + "tooltip": "View Certificate of Analysis", + "link": "/c_of_a\\2025-09-30_22h05m13s_cP7gqMyi.pdf", + "icon": "file-type-pdf" + }, + { + "name": "edit", + "tooltip": "Edit Standard", + "link": "./update.sql?id={id}", + "icon": "pencil" + }, + { + "name": "Action", + "tooltip": "Retire Standard", + "link": "./actions/retire.sql?standard_id=33", + "icon": "test-pipe-off" + } + ] + }, + { + "name": "CalStd", + "vendor": "PharmaCo", + "product_number": "P1234", + "facility_name": "A Plant", + "lot_number": "A123", + "status": "Discarded", + "date_of_expiration": "2026-09-30", + "_sqlpage_id": 31, + "_sqlpage_actions": [ + { + "name": "history", + "tooltip": "View Standard History", + "link": "./history.sql?standard_id={id}", + "icon": "history" + }, + { + "name": "view_coa", + "tooltip": "View Certificate of Analysis", + "link": "#", + "icon": "file-type-pdf" + }, + { + "name": "edit", + "tooltip": "Edit Standard", + "link": "./update.sql?id={id}", + "icon": "pencil" + }, + null + ] + } +]') ); + INSERT INTO component(name, icon, description) VALUES ('csv', 'download', 'Lets the user download data as a CSV file. Each column from the items in the component will map to a column in the resulting CSV. diff --git a/sqlpage/templates/table.handlebars b/sqlpage/templates/table.handlebars index 90958dfe..639f9341 100644 --- a/sqlpage/templates/table.handlebars +++ b/sqlpage/templates/table.handlebars @@ -3,6 +3,7 @@ {{#if (or search initial_search_value)}}
{{/if}} {{/each}} + {{#if ../edit_url}}Edit{{/if}} + {{#if ../delete_url}}Delete{{/if}} + {{#if ../custom_actions}} + {{#each ../custom_actions}} + {{this.name}} + {{/each}} + {{/if}} + {{#if _sqlpage_actions}} + {{#each _sqlpage_actions}} + {{this.name}} + {{/each}} + {{/if}} {{#delay}}{{/delay}} @@ -78,6 +91,38 @@ {{/if~}} {{~/each~}} + {{#if ../edit_url}} + + + {{~icon_img 'edit'~}} + + + {{/if}} + {{#if ../delete_url}} + + + {{~icon_img 'trash'~}} + + + {{/if}} + {{#if ../custom_actions}} + {{#each ../custom_actions}} + + {{!Title property sets the tooltip text}} + {{~icon_img this.icon~}} + + + {{/each}} + {{/if}} + {{#if _sqlpage_actions}} + {{#each _sqlpage_actions}} + + + {{~icon_img this.icon~}} + + + {{/each}} + {{/if}} {{!~ After this has been rendered, if this was a footer, we need to reopen a new From be67d3e4ae990f7a2efb5b7b8676153391b5c528 Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Tue, 14 Oct 2025 19:17:56 -0700 Subject: [PATCH 02/45] Modified new table example. --- .../sqlpage/migrations/01_documentation.sql | 135 ++++++------------ 1 file changed, 45 insertions(+), 90 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/01_documentation.sql b/examples/official-site/sqlpage/migrations/01_documentation.sql index c9630fbf..b9fae3d9 100644 --- a/examples/official-site/sqlpage/migrations/01_documentation.sql +++ b/examples/official-site/sqlpage/migrations/01_documentation.sql @@ -1001,88 +1001,66 @@ This will generate a table with the stores in the first column, and the items in ), ( 'table', -'# Using row based custom actions in a table +'## Using Action Buttons in a table. -The table has a column of buttons, each button defined by the `_sqlpage_actions` column at the table level, and by the `_sqlpage_actions` property at the row level. +### Preset Actions: `edit_url` & `delete_url` +Since edit and delete are common actions, the `table` component has dedicated `edit_url` and `delete_url` properties to add buttons for these actions. +The value of these properties should be a URL, containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row. -```sql - SELECT - name, vendor, product_number, facility_name, - lot_number, status, date_of_expiration, - --Use the unique identifier of the row as the _sqlpage_id property - standard_id AS _sqlpage_id, - --Build an array of objects, each object defining a button with the following properties: name, icon, link, tooltip - json_array(--SQLite specific, refer to your database documentation for the equivalent JSON functions - --The {id} placeholder in the link property will be replaced by the value of the _sqlpage_id property for that row. - json_object(''name'', ''history'', ''tooltip'', ''View Standard History'', ''link'', ''./history.sql?standard_id={id}'', ''icon'', ''history''), - json_object(''name'', ''view_coa'', ''tooltip'', ''View Certificate of Analysis'', ''link'', c_of_a_path, ''icon'', ''file-type-pdf''), - json_object(''name'', ''edit'', ''tooltip'', ''Edit Standard'', ''link'', ''./update.sql?id={id}'', ''icon'', ''pencil''), - --We want different actions based on the status of the standard, so we use a CASE statement to build the appropriate action - CASE - WHEN status = ''Available'' THEN json_object( - ''name'',''Action'', - ''tooltip'',''Set In Use'', - ''link'',''./actions/set_in_use.sql?standard_id='' || standard_id, - ''icon'',''caret-right'' - ) - WHEN status = ''In Use'' THEN json_object( - ''name'',''Action'', - ''tooltip'',''Retire Standard'', - ''link'',''./actions/retire.sql?standard_id='' || standard_id, - ''icon'',''test-pipe-off'' - ) - WHEN status = ''Retired'' THEN json_object( - ''name'',''Action'', - ''tooltip'',''Discard Standard'', - ''link'',''./actions/discard.sql?standard_id='' || standard_id, - ''icon'',''flask-off'' - ) - -- Include an action with no link or icon as a placeholder to keep the buttons aligned and make sure the header is correct. - WHEN status = ''Discarded'' THEN json_object(''name'',''Action'') - - ELSE json_object(''name'',''Action'') - END - ) - AS _sqlpage_actions - FROM standard; - - ``` +### Column with fixed action buttons +You may want to add custom action buttons to your table rows, for instance to view details, download a file, or perform a custom operation. +For this, the `table` component has a `custom_actions` property that lets you define a column of buttons, each button defined by a name, an icon, a link, and an optional tooltip. - ' +### Column with variable action buttons + +The `table` component also supports the row level `_sqlpage_actions` column in your data table. +This is helpful if you want a more complex logic, for instance to disable a button on some rows, or to change the link or icon based on the row data. + +> WARNING! +> If the number of array items in `_sqlpage_actions` is not consistent across all rows, the table may not render correctly. +> You can leave blank spaces by including an object with only the `name` property. + +The table has a column of buttons, each button defined by the `_sqlpage_actions` column at the table level, and by the `_sqlpage_actions` property at the row level. +### `custom_actions` & `_sqlpage_actions` JSON properties. +Each button is defined by the following properties: +* `name`: sets the column header and the tooltip if no tooltip is provided, +* `tooltip`: text to display when hovering over the button, +* `link`: the URL to navigate to when the button is clicked, possibly containing the {id} placeholder that will be replaced by the value of the `_sqlpage_id` property for that row, +* `icon`: the tabler icon name or image link to display on the button + +### Example using all of the above +' , json('[ { - "component": "table" + "component": "table", + "edit_url": "./update.sql?id={id}", + "delete_url": "./delete.sql?id={id}", + "custom_actions": [ + { + "name": "history", + "tooltip": "View Standard History", + "link": "./history.sql?standard_id={id}", + "icon": "history" + } + ] }, { "name": "CalStd", "vendor": "PharmaCo", "product_number": "P1234", - "facility_name": "A Plant", "lot_number": "T23523", "status": "Available", "date_of_expiration": "2026-10-13", "_sqlpage_id": 32, "_sqlpage_actions": [ - { - "name": "history", - "tooltip": "View Standard History", - "link": "./history.sql?standard_id={id}", - "icon": "history" - }, { "name": "view_coa", "tooltip": "View Certificate of Analysis", - "link": "/c_of_a\\2025-09-30_22h01m21s_B69baKoz.pdf", + "link": "/c_of_a/2025-09-30_22h01m21s_B69baKoz.pdf", "icon": "file-type-pdf" }, - { - "name": "edit", - "tooltip": "Edit Standard", - "link": "./update.sql?id={id}", - "icon": "pencil" - }, { "name": "Action", "tooltip": "Set In Use", @@ -1095,30 +1073,17 @@ The table has a column of buttons, each button defined by the `_sqlpage_actions` "name": "CalStd", "vendor": "PharmaCo", "product_number": "P1234", - "facility_name": "A Plant", "lot_number": "T2352", "status": "In Use", "date_of_expiration": "2026-10-14", "_sqlpage_id": 33, "_sqlpage_actions": [ - { - "name": "history", - "tooltip": "View Standard History", - "link": "./history.sql?standard_id={id}", - "icon": "history" - }, { "name": "view_coa", "tooltip": "View Certificate of Analysis", - "link": "/c_of_a\\2025-09-30_22h05m13s_cP7gqMyi.pdf", + "link": "/c_of_a/2025-09-30_22h05m13s_cP7gqMyi.pdf", "icon": "file-type-pdf" }, - { - "name": "edit", - "tooltip": "Edit Standard", - "link": "./update.sql?id={id}", - "icon": "pencil" - }, { "name": "Action", "tooltip": "Retire Standard", @@ -1131,35 +1096,25 @@ The table has a column of buttons, each button defined by the `_sqlpage_actions` "name": "CalStd", "vendor": "PharmaCo", "product_number": "P1234", - "facility_name": "A Plant", "lot_number": "A123", "status": "Discarded", "date_of_expiration": "2026-09-30", "_sqlpage_id": 31, "_sqlpage_actions": [ - { - "name": "history", - "tooltip": "View Standard History", - "link": "./history.sql?standard_id={id}", - "icon": "history" - }, { "name": "view_coa", "tooltip": "View Certificate of Analysis", - "link": "#", + "link": "025-09-30_22h01m21s_B439baKoz.pdf", "icon": "file-type-pdf" }, { - "name": "edit", - "tooltip": "Edit Standard", - "link": "./update.sql?id={id}", - "icon": "pencil" - }, - null + "name": "Action" + } ] } -]') - ); +]' +) +); From 3654d4272bdd1b7ff0d559327b498f026fda3361 Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Tue, 14 Oct 2025 19:43:02 -0700 Subject: [PATCH 03/45] Updated class settings in table.handlebars so that action buttons are centered, and _col_{name} is included in new rows. --- sqlpage/templates/table.handlebars | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/sqlpage/templates/table.handlebars b/sqlpage/templates/table.handlebars index 639f9341..bf1cd3e4 100644 --- a/sqlpage/templates/table.handlebars +++ b/sqlpage/templates/table.handlebars @@ -53,16 +53,16 @@ {{/if}} {{/each}} - {{#if ../edit_url}}Edit{{/if}} - {{#if ../delete_url}}Delete{{/if}} + {{#if ../edit_url}}Edit{{/if}} + {{#if ../delete_url}}Delete{{/if}} {{#if ../custom_actions}} {{#each ../custom_actions}} - {{this.name}} + {{this.name}} {{/each}} {{/if}} {{#if _sqlpage_actions}} {{#each _sqlpage_actions}} - {{this.name}} + {{this.name}} {{/each}} {{/if}} @@ -92,14 +92,14 @@ {{/if~}} {{~/each~}} {{#if ../edit_url}} - + {{~icon_img 'edit'~}} {{/if}} {{#if ../delete_url}} - + {{~icon_img 'trash'~}} @@ -107,8 +107,8 @@ {{/if}} {{#if ../custom_actions}} {{#each ../custom_actions}} - - {{!Title property sets the tooltip text}} + + {{!Title property sets the tooltip text}} {{~icon_img this.icon~}} @@ -116,8 +116,8 @@ {{/if}} {{#if _sqlpage_actions}} {{#each _sqlpage_actions}} - - + + {{~icon_img this.icon~}} From 83be28bd60d5a94940c5357b9e74628ad7bb13a8 Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Tue, 14 Oct 2025 20:23:19 -0700 Subject: [PATCH 04/45] Eliminate clippy redundant else error from src/webserver/http.rs cargo clippy Checking sqlpage v0.38.0 error: redundant else block --> src\webserver\http.rs:493:6 | 493 | } else { | ______^ 494 | | if let Some(domain) = &config.https_domain { 495 | | let mut listen_on_https = listen_on; 496 | | listen_on_https.set_port(443); ... | 511 | | } | |_____^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#redundant_else note: the lint level is defined here --> src\lib.rs:1:9 | 1 | #![deny(clippy::pedantic)] | ^^^^^^^^^^^^^^^^ = note: `#[deny(clippy::redundant_else)]` implied by `#[deny(clippy::pedantic)]` help: remove the `else` block and move the contents out | 493 ~ } 494 + if let Some(domain) = &config.https_domain { 495 + let mut listen_on_https = listen_on; 496 + listen_on_https.set_port(443); 497 + log::debug!("Will start HTTPS server on {listen_on_https}"); 498 + let config = make_auto_rustls_config(domain, config); 499 + server = server 500 + .bind_rustls_0_23(listen_on_https, config) 501 + .map_err(|e| bind_error(e, listen_on_https))?; 502 + } else if listen_on.port() == 443 { 503 + bail!("Please specify a value for https_domain in the configuration file. This is required when using HTTPS (port 443)"); 504 + } 505 + if listen_on.port() != 443 { 506 + log::debug!("Will start HTTP server on {listen_on}"); 507 + server = server 508 + .bind(listen_on) 509 + .map_err(|e| bind_error(e, listen_on))?; 510 + } | error: could not compile `sqlpage` (lib) due to 1 previous error --- src/webserver/http.rs | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/src/webserver/http.rs b/src/webserver/http.rs index 88c9966e..6f163a90 100644 --- a/src/webserver/http.rs +++ b/src/webserver/http.rs @@ -490,24 +490,23 @@ pub async fn run_server(config: &AppConfig, state: AppState) -> anyhow::Result<( } #[cfg(not(target_family = "unix"))] anyhow::bail!("Unix sockets are not supported on your operating system. Use listen_on instead of unix_socket."); - } else { - if let Some(domain) = &config.https_domain { - let mut listen_on_https = listen_on; - listen_on_https.set_port(443); - log::debug!("Will start HTTPS server on {listen_on_https}"); - let config = make_auto_rustls_config(domain, config); - server = server - .bind_rustls_0_23(listen_on_https, config) - .map_err(|e| bind_error(e, listen_on_https))?; - } else if listen_on.port() == 443 { - bail!("Please specify a value for https_domain in the configuration file. This is required when using HTTPS (port 443)"); - } - if listen_on.port() != 443 { - log::debug!("Will start HTTP server on {listen_on}"); - server = server - .bind(listen_on) - .map_err(|e| bind_error(e, listen_on))?; - } + } + if let Some(domain) = &config.https_domain { + let mut listen_on_https = listen_on; + listen_on_https.set_port(443); + log::debug!("Will start HTTPS server on {listen_on_https}"); + let config = make_auto_rustls_config(domain, config); + server = server + .bind_rustls_0_23(listen_on_https, config) + .map_err(|e| bind_error(e, listen_on_https))?; + } else if listen_on.port() == 443 { + bail!("Please specify a value for https_domain in the configuration file. This is required when using HTTPS (port 443)"); + } + if listen_on.port() != 443 { + log::debug!("Will start HTTP server on {listen_on}"); + server = server + .bind(listen_on) + .map_err(|e| bind_error(e, listen_on))?; } log_welcome_message(config); From 5d5d1f94d78248283d35035f8a5f12dcb852694d Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Sat, 18 Oct 2025 12:19:15 +0200 Subject: [PATCH 05/45] The login component is an authentication form for users of an application. --- .../sqlpage/migrations/68_login.sql | 52 +++++++++++ .../99_shared_id_class_attributes.sql | 6 +- sqlpage/templates/login.handlebars | 89 +++++++++++++++++++ 3 files changed, 145 insertions(+), 2 deletions(-) create mode 100644 examples/official-site/sqlpage/migrations/68_login.sql create mode 100644 sqlpage/templates/login.handlebars diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql new file mode 100644 index 00000000..7230f759 --- /dev/null +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -0,0 +1,52 @@ +INSERT INTO component(name, icon, description, introduced_in_version) VALUES + ('login', 'password-user', ' +The login component is an authentication form for users of an application. + +It allows the entry of a user account consisting of a username and a password. + +It offers additional features such as the ability to request session persistence or to reset the password.', '0.39.0'); + +INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'login', * FROM (VALUES + ('title','Title of the authentication form.','TEXT',TRUE,TRUE), + ('enctype','Form data encoding.','TEXT',TRUE,TRUE), + ('action','An optional link to a target page that will handle the results of the form. ','TEXT',TRUE,TRUE), + ('username','User account identifier.','TEXT',TRUE,FALSE), + ('password','User password.','TEXT',TRUE,FALSE), + ('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE), + ('forgot_password_text','A text for the link allowing the user to reset their password. If the text is empty, the link is not displayed.','TEXT',TRUE,TRUE), + ('forgot_password_link','The link to the page allowing the user to reset their password.','TEXT',TRUE,TRUE), + ('remember_me_text','A text for the option allowing the user to request the preservation of their work session. The name of the field is remember. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE), + ('footer','A text placed at the bottom of the authentication form.','TEXT',TRUE,TRUE), + ('footer_md','A markdown text placed at the bottom of the authentication form. Useful for creating links to other pages (creating a new account, contacting technical support, etc.).','TEXT',TRUE,TRUE), + ('validate','The text to display in the button at the bottom of the form that submits the values.','TEXT',TRUE,FALSE), + ('validate_color','The color of the button at the bottom of the form that submits the values. Omit this property to use the default color.','COLOR',TRUE,TRUE), + ('validate_shape','The shape of the validation button.','TEXT',TRUE,TRUE), + ('validate_outline','A color to outline the validation button.','COLOR',TRUE,TRUE), + ('validate_size','The size of the validation button.','TEXT',TRUE,TRUE) +) x; + +-- Insert example(s) for the component +INSERT INTO example(component, description, properties) +VALUES ( + 'login', + 'Using the main options of the login component', + JSON( + '[ + { + "component": "login", + "action": "login.sql", + "image": "../assets/icon.webp", + "title": "Please login to your account", + "username": "Username", + "password": "Password", + "forgot_password_text": "Forgot your password?", + "forgot_password_link": "reset_password.sql", + "remember_me_text": "Remember me", + "footer_md": "Don''t have an account? [Register here](register.sql)", + "validate": "Sign in" + } + ]' + ) + ); + +-- 265707.png \ No newline at end of file diff --git a/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql b/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql index 47e66576..df054541 100644 --- a/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql +++ b/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql @@ -18,7 +18,8 @@ FROM (VALUES ('title', TRUE), ('tracking', TRUE), ('text', TRUE), - ('carousel', TRUE) + ('carousel', TRUE), + ('login', TRUE) ); INSERT INTO parameter(component, top_level, name, description, type, optional) @@ -49,6 +50,7 @@ FROM (VALUES ('timeline', FALSE), ('title', TRUE), ('tracking', TRUE), - ('carousel', TRUE) + ('carousel', TRUE), + ('login', TRUE) ); diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars new file mode 100644 index 00000000..f292a18d --- /dev/null +++ b/sqlpage/templates/login.handlebars @@ -0,0 +1,89 @@ +
+
+
+
+ {{#if image}} +
+ +
+ {{/if}} + {{#if title}} +

{{title}}

+ {{/if}} + +
+ + + + + + + + +
+ +
+ + + + + + + + + +
+ {{#if remember_me_text}} + + {{/if}} +
+ +
+ {{#if (or footer footer_md)}} +
+
+ + {{#if footer}} + {{footer}} + {{else}} + {{#if footer_md}} + {{{markdown footer_md}}} + {{/if}} + {{/if}} + +
+ {{/if}} +
+
+
+
From 6729e10a01fc442eb981490440c564c50497f755 Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Mon, 20 Oct 2025 09:31:36 -0700 Subject: [PATCH 06/45] Added sqlpage version number information to the new components. --- .../official-site/sqlpage/migrations/01_documentation.sql | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/01_documentation.sql b/examples/official-site/sqlpage/migrations/01_documentation.sql index b9fae3d9..410dfe2f 100644 --- a/examples/official-site/sqlpage/migrations/01_documentation.sql +++ b/examples/official-site/sqlpage/migrations/01_documentation.sql @@ -810,15 +810,15 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('money', 'Name of a numeric column whose values should be displayed as currency amounts, in the currency defined by the `currency` property. This argument can be repeated multiple times.', 'TEXT', TRUE, TRUE), ('currency', 'The ISO 4217 currency code (e.g., USD, EUR, GBP, etc.) to use when formatting monetary values.', 'TEXT', TRUE, TRUE), ('number_format_digits', 'Maximum number of decimal digits to display for numeric values.', 'INTEGER', TRUE, TRUE), - ('edit_url', 'If set, an edit button will be added to each row. The value of this property should be a URL, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row. Clicking the edit button will take the user to that URL.', 'TEXT', TRUE, TRUE), - ('delete_url', 'If set, a delete button will be added to each row. The value of this property should be a URL, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row. Clicking the delete button will take the user to that URL.', 'TEXT', TRUE, TRUE), - ('custom_actions', 'If set, a column of custom action buttons will be added to each row. The value of this property should be a JSON array of objects, each object defining a button with the following properties: `name` (the text to display on the button), `icon` (the tabler icon name or image link to display on the button), `link` (the URL to navigate to when the button is clicked, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row), and `tooltip` (optional text to display when hovering over the button).', 'JSON', TRUE, TRUE), + ('edit_url', 'If set, an edit button will be added to each row. The value of this property should be a URL, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row. Clicking the edit button will take the user to that URL. Added in v0.39.0', 'TEXT', TRUE, TRUE), + ('delete_url', 'If set, a delete button will be added to each row. The value of this property should be a URL, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row. Clicking the delete button will take the user to that URL. Added in v0.39.0', 'TEXT', TRUE, TRUE), + ('custom_actions', 'If set, a column of custom action buttons will be added to each row. The value of this property should be a JSON array of objects, each object defining a button with the following properties: `name` (the text to display on the button), `icon` (the tabler icon name or image link to display on the button), `link` (the URL to navigate to when the button is clicked, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row), and `tooltip` (optional text to display when hovering over the button). Added in v0.39.0', 'JSON', TRUE, TRUE), -- row level ('_sqlpage_css_class', 'For advanced users. Sets a css class on the table row. Added in v0.8.0.', 'TEXT', FALSE, TRUE), ('_sqlpage_color', 'Sets the background color of the row. Added in v0.8.0.', 'COLOR', FALSE, TRUE), ('_sqlpage_footer', 'Sets this row as the table footer. It is recommended that this parameter is applied to the last row. Added in v0.34.0.', 'BOOLEAN', FALSE, TRUE), ('_sqlpage_id', 'Sets the id of the html tabler row element. Allows you to make links targeting a specific row in a table.', 'TEXT', FALSE, TRUE), - ('_sqlpage_actions', 'Sets custom action buttons for this specific row in addition to any defined at the table level, The value of this property should be a JSON array of objects, each object defining a button with the following properties: `name` (the text to display on the button), `icon` (the tabler icon name or image link to display on the button), `link` (the URL to navigate to when the button is clicked, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row), and `tooltip` (optional text to display when hovering over the button).', 'JSON', FALSE, TRUE) + ('_sqlpage_actions', 'Sets custom action buttons for this specific row in addition to any defined at the table level, The value of this property should be a JSON array of objects, each object defining a button with the following properties: `name` (the text to display on the button), `icon` (the tabler icon name or image link to display on the button), `link` (the URL to navigate to when the button is clicked, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row), and `tooltip` (optional text to display when hovering over the button). Added in v0.39.0', 'JSON', FALSE, TRUE) ) x; INSERT INTO example(component, description, properties) VALUES From 5d9df45231ab3a68e847826fcee1c30763b320ca Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Mon, 20 Oct 2025 09:53:10 -0700 Subject: [PATCH 07/45] Undo changes to http.rs since it is not part of the feature. --- src/webserver/http.rs | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/src/webserver/http.rs b/src/webserver/http.rs index 88c9966e..6f163a90 100644 --- a/src/webserver/http.rs +++ b/src/webserver/http.rs @@ -490,24 +490,23 @@ pub async fn run_server(config: &AppConfig, state: AppState) -> anyhow::Result<( } #[cfg(not(target_family = "unix"))] anyhow::bail!("Unix sockets are not supported on your operating system. Use listen_on instead of unix_socket."); - } else { - if let Some(domain) = &config.https_domain { - let mut listen_on_https = listen_on; - listen_on_https.set_port(443); - log::debug!("Will start HTTPS server on {listen_on_https}"); - let config = make_auto_rustls_config(domain, config); - server = server - .bind_rustls_0_23(listen_on_https, config) - .map_err(|e| bind_error(e, listen_on_https))?; - } else if listen_on.port() == 443 { - bail!("Please specify a value for https_domain in the configuration file. This is required when using HTTPS (port 443)"); - } - if listen_on.port() != 443 { - log::debug!("Will start HTTP server on {listen_on}"); - server = server - .bind(listen_on) - .map_err(|e| bind_error(e, listen_on))?; - } + } + if let Some(domain) = &config.https_domain { + let mut listen_on_https = listen_on; + listen_on_https.set_port(443); + log::debug!("Will start HTTPS server on {listen_on_https}"); + let config = make_auto_rustls_config(domain, config); + server = server + .bind_rustls_0_23(listen_on_https, config) + .map_err(|e| bind_error(e, listen_on_https))?; + } else if listen_on.port() == 443 { + bail!("Please specify a value for https_domain in the configuration file. This is required when using HTTPS (port 443)"); + } + if listen_on.port() != 443 { + log::debug!("Will start HTTP server on {listen_on}"); + server = server + .bind(listen_on) + .map_err(|e| bind_error(e, listen_on))?; } log_welcome_message(config); From c371b23af2252dba0e8f8ffbe06601d535f26bc5 Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Mon, 20 Oct 2025 10:20:02 -0700 Subject: [PATCH 08/45] Undo changes to http.rs --- src/webserver/http.rs | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/src/webserver/http.rs b/src/webserver/http.rs index 6f163a90..88c9966e 100644 --- a/src/webserver/http.rs +++ b/src/webserver/http.rs @@ -490,23 +490,24 @@ pub async fn run_server(config: &AppConfig, state: AppState) -> anyhow::Result<( } #[cfg(not(target_family = "unix"))] anyhow::bail!("Unix sockets are not supported on your operating system. Use listen_on instead of unix_socket."); - } - if let Some(domain) = &config.https_domain { - let mut listen_on_https = listen_on; - listen_on_https.set_port(443); - log::debug!("Will start HTTPS server on {listen_on_https}"); - let config = make_auto_rustls_config(domain, config); - server = server - .bind_rustls_0_23(listen_on_https, config) - .map_err(|e| bind_error(e, listen_on_https))?; - } else if listen_on.port() == 443 { - bail!("Please specify a value for https_domain in the configuration file. This is required when using HTTPS (port 443)"); - } - if listen_on.port() != 443 { - log::debug!("Will start HTTP server on {listen_on}"); - server = server - .bind(listen_on) - .map_err(|e| bind_error(e, listen_on))?; + } else { + if let Some(domain) = &config.https_domain { + let mut listen_on_https = listen_on; + listen_on_https.set_port(443); + log::debug!("Will start HTTPS server on {listen_on_https}"); + let config = make_auto_rustls_config(domain, config); + server = server + .bind_rustls_0_23(listen_on_https, config) + .map_err(|e| bind_error(e, listen_on_https))?; + } else if listen_on.port() == 443 { + bail!("Please specify a value for https_domain in the configuration file. This is required when using HTTPS (port 443)"); + } + if listen_on.port() != 443 { + log::debug!("Will start HTTP server on {listen_on}"); + server = server + .bind(listen_on) + .map_err(|e| bind_error(e, listen_on))?; + } } log_welcome_message(config); From 32d6863982bfa90f953fc0f13ec706e6d4848b31 Mon Sep 17 00:00:00 2001 From: Spencer Hansen Date: Mon, 20 Oct 2025 15:48:07 -0700 Subject: [PATCH 09/45] Added checks for active status to dropdown items in shell.handlebars. --- sqlpage/templates/shell.handlebars | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sqlpage/templates/shell.handlebars b/sqlpage/templates/shell.handlebars index 35f31b91..0e1c7a8e 100644 --- a/sqlpage/templates/shell.handlebars +++ b/sqlpage/templates/shell.handlebars @@ -95,7 +95,7 @@ {{~#with (parse_json this)}} {{#if (or (or this.title this.icon) this.image)}}
  • - {{~#each this.submenu~}} {{#if (or (or this.title this.icon) this.image)}} - + {{~#if this.image~}} {{~#if (eq ../this.size 'sm')}} From f8a47cdea3aba52761a4c27be1542176a2549380 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Tue, 21 Oct 2025 09:48:33 +0200 Subject: [PATCH 10/45] changelog --- CHANGELOG.md | 1 + Cargo.lock | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1cd2975a..db8fe4d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## v0.38.1 - Ability to execute sql for URL paths with another extension. If you create sitemap.xml.sql, it will be executed for example.com/sitemap.xml - Display source line info in errors even when the database does not return a precise error position. In this case, the entire problematic SQL statement is referenced. + - The shell with a vertical sidebar can now have "active" elements, just like the horizontal header bar. ## v0.38.0 - Added support for the Open Database Connectivity (ODBC) standard. diff --git a/Cargo.lock b/Cargo.lock index 3d36bc87..836767d2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -936,9 +936,9 @@ dependencies = [ [[package]] name = "clap" -version = "4.5.49" +version = "4.5.50" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f4512b90fa68d3a9932cea5184017c5d200f5921df706d45e853537dea51508f" +checksum = "0c2cfd7bf8a6017ddaa4e32ffe7403d547790db06bd171c1c53926faab501623" dependencies = [ "clap_builder", "clap_derive", @@ -946,9 +946,9 @@ dependencies = [ [[package]] name = "clap_builder" -version = "4.5.49" +version = "4.5.50" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0025e98baa12e766c67ba13ff4695a887a1eba19569aad00a472546795bd6730" +checksum = "0a4c05b9e80c5ccd3a7ef080ad7b6ba7d6fc00a985b8b157197075677c82c7a0" dependencies = [ "anstream", "anstyle", From 842f67cf83f5756d5e2692c535c1fc6b5365d392 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Tue, 21 Oct 2025 11:35:08 +0200 Subject: [PATCH 11/45] update documentation --- .../sqlpage/migrations/01_documentation.sql | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/01_documentation.sql b/examples/official-site/sqlpage/migrations/01_documentation.sql index 410dfe2f..960943f4 100644 --- a/examples/official-site/sqlpage/migrations/01_documentation.sql +++ b/examples/official-site/sqlpage/migrations/01_documentation.sql @@ -1010,7 +1010,7 @@ The value of these properties should be a URL, containing the `{id}` placeholder ### Column with fixed action buttons You may want to add custom action buttons to your table rows, for instance to view details, download a file, or perform a custom operation. -For this, the `table` component has a `custom_actions` property that lets you define a column of buttons, each button defined by a name, an icon, a link, and an optional tooltip. +For this, the `table` component has a `custom_actions` top-level property that lets you define a column of buttons, each button defined by a name, an icon, a link, and an optional tooltip. ### Column with variable action buttons @@ -1026,7 +1026,7 @@ The table has a column of buttons, each button defined by the `_sqlpage_actions` Each button is defined by the following properties: * `name`: sets the column header and the tooltip if no tooltip is provided, * `tooltip`: text to display when hovering over the button, -* `link`: the URL to navigate to when the button is clicked, possibly containing the {id} placeholder that will be replaced by the value of the `_sqlpage_id` property for that row, +* `link`: the URL to navigate to when the button is clicked, possibly containing the `{id}` placeholder that will be replaced by the value of the `_sqlpage_id` property for that row, * `icon`: the tabler icon name or image link to display on the button ### Example using all of the above @@ -1049,14 +1049,14 @@ Each button is defined by the following properties: { "name": "CalStd", "vendor": "PharmaCo", - "product_number": "P1234", - "lot_number": "T23523", + "Product": "P1234", + "lot number": "T23523", "status": "Available", - "date_of_expiration": "2026-10-13", + "expires on": "2026-10-13", "_sqlpage_id": 32, "_sqlpage_actions": [ { - "name": "view_coa", + "name": "View PDF", "tooltip": "View Certificate of Analysis", "link": "/c_of_a/2025-09-30_22h01m21s_B69baKoz.pdf", "icon": "file-type-pdf" @@ -1072,14 +1072,14 @@ Each button is defined by the following properties: { "name": "CalStd", "vendor": "PharmaCo", - "product_number": "P1234", - "lot_number": "T2352", + "Product": "P1234", + "lot number": "T2352", "status": "In Use", - "date_of_expiration": "2026-10-14", + "expires on": "2026-10-14", "_sqlpage_id": 33, "_sqlpage_actions": [ { - "name": "view_coa", + "name": "View PDF", "tooltip": "View Certificate of Analysis", "link": "/c_of_a/2025-09-30_22h05m13s_cP7gqMyi.pdf", "icon": "file-type-pdf" @@ -1095,14 +1095,14 @@ Each button is defined by the following properties: { "name": "CalStd", "vendor": "PharmaCo", - "product_number": "P1234", - "lot_number": "A123", + "Product": "P1234", + "lot number": "A123", "status": "Discarded", - "date_of_expiration": "2026-09-30", + "expires on": "2026-09-30", "_sqlpage_id": 31, "_sqlpage_actions": [ { - "name": "view_coa", + "name": "View PDF", "tooltip": "View Certificate of Analysis", "link": "025-09-30_22h01m21s_B439baKoz.pdf", "icon": "file-type-pdf" From a44341482a0d579647459590105469d61e4a4cef Mon Sep 17 00:00:00 2001 From: lovasoa Date: Tue, 21 Oct 2025 11:39:26 +0200 Subject: [PATCH 12/45] changelog + 0.39 --- CHANGELOG.md | 3 ++- Cargo.lock | 2 +- Cargo.toml | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db8fe4d0..8baa84bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,10 @@ # CHANGELOG.md -## v0.38.1 +## v0.39.0 - Ability to execute sql for URL paths with another extension. If you create sitemap.xml.sql, it will be executed for example.com/sitemap.xml - Display source line info in errors even when the database does not return a precise error position. In this case, the entire problematic SQL statement is referenced. - The shell with a vertical sidebar can now have "active" elements, just like the horizontal header bar. + - New `edit_url`, `delete_url`, and `custom_actions` properties in the [table](https://sql-page.com/component.sql?component=table) component to easily add nice icon buttons to a table. ## v0.38.0 - Added support for the Open Database Connectivity (ODBC) standard. diff --git a/Cargo.lock b/Cargo.lock index 836767d2..2bfa8581 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4219,7 +4219,7 @@ dependencies = [ [[package]] name = "sqlpage" -version = "0.38.1" +version = "0.39.0" dependencies = [ "actix-multipart", "actix-rt", diff --git a/Cargo.toml b/Cargo.toml index 373c1078..f4a84374 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "sqlpage" -version = "0.38.1" +version = "0.39.0" edition = "2021" description = "Build data user interfaces entirely in SQL. A web server that takes .sql files and formats the query result using pre-made configurable professional-looking components." keywords = ["web", "sql", "framework"] From f466bcc21de2599f556fd39c870a43faeed1d6a5 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Tue, 21 Oct 2025 11:54:31 +0200 Subject: [PATCH 13/45] remove broken links --- .../sqlpage/migrations/01_documentation.sql | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/01_documentation.sql b/examples/official-site/sqlpage/migrations/01_documentation.sql index 960943f4..dabd6d76 100644 --- a/examples/official-site/sqlpage/migrations/01_documentation.sql +++ b/examples/official-site/sqlpage/migrations/01_documentation.sql @@ -1035,13 +1035,13 @@ Each button is defined by the following properties: json('[ { "component": "table", - "edit_url": "./update.sql?id={id}", - "delete_url": "./delete.sql?id={id}", + "edit_url": "/examples/show_variables.sql?action=edit&update_id={id}", + "delete_url": "/examples/show_variables.sql?action=delete&delete_id={id}", "custom_actions": [ { "name": "history", "tooltip": "View Standard History", - "link": "./history.sql?standard_id={id}", + "link": "/examples/show_variables.sql?action=history&standard_id={id}", "icon": "history" } ] @@ -1057,14 +1057,14 @@ Each button is defined by the following properties: "_sqlpage_actions": [ { "name": "View PDF", - "tooltip": "View Certificate of Analysis", - "link": "/c_of_a/2025-09-30_22h01m21s_B69baKoz.pdf", + "tooltip": "View Presentation", + "link": "https://sql-page.com/pgconf/2024-sqlpage-badass.pdf", "icon": "file-type-pdf" }, { "name": "Action", "tooltip": "Set In Use", - "link": "./actions/set_in_use.sql?standard_id=32", + "link": "/examples/show_variables.sql?action=set_in_use&standard_id=32", "icon": "caret-right" } ] @@ -1080,14 +1080,14 @@ Each button is defined by the following properties: "_sqlpage_actions": [ { "name": "View PDF", - "tooltip": "View Certificate of Analysis", - "link": "/c_of_a/2025-09-30_22h05m13s_cP7gqMyi.pdf", + "tooltip": "View Presentation", + "link": "https://sql-page.com/pgconf/2024-sqlpage-badass.pdf", "icon": "file-type-pdf" }, { "name": "Action", "tooltip": "Retire Standard", - "link": "./actions/retire.sql?standard_id=33", + "link": "/examples/show_variables.sql?action=retire&standard_id=33", "icon": "test-pipe-off" } ] @@ -1103,8 +1103,8 @@ Each button is defined by the following properties: "_sqlpage_actions": [ { "name": "View PDF", - "tooltip": "View Certificate of Analysis", - "link": "025-09-30_22h01m21s_B439baKoz.pdf", + "tooltip": "View Presentation", + "link": "https://sql-page.com/pgconf/2024-sqlpage-badass.pdf", "icon": "file-type-pdf" }, { From b485028e373984fad7bc3a3bc42b4c3ecfe82ab3 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Tue, 21 Oct 2025 14:07:41 +0200 Subject: [PATCH 14/45] Add end-to-end tests for table action buttons - Implemented tests for edit, delete, and custom action buttons in the table component. - Verified visibility and correct href attributes for action buttons. - Added checks for disabled action buttons in the table. Updated package dependencies for Playwright and Node types in package.json and package-lock.json. --- tests/end-to-end/official-site.spec.ts | 84 ++++++++++++++++++++++++++ tests/end-to-end/package-lock.json | 38 ++++++------ tests/end-to-end/package.json | 2 +- 3 files changed, 104 insertions(+), 20 deletions(-) diff --git a/tests/end-to-end/official-site.spec.ts b/tests/end-to-end/official-site.spec.ts index 7d840811..eda20e7e 100644 --- a/tests/end-to-end/official-site.spec.ts +++ b/tests/end-to-end/official-site.spec.ts @@ -213,3 +213,87 @@ test("modal", async ({ page }) => { await modal.getByRole("button", { label: "Close" }).first().click(); await expect(modal).not.toBeVisible(); }); + +test("table action buttons - edit_url and delete_url", async ({ page }) => { + await page.goto(`${BASE}/documentation.sql?component=table`); + const tableSection = page.locator(".table-responsive", { + has: page.getByRole("cell", { name: "PharmaCo" }), + }); + + const editButton = tableSection.getByTitle("Edit").first(); + await expect(editButton).toBeVisible(); + await expect(editButton).toHaveAttribute("href", /action=edit&update_id=\d+/); + + const deleteButton = tableSection.getByTitle("Delete").first(); + await expect(deleteButton).toBeVisible(); + await expect(deleteButton).toHaveAttribute( + "href", + /action=delete&delete_id=\d+/, + ); +}); + +test("table action buttons - custom_actions", async ({ page }) => { + await page.goto(`${BASE}/documentation.sql?component=table`); + const tableSection = page.locator(".table-responsive", { + has: page.getByRole("cell", { name: "PharmaCo" }), + }); + + const historyButton = tableSection + .getByTitle("View Standard History") + .first(); + await expect(historyButton).toBeVisible(); + await expect(historyButton).toHaveAttribute( + "href", + /action=history&standard_id=\d+/, + ); +}); + +test("table action buttons - _sqlpage_actions", async ({ page }) => { + await page.goto(`${BASE}/documentation.sql?component=table`); + const tableSection = page.locator(".table-responsive", { + has: page.getByRole("cell", { name: "PharmaCo" }), + }); + + const pdfButtons = tableSection.getByTitle("View Presentation"); + await expect(pdfButtons.first()).toBeVisible(); + await expect(pdfButtons).toHaveCount(3); + + const firstPdfButton = pdfButtons.first(); + await expect(firstPdfButton).toHaveAttribute( + "href", + "https://sql-page.com/pgconf/2024-sqlpage-badass.pdf", + ); + + const setInUseButton = tableSection.getByTitle("Set In Use"); + await expect(setInUseButton).toBeVisible(); + await expect(setInUseButton).toHaveAttribute( + "href", + /action=set_in_use&standard_id=32/, + ); + + const retireButton = tableSection.getByTitle("Retire Standard"); + await expect(retireButton).toBeVisible(); + await expect(retireButton).toHaveAttribute( + "href", + /action=retire&standard_id=33/, + ); +}); + +test("table action buttons - disabled action", async ({ page }) => { + await page.goto(`${BASE}/documentation.sql?component=table`); + const tableSection = page.locator(".table-responsive", { + has: page.getByRole("cell", { name: "PharmaCo" }), + }); + + const viewPresentationButtons = tableSection.getByTitle("View Presentation"); + await expect(viewPresentationButtons).toHaveCount(3); + + const actionColumnButtons = tableSection.locator( + "td._col_Action a[data-action='https://github.com/Action']", + ); + await expect(actionColumnButtons).toHaveCount(3); + + const emptyActionButton = actionColumnButtons.last(); + await expect(emptyActionButton).toHaveAttribute("href", "null"); + await expect(emptyActionButton).toHaveAttribute("title", "Action"); +}); diff --git a/tests/end-to-end/package-lock.json b/tests/end-to-end/package-lock.json index d424cb49..875db3cc 100644 --- a/tests/end-to-end/package-lock.json +++ b/tests/end-to-end/package-lock.json @@ -10,17 +10,17 @@ "license": "ISC", "devDependencies": { "@playwright/test": "^1.45.3", - "@types/node": "^22.1.0" + "@types/node": "^24.9.1" } }, "node_modules/@playwright/test": { - "version": "1.53.1", - "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.53.1.tgz", - "integrity": "sha512-Z4c23LHV0muZ8hfv4jw6HngPJkbbtZxTkxPNIg7cJcTc9C28N/p2q7g3JZS2SiKBBHJ3uM1dgDye66bB7LEk5w==", + "version": "1.56.1", + "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.56.1.tgz", + "integrity": "sha512-vSMYtL/zOcFpvJCW71Q/OEGQb7KYBPAdKh35WNSkaZA75JlAO8ED8UN6GUNTm3drWomcbcqRPFqQbLae8yBTdg==", "dev": true, "license": "Apache-2.0", "dependencies": { - "playwright": "1.53.1" + "playwright": "1.56.1" }, "bin": { "playwright": "cli.js" @@ -30,13 +30,13 @@ } }, "node_modules/@types/node": { - "version": "22.15.33", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.15.33.tgz", - "integrity": "sha512-wzoocdnnpSxZ+6CjW4ADCK1jVmd1S/J3ArNWfn8FDDQtRm8dkDg7TA+mvek2wNrfCgwuZxqEOiB9B1XCJ6+dbw==", + "version": "24.9.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-24.9.1.tgz", + "integrity": "sha512-QoiaXANRkSXK6p0Duvt56W208du4P9Uye9hWLWgGMDTEoKPhuenzNcC4vGUmrNkiOKTlIrBoyNQYNpSwfEZXSg==", "dev": true, "license": "MIT", "dependencies": { - "undici-types": "~6.21.0" + "undici-types": "~7.16.0" } }, "node_modules/fsevents": { @@ -55,13 +55,13 @@ } }, "node_modules/playwright": { - "version": "1.53.1", - "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.53.1.tgz", - "integrity": "sha512-LJ13YLr/ocweuwxyGf1XNFWIU4M2zUSo149Qbp+A4cpwDjsxRPj7k6H25LBrEHiEwxvRbD8HdwvQmRMSvquhYw==", + "version": "1.56.1", + "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.56.1.tgz", + "integrity": "sha512-aFi5B0WovBHTEvpM3DzXTUaeN6eN0qWnTkKx4NQaH4Wvcmc153PdaY2UBdSYKaGYw+UyWXSVyxDUg5DoPEttjw==", "dev": true, "license": "Apache-2.0", "dependencies": { - "playwright-core": "1.53.1" + "playwright-core": "1.56.1" }, "bin": { "playwright": "cli.js" @@ -74,9 +74,9 @@ } }, "node_modules/playwright-core": { - "version": "1.53.1", - "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.53.1.tgz", - "integrity": "sha512-Z46Oq7tLAyT0lGoFx4DOuB1IA9D1TPj0QkYxpPVUnGDqHHvDpCftu1J2hM2PiWsNMoZh8+LQaarAWcDfPBc6zg==", + "version": "1.56.1", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.56.1.tgz", + "integrity": "sha512-hutraynyn31F+Bifme+Ps9Vq59hKuUCz7H1kDOcBs+2oGguKkWTU50bBWrtz34OUWmIwpBTWDxaRPXrIXkgvmQ==", "dev": true, "license": "Apache-2.0", "bin": { @@ -87,9 +87,9 @@ } }, "node_modules/undici-types": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", - "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==", + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz", + "integrity": "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==", "dev": true, "license": "MIT" } diff --git a/tests/end-to-end/package.json b/tests/end-to-end/package.json index 26647081..caa9a84c 100644 --- a/tests/end-to-end/package.json +++ b/tests/end-to-end/package.json @@ -12,6 +12,6 @@ "license": "ISC", "devDependencies": { "@playwright/test": "^1.45.3", - "@types/node": "^22.1.0" + "@types/node": "^24.9.1" } } From 8e248b9571e0f1627ded1d650f6b7d2351224462 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 22 Oct 2025 12:38:36 +0000 Subject: [PATCH 15/45] feat: Add Server-Timing header support Co-authored-by: contact --- src/render.rs | 16 +++++++++++-- src/webserver/http.rs | 22 ++++++++++++++++- src/webserver/mod.rs | 1 + src/webserver/server_timing.rs | 43 ++++++++++++++++++++++++++++++++++ 4 files changed, 79 insertions(+), 3 deletions(-) create mode 100644 src/webserver/server_timing.rs diff --git a/src/render.rs b/src/render.rs index aecd118b..52b635a2 100644 --- a/src/render.rs +++ b/src/render.rs @@ -80,7 +80,7 @@ pub enum PageContext { /// Handles the first SQL statements, before the headers have been sent to pub struct HeaderContext { app_state: Arc, - request_context: RequestContext, + pub request_context: RequestContext, pub writer: ResponseWriter, response: HttpResponseBuilder, has_status: bool, @@ -368,7 +368,13 @@ impl HeaderContext { Ok(PageContext::Header(self)) } - async fn start_body(self, data: JsonValue) -> anyhow::Result { + async fn start_body(mut self, data: JsonValue) -> anyhow::Result { + if let Some(ref timing) = self.request_context.server_timing { + let header_value = timing.as_header_value(); + if !header_value.is_empty() { + self.response.insert_header(("Server-Timing", header_value)); + } + } let html_renderer = HtmlRenderContext::new(self.app_state, self.request_context, self.writer, data) .await @@ -382,6 +388,12 @@ impl HeaderContext { } pub fn close(mut self) -> HttpResponse { + if let Some(ref timing) = self.request_context.server_timing { + let header_value = timing.as_header_value(); + if !header_value.is_empty() { + self.response.insert_header(("Server-Timing", header_value)); + } + } self.response.finish() } } diff --git a/src/webserver/http.rs b/src/webserver/http.rs index 88c9966e..d41b07b5 100644 --- a/src/webserver/http.rs +++ b/src/webserver/http.rs @@ -7,6 +7,7 @@ use crate::webserver::content_security_policy::ContentSecurityPolicy; use crate::webserver::database::execute_queries::stop_at_first_error; use crate::webserver::database::{execute_queries::stream_query_results_with_conn, DbItem}; use crate::webserver::http_request_info::extract_request_info; +use crate::webserver::server_timing::ServerTiming; use crate::webserver::ErrorWithStatus; use crate::{AppConfig, AppState, ParsedSqlFile, DEFAULT_404_FILE}; use actix_web::dev::{fn_service, ServiceFactory, ServiceRequest}; @@ -46,6 +47,7 @@ pub struct RequestContext { pub is_embedded: bool, pub source_path: PathBuf, pub content_security_policy: ContentSecurityPolicy, + pub server_timing: Option, } async fn stream_response(stream: impl Stream, mut renderer: AnyRenderBodyContext) { @@ -104,7 +106,14 @@ async fn build_response_header_and_stream>( let writer = ResponseWriter::new(sender); let mut head_context = HeaderContext::new(app_state, request_context, writer); let mut stream = Box::pin(database_entries); + let mut first_row = true; while let Some(item) = stream.next().await { + if first_row { + if let Some(ref mut timing) = head_context.request_context.server_timing { + timing.record("query"); + } + first_row = false; + } let page_context = match item { DbItem::Row(data) => head_context.handle_row(data).await?, DbItem::FinishedQuery => { @@ -167,14 +176,24 @@ async fn render_sql( let app_state = srv_req .app_data::>() .ok_or_else(|| ErrorInternalServerError("no state"))? - .clone() // Cheap reference count increase + .clone() .into_inner(); + let mut server_timing = if !app_state.config.environment.is_prod() { + Some(ServerTiming::new()) + } else { + None + }; + let mut req_param = extract_request_info(srv_req, Arc::clone(&app_state)) .await .map_err(|e| anyhow_err_to_actix(e, &app_state))?; log::debug!("Received a request with the following parameters: {req_param:?}"); + if let Some(ref mut timing) = server_timing { + timing.record("parse"); + } + let (resp_send, resp_recv) = tokio::sync::oneshot::channel::(); let source_path: PathBuf = sql_file.source_path.clone(); actix_web::rt::spawn(async move { @@ -182,6 +201,7 @@ async fn render_sql( is_embedded: req_param.get_variables.contains_key("_sqlpage_embed"), source_path, content_security_policy: ContentSecurityPolicy::with_random_nonce(), + server_timing, }; let mut conn = None; let database_entries_stream = diff --git a/src/webserver/mod.rs b/src/webserver/mod.rs index 9a74cc04..484ad40d 100644 --- a/src/webserver/mod.rs +++ b/src/webserver/mod.rs @@ -38,6 +38,7 @@ pub mod http_client; pub mod http_request_info; mod https; pub mod request_variables; +pub mod server_timing; pub use database::Database; pub use error_with_status::ErrorWithStatus; diff --git a/src/webserver/server_timing.rs b/src/webserver/server_timing.rs new file mode 100644 index 00000000..47a71dae --- /dev/null +++ b/src/webserver/server_timing.rs @@ -0,0 +1,43 @@ +use std::time::Instant; + +#[derive(Debug, Clone)] +pub struct ServerTiming { + start: Instant, + events: Vec, +} + +#[derive(Debug, Clone)] +struct TimingEvent { + name: &'static str, + duration_ms: f64, +} + +impl ServerTiming { + #[must_use] + pub fn new() -> Self { + Self { + start: Instant::now(), + events: Vec::new(), + } + } + + pub fn record(&mut self, name: &'static str) { + let duration_ms = self.start.elapsed().as_secs_f64() * 1000.0; + self.events.push(TimingEvent { name, duration_ms }); + } + + #[must_use] + pub fn as_header_value(&self) -> String { + self.events + .iter() + .map(|event| format!("{};dur={:.2}", event.name, event.duration_ms)) + .collect::>() + .join(", ") + } +} + +impl Default for ServerTiming { + fn default() -> Self { + Self::new() + } +} From 8690e4d1773648ea58246789036d3d3a67ade0cc Mon Sep 17 00:00:00 2001 From: lovasoa Date: Wed, 22 Oct 2025 21:21:38 +0200 Subject: [PATCH 16/45] update dependencies --- Cargo.lock | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 2bfa8581..bdd53446 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2338,9 +2338,9 @@ dependencies = [ [[package]] name = "is_terminal_polyfill" -version = "1.70.1" +version = "1.70.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf" +checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" [[package]] name = "itertools" @@ -3096,9 +3096,9 @@ checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d" [[package]] name = "once_cell_polyfill" -version = "1.70.1" +version = "1.70.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a4895175b425cb1f87721b59f0f286c2092bd4af812243672510e1ac53e2e0ad" +checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" [[package]] name = "openidconnect" @@ -3782,9 +3782,9 @@ dependencies = [ [[package]] name = "rustls" -version = "0.23.33" +version = "0.23.34" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "751e04a496ca00bb97a5e043158d23d66b5aabf2e1d5aa2a0aaebb1aafe6f82c" +checksum = "6a9586e9ee2b4f8fab52a0048ca7334d7024eef48e2cb9407e3497bb7cab7fa7" dependencies = [ "aws-lc-rs", "log", @@ -4075,9 +4075,9 @@ dependencies = [ [[package]] name = "serde_with" -version = "3.15.0" +version = "3.15.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6093cd8c01b25262b84927e0f7151692158fab02d961e04c979d3903eba7ecc5" +checksum = "aa66c845eee442168b2c8134fec70ac50dc20e760769c8ba0ad1319ca1959b04" dependencies = [ "base64 0.22.1", "chrono", @@ -4094,9 +4094,9 @@ dependencies = [ [[package]] name = "serde_with_macros" -version = "3.15.0" +version = "3.15.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a7e6c180db0816026a61afa1cff5344fb7ebded7e4d3062772179f2501481c27" +checksum = "b91a903660542fced4e99881aa481bdbaec1634568ee02e0b8bd57c64cb38955" dependencies = [ "darling 0.21.3", "proc-macro2", @@ -4772,9 +4772,9 @@ checksum = "70ba288e709927c043cbe476718d37be306be53fb1fafecd0dbe36d072be2580" [[package]] name = "unicode-ident" -version = "1.0.19" +version = "1.0.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f63a545481291138910575129486daeaf8ac54aee4387fe7906919f7830c7d9d" +checksum = "462eeb75aeb73aea900253ce739c8e18a67423fadf006037cd3ff27e82748a06" [[package]] name = "unicode-normalization" From faf19a66603feef2e7f3f07899fbacb7e2b3c672 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 22 Oct 2025 19:47:39 +0000 Subject: [PATCH 17/45] feat: Add Server-Timing header to track request performance Co-authored-by: contact --- src/render.rs | 21 +++--- src/webserver/database/execute_queries.rs | 8 ++- src/webserver/http.rs | 42 +++++------ src/webserver/http_request_info.rs | 4 ++ src/webserver/server_timing.rs | 88 ++++++++++++++++++++++- 5 files changed, 123 insertions(+), 40 deletions(-) diff --git a/src/render.rs b/src/render.rs index 52b635a2..520d5576 100644 --- a/src/render.rs +++ b/src/render.rs @@ -368,13 +368,15 @@ impl HeaderContext { Ok(PageContext::Header(self)) } - async fn start_body(mut self, data: JsonValue) -> anyhow::Result { - if let Some(ref timing) = self.request_context.server_timing { - let header_value = timing.as_header_value(); - if !header_value.is_empty() { - self.response.insert_header(("Server-Timing", header_value)); - } + fn add_server_timing_header(&mut self) { + let header_value = self.request_context.server_timing.as_header_value(); + if !header_value.is_empty() { + self.response.insert_header(("Server-Timing", header_value)); } + } + + async fn start_body(mut self, data: JsonValue) -> anyhow::Result { + self.add_server_timing_header(); let html_renderer = HtmlRenderContext::new(self.app_state, self.request_context, self.writer, data) .await @@ -388,12 +390,7 @@ impl HeaderContext { } pub fn close(mut self) -> HttpResponse { - if let Some(ref timing) = self.request_context.server_timing { - let header_value = timing.as_header_value(); - if !header_value.is_empty() { - self.response.insert_header(("Server-Timing", header_value)); - } - } + self.add_server_timing_header(); self.response.finish() } } diff --git a/src/webserver/database/execute_queries.rs b/src/webserver/database/execute_queries.rs index 80883e24..352cd7b3 100644 --- a/src/webserver/database/execute_queries.rs +++ b/src/webserver/database/execute_queries.rs @@ -52,13 +52,13 @@ pub fn stream_query_results_with_conn<'a>( for res in &sql_file.statements { match res { ParsedStatement::CsvImport(csv_import) => { - let connection = take_connection(&request.app_state.db, db_connection).await?; + let connection = take_connection(&request.app_state.db, db_connection, request).await?; log::debug!("Executing CSV import: {csv_import:?}"); run_csv_import(connection, csv_import, request).await.with_context(|| format!("Failed to import the CSV file {:?} into the table {:?}", csv_import.uploaded_file, csv_import.table_name))?; }, ParsedStatement::StmtWithParams(stmt) => { let query = bind_parameters(stmt, request, db_connection).await?; - let connection = take_connection(&request.app_state.db, db_connection).await?; + let connection = take_connection(&request.app_state.db, db_connection, request).await?; log::trace!("Executing query {:?}", query.sql); let mut stream = connection.fetch_many(query); let mut error = None; @@ -192,7 +192,7 @@ async fn execute_set_variable_query<'a>( source_file: &Path, ) -> anyhow::Result<()> { let query = bind_parameters(statement, request, db_connection).await?; - let connection = take_connection(&request.app_state.db, db_connection).await?; + let connection = take_connection(&request.app_state.db, db_connection, request).await?; log::debug!( "Executing query to set the {variable:?} variable: {:?}", query.sql @@ -276,6 +276,7 @@ fn vars_and_name<'a, 'b>( async fn take_connection<'a>( db: &'a Database, conn: &'a mut DbConn, + request: &RequestInfo, ) -> anyhow::Result<&'a mut PoolConnection> { if let Some(c) = conn { return Ok(c); @@ -283,6 +284,7 @@ async fn take_connection<'a>( match db.connection.acquire().await { Ok(c) => { log::debug!("Acquired a database connection"); + request.server_timing.borrow_mut().record("db_conn"); *conn = Some(c); Ok(conn.as_mut().unwrap()) } diff --git a/src/webserver/http.rs b/src/webserver/http.rs index d41b07b5..30e0eaa9 100644 --- a/src/webserver/http.rs +++ b/src/webserver/http.rs @@ -47,7 +47,7 @@ pub struct RequestContext { pub is_embedded: bool, pub source_path: PathBuf, pub content_security_policy: ContentSecurityPolicy, - pub server_timing: Option, + pub server_timing: ServerTiming, } async fn stream_response(stream: impl Stream, mut renderer: AnyRenderBodyContext) { @@ -106,16 +106,12 @@ async fn build_response_header_and_stream>( let writer = ResponseWriter::new(sender); let mut head_context = HeaderContext::new(app_state, request_context, writer); let mut stream = Box::pin(database_entries); - let mut first_row = true; while let Some(item) = stream.next().await { - if first_row { - if let Some(ref mut timing) = head_context.request_context.server_timing { - timing.record("query"); - } - first_row = false; - } let page_context = match item { - DbItem::Row(data) => head_context.handle_row(data).await?, + DbItem::Row(data) => { + head_context.request_context.server_timing.record("row"); + head_context.handle_row(data).await? + } DbItem::FinishedQuery => { log::debug!("finished query"); continue; @@ -172,6 +168,7 @@ enum ResponseWithWriter { async fn render_sql( srv_req: &mut ServiceRequest, sql_file: Arc, + server_timing: ServerTiming, ) -> actix_web::Result { let app_state = srv_req .app_data::>() @@ -179,29 +176,23 @@ async fn render_sql( .clone() .into_inner(); - let mut server_timing = if !app_state.config.environment.is_prod() { - Some(ServerTiming::new()) - } else { - None - }; - - let mut req_param = extract_request_info(srv_req, Arc::clone(&app_state)) - .await - .map_err(|e| anyhow_err_to_actix(e, &app_state))?; + let mut req_param = + extract_request_info(srv_req, Arc::clone(&app_state), server_timing.clone()) + .await + .map_err(|e| anyhow_err_to_actix(e, &app_state))?; log::debug!("Received a request with the following parameters: {req_param:?}"); - if let Some(ref mut timing) = server_timing { - timing.record("parse"); - } + req_param.server_timing.borrow_mut().record("parse"); let (resp_send, resp_recv) = tokio::sync::oneshot::channel::(); let source_path: PathBuf = sql_file.source_path.clone(); actix_web::rt::spawn(async move { + let server_timing_for_context = req_param.server_timing.borrow().clone(); let request_context = RequestContext { is_embedded: req_param.get_variables.contains_key("_sqlpage_embed"), source_path, content_security_policy: ContentSecurityPolicy::with_random_nonce(), - server_timing, + server_timing: server_timing_for_context, }; let mut conn = None; let database_entries_stream = @@ -295,13 +286,18 @@ async fn process_sql_request( sql_path: PathBuf, ) -> actix_web::Result { let app_state: &web::Data = req.app_data().expect("app_state"); + let mut server_timing = ServerTiming::new(!app_state.config.environment.is_prod()); + server_timing.record("request"); + let sql_file = app_state .sql_file_cache .get_with_privilege(app_state, &sql_path, false) .await .with_context(|| format!("Unable to read SQL file \"{}\"", sql_path.display())) .map_err(|e| anyhow_err_to_actix(e, app_state))?; - render_sql(req, sql_file).await + server_timing.record("sql_file"); + + render_sql(req, sql_file, server_timing).await } async fn serve_file( diff --git a/src/webserver/http_request_info.rs b/src/webserver/http_request_info.rs index 23675a51..7797af21 100644 --- a/src/webserver/http_request_info.rs +++ b/src/webserver/http_request_info.rs @@ -42,6 +42,7 @@ pub struct RequestInfo { pub clone_depth: u8, pub raw_body: Option>, pub oidc_claims: Option, + pub server_timing: std::cell::RefCell, } impl RequestInfo { @@ -62,6 +63,7 @@ impl RequestInfo { clone_depth: self.clone_depth + 1, raw_body: self.raw_body.clone(), oidc_claims: self.oidc_claims.clone(), + server_timing: std::cell::RefCell::new(self.server_timing.borrow().clone()), } } } @@ -78,6 +80,7 @@ impl Clone for RequestInfo { pub(crate) async fn extract_request_info( req: &mut ServiceRequest, app_state: Arc, + server_timing: super::server_timing::ServerTiming, ) -> anyhow::Result { let (http_req, payload) = req.parts_mut(); let method = http_req.method().clone(); @@ -123,6 +126,7 @@ pub(crate) async fn extract_request_info( clone_depth: 0, raw_body, oidc_claims, + server_timing: std::cell::RefCell::new(server_timing), }) } diff --git a/src/webserver/server_timing.rs b/src/webserver/server_timing.rs index 47a71dae..ee89fb55 100644 --- a/src/webserver/server_timing.rs +++ b/src/webserver/server_timing.rs @@ -2,6 +2,7 @@ use std::time::Instant; #[derive(Debug, Clone)] pub struct ServerTiming { + enabled: bool, start: Instant, events: Vec, } @@ -14,20 +15,32 @@ struct TimingEvent { impl ServerTiming { #[must_use] - pub fn new() -> Self { + pub fn new(enabled: bool) -> Self { Self { + enabled, start: Instant::now(), events: Vec::new(), } } pub fn record(&mut self, name: &'static str) { + if !self.enabled { + return; + } let duration_ms = self.start.elapsed().as_secs_f64() * 1000.0; self.events.push(TimingEvent { name, duration_ms }); } + #[must_use] + pub fn is_enabled(&self) -> bool { + self.enabled + } + #[must_use] pub fn as_header_value(&self) -> String { + if !self.enabled { + return String::new(); + } self.events .iter() .map(|event| format!("{};dur={:.2}", event.name, event.duration_ms)) @@ -38,6 +51,77 @@ impl ServerTiming { impl Default for ServerTiming { fn default() -> Self { - Self::new() + Self::new(false) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::thread; + use std::time::Duration; + + #[test] + fn test_disabled_timing() { + let mut timing = ServerTiming::new(false); + assert!(!timing.is_enabled()); + timing.record("event1"); + timing.record("event2"); + assert_eq!(timing.as_header_value(), ""); + } + + #[test] + fn test_enabled_timing() { + let mut timing = ServerTiming::new(true); + assert!(timing.is_enabled()); + timing.record("event1"); + thread::sleep(Duration::from_millis(10)); + timing.record("event2"); + let header = timing.as_header_value(); + assert!(header.contains("event1;dur=")); + assert!(header.contains("event2;dur=")); + assert!(header.contains(", ")); + } + + #[test] + fn test_timing_values_increase() { + let mut timing = ServerTiming::new(true); + timing.record("first"); + thread::sleep(Duration::from_millis(5)); + timing.record("second"); + assert_eq!(timing.events.len(), 2); + assert!(timing.events[1].duration_ms > timing.events[0].duration_ms); + } + + #[test] + fn test_default_is_disabled() { + let timing = ServerTiming::default(); + assert!(!timing.is_enabled()); + } + + #[test] + fn test_header_format() { + let mut timing = ServerTiming::new(true); + timing.events.push(TimingEvent { + name: "test", + duration_ms: 123.456, + }); + let header = timing.as_header_value(); + assert_eq!(header, "test;dur=123.46"); + } + + #[test] + fn test_multiple_events_format() { + let mut timing = ServerTiming::new(true); + timing.events.push(TimingEvent { + name: "first", + duration_ms: 10.5, + }); + timing.events.push(TimingEvent { + name: "second", + duration_ms: 25.75, + }); + let header = timing.as_header_value(); + assert_eq!(header, "first;dur=10.50, second;dur=25.75"); } } From 5c415984bf6eb1630f9cc6aa5e0627bd3ed98d81 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 22 Oct 2025 20:03:09 +0000 Subject: [PATCH 18/45] Refactor Server-Timing header generation and add tests This commit refactors the Server-Timing header generation to be more efficient and adds comprehensive tests for its behavior in development and production environments. It also includes a new test SQL file for server timing verification. Co-authored-by: contact --- src/render.rs | 3 +- src/webserver/http.rs | 2 +- src/webserver/server_timing.rs | 109 +++++---------------------- tests/mod.rs | 1 + tests/server_timing/mod.rs | 100 ++++++++++++++++++++++++ tests/server_timing/simple_query.sql | 2 + 6 files changed, 124 insertions(+), 93 deletions(-) create mode 100644 tests/server_timing/mod.rs create mode 100644 tests/server_timing/simple_query.sql diff --git a/src/render.rs b/src/render.rs index 520d5576..476e3638 100644 --- a/src/render.rs +++ b/src/render.rs @@ -371,7 +371,8 @@ impl HeaderContext { fn add_server_timing_header(&mut self) { let header_value = self.request_context.server_timing.as_header_value(); if !header_value.is_empty() { - self.response.insert_header(("Server-Timing", header_value)); + self.response + .insert_header(("Server-Timing", header_value.to_string())); } } diff --git a/src/webserver/http.rs b/src/webserver/http.rs index 30e0eaa9..7ce3e022 100644 --- a/src/webserver/http.rs +++ b/src/webserver/http.rs @@ -182,7 +182,7 @@ async fn render_sql( .map_err(|e| anyhow_err_to_actix(e, &app_state))?; log::debug!("Received a request with the following parameters: {req_param:?}"); - req_param.server_timing.borrow_mut().record("parse"); + req_param.server_timing.borrow_mut().record("parse_req"); let (resp_send, resp_recv) = tokio::sync::oneshot::channel::(); let source_path: PathBuf = sql_file.source_path.clone(); diff --git a/src/webserver/server_timing.rs b/src/webserver/server_timing.rs index ee89fb55..11a524db 100644 --- a/src/webserver/server_timing.rs +++ b/src/webserver/server_timing.rs @@ -3,14 +3,8 @@ use std::time::Instant; #[derive(Debug, Clone)] pub struct ServerTiming { enabled: bool, - start: Instant, - events: Vec, -} - -#[derive(Debug, Clone)] -struct TimingEvent { - name: &'static str, - duration_ms: f64, + previous_event: Instant, + header: String, } impl ServerTiming { @@ -18,8 +12,8 @@ impl ServerTiming { pub fn new(enabled: bool) -> Self { Self { enabled, - start: Instant::now(), - events: Vec::new(), + previous_event: Instant::now(), + header: String::new(), } } @@ -27,8 +21,15 @@ impl ServerTiming { if !self.enabled { return; } - let duration_ms = self.start.elapsed().as_secs_f64() * 1000.0; - self.events.push(TimingEvent { name, duration_ms }); + let now = Instant::now(); + let duration_ms = (now - self.previous_event).as_secs_f64() * 1000.0; + self.previous_event = now; + + if !self.header.is_empty() { + self.header.push_str(", "); + } + use std::fmt::Write; + write!(&mut self.header, "{};dur={:.2}", name, duration_ms).unwrap(); } #[must_use] @@ -37,15 +38,12 @@ impl ServerTiming { } #[must_use] - pub fn as_header_value(&self) -> String { - if !self.enabled { - return String::new(); + pub fn as_header_value(&self) -> &str { + if self.enabled { + &self.header + } else { + "" } - self.events - .iter() - .map(|event| format!("{};dur={:.2}", event.name, event.duration_ms)) - .collect::>() - .join(", ") } } @@ -54,74 +52,3 @@ impl Default for ServerTiming { Self::new(false) } } - -#[cfg(test)] -mod tests { - use super::*; - use std::thread; - use std::time::Duration; - - #[test] - fn test_disabled_timing() { - let mut timing = ServerTiming::new(false); - assert!(!timing.is_enabled()); - timing.record("event1"); - timing.record("event2"); - assert_eq!(timing.as_header_value(), ""); - } - - #[test] - fn test_enabled_timing() { - let mut timing = ServerTiming::new(true); - assert!(timing.is_enabled()); - timing.record("event1"); - thread::sleep(Duration::from_millis(10)); - timing.record("event2"); - let header = timing.as_header_value(); - assert!(header.contains("event1;dur=")); - assert!(header.contains("event2;dur=")); - assert!(header.contains(", ")); - } - - #[test] - fn test_timing_values_increase() { - let mut timing = ServerTiming::new(true); - timing.record("first"); - thread::sleep(Duration::from_millis(5)); - timing.record("second"); - assert_eq!(timing.events.len(), 2); - assert!(timing.events[1].duration_ms > timing.events[0].duration_ms); - } - - #[test] - fn test_default_is_disabled() { - let timing = ServerTiming::default(); - assert!(!timing.is_enabled()); - } - - #[test] - fn test_header_format() { - let mut timing = ServerTiming::new(true); - timing.events.push(TimingEvent { - name: "test", - duration_ms: 123.456, - }); - let header = timing.as_header_value(); - assert_eq!(header, "test;dur=123.46"); - } - - #[test] - fn test_multiple_events_format() { - let mut timing = ServerTiming::new(true); - timing.events.push(TimingEvent { - name: "first", - duration_ms: 10.5, - }); - timing.events.push(TimingEvent { - name: "second", - duration_ms: 25.75, - }); - let header = timing.as_header_value(); - assert_eq!(header, "first;dur=10.50, second;dur=25.75"); - } -} diff --git a/tests/mod.rs b/tests/mod.rs index 9eab13f2..aeaf5dc9 100644 --- a/tests/mod.rs +++ b/tests/mod.rs @@ -5,6 +5,7 @@ mod core; mod data_formats; mod errors; mod requests; +mod server_timing; pub mod sql_test_files; mod transactions; mod uploads; diff --git a/tests/server_timing/mod.rs b/tests/server_timing/mod.rs new file mode 100644 index 00000000..3a4fd815 --- /dev/null +++ b/tests/server_timing/mod.rs @@ -0,0 +1,100 @@ +use actix_web::{http::StatusCode, test}; +use sqlpage::webserver::http::main_handler; + +use crate::common::{get_request_to, make_app_data_from_config, test_config}; + +#[actix_web::test] +async fn test_server_timing_disabled_in_production() -> actix_web::Result<()> { + let mut config = test_config(); + config.environment = sqlpage::app_config::DevOrProd::Production; + let app_data = make_app_data_from_config(config).await; + + let req = + crate::common::get_request_to_with_data("/tests/server_timing/simple_query.sql", app_data) + .await? + .to_srv_request(); + let resp = main_handler(req).await?; + + assert_eq!(resp.status(), StatusCode::OK); + assert!( + resp.headers().get("Server-Timing").is_none(), + "Server-Timing header should not be present in production mode" + ); + Ok(()) +} + +#[actix_web::test] +async fn test_server_timing_enabled_in_development() -> actix_web::Result<()> { + let mut config = test_config(); + config.environment = sqlpage::app_config::DevOrProd::Development; + let app_data = make_app_data_from_config(config).await; + + let req = + crate::common::get_request_to_with_data("/tests/server_timing/simple_query.sql", app_data) + .await? + .to_srv_request(); + let resp = main_handler(req).await?; + + assert_eq!(resp.status(), StatusCode::OK); + let server_timing_header = resp + .headers() + .get("Server-Timing") + .expect("Server-Timing header should be present in development mode"); + let header_value = server_timing_header.to_str().unwrap(); + + assert!( + header_value.contains("request;dur="), + "Should contain request timing: {header_value}" + ); + assert!( + header_value.contains("sql_file;dur="), + "Should contain sql_file timing: {header_value}" + ); + assert!( + header_value.contains("parse_req;dur="), + "Should contain parse_req timing: {header_value}" + ); + assert!( + header_value.contains("db_conn;dur="), + "Should contain db_conn timing: {header_value}" + ); + assert!( + header_value.contains("row;dur="), + "Should contain row timing: {header_value}" + ); + + Ok(()) +} + +#[actix_web::test] +async fn test_server_timing_format() -> actix_web::Result<()> { + let req = get_request_to("/tests/server_timing/simple_query.sql") + .await? + .to_srv_request(); + let resp = main_handler(req).await?; + + assert_eq!(resp.status(), StatusCode::OK); + let server_timing_header = resp.headers().get("Server-Timing").unwrap(); + let header_value = server_timing_header.to_str().unwrap(); + + let parts: Vec<&str> = header_value.split(", ").collect(); + assert!(parts.len() >= 4, "Should have at least 4 timing events"); + + for part in parts { + assert!( + part.contains(";dur="), + "Each part should have name;dur= format: {part}" + ); + let dur_parts: Vec<&str> = part.split(";dur=").collect(); + assert_eq!(dur_parts.len(), 2, "Should have name and duration: {part}"); + let duration: f64 = dur_parts[1] + .parse() + .expect("Duration should be a valid number"); + assert!( + duration >= 0.0, + "Duration should be non-negative: {duration}" + ); + } + + Ok(()) +} diff --git a/tests/server_timing/simple_query.sql b/tests/server_timing/simple_query.sql new file mode 100644 index 00000000..738ec0d0 --- /dev/null +++ b/tests/server_timing/simple_query.sql @@ -0,0 +1,2 @@ +SELECT 'text' AS component, 'Server timing test' AS contents; +SELECT 'Hello' AS value FROM (SELECT 1 UNION ALL SELECT 2 UNION ALL SELECT 3); From 38e08d78d1bce3574762008da9a90c312e84af4d Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 22 Oct 2025 22:08:10 +0000 Subject: [PATCH 19/45] Refactor: Pass ServerTiming to extract_request_info Co-authored-by: contact --- src/webserver/http_request_info.rs | 9 ++++++--- src/webserver/server_timing.rs | 4 ++-- tests/server_timing/mod.rs | 22 +++++++++++++--------- tests/server_timing/simple_query.sql | 2 -- 4 files changed, 21 insertions(+), 16 deletions(-) delete mode 100644 tests/server_timing/simple_query.sql diff --git a/src/webserver/http_request_info.rs b/src/webserver/http_request_info.rs index 7797af21..a6e459f2 100644 --- a/src/webserver/http_request_info.rs +++ b/src/webserver/http_request_info.rs @@ -288,7 +288,8 @@ mod test { serde_json::from_str::(r#"{"listen_on": "localhost:1234"}"#).unwrap(); let mut service_request = TestRequest::default().to_srv_request(); let app_data = Arc::new(AppState::init(&config).await.unwrap()); - let request_info = extract_request_info(&mut service_request, app_data) + let server_timing = super::server_timing::ServerTiming::new(false); + let request_info = extract_request_info(&mut service_request, app_data, server_timing) .await .unwrap(); assert_eq!(request_info.post_variables.len(), 0); @@ -306,7 +307,8 @@ mod test { .set_payload("my_array[]=3&my_array[]=Hello%20World&repeated=1&repeated=2") .to_srv_request(); let app_data = Arc::new(AppState::init(&config).await.unwrap()); - let request_info = extract_request_info(&mut service_request, app_data) + let server_timing = super::server_timing::ServerTiming::new(false); + let request_info = extract_request_info(&mut service_request, app_data, server_timing) .await .unwrap(); assert_eq!( @@ -355,7 +357,8 @@ mod test { ) .to_srv_request(); let app_data = Arc::new(AppState::init(&config).await.unwrap()); - let request_info = extract_request_info(&mut service_request, app_data) + let server_timing = super::server_timing::ServerTiming::new(false); + let request_info = extract_request_info(&mut service_request, app_data, server_timing) .await .unwrap(); assert_eq!( diff --git a/src/webserver/server_timing.rs b/src/webserver/server_timing.rs index 11a524db..08ed5b5a 100644 --- a/src/webserver/server_timing.rs +++ b/src/webserver/server_timing.rs @@ -1,3 +1,4 @@ +use std::fmt::Write; use std::time::Instant; #[derive(Debug, Clone)] @@ -28,8 +29,7 @@ impl ServerTiming { if !self.header.is_empty() { self.header.push_str(", "); } - use std::fmt::Write; - write!(&mut self.header, "{};dur={:.2}", name, duration_ms).unwrap(); + write!(&mut self.header, "{name};dur={duration_ms:.2}").unwrap(); } #[must_use] diff --git a/tests/server_timing/mod.rs b/tests/server_timing/mod.rs index 3a4fd815..718eea5d 100644 --- a/tests/server_timing/mod.rs +++ b/tests/server_timing/mod.rs @@ -9,10 +9,12 @@ async fn test_server_timing_disabled_in_production() -> actix_web::Result<()> { config.environment = sqlpage::app_config::DevOrProd::Production; let app_data = make_app_data_from_config(config).await; - let req = - crate::common::get_request_to_with_data("/tests/server_timing/simple_query.sql", app_data) - .await? - .to_srv_request(); + let req = crate::common::get_request_to_with_data( + "/tests/sql_test_files/it_works_simple.sql", + app_data, + ) + .await? + .to_srv_request(); let resp = main_handler(req).await?; assert_eq!(resp.status(), StatusCode::OK); @@ -29,10 +31,12 @@ async fn test_server_timing_enabled_in_development() -> actix_web::Result<()> { config.environment = sqlpage::app_config::DevOrProd::Development; let app_data = make_app_data_from_config(config).await; - let req = - crate::common::get_request_to_with_data("/tests/server_timing/simple_query.sql", app_data) - .await? - .to_srv_request(); + let req = crate::common::get_request_to_with_data( + "/tests/sql_test_files/it_works_simple.sql", + app_data, + ) + .await? + .to_srv_request(); let resp = main_handler(req).await?; assert_eq!(resp.status(), StatusCode::OK); @@ -68,7 +72,7 @@ async fn test_server_timing_enabled_in_development() -> actix_web::Result<()> { #[actix_web::test] async fn test_server_timing_format() -> actix_web::Result<()> { - let req = get_request_to("/tests/server_timing/simple_query.sql") + let req = get_request_to("/tests/sql_test_files/it_works_simple.sql") .await? .to_srv_request(); let resp = main_handler(req).await?; diff --git a/tests/server_timing/simple_query.sql b/tests/server_timing/simple_query.sql deleted file mode 100644 index 738ec0d0..00000000 --- a/tests/server_timing/simple_query.sql +++ /dev/null @@ -1,2 +0,0 @@ -SELECT 'text' AS component, 'Server timing test' AS contents; -SELECT 'Hello' AS value FROM (SELECT 1 UNION ALL SELECT 2 UNION ALL SELECT 3); From 06df761eee152f42cdbf3275aa64f7b63cb047a9 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Thu, 23 Oct 2025 12:42:09 +0200 Subject: [PATCH 20/45] Refactor: Update ServerTiming to use Arc and simplify header generation This commit modifies the ServerTiming structure to utilize Arc for thread-safe reference counting, enhancing performance and memory management. The header generation logic is streamlined, and related code is updated to reflect these changes. Additionally, tests are adjusted to ensure proper functionality with the new implementation. Co-authored-by: contact --- src/render.rs | 6 +- src/webserver/database/execute_queries.rs | 2 +- src/webserver/http.rs | 17 ++--- src/webserver/http_request_info.rs | 17 ++--- src/webserver/server_timing.rs | 78 ++++++++++++++--------- tests/server_timing/mod.rs | 10 +-- 6 files changed, 69 insertions(+), 61 deletions(-) diff --git a/src/render.rs b/src/render.rs index 476e3638..c9229ce7 100644 --- a/src/render.rs +++ b/src/render.rs @@ -369,10 +369,8 @@ impl HeaderContext { } fn add_server_timing_header(&mut self) { - let header_value = self.request_context.server_timing.as_header_value(); - if !header_value.is_empty() { - self.response - .insert_header(("Server-Timing", header_value.to_string())); + if let Some(header_value) = self.request_context.server_timing.header_value() { + self.response.insert_header(("Server-Timing", header_value)); } } diff --git a/src/webserver/database/execute_queries.rs b/src/webserver/database/execute_queries.rs index 352cd7b3..9f780f72 100644 --- a/src/webserver/database/execute_queries.rs +++ b/src/webserver/database/execute_queries.rs @@ -284,7 +284,7 @@ async fn take_connection<'a>( match db.connection.acquire().await { Ok(c) => { log::debug!("Acquired a database connection"); - request.server_timing.borrow_mut().record("db_conn"); + request.server_timing.record("db_conn"); *conn = Some(c); Ok(conn.as_mut().unwrap()) } diff --git a/src/webserver/http.rs b/src/webserver/http.rs index 7ce3e022..dbf3e208 100644 --- a/src/webserver/http.rs +++ b/src/webserver/http.rs @@ -47,7 +47,7 @@ pub struct RequestContext { pub is_embedded: bool, pub source_path: PathBuf, pub content_security_policy: ContentSecurityPolicy, - pub server_timing: ServerTiming, + pub server_timing: Arc, } async fn stream_response(stream: impl Stream, mut renderer: AnyRenderBodyContext) { @@ -176,23 +176,21 @@ async fn render_sql( .clone() .into_inner(); - let mut req_param = - extract_request_info(srv_req, Arc::clone(&app_state), server_timing.clone()) - .await - .map_err(|e| anyhow_err_to_actix(e, &app_state))?; + let mut req_param = extract_request_info(srv_req, Arc::clone(&app_state), server_timing) + .await + .map_err(|e| anyhow_err_to_actix(e, &app_state))?; log::debug!("Received a request with the following parameters: {req_param:?}"); - req_param.server_timing.borrow_mut().record("parse_req"); + req_param.server_timing.record("parse_req"); let (resp_send, resp_recv) = tokio::sync::oneshot::channel::(); let source_path: PathBuf = sql_file.source_path.clone(); actix_web::rt::spawn(async move { - let server_timing_for_context = req_param.server_timing.borrow().clone(); let request_context = RequestContext { is_embedded: req_param.get_variables.contains_key("_sqlpage_embed"), source_path, content_security_policy: ContentSecurityPolicy::with_random_nonce(), - server_timing: server_timing_for_context, + server_timing: Arc::clone(&req_param.server_timing), }; let mut conn = None; let database_entries_stream = @@ -286,8 +284,7 @@ async fn process_sql_request( sql_path: PathBuf, ) -> actix_web::Result { let app_state: &web::Data = req.app_data().expect("app_state"); - let mut server_timing = ServerTiming::new(!app_state.config.environment.is_prod()); - server_timing.record("request"); + let server_timing = ServerTiming::for_env(app_state.config.environment); let sql_file = app_state .sql_file_cache diff --git a/src/webserver/http_request_info.rs b/src/webserver/http_request_info.rs index a6e459f2..ff0f3114 100644 --- a/src/webserver/http_request_info.rs +++ b/src/webserver/http_request_info.rs @@ -1,3 +1,4 @@ +use crate::webserver::server_timing::ServerTiming; use crate::AppState; use actix_multipart::form::bytes::Bytes; use actix_multipart::form::tempfile::TempFile; @@ -42,7 +43,7 @@ pub struct RequestInfo { pub clone_depth: u8, pub raw_body: Option>, pub oidc_claims: Option, - pub server_timing: std::cell::RefCell, + pub server_timing: Arc, } impl RequestInfo { @@ -63,7 +64,7 @@ impl RequestInfo { clone_depth: self.clone_depth + 1, raw_body: self.raw_body.clone(), oidc_claims: self.oidc_claims.clone(), - server_timing: std::cell::RefCell::new(self.server_timing.borrow().clone()), + server_timing: Arc::clone(&self.server_timing), } } } @@ -80,7 +81,7 @@ impl Clone for RequestInfo { pub(crate) async fn extract_request_info( req: &mut ServiceRequest, app_state: Arc, - server_timing: super::server_timing::ServerTiming, + server_timing: ServerTiming, ) -> anyhow::Result { let (http_req, payload) = req.parts_mut(); let method = http_req.method().clone(); @@ -126,7 +127,7 @@ pub(crate) async fn extract_request_info( clone_depth: 0, raw_body, oidc_claims, - server_timing: std::cell::RefCell::new(server_timing), + server_timing: Arc::new(server_timing), }) } @@ -279,7 +280,7 @@ async fn is_file_field_empty( mod test { use super::super::http::SingleOrVec; use super::*; - use crate::app_config::AppConfig; + use crate::{app_config::AppConfig, webserver::server_timing::ServerTiming}; use actix_web::{http::header::ContentType, test::TestRequest}; #[actix_web::test] @@ -288,7 +289,7 @@ mod test { serde_json::from_str::(r#"{"listen_on": "localhost:1234"}"#).unwrap(); let mut service_request = TestRequest::default().to_srv_request(); let app_data = Arc::new(AppState::init(&config).await.unwrap()); - let server_timing = super::server_timing::ServerTiming::new(false); + let server_timing = ServerTiming::default(); let request_info = extract_request_info(&mut service_request, app_data, server_timing) .await .unwrap(); @@ -307,7 +308,7 @@ mod test { .set_payload("my_array[]=3&my_array[]=Hello%20World&repeated=1&repeated=2") .to_srv_request(); let app_data = Arc::new(AppState::init(&config).await.unwrap()); - let server_timing = super::server_timing::ServerTiming::new(false); + let server_timing = ServerTiming::default(); let request_info = extract_request_info(&mut service_request, app_data, server_timing) .await .unwrap(); @@ -357,7 +358,7 @@ mod test { ) .to_srv_request(); let app_data = Arc::new(AppState::init(&config).await.unwrap()); - let server_timing = super::server_timing::ServerTiming::new(false); + let server_timing = ServerTiming::enabled(false); let request_info = extract_request_info(&mut service_request, app_data, server_timing) .await .unwrap(); diff --git a/src/webserver/server_timing.rs b/src/webserver/server_timing.rs index 08ed5b5a..44ad4683 100644 --- a/src/webserver/server_timing.rs +++ b/src/webserver/server_timing.rs @@ -1,54 +1,70 @@ use std::fmt::Write; +use std::sync::Mutex; use std::time::Instant; -#[derive(Debug, Clone)] +use crate::app_config::DevOrProd; + +#[derive(Debug)] pub struct ServerTiming { enabled: bool, - previous_event: Instant, - header: String, + created_at: Instant, + events: Mutex>, } -impl ServerTiming { - #[must_use] - pub fn new(enabled: bool) -> Self { +#[derive(Debug)] +struct PerfEvent { + time: Instant, + name: &'static str, +} + +impl Default for ServerTiming { + fn default() -> Self { Self { - enabled, - previous_event: Instant::now(), - header: String::new(), + enabled: false, + created_at: Instant::now(), + events: Mutex::new(Vec::new()), } } +} - pub fn record(&mut self, name: &'static str) { - if !self.enabled { - return; - } - let now = Instant::now(); - let duration_ms = (now - self.previous_event).as_secs_f64() * 1000.0; - self.previous_event = now; - - if !self.header.is_empty() { - self.header.push_str(", "); +impl ServerTiming { + #[must_use] + pub fn enabled(enabled: bool) -> Self { + Self { + enabled, + ..Default::default() } - write!(&mut self.header, "{name};dur={duration_ms:.2}").unwrap(); } #[must_use] - pub fn is_enabled(&self) -> bool { - self.enabled + pub fn for_env(env: DevOrProd) -> Self { + Self::enabled(!env.is_prod()) } - #[must_use] - pub fn as_header_value(&self) -> &str { + pub fn record(&self, name: &'static str) { if self.enabled { - &self.header - } else { - "" + self.events.lock().unwrap().push(PerfEvent { + time: Instant::now(), + name, + }); } } -} -impl Default for ServerTiming { - fn default() -> Self { - Self::new(false) + pub fn header_value(&self) -> Option { + if !self.enabled { + return None; + } + let evts = self.events.lock().unwrap(); + let mut s = String::with_capacity(evts.len() * 16); + let mut last = self.created_at; + for (i, PerfEvent { name, time }) in evts.iter().enumerate() { + if i > 0 { + s.push_str(", "); + } + let millis = time.saturating_duration_since(last).as_millis(); + write!(&mut s, "{name};dur={millis}").ok()?; + last = *time; + } + Some(s) } } diff --git a/tests/server_timing/mod.rs b/tests/server_timing/mod.rs index 718eea5d..a64eef23 100644 --- a/tests/server_timing/mod.rs +++ b/tests/server_timing/mod.rs @@ -1,4 +1,4 @@ -use actix_web::{http::StatusCode, test}; +use actix_web::http::StatusCode; use sqlpage::webserver::http::main_handler; use crate::common::{get_request_to, make_app_data_from_config, test_config}; @@ -32,7 +32,7 @@ async fn test_server_timing_enabled_in_development() -> actix_web::Result<()> { let app_data = make_app_data_from_config(config).await; let req = crate::common::get_request_to_with_data( - "/tests/sql_test_files/it_works_simple.sql", + "/tests/sql_test_files/it_works_sqrt.sql", app_data, ) .await? @@ -46,10 +46,6 @@ async fn test_server_timing_enabled_in_development() -> actix_web::Result<()> { .expect("Server-Timing header should be present in development mode"); let header_value = server_timing_header.to_str().unwrap(); - assert!( - header_value.contains("request;dur="), - "Should contain request timing: {header_value}" - ); assert!( header_value.contains("sql_file;dur="), "Should contain sql_file timing: {header_value}" @@ -72,7 +68,7 @@ async fn test_server_timing_enabled_in_development() -> actix_web::Result<()> { #[actix_web::test] async fn test_server_timing_format() -> actix_web::Result<()> { - let req = get_request_to("/tests/sql_test_files/it_works_simple.sql") + let req = get_request_to("/tests/sql_test_files/it_works_sqrt.sql") .await? .to_srv_request(); let resp = main_handler(req).await?; From 3999bffc237cf27913210475fb7217d10a42a89f Mon Sep 17 00:00:00 2001 From: lovasoa Date: Thu, 23 Oct 2025 14:17:54 +0200 Subject: [PATCH 21/45] server timing header in changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8baa84bc..4f34e405 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - Display source line info in errors even when the database does not return a precise error position. In this case, the entire problematic SQL statement is referenced. - The shell with a vertical sidebar can now have "active" elements, just like the horizontal header bar. - New `edit_url`, `delete_url`, and `custom_actions` properties in the [table](https://sql-page.com/component.sql?component=table) component to easily add nice icon buttons to a table. + - SQLPage now sets the [`Server-Timing` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Server-Timing) in development. So when you have a page that loads slowly, you can open your browser's network inspector, click on the slow request, then open the timing tab to understand where it's spending its time. ## v0.38.0 - Added support for the Open Database Connectivity (ODBC) standard. From b356cc8904d94ea6f9c462a92f66646c8b480a82 Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Fri, 24 Oct 2025 08:04:39 +0200 Subject: [PATCH 22/45] username_icon and password_icon attributes --- .../sqlpage/migrations/68_login.sql | 6 ++-- sqlpage/templates/login.handlebars | 28 +++++-------------- 2 files changed, 11 insertions(+), 23 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index 7230f759..dad03a8e 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -12,6 +12,8 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('action','An optional link to a target page that will handle the results of the form. ','TEXT',TRUE,TRUE), ('username','User account identifier.','TEXT',TRUE,FALSE), ('password','User password.','TEXT',TRUE,FALSE), + ('username_icon','Icon to display on the left side of the input field, on the same line.','ICON',TRUE,TRUE), + ('password_icon','Icon to display on the left side of the input field, on the same line.','ICON',TRUE,TRUE), ('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE), ('forgot_password_text','A text for the link allowing the user to reset their password. If the text is empty, the link is not displayed.','TEXT',TRUE,TRUE), ('forgot_password_link','The link to the page allowing the user to reset their password.','TEXT',TRUE,TRUE), @@ -39,6 +41,8 @@ VALUES ( "title": "Please login to your account", "username": "Username", "password": "Password", + "username_icon": "user", + "password_icon": "lock", "forgot_password_text": "Forgot your password?", "forgot_password_link": "reset_password.sql", "remember_me_text": "Remember me", @@ -48,5 +52,3 @@ VALUES ( ]' ) ); - --- 265707.png \ No newline at end of file diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars index f292a18d..258622a8 100644 --- a/sqlpage/templates/login.handlebars +++ b/sqlpage/templates/login.handlebars @@ -1,4 +1,4 @@ -
    +
    {{username}}
    - - - - - - - + {{#if username_icon}} + {{icon_img username_icon}} + {{/if}}
    - - - - - - - - + {{#if password_icon}} + {{~icon_img password_icon~}} + {{/if}}
    {{#if remember_me_text}} From cb8fa2dc16e454e7068e6723912ed3c34267a3bc Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Fri, 24 Oct 2025 08:09:32 +0200 Subject: [PATCH 23/45] Fixing a regression with the class attribute. --- sqlpage/templates/login.handlebars | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars index 258622a8..a664e0cc 100644 --- a/sqlpage/templates/login.handlebars +++ b/sqlpage/templates/login.handlebars @@ -1,4 +1,4 @@ -
    +
    Date: Fri, 24 Oct 2025 08:29:35 +0200 Subject: [PATCH 24/45] Documentation improved --- .../official-site/sqlpage/migrations/68_login.sql | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index dad03a8e..1cbed299 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -1,10 +1,15 @@ INSERT INTO component(name, icon, description, introduced_in_version) VALUES ('login', 'password-user', ' -The login component is an authentication form for users of an application. +The login component is an authentication form with numerous customization options. +It offers the main functionalities for this type of form. +The user can enter their username and password. +There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s session via a cookie. +It is also possible to set the title of the form, display the company logo, or customize the appearance of the form submission button. -It allows the entry of a user account consisting of a username and a password. +This component should be used in conjunction with other components such as [authentication](component.sql?component=authentication) and [cookie](component.sql?component=cookie). +It does not implement any logic and simply collects the username and password to pass them to the code responsible for authentication. -It offers additional features such as the ability to request session persistence or to reset the password.', '0.39.0'); +', '0.39.0'); INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'login', * FROM (VALUES ('title','Title of the authentication form.','TEXT',TRUE,TRUE), From ce4ffd33940362efa2da07d6e87282adff149827 Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Fri, 24 Oct 2025 08:45:57 +0200 Subject: [PATCH 25/45] Documentation improved --- examples/official-site/sqlpage/migrations/68_login.sql | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index 1cbed299..6d906ae5 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -3,12 +3,17 @@ INSERT INTO component(name, icon, description, introduced_in_version) VALUES The login component is an authentication form with numerous customization options. It offers the main functionalities for this type of form. The user can enter their username and password. -There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s session via a cookie. +There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s identity via a cookie. It is also possible to set the title of the form, display the company logo, or customize the appearance of the form submission button. This component should be used in conjunction with other components such as [authentication](component.sql?component=authentication) and [cookie](component.sql?component=cookie). It does not implement any logic and simply collects the username and password to pass them to the code responsible for authentication. +A few things to know : +- The form uses the POST method to transmit information to the destination page, +- The user''s username and password are entered into fields with the names `username` and `password`, +- To obtain the values of username and password, you must use the variables `:username` and `:password`, +- To know if the user wants their identity to be remembered, you must read the value of the variable `:remember`. ', '0.39.0'); INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'login', * FROM (VALUES @@ -22,7 +27,7 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE), ('forgot_password_text','A text for the link allowing the user to reset their password. If the text is empty, the link is not displayed.','TEXT',TRUE,TRUE), ('forgot_password_link','The link to the page allowing the user to reset their password.','TEXT',TRUE,TRUE), - ('remember_me_text','A text for the option allowing the user to request the preservation of their work session. The name of the field is remember. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE), + ('remember_me_text','A text for the option allowing the user to request the preservation of their identity. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE), ('footer','A text placed at the bottom of the authentication form.','TEXT',TRUE,TRUE), ('footer_md','A markdown text placed at the bottom of the authentication form. Useful for creating links to other pages (creating a new account, contacting technical support, etc.).','TEXT',TRUE,TRUE), ('validate','The text to display in the button at the bottom of the form that submits the values.','TEXT',TRUE,FALSE), From 8ff9f7ef9988c1f5154e0fb4543f86f7c8f05370 Mon Sep 17 00:00:00 2001 From: Ophir LOJKINE Date: Fri, 24 Oct 2025 14:50:20 +0200 Subject: [PATCH 26/45] Add image reference to CHANGELOG.md Added an image to the changelog for visual reference. --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f34e405..5e73147c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ - The shell with a vertical sidebar can now have "active" elements, just like the horizontal header bar. - New `edit_url`, `delete_url`, and `custom_actions` properties in the [table](https://sql-page.com/component.sql?component=table) component to easily add nice icon buttons to a table. - SQLPage now sets the [`Server-Timing` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Server-Timing) in development. So when you have a page that loads slowly, you can open your browser's network inspector, click on the slow request, then open the timing tab to understand where it's spending its time. + - image + ## v0.38.0 - Added support for the Open Database Connectivity (ODBC) standard. From be5eb4cd0656eb1378f12eabf3c6c0529f17bffa Mon Sep 17 00:00:00 2001 From: lovasoa Date: Sat, 25 Oct 2025 01:21:13 +0200 Subject: [PATCH 27/45] fix odbc memory corruption make it harder to miss such issues in the future thanks to malloc instrumentation on ci fixes https://github.com/pacman82/odbc-api/issues/793 --- .github/workflows/ci.yml | 2 ++ CHANGELOG.md | 1 + Cargo.lock | 51 +++++++++++++++++++++++----------------- 3 files changed, 32 insertions(+), 22 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7eb315db..20485478 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -74,6 +74,8 @@ jobs: env: DATABASE_URL: ${{ matrix.db_url }} RUST_BACKTRACE: 1 + MALLOC_CHECK_: 3 + MALLOC_PERTURB_: 10 windows_test: runs-on: windows-latest diff --git a/CHANGELOG.md b/CHANGELOG.md index 5e73147c..ccf8bc1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ - New `edit_url`, `delete_url`, and `custom_actions` properties in the [table](https://sql-page.com/component.sql?component=table) component to easily add nice icon buttons to a table. - SQLPage now sets the [`Server-Timing` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Server-Timing) in development. So when you have a page that loads slowly, you can open your browser's network inspector, click on the slow request, then open the timing tab to understand where it's spending its time. - image + - Fixed a memory corruption issue in the builtin odbc driver manager ## v0.38.0 diff --git a/Cargo.lock b/Cargo.lock index bdd53446..654b0598 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -38,7 +38,7 @@ dependencies = [ "derive_more 2.0.1", "encoding_rs", "flate2", - "foldhash", + "foldhash 0.1.5", "futures-core", "h2", "http 0.2.12", @@ -214,7 +214,7 @@ dependencies = [ "cookie", "derive_more 2.0.1", "encoding_rs", - "foldhash", + "foldhash 0.1.5", "futures-core", "futures-util", "impl-more", @@ -872,9 +872,9 @@ dependencies = [ [[package]] name = "cc" -version = "1.2.41" +version = "1.2.43" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ac9fe6cdbb24b6ade63616c0a0688e45bb56732262c158df3c0c4bea4ca47cb7" +checksum = "739eb0f94557554b3ca9a86d2d37bebd49c5e6d0c1d2bda35ba5bdac830befc2" dependencies = [ "find-msvc-tools", "jobserver", @@ -1722,9 +1722,9 @@ checksum = "52051878f80a721bb68ebfbc930e07b65ba72f2da88968ea5c06fd6ca3d3a127" [[package]] name = "flate2" -version = "1.1.4" +version = "1.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dc5a4e564e38c699f2880d3fda590bedc2e69f3f84cd48b457bd892ce61d0aa9" +checksum = "bfe33edd8e85a12a67454e37f8c75e730830d83e313556ab9ebf9ee7fbeb3bfb" dependencies = [ "crc32fast", "miniz_oxide", @@ -1753,6 +1753,12 @@ version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" +[[package]] +name = "foldhash" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" + [[package]] name = "foreign-types" version = "0.5.0" @@ -2018,10 +2024,6 @@ name = "hashbrown" version = "0.14.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" -dependencies = [ - "ahash", - "allocator-api2", -] [[package]] name = "hashbrown" @@ -2029,7 +2031,7 @@ version = "0.15.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1" dependencies = [ - "foldhash", + "foldhash 0.1.5", ] [[package]] @@ -2037,6 +2039,11 @@ name = "hashbrown" version = "0.16.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5419bdc4f6a9207fbeba6d11b604d481addf78ecd10c11ad51e76c2f6482748d" +dependencies = [ + "allocator-api2", + "equivalent", + "foldhash 0.2.0", +] [[package]] name = "hashlink" @@ -2515,9 +2522,9 @@ checksum = "2874a2af47a2325c2001a6e6fad9b16a53b802102b528163885171cf92b15976" [[package]] name = "libflate" -version = "2.1.0" +version = "2.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "45d9dfdc14ea4ef0900c1cddbc8dcd553fbaacd8a4a282cf4018ae9dd04fb21e" +checksum = "249fa21ba2b59e8cbd69e722f5b31e1b466db96c937ae3de23e8b99ead0d1383" dependencies = [ "adler32", "core2", @@ -2528,12 +2535,12 @@ dependencies = [ [[package]] name = "libflate_lz77" -version = "2.1.0" +version = "2.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e6e0d73b369f386f1c44abd9c570d5318f55ccde816ff4b562fa452e5182863d" +checksum = "a599cb10a9cd92b1300debcef28da8f70b935ec937f44fcd1b70a7c986a11c5c" dependencies = [ "core2", - "hashbrown 0.14.5", + "hashbrown 0.16.0", "rle-decode-fast", ] @@ -3074,7 +3081,7 @@ dependencies = [ [[package]] name = "odbc-sys" version = "0.27.3" -source = "git+https://github.com/sqlpage/odbc-sys?branch=no-autotools#ae3e15446bb2c5c191f05e7c6affc37dfd6fcabe" +source = "git+https://github.com/sqlpage/odbc-sys?branch=no-autotools#b9617a5164eeda7b1ffaecc9afadbc0d3134633e" dependencies = [ "unix-odbc", ] @@ -3474,9 +3481,9 @@ dependencies = [ [[package]] name = "proc-macro2" -version = "1.0.101" +version = "1.0.103" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "89ae43fd86e4158d6db51ad8e2b80f313af9cc74f5c0e03ccb87de09998732de" +checksum = "5ee95bc4ef87b8d5ba32e8b7714ccc834865276eab0aed5c9958d00ec45f49e8" dependencies = [ "unicode-ident", ] @@ -4425,9 +4432,9 @@ checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" [[package]] name = "syn" -version = "2.0.107" +version = "2.0.108" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2a26dbd934e5451d21ef060c018dae56fc073894c5a7896f882928a76e6d081b" +checksum = "da58917d35242480a05c2897064da0a80589a2a0476c9a3f2fdc83b53502e917" dependencies = [ "proc-macro2", "quote", @@ -4806,7 +4813,7 @@ checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" [[package]] name = "unix-odbc" version = "0.1.2" -source = "git+https://github.com/sqlpage/odbc-sys?branch=no-autotools#ae3e15446bb2c5c191f05e7c6affc37dfd6fcabe" +source = "git+https://github.com/sqlpage/odbc-sys?branch=no-autotools#b9617a5164eeda7b1ffaecc9afadbc0d3134633e" dependencies = [ "cc", ] From 6f96213269578e310437865aa5ef28eb5cfde834 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Sat, 25 Oct 2025 23:53:43 +0200 Subject: [PATCH 28/45] my odbc-sys patch was merged upstream --- Cargo.lock | 14 ++++++++------ Cargo.toml | 6 +----- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 654b0598..b4b1df95 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1382,9 +1382,9 @@ dependencies = [ [[package]] name = "deranged" -version = "0.5.4" +version = "0.5.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a41953f86f8a05768a6cda24def994fd2f424b04ec5c719cf89989779f199071" +checksum = "ececcb659e7ba858fb4f10388c250a7252eb0a27373f1a72b8748afdd248e587" dependencies = [ "powerfmt", "serde_core", @@ -3080,8 +3080,9 @@ dependencies = [ [[package]] name = "odbc-sys" -version = "0.27.3" -source = "git+https://github.com/sqlpage/odbc-sys?branch=no-autotools#b9617a5164eeda7b1ffaecc9afadbc0d3134633e" +version = "0.27.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1896e52e97c2f0cf997cc627380f1af1ecb3f6c29ce6175047cd38adaadb46f5" dependencies = [ "unix-odbc", ] @@ -4812,8 +4813,9 @@ checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" [[package]] name = "unix-odbc" -version = "0.1.2" -source = "git+https://github.com/sqlpage/odbc-sys?branch=no-autotools#b9617a5164eeda7b1ffaecc9afadbc0d3134633e" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8579f2e2aaba57c09f10990cf9ab50eef8c0155820ed8a72d962c1c05af4a8a" dependencies = [ "cc", ] diff --git a/Cargo.toml b/Cargo.toml index f4a84374..465464e9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -79,7 +79,7 @@ clap = { version = "4.5.17", features = ["derive"] } tokio-util = "0.7.12" openidconnect = { version = "4.0.0", default-features = false } encoding_rs = "0.8.35" -odbc-sys = { version = "0.27.1", optional = true } +odbc-sys = { version = "0.27.4", optional = true } [features] @@ -87,10 +87,6 @@ default = [] odbc-static = ["odbc-sys", "odbc-sys/vendored-unix-odbc"] lambda-web = ["dep:lambda-web", "odbc-static"] - -[patch.crates-io] -odbc-sys = { git = "https://github.com/sqlpage/odbc-sys", branch = "no-autotools" } - [build-dependencies] awc = { version = "3", features = ["rustls-0_23-webpki-roots"] } rustls = "0.23" From 4dba824727751bd4ccf68badeea2f65c5bf3963d Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 14:56:17 +0100 Subject: [PATCH 29/45] Enhance ODBC support for Debian-based systems by setting the library search path in build.rs. Update CI configuration to use the correct PostgreSQL driver name. Document changes in CHANGELOG.md. --- .github/workflows/ci.yml | 2 +- CHANGELOG.md | 1 + build.rs | 12 ++++++++++++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 20485478..47625c5d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -54,7 +54,7 @@ jobs: db_url: "mssql://root:Password123!@127.0.0.1/sqlpage" - database: odbc container: postgres - db_url: "Driver=/usr/lib/x86_64-linux-gnu/odbc/psqlodbcw.so;Server=127.0.0.1;Port=5432;Database=sqlpage;UID=root;PWD=Password123!" + db_url: "Driver=PostgreSQL Unicode;Server=127.0.0.1;Port=5432;Database=sqlpage;UID=root;PWD=Password123!" setup_odbc: true steps: - uses: actions/checkout@v4 diff --git a/CHANGELOG.md b/CHANGELOG.md index ccf8bc1b..a4e00999 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ - SQLPage now sets the [`Server-Timing` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Server-Timing) in development. So when you have a page that loads slowly, you can open your browser's network inspector, click on the slow request, then open the timing tab to understand where it's spending its time. - image - Fixed a memory corruption issue in the builtin odbc driver manager + - ODBC: fix using globally installed system drivers by their name in debian-based linux distributions. ## v0.38.0 diff --git a/build.rs b/build.rs index a39ea959..2b99740c 100644 --- a/build.rs +++ b/build.rs @@ -29,6 +29,7 @@ async fn main() { ] { h.await.unwrap(); } + set_odbc_rpath(); } fn make_client() -> awc::Client { @@ -171,3 +172,14 @@ fn make_url_path(url: &str) -> PathBuf { ); sqlpage_artefacts.join(filename) } + +/// On debian-based linux distributions, odbc drivers are installed in /usr/lib/-linux-gnu/odbc +/// which is not in the default library search path. +fn set_odbc_rpath() { + if cfg!(all(target_os = "linux", feature = "odbc-static")) { + println!( + "cargo:rustc-link-arg=-Wl,-rpath,/usr/lib/{}-linux-gnu/odbc", + std::env::var("TARGET").unwrap().split('-').next().unwrap() + ); + } +} \ No newline at end of file From afde9e1f09d5159c9bc42289fecb73fd29d2ff16 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 15:12:39 +0100 Subject: [PATCH 30/45] fmt --- build.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.rs b/build.rs index 2b99740c..ed14c612 100644 --- a/build.rs +++ b/build.rs @@ -182,4 +182,4 @@ fn set_odbc_rpath() { std::env::var("TARGET").unwrap().split('-').next().unwrap() ); } -} \ No newline at end of file +} From 74a2c8b1e70db851fe0692e134dd14c6257f4e20 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 18:13:36 +0100 Subject: [PATCH 31/45] Fix docker image references in README Update docker image names from sqlpage/SQLPage to lovasoa/sqlpage and update example port mapping to use port 80 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b4c99c33..d1692f5d 100644 --- a/README.md +++ b/README.md @@ -164,12 +164,12 @@ To run on a server, you can use [the docker image](https://hub.docker.com/r/lova custom components, and migrations (see [configuration.md](./configuration.md)) to `/etc/sqlpage` in the container. - For instance, you can use: - - `docker run -it --name sqlpage -p 8080:8080 --volume "$(pwd)/source:/var/www" --volume "$(pwd)/configuration:/etc/sqlpage:ro" --rm sqlpage/SQLPage` + - `docker run -it --name sqlpage -p 80:8080 --volume "$(pwd)/source:/var/www" --volume "$(pwd)/configuration:/etc/sqlpage:ro" --rm lovasoa/sqlpage` - And place your website in a folder named `source` and your `sqlpage.json` in a folder named `configuration`. - If you want to build your own docker image, taking the raw sqlpage image as a base is not recommended, since it is extremely stripped down and probably won't contain the dependencies you need. Instead, you can take debian as a base and simply copy the sqlpage binary from the official image to your own image: - ```Dockerfile FROM debian:stable-slim - COPY --from=sqlpage/SQLPage:main /usr/local/bin/sqlpage /usr/local/bin/sqlpage + COPY --from=lovasoa/sqlpage:main /usr/local/bin/sqlpage /usr/local/bin/sqlpage ``` We provide compiled binaries only for the x86_64 architecture, but provide docker images for other architectures, including arm64 and armv7. If you want to run SQLPage on a Raspberry Pi or @@ -359,4 +359,4 @@ Check out our [Contributing Guide](./CONTRIBUTING.md) for detailed instructions Our windows binaries are digitally signed, so they should be recognized as safe by Windows. Free code signing provided by [SignPath.io](https://about.signpath.io/), certificate by [SignPath Foundation](https://signpath.org/). [Contributors](https://github.com/sqlpage/SQLPage/graphs/contributors), [Owners](https://github.com/orgs/sqlpage/people?query=role%3Aowner). -This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it \ No newline at end of file +This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it From 7f7fdd6f576be199aad73c3877453240b51f9715 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 22:49:28 +0100 Subject: [PATCH 32/45] update deps --- Cargo.lock | 48 +++++++++++++++++------------------------------- 1 file changed, 17 insertions(+), 31 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index b4b1df95..96f46222 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2431,9 +2431,9 @@ dependencies = [ [[package]] name = "js-sys" -version = "0.3.81" +version = "0.3.82" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ec48937a97411dcb524a265206ccd4c90bb711fca92b2792c407f268825b9305" +checksum = "b011eec8cc36da2aab2d5cff675ec18454fad408585853910a202391cf9f8e65" dependencies = [ "once_cell", "wasm-bindgen", @@ -3852,9 +3852,9 @@ dependencies = [ [[package]] name = "rustls-pki-types" -version = "1.12.0" +version = "1.13.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "229a4a4c221013e7e1f1a043678c5cc39fe5171437c88fb47151a21e6f5b5c79" +checksum = "94182ad936a0c91c324cd46c6511b9510ed16af436d7b5bab34beab0afd55f7a" dependencies = [ "zeroize", ] @@ -4914,9 +4914,9 @@ checksum = "b8dad83b4f25e74f184f64c43b150b91efe7647395b42289f38e50566d82855b" [[package]] name = "wasm-bindgen" -version = "0.2.104" +version = "0.2.105" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c1da10c01ae9f1ae40cbfac0bac3b1e724b320abfcf52229f80b547c0d250e2d" +checksum = "da95793dfc411fbbd93f5be7715b0578ec61fe87cb1a42b12eb625caa5c5ea60" dependencies = [ "cfg-if", "once_cell", @@ -4925,25 +4925,11 @@ dependencies = [ "wasm-bindgen-shared", ] -[[package]] -name = "wasm-bindgen-backend" -version = "0.2.104" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "671c9a5a66f49d8a47345ab942e2cb93c7d1d0339065d4f8139c486121b43b19" -dependencies = [ - "bumpalo", - "log", - "proc-macro2", - "quote", - "syn", - "wasm-bindgen-shared", -] - [[package]] name = "wasm-bindgen-futures" -version = "0.4.54" +version = "0.4.55" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7e038d41e478cc73bae0ff9b36c60cff1c98b8f38f8d7e8061e79ee63608ac5c" +checksum = "551f88106c6d5e7ccc7cd9a16f312dd3b5d36ea8b4954304657d5dfba115d4a0" dependencies = [ "cfg-if", "js-sys", @@ -4954,9 +4940,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro" -version = "0.2.104" +version = "0.2.105" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7ca60477e4c59f5f2986c50191cd972e3a50d8a95603bc9434501cf156a9a119" +checksum = "04264334509e04a7bf8690f2384ef5265f05143a4bff3889ab7a3269adab59c2" dependencies = [ "quote", "wasm-bindgen-macro-support", @@ -4964,31 +4950,31 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro-support" -version = "0.2.104" +version = "0.2.105" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9f07d2f20d4da7b26400c9f4a0511e6e0345b040694e8a75bd41d578fa4421d7" +checksum = "420bc339d9f322e562942d52e115d57e950d12d88983a14c79b86859ee6c7ebc" dependencies = [ + "bumpalo", "proc-macro2", "quote", "syn", - "wasm-bindgen-backend", "wasm-bindgen-shared", ] [[package]] name = "wasm-bindgen-shared" -version = "0.2.104" +version = "0.2.105" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bad67dc8b2a1a6e5448428adec4c3e84c43e561d8c9ee8a9e5aabeb193ec41d1" +checksum = "76f218a38c84bcb33c25ec7059b07847d465ce0e0a76b995e134a45adcb6af76" dependencies = [ "unicode-ident", ] [[package]] name = "web-sys" -version = "0.3.81" +version = "0.3.82" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9367c417a924a74cae129e6a2ae3b47fabb1f8995595ab474029da749a8be120" +checksum = "3a1f95c0d03a47f4ae1f7a64643a6bb97465d9b740f0fa8f90ea33915c99a9a1" dependencies = [ "js-sys", "wasm-bindgen", From 722dc740fa9df5cd34b8d5e2b2907d2cf8776a45 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 23:07:57 +0100 Subject: [PATCH 33/45] add an error_message property to the login component - Updated SQL queries in `create_session_token.sql` and `login.sql` to use consistent parameter naming conventions. - Enhanced the login form in `login.sql` to include an error message for failed login attempts. - Added a new parameter `error_message` in the migration file for better user feedback. - Modified the Handlebars template to display the error message when applicable, improving user experience during authentication. --- .../authentication/create_session_token.sql | 6 +++--- .../examples/authentication/login.sql | 17 +++++++++++------ .../sqlpage/migrations/68_login.sql | 1 + sqlpage/templates/login.handlebars | 12 +++++++++++- 4 files changed, 26 insertions(+), 10 deletions(-) diff --git a/examples/official-site/examples/authentication/create_session_token.sql b/examples/official-site/examples/authentication/create_session_token.sql index 645fedc4..8ea8cd19 100644 --- a/examples/official-site/examples/authentication/create_session_token.sql +++ b/examples/official-site/examples/authentication/create_session_token.sql @@ -4,12 +4,12 @@ delete from user_sessions where created_at < datetime('now', '-1 day'); -- check that the SELECT 'authentication' AS component, 'login.sql?failed' AS link, -- redirect to the login page on error - (SELECT password_hash FROM users WHERE username = :Username) AS password_hash, -- this is a hash of the password 'admin' - :Password AS password; -- this is the password that the user sent through our form in 'index.sql' + (SELECT password_hash FROM users WHERE username = :username) AS password_hash, -- this is a hash of the password 'admin' + :password AS password; -- this is the password that the user sent through our form in 'index.sql' -- if we haven't been redirected, then the password is correct -- create a new session -insert into user_sessions (session_token, username) values (sqlpage.random_string(32), :Username) +insert into user_sessions (session_token, username) values (sqlpage.random_string(32), :username) returning 'cookie' as component, 'session_token' as name, session_token as value; -- redirect to the authentication example home page diff --git a/examples/official-site/examples/authentication/login.sql b/examples/official-site/examples/authentication/login.sql index b634de30..264bbc4a 100644 --- a/examples/official-site/examples/authentication/login.sql +++ b/examples/official-site/examples/authentication/login.sql @@ -1,10 +1,15 @@ select 'dynamic' as component, properties FROM example WHERE component = 'shell' LIMIT 1; -select 'form' as component, 'Authentication' as title, 'Log in' as validate, 'create_session_token.sql' as action; -select 'Username' as name, 'user' as prefix_icon, 'admin' as placeholder; -select 'Password' as name, 'lock' as prefix_icon, 'admin' as placeholder, 'password' as type; - -select 'alert' as component, 'danger' as color, 'Invalid username or password' as title where $failed is not null; +select + 'login' as component, + 'create_session_token.sql' as action, + '/assets/icon.webp' as image, + 'Demo Login Form' as title, + 'Username' as username, + 'Password' as password, + case when $failed is not null then 'Invalid username or password. In this demo, you can log in with admin / admin.' end as error_message, + 'In this demo, the username is "admin" and the password is "admin".' as footer_md, + 'Sign in' as validate; select 'text' as component, ' @@ -12,7 +17,7 @@ select 'text' as component, ' This is a simple example of an authentication form. It uses - - the [`form`](/documentation.sql?component=form#component) component to create a login form + - the [`login`](/documentation.sql?component=login#component) component to create a login form - the [`authentication`](/documentation.sql?component=authentication#component) component to check the user password - the [`cookie`](/documentation.sql?component=cookie#component) component to store a unique session token in the user browser - the [`redirect`](/documentation.sql?component=redirect#component) component to redirect the user to the login page if they are not logged in diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index 6d906ae5..522c8672 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -20,6 +20,7 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('title','Title of the authentication form.','TEXT',TRUE,TRUE), ('enctype','Form data encoding.','TEXT',TRUE,TRUE), ('action','An optional link to a target page that will handle the results of the form. ','TEXT',TRUE,TRUE), + ('error_message','An error message to display above the form, typically shown after a failed login attempt.','TEXT',TRUE,TRUE), ('username','User account identifier.','TEXT',TRUE,FALSE), ('password','User password.','TEXT',TRUE,FALSE), ('username_icon','Icon to display on the left side of the input field, on the same line.','ICON',TRUE,TRUE), diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars index a664e0cc..54808bfa 100644 --- a/sqlpage/templates/login.handlebars +++ b/sqlpage/templates/login.handlebars @@ -13,13 +13,23 @@ {{/if}} > {{#if image}} -
    +
    {{/if}} {{#if title}}

    {{title}}

    {{/if}} + {{#if error_message}} + + {{/if}}
    {{#if username_icon}} From cfea904e5d30d50494c100515b744802501b883d Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Sat, 18 Oct 2025 12:19:15 +0200 Subject: [PATCH 34/45] The login component is an authentication form for users of an application. --- .../sqlpage/migrations/68_login.sql | 52 +++++++++++ .../99_shared_id_class_attributes.sql | 6 +- sqlpage/templates/login.handlebars | 89 +++++++++++++++++++ 3 files changed, 145 insertions(+), 2 deletions(-) create mode 100644 examples/official-site/sqlpage/migrations/68_login.sql create mode 100644 sqlpage/templates/login.handlebars diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql new file mode 100644 index 00000000..7230f759 --- /dev/null +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -0,0 +1,52 @@ +INSERT INTO component(name, icon, description, introduced_in_version) VALUES + ('login', 'password-user', ' +The login component is an authentication form for users of an application. + +It allows the entry of a user account consisting of a username and a password. + +It offers additional features such as the ability to request session persistence or to reset the password.', '0.39.0'); + +INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'login', * FROM (VALUES + ('title','Title of the authentication form.','TEXT',TRUE,TRUE), + ('enctype','Form data encoding.','TEXT',TRUE,TRUE), + ('action','An optional link to a target page that will handle the results of the form. ','TEXT',TRUE,TRUE), + ('username','User account identifier.','TEXT',TRUE,FALSE), + ('password','User password.','TEXT',TRUE,FALSE), + ('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE), + ('forgot_password_text','A text for the link allowing the user to reset their password. If the text is empty, the link is not displayed.','TEXT',TRUE,TRUE), + ('forgot_password_link','The link to the page allowing the user to reset their password.','TEXT',TRUE,TRUE), + ('remember_me_text','A text for the option allowing the user to request the preservation of their work session. The name of the field is remember. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE), + ('footer','A text placed at the bottom of the authentication form.','TEXT',TRUE,TRUE), + ('footer_md','A markdown text placed at the bottom of the authentication form. Useful for creating links to other pages (creating a new account, contacting technical support, etc.).','TEXT',TRUE,TRUE), + ('validate','The text to display in the button at the bottom of the form that submits the values.','TEXT',TRUE,FALSE), + ('validate_color','The color of the button at the bottom of the form that submits the values. Omit this property to use the default color.','COLOR',TRUE,TRUE), + ('validate_shape','The shape of the validation button.','TEXT',TRUE,TRUE), + ('validate_outline','A color to outline the validation button.','COLOR',TRUE,TRUE), + ('validate_size','The size of the validation button.','TEXT',TRUE,TRUE) +) x; + +-- Insert example(s) for the component +INSERT INTO example(component, description, properties) +VALUES ( + 'login', + 'Using the main options of the login component', + JSON( + '[ + { + "component": "login", + "action": "login.sql", + "image": "../assets/icon.webp", + "title": "Please login to your account", + "username": "Username", + "password": "Password", + "forgot_password_text": "Forgot your password?", + "forgot_password_link": "reset_password.sql", + "remember_me_text": "Remember me", + "footer_md": "Don''t have an account? [Register here](register.sql)", + "validate": "Sign in" + } + ]' + ) + ); + +-- 265707.png \ No newline at end of file diff --git a/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql b/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql index 47e66576..df054541 100644 --- a/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql +++ b/examples/official-site/sqlpage/migrations/99_shared_id_class_attributes.sql @@ -18,7 +18,8 @@ FROM (VALUES ('title', TRUE), ('tracking', TRUE), ('text', TRUE), - ('carousel', TRUE) + ('carousel', TRUE), + ('login', TRUE) ); INSERT INTO parameter(component, top_level, name, description, type, optional) @@ -49,6 +50,7 @@ FROM (VALUES ('timeline', FALSE), ('title', TRUE), ('tracking', TRUE), - ('carousel', TRUE) + ('carousel', TRUE), + ('login', TRUE) ); diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars new file mode 100644 index 00000000..f292a18d --- /dev/null +++ b/sqlpage/templates/login.handlebars @@ -0,0 +1,89 @@ +
    +
    +
    + + {{#if image}} +
    + +
    + {{/if}} + {{#if title}} +

    {{title}}

    + {{/if}} + +
    + + + + + + + + +
    + +
    + + + + + + + + + +
    + {{#if remember_me_text}} + + {{/if}} +
    + +
    + {{#if (or footer footer_md)}} +
    +
    + + {{#if footer}} + {{footer}} + {{else}} + {{#if footer_md}} + {{{markdown footer_md}}} + {{/if}} + {{/if}} + +
    + {{/if}} + +
    +
    +
    From eb1f43c6e1567104a4ce81d605404c37c78b7177 Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Fri, 24 Oct 2025 08:04:39 +0200 Subject: [PATCH 35/45] username_icon and password_icon attributes --- .../sqlpage/migrations/68_login.sql | 6 ++-- sqlpage/templates/login.handlebars | 28 +++++-------------- 2 files changed, 11 insertions(+), 23 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index 7230f759..dad03a8e 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -12,6 +12,8 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('action','An optional link to a target page that will handle the results of the form. ','TEXT',TRUE,TRUE), ('username','User account identifier.','TEXT',TRUE,FALSE), ('password','User password.','TEXT',TRUE,FALSE), + ('username_icon','Icon to display on the left side of the input field, on the same line.','ICON',TRUE,TRUE), + ('password_icon','Icon to display on the left side of the input field, on the same line.','ICON',TRUE,TRUE), ('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE), ('forgot_password_text','A text for the link allowing the user to reset their password. If the text is empty, the link is not displayed.','TEXT',TRUE,TRUE), ('forgot_password_link','The link to the page allowing the user to reset their password.','TEXT',TRUE,TRUE), @@ -39,6 +41,8 @@ VALUES ( "title": "Please login to your account", "username": "Username", "password": "Password", + "username_icon": "user", + "password_icon": "lock", "forgot_password_text": "Forgot your password?", "forgot_password_link": "reset_password.sql", "remember_me_text": "Remember me", @@ -48,5 +52,3 @@ VALUES ( ]' ) ); - --- 265707.png \ No newline at end of file diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars index f292a18d..258622a8 100644 --- a/sqlpage/templates/login.handlebars +++ b/sqlpage/templates/login.handlebars @@ -1,4 +1,4 @@ -
    +
    {{username}}
    - - - - - - - + {{#if username_icon}} + {{icon_img username_icon}} + {{/if}}
    - - - - - - - - + {{#if password_icon}} + {{~icon_img password_icon~}} + {{/if}}
    {{#if remember_me_text}} From 36ab34f827fe7cfaf761f86c8752e861539eca2c Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Fri, 24 Oct 2025 08:09:32 +0200 Subject: [PATCH 36/45] Fixing a regression with the class attribute. --- sqlpage/templates/login.handlebars | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars index 258622a8..a664e0cc 100644 --- a/sqlpage/templates/login.handlebars +++ b/sqlpage/templates/login.handlebars @@ -1,4 +1,4 @@ -
    +
    Date: Fri, 24 Oct 2025 08:29:35 +0200 Subject: [PATCH 37/45] Documentation improved --- .../official-site/sqlpage/migrations/68_login.sql | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index dad03a8e..1cbed299 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -1,10 +1,15 @@ INSERT INTO component(name, icon, description, introduced_in_version) VALUES ('login', 'password-user', ' -The login component is an authentication form for users of an application. +The login component is an authentication form with numerous customization options. +It offers the main functionalities for this type of form. +The user can enter their username and password. +There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s session via a cookie. +It is also possible to set the title of the form, display the company logo, or customize the appearance of the form submission button. -It allows the entry of a user account consisting of a username and a password. +This component should be used in conjunction with other components such as [authentication](component.sql?component=authentication) and [cookie](component.sql?component=cookie). +It does not implement any logic and simply collects the username and password to pass them to the code responsible for authentication. -It offers additional features such as the ability to request session persistence or to reset the password.', '0.39.0'); +', '0.39.0'); INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'login', * FROM (VALUES ('title','Title of the authentication form.','TEXT',TRUE,TRUE), From 3d7f780fbd3002b930745b229f0b78bcb6768e2f Mon Sep 17 00:00:00 2001 From: Olivier Auverlot Date: Fri, 24 Oct 2025 08:45:57 +0200 Subject: [PATCH 38/45] Documentation improved --- examples/official-site/sqlpage/migrations/68_login.sql | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index 1cbed299..6d906ae5 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -3,12 +3,17 @@ INSERT INTO component(name, icon, description, introduced_in_version) VALUES The login component is an authentication form with numerous customization options. It offers the main functionalities for this type of form. The user can enter their username and password. -There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s session via a cookie. +There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s identity via a cookie. It is also possible to set the title of the form, display the company logo, or customize the appearance of the form submission button. This component should be used in conjunction with other components such as [authentication](component.sql?component=authentication) and [cookie](component.sql?component=cookie). It does not implement any logic and simply collects the username and password to pass them to the code responsible for authentication. +A few things to know : +- The form uses the POST method to transmit information to the destination page, +- The user''s username and password are entered into fields with the names `username` and `password`, +- To obtain the values of username and password, you must use the variables `:username` and `:password`, +- To know if the user wants their identity to be remembered, you must read the value of the variable `:remember`. ', '0.39.0'); INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'login', * FROM (VALUES @@ -22,7 +27,7 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE), ('forgot_password_text','A text for the link allowing the user to reset their password. If the text is empty, the link is not displayed.','TEXT',TRUE,TRUE), ('forgot_password_link','The link to the page allowing the user to reset their password.','TEXT',TRUE,TRUE), - ('remember_me_text','A text for the option allowing the user to request the preservation of their work session. The name of the field is remember. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE), + ('remember_me_text','A text for the option allowing the user to request the preservation of their identity. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE), ('footer','A text placed at the bottom of the authentication form.','TEXT',TRUE,TRUE), ('footer_md','A markdown text placed at the bottom of the authentication form. Useful for creating links to other pages (creating a new account, contacting technical support, etc.).','TEXT',TRUE,TRUE), ('validate','The text to display in the button at the bottom of the form that submits the values.','TEXT',TRUE,FALSE), From cc95ae25dee3e671c6f604268d9bd1ebe7e90c98 Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 18:13:52 +0100 Subject: [PATCH 39/45] Improve login component documentation and usability Add complete example with database schema, credential processing, and page protection. Update authentication migration to reference new login component. Enhance login template with default icons and autocomplete attributes. Make validate parameter optional with sensible default. --- .../sqlpage/migrations/07_authentication.sql | 8 +- .../sqlpage/migrations/68_login.sql | 78 +++++++++++++++---- sqlpage/templates/login.handlebars | 14 ++-- 3 files changed, 71 insertions(+), 29 deletions(-) diff --git a/examples/official-site/sqlpage/migrations/07_authentication.sql b/examples/official-site/sqlpage/migrations/07_authentication.sql index fd342fc6..c759dee8 100644 --- a/examples/official-site/sqlpage/migrations/07_authentication.sql +++ b/examples/official-site/sqlpage/migrations/07_authentication.sql @@ -14,7 +14,7 @@ you have two main options: - does not require any external service - gives you fine-grained control over - which pages and actions are protected - - the look of the login form + - the look of the [login form](?component=login) - the duration of the session - the permissions of each user 2. [**Single sign-on**](/sso) @@ -128,12 +128,10 @@ Then, in all the pages that require authentication, you check if the cookie is p You can check if the user has sent the correct password in a form, and if not, redirect them to a login page. -Create a login form in a file called `login.sql`: +Create a login form in a file called `login.sql` that uses the [login component](?component=login): ```sql -select ''form'' as component, ''Authentication'' as title, ''Log in'' as validate, ''create_session_token.sql'' as action; -select ''Username'' as name, ''admin'' as placeholder; -select ''Password'' as name, ''admin'' as placeholder, ''password'' as type; +select ''login'' as component; ``` And then, in `create_session_token.sql` : diff --git a/examples/official-site/sqlpage/migrations/68_login.sql b/examples/official-site/sqlpage/migrations/68_login.sql index 6d906ae5..a8a18c60 100644 --- a/examples/official-site/sqlpage/migrations/68_login.sql +++ b/examples/official-site/sqlpage/migrations/68_login.sql @@ -1,13 +1,15 @@ INSERT INTO component(name, icon, description, introduced_in_version) VALUES ('login', 'password-user', ' The login component is an authentication form with numerous customization options. -It offers the main functionalities for this type of form. -The user can enter their username and password. +The user enters their username and password, +and is then redirected to another page, where you can use the [authentication](?component=authentication) component +to check the credentials. + There are many optional attributes such as the use of icons on input fields, the insertion of a link to a page to reset the password, an option for the application to maintain the user''s identity via a cookie. It is also possible to set the title of the form, display the company logo, or customize the appearance of the form submission button. -This component should be used in conjunction with other components such as [authentication](component.sql?component=authentication) and [cookie](component.sql?component=cookie). -It does not implement any logic and simply collects the username and password to pass them to the code responsible for authentication. +This component does not implement any logic. It simply collects the username and password to pass them to the code responsible for authentication. +It should be used in conjunction with other components such as [authentication](component.sql?component=authentication) and [cookie](component.sql?component=cookie) to actually allow or deny access. A few things to know : - The form uses the POST method to transmit information to the destination page, @@ -20,8 +22,8 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('title','Title of the authentication form.','TEXT',TRUE,TRUE), ('enctype','Form data encoding.','TEXT',TRUE,TRUE), ('action','An optional link to a target page that will handle the results of the form. ','TEXT',TRUE,TRUE), - ('username','User account identifier.','TEXT',TRUE,FALSE), - ('password','User password.','TEXT',TRUE,FALSE), + ('username','Label and placeholder for the user account identifier text field.','TEXT',TRUE,FALSE), + ('password','Label and placeholder for the password field.','TEXT',TRUE,FALSE), ('username_icon','Icon to display on the left side of the input field, on the same line.','ICON',TRUE,TRUE), ('password_icon','Icon to display on the left side of the input field, on the same line.','ICON',TRUE,TRUE), ('image','The URL of an centered image displayed before the title.','URL',TRUE,TRUE), @@ -30,7 +32,7 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S ('remember_me_text','A text for the option allowing the user to request the preservation of their identity. If the text is empty, the option is not displayed.','TEXT',TRUE,TRUE), ('footer','A text placed at the bottom of the authentication form.','TEXT',TRUE,TRUE), ('footer_md','A markdown text placed at the bottom of the authentication form. Useful for creating links to other pages (creating a new account, contacting technical support, etc.).','TEXT',TRUE,TRUE), - ('validate','The text to display in the button at the bottom of the form that submits the values.','TEXT',TRUE,FALSE), + ('validate','The text to display in the button at the bottom of the form that submits the values.','TEXT',TRUE,TRUE), ('validate_color','The color of the button at the bottom of the form that submits the values. Omit this property to use the default color.','COLOR',TRUE,TRUE), ('validate_shape','The shape of the validation button.','TEXT',TRUE,TRUE), ('validate_outline','A color to outline the validation button.','COLOR',TRUE,TRUE), @@ -41,10 +43,57 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S INSERT INTO example(component, description, properties) VALUES ( 'login', - 'Using the main options of the login component', - JSON( - '[ - { + 'This example shows how to implement a complete custom login system in your SQLPage app. + +### Database schema + +`sqlpage/migrations/001_users.sql` + +```sql +create table account ( + username TEXT PRIMARY KEY, + password_hash TEXT NOT NULL +); + +create table session ( + id TEXT PRIMARY KEY, + username TEXT REFERENCES account(username) + -- you could add more fields for session expiration, session metadata tracking... +); +``` + +### Process user credentials + +Create a file named `login.sql`: + +```sql +SELECT ''authentication'' AS component, + ''/'' AS link, -- redirect the user to the homepage if the password is incorrect + (SELECT password_hash FROM account WHERE username = :username) AS password_hash, + :password AS password; + +-- The code after this point is only executed if the user has sent the correct password + +-- Generate a random session token +INSERT INTO session (id, username) +VALUES (sqlpage.random_string(32), :username) +RETURNING ''cookie'' AS component, ''session_token'' AS name, id AS value, +case when :remember is null then 3600*24*365 else 3600*4 end as max_age; + +select ''redirect'' as component, ''protected.sql'' as link; -- once logged in, redirect to the protected page +``` + +### Protect pages + +Start all protected pages with + +```sql +select ''redirect'' as component, ''/'' as link where not exists (select 1 from session where id=sqlpage.cookie(''session_token'')); +``` + +### Login form on the home page +', + JSON('[{ "component": "login", "action": "login.sql", "image": "../assets/icon.webp", @@ -58,7 +107,6 @@ VALUES ( "remember_me_text": "Remember me", "footer_md": "Don''t have an account? [Register here](register.sql)", "validate": "Sign in" - } - ]' - ) - ); + }]') +), + ('login', 'Most basic login form', JSON('[{"component": "login"}]')); diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars index a664e0cc..723fdb87 100644 --- a/sqlpage/templates/login.handlebars +++ b/sqlpage/templates/login.handlebars @@ -22,10 +22,8 @@ {{/if}}
    - {{#if username_icon}} - {{icon_img username_icon}} - {{/if}} - + {{icon_img (default username_icon 'user-circle')}} +
    - {{#if password_icon}} - {{~icon_img password_icon~}} - {{/if}} - + {{~icon_img (default password_icon 'key')~}} +
    {{#if remember_me_text}}
    {{#if (or footer footer_md)}}
    From d542a8ae79e1ffe7bc83838cf1ea7c5a286c784a Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 23:23:44 +0100 Subject: [PATCH 40/45] update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4e00999..ccb59417 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ - image - Fixed a memory corruption issue in the builtin odbc driver manager - ODBC: fix using globally installed system drivers by their name in debian-based linux distributions. + - New [login](https://sql-page.com/component.sql?component=table) component. ## v0.38.0 From 5ee781cf40950890f53c94218bde20e4378977fd Mon Sep 17 00:00:00 2001 From: lovasoa Date: Mon, 27 Oct 2025 23:36:29 +0100 Subject: [PATCH 41/45] use the login component in the user auth example --- .../user-authentication/docker-compose.yml | 2 ++ examples/user-authentication/signin.sql | 21 +++++++------------ sqlpage/templates/login.handlebars | 7 ++++--- 3 files changed, 14 insertions(+), 16 deletions(-) diff --git a/examples/user-authentication/docker-compose.yml b/examples/user-authentication/docker-compose.yml index 5108ac1e..7738221d 100644 --- a/examples/user-authentication/docker-compose.yml +++ b/examples/user-authentication/docker-compose.yml @@ -1,6 +1,8 @@ services: web: image: lovasoa/sqlpage:main # main is cutting edge, use sqlpage/SQLPage:latest for the latest stable version + build: + context: ".." ports: - "8080:8080" volumes: diff --git a/examples/user-authentication/signin.sql b/examples/user-authentication/signin.sql index 4057e44d..bab0e883 100644 --- a/examples/user-authentication/signin.sql +++ b/examples/user-authentication/signin.sql @@ -1,14 +1,9 @@ -SELECT 'form' AS component, +SELECT 'login' AS component, + 'login.sql' AS action, 'Sign in' AS title, - 'Sign in' AS validate, - 'login.sql' AS action; - -SELECT 'username' AS name; -SELECT 'password' AS name, 'password' AS type; - -SELECT 'alert' as component, - 'Sorry' as title, - 'We could not authenticate you. Please log in or [create an account](signup.sql).' as description_md, - 'alert-circle' as icon, - 'red' as color -WHERE $error IS NOT NULL; \ No newline at end of file + 'Username' AS username, + 'Password' AS password, + 'user' AS username_icon, + 'lock' AS password_icon, + case when $error is not null then 'We could not authenticate you. Please log in or [create an account](signup.sql).' end as error_message_md, + 'Sign in' AS validate; \ No newline at end of file diff --git a/sqlpage/templates/login.handlebars b/sqlpage/templates/login.handlebars index 18c9bbb0..28e1666c 100644 --- a/sqlpage/templates/login.handlebars +++ b/sqlpage/templates/login.handlebars @@ -20,13 +20,14 @@ {{#if title}}

    {{title}}

    {{/if}} - {{#if error_message}} + {{#if (or error_message error_message_md)}}
    {{/if}} - +
    {{icon_img (default username_icon 'user-circle')}}
    -