Skip to content

Commit 74a91a3

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 113c3a0 commit 74a91a3

File tree

6 files changed

+225
-4
lines changed

6 files changed

+225
-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
@@ -64,6 +64,54 @@ static arch_eval_file_hooks: Lazy<Vec<PythonArchEvalFileHook>> = Lazy::new(|| {v
6464
env.set_doc_string(Some(S!("")));
6565
}
6666
}},
67+
PythonArchEvalFileHook {odoo_entry: true,
68+
trees: vec![(Sy!("0.0"), Sy!("15.3"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("request")]))],
69+
if_exist_only: true,
70+
func: |_odoo: &mut SessionInfo, _entry: &Rc<RefCell<EntryPoint>>, file_symbol: Rc<RefCell<Symbol>>, symbol: Rc<RefCell<Symbol>>| {
71+
// --------- request: WebRequest (before 15.3) ---------
72+
let web_request_class = file_symbol.borrow().get_symbol(&(vec![], vec![Sy!("WebRequest")]), u32::MAX);
73+
let Some(web_request_class) = web_request_class.last() else {
74+
return;
75+
};
76+
let mut request = symbol.borrow_mut();
77+
request.set_evaluations(vec![Evaluation::eval_from_symbol(&Rc::downgrade(web_request_class), Some(true))]);
78+
}},
79+
PythonArchEvalFileHook {odoo_entry: true,
80+
trees: vec![(Sy!("15.3"), Sy!("999.0"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("request")]))],
81+
if_exist_only: true,
82+
func: |_odoo: &mut SessionInfo, _entry: &Rc<RefCell<EntryPoint>>, file_symbol: Rc<RefCell<Symbol>>, symbol: Rc<RefCell<Symbol>>| {
83+
// --------- request: Request (15.3+) ---------
84+
let request_class = file_symbol.borrow().get_symbol(&(vec![], vec![Sy!("Request")]), u32::MAX);
85+
let Some(request_class) = request_class.last() else {
86+
return;
87+
};
88+
let mut request = symbol.borrow_mut();
89+
request.set_evaluations(vec![Evaluation::eval_from_symbol(&Rc::downgrade(request_class), Some(true))]);
90+
}},
91+
PythonArchEvalFileHook {odoo_entry: true,
92+
trees: vec![
93+
(Sy!("0"), Sy!("15.3"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("WebRequest"), Sy!("env")])),
94+
(Sy!("15.3"), Sy!("999.0"), (vec![Sy!("odoo"), Sy!("http")], vec![Sy!("Request"), Sy!("env")]))
95+
],
96+
if_exist_only: true,
97+
func: |odoo: &mut SessionInfo, _entry: &Rc<RefCell<EntryPoint>>, file_symbol: Rc<RefCell<Symbol>>, symbol: Rc<RefCell<Symbol>>| {
98+
// --------- (Web)Request.env: Environment | None ---------
99+
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);
100+
let Some(env_file) = env_file.last() else {
101+
return;
102+
};
103+
let env_class = env_file.borrow().get_symbol(&(vec![], vec![Sy!("Environment")]), u32::MAX);
104+
let Some(env_class) = env_class.last() else {
105+
return;
106+
};
107+
// env is a property (function) before 15.3, and an instance variable in 15.3.
108+
// In both cases the evaluation is Environment | None.
109+
symbol.borrow_mut().set_evaluations(vec![
110+
Evaluation::eval_from_symbol(&Rc::downgrade(env_class), Some(true)),
111+
Evaluation::new_none()
112+
]);
113+
file_symbol.borrow_mut().add_dependency(&mut env_file.borrow_mut(), BuildSteps::ARCH_EVAL, BuildSteps::ARCH);
114+
}},
67115
PythonArchEvalFileHook {odoo_entry: true,
68116
trees: vec![(Sy!("0.0"), Sy!("18.1"), (vec![Sy!("odoo"), Sy!("models")], vec![Sy!("BaseModel"), Sy!("ids")])),
69117
(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: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
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+
}
41+
42+
/// Test that hovering over 'request' shows Request class
43+
/// and that hovering over 'request.env' shows Environment type
44+
fn test_request_type_hover(
45+
session: &mut SessionInfo,
46+
file_symbol: &Rc<RefCell<Symbol>>,
47+
file_info: &Rc<RefCell<FileInfo>>
48+
) {
49+
// Test 1: Hover over 'request' variable (line 11: req = request)
50+
// Should show Request class
51+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 11, 14)
52+
.expect("Should get hover text for request");
53+
54+
assert!(
55+
hover_text.contains("Request"),
56+
"Hover over 'request' should show Request class. Got: {}",
57+
hover_text
58+
);
59+
60+
// Test 2: Hover over 'request.env' (line 14: env = request.env)
61+
// Should show Environment | None
62+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 14, 21)
63+
.expect("Should get hover text for request.env");
64+
65+
assert!(
66+
hover_text.contains("Environment"),
67+
"Hover over 'request.env' should show Environment type. Got: {}",
68+
hover_text
69+
);
70+
assert!(
71+
hover_text.contains("None"),
72+
"Hover over 'request.env' should show None. Got: {}",
73+
hover_text
74+
);
75+
}
76+
77+
/// Test that request.env provides correct definitions
78+
fn test_request_env_definition(
79+
session: &mut SessionInfo,
80+
file_symbol: &Rc<RefCell<Symbol>>,
81+
file_info: &Rc<RefCell<FileInfo>>
82+
) {
83+
// Test 1: Go-to-definition on 'request' import (line 3: from odoo.http import request)
84+
// Should navigate to request variable in odoo.http
85+
let definitions = test_utils::get_definition_locs(session, file_symbol, file_info, 2, 22);
86+
87+
assert!(
88+
!definitions.is_empty(),
89+
"Should find definition for 'request' import"
90+
);
91+
92+
// Verify it points to odoo/http.py or similar
93+
let target_uri = &definitions[0].target_uri.to_string();
94+
assert!(
95+
target_uri.contains("odoo/http.py"),
96+
"Definition should point to http module. Got: {:?}",
97+
target_uri
98+
);
99+
100+
// Test 2: Go-to-definition on 'request.env' (line 15: env = request.env)
101+
// Should navigate to Environment class or env attribute
102+
let definitions = test_utils::get_definition_locs(session, file_symbol, file_info, 14, 21);
103+
104+
assert!(
105+
!definitions.is_empty(),
106+
"Should find definition for 'request.env'"
107+
);
108+
109+
// Test 3: Hover on request.env.user (line 34: current_user = request.env.user)
110+
// Should show proper type for user
111+
let hover_text = test_utils::get_hover_markdown(session, file_symbol, file_info, 33, 35)
112+
.expect("Should get hover text for 'user'");
113+
114+
// env.user should have a type (typically res.users or User)
115+
assert!(
116+
!hover_text.is_empty(),
117+
"request.env.user should have hover information"
118+
);
119+
}
120+
121+

0 commit comments

Comments
 (0)