[WEB-4008] fix: handle when settings are None

[aheckmann]

Description

space_base_path = getattr(settings, "SPACE_BASE_PATH", "/spaces/") could still return None when configuration sets it to None. This caused an error to be thrown on the following line if not space_base_path.startswith("/").

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• Feature (non-breaking change which adds functionality)
• Improvement (change that would cause existing functionality to not work as expected)
• Code refactoring
• Performance improvements
• Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

https://app.plane.so/plane/browse/WEB-4008/

Summary by CodeRabbit

• Bug Fixes
  • Improved validation of admin and space base path settings to ensure correct handling and normalization, preventing potential errors from invalid configuration types.

[coderabbitai]

Walkthrough

The changes update the retrieval of ADMIN_BASE_PATH and SPACE_BASE_PATH from settings in two utility modules. Instead of using a string as the default, the code now uses None and then validates the type, assigning the original string default if the value is not a string. The path normalization logic is unchanged.

Changes

File(s)	Change Summary
apiserver/plane/authentication/utils/host.py	Updated retrieval of base paths from settings to use None as default, added string type validation.
apiserver/plane/utils/host.py	Same update as above: changed default to None and added type check for base path settings.

Poem

In the warren of code, a path must be right,
Now checked for its type, in the soft server light.
No more stringy surprises, just slashes in place—
The rabbits ensure every path has its space.
Hop, hop, hooray, for settings made clear!
🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42e2b78 and c958f41.

📒 Files selected for processing (2)

• apiserver/plane/authentication/utils/host.py (2 hunks)
• apiserver/plane/utils/host.py (2 hunks)

🔇 Additional comments (4)

apiserver/plane/authentication/utils/host.py (2)

24-26: Good fix for handling explicit None values

The change properly addresses the bug where ADMIN_BASE_PATH could be explicitly set to None in settings. By retrieving the value with None as the default and then checking its type, the code ensures type safety before performing string operations.

---

39-41: Good fix for handling explicit None values

Similar to the admin path fix, this change correctly handles the case when SPACE_BASE_PATH is explicitly set to None in settings, preventing potential errors when string operations are performed on the path.

apiserver/plane/utils/host.py (2)

28-30: Good fix for handling explicit None values

This change properly addresses the bug mentioned in the PR description, where ADMIN_BASE_PATH could be explicitly set to None. The type checking ensures that string operations will not fail.

---

43-45: Good fix for handling explicit None values

This change correctly implements the fix for the bug mentioned in the PR description, where SPACE_BASE_PATH could be set to None. The code now properly validates the type before performing string operations.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[makeplane]

Pull Request Linked with Plane Work Items

• [WEB-4008] 'NoneType' object has no attribute 'startswith'

Comment Automatically Generated by Plane