π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
[WEB-4088] fix: issue exports when cycles are not present (#7057)
Nikhil534f5c7dd0c3
diff --git a/apiserver/plane/bgtasks/export_task.py b/apiserver/plane/bgtasks/export_task.pyindex 061167122e..78210db64c 100644--- a/apiserver/plane/bgtasks/export_task.py+++ b/apiserver/plane/bgtasks/export_task.py@@ -3,10 +3,11 @@ import csvimport ioimport jsonimport zipfile-+from typing import Listimport boto3from botocore.client import Config-+from uuid import UUID+from datetime import datetime, date# Third party importsfrom celery import shared_task@@ -20,21 +21,30 @@ from django.db.models import F, Prefetchfrom collections import defaultdict# Module imports-from plane.db.models import ExporterHistory, Issue, FileAsset, Label, User+from plane.db.models import ExporterHistory, Issue, FileAsset, Label, User, IssueCommentfrom plane.utils.exception_logger import log_exception-def dateTimeConverter(time):+def dateTimeConverter(time: datetime) -> str | None:+ """+ Convert a datetime object to a formatted string.+ """if time:return time.strftime("%a, %d %b %Y %I:%M:%S %Z%z")-def dateConverter(time):+def dateConverter(time: date) -> str | None:+ """+ Convert a date object to a formatted string.+ """if time:return time.strftime("%a, %d %b %Y")-def create_csv_file(data):+def create_csv_file(data: List[List[str]]) -> str:+ """+ Create a CSV file from the provided data.+ """csv_buffer = io.StringIO()csv_writer = csv.writer(csv_buffer, delimiter=",", quoting=csv.QUOTE_ALL)@@ -45,11 +55,17 @@ def create_csv_file(data):return csv_buffer.getvalue()-def create_json_file(data):+def create_json_file(data: List[dict]) -> str:+ """+ Create a JSON file from the provided data.+ """return json.dumps(data)-def create_xlsx_file(data):+def create_xlsx_file(data: List[List[str]]) -> bytes:+ """+ Create an XLSX file from the provided data.+ """workbook = Workbook()sheet = workbook.active@@ -62,7 +78,10 @@ def create_xlsx_file(data):return xlsx_buffer.getvalue()-def create_zip_file(files):+def create_zip_file(files: List[tuple[str, str | bytes]]) -> io.BytesIO:+ """+ Create a ZIP file from the provided files.+ """zip_buffer = io.BytesIO()with zipfile.ZipFile(zip_buffer, "w", zipfile.ZIP_DEFLATED) as zipf:for filename, file_content in files:@@ -71,8 +90,11 @@ def create_zip_file(files):zip_buffer.seek(0)return zip_buffer--def upload_to_s3(zip_file, workspace_id, token_id, slug):+# TODO: Change the upload_to_s3 function to use the new storage method with entry in file asset table+def upload_to_s3(zip_file: io.BytesIO, workspace_id: UUID, token_id: str, slug: str) -> None:+ """+ Upload a ZIP file to S3 and generate a presigned URL.+ """file_name = (f"{workspace_id}/export-{slug}-{token_id[:6]}-{str(timezone.now().date())}.zip")@@ -154,7 +176,10 @@ def upload_to_s3(zip_file, workspace_id, token_id, slug):exporter_instance.save(update_fields=["status", "url", "key"])-def generate_table_row(issue):+def generate_table_row(issue: dict) -> List[str]:+ """+ Generate a table row from an issue dictionary.+ """return [f"""{issue["project_identifier"]}-{issue["sequence_id"]}""",issue["project_name"],@@ -166,22 +191,24 @@ def generate_table_row(issue):issue["priority"],issue["created_by"],", ".join(issue["labels"]) if issue["labels"] else "",- issue.get("cycle_name", ""),- issue.get("cycle_start_date", ""),- issue.get("cycle_end_date", ""),+ issue["cycle_name"],+ issue["cycle_start_date"],+ issue["cycle_end_date"],", ".join(issue.get("module_name", "")) if issue.get("module_name") else "",dateTimeConverter(issue["created_at"]),dateTimeConverter(issue["updated_at"]),dateTimeConverter(issue["completed_at"]),dateTimeConverter(issue["archived_at"]),- ", ".join(- [- f"{comment['comment']} ({comment['created_at']} by {comment['created_by']})"- for comment in issue["comments"]- ]- )- if issue["comments"]- else "",+ (+ ", ".join(+ [+ f"{comment['comment']} ({comment['created_at']} by {comment['created_by']})"+ for comment in issue["comments"]+ ]+ )+ if issue["comments"]+ else ""+ ),issue["estimate"] if issue["estimate"] else "",", ".join(issue["link"]) if issue["link"] else "",", ".join(issue["assignees"]) if issue["assignees"] else "",@@ -191,7 +218,10 @@ def generate_table_row(issue):]-def generate_json_row(issue):+def generate_json_row(issue: dict) -> dict:+ """+ Generate a JSON row from an issue dictionary.+ """return {"ID": f"""{issue["project_identifier"]}-{issue["sequence_id"]}""","Project": issue["project_name"],@@ -221,7 +251,10 @@ def generate_json_row(issue):}-def update_json_row(rows, row):+def update_json_row(rows: List[dict], row: dict) -> None:+ """+ Update the json row with the new assignee and label.+ """matched_index = next((index@@ -250,7 +283,10 @@ def update_json_row(rows, row):rows.append(row)-def update_table_row(rows, row):+def update_table_row(rows: List[List[str]], row: List[str]) -> None:+ """+ Update the table row with the new assignee and label.+ """matched_index = next((index for index, existing_row in enumerate(rows) if existing_row[0] == row[0]),None,@@ -272,20 +308,22 @@ def update_table_row(rows, row):rows.append(row)-def generate_csv(header, project_id, issues, files):+def generate_csv(header: List[str], project_id: str, issues: List[dict], files: List[tuple[str, str | bytes]]) -> None:"""Generate CSV export for all the passed issues."""rows = [header]for issue in issues:row = generate_table_row(issue)-update_table_row(rows, row)csv_file = create_csv_file(rows)files.append((f"{project_id}.csv", csv_file))-def generate_json(header, project_id, issues, files):+def generate_json(header: List[str], project_id: str, issues: List[dict], files: List[tuple[str, str | bytes]]) -> None:+ """+ Generate JSON export for all the passed issues.+ """rows = []for issue in issues:row = generate_json_row(issue)@@ -294,7 +332,10 @@ def generate_json(header, project_id, issues, files):files.append((f"{project_id}.json", json_file))-def generate_xlsx(header, project_id, issues, files):+def generate_xlsx(header: List[str], project_id: str, issues: List[dict], files: List[tuple[str, str | bytes]]) -> None:+ """+ Generate XLSX export for all the passed issues.+ """rows = [header]for issue in issues:row = generate_table_row(issue)@@ -304,13 +345,29 @@ def generate_xlsx(header, project_id, issues, files):files.append((f"{project_id}.xlsx", xlsx_file))+def get_created_by(obj: Issue | IssueComment) -> str:+ """+ Get the created by user for the given object.+ """+ if obj.created_by:+ return f"{obj.created_by.first_name} {obj.created_by.last_name}"+ return ""++@shared_task-def issue_export_task(provider, workspace_id, project_ids, token_id, multiple, slug):+def issue_export_task(provider: str, workspace_id: UUID, project_ids: List[str], token_id: str, multiple: bool, slug: str):+ """+ Export issues from the workspace.+ provider (str): The provider to export the issues to csv | json | xlsx.+ token_id (str): The export object token id.+ multiple (bool): Whether to export the issues to multiple files per project.+ """try:exporter_instance = ExporterHistory.objects.get(token=token_id)exporter_instance.status = "processing"exporter_instance.save(update_fields=["status"])+ # Base query to get the issuesworkspace_issues = (Issue.objects.filter(workspace__id=workspace_id,@@ -348,16 +405,21 @@ def issue_export_task(provider, workspace_id, project_ids, token_id, multiple, s))+ # Get the attachments for the issuesfile_assets = FileAsset.objects.filter(- issue_id__in=workspace_issues.values_list("id", flat=True)+ issue_id__in=workspace_issues.values_list("id", flat=True),+ entity_type=FileAsset.EntityTypeContext.ISSUE_ATTACHMENT).annotate(work_item_id=F("issue_id"), asset_id=F("id"))+ # Create a dictionary to store the attachments for the issuesattachment_dict = defaultdict(list)for asset in file_assets:attachment_dict[asset.work_item_id].append(asset.asset_id)+ # Create a list to store the issues dataissues_data = []+ # Iterate over the issuesfor issue in workspace_issues:attachments = attachment_dict.get(issue.id, [])@@ -380,18 +442,18 @@ def issue_export_task(provider, workspace_id, project_ids, token_id, multiple, s"module_name": [module.module.name for module in issue.issue_module.all()],- "created_by": f"{issue.created_by.first_name} {issue.created_by.last_name}",+ "created_by": get_created_by(issue),"labels": [label.name for label in issue.label_details],"comments": [{"comment": comment.comment_stripped,"created_at": dateConverter(comment.created_at),- "created_by": f"{comment.created_by.first_name} {comment.created_by.last_name}",+ "created_by": get_created_by(comment),}for comment in issue.issue_comments.all()],"estimate": issue.estimate_point.estimate.name- if issue.estimate_point+ if issue.estimate_point and issue.estimate_point.estimateelse "","link": [link.url for link in issue.issue_link.all()],"assignees": [@@ -406,14 +468,17 @@ def issue_export_task(provider, workspace_id, project_ids, token_id, multiple, s],}- # Get prefetched cycles and modules- cycles = list(issue.issue_cycle.all())-- # Update cycle data- for cycle in cycles:+ # Get Cycles data for the issue+ cycle = issue.issue_cycle.last()+ if cycle:+ # Update cycle dataissue_data["cycle_name"] = cycle.cycle.nameissue_data["cycle_start_date"] = dateConverter(cycle.cycle.start_date)issue_data["cycle_end_date"] = dateConverter(cycle.cycle.end_date)+ else:+ issue_data["cycle_name"] = ""+ issue_data["cycle_start_date"] = ""+ issue_data["cycle_end_date"] = ""issues_data.append(issue_data)@@ -446,6 +511,7 @@ def issue_export_task(provider, workspace_id, project_ids, token_id, multiple, s"Attachment Links",]+ # Map the provider to the functionEXPORTER_MAPPER = {"csv": generate_csv,"json": generate_json,