Feat/Refresh s3 links in projects and issues

ENV_SETUP.md

@@ -27,6 +27,8 @@ AWS_SECRET_ACCESS_KEY="secret-key"
 AWS_S3_ENDPOINT_URL="http://plane-minio:9000"
 # Changing this requires change in the nginx.conf for uploads if using minio setup
 AWS_S3_BUCKET_NAME="uploads"
+AWS_S3_BUCKET_AUTH=False
+AWS_QUERYSTRING_AUTH=False
 # Maximum file upload limit
 FILE_SIZE_LIMIT=5242880
 ​
@@ -94,6 +96,8 @@ AWS_SECRET_ACCESS_KEY="secret-key"
 AWS_S3_ENDPOINT_URL="http://plane-minio:9000"
 # Changing this requires change in the nginx.conf for uploads if using minio setup
 AWS_S3_BUCKET_NAME="uploads"
+AWS_S3_BUCKET_AUTH=False
+AWS_QUERYSTRING_AUTH=False
 # Maximum file upload limit
 FILE_SIZE_LIMIT=5242880
 ​

apiserver/.env.example

@@ -31,6 +31,8 @@ AWS_SECRET_ACCESS_KEY="secret-key"
 AWS_S3_ENDPOINT_URL="http://plane-minio:9000"
 # Changing this requires change in the nginx.conf for uploads if using minio setup
 AWS_S3_BUCKET_NAME="uploads"
+AWS_S3_BUCKET_AUTH=False
+AWS_QUERYSTRING_AUTH=False
 # Maximum file upload limit
 FILE_SIZE_LIMIT=5242880
 

apiserver/plane/api/serializers/issue.py

@@ -21,12 +21,14 @@
     IssueActivity,
     ProjectMember,
 )
+
 from .base import BaseSerializer
 from .cycle import CycleSerializer, CycleLiteSerializer
 from .module import ModuleSerializer, ModuleLiteSerializer
 from .user import UserLiteSerializer
 from .state import StateLiteSerializer
 
+
 class IssueSerializer(BaseSerializer):
     assignees = serializers.ListField(
         child=serializers.PrimaryKeyRelatedField(
@@ -67,13 +69,13 @@ def validate(self, data):
             and data.get("start_date", None) > data.get("target_date", None)
         ):
             raise serializers.ValidationError("Start date cannot exceed target date")
-        
+
         try:
-            if(data.get("description_html", None) is not None):
+            if data.get("description_html", None) is not None:
                 parsed = html.fromstring(data["description_html"])
-                parsed_str = html.tostring(parsed, encoding='unicode')
+                parsed_str = html.tostring(parsed, encoding="unicode")
                 data["description_html"] = parsed_str
-            
+
         except Exception as e:
             raise serializers.ValidationError(f"Invalid HTML: {str(e)}")
 
@@ -324,11 +326,11 @@ class Meta:
 
     def validate(self, data):
         try:
-            if(data.get("comment_html", None) is not None):
+            if data.get("comment_html", None) is not None:
                 parsed = html.fromstring(data["comment_html"])
-                parsed_str = html.tostring(parsed, encoding='unicode')
+                parsed_str = html.tostring(parsed, encoding="unicode")
                 data["comment_html"] = parsed_str
-            
+
         except Exception as e:
             raise serializers.ValidationError(f"Invalid HTML: {str(e)}")
         return data
@@ -362,7 +364,6 @@ class Meta:
 
 
 class LabelLiteSerializer(BaseSerializer):
-
     class Meta:
         model = Label
         fields = [

apiserver/plane/api/serializers/project.py

@@ -2,12 +2,11 @@
 from rest_framework import serializers
 
 # Module imports
-from plane.db.models import Project, ProjectIdentifier, WorkspaceMember, State, Estimate
+from plane.db.models import Project, ProjectIdentifier, WorkspaceMember
 from .base import BaseSerializer
 
 
 class ProjectSerializer(BaseSerializer):
-
     total_members = serializers.IntegerField(read_only=True)
     total_cycles = serializers.IntegerField(read_only=True)
     total_modules = serializers.IntegerField(read_only=True)
@@ -21,7 +20,7 @@ class Meta:
         fields = "__all__"
         read_only_fields = [
             "id",
-            'emoji',
+            "emoji",
             "workspace",
             "created_at",
             "updated_at",
@@ -89,4 +88,4 @@ class Meta:
             "emoji",
             "description",
         ]
-        read_only_fields = fields
+        read_only_fields = fields

apiserver/plane/app/serializers/issue.py

@@ -1,5 +1,6 @@
 # Django imports
 from django.utils import timezone
+from django.conf import settings
 
 # Third Party imports
 from rest_framework import serializers
@@ -31,9 +32,23 @@
     IssueVote,
     IssueRelation,
 )
+from plane.utils.parse_html import parse_text_to_html, refresh_url_content
 
 
-class IssueFlatSerializer(BaseSerializer):
+class BaseIssueSerializerMixin:
+    """abstract class for refresh s3 link in description htlm images"""
+
+    def refresh_html_content(self, instance, html, html_field_name="description_html"):
+        if settings.AWS_S3_BUCKET_AUTH:
+            html = parse_text_to_html(html)
+            refreshed, html = refresh_url_content(html)
+
+            if refreshed:
+                setattr(instance, html_field_name, html)
+                instance.save()
+
+
+class IssueFlatSerializer(BaseSerializer, BaseIssueSerializerMixin):
     ## Contain only flat fields
 
     class Meta:
@@ -51,6 +66,10 @@ class Meta:
             "is_draft",
         ]
 
