Skip to content
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.

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

fix show_excluded_items in @navigation api #1816

Merged
merged 8 commits into from
Sep 21, 2024
Merged

Conversation

mamico
Copy link
Member

@mamico mamico commented Sep 19, 2024

The show_ecluded_items setting does not work for the @navigation API due to an incorrect condition.


📚 Documentation preview 📚: https://plonerestapi--1816.org.readthedocs.build/

@mister-roboto

This comment was marked as resolved.

@mamico
Copy link
Member Author

mamico commented Sep 19, 2024

In Plone 5.2 test is broken with and without the fix.
I can't figure out if it's the wrong test or what else

@mamico
Copy link
Member Author

mamico commented Sep 19, 2024

@jenkins-plone-org please run jobs

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of typos and a question for the failing test.

src/plone/restapi/tests/test_services_navigation.py Outdated Show resolved Hide resolved
news/1816.bugfix Outdated Show resolved Hide resolved
response = self.api_session.get(
"/folder/@navigation", params={"expand.navigation.depth": 2}
)
self.assertNotIn(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is settings.show_excluded_items==True at this point? That could explain the test failure.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mamico I noticed that there are differences between the the Python 3.8/Plone 5.2 and all other runs. There are two extra lines, excluding any deprecation warnings, between the test setup and test results: https://github.com/plone/plone.restapi/actions/runs/10954244520/job/30415848888?pr=1816#step:10:216

*** Relations rebuild. flush: False
*** Relations rebuild. flush: True

Perhaps that is a clue?

Also do we care about Plone 5.2/Python 3.8 for this bugfix? I don't think it is a security issue, but a maintenance fix, and Plone 5.2 is out of maintenance support.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevepiercy probably your first suggestion is the right one. It seems that Plone 5.2 and Plone 6.0 have different defaults for show_ecluded_items (?). Now I explicitly set it in the test. I am waiting for the results of the CI...

mamico and others added 3 commits September 20, 2024 08:19
Co-authored-by: Steve Piercy <[email protected]>
Co-authored-by: Steve Piercy <[email protected]>
@mamico
Copy link
Member Author

mamico commented Sep 20, 2024

@jenkins-plone-org please run jobs

@mamico mamico requested a review from stevepiercy September 20, 2024 11:03
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, I actually guessed right! Yay, team!

We should have one more core developer review before merging.

@stevepiercy stevepiercy linked an issue Sep 20, 2024 that may be closed by this pull request
Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@davisagli davisagli merged commit 913f49b into main Sep 21, 2024
21 of 25 checks passed
@davisagli davisagli deleted the show_excluded_items branch September 21, 2024 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add html_meta tags to docs
4 participants