Slack Work

[Dhruv-Sharma01]

Added a csv of project slack channels of OWASP in project_channels.csv. Also created a new field "slack" in project model(models.py) and did changes in project_detail.html to view slack channel. fixes #3198

Summary by CodeRabbit

• New Features
  • Enhanced Slack integration for projects.
    • A new field in the project submission form lets you enter a Slack URL.
    • Project detail pages now display a clickable Slack icon linking to the project's channel.
    • Entered Slack URLs are validated to ensure they start with "http://" or "https://".

[yashpandey06]

Tests for these changes have been added ?

@Dhruv-Sharma01

[JisanAR03]

can you please review the project.py file cause u have pushed few unused code in that file

[Dhruv-Sharma01]

@yashpandey06 I am not sure about it.

[Dhruv-Sharma01]

can you please review the project.py file cause u have pushed few unused code in that file

Will do that.

[Dhruv-Sharma01]

Can you check this again please there seems to be some overlap with code

Sir, I have commited the changes in my PR please check once.

[Dhruv-Sharma01]

lets add slack_channel, slack_id, and slack_url

Done Sir, please check.

[DonnieBLT]

And please add them to the models and create an import management command

[Dhruv-Sharma01]

And please add them to the models and create an import management command

Sir, please let me know if anything else is needed.

[DonnieBLT]

Instead of a new model can you please put those fields on the project?

[Dhruv-Sharma01]

Instead of a new model can you please put those fields on the project?

Sir, please check now.

[DonnieBLT]

Nice work, approved. Please check to see it merged.

[DonnieBLT]

Thank you

[Dhruv-Sharma01]

Thank you sir, just please review once more I have resolved issues arising due to pre-commit.

[Dhruv-Sharma01]

Sir, pre-commit was passing locally, I guess it was because of version mismatch I have fixed that please review once more.

[Dhruv-Sharma01]

Sir, error in tests is also resolved please review once more.

[DonnieBLT]

can you please take out the myenv

[Dhruv-Sharma01]

Yes sir, it is removed. I pushed it by mistake.

[yashpandey06]

@Dhruv-Sharma01 also i see the branch is not updated ...would also suggest squashing the commits .

[DonnieBLT]

@coderabbitai please code the changes for this based on the comments

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Let's first find the models.py file with the Project model
fd --type f "models.py" | xargs grep -l "class Project"

Length of output: 73

---

🏁 Script executed:

#!/bin/bash
# First, let's look at the Project model definition
cat website/models.py | grep -A 30 "class Project"

# Let's see the project_detail.html file
fd --type f "project_detail.html" | xargs cat

# Let's check if the project_channels.csv file exists and its structure
fd --type f "project_channels.csv" | xargs cat

# Check for existing management commands
find . -type d -name "management"
find . -name "*.py" | grep -i import | grep management

Length of output: 35120

---

🏁 Script executed:

#!/bin/bash
# Let's check the existing import management command
cat ./website/management/commands/import_slack_channel.py

# Let's also look at project.py file that was mentioned in the comments
fd --type f "project.py" | xargs cat

# Let's check what files are changed in this PR
git diff --name-only HEAD

# Let's get more context on the changes made to models.py
git diff HEAD -- website/models.py

Length of output: 63361

---

🏁 Script executed:

#!/bin/bash
# Let's check for any unused imports or code in project.py
# First, let's check for some common imports that might be unused
grep "import " website/project.py | sort

# Let's see if there's a management command that imports from CSV
fd --type f -e py | grep -i "import.*csv" | xargs cat

Length of output: 150

---

🏁 Script executed:

#!/bin/bash
# Let's find the project.py file first
fd -t f "project.py"

# Let's examine the existing import_slack_channel.py command
cat ./website/management/commands/import_slack_channel.py

# Let's create a better version of the import command to read from CSV
cat > website/management/commands/import_slack_channels_csv.py << 'EOF'
import csv
import os
from django.core.management.base import BaseCommand
from website.models import Project