+    def to_representation(self, instance):
+        self.refresh_html_content(instance, instance.description_html)
+        return super().to_representation(instance)
+
 
 class IssueProjectLiteSerializer(BaseSerializer):
     project_detail = ProjectLiteSerializer(source="project", read_only=True)
@@ -100,8 +119,8 @@ class Meta:
 
     def to_representation(self, instance):
         data = super().to_representation(instance)
-        data['assignees'] = [str(assignee.id) for assignee in instance.assignees.all()]
-        data['labels'] = [str(label.id) for label in instance.labels.all()]
+        data["assignees"] = [str(assignee.id) for assignee in instance.assignees.all()]
+        data["labels"] = [str(label.id) for label in instance.labels.all()]
         return data
 
     def validate(self, data):
@@ -232,7 +251,6 @@ class Meta:
         fields = "__all__"
 
 
-
 class IssuePropertySerializer(BaseSerializer):
     class Meta:
         model = IssueProperty
@@ -268,7 +286,6 @@ class Meta:
 
 
 class IssueLabelSerializer(BaseSerializer):
-
     class Meta:
         model = IssueLabel
         fields = "__all__"
@@ -283,30 +300,19 @@ class IssueRelationSerializer(BaseSerializer):
 
     class Meta:
         model = IssueRelation
-        fields = [
-            "issue_detail",
-            "relation_type",
-            "related_issue",
-            "issue",
-            "id"
-        ]
+        fields = ["issue_detail", "relation_type", "related_issue", "issue", "id"]
         read_only_fields = [
             "workspace",
             "project",
         ]
 
+
 class RelatedIssueSerializer(BaseSerializer):
     issue_detail = IssueProjectLiteSerializer(read_only=True, source="issue")
 
     class Meta:
         model = IssueRelation
-        fields = [
-            "issue_detail",
-            "relation_type",
-            "related_issue",
-            "issue",
-            "id"
-        ]
+        fields = ["issue_detail", "relation_type", "related_issue", "issue", "id"]
         read_only_fields = [
             "workspace",
             "project",
@@ -424,9 +430,8 @@ class Meta:
 
 
 class IssueReactionSerializer(BaseSerializer):
-
     actor_detail = UserLiteSerializer(read_only=True, source="actor")
-    
+
     class Meta:
         model = IssueReaction
         fields = "__all__"
@@ -459,7 +464,6 @@ class Meta:
 
 
 class IssueVoteSerializer(BaseSerializer):
-
     actor_detail = UserLiteSerializer(read_only=True, source="actor")
 
     class Meta:
@@ -468,7 +472,7 @@ class Meta:
         read_only_fields = fields
 
 
-class IssueCommentSerializer(BaseSerializer):
+class IssueCommentSerializer(BaseSerializer, BaseIssueSerializerMixin):
     actor_detail = UserLiteSerializer(read_only=True, source="actor")
     issue_detail = IssueFlatSerializer(read_only=True, source="issue")
     project_detail = ProjectLiteSerializer(read_only=True, source="project")
@@ -489,6 +493,10 @@ class Meta:
             "updated_at",
         ]
 
