Skip to content

fix nested loading behavior #1237

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 2, 2025
Merged

fix nested loading behavior #1237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
07b0a45
fix nested loading behavior
jdkent Dec 2, 2025
1ebe755
update openapi
jdkent Dec 2, 2025
db4a59e
test new behavior
jdkent Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion store/backend/neurostore/openapi
Open in desktop
Submodule openapi updated 1 files
+2 −0 neurostore-openapi.yml
47 changes: 46 additions & 1 deletion store/backend/neurostore/resources/data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1056,6 +1056,7 @@ class BaseStudiesView(ObjectView, ListView):
"y": fields.Float(required=False, allow_none=True),
"z": fields.Float(required=False, allow_none=True),
"radius": fields.Float(required=False, allow_none=True),
**LIST_NESTED_ARGS,
}

_multi_search = ("name", "description")
Expand Down Expand Up @@ -1148,7 +1149,51 @@ def eager_load(self, q, args=None):
)

# Handle version and user loading
if args.get("info"):
if args.get("nested"):
q = q.options(
selectinload(BaseStudy.versions).options(
selectinload(Study.user)
.load_only(User.name, User.external_id)
.options(raiseload("*", sql_only=True)),
selectinload(Study.tables)
.load_only(Table.id)
.options(raiseload("*", sql_only=True)),
selectinload(Study.analyses).options(
raiseload("*", sql_only=True),
selectinload(Analysis.user)
.load_only(User.name, User.external_id)
.options(raiseload("*", sql_only=True)),
selectinload(Analysis.images).options(
raiseload("*", sql_only=True),
selectinload(Image.user)
.load_only(User.name, User.external_id)
.options(raiseload("*", sql_only=True)),
),
selectinload(Analysis.points).options(
raiseload("*", sql_only=True),
selectinload(Point.user)
.load_only(User.name, User.external_id)
.options(raiseload("*", sql_only=True)),
selectinload(Point.values).options(
raiseload("*", sql_only=True)
),
),
selectinload(Analysis.analysis_conditions).options(
raiseload("*", sql_only=True),
selectinload(AnalysisConditions.condition).options(
raiseload("*", sql_only=True),
selectinload(Condition.user)
.load_only(User.name, User.external_id)
.options(raiseload("*", sql_only=True)),
),
),
),
),
joinedload(BaseStudy.user)
.load_only(User.name, User.external_id)
.options(raiseload("*", sql_only=True)),
)
elif args.get("info"):
q = q.options(
joinedload(BaseStudy.versions).options(
raiseload("*", sql_only=True),
Expand Down
18 changes: 18 additions & 0 deletions store/backend/neurostore/tests/api/test_base_studies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,24 @@ def test_info_base_study(auth_client, ingest_neurosynth, session):
assert isinstance(single_reg_resp.json()["versions"][0], str)


def test_nested_base_study(auth_client, ingest_neurosynth, session):
resp = auth_client.get("/api/base-studies/?nested=true")
assert resp.status_code == 200

first_result = resp.json()["results"][0]
first_version = first_result["versions"][0]

assert isinstance(first_version, dict)
assert "username" in first_version
assert "user" in first_version

if first_version.get("analyses"):
first_analysis = first_version["analyses"][0]
assert isinstance(first_analysis, dict)
assert "username" in first_analysis
assert "user" in first_analysis


def test_has_coordinates_images(auth_client, session):
# create an empty study
doi_a = "abcd"
Expand Down
Loading