mirrors/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2025-09-15 23:42:28 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 24

vlib: add a new Dynamic Template Manager module in x.templating.dtm and an example vweb server that uses it (#20468)

Browse source
This commit is contained in:
GGRei 2024-02-02 15:14:51 +01:00 • committed by GitHub
parent 5f732aa1b2
commit 07016fb3d5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 1750 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

65
vlib/vweb/tests/dynamic_template_manager_test_server/dynamic_template_manager_test_server.v Normal file
View file

@ -0,0 +1,65 @@
import vweb
import time
import x.templating.dtm
import os
struct App {
vweb.Context
pub mut:
dtm &dtm.DynamicTemplateManager = dtm.create_dtm() @[vweb_global]
shared_data_string []string @[vweb_global]
shared_data_int []int @[vweb_global]
shared_switch int = 1 @[vweb_global]
}
fn main() {
mut app := &App{}
app.shared_data_string << 'vweb dtm'
app.shared_data_string << 'VWEB DTM'
app.shared_data_string << '<span>this <br> is <br> a <br> test <br> with <br> included <br> HTML!</span>'
app.shared_data_string << '<span>THIS <br> NOT <br> A <br> TEST!</span>'
app.shared_data_string << '<p>escaped html tags test</p>'
app.shared_data_int << 123456
app.shared_data_int << 7891011
dtm.initialize_dtm(mut app.dtm) or { eprintln(err) }
/*
app.initialize_dtm(mut &app.dtm,
compress_html: false
active_cache_server: false
max_size_data_in_mem: 100) or { eprintln(err) }
*/
go app.update_data()
app.mount_static_folder_at(os.resource_abs_path('static'), '/')
vweb.run(app, 18081)
}
@['/']
pub fn (mut app App) index() vweb.Result {
mut tmpl_var := map[string]dtm.DtmMultiTypeMap{}
tmpl_var['title'] = app.shared_data_string[app.shared_switch]
tmpl_var['non_string_type'] = app.shared_data_int[app.shared_switch]
tmpl_var['string_type'] = app.shared_data_string[4]
tmpl_var['html_#includehtml'] = app.shared_data_string[app.shared_switch + 2]
// You can also modify the HTML template file directly without having to recompile the application.
html_content := app.dtm.serve_dynamic_template('index.html',
placeholders: &tmpl_var
cache_delay_expiration: dtm.cache_delay_expiration_at_min
)
return app.html(html_content)
}
fn (mut app App) update_data() {
for {
if app.shared_switch == 1 {
app.shared_switch = 0
} else {
app.shared_switch = 1
}
time.sleep(10 * time.second)
}
}

30
vlib/vweb/tests/dynamic_template_manager_test_server/static/index.css Normal file
View file

@ -0,0 +1,30 @@
body {
font-family: Arial, sans-serif;
background-color: #f8f8f8;
color: #333;
margin: 0;
padding: 0;
}
#container {
width: 80%;
margin: 0 auto;
background-color: #fff;
padding: 20px;
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
}
h1 {
color: #007bff;
text-align: center;
}
p {
font-size: 16px;
line-height: 1.6;
}
span {
color: #28a745;
font-weight: bold;
}

2
vlib/vweb/tests/dynamic_template_manager_test_server/templates/comment.html Normal file
View file

@ -0,0 +1,2 @@
<p>This is from a file inclusion!</p>
<span>DTM</span>

16
vlib/vweb/tests/dynamic_template_manager_test_server/templates/index.html Normal file
View file

@ -0,0 +1,16 @@
<!DOCTYPE html>
<html>
<head>
<title>@title</title>
@css '/index.css'
</head>
<body>
@include 'comment.html'
<div id="container">
<H1>@title</H1>
<p>@non_string_type</p>
<p>@string_type</p>
@html
</div>
</body>
</html>

0
vlib/vweb/tests/dynamic_template_manager_test_server/vcache/.gitkeep Normal file
View file

1225
vlib/x/templating/dtm/dynamic_template_manager.v Normal file
View file

File diff suppressed because it is too large Load diff

405
vlib/x/templating/dtm/dynamic_template_manager_test.v Normal file
View file

