feat: custom property context methods#44
Open
sunder-ch wants to merge 1 commit into
Open
Conversation
📝 WalkthroughWalkthroughThis PR introduces workspace-level work item property contexts as a new API sub-resource. Four context models are defined (response and request shapes), a new ChangesWorkspace Work Item Property Contexts Feature
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tests/unit/test_workspace_work_item_property_contexts.py (1)
63-114: 🏗️ Heavy liftMethod name/docstring don't match behavior;
contexts.create/contexts.deleteremain untested.This test creates a property, updates the default context, and in teardown deletes the property. It never calls
client.workspace_work_item_properties.contexts.create(...)orcontexts.delete(...), so the two new CRUD endpoints introduced in this PR have no coverage. Either rename to reflect what it does (create-property / update-default-context) or extend it to actually create and delete a non-default context as the docstring claims.Want me to draft a test that creates a non-default context (with project + work-item-type IDs) and deletes it via
contexts.delete?🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/unit/test_workspace_work_item_property_contexts.py` around lines 63 - 114, The test currently only creates a property and updates the default context but never exercises the new contexts.create and contexts.delete endpoints; either rename the test to reflect it only updates the default context or extend it to create and delete a non-default context: call client.workspace_work_item_properties.contexts.create(workspace_slug, prop.id, CreateWorkItemPropertyContext(...)) supplying explicit project and work item type IDs (so applies_to_all_* are false), assert the returned context fields, then retrieve it via contexts.retrieve, update if needed, and finally call client.workspace_work_item_properties.contexts.delete(workspace_slug, prop.id, created_ctx.id) and assert deletion (or that list no longer contains it); update the test docstring to match the new behavior if you choose to extend rather than rename.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@tests/scripts/test_estimates_methods.py`:
- Line 24: The test currently performs a no-op os.getenv("PLANE_ACCESS_TOKEN")
and always initializes the client with only api_key, breaking the "API key or
access token" path; change the setup in tests/scripts/test_estimates_methods.py
to read and use the access token: assign access_token =
os.getenv("PLANE_ACCESS_TOKEN") (or similar), then initialize the client with
the access token when present (e.g., pass access_token or choose between api_key
and access_token) so the test covers the access-token auth path instead of
ignoring the env value.
---
Nitpick comments:
In `@tests/unit/test_workspace_work_item_property_contexts.py`:
- Around line 63-114: The test currently only creates a property and updates the
default context but never exercises the new contexts.create and contexts.delete
endpoints; either rename the test to reflect it only updates the default context
or extend it to create and delete a non-default context: call
client.workspace_work_item_properties.contexts.create(workspace_slug, prop.id,
CreateWorkItemPropertyContext(...)) supplying explicit project and work item
type IDs (so applies_to_all_* are false), assert the returned context fields,
then retrieve it via contexts.retrieve, update if needed, and finally call
client.workspace_work_item_properties.contexts.delete(workspace_slug, prop.id,
created_ctx.id) and assert deletion (or that list no longer contains it); update
the test docstring to match the new behavior if you choose to extend rather than
rename.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a9a02852-47c0-4777-86bc-2aa1be2337de
📒 Files selected for processing (19)
README.mdplane/__init__.pyplane/api/milestones.pyplane/api/work_items/base.pyplane/api/workspace_work_item_properties/base.pyplane/api/workspace_work_item_properties/contexts.pyplane/models/__init__.pyplane/models/milestones.pyplane/models/work_item_property_configurations.pyplane/models/work_item_property_context.pyplane/models/workspaces.pypyproject.tomltests/scripts/test_archive.pytests/scripts/test_cycles.pytests/scripts/test_estimates_methods.pytests/scripts/test_milestones.pytests/scripts/test_work_item_types_and_properties.pytests/unit/test_work_item_properties.pytests/unit/test_workspace_work_item_property_contexts.py
💤 Files with no reviewable changes (3)
- plane/api/milestones.py
- plane/models/work_item_property_configurations.py
- plane/api/work_items/base.py
| base_url = os.getenv("PLANE_BASE_URL") | ||
| api_key = os.getenv("PLANE_API_KEY") | ||
| access_token = os.getenv("PLANE_ACCESS_TOKEN") | ||
| os.getenv("PLANE_ACCESS_TOKEN") |
There was a problem hiding this comment.
Restore access-token auth path in test setup.
Line 24 is now a no-op env read, and the client still initializes with only api_key. This breaks the documented “API key or access token” flow for this script.
Proposed fix
- os.getenv("PLANE_ACCESS_TOKEN")
+ access_token = os.getenv("PLANE_ACCESS_TOKEN")
@@
- client = PlaneClient(base_url=base_url, api_key=api_key)
+ client = PlaneClient(base_url=base_url, api_key=api_key, access_token=access_token)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@tests/scripts/test_estimates_methods.py` at line 24, The test currently
performs a no-op os.getenv("PLANE_ACCESS_TOKEN") and always initializes the
client with only api_key, breaking the "API key or access token" path; change
the setup in tests/scripts/test_estimates_methods.py to read and use the access
token: assign access_token = os.getenv("PLANE_ACCESS_TOKEN") (or similar), then
initialize the client with the access token when present (e.g., pass
access_token or choose between api_key and access_token) so the test covers the
access-token auth path instead of ignoring the env value.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR implements workspace-level work item property contexts in the Plane Python SDK. This allows managing property visibility, requirement status, and default values across specific projects and work item types at the workspace level.
Key Changes
🚀 Workspace Work Item Property Contexts
workspace_work_item_propertiesendpoint namespace (accessible viaclient.workspace_work_item_properties.contexts).list(workspace_slug, property_id)create(workspace_slug, property_id, data)retrieve(workspace_slug, property_id, context_id)update(workspace_slug, property_id, context_id, data)delete(workspace_slug, property_id, context_id)CreateWorkItemPropertyContext, andUpdateWorkItemPropertyContextvalidation models.Additionally, this PR fixes several pre-commit lint issues (Ruff, line lengths, duplicate methods, and variable shadowing).
Test Plan
1. Automated Integration & Unit Tests
Run the newly created unit/integration test suite:
test_list_contexts_for_workspace_property: Verifies retrieving all contexts for a workspace property, checking that default contexts exist.test_retrieve_context_for_workspace_property: Asserts specific property contexts can be retrieved by ID.test_create_update_delete_context: Validates the full CRUD lifecycle on custom property contexts.test_context_response_shape: Ensures the fields ofWorkItemPropertyContextcorrectly parse all expected types (e.g. lists of projects, type IDs, options).Summary by CodeRabbit
New Features
Documentation
Chores