class Command(BaseCommand):
    help = "Import slack channels from CSV file and associate them with projects"

    def add_arguments(self, parser):
        parser.add_argument(
            "--csv_file",
            type=str,
            default="project_channels.csv",
            help="Path to the CSV file containing the slack channel data",
        )

    def handle(self, *args, **kwargs):
        csv_file_path = kwargs["csv_file"]
        
        self.stdout.write(f"Importing slack channels from CSV file: {csv_file_path}")
        
        if not os.path.exists(csv_file_path):
            self.stdout.write(self.style.ERROR(f"CSV file not found: {csv_file_path}"))
            return
        
        updated_count = 0
        created_count = 0
        
        with open(csv_file_path, "r") as file:
            reader = csv.DictReader(file)
            for row in reader:
                slack_channel = row.get("slack_channel", "").strip()
                slack_id = row.get("slack_id", "").strip()
                slack_url = row.get("slack_url", "").strip()
                
                if not slack_channel or not slack_channel.startswith("project-"):
                    continue
                
                project_name = slack_channel.replace("project-", "").replace("-", " ").title()
                
                # Try to find project by name
                project = Project.objects.filter(name__iexact=project_name).first()
                
                if project:
                    # Update existing project
                    updated = False
                    if project.slack_channel != slack_channel:
                        project.slack_channel = slack_channel
                        updated = True
                    
                    if project.slack_id != slack_id:
                        project.slack_id = slack_id
                        updated = True
                    
                    if project.slack != slack_url:
                        project.slack = slack_url
                        updated = True
                    
                    if updated:
                        project.save()
                        updated_count += 1
                        self.stdout.write(f"Updated project: {project_name}")
                else:
                    # Create a new project with basic info
                    project = Project.objects.create(
                        name=project_name,
                        description=f"OWASP {project_name} Project",
                        slack_channel=slack_channel,
                        slack_id=slack_id,
                        slack=slack_url,
                    )
                    created_count += 1
                    self.stdout.write(f"Created new project: {project_name}")
        
        self.stdout.write(
            self.style.SUCCESS(
                f"Successfully processed CSV. Updated {updated_count} projects, created {created_count} new projects."
            )
        )
EOF

# Check if there are any unused imports in the code
grep -n "import" website/management/commands/import_slack_channel.py

# Let's see if we can find any references to project.py
find . -name '*.py' -type f -exec grep -l "project\.py" {} \;

Length of output: 2639

---

@DonnieBLT Based on the PR comments, I've created the required changes:

1. I've created a new management command to import Slack data from the CSV file:

# website/management/commands/import_slack_channels_csv.py
import csv
import os
from django.core.management.base import BaseCommand
from website.models import Project

class Command(BaseCommand):
    help = "Import slack channels from CSV file and associate them with projects"

    def add_arguments(self, parser):
        parser.add_argument(
            "--csv_file",
            type=str,
            default="project_channels.csv",
            help="Path to the CSV file containing the slack channel data",
        )

    def handle(self, *args, **kwargs):
        csv_file_path = kwargs["csv_file"]
        
        self.stdout.write(f"Importing slack channels from CSV file: {csv_file_path}")
        
        if not os.path.exists(csv_file_path):
            self.stdout.write(self.style.ERROR(f"CSV file not found: {csv_file_path}"))
            return
        
        updated_count = 0
        created_count = 0
        
        with open(csv_file_path, "r") as file:
            reader = csv.DictReader(file)
            for row in reader:
                slack_channel = row.get("slack_channel", "").strip()
                slack_id = row.get("slack_id", "").strip()
                slack_url = row.get("slack_url", "").strip()
                
                if not slack_channel or not slack_channel.startswith("project-"):
                    continue
                
                project_name = slack_channel.replace("project-", "").replace("-", " ").title()
                
                # Try to find project by name
                project = Project.objects.filter(name__iexact=project_name).first()
                
                if project:
                    # Update existing project
                    updated = False
                    if project.slack_channel != slack_channel:
                        project.slack_channel = slack_channel
                        updated = True
                    
                    if project.slack_id != slack_id:
                        project.slack_id = slack_id
                        updated = True
                    
                    if project.slack != slack_url:
                        project.slack = slack_url
                        updated = True
                    
                    if updated:
                        project.save()
                        updated_count += 1
                        self.stdout.write(f"Updated project: {project_name}")
                else:
                    # Create a new project with basic info
                    project = Project.objects.create(
                        name=project_name,
                        description=f"OWASP {project_name} Project",
                        slack_channel=slack_channel,
                        slack_id=slack_id,
                        slack=slack_url,
                    )
                    created_count += 1
                    self.stdout.write(f"Created new project: {project_name}")
        
        self.stdout.write(
            self.style.SUCCESS(
                f"Successfully processed CSV. Updated {updated_count} projects, created {created_count} new projects."
            )
        )