@ -0,0 +1,405 @@
module dtm
import os
import time
const temp_dtm_dir = 'dynamic_template_manager_test'
const temp_cache_dir = 'vcache'
const temp_templates_dir = 'templates'
const temp_html_fp = 'temp.html'
const temp_html_n = 'temp'
const vtmp_dir = os.vtmp_dir()
fn testsuite_begin() {
temp_folder := os.join_path(dtm.vtmp_dir, dtm.temp_dtm_dir)
os.mkdir_all(temp_folder)!
vcache_path := os.join_path(temp_folder, dtm.temp_cache_dir)
templates_path := os.join_path(temp_folder, dtm.temp_templates_dir)
os.mkdir_all(vcache_path)!
os.mkdir_all(templates_path)!
temp_html_file := os.join_path(templates_path, dtm.temp_html_fp)
html_content := '
<!DOCTYPE html>
<html>
<head>
<title>TEST</title>
</head>
<body>
<div>
<H1>TEST</H1>
</div>
</body>
</html>'
os.write_file(temp_html_file, html_content)!
}
fn test_initialize_dtm() {
dtmi := init_dtm(false, 0)!
assert dtmi.dtm_init_is_ok == true
}
fn test_check_and_clear_cache_files() {
dtmi := init_dtm(false, 0)!
dtmi.check_and_clear_cache_files()!
count_cache_files := os.ls(dtmi.template_cache_folder)!
assert count_cache_files.len == 0
}
fn test_create_template_cache_and_display_html() {
mut dtmi := init_dtm(true, max_size_data_in_memory)!
defer {
dtmi.stop_cache_handler()
}
html := dtmi.create_cache()
assert html.len > 10
}
fn test_get_cache() {
mut dtmi := init_dtm(true, max_size_data_in_memory)!
dtmi.create_cache()
defer {
dtmi.stop_cache_handler()
}
dtm_placeholers := map[string]DtmMultiTypeMap{}
temp_html_file := os.join_path(dtmi.template_folder, dtm.temp_html_fp)
html_mem := dtmi.get_cache(dtm.temp_html_n, temp_html_file, &dtm_placeholers)
assert html_mem.len > 10
}
fn test_return_cache_info_isexistent() {
mut dtmi := init_dtm(false, 0)!
path_template := os.join_path(dtmi.template_folder, dtm.temp_html_fp)
lock dtmi.template_caches {
dtmi.template_caches << TemplateCache{
id: 1
path: path_template
}
}
lock dtmi.nbr_of_remaining_template_request {
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 1
}
}
cache_exists, _, _, _, _, _, _ := dtmi.return_cache_info_isexistent(path_template)
assert cache_exists == true
lock dtmi.template_caches {
dtmi.template_caches[0].id_redirection = 2
dtmi.template_caches << TemplateCache{
id: 2
path: path_template
id_redirection: 3
}
dtmi.template_caches << TemplateCache{
id: 3
path: path_template
id_redirection: 4
}
dtmi.template_caches << TemplateCache{
id: 4
path: path_template
id_redirection: 5
}
dtmi.template_caches << TemplateCache{
id: 5
path: path_template
}
}
lock dtmi.nbr_of_remaining_template_request {
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 2
}
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 3
}
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 4
}
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 5
}
}
_, id, _, _, _, _, _ := dtmi.return_cache_info_isexistent(path_template)
assert id == 5
}
fn test_remaining_template_request() {
mut dtmi := init_dtm(false, 0)!
lock dtmi.nbr_of_remaining_template_request {
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 1
}
}
dtmi.remaining_template_request(true, 1)
rlock dtmi.nbr_of_remaining_template_request {
assert dtmi.nbr_of_remaining_template_request[0].nbr_of_remaining_request == 1
}
dtmi.remaining_template_request(true, 1)
rlock dtmi.nbr_of_remaining_template_request {
assert dtmi.nbr_of_remaining_template_request[0].nbr_of_remaining_request == 2
}
dtmi.remaining_template_request(false, 1)
rlock dtmi.nbr_of_remaining_template_request {
assert dtmi.nbr_of_remaining_template_request[0].nbr_of_remaining_request == 1
}
dtmi.remaining_template_request(false, 1)
rlock dtmi.nbr_of_remaining_template_request {
assert dtmi.nbr_of_remaining_template_request[0].nbr_of_remaining_request == 0
}
}
fn test_check_html_and_placeholders_size() {
mut dtmi := init_dtm(false, 0)!
temp_html_file := os.join_path(dtmi.template_folder, dtm.temp_html_fp)
placeholders := map[string]DtmMultiTypeMap{}
path, filename, content_checksum := dtmi.check_html_and_placeholders_size(temp_html_file,
&placeholders)!
assert path.len > 10
assert filename.len > 3
// assert content_checksum.len > 3
}
fn test_chandler_prevent_cache_duplicate_request() {
dtmi := init_dtm(false, 0)!
temp_html_file := os.join_path(dtmi.template_folder, dtm.temp_html_fp)
lock dtmi.template_caches {
dtmi.template_caches << TemplateCache{
id: 1
path: temp_html_file
cache_request: .new
}
dtmi.template_caches << TemplateCache{
id: 2
path: temp_html_file
cache_request: .update
last_template_mod: i64(1)
}
dtmi.template_caches << TemplateCache{
id: 3
path: temp_html_file
cache_request: .exp_update
last_template_mod: i64(1)
generate_at: i64(100)
}
dtmi.template_caches << TemplateCache{
id: 4
cache_request: .delete
}
}
new_cache := TemplateCache{
id: 5
path: temp_html_file
cache_request: .new
}
update_cache := TemplateCache{
id: 6
path: temp_html_file
cache_request: .update
last_template_mod: i64(1)
}
exp_update_cache := TemplateCache{
id: 7
path: temp_html_file
cache_request: .exp_update
last_template_mod: i64(1)
generate_at: i64(10)
cache_delay_expiration: i64(10)
}
delete_cache := TemplateCache{
id: 4
cache_request: .delete
}
mut is_duplicate := dtmi.chandler_prevent_cache_duplicate_request(&new_cache)
assert is_duplicate == true
is_duplicate = dtmi.chandler_prevent_cache_duplicate_request(&update_cache)
assert is_duplicate == true
is_duplicate = dtmi.chandler_prevent_cache_duplicate_request(&exp_update_cache)
assert is_duplicate == true
is_duplicate = dtmi.chandler_prevent_cache_duplicate_request(&delete_cache)
assert is_duplicate == false
lock dtmi.template_caches {
dtmi.template_caches.delete(3)
}
is_duplicate = dtmi.chandler_prevent_cache_duplicate_request(&delete_cache)
assert is_duplicate == true
}
fn test_chandler_clear_specific_cache() {
mut dtmi := init_dtm(true, 0)!
defer {
dtmi.stop_cache_handler()
}
dtmi.create_cache()
lock dtmi.template_caches {
cache_file := os.join_path(dtmi.template_cache_folder, '${dtmi.template_caches[0].name}_${dtmi.template_caches[0].checksum}.cache')
index, is_success := dtmi.chandler_clear_specific_cache(dtmi.template_caches[0].id)
assert is_success == true
assert index == 0
cache_exist := os.exists(cache_file)
assert cache_exist == false
}
}
fn test_chandler_remaining_cache_template_used() {
mut dtmi := init_dtm(false, 0)!
lock dtmi.nbr_of_remaining_template_request {
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 1
nbr_of_remaining_request: 0
}
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 2
nbr_of_remaining_request: 1
need_to_delete: true
}
dtmi.nbr_of_remaining_template_request << RemainingTemplateRequest{
id: 3
nbr_of_remaining_request: 0
need_to_delete: true
}
}
mut can_delete := dtmi.chandler_remaining_cache_template_used(CacheRequest.update,
3, 3)
assert can_delete == true
can_delete = dtmi.chandler_remaining_cache_template_used(CacheRequest.update, 2, 2)
assert can_delete == false
can_delete = dtmi.chandler_remaining_cache_template_used(CacheRequest.delete, 1, 0)
assert can_delete == true
can_delete = dtmi.chandler_remaining_cache_template_used(CacheRequest.new, 4, 0)
assert can_delete == true
}
fn test_parse_html_file() {
mut dtmi := init_dtm(false, 0)!
temp_folder := os.join_path(dtm.vtmp_dir, dtm.temp_dtm_dir)
templates_path := os.join_path(temp_folder, dtm.temp_templates_dir)
temp_html_file := os.join_path(templates_path, dtm.temp_html_fp)
mut placeholders := map[string]DtmMultiTypeMap{}
is_compressed := true
html := dtmi.parse_html_file(temp_html_file, dtm.temp_html_n, &placeholders, is_compressed)
assert html.len > 0
}
fn test_check_if_cache_delay_iscorrect() {
check_if_cache_delay_iscorrect(i64(300 * 1000000), dtm.temp_html_n) or { assert false }
check_if_cache_delay_iscorrect(i64(-100), dtm.temp_html_n) or { assert true }
}
fn test_cache_request_route() {
mut dtmi := init_dtm(false, 0)!
mut is_cache_exist := true
mut cache_delay_expiration := i64(400)
mut last_template_mod := get_current_unix_micro_timestamp()
mut test_current_template_mod := last_template_mod
mut cache_del_exp := 300
mut gen_at := last_template_mod
mut content_checksum := 'checksumtest1'
mut current_content_checksum := 'checksumtest2'
mut request_type, _ := dtmi.cache_request_route(is_cache_exist, cache_delay_expiration,
last_template_mod, test_current_template_mod, cache_del_exp, gen_at, get_current_unix_micro_timestamp(),
content_checksum, current_content_checksum)
assert request_type == CacheRequest.update
current_content_checksum = 'checksumtest1'
request_type, _ = dtmi.cache_request_route(is_cache_exist, cache_delay_expiration,
last_template_mod, test_current_template_mod, cache_del_exp, gen_at, get_current_unix_micro_timestamp(),
content_checksum, current_content_checksum)
assert request_type == CacheRequest.cached
gen_at = (last_template_mod - 500)
request_type, _ = dtmi.cache_request_route(is_cache_exist, cache_delay_expiration,
last_template_mod, test_current_template_mod, cache_del_exp, gen_at, get_current_unix_micro_timestamp(),
content_checksum, current_content_checksum)
assert request_type == CacheRequest.exp_update
is_cache_exist = false
request_type, _ = dtmi.cache_request_route(is_cache_exist, cache_delay_expiration,
last_template_mod, test_current_template_mod, cache_del_exp, gen_at, get_current_unix_micro_timestamp(),
content_checksum, current_content_checksum)
assert request_type == CacheRequest.new
}
fn test_cache_handler() {
mut dtmi := init_dtm(true, max_size_data_in_memory)!
defer {
dtmi.stop_cache_handler()
}
dtmi.create_cache()
path_f := os.join_path(dtmi.template_folder, dtm.temp_html_fp)
lock dtmi.template_caches {
assert dtmi.template_caches[0].id == 1
assert dtmi.template_caches[0].name == dtm.temp_html_n
assert dtmi.template_caches[0].path == path_f
}
dtmi.id_to_handlered = 1
dtmi.ch_cache_handler <- TemplateCache{
id: 1
cache_request: .delete
}
time.sleep(5 * time.millisecond)
lock dtmi.template_caches {
assert dtmi.template_caches.len == 0
}
}
fn testsuite_end() {
temp_folder := os.join_path(dtm.vtmp_dir, dtm.temp_dtm_dir)
os.rmdir_all(temp_folder) or {}
}
// Utilities function :
fn init_dtm(b bool, m int) !&DynamicTemplateManager {
temp_folder := os.join_path(dtm.vtmp_dir, dtm.temp_dtm_dir)
vcache_path := os.join_path(temp_folder, dtm.temp_cache_dir)
templates_path := os.join_path(temp_folder, dtm.temp_templates_dir)
mut dtm := create_dtm()
init_params := DynamicTemplateManagerInitialisationParams{
active_cache_server: b
max_size_data_in_mem: m
test_cache_dir: vcache_path
test_template_dir: templates_path
}
initialize_dtm(mut dtm, init_params)!
return dtm
}
fn (mut tm DynamicTemplateManager) create_cache() string {
temp_html_file := os.join_path(tm.template_folder, dtm.temp_html_fp)
html_last_mod := os.file_last_mod_unix(temp_html_file)
c_time := get_current_unix_micro_timestamp()
cache_delay_exp := i64(500) * i64(1000000)
placeholder := map[string]DtmMultiTypeMap{}
content_checksum := ''
html := tm.create_template_cache_and_display_html(.new, html_last_mod, c_time, temp_html_file,
dtm.temp_html_n, cache_delay_exp, &placeholder, content_checksum)
time.sleep(5 * time.millisecond)
return html
}

7
vlib/x/templating/dtm/escape_html_strings_in_templates.v Normal file
View file

@ -0,0 +1,7 @@
module dtm
import encoding.html
fn filter(s string) string {
return html.escape(s)
}