[Integration][Clickup] Add clickup integration #768
Conversation
| endDate: .due_date | tonumber / 1000 | todate | ||
| totalIssues: .task_count | ||
| relations: | ||
| team: .__team_id |
There was a problem hiding this comment.
too specific, should have added an option to see all the team object, this will allow extensibility in the future
| properties: | ||
| url: .url | ||
| status: .status.status | ||
| assignee: .assignees | map(.email) | first |
There was a problem hiding this comment.
why not all assignees? having all the list will allow seeing the distribution and spread work inside port between the different assignees, while only setting the first, might be misleading as it can be ordered alphabetically
There was a problem hiding this comment.
It is a pre-defined blueprint and was advised to not modify. I can adjust it to take in all assignees
integrations/clickup/CHANGELOG.md
Outdated
|
|
||
| ### Features | ||
|
|
||
| - Added Jira integration with support for projects and issues (0.1.0) |
There was a problem hiding this comment.
this is a clickup integration not Jira integration
integrations/clickup/main.py
Outdated
| event: str = data.get("event", "") | ||
| logger.info(f"Received clickup webhook event: {event}") | ||
|
|
||
| if event.startswith("list"): | ||
| logger.info(f"Received webhook project event: {data['list_id']}") | ||
| project = await client.get_single_project(data["list_id"]) | ||
|
|
||
| if event.endswith("Deleted"): |
There was a problem hiding this comment.
when starting resolving patterns from strings, its worth to leave some comments, examples and reference to how that kind of thing is expected to be received, it can help to onboard developers to the code and make it more readable
| # because the port-app-config uses the team ID to relate the projects to the teams | ||
| # we add the team ID to each project | ||
| # also, the clickup returns the datetime as a timestamp, so we convert it to a | ||
| # datetime object |
There was a problem hiding this comment.
we thrive to write a generic code, as although we do have in thought how the mapping will be used, we should be aware that users can change it to their needs and therefor make it generic and as extensible as we can.
e.g. instead of returning only the team_id, return the full team object.
also no need to mention the datetime and the transformation if you are not doing anything with it here
| project = next( | ||
| ( | ||
| project | ||
| for project in await self.get_projects() | ||
| if project["id"] == project_id | ||
| ), | ||
| None, | ||
| ) |
There was a problem hiding this comment.
as although it is nice it re-uses the same code as in the resync method, it is quite an not efficient way to resolve and get the project, as it is very costly to get list all the teams and then all the spaces and then all the projects just to get a single project.
There was a problem hiding this comment.
Yes, that's true. I'll think of a different approach
| async def create_webhook_events(self, app_host: str) -> None: | ||
| for team in await self.get_teams(): | ||
| await self._create_team_webhook_events(app_host, team["id"]) | ||
|
|
||
| async def _create_team_webhook_events(self, app_host: str, team_id: int) -> None: | ||
| webhook_target_app_host = f"{app_host}/integration/webhook" | ||
| webhooks_response = await self.client.get( | ||
| f"{self.clickup_url}/team/{team_id}/webhook" | ||
| ) | ||
| webhooks_response.raise_for_status() | ||
| webhooks = webhooks_response.json() | ||
|
|
||
| existing_webhook = next( | ||
| ( | ||
| webhook | ||
| for webhook in webhooks["webhooks"] | ||
| if webhook["endpoint"] == webhook_target_app_host | ||
| ), | ||
| None, | ||
| ) | ||
|
|
There was a problem hiding this comment.
this whole logic, should be outside of the client, and the client should only expost get and create methods
There was a problem hiding this comment.
the resolution logic shouldn't be inside the client
| await ocean.register_raw(ObjectKind.PROJECT, [project]) | ||
| elif event.startswith("task"): | ||
| logger.info(f"Received webhook task event: {data['task_id']}") | ||
| issue = await client.get_single_issue(data["task_id"]) |
There was a problem hiding this comment.
what will get returned if its deleted event?
There was a problem hiding this comment.
I wonder if we even have what to return
There was a problem hiding this comment.
Couldn't find a way to solve this. The webhook only returns the task ID, and digging into the unregister_raw method, it seems to expect the entire object so it can calculate differences.
Would it be okay to call Port's API from within an integration directly? I'm halfway into this but I realized users will need to generate an API token from the dashboard, and I think they shouldn't have to do that
There was a problem hiding this comment.
For now, I've removed the blocks that check for deleted issues and projects
Description
What - This PR adds an integration for Clickup
Why - This will allow users to connect their workspaces from Clickup to Port
How - This was integrated using the Ocean framework. Documentation on usage is available here
Type of change
Please leave one option from the following and delete the rest:
Screenshots
API Documentation