2. I've confirmed the Project model already has the necessary fields (slack, slack_channel, slack_id) and project_detail.html already displays the Slack link.

3. For testing this functionality, we should add a test that verifies the command imports data correctly from the CSV file.

Would you like me to create a test file for the import command as well?

[A1L13N]

@coderabbitai please show the changes needed to make slack info into a new model joined to orgs and projects

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check the Project model definition
cat website/models.py | grep -A 50 "class Project"

# Look for Organization model if it exists
cat website/models.py | grep -A 50 "class Organization" || echo "Organization model not found"

# Check project_detail.html to see how slack info is currently displayed
fd --type f "project_detail.html" | xargs cat

# Look at import management command
cat website/management/commands/import_slack_channel.py || echo "Management command not found"

Length of output: 33930

---

@A1L13N Here's how to refactor the slack information into a new model that's joined to both projects and organizations:

1. Create a new SlackInfo model in models.py

class SlackInfo(models.Model):
    """Model to store Slack channel information for Projects and Organizations."""
    channel_name = models.CharField(max_length=255, blank=True, null=True)
    channel_id = models.CharField(max_length=255, unique=True, blank=True, null=True)
    url = models.URLField(null=True, blank=True)
    created = models.DateTimeField(auto_now_add=True)
    modified = models.DateTimeField(auto_now=True)

    def __str__(self):
        return self.channel_name or "Unnamed Slack Channel"

    class Meta:
        verbose_name = "Slack Information"
        verbose_name_plural = "Slack Information"

2. Update the Project model to use the new SlackInfo relationship

class Project(models.Model):
    STATUS_CHOICES = [
        ("flagship", "Flagship"),
        ("production", "Production"),
        ("incubator", "Incubator"),
        ("lab", "Lab"),
        ("inactive", "Inactive"),
    ]

    organization = models.ForeignKey(
        Organization,
        null=True,
        blank=True,
        related_name="projects",
        on_delete=models.CASCADE,
    )
    name = models.CharField(max_length=255)
    slug = models.SlugField(unique=True, blank=True)
    description = models.TextField()
    status = models.CharField(max_length=20, choices=STATUS_CHOICES, default="new")
    url = models.URLField(unique=True, null=True, blank=True)  # Made url nullable in case of no website
    project_visit_count = models.IntegerField(default=0)
    twitter = models.CharField(max_length=30, null=True, blank=True)
    # Remove these fields:
    # slack = models.URLField(null=True, blank=True)
    # slack_channel = models.CharField(max_length=255, blank=True, null=True)
    # slack_id = models.CharField(max_length=255, unique=True, blank=True, null=True)
    
    # Add this new field:
    slack_info = models.OneToOneField(SlackInfo, on_delete=models.SET_NULL, null=True, blank=True, related_name="project")
    
    facebook = models.URLField(null=True, blank=True)
    logo = models.ImageField(upload_to="project_logos", null=True, blank=True)
    created = models.DateTimeField(auto_now_add=True)  # Standardized field name
    modified = models.DateTimeField(auto_now=True)  # Standardized field name

    # Rest of the model remains unchanged

3. Update the Organization model to include SlackInfo

class Organization(models.Model):
    # Existing fields...
    
    # Add this new field:
    slack_info = models.OneToOneField(SlackInfo, on_delete=models.SET_NULL, null=True, blank=True, related_name="organization")
    
    # Rest of the model remains unchanged

4. Create a data migration to transfer existing slack data

# migrations/XXXX_migrate_slack_data.py
from django.db import migrations


def migrate_slack_data(apps, schema_editor):
    """
    Migrate slack data from Project model to the new SlackInfo model
    """
    Project = apps.get_model('website', 'Project')
    SlackInfo = apps.get_model('website', 'SlackInfo')
    
    for project in Project.objects.all():
        # Only create SlackInfo if at least one slack field has data
        if project.slack or project.slack_channel or project.slack_id:
            slack_info = SlackInfo.objects.create(
                channel_name=project.slack_channel,
                channel_id=project.slack_id,
                url=project.slack
            )
            project.slack_info = slack_info
            project.save()


def reverse_migrate(apps, schema_editor):
    """
    Reverse migration to restore slack data back to Project model
    """
    Project = apps.get_model('website', 'Project')
    SlackInfo = apps.get_model('website', 'SlackInfo')
    
    for project in Project.objects.filter(slack_info__isnull=False):
        project.slack = project.slack_info.url
        project.slack_channel = project.slack_info.channel_name
        project.slack_id = project.slack_info.channel_id
        project.save()


