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

bug-bash: Change phase to directive in custom logic doc #8001

Merged
merged 3 commits into from
Oct 7, 2024

Conversation

Guaris
Copy link
Contributor

@Guaris Guaris commented Oct 2, 2024

Fixes #7533

@Guaris Guaris added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Oct 2, 2024
@Guaris Guaris requested a review from a team as a code owner October 2, 2024 19:14
Copy link

netlify bot commented Oct 2, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit c96c2db
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/6704631f318fc50008153f9e
😎 Deploy Preview https://deploy-preview-8001--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 92 (🟢 up 1 from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

This is missing the second part of the issue as well, which is:

An other issue concerns the "reponse" function, for which the phase is "access". However, according to the description, it replaces "header_filter()" and "body_filter()". As shown in the diagram in the Directives section, they are part of "Content Phase", not "Access Phase". This seems to be a mistake.

Edit: After doing more digging, I found that the response function runs in the Kong response phase, as a whole separate thing: https://github.com/Kong/kong/blob/master/spec/fixtures/custom_plugins/kong/plugins/enable-buffering-response/handler.lua. The links to the directives are correct though (header_filter and body_filter).

See all the Kong phases here: https://github.com/Kong/kong/blob/master/kong/pdk/private/phases.lua

Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

tl;dr for the changes I made to this PR:

  • marked ws phases as enterprise only
  • added a directives column and renamed the original phases column to "Kong phases", which are not the same thing as the nginx phases
  • checked each function against its real phase in Kong; the only one that actually differs from its function name is the configuration function

@lena-larionova lena-larionova merged commit 4de0c34 into main Oct 7, 2024
15 checks passed
@lena-larionova lena-larionova deleted the issue-7533 branch October 7, 2024 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing terms and concepts: "directives" and "phases"
2 participants