+    def to_representation(self, instance):
+        self.refresh_html_content(instance, instance.comment_html, "comment_html")
+        return super().to_representation(instance)
+
 
 class IssueStateFlatSerializer(BaseSerializer):
     state_detail = StateLiteSerializer(read_only=True, source="state")
@@ -506,7 +514,7 @@ class Meta:
 
 
 # Issue Serializer with state details
-class IssueStateSerializer(DynamicBaseSerializer):
+class IssueStateSerializer(DynamicBaseSerializer, BaseIssueSerializerMixin):
     label_details = LabelLiteSerializer(read_only=True, source="labels", many=True)
     state_detail = StateLiteSerializer(read_only=True, source="state")
     project_detail = ProjectLiteSerializer(read_only=True, source="project")
@@ -520,15 +528,23 @@ class Meta:
         model = Issue
         fields = "__all__"
 
+    def to_representation(self, instance):
+        self.refresh_html_content(instance, instance.description_html)
+        return super().to_representation(instance)
+
 
-class IssueSerializer(BaseSerializer):
+class IssueSerializer(BaseSerializer, BaseIssueSerializerMixin):
     project_detail = ProjectLiteSerializer(read_only=True, source="project")
     state_detail = StateSerializer(read_only=True, source="state")
     parent_detail = IssueStateFlatSerializer(read_only=True, source="parent")
     label_details = LabelSerializer(read_only=True, source="labels", many=True)
     assignee_details = UserLiteSerializer(read_only=True, source="assignees", many=True)
-    related_issues = IssueRelationSerializer(read_only=True, source="issue_relation", many=True)
-    issue_relations = RelatedIssueSerializer(read_only=True, source="issue_related", many=True)
+    related_issues = IssueRelationSerializer(
+        read_only=True, source="issue_relation", many=True
+    )
+    issue_relations = RelatedIssueSerializer(
+        read_only=True, source="issue_related", many=True
+    )
     issue_cycle = IssueCycleDetailSerializer(read_only=True)
     issue_module = IssueModuleDetailSerializer(read_only=True)
     issue_link = IssueLinkSerializer(read_only=True, many=True)
@@ -548,8 +564,12 @@ class Meta:
             "updated_at",
         ]
 
+    def to_representation(self, instance):
+        self.refresh_html_content(instance, instance.description_html)
+        return super().to_representation(instance)
+
 
-class IssueLiteSerializer(DynamicBaseSerializer):
+class IssueLiteSerializer(DynamicBaseSerializer, BaseIssueSerializerMixin):
     workspace_detail = WorkspaceLiteSerializer(read_only=True, source="workspace")
     project_detail = ProjectLiteSerializer(read_only=True, source="project")
     state_detail = StateLiteSerializer(read_only=True, source="state")
@@ -577,11 +597,17 @@ class Meta:
             "updated_at",
         ]
 
+    def to_representation(self, instance):
+        self.refresh_html_content(instance, instance.description_html)
+        return super().to_representation(instance)
 
-class IssuePublicSerializer(BaseSerializer):
+
+class IssuePublicSerializer(BaseSerializer, BaseIssueSerializerMixin):
     project_detail = ProjectLiteSerializer(read_only=True, source="project")
     state_detail = StateLiteSerializer(read_only=True, source="state")
-    reactions = IssueReactionSerializer(read_only=True, many=True, source="issue_reactions")
+    reactions = IssueReactionSerializer(
+        read_only=True, many=True, source="issue_reactions"
+    )
     votes = IssueVoteSerializer(read_only=True, many=True)
 
     class Meta:
@@ -603,6 +629,9 @@ class Meta:
         ]
         read_only_fields = fields
 
+    def to_representation(self, instance):
+        self.refresh_html_content(instance, instance.description_html)
+        return super().to_representation(instance)
 
 
 class IssueSubscriberSerializer(BaseSerializer):