class Migration(migrations.Migration):
    dependencies = [
        ('website', 'XXXX_previous_migration'),  # Replace with the actual previous migration
    ]

    operations = [
        migrations.RunPython(migrate_slack_data, reverse_migrate),
    ]

5. Update the project_detail.html template to use the new relationship

{% if project.slack_info and project.slack_info.url %}
    <a href="{{ project.slack_info.url }}"
       target="_blank"
       rel="noopener noreferrer"
       class="inline-flex items-center px-4 py-2 bg-white/10 hover:bg-white/20 rounded-lg text-white transition">
        <svg class="w-5 h-5 mr-2" fill="currentColor" viewBox="0 0 24 24">
            <path d="M12 2C6.48 2 2 6.48 2 12c0 4.94 3.63 9.02 8.35 9.8V15.5H7.5v-3h2.85V10.7c0-2.82 1.68-4.38 4.25-4.38 1.23 0 2.55.22 2.55.22v2.82h-1.43c-1.41 0-1.85.87-1.85 1.77v2.13h3l-.3 3h-2.7v6.5C18.37 21.02 22 16.94 22 12c0-5.52-4.48-10-10-10z" />
        </svg>
        Slack
    </a>
{% endif %}

6. Update the management command to work with the new model structure

# website/management/commands/import_slack_channel.py
import requests
from django.conf import settings
from django.core.management.base import BaseCommand

from website.models import Project, SlackInfo

SLACK_TOKEN = settings.SLACK_TOKEN
SLACK_API_URL = "https://slack.com/api/conversations.list"
HEADERS = {"Authorization": f"Bearer {SLACK_TOKEN}"}


class Command(BaseCommand):
    help = "Fetch Slack channels and associate them with projects"

    def fetch_channels(self):
        url = SLACK_API_URL
        params = {"limit": 1000, "types": "public_channel"}  # Fetch only public channels
        channels = []

        while url:
            response = requests.get(url, headers=HEADERS, params=params)
            data = response.json()

            if not data.get("ok"):
                self.stdout.write(f"Error: {data.get('error')}")
                break

            channels.extend(data.get("channels", []))
            cursor = data.get("response_metadata", {}).get("next_cursor")
            if cursor:
                url = SLACK_API_URL + f"?cursor={cursor}"
            else:
                url = None

        return channels

    def handle(self, *args, **kwargs):
        self.stdout.write("Fetching Slack channels...")

        channels = self.fetch_channels()
        projects_updated = 0
        
        for channel in channels:
            if channel["name"].startswith("project-"):
                project_name = channel["name"].replace("project-", "").capitalize()
                slack_url = f"https://OWASP.slack.com/archives/{channel['id']}"

                # Find project by name
                project = Project.objects.filter(name__iexact=project_name).first()
                
                if project:
                    # Check if project already has SlackInfo
                    if project.slack_info:
                        # Update existing SlackInfo
                        slack_info = project.slack_info
                        slack_info.channel_name = channel["name"]
                        slack_info.channel_id = channel["id"]
                        slack_info.url = slack_url
                        slack_info.save()
                    else:
                        # Create new SlackInfo and associate with project
                        slack_info = SlackInfo.objects.create(
                            channel_name=channel["name"],
                            channel_id=channel["id"],
                            url=slack_url
                        )
                        project.slack_info = slack_info
                        project.save()
                    
                    projects_updated += 1
                    self.stdout.write(f"Updated Slack info for project: {project_name}")
                else:
                    self.stdout.write(f"No project found with name: {project_name}")

        self.stdout.write(f"Successfully updated Slack info for {projects_updated} projects.")

7. Create a new CSV import command

# website/management/commands/import_slack_channels_csv.py
import csv
import os
from django.core.management.base import BaseCommand
from website.models import Project, SlackInfo

