Skip to content

Commit 783a486

Browse files
committed
[IMP] add evaluation for request.env
- add evaluation for odoo.http.request: - up to 15.2: WebRequest class - since 15.3: Request class - add env variable to Request class (15.3+ only, as it is a property before that) - add evaluation to (Request/WebRequest).env: Environment | None This allows us for better tooling in controllers, which use odoo.http.request extensively.
1 parent c8c6edf commit 783a486

File tree

6 files changed

+256
-4
lines changed

6 files changed

+256
-4
lines changed

server/src/core/python_arch_builder_hooks.rs

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,27 @@ static arch_class_hooks: Lazy<Vec<PythonArchClassHook>> = Lazy::new(|| {vec![
3838
let mut range = symbol.borrow().range().clone();
3939
let slots = symbol.borrow().get_symbol(&(vec![], vec![Sy!("__slots__")]), u32::MAX);
4040
if slots.len() == 1 {
41-
if slots.len() == 1 {
42-
range = slots[0].borrow().range().clone();
43-
}
41+
range = slots[0].borrow().range().clone();
4442
}
4543
symbol.borrow_mut().add_new_variable(session, Sy!("env"), &range);
4644
}
4745
}
4846
},
47+
PythonArchClassHook {
48+
odoo_entry: true,
49+
trees: vec![
50+
(Sy!("15.3"), Sy!("999.0"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("Request")]))
51+
],
52+
func: |session: &mut SessionInfo, _entry_point: &Rc<RefCell<EntryPoint>>, request_class: Rc<RefCell<Symbol>>| {
53+
// ----------- Request.env ------------
54+
let has_env = !request_class.borrow().get_content_symbol(&Sy!("env"), u32::MAX).symbols.is_empty();
55+
if has_env {
56+
return;
57+
}
58+
let range = request_class.borrow().range().clone();
59+
request_class.borrow_mut().add_new_variable(session, Sy!("env"), &range);
60+
}
61+
},
4962
PythonArchClassHook {
5063
odoo_entry: true,
5164
trees: vec![

server/src/core/python_arch_eval_hooks.rs

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,54 @@ static arch_eval_file_hooks: Lazy<Vec<PythonArchEvalFileHook>> = Lazy::new(|| {v
6565
env.set_doc_string(Some(S!("")));
6666
}
6767
}},
68+
PythonArchEvalFileHook {odoo_entry: true,
69+
trees: vec![(Sy!("0.0"), Sy!("15.3"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("request")]))],
70+
if_exist_only: true,
71+
func: |_odoo: &mut SessionInfo, _entry: &Rc<RefCell<EntryPoint>>, file_symbol: Rc<RefCell<Symbol>>, symbol: Rc<RefCell<Symbol>>| {
72+
// --------- request: WebRequest (before 15.3) ---------
73+
let web_request_class = file_symbol.borrow().get_symbol(&(vec![], vec![Sy!("WebRequest")]), u32::MAX);
74+
let Some(web_request_class) = web_request_class.last() else {
75+
return;
76+
};
77+
let mut request = symbol.borrow_mut();
78+
request.set_evaluations(vec![Evaluation::eval_from_symbol(&Rc::downgrade(web_request_class), Some(true))]);
79+
}},
80+
PythonArchEvalFileHook {odoo_entry: true,
81+
trees: vec![(Sy!("15.3"), Sy!("999.0"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("request")]))],
82+
if_exist_only: true,
83+
func: |_odoo: &mut SessionInfo, _entry: &Rc<RefCell<EntryPoint>>, file_symbol: Rc<RefCell<Symbol>>, symbol: Rc<RefCell<Symbol>>| {
84+
// --------- request: Request (15.3+) ---------
85+
let request_class = file_symbol.borrow().get_symbol(&(vec![], vec![Sy!("Request")]), u32::MAX);
86+
let Some(request_class) = request_class.last() else {
87+
return;
88+
};
89+
let mut request = symbol.borrow_mut();
90+
request.set_evaluations(vec![Evaluation::eval_from_symbol(&Rc::downgrade(request_class), Some(true))]);
91+
}},
92+
PythonArchEvalFileHook {odoo_entry: true,
93+
trees: vec![
94+
(Sy!("0"), Sy!("15.3"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("WebRequest"), Sy!("env")])),
95+
(Sy!("15.3"), Sy!("999.0"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("Request"), Sy!("env")]))
96+
],
97+
if_exist_only: true,
98+
func: |odoo: &mut SessionInfo, _entry: &Rc<RefCell<EntryPoint>>, file_symbol: Rc<RefCell<Symbol>>, symbol: Rc<RefCell<Symbol>>| {
99+
// --------- (Web)Request.env: Environment | None ---------
100+
let env_file = odoo.sync_odoo.get_symbol(odoo.sync_odoo.config.odoo_path.as_ref().unwrap(), &(vec![Sy!("odoo"), Sy!("api")], vec![]), u32::MAX);
101+
let Some(env_file) = env_file.last() else {
102+
return;
103+
};
104+
let env_class = env_file.borrow().get_symbol(&(vec![], vec![Sy!("Environment")]), u32::MAX);
105+
let Some(env_class) = env_class.last() else {
106+
return;
107+
};
108+
// env is a property (function) before 15.3, and an instance variable in 15.3.
109+
// In both cases the evaluation is Environment | None.
110+
symbol.borrow_mut().set_evaluations(vec![
111+
Evaluation::eval_from_symbol(&Rc::downgrade(env_class), Some(true)),
112+
Evaluation::new_none()
113+
]);
114+
file_symbol.borrow_mut().add_dependency(&mut env_file.borrow_mut(), BuildSteps::ARCH_EVAL, BuildSteps::ARCH);
115+
}},
68116
PythonArchEvalFileHook {odoo_entry: true,
69117
trees: vec![(Sy!("0.0"), Sy!("18.1"), (vec![Sy!("odoo"), Sy!("models")], vec![Sy!("BaseModel"), Sy!("ids")])),
70118
(Sy!("18.1"), Sy!("999.0"), (vec![Sy!("odoo"), Sy!("orm"), Sy!("models")], vec![Sy!("BaseModel"), Sy!("ids")]))],
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
from . import models
2-
from . import data
2+
from . import data
3+
from . import controllers
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# -*- coding: utf-8 -*-
2+
from . import main
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# -*- coding: utf-8 -*-
2+
from odoo import http
3+
from odoo.http import request
4+
5+
6+
class TestController(http.Controller):
7+
8+
@http.route('/test/request', type='http', auth='public')
9+
def test_request_type(self):
10+
"""Test that request has correct type."""
11+
# Hovering over 'request' should show Request class
12+
req = request
13+
14+
# Hovering over 'request.env' should show Environment | None
15+
env = request.env
16+
17+
# Accessing models via request.env
18+
if request.env:
19+
partner = request.env['res.partner']
20+
users = request.env['res.users']
21+
22+
return "OK"
23+
24+
@http.route('/test/request/search', type='http', auth='user')
25+
def test_request_env_usage(self):
26+
"""Test using request.env in typical scenarios."""
27+
# Direct model access
28+
partners = request.env['res.partner'].search([])
29+
30+
# With sudo
31+
admin_partners = request.env['res.partner'].sudo().search([])
32+
33+
# Accessing user
34+
current_user = request.env.user
35+
36+
return "OK"

server/tests/test_controller.rs

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
use std::env;
2+
use std::path::PathBuf;
3+
use std::cell::RefCell;
4+
use std::rc::Rc;
5+
6+
use odoo_ls_server::core::odoo::SyncOdoo;
7+
use odoo_ls_server::core::symbols::symbol::Symbol;
8+
use odoo_ls_server::core::file_mgr::FileInfo;
9+
use odoo_ls_server::utils::PathSanitizer;
10+
use odoo_ls_server::threads::SessionInfo;
11+
12+
mod setup;
13+
mod test_utils;
14+
15+
/// Test that odoo.http.request and request.env hooks work correctly.
16+
/// Tests hover and definition.
17+
#[test]
18+
fn test_controller() {
19+
let (mut odoo, config) = setup::setup::setup_server(true);
20+
let mut session = setup::setup::create_init_session(&mut odoo, config);
21+
22+
// This test only applies to Odoo 15.3+. Skip otherwise.
23+
if session.sync_odoo.version_major < 15 || (session.sync_odoo.version_major == 15 && session.sync_odoo.version_minor < 3) {
24+
return;
25+
}
26+
27+
let test_file = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
28+
.join("tests/data/addons/module_1/controllers/main.py")
29+
.sanitize();
30+
31+
let Some(file_symbol) = SyncOdoo::get_symbol_of_opened_file(&mut session, &PathBuf::from(&test_file)) else {
32+
panic!("Failed to get file symbol for {}", test_file);
33+
};
34+
35+
let file_mgr = session.sync_odoo.get_file_mgr();
36+
let file_info = file_mgr.borrow().get_file_info(&test_file).unwrap();
37+
38+
test_request_type_hover(&mut session, &file_symbol, &file_info);
39+
test_request_env_definition(&mut session, &file_symbol, &file_info);
40+
test_request_env_subscript(&mut session, &file_symbol, &file_info);
41+
}
42+
43+
/// Test that hovering over 'request' shows Request class
44+
/// and that hovering over 'request.env' shows Environment type
45+
fn test_request_type_hover(
46+
session: &mut SessionInfo,
47+
file_symbol: &Rc<RefCell<Symbol>>,
48+
file_info: &Rc<RefCell<FileInfo>>
49+
) {
50+
// Test 1: Hover over 'request' variable (line 11: req = request)
51+
// Should show Request class
52+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 11, 14)
53+
.expect("Should get hover text for request");
54+
55+
assert!(
56+
hover_text.contains("Request"),
57+
"Hover over 'request' should show Request class. Got: {}",
58+
hover_text
59+
);
60+
61+
// Test 2: Hover over 'request.env' (line 14: env = request.env)
62+
// Should show Environment | None
63+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 14, 21)
64+
.expect("Should get hover text for request.env");
65+
66+
assert!(
67+
hover_text.contains("Environment"),
68+
"Hover over 'request.env' should show Environment type. Got: {}",
69+
hover_text
70+
);
71+
assert!(
72+
hover_text.contains("None"),
73+
"Hover over 'request.env' should show None. Got: {}",
74+
hover_text
75+
);
76+
}
77+
78+
/// Test that request.env provides correct definitions
79+
fn test_request_env_definition(
80+
session: &mut SessionInfo,
81+
file_symbol: &Rc<RefCell<Symbol>>,
82+
file_info: &Rc<RefCell<FileInfo>>
83+
) {
84+
// Test 1: Go-to-definition on 'request' import (line 3: from odoo.http import request)
85+
// Should navigate to request variable in odoo.http
86+
let definitions = test_utils::get_definition_locs(session, file_symbol, file_info, 2, 22);
87+
88+
assert!(
89+
!definitions.is_empty(),
90+
"Should find definition for 'request' import"
91+
);
92+
93+
// Verify it points to odoo/http.py or similar
94+
let target_uri = &definitions[0].target_uri.to_string();
95+
assert!(
96+
target_uri.contains("odoo/http.py"),
97+
"Definition should point to http module. Got: {:?}",
98+
target_uri
99+
);
100+
101+
// Test 2: Go-to-definition on 'request.env' (line 15: env = request.env)
102+
// Should navigate to Environment class or env attribute
103+
let definitions = test_utils::get_definition_locs(session, file_symbol, file_info, 14, 21);
104+
105+
assert!(
106+
!definitions.is_empty(),
107+
"Should find definition for 'request.env'"
108+
);
109+
110+
// Test 3: Hover on request.env.user (line 34: current_user = request.env.user)
111+
// Should show proper type for user
112+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 33, 35)
113+
.expect("Should get hover text for 'user'");
114+
115+
// env.user should have a type (typically res.users or User)
116+
assert!(
117+
!hover_text.is_empty(),
118+
"request.env.user should have hover information"
119+
);
120+
}
121+
122+
/// Test that request.env["model_name"] resolves to Model instance
123+
fn test_request_env_subscript(
124+
session: &mut SessionInfo,
125+
file_symbol: &Rc<RefCell<Symbol>>,
126+
file_info: &Rc<RefCell<FileInfo>>
127+
) {
128+
let partner_class = test_utils::PARTNER_CLASS_NAME(&session.sync_odoo.full_version);
129+
130+
// Test 1: Hover over 'partner' variable (line 19: partner = request.env['res.partner'])
131+
// Should show Partner/ResPartner class
132+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 18, 12)
133+
.expect("Should get hover text for 'partner' variable");
134+
135+
assert!(
136+
hover_text.contains(partner_class),
137+
"Hover over 'partner' should show {} class. Got: {}",
138+
partner_class,
139+
hover_text
140+
);
141+
142+
// Test 2: Hover over .search on request.env['res.partner'].search (line 29)
143+
// Should display markdown content for the search method
144+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 27, 46)
145+
.expect("Should get hover text for .search method");
146+
147+
assert!(
148+
hover_text.contains("def search"),
149+
"Hover over .search should have markdown content and mention 'search'. Got: {}",
150+
hover_text
151+
);
152+
}

0 commit comments

Comments
 (0)