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

root: Improve debugging experience #12961

Merged
merged 3 commits into from
Feb 14, 2025
Merged

Conversation

sirux88
Copy link
Contributor

@sirux88 sirux88 commented Feb 8, 2025

Details

This PR is ment to improve the debugging experiance:

  1. It sets the vscode debugging python configurations to use relative paths instead of absolute paths. This reverts the last commit of lifecycle: much improved debugging experience #12804
  2. Since usage of docker-compose.override.yml is necessary due to website/docs: updated debugging docs #12809 it adds docker-compose.override.yml to gitignore to remove noice when comitting

Further thoughts:

  1. Remove Debug: Attach Worker configuration since it only duplicates Debug: Attach Server Core in its curretns state. Renaming Debug: Attach Server Core would be useful for clarification then
  2. If debugging worker and server should be able at the same time it would be necessary distinguish between both when setting up the debugging ports on startup or via port forwarding in docker-compose.override.yml.
    Both needs to be documented somewhere
  3. The dev-server containers don't include the dev-dependencies. They need to be installed in runtime but the container needs root rights to do that. Might be ok for developing but the dependencies could be included aswell by making changes to Dockerfile (Sidemark: Image size will increase ~30%)

Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@sirux88 sirux88 requested review from a team as code owners February 8, 2025 15:11
Copy link

netlify bot commented Feb 8, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 4e66b19
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67afd5f6188dd40008f4fdca
😎 Deploy Preview https://deploy-preview-12961--authentik-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

netlify bot commented Feb 8, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 4e66b19
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67afd5f68232860008392621
😎 Deploy Preview https://deploy-preview-12961--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

codecov bot commented Feb 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.69%. Comparing base (daebeb1) to head (4e66b19).
Report is 82 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12961      +/-   ##
==========================================
- Coverage   92.75%   92.69%   -0.07%     
==========================================
  Files         785      785              
  Lines       39580    39623      +43     
==========================================
+ Hits        36714    36728      +14     
- Misses       2866     2895      +29     
Flag Coverage Δ
e2e 48.39% <ø> (-0.17%) ⬇️
integration 24.54% <ø> (-0.01%) ⬇️
unit 90.43% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sirux88
Copy link
Contributor Author

sirux88 commented Feb 8, 2025

@BeryJu:
As mentioned in #12804 I reviewed what you stated there. I could not reproduce your issue. After properly setting up everything (pulling dev-server container, creating docker-compose.override.yml, creating .env file and spinning up docker compose) I could debug the python part of the application.

For testing purpose I added some minor python changes. After that the breaking points around the changes didn't get hit anymore (which makes sense since the changes aren't visible in the container itself).
I could resolve this by adding:

volumes:
  - ./authentik:/authentik

to docker-compose.override.yml

Maybe you could reevaluate your problem with this PR/comment

@sirux88 sirux88 changed the title Improve debugging experiance Improve debugging experience Feb 8, 2025
@BeryJu BeryJu changed the title Improve debugging experience root: Improve debugging experience Feb 14, 2025
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu BeryJu merged commit de20897 into goauthentik:main Feb 14, 2025
60 of 62 checks passed
@sirux88 sirux88 deleted the improve-debugging branch February 15, 2025 18:40
kensternberg-authentik added a commit that referenced this pull request Feb 20, 2025
* main: (24 commits)
  core: add additional RBAC permission to restrict setting the superuser status on groups (#12900)
  web: bump API Client version (#13089)
  core: bump github.com/spf13/cobra from 1.8.1 to 1.9.1 (#13085)
  stages/authenticator_email: Email OTP (#12630)
  website: bump dompurify and mermaid in /website (#13077)
  web: bump dompurify and mermaid in /web (#13078)
  core: bump django-filter from 24.3 to 25.1 (#13086)
  enterprise/audit: fix diff being created when not enabled (#13084)
  core, web: update translations (#13088)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#13080)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#13081)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#13082)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#13083)
  core: bump django-storages from 1.14.4 to 1.14.5 (#13087)
  web/user: fix redirects back to user settings (#13076)
  ci: parallelize unit tests (#13036)
  core, web: update translations (#13072)
  stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs (#13073)
  root: Improve debugging experience (#12961)
  core, web: update translations (#13071)
  ...
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.

2 participants