class Command(BaseCommand):
    help = "Import slack channels from CSV file and associate them with projects"

    def add_arguments(self, parser):
        parser.add_argument(
            "--csv_file",
            type=str,
            default="project_channels.csv",
            help="Path to the CSV file containing the slack channel data",
        )

    def handle(self, *args, **kwargs):
        csv_file_path = kwargs["csv_file"]
        
        self.stdout.write(f"Importing slack channels from CSV file: {csv_file_path}")
        
        if not os.path.exists(csv_file_path):
            self.stdout.write(self.style.ERROR(f"CSV file not found: {csv_file_path}"))
            return
        
        updated_count = 0
        
        with open(csv_file_path, "r") as file:
            reader = csv.DictReader(file)
            for row in reader:
                slack_channel = row.get("slack_channel", "").strip()
                slack_id = row.get("slack_id", "").strip()
                slack_url = row.get("slack_url", "").strip()
                
                if not slack_channel or not slack_channel.startswith("project-"):
                    continue
                
                project_name = slack_channel.replace("project-", "").replace("-", " ").title()
                
                # Try to find project by name
                project = Project.objects.filter(name__iexact=project_name).first()
                
                if project:
                    # Create or update SlackInfo
                    if project.slack_info:
                        # Update existing SlackInfo
                        slack_info = project.slack_info
                        slack_info.channel_name = slack_channel
                        slack_info.channel_id = slack_id
                        slack_info.url = slack_url
                        slack_info.save()
                    else:
                        # Create new SlackInfo
                        slack_info = SlackInfo.objects.create(
                            channel_name=slack_channel,
                            channel_id=slack_id,
                            url=slack_url
                        )
                        project.slack_info = slack_info
                        project.save()
                    
                    updated_count += 1
                    self.stdout.write(f"Updated project: {project_name}")
                else:
                    self.stdout.write(self.style.WARNING(f"No project found with name: {project_name}"))
        
        self.stdout.write(
            self.style.SUCCESS(
                f"Successfully processed CSV. Updated {updated_count} projects."
            )
        )

This complete solution separates the slack information into a dedicated model and ensures proper relationships between projects, organizations, and slack data. It also includes necessary migration steps and updates to the management commands.

[DonnieBLT]

@Dhruv-Sharma01 can you please make those changes?

[DonnieBLT]

/giphy please try again

[github-actions[bot]]

[coderabbitai[bot]]

Walkthrough

This pull request introduces Slack integration support across the Django application. It adds new fields to the Project model, updates database migrations, and enhances templates and views to incorporate Slack URLs. A management command is provided to fetch public Slack channels via the Slack API and update associated projects. Additionally, the project creation view now validates any provided Slack URL before proceeding, ensuring better data integrity.

Changes

File(s)	Change Summary
website/management/commands/import_slack_channel.py	New management command to fetch Slack channels using the Slack API with pagination and update projects based on channels starting with "project-".
website/migrations/0181_alter_project_slack….py website/migrations/0189_merge_20250130_2249.py	Database migration files altering Project model fields: updating the slack field and adding slack_channel and slack_id, and merging migration dependencies.
website/models.py	Project model updated with three new fields: slack (URLField), slack_channel (CharField), and slack_id (unique CharField).
website/templates/projects/project_detail.html website/templates/projects/project_list.html	Templates updated to display a Slack link in the project detail view and add a Slack URL input field in the "Add New Project" modal.
website/views/project.py	In the project creation view, added validation for the Slack URL to ensure proper format and accessibility, and included the Slack URL in the new project's data.

Sequence Diagram(s)

sequenceDiagram
    participant Cmd as ImportSlackChannel Command
    participant API as Slack API
    participant DB as Database (Project Model)
    
    Cmd->>API: GET /conversations.list (with pagination cursor)
    API-->>Cmd: Returns JSON response (channels, next_cursor)
    loop Process each page
        Cmd->>Cmd: Iterate through channels
        alt Channel name starts with "project-"
            Cmd->>DB: Update/Create Project with Slack channel info
        end
    end
    Cmd->>Cmd: Log total channels processed

sequenceDiagram
    participant User as User
    participant View as create_project Function
    participant Validator as URL Validator (validate_url)
    participant DB as Database (Project Model)
    
    User->>View: POST request with project data (including Slack URL)
    View->>View: Check if Slack URL is provided and starts with http/https
    View->>Validator: Validate URL accessibility
    alt URL is valid
        Validator-->>View: Confirmation
        View->>DB: Create new Project with Slack URL
        View-->>User: Return success JSON response
    else URL is invalid
        Validator-->>View: Error response
        View-->>User: Return error JSON response ("Invalid Slack URL")
    end

Assessment against linked issues

Objective	Addressed	Explanation
Add new field slack_channel to projects (#3198)	✅
Create a CSV of all OWASP slack channels with an import script (#3198)	❌	CSV generation functionality is not implemented.

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

🪧 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.

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 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.