Merge pull request #3535 from makeplane/preview

release: 0.15-dev

.deepsource.toml

@@ -0,0 +1,23 @@
+version = 1
+
+exclude_patterns = [  
+  "bin/**",  
+  "**/node_modules/",  
+  "**/*.min.js"  
+]
+
+[[analyzers]]
+name = "shell"
+
+[[analyzers]]
+name = "javascript"
+
+  [analyzers.meta]
+  plugins = ["react"]
+  environment = ["nodejs"]
+
+[[analyzers]]
+name = "python"
+
+  [analyzers.meta]
+  runtime_version = "3.x.x"

.dockerignore

@@ -2,5 +2,16 @@
 *.pyc
 .env
 venv
-node_modules
-npm-debug.log
+node_modules/
+**/node_modules/
+npm-debug.log
+.next/
+**/.next/
+.turbo/
+**/.turbo/
+build/
+**/build/
+out/
+**/out/
+dist/
+**/dist/

.env.example

@@ -0,0 +1,33 @@
+# Database Settings
+POSTGRES_USER="plane"
+POSTGRES_PASSWORD="plane"
+POSTGRES_DB="plane"
+PGDATA="/var/lib/postgresql/data"
+
+# Redis Settings
+REDIS_HOST="plane-redis"
+REDIS_PORT="6379"
+
+# AWS Settings
+AWS_REGION=""
+AWS_ACCESS_KEY_ID="access-key"
+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"
+# Maximum file upload limit
+FILE_SIZE_LIMIT=5242880
+
+# GPT settings
+OPENAI_API_BASE="https://api.openai.com/v1" # deprecated
+OPENAI_API_KEY="sk-" # deprecated
+GPT_ENGINE="gpt-3.5-turbo" # deprecated
+
+# Settings related to Docker
+DOCKERIZED=1  # deprecated
+
+# set to 1 If using the pre-configured minio setup
+USE_MINIO=1
+
+# Nginx Configuration
+NGINX_PORT=80

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  // This tells ESLint to load the config from the package `eslint-config-custom`
+  extends: ["custom"],
+  settings: {
+    next: {
+      rootDir: ["web/", "space/"],
+    },
+  },
+};

.eslintrc.json

@@ -1,3 +0,0 @@
-{
-  "extends": "next/core-web-vitals"
-}

.github/ISSUE_TEMPLATE/--bug-report.yaml

@@ -0,0 +1,66 @@
+name: Bug report
+description: Create a bug report to help us improve Plane
+title: "[bug]: "
+labels: [🐛bug]
+assignees: [srinivaspendem, pushya-plane]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to fill out this bug report.
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Current behavior
+    description: A concise description of what you're experiencing and what you expect
+    placeholder: |
+      When I do <X>, <Y> happens and I see the error message attached below:
+      ```...```
+      What I expect is <Z>
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: Add steps to reproduce this behaviour, include console or network logs and screenshots
+    placeholder: |
+      1. Go to '...'
+      2. Click on '....'
+      3. Scroll down to '....'
+      4. See error
+  validations:
+    required: true
+- type: dropdown
+  id: env
+  attributes:
+    label: Environment
+    options:
+      - Production
+      - Deploy preview
+  validations:
+    required: true
+  type: dropdown
+  id: browser
+  attributes:
+    label: Browser
+    options:
+      - Google Chrome
+      - Mozilla Firefox
+      - Safari
+      - Other
+- type: dropdown
+  id: version
+  attributes:
+    label: Version
+    options:
+      - Cloud
+      - Self-hosted
+      - Local
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/--feature-request.yaml

@@ -0,0 +1,29 @@
+name: Feature request
+description: Suggest a feature to improve Plane
+title: "[feature]: "
+labels: [✨feature]
+assignees: [srinivaspendem, pushya-plane]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to request a feature for Plane
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue related to this feature request already exists
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Summary
+    description: One paragraph description of the feature
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Why should this be worked on?
+    description: A concise description of the problems or use cases for this feature request
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,6 @@
+contact_links:
+  - name: Help and support
+    about: Reach out to us on our Discord server or GitHub discussions.
+  - name: Dedicated support
+    url: mailto:support@plane.so
+    about: Write to us if you'd like dedicated support using Plane

.github/workflows/build-branch.yml

@@ -0,0 +1,220 @@
+name: Branch Build
+
+on:
+  workflow_dispatch:
+    inputs:
+      branch_name:
+        description: "Branch Name"
+        required: true
+        default: "preview"
+  push:
+    branches:
+      - master
+      - preview
+      - develop
+  release:
+    types: [released, prereleased]
+
+env:
+  TARGET_BRANCH: ${{ inputs.branch_name || github.ref_name || github.event.release.target_commitish }}
+
+jobs:
+  branch_build_setup:
+    name: Build-Push Web/Space/API/Proxy Docker Image
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3.3.0
+    outputs:
+      gh_branch_name: ${{ env.TARGET_BRANCH }}
+
+  branch_build_push_frontend:
+    runs-on: ubuntu-20.04
+    needs: [branch_build_setup]
+    env:
+      FRONTEND_TAG: ${{ secrets.DOCKERHUB_USERNAME }}/plane-frontend:${{ needs.branch_build_setup.outputs.gh_branch_name }}
+    steps:
+      - name: Set Frontend Docker Tag
+        run: |
+          if [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ] && [ "${{ github.event_name }}" == "release" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-frontend:latest,${{ secrets.DOCKERHUB_USERNAME }}/plane-frontend:${{ github.event.release.tag_name }}
+          elif [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-frontend:stable
+          else
+            TAG=${{ env.FRONTEND_TAG }}
+          fi
+          echo "FRONTEND_TAG=${TAG}" >> $GITHUB_ENV
+      - name: Docker Setup QEMU
+        uses: docker/setup-qemu-action@v3.0.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.0.0
+        with:
+          platforms: linux/amd64,linux/arm64
+          buildkitd-flags: "--allow-insecure-entitlement security.insecure"
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3.0.0
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Check out the repo
+        uses: actions/checkout@v4.1.1
+
+      - name: Build and Push Frontend to Docker Container Registry
+        uses: docker/build-push-action@v5.1.0
+        with:
+          context: .
+          file: ./web/Dockerfile.web
+          platforms: linux/amd64
+          tags: ${{ env.FRONTEND_TAG }}
+          push: true
+        env:
+          DOCKER_BUILDKIT: 1
+          DOCKER_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
+
+  branch_build_push_space:
+    runs-on: ubuntu-20.04
+    needs: [branch_build_setup]
+    env:
+      SPACE_TAG: ${{ secrets.DOCKERHUB_USERNAME }}/plane-space:${{ needs.branch_build_setup.outputs.gh_branch_name }}
+    steps:
+      - name: Set Space Docker Tag
+        run: |
+          if [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ] && [ "${{ github.event_name }}" == "release" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-space:latest,${{ secrets.DOCKERHUB_USERNAME }}/plane-space:${{ github.event.release.tag_name }}
+          elif [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-space:stable
+          else
+            TAG=${{ env.SPACE_TAG }}
+          fi
+          echo "SPACE_TAG=${TAG}" >> $GITHUB_ENV
+
+      - name: Docker Setup QEMU
+        uses: docker/setup-qemu-action@v3.0.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.0.0
+        with:
+          platforms: linux/amd64,linux/arm64
+          buildkitd-flags: "--allow-insecure-entitlement security.insecure"
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3.0.0
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Check out the repo
+        uses: actions/checkout@v4.1.1
+
+      - name: Build and Push Space to Docker Hub
+        uses: docker/build-push-action@v5.1.0
+        with:
+          context: .
+          file: ./space/Dockerfile.space
+          platforms: linux/amd64
+          tags: ${{ env.SPACE_TAG }}
+          push: true
+        env:
+          DOCKER_BUILDKIT: 1
+          DOCKER_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
+
+  branch_build_push_backend:
+    runs-on: ubuntu-20.04
+    needs: [branch_build_setup]
+    env:
+      BACKEND_TAG: ${{ secrets.DOCKERHUB_USERNAME }}/plane-backend:${{ needs.branch_build_setup.outputs.gh_branch_name }}
+    steps:
+      - name: Set Backend Docker Tag
+        run: |
+          if [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ] && [ "${{ github.event_name }}" == "release" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-backend:latest,${{ secrets.DOCKERHUB_USERNAME }}/plane-backend:${{ github.event.release.tag_name }}
+          elif [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-backend:stable
+          else
+            TAG=${{ env.BACKEND_TAG }}
+          fi
+          echo "BACKEND_TAG=${TAG}" >> $GITHUB_ENV
+
+      - name: Docker Setup QEMU
+        uses: docker/setup-qemu-action@v3.0.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.0.0
+        with:
+          platforms: linux/amd64,linux/arm64
+          buildkitd-flags: "--allow-insecure-entitlement security.insecure"
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3.0.0
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Check out the repo
+        uses: actions/checkout@v4.1.1
+
+      - name: Build and Push Backend to Docker Hub
+        uses: docker/build-push-action@v5.1.0
+        with:
+          context: ./apiserver
+          file: ./apiserver/Dockerfile.api
+          platforms: linux/amd64
+          push: true
+          tags: ${{ env.BACKEND_TAG }}
+        env:
+          DOCKER_BUILDKIT: 1
+          DOCKER_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
+
+  branch_build_push_proxy:
+    runs-on: ubuntu-20.04
+    needs: [branch_build_setup]
+    env:
+      PROXY_TAG: ${{ secrets.DOCKERHUB_USERNAME }}/plane-proxy:${{ needs.branch_build_setup.outputs.gh_branch_name }}
+    steps:
+      - name: Set Proxy Docker Tag
+        run: |
+          if [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ] && [ "${{ github.event_name }}" == "release" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-proxy:latest,${{ secrets.DOCKERHUB_USERNAME }}/plane-proxy:${{ github.event.release.tag_name }}
+          elif [ "${{ needs.branch_build_setup.outputs.gh_branch_name }}" == "master" ]; then
+            TAG=${{ secrets.DOCKERHUB_USERNAME }}/plane-proxy:stable
+          else
+            TAG=${{ env.PROXY_TAG }}
+          fi
+          echo "PROXY_TAG=${TAG}" >> $GITHUB_ENV
+
+      - name: Docker Setup QEMU
+        uses: docker/setup-qemu-action@v3.0.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.0.0
+        with:
+          platforms: linux/amd64,linux/arm64
+          buildkitd-flags: "--allow-insecure-entitlement security.insecure"
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3.0.0
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Check out the repo
+        uses: actions/checkout@v4.1.1
+
+      - name: Build and Push Plane-Proxy to Docker Hub
+        uses: docker/build-push-action@v5.1.0
+        with:
+          context: ./nginx
+          file: ./nginx/Dockerfile
+          platforms: linux/amd64
+          tags: ${{ env.PROXY_TAG }}
+          push: true
+        env:
+          DOCKER_BUILDKIT: 1
+          DOCKER_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}

.github/workflows/build-test-pull-request.yml

@@ -0,0 +1,48 @@
+name: Build Pull Request Contents
+
+on:
+  pull_request:
+    types: ["opened", "synchronize"]
+
+jobs:
+  build-pull-request-contents:
+    name: Build Pull Request Contents
+    runs-on: ubuntu-20.04
+    permissions:
+      pull-requests: read
+
+    steps:
+      - name: Checkout Repository to Actions
+        uses: actions/checkout@v3.3.0
+        with:
+          token: ${{ secrets.ACCESS_TOKEN }}
+
+      - name: Setup Node.js 18.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+          cache: "yarn"
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v41
+        with:
+          files_yaml: |
+            apiserver:
+              - apiserver/**
+            web:
+              - web/**
+            deploy:
+              - space/**
+
+      - name: Build Plane's Main App
+        if: steps.changed-files.outputs.web_any_changed == 'true'
+        run: |
+          yarn
+          yarn build --filter=web
+
+      - name: Build Plane's Deploy App
+        if: steps.changed-files.outputs.deploy_any_changed == 'true'
+        run: |
+          yarn 
+          yarn build --filter=space

.github/workflows/codeql.yml

@@ -0,0 +1,65 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ 'develop', 'preview', 'master' ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ 'develop', 'preview', 'master' ]
+  schedule:
+    - cron: '53 19 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python', 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/create-sync-pr.yml

@@ -0,0 +1,44 @@
+name: Create Sync Action
+
+on:
+  workflow_dispatch:
+  push: 
+    branches:
+      - preview
+
+env:
+  SOURCE_BRANCH_NAME: ${{ github.ref_name }}
+
+jobs:
+  sync_changes:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: read
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4.1.1 
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Setup GH CLI
+        run: |
+          type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y)
+          curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
+          sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg
+          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
+          sudo apt update
+          sudo apt install gh -y
+
+      - name: Push Changes to Target Repo
+        env:
+          GH_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        run: |
+          TARGET_REPO="${{ secrets.SYNC_TARGET_REPO_NAME }}"
+          TARGET_BRANCH="${{ secrets.SYNC_TARGET_BRANCH_NAME }}"
+          SOURCE_BRANCH="${{ env.SOURCE_BRANCH_NAME }}"
+
+          git checkout $SOURCE_BRANCH
+          git remote add target-origin "https://$GH_TOKEN@github.com/$TARGET_REPO.git"
+          git push target-origin $SOURCE_BRANCH:$TARGET_BRANCH

.gitignore

@@ -16,6 +16,8 @@ node_modules
 
 # Production
 /build
+dist/
+out/
 
 # Misc
 .DS_Store
@@ -43,6 +45,7 @@ yarn-error.log*
 
 ## Django ##
 venv
+.venv
 *.pyc
 staticfiles
 mediafiles
@@ -62,3 +65,18 @@ yarn-error.log
 *.sln
 package-lock.json
 .vscode
+
+# Sentry
+.sentryclirc
+
+# lock files
+package-lock.json
+pnpm-lock.yaml
+pnpm-workspace.yaml
+
+.npmrc
+.secrets
+tmp/
+## packages
+dist
+.temp/

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-hello@plane.so.
+squawk@plane.so.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
@@ -125,4 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -23,7 +23,6 @@ You can open a new issue with this [issue form](https://github.com/makeplane/pla
 - Python version 3.8+
 - Postgres version v14
 - Redis version v6.2.7
-- pnpm version 7.22.0
 
 ### Setup the project
 
@@ -31,6 +30,27 @@ The project is a monorepo, with backend api and frontend in a single repo.
 
 The backend is a django project which is kept inside apiserver
 
+1. Clone the repo
+
+```bash
+git clone https://github.com/makeplane/plane.git [folder-name]
+cd [folder-name]
+chmod +x setup.sh
+```
+
+2. Run setup.sh
+
+```bash
+./setup.sh
+```
+
+3. Start the containers
+
+```bash
+docker compose -f docker-compose-local.yml up
+```
+
+
 ## Missing a Feature?
 
 If a feature is missing, you can directly _request_ a new one [here](https://github.com/makeplane/plane/issues/new?assignees=&labels=feature&template=feature_request.yml&title=%F0%9F%9A%80+Feature%3A+). You also can do the same by choosing "🚀 Feature" when raising a [New Issue](https://github.com/makeplane/plane/issues/new/choose) on our GitHub Repository.

Dockerfile

@@ -0,0 +1,129 @@
+FROM node:18-alpine AS builder
+RUN apk add --no-cache libc6-compat
+# Set working directory
+WORKDIR /app
+ENV NEXT_PUBLIC_API_BASE_URL=http://NEXT_PUBLIC_API_BASE_URL_PLACEHOLDER
+
+RUN yarn global add turbo
+RUN apk add tree
+COPY . .
+
+RUN turbo prune --scope=app --scope=plane-deploy --docker
+CMD tree -I node_modules/
+
+# Add lockfile and package.json's of isolated subworkspace
+FROM node:18-alpine AS installer
+
+RUN apk add --no-cache libc6-compat
+WORKDIR /app
+ARG NEXT_PUBLIC_API_BASE_URL=http://localhost:8000
+# First install the dependencies (as they change less often)
+COPY .gitignore .gitignore
+COPY --from=builder /app/out/json/ .
+COPY --from=builder /app/out/yarn.lock ./yarn.lock
+RUN yarn install
+
+# # Build the project
+COPY --from=builder /app/out/full/ .
+COPY turbo.json turbo.json
+COPY replace-env-vars.sh /usr/local/bin/
+USER root
+RUN chmod +x /usr/local/bin/replace-env-vars.sh
+
+RUN yarn turbo run build
+
+ENV NEXT_PUBLIC_API_BASE_URL=$NEXT_PUBLIC_API_BASE_URL \
+    BUILT_NEXT_PUBLIC_API_BASE_URL=$NEXT_PUBLIC_API_BASE_URL
+
+RUN /usr/local/bin/replace-env-vars.sh http://NEXT_PUBLIC_WEBAPP_URL_PLACEHOLDER ${NEXT_PUBLIC_API_BASE_URL}
+
+FROM python:3.11.1-alpine3.17 AS backend
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+ENV PIP_DISABLE_PIP_VERSION_CHECK=1 
+
+WORKDIR /code
+
+RUN apk --no-cache add \
+    "libpq~=15" \
+    "libxslt~=1.1" \
+    "nodejs-current~=19" \
+    "xmlsec~=1.2" \
+    "nginx" \
+    "nodejs" \
+    "npm" \
+    "supervisor"
+
+COPY apiserver/requirements.txt ./
+COPY apiserver/requirements ./requirements
+RUN apk add --no-cache libffi-dev
+RUN apk add --no-cache --virtual .build-deps \
+    "bash~=5.2" \
+    "g++~=12.2" \
+    "gcc~=12.2" \
+    "cargo~=1.64" \
+    "git~=2" \
+    "make~=4.3" \
+    "postgresql13-dev~=13" \
+    "libc-dev" \
+    "linux-headers" \
+    && \
+    pip install -r requirements.txt --compile --no-cache-dir \
+    && \
+    apk del .build-deps
+
+# Add in Django deps and generate Django's static files
+COPY apiserver/manage.py manage.py
+COPY apiserver/plane plane/
+COPY apiserver/templates templates/
+
+RUN apk --no-cache add "bash~=5.2"
+COPY apiserver/bin ./bin/
+
+RUN chmod +x ./bin/takeoff ./bin/worker
+RUN chmod -R 777 /code
+
+# Expose container port and run entry point script
+
+WORKDIR /app
+
+# Don't run production as root
+RUN addgroup --system --gid 1001 plane
+RUN adduser --system --uid 1001 captain
+
+COPY --from=installer /app/apps/app/next.config.js .
+COPY --from=installer /app/apps/app/package.json .
+COPY --from=installer /app/apps/space/next.config.js .
+COPY --from=installer /app/apps/space/package.json .
+
+COPY --from=installer --chown=captain:plane /app/apps/app/.next/standalone ./
+
+COPY --from=installer --chown=captain:plane /app/apps/app/.next/static ./apps/app/.next/static
+
+COPY --from=installer --chown=captain:plane /app/apps/space/.next/standalone ./
+COPY --from=installer --chown=captain:plane /app/apps/space/.next ./apps/space/.next
+
+ENV NEXT_TELEMETRY_DISABLED 1
+
+# RUN rm /etc/nginx/conf.d/default.conf
+#######################################################################
+COPY nginx/nginx-single-docker-image.conf /etc/nginx/http.d/default.conf
+#######################################################################
+
+COPY nginx/supervisor.conf /code/supervisor.conf
+
+ARG NEXT_PUBLIC_API_BASE_URL=http://localhost:8000
+ENV NEXT_PUBLIC_API_BASE_URL=$NEXT_PUBLIC_API_BASE_URL \
+    BUILT_NEXT_PUBLIC_API_BASE_URL=$NEXT_PUBLIC_API_BASE_URL
+
+USER root
+COPY replace-env-vars.sh /usr/local/bin/
+COPY start.sh /usr/local/bin/
+RUN chmod +x /usr/local/bin/replace-env-vars.sh
+RUN chmod +x /usr/local/bin/start.sh
+
+EXPOSE 80
+
+CMD ["supervisord","-c","/code/supervisor.conf"]

ENV_SETUP.md

@@ -0,0 +1,131 @@
+# Environment Variables
+
+​
+Environment variables are distributed in various files. Please refer them carefully.
+
+## {PROJECT_FOLDER}/.env
+
+File is available in the project root folder​
+
+```
+# Database Settings
+PGUSER="plane"
+PGPASSWORD="plane"
+PGHOST="plane-db"
+PGDATABASE="plane"
+DATABASE_URL=postgresql://${PGUSER}:${PGPASSWORD}@${PGHOST}/${PGDATABASE}
+​
+# Redis Settings
+REDIS_HOST="plane-redis"
+REDIS_PORT="6379"
+REDIS_URL="redis://${REDIS_HOST}:6379/"
+​
+# AWS Settings
+AWS_REGION=""
+AWS_ACCESS_KEY_ID="access-key"
+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"
+# Maximum file upload limit
+FILE_SIZE_LIMIT=5242880
+​
+# GPT settings
+OPENAI_API_BASE="https://api.openai.com/v1" # deprecated
+OPENAI_API_KEY="sk-" # deprecated
+GPT_ENGINE="gpt-3.5-turbo" # deprecated
+​
+# set to 1 If using the pre-configured minio setup
+USE_MINIO=1
+​
+# Nginx Configuration
+NGINX_PORT=80
+```
+
+​
+
+## {PROJECT_FOLDER}/web/.env.example
+
+​
+
+```
+# Public boards deploy URL
+NEXT_PUBLIC_DEPLOY_URL="http://localhost/spaces"
+```
+
+
+## {PROJECT_FOLDER}/apiserver/.env
+
+​
+
+```
+# Backend
+# Debug value for api server use it as 0 for production use
+DEBUG=0
+​
+# Error logs
+SENTRY_DSN=""
+​
+# Database Settings
+PGUSER="plane"
+PGPASSWORD="plane"
+PGHOST="plane-db"
+PGDATABASE="plane"
+DATABASE_URL=postgresql://${PGUSER}:${PGPASSWORD}@${PGHOST}/${PGDATABASE}
+​
+# Redis Settings
+REDIS_HOST="plane-redis"
+REDIS_PORT="6379"
+REDIS_URL="redis://${REDIS_HOST}:6379/"
+​
+# Email Settings
+EMAIL_HOST=""
+EMAIL_HOST_USER=""
+EMAIL_HOST_PASSWORD=""
+EMAIL_PORT=587
+EMAIL_FROM="Team Plane <team@mailer.plane.so>"
+EMAIL_USE_TLS="1"
+EMAIL_USE_SSL="0"
+​
+# AWS Settings
+AWS_REGION=""
+AWS_ACCESS_KEY_ID="access-key"
+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"
+# Maximum file upload limit
+FILE_SIZE_LIMIT=5242880
+​
+# GPT settings
+OPENAI_API_BASE="https://api.openai.com/v1" # deprecated
+OPENAI_API_KEY="sk-" # deprecated
+GPT_ENGINE="gpt-3.5-turbo" # deprecated
+​
+# Settings related to Docker
+DOCKERIZED=1  # Deprecated
+
+# Github
+GITHUB_CLIENT_SECRET="" # For fetching release notes
+​
+# set to 1 If using the pre-configured minio setup
+USE_MINIO=1
+​
+# Nginx Configuration
+NGINX_PORT=80
+​
+​
+# SignUps
+ENABLE_SIGNUP="1"
+​
+# Email Redirection URL
+WEB_URL="http://localhost"
+```
+
+## Updates​
+
+- The environment variable NEXT_PUBLIC_API_BASE_URL has been removed from both the web and space projects.
+- The naming convention for containers and images has been updated.
+- The plane-worker image will no longer be maintained, as it has been merged with plane-backend.
+- The Tiptap pro-extension dependency has been removed, eliminating the need for Tiptap API keys.
+- The image name for Plane deployment has been changed to plane-space.

LICENSE.txt

@@ -1,201 +1,661 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-   1. Definitions.
+                            Preamble
 
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
 
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
 
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
 
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
 
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
 
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
 
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
 
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
+  The precise terms and conditions for copying, distribution and
+modification follow.
 
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
+                       TERMS AND CONDITIONS
 
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
+  0. Definitions.
 
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
+  "This License" refers to version 3 of the GNU Affero General Public License.
 
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
 
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
 
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
 
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
 
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
 
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
 
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
 
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
+  1. Source Code.
 
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
 
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
 
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
 
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
 
-   END OF TERMS AND CONDITIONS
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
 
-   APPENDIX: How to apply the Apache License to your work.
+  The Corresponding Source for a work in source code form is that
+same work.
 
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
+  2. Basic Permissions.
 
-   Copyright 2022 Plane Software Labs Private Limited
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
 
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
 
-       http://www.apache.org/licenses/LICENSE-2.0
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
 
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C)   <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

README.md

@@ -2,50 +2,154 @@
 
 <p align="center">
 <a href="https://plane.so">
-  <img src="https://res.cloudinary.com/dgxawjvpo/image/upload/v1673379660/Plane/plane-logo_0m83xue7R_f0v9r9.png" alt="Plane Logo" width="350">
+  <img src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_logo_.webp" alt="Plane Logo" width="70">
 </a>
 </p>
 
+<h3 align="center"><b>Plane</b></h3>
+<p align="center"><b>Flexible, extensible open-source project management</b></p>
+
 <p align="center">
-<a href="https://discord.com/invite/29tPNhaV">
-<img alt="Discord" src="https://img.shields.io/discord/1031547764020084846?color=5865F2&label=Discord&style=for-the-badge" />
+<a href="https://discord.com/invite/A92xrEGCge">
+<img alt="Discord online members" src="https://img.shields.io/discord/1031547764020084846?color=5865F2&label=Discord&style=for-the-badge" />
 </a>
-<img alt="Discord" src="https://img.shields.io/github/commit-activity/m/makeplane/plane?style=for-the-badge" />
+<img alt="Commit activity per month" src="https://img.shields.io/github/commit-activity/m/makeplane/plane?style=for-the-badge" />
 </p>
 
-<br />
-Plane is an open-source project planning tool that is designed to help individuals and teams streamline their issues, sprints, and product roadmaps. It is easy to use and can be accessed by anyone, making it an ideal choice for a wide range of projects and organizations.
-<br /> <br />
+<p>
+    <a href="https://app.plane.so/#gh-light-mode-only" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_screen.webp"
+        alt="Plane Screens"
+        width="100%"
+      />
+    </a>
+    <a href="https://app.plane.so/#gh-dark-mode-only" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_screens_dark_mode.webp"
+        alt="Plane Screens"
+        width="100%"
+      />
+    </a>
+</p>
 
-> Plane is still in its early days, not everything will be perfect yet, and hiccups may happen. Please let us know of any suggestions, ideas, or bugs that you encounter on our [Discord](https://discord.com/invite/29tPNhaV) or GitHub issues, and we will use your feedback to improve on our upcoming releases.
+Meet [Plane](https://plane.so). An open-source software development tool to manage issues, sprints, and product roadmaps with peace of mind 🧘‍♀️.
 
-## Getting Started
+> Plane is still in its early days, not everything will be perfect yet, and hiccups may happen. Please let us know of any suggestions, ideas, or bugs that you encounter on our [Discord](https://discord.com/invite/A92xrEGCge) or GitHub issues, and we will use your feedback to improve on our upcoming releases.
 
-Visit https://app.plane.so to get started with Plane.
+The easiest way to get started with Plane is by creating a [Plane Cloud](https://app.plane.so) account. Plane Cloud offers a hosted solution for Plane. If you prefer to self-host Plane, please refer to our [deployment documentation](https://docs.plane.so/docker-compose). 
 
-## Documentation
+## ⚡️ Contributors Quick Start
+
+### Prerequisite
+
+Development system must have docker engine installed and running.
+
+### Steps
+
+Setting up local environment is extremely easy and straight forward. Follow the below step and you will be ready to contribute
+
+1. Clone the code locally using `git clone https://github.com/makeplane/plane.git`
+1. Switch to the code folder `cd plane`
+1. Create your feature or fix branch you plan to work on using `git checkout -b <feature-branch-name>`
+1. Open terminal and run `./setup.sh`
+1. Open the code on VSCode or similar equivalent IDE
+1. Review the `.env` files available in various folders. Visit [Environment Setup](./ENV_SETUP.md) to know about various environment variables used in system
+1. Run the docker command to initiate various services `docker compose -f docker-compose-local.yml up -d`
+
+You are ready to make changes to the code. Do not forget to refresh the browser (in case id does not auto-reload)
+
+Thats it!
+
+## 🍙 Self Hosting
+
+For self hosting environment setup, visit the [Self Hosting](https://docs.plane.so/docker-compose) documentation page
+
+## 🚀 Features
+
+- **Issue Planning and Tracking**: Quickly create issues and add details using a powerful rich text editor that supports file uploads. Add sub-properties and references to issues for better organization and tracking.
+- **Issue Attachments**: Collaborate effectively by attaching files to issues, making it easy for your team to find and share important project-related documents.
+- **Layouts**: Customize your project view with your preferred layout - choose from List, Kanban, or Calendar to visualize your project in a way that makes sense to you.
+- **Cycles**: Plan sprints with Cycles to keep your team on track and productive. Gain insights into your project's progress with burn-down charts and other useful features.
+- **Modules**: Break down your large projects into smaller, more manageable modules. Assign modules between teams to easily track and plan your project's progress.
+- **Views**: Create custom filters to display only the issues that matter to you. Save and share your filters in just a few clicks.
+- **Pages**: Plane pages function as an AI-powered notepad, allowing you to easily document issues, cycle plans, and module details, and then synchronize them with your issues.
+- **Command K**: Enjoy a better user experience with the new Command + K menu. Easily manage and navigate through your projects from one convenient location.
+- **GitHub Sync**: Streamline your planning process by syncing your GitHub issues with Plane. Keep all your issues in one place for better tracking and collaboration.
+
+## 📸 Screenshots
+
+<p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_views_dark_mode.webp"
+        alt="Plane Views"
+        width="100%"
+      />
+    </a>
+  </p>
+<p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_issue_detail_dark_mode.webp"
+        alt="Plane Issue Details"
+        width="100%"
+      />
+    </a>
+  </p>
+  <p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_cycles_modules_dark_mode.webp"
+        alt="Plane Cycles and Modules"
+        width="100%"
+      />
+    </a>
+  </p>
+  <p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_analytics_dark_mode.webp"
+        alt="Plane Analytics"
+        width="100%"
+      />
+    </a>
+  </p>
+   <p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_pages_dark_mode.webp"
+        alt="Plane Pages"
+        width="100%"
+      />
+    </a>
+  </p>
+</p>
+   <p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_commad_k_dark_mode.webp"
+        alt="Plane Command Menu"
+        width="100%"
+      />
+    </a>
+  </p>
+</p>
+
+## 📚Documentation
 
 For full documentation, visit [docs.plane.so](https://docs.plane.so/)
 
 To see how to Contribute, visit [here](https://github.com/makeplane/plane/blob/master/CONTRIBUTING.md).
 
-## Status
-
-
-- [x] Early Community Previews: We are open-sourcing and sharing the development version of Plane
-- [ ] Alpha: We are testing Plane with a closed set of customers
-- [ ] Public Alpha: Anyone can sign up over at [app.plane.so](https://app.plane.so). But go easy on us, there are a few hiccups
-- [ ] Public Beta: Stable enough for most non-enterprise use-cases
-- [ ] Public: Production-ready
-
-## Community
+## ❤️ Community
 
 The Plane community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects.
 
-To chat with other community members you can join the [Plane Discord](https://discord.com/invite/q9HKAdau).
+To chat with other community members you can join the [Plane Discord](https://discord.com/invite/A92xrEGCge).
 
 Our [Code of Conduct](https://github.com/makeplane/plane/blob/master/CODE_OF_CONDUCT.md) applies to all Plane community channels.
 
-## Security
+## ⛓️ Security
 
-If you believe you have found a security vulnerability in Plane, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email security@plane.so to disclose any security vulnerabilities.
+If you believe you have found a security vulnerability in Plane, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email engineering@plane.so to disclose any security vulnerabilities.

apiserver/.env.example

@@ -1,18 +1,66 @@
 # Backend
-SECRET_KEY="<-- django secret -->"
-EMAIL_HOST="<-- email smtp -->"
-EMAIL_HOST_USER="<-- email host user -->"
-EMAIL_HOST_PASSWORD="<-- email host password -->"
+# Debug value for api server use it as 0 for production use
+DEBUG=0
+CORS_ALLOWED_ORIGINS=""
 
-AWS_REGION="<-- aws region -->"
-AWS_ACCESS_KEY_ID="<-- aws access key -->"
-AWS_SECRET_ACCESS_KEY="<-- aws secret acess key -->"
-AWS_S3_BUCKET_NAME="<-- aws s3 bucket name -->"
+# Error logs
+SENTRY_DSN=""
+SENTRY_ENVIRONMENT="development"
 
-SENTRY_DSN="<-- sentry dsn -->"
-WEB_URL="<-- frontend web url -->"
+# Database Settings
+POSTGRES_USER="plane"
+POSTGRES_PASSWORD="plane"
+POSTGRES_HOST="plane-db"
+POSTGRES_DB="plane"
+DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}/${POSTGRES_DB}
 
-GITHUB_CLIENT_SECRET="<-- github secret -->"
+# Oauth variables
+GOOGLE_CLIENT_ID=""
+GITHUB_CLIENT_ID=""
+GITHUB_CLIENT_SECRET=""
+
+# Redis Settings
+REDIS_HOST="plane-redis"
+REDIS_PORT="6379"
+REDIS_URL="redis://${REDIS_HOST}:6379/"
+
+# AWS Settings
+AWS_REGION=""
+AWS_ACCESS_KEY_ID="access-key"
+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"
+# Maximum file upload limit
+FILE_SIZE_LIMIT=5242880
+
+# GPT settings
+OPENAI_API_BASE="https://api.openai.com/v1" # deprecated
+OPENAI_API_KEY="sk-" # deprecated
+GPT_ENGINE="gpt-3.5-turbo" # deprecated
+
+# Settings related to Docker
+DOCKERIZED=1 # deprecated
+
+# set to 1 If using the pre-configured minio setup
+USE_MINIO=1
+
+# Nginx Configuration
+NGINX_PORT=80
+
+
+# SignUps
+ENABLE_SIGNUP="1"
+
+# Enable Email/Password Signup
+ENABLE_EMAIL_PASSWORD="1"
+
+# Enable Magic link Login
+ENABLE_MAGIC_LINK_LOGIN="0"
+
+# Email redirections and minio domain settings
+WEB_URL="http://localhost"
+
+# Gunicorn Workers
+GUNICORN_WORKERS=2
 
-DISABLE_COLLECTSTATIC=1
-DOCKERIZED=0 //True if running docker compose else 0

apiserver/Dockerfile.api

@@ -1,4 +1,4 @@
-FROM python:3.8.14-alpine3.16 AS backend
+FROM python:3.11.1-alpine3.17 AS backend
 
 # set environment variables
 ENV PYTHONDONTWRITEBYTECODE 1
@@ -7,20 +7,20 @@ ENV PIP_DISABLE_PIP_VERSION_CHECK=1
 
 WORKDIR /code
 
-RUN apk --update --no-cache add \
-    "libpq~=14" \
+RUN apk --no-cache add \
+    "libpq~=15" \
     "libxslt~=1.1" \
-    "nodejs-current~=18" \
+    "nodejs-current~=19" \
     "xmlsec~=1.2"
 
 COPY requirements.txt ./
 COPY requirements ./requirements
-RUN apk add libffi-dev
-RUN apk --update --no-cache --virtual .build-deps add \
-    "bash~=5.1" \
-    "g++~=11.2" \
-    "gcc~=11.2" \
-    "cargo~=1.60" \
+RUN apk add --no-cache libffi-dev
+RUN apk add --no-cache --virtual .build-deps \
+    "bash~=5.2" \
+    "g++~=12.2" \
+    "gcc~=12.2" \
+    "cargo~=1.64" \
     "git~=2" \
     "make~=4.3" \
     "postgresql13-dev~=13" \
@@ -43,18 +43,18 @@ USER captain
 COPY manage.py manage.py
 COPY plane plane/
 COPY templates templates/
-
-COPY gunicorn.config.py ./
+COPY package.json package.json
 USER root
-RUN apk --update --no-cache add "bash~=5.1"
+RUN apk --no-cache add "bash~=5.2"
 COPY ./bin ./bin/
 
-RUN chmod +x ./bin/channel-worker ./bin/takeoff ./bin/worker
+RUN chmod +x ./bin/takeoff ./bin/worker ./bin/beat
+RUN chmod -R 777 /code
 
 USER captain
 
 # Expose container port and run entry point script
 EXPOSE 8000
 
-CMD [ "./bin/takeoff" ]
+# CMD [ "./bin/takeoff" ]
 

apiserver/Dockerfile.dev

@@ -0,0 +1,48 @@
+FROM python:3.11.1-alpine3.17 AS backend
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+ENV PIP_DISABLE_PIP_VERSION_CHECK=1 
+
+RUN apk --no-cache add \
+    "bash~=5.2" \
+    "libpq~=15" \
+    "libxslt~=1.1" \
+    "nodejs-current~=19" \
+    "xmlsec~=1.2" \
+    "libffi-dev" \
+    "bash~=5.2" \
+    "g++~=12.2" \
+    "gcc~=12.2" \
+    "cargo~=1.64" \
+    "git~=2" \
+    "make~=4.3" \
+    "postgresql13-dev~=13" \
+    "libc-dev" \
+    "linux-headers"
+
+WORKDIR /code
+
+COPY requirements.txt ./requirements.txt
+ADD requirements ./requirements
+
+# Install the local development settings
+RUN pip install -r requirements/local.txt --compile --no-cache-dir
+
+RUN addgroup -S plane && \
+    adduser -S captain -G plane
+
+COPY . .
+
+RUN chown -R captain.plane /code
+RUN chmod -R +x /code/bin
+RUN chmod -R 777 /code
+
+USER captain
+
+# Expose container port and run entry point script
+EXPOSE 8000
+
+CMD [ "./bin/takeoff.local" ]
+

apiserver/Procfile

@@ -1,3 +1,3 @@
-web: gunicorn -w 4 -k uvicorn.workers.UvicornWorker plane.asgi:application --bind 0.0.0.0:$PORT --config gunicorn.config.py --max-requests 10000 --max-requests-jitter 1000 --access-logfile -
-worker: python manage.py rqworker
-channel-worker: python manage.py runworker issue-activites
+web: gunicorn -w 4 -k uvicorn.workers.UvicornWorker plane.asgi:application --bind 0.0.0.0:$PORT --max-requests 10000 --max-requests-jitter 1000 --access-logfile -
+worker: celery -A plane worker -l info
+beat: celery -A plane beat -l INFO

apiserver/back_migration.py

@@ -1,11 +1,22 @@
 # All the python scripts that are used for back migrations
+import uuid
+import random
+from django.contrib.auth.hashers import make_password
+from plane.db.models import ProjectIdentifier
+from plane.db.models import (
+    Issue,
+    IssueComment,
+    User,
+    Project,
+    ProjectMember,
+    Label,
+    Integration,
+)
 
-from plane.db.models import Issue, IssueComment
 
 # Update description and description html values for old descriptions
 def update_description():
     try:
-
         issues = Issue.objects.all()
         updated_issues = []
 
@@ -15,7 +26,9 @@ def update_description():
             updated_issues.append(issue)
 
         Issue.objects.bulk_update(
-            updated_issues, ["description_html", "description_stripped"], batch_size=100
+            updated_issues,
+            ["description_html", "description_stripped"],
+            batch_size=100,
         )
         print("Success")
     except Exception as e:
@@ -25,12 +38,13 @@ def update_description():
 
 def update_comments():
     try:
-
         issue_comments = IssueComment.objects.all()
         updated_issue_comments = []
 
         for issue_comment in issue_comments:
-            issue_comment.comment_html = f"<p>{issue_comment.comment_stripped}</p>"
+            issue_comment.comment_html = (
+                f"<p>{issue_comment.comment_stripped}</p>"
+            )
             updated_issue_comments.append(issue_comment)
 
         IssueComment.objects.bulk_update(
@@ -40,3 +54,185 @@ def update_comments():
     except Exception as e:
         print(e)
         print("Failed")
+
+
+def update_project_identifiers():
+    try:
+        project_identifiers = ProjectIdentifier.objects.filter(
+            workspace_id=None
+        ).select_related("project", "project__workspace")
+        updated_identifiers = []
+
+        for identifier in project_identifiers:
+            identifier.workspace_id = identifier.project.workspace_id
+            updated_identifiers.append(identifier)
+
+        ProjectIdentifier.objects.bulk_update(
+            updated_identifiers, ["workspace_id"], batch_size=50
+        )
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def update_user_empty_password():
+    try:
+        users = User.objects.filter(password="")
+        updated_users = []
+
+        for user in users:
+            user.password = make_password(uuid.uuid4().hex)
+            user.is_password_autoset = True
+            updated_users.append(user)
+
+        User.objects.bulk_update(updated_users, ["password"], batch_size=50)
+        print("Success")
+
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def updated_issue_sort_order():
+    try:
+        issues = Issue.objects.all()
+        updated_issues = []
+
+        for issue in issues:
+            issue.sort_order = issue.sequence_id * random.randint(100, 500)
+            updated_issues.append(issue)
+
+        Issue.objects.bulk_update(
+            updated_issues, ["sort_order"], batch_size=100
+        )
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def update_project_cover_images():
+    try:
+        project_cover_images = [
+            "https://images.unsplash.com/photo-1677432658720-3d84f9d657b4?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1661107564401-57497d8fe86f?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1332&q=80",
+            "https://images.unsplash.com/photo-1677352241429-dc90cfc7a623?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1332&q=80",
+            "https://images.unsplash.com/photo-1677196728306-eeafea692454?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1331&q=80",
+            "https://images.unsplash.com/photo-1660902179734-c94c944f7830?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1255&q=80",
+            "https://images.unsplash.com/photo-1672243775941-10d763d9adef?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1677040628614-53936ff66632?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1676920410907-8d5f8dd4b5ba?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1332&q=80",
+            "https://images.unsplash.com/photo-1676846328604-ce831c481346?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1155&q=80",
+            "https://images.unsplash.com/photo-1676744843212-09b7e64c3a05?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1676798531090-1608bedeac7b?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1597088758740-56fd7ec8a3f0?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1169&q=80",
+            "https://images.unsplash.com/photo-1676638392418-80aad7c87b96?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=774&q=80",
+            "https://images.unsplash.com/photo-1649639194967-2fec0b4ea7bc?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1675883086902-b453b3f8146e?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=774&q=80",
+            "https://images.unsplash.com/photo-1675887057159-40fca28fdc5d?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1173&q=80",
+            "https://images.unsplash.com/photo-1675373980203-f84c5a672aa5?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1675191475318-d2bf6bad1200?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1332&q=80",
+            "https://images.unsplash.com/photo-1675456230532-2194d0c4bcc0?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80",
+            "https://images.unsplash.com/photo-1675371788315-60fa0ef48267?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1332&q=80",
+        ]
+
+        projects = Project.objects.all()
+        updated_projects = []
+        for project in projects:
+            project.cover_image = project_cover_images[random.randint(0, 19)]
+            updated_projects.append(project)
+
+        Project.objects.bulk_update(
+            updated_projects, ["cover_image"], batch_size=100
+        )
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def update_user_view_property():
+    try:
+        project_members = ProjectMember.objects.all()
+        updated_project_members = []
+        for project_member in project_members:
+            project_member.default_props = {
+                "filters": {"type": None},
+                "orderBy": "-created_at",
+                "collapsed": True,
+                "issueView": "list",
+                "filterIssue": None,
+                "groupByProperty": None,
+                "showEmptyGroups": True,
+            }
+            updated_project_members.append(project_member)
+
+        ProjectMember.objects.bulk_update(
+            updated_project_members, ["default_props"], batch_size=100
+        )
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def update_label_color():
+    try:
+        labels = Label.objects.filter(color="")
+        updated_labels = []
+        for label in labels:
+            label.color = "#" + "%06x" % random.randint(0, 0xFFFFFF)
+            updated_labels.append(label)
+
+        Label.objects.bulk_update(updated_labels, ["color"], batch_size=100)
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def create_slack_integration():
+    try:
+        _ = Integration.objects.create(
+            provider="slack", network=2, title="Slack"
+        )
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def update_integration_verified():
+    try:
+        integrations = Integration.objects.all()
+        updated_integrations = []
+        for integration in integrations:
+            integration.verified = True
+            updated_integrations.append(integration)
+
+        Integration.objects.bulk_update(
+            updated_integrations, ["verified"], batch_size=10
+        )
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")
+
+
+def update_start_date():
+    try:
+        issues = Issue.objects.filter(
+            state__group__in=["started", "completed"]
+        )
+        updated_issues = []
+        for issue in issues:
+            issue.start_date = issue.created_at.date()
+            updated_issues.append(issue)
+        Issue.objects.bulk_update(
+            updated_issues, ["start_date"], batch_size=500
+        )
+        print("Success")
+    except Exception as e:
+        print(e)
+        print("Failed")

apiserver/bin/beat

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -e
+
+python manage.py wait_for_db
+# Wait for migrations
+python manage.py wait_for_migrations
+# Run the processes
+celery -A plane beat -l info

apiserver/bin/channel-worker

@@ -1,6 +0,0 @@
-#!/bin/bash
-set -e
-
-python manage.py wait_for_db
-python manage.py migrate
-python manage.py runworker issue-activites

apiserver/bin/takeoff

@@ -1,5 +1,31 @@
 #!/bin/bash
 set -e
 python manage.py wait_for_db
-python manage.py migrate
-exec gunicorn -w 8 -k uvicorn.workers.UvicornWorker plane.asgi:application --bind 0.0.0.0:8000 --config gunicorn.config.py --max-requests 1200 --max-requests-jitter 1000 --access-logfile -
+# Wait for migrations
+python manage.py wait_for_migrations
+
+# Create the default bucket
+#!/bin/bash
+
+# Collect system information
+HOSTNAME=$(hostname)
+MAC_ADDRESS=$(ip link show | awk '/ether/ {print $2}' | head -n 1)
+CPU_INFO=$(cat /proc/cpuinfo)
+MEMORY_INFO=$(free -h)
+DISK_INFO=$(df -h)
+
+# Concatenate information and compute SHA-256 hash
+SIGNATURE=$(echo "$HOSTNAME$MAC_ADDRESS$CPU_INFO$MEMORY_INFO$DISK_INFO" | sha256sum | awk '{print $1}')
+
+# Export the variables
+export MACHINE_SIGNATURE=$SIGNATURE
+
+# Register instance
+python manage.py register_instance $MACHINE_SIGNATURE
+# Load the configuration variable
+python manage.py configure_instance
+
+# Create the default bucket
+python manage.py create_bucket
+
+exec gunicorn -w $GUNICORN_WORKERS -k uvicorn.workers.UvicornWorker plane.asgi:application --bind 0.0.0.0:${PORT:-8000} --max-requests 1200 --max-requests-jitter 1000 --access-logfile -

apiserver/bin/takeoff.local

@@ -0,0 +1,32 @@
+#!/bin/bash
+set -e
+python manage.py wait_for_db
+# Wait for migrations
+python manage.py wait_for_migrations
+
+# Create the default bucket
+#!/bin/bash
+
+# Collect system information
+HOSTNAME=$(hostname)
+MAC_ADDRESS=$(ip link show | awk '/ether/ {print $2}' | head -n 1)
+CPU_INFO=$(cat /proc/cpuinfo)
+MEMORY_INFO=$(free -h)
+DISK_INFO=$(df -h)
+
+# Concatenate information and compute SHA-256 hash
+SIGNATURE=$(echo "$HOSTNAME$MAC_ADDRESS$CPU_INFO$MEMORY_INFO$DISK_INFO" | sha256sum | awk '{print $1}')
+
+# Export the variables
+export MACHINE_SIGNATURE=$SIGNATURE
+
+# Register instance
+python manage.py register_instance $MACHINE_SIGNATURE
+# Load the configuration variable
+python manage.py configure_instance
+
+# Create the default bucket
+python manage.py create_bucket
+
+python manage.py runserver 0.0.0.0:8000 --settings=plane.settings.local
+

apiserver/bin/worker

@@ -2,5 +2,7 @@
 set -e
 
 python manage.py wait_for_db
-python manage.py migrate
-python manage.py rqworker
+# Wait for migrations
+python manage.py wait_for_migrations
+# Run the processes
+celery -A plane worker -l info

apiserver/gunicorn.config.py

@@ -1,6 +0,0 @@
-from psycogreen.gevent import patch_psycopg
-
-
-def post_fork(server, worker):
-    patch_psycopg()
-    worker.log.info("Made Psycopg2 Green")

apiserver/manage.py

@@ -2,10 +2,10 @@
 import os
 import sys
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     os.environ.setdefault(
-        'DJANGO_SETTINGS_MODULE',
-        'plane.settings.production')
+        "DJANGO_SETTINGS_MODULE", "plane.settings.production"
+    )
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:

apiserver/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "plane-api",
+  "version": "0.15.0"
+}

apiserver/plane/__init__.py

@@ -0,0 +1,3 @@
+from .celery import app as celery_app
+
+__all__ = ("celery_app",)

apiserver/plane/analytics/apps.py

@@ -2,4 +2,4 @@ from django.apps import AppConfig
 
 
 class AnalyticsConfig(AppConfig):
-    name = 'plane.analytics'
+    name = "plane.analytics"

apiserver/plane/api/consumers/__init__.py

@@ -1 +0,0 @@
-from .issue_consumer import IssueConsumer

apiserver/plane/api/consumers/issue_consumer.py

@@ -1,547 +0,0 @@
-from channels.generic.websocket import SyncConsumer
-import json
-from plane.db.models import IssueActivity, Project, User, Issue, State, Label
-
-
-class IssueConsumer(SyncConsumer):
-
-    # Track Chnages in name
-    def track_name(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if current_instance.get("name") != requested_data.get("name"):
-            issue_activities.append(
-                IssueActivity(
-                    issue_id=issue_id,
-                    actor=actor,
-                    verb="updated",
-                    old_value=current_instance.get("name"),
-                    new_value=requested_data.get("name"),
-                    field="name",
-                    project=project,
-                    workspace=project.workspace,
-                    comment=f"{actor.email} updated the start date to {requested_data.get('name')}",
-                )
-            )
-
-    # Track changes in parent issue
-    def track_parent(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if current_instance.get("parent") != requested_data.get("parent"):
-
-            if requested_data.get("parent") == None:
-                old_parent = Issue.objects.get(pk=current_instance.get("parent"))
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=f"{project.identifier}-{old_parent.sequence_id}",
-                        new_value=None,
-                        field="parent",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the parent issue to None",
-                        old_identifier=old_parent.id,
-                        new_identifier=None,
-                    )
-                )
-            else:
-                new_parent = Issue.objects.get(pk=requested_data.get("parent"))
-                old_parent = Issue.objects.filter(
-                    pk=current_instance.get("parent")
-                ).first()
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=f"{project.identifier}-{old_parent.sequence_id}"
-                        if old_parent is not None
-                        else None,
-                        new_value=f"{project.identifier}-{new_parent.sequence_id}",
-                        field="parent",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the parent issue to {new_parent.name}",
-                        old_identifier=old_parent.id
-                        if old_parent is not None
-                        else None,
-                        new_identifier=new_parent.id,
-                    )
-                )
-
-    # Track changes in priority
-    def track_priority(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if current_instance.get("priority") != requested_data.get("priority"):
-            if requested_data.get("priority") == None:
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=current_instance.get("parent"),
-                        new_value=requested_data.get("parent"),
-                        field="priority",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the priority to None",
-                    )
-                )
-            else:
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=current_instance.get("priority"),
-                        new_value=requested_data.get("priority"),
-                        field="priority",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the priority to {requested_data.get('priority')}",
-                    )
-                )
-
-    # Track chnages in state of the issue
-    def track_state(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if current_instance.get("state") != requested_data.get("state"):
-
-            new_state = State.objects.get(pk=requested_data.get("state", None))
-            old_state = State.objects.get(pk=current_instance.get("state", None))
-
-            issue_activities.append(
-                IssueActivity(
-                    issue_id=issue_id,
-                    actor=actor,
-                    verb="updated",
-                    old_value=old_state.name,
-                    new_value=new_state.name,
-                    field="state",
-                    project=project,
-                    workspace=project.workspace,
-                    comment=f"{actor.email} updated the state to {new_state.name}",
-                    old_identifier=old_state.id,
-                    new_identifier=new_state.id,
-                )
-            )
-
-    # Track issue description
-    def track_description(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if current_instance.get("description_html") != requested_data.get("description_html"):
-
-            issue_activities.append(
-                IssueActivity(
-                    issue_id=issue_id,
-                    actor=actor,
-                    verb="updated",
-                    old_value=current_instance.get("description_html"),
-                    new_value=requested_data.get("description_html"),
-                    field="description",
-                    project=project,
-                    workspace=project.workspace,
-                    comment=f"{actor.email} updated the description to {requested_data.get('description_html')}",
-                )
-            )
-
-    # Track changes in issue target date
-    def track_target_date(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if current_instance.get("target_date") != requested_data.get("target_date"):
-            if requested_data.get("target_date") == None:
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=current_instance.get("target_date"),
-                        new_value=requested_data.get("target_date"),
-                        field="target_date",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the target date to None",
-                    )
-                )
-            else:
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=current_instance.get("target_date"),
-                        new_value=requested_data.get("target_date"),
-                        field="target_date",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the target date to {requested_data.get('target_date')}",
-                    )
-                )
-
-    # Track changes in issue start date
-    def track_start_date(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if current_instance.get("start_date") != requested_data.get("start_date"):
-            if requested_data.get("start_date") == None:
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=current_instance.get("start_date"),
-                        new_value=requested_data.get("start_date"),
-                        field="start_date",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the start date to None",
-                    )
-                )
-            else:
-                issue_activities.append(
-                    IssueActivity(
-                        issue_id=issue_id,
-                        actor=actor,
-                        verb="updated",
-                        old_value=current_instance.get("start_date"),
-                        new_value=requested_data.get("start_date"),
-                        field="start_date",
-                        project=project,
-                        workspace=project.workspace,
-                        comment=f"{actor.email} updated the start date to {requested_data.get('start_date')}",
-                    )
-                )
-
-    # Track changes in issue labels
-    def track_labels(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        # Label Addition
-        if len(requested_data.get("labels_list")) > len(current_instance.get("labels")):
-
-            for label in requested_data.get("labels_list"):
-                if label not in current_instance.get("labels"):
-                    label = Label.objects.get(pk=label)
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value="",
-                            new_value=label.name,
-                            field="labels",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} added label {label.name}",
-                            new_identifier=label.id,
-                            old_identifier=None,
-                        )
-                    )
-
-        # Label Removal
-        if len(requested_data.get("labels_list")) < len(current_instance.get("labels")):
-
-            for label in current_instance.get("labels"):
-                if label not in requested_data.get("labels_list"):
-                    label = Label.objects.get(pk=label)
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value=label.name,
-                            new_value="",
-                            field="labels",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} removed label {label.name}",
-                            old_identifier=label.id,
-                            new_identifier=None,
-                        )
-                    )
-
-    # Track changes in issue assignees
-    def track_assignees(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-
-        # Assignee Addition
-        if len(requested_data.get("assignees_list")) > len(
-            current_instance.get("assignees")
-        ):
-
-            for assignee in requested_data.get("assignees_list"):
-                if assignee not in current_instance.get("assignees"):
-                    assignee = User.objects.get(pk=assignee)
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value="",
-                            new_value=assignee.email,
-                            field="assignees",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} added assignee {assignee.email}",
-                            new_identifier=actor.id,
-                        )
-                    )
-
-        # Assignee Removal
-        if len(requested_data.get("assignees_list")) < len(
-            current_instance.get("assignees")
-        ):
-
-            for assignee in current_instance.get("assignees"):
-                if assignee not in requested_data.get("assignees_list"):
-                    assignee = User.objects.get(pk=assignee)
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value=assignee.email,
-                            new_value="",
-                            field="assignee",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} removed assignee {assignee.email}",
-                            old_identifier=actor.id,
-                        )
-                    )
-
-    # Track changes in blocking issues
-    def track_blocks(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if len(requested_data.get("blocks_list")) > len(
-            current_instance.get("blocked_issues")
-        ):
-
-            for block in requested_data.get("blocks_list"):
-                if (
-                    len(
-                        [
-                            blocked
-                            for blocked in current_instance.get("blocked_issues")
-                            if blocked.get("block") == block
-                        ]
-                    )
-                    == 0
-                ):
-                    issue = Issue.objects.get(pk=block)
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value="",
-                            new_value=f"{project.identifier}-{issue.sequence_id}",
-                            field="blocks",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} added blocking issue {project.identifier}-{issue.sequence_id}",
-                            new_identifier=issue.id,
-                        )
-                    )
-
-        # Blocked Issue Removal
-        if len(requested_data.get("blocks_list")) < len(
-            current_instance.get("blocked_issues")
-        ):
-
-            for blocked in current_instance.get("blocked_issues"):
-                if blocked.get("block") not in requested_data.get("blocks_list"):
-                    issue = Issue.objects.get(pk=blocked.get("block"))
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value=f"{project.identifier}-{issue.sequence_id}",
-                            new_value="",
-                            field="blocks",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} removed blocking issue {project.identifier}-{issue.sequence_id}",
-                            old_identifier=issue.id,
-                        )
-                    )
-
-    # Track changes in blocked_by issues
-    def track_blockings(
-        self,
-        requested_data,
-        current_instance,
-        issue_id,
-        project,
-        actor,
-        issue_activities,
-    ):
-        if len(requested_data.get("blockers_list")) > len(
-            current_instance.get("blocker_issues")
-        ):
-
-            for block in requested_data.get("blockers_list"):
-                if (
-                    len(
-                        [
-                            blocked
-                            for blocked in current_instance.get("blocker_issues")
-                            if blocked.get("blocked_by") == block
-                        ]
-                    )
-                    == 0
-                ):
-                    issue = Issue.objects.get(pk=block)
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value="",
-                            new_value=f"{project.identifier}-{issue.sequence_id}",
-                            field="blocking",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} added blocked by issue {project.identifier}-{issue.sequence_id}",
-                            new_identifier=issue.id,
-                        )
-                    )
-
-        # Blocked Issue Removal
-        if len(requested_data.get("blockers_list")) < len(
-            current_instance.get("blocker_issues")
-        ):
-
-            for blocked in current_instance.get("blocker_issues"):
-                if blocked.get("blocked_by") not in requested_data.get("blockers_list"):
-                    issue = Issue.objects.get(pk=blocked.get("blocked_by"))
-                    issue_activities.append(
-                        IssueActivity(
-                            issue_id=issue_id,
-                            actor=actor,
-                            verb="updated",
-                            old_value=f"{project.identifier}-{issue.sequence_id}",
-                            new_value="",
-                            field="blocking",
-                            project=project,
-                            workspace=project.workspace,
-                            comment=f"{actor.email} removed blocked by issue {project.identifier}-{issue.sequence_id}",
-                            old_identifier=issue.id,
-                        )
-                    )
-
-    # Receive message from room group
-    def issue_activity(self, event):
-
-        issue_activities = []
-        # Remove event type:
-        event.pop("type")
-
-        requested_data = json.loads(event.get("requested_data"))
-        current_instance = json.loads(event.get("current_instance"))
-        issue_id = event.get("issue_id")
-        actor_id = event.get("actor_id")
-        project_id = event.get("project_id")
-
-        actor = User.objects.get(pk=actor_id)
-
-        project = Project.objects.get(pk=project_id)
-
-        ISSUE_ACTIVITY_MAPPER = {
-            "name": self.track_name,
-            "parent": self.track_parent,
-            "priority": self.track_priority,
-            "state": self.track_state,
-            "description": self.track_description,
-            "target_date": self.track_target_date,
-            "start_date": self.track_start_date,
-            "labels_list": self.track_labels,
-            "assignees_list": self.track_assignees,
-            "blocks_list": self.track_blocks,
-            "blockers_list": self.track_blockings,
-        }
-
-        for key in requested_data:
-            func = ISSUE_ACTIVITY_MAPPER.get(key, None)
-            if func is not None:
-                func(
-                    requested_data,
-                    current_instance,
-                    issue_id,
-                    project,
-                    actor,
-                    issue_activities,
-                )
-        
-        # Save all the values to database
-        IssueActivity.objects.bulk_create(issue_activities)

apiserver/plane/api/middleware/api_authentication.py

@@ -0,0 +1,50 @@
+# Django imports
+from django.utils import timezone
+from django.db.models import Q
+
+# Third party imports
+from rest_framework import authentication
+from rest_framework.exceptions import AuthenticationFailed
+
+# Module imports
+from plane.db.models import APIToken
+
+
+class APIKeyAuthentication(authentication.BaseAuthentication):
+    """
+    Authentication with an API Key
+    """
+
+    www_authenticate_realm = "api"
+    media_type = "application/json"
+    auth_header_name = "X-Api-Key"
+
+    def get_api_token(self, request):
+        return request.headers.get(self.auth_header_name)
+
+    def validate_api_token(self, token):
+        try:
+            api_token = APIToken.objects.get(
+                Q(
+                    Q(expired_at__gt=timezone.now())
+                    | Q(expired_at__isnull=True)
+                ),
+                token=token,
+                is_active=True,
+            )
+        except APIToken.DoesNotExist:
+            raise AuthenticationFailed("Given API token is not valid")
+
+        # save api token last used
+        api_token.last_used = timezone.now()
+        api_token.save(update_fields=["last_used"])
+        return (api_token.user, api_token.token)
+
+    def authenticate(self, request):
+        token = self.get_api_token(request=request)
+        if not token:
+            return None
+
+        # Validate the API token
+        user, token = self.validate_api_token(token)
+        return user, token

apiserver/plane/api/permissions/__init__.py

@@ -1,2 +0,0 @@
-from .workspace import WorkSpaceBasePermission, WorkSpaceAdminPermission
-from .project import ProjectBasePermission, ProjectEntityPermission, ProjectMemberPermission

apiserver/plane/api/permissions/project.py

@@ -1,63 +0,0 @@
-# Third Party imports
-from rest_framework.permissions import BasePermission, SAFE_METHODS
-
-# Module import
-from plane.db.models import WorkspaceMember, ProjectMember
-
-
-class ProjectBasePermission(BasePermission):
-    def has_permission(self, request, view):
-
-        if request.user.is_anonymous:
-            return False
-
-        ## Safe Methods -> Handle the filtering logic in queryset
-        if request.method in SAFE_METHODS:
-            return True
-        ## Only workspace owners or admins can create the projects
-        if request.method == "POST":
-            return WorkspaceMember.objects.filter(
-                workspace=view.workspace, member=request.user, role__in=[15, 20]
-            ).exists()
-
-        ## Only Project Admins can update project attributes
-        return ProjectMember.objects.filter(
-            workspace=view.workspace, member=request.user, role=20
-        ).exists()
-
-
-class ProjectMemberPermission(BasePermission):
-    def has_permission(self, request, view):
-
-        if request.user.is_anonymous:
-            return False
-
-        ## Safe Methods -> Handle the filtering logic in queryset
-        if request.method in SAFE_METHODS:
-            return True
-        ## Only workspace owners or admins can create the projects
-        if request.method == "POST":
-            return WorkspaceMember.objects.filter(
-                workspace=view.workspace, member=request.user, role__in=[15, 20]
-            ).exists()
-
-        ## Only Project Admins can update project attributes
-        return ProjectMember.objects.filter(
-            workspace=view.workspace, member=request.user, role__in=[15, 20]
-        ).exists()
-
-
-class ProjectEntityPermission(BasePermission):
-    def has_permission(self, request, view):
-
-        if request.user.is_anonymous:
-            return False
-    
-        ## Safe Methods -> Handle the filtering logic in queryset
-        if request.method in SAFE_METHODS:
-            return True
-        ## Only workspace owners or admins can create the projects
-
-        return ProjectMember.objects.filter(
-            workspace=view.workspace, member=request.user, role__in=[15, 20]
-        ).exists()

apiserver/plane/api/permissions/workspace.py

@@ -1,43 +0,0 @@
-# Third Party imports
-from rest_framework.permissions import BasePermission, SAFE_METHODS
-
-# Module imports
-from plane.db.models import WorkspaceMember, ProjectMember
-
-
-# TODO: Move the below logic to python match - python v3.10
-class WorkSpaceBasePermission(BasePermission):
-    def has_permission(self, request, view):
-        # allow anyone to create a workspace
-        if request.user.is_anonymous:
-            return False
-
-        if request.method == "POST":
-            return True
-
-        ## Safe Methods
-        if request.method in SAFE_METHODS:
-            return True
-
-        # allow only admins and owners to update the workspace settings
-        if request.method in ["PUT", "PATCH"]:
-            return WorkspaceMember.objects.filter(
-                member=request.user, workspace=view.workspace, role__in=[15, 20]
-            ).exists()
-
-        # allow only owner to delete the workspace
-        if request.method == "DELETE":
-            return WorkspaceMember.objects.filter(
-                member=request.user, workspace=view.workspace, role=20
-            ).exists()
-
-
-class WorkSpaceAdminPermission(BasePermission):
-    def has_permission(self, request, view):
-
-        if request.user.is_anonymous:
-            return False
-
-        return WorkspaceMember.objects.filter(
-            member=request.user, workspace=view.workspace, role__in=[15, 20]
-        ).exists()

apiserver/plane/api/rate_limit.py

@@ -0,0 +1,42 @@
+from rest_framework.throttling import SimpleRateThrottle
+
+
+class ApiKeyRateThrottle(SimpleRateThrottle):
+    scope = "api_key"
+    rate = "60/minute"
+
+    def get_cache_key(self, request, view):
+        # Retrieve the API key from the request header
+        api_key = request.headers.get("X-Api-Key")
+        if not api_key:
+            return None  # Allow the request if there's no API key
+
+        # Use the API key as part of the cache key
+        return f"{self.scope}:{api_key}"
+
+    def allow_request(self, request, view):
+        allowed = super().allow_request(request, view)
+
+        if allowed:
+            now = self.timer()
+            # Calculate the remaining limit and reset time
+            history = self.cache.get(self.key, [])
+
+            # Remove old histories
+            while history and history[-1] <= now - self.duration:
+                history.pop()
+
+            # Calculate the requests
+            num_requests = len(history)
+
+            # Check available requests
+            available = self.num_requests - num_requests
+
+            # Unix timestamp for when the rate limit will reset
+            reset_time = int(now + self.duration)
+
+            # Add headers
+            request.META["X-RateLimit-Remaining"] = max(0, available)
+            request.META["X-RateLimit-Reset"] = reset_time
+
+        return allowed

apiserver/plane/api/serializers/__init__.py

@@ -1,42 +1,21 @@
-from .base import BaseSerializer
-from .people import (
-    ChangePasswordSerializer,
-    ResetPasswordSerializer,
-    TokenSerializer,
-)
-from .user import UserSerializer, UserLiteSerializer
-from .workspace import (
-    WorkSpaceSerializer,
-    WorkSpaceMemberSerializer,
-    TeamSerializer,
-    WorkSpaceMemberInviteSerializer,
-)
-from .project import (
-    ProjectSerializer,
-    ProjectDetailSerializer,
-    ProjectMemberSerializer,
-    ProjectMemberInviteSerializer,
-    ProjectIdentifierSerializer,
-)
-from .state import StateSerializer
-from .shortcut import ShortCutSerializer
-from .view import ViewSerializer
-from .cycle import CycleSerializer, CycleIssueSerializer
-from .asset import FileAssetSerializer
+from .user import UserLiteSerializer
+from .workspace import WorkspaceLiteSerializer
+from .project import ProjectSerializer, ProjectLiteSerializer
 from .issue import (
-    IssueCreateSerializer,
-    IssueActivitySerializer,
-    IssueCommentSerializer,
-    TimeLineIssueSerializer,
-    IssuePropertySerializer,
-    IssueLabelSerializer,
-    BlockerIssueSerializer,
-    BlockedIssueSerializer,
-    IssueAssigneeSerializer,
-    LabelSerializer,
     IssueSerializer,
-    IssueFlatSerializer,
-    IssueStateSerializer,
+    LabelSerializer,
+    IssueLinkSerializer,
+    IssueAttachmentSerializer,
+    IssueCommentSerializer,
+    IssueAttachmentSerializer,
+    IssueActivitySerializer,
+    IssueExpandSerializer,
 )
-
-from .module import ModuleWriteSerializer, ModuleSerializer, ModuleIssueSerializer
+from .state import StateLiteSerializer, StateSerializer
+from .cycle import CycleSerializer, CycleIssueSerializer, CycleLiteSerializer
+from .module import (
+    ModuleSerializer,
+    ModuleIssueSerializer,
+    ModuleLiteSerializer,
+)
+from .inbox import InboxIssueSerializer

apiserver/plane/api/serializers/base.py

@@ -1,5 +1,107 @@
+# Third party imports
 from rest_framework import serializers
 
 
 class BaseSerializer(serializers.ModelSerializer):
     id = serializers.PrimaryKeyRelatedField(read_only=True)
+
+    def __init__(self, *args, **kwargs):
+        # If 'fields' is provided in the arguments, remove it and store it separately.
+        # This is done so as not to pass this custom argument up to the superclass.
+        fields = kwargs.pop("fields", [])
+        self.expand = kwargs.pop("expand", []) or []
+
+        # Call the initialization of the superclass.
+        super().__init__(*args, **kwargs)
+
+        # If 'fields' was provided, filter the fields of the serializer accordingly.
+        if fields:
+            self.fields = self._filter_fields(fields=fields)
+
+    def _filter_fields(self, fields):
+        """
+        Adjust the serializer's fields based on the provided 'fields' list.
+
+        :param fields: List or dictionary specifying which fields to include in the serializer.
+        :return: The updated fields for the serializer.
+        """
+        # Check each field_name in the provided fields.
+        for field_name in fields:
+            # If the field is a dictionary (indicating nested fields),
+            # loop through its keys and values.
+            if isinstance(field_name, dict):
+                for key, value in field_name.items():
+                    # If the value of this nested field is a list,
+                    # perform a recursive filter on it.
+                    if isinstance(value, list):
+                        self._filter_fields(self.fields[key], value)
+
+        # Create a list to store allowed fields.
+        allowed = []
+        for item in fields:
+            # If the item is a string, it directly represents a field's name.
+            if isinstance(item, str):
+                allowed.append(item)
+            # If the item is a dictionary, it represents a nested field.
+            # Add the key of this dictionary to the allowed list.
+            elif isinstance(item, dict):
+                allowed.append(list(item.keys())[0])
+
+        # Convert the current serializer's fields and the allowed fields to sets.
+        existing = set(self.fields)
+        allowed = set(allowed)
+
+        # Remove fields from the serializer that aren't in the 'allowed' list.
+        for field_name in existing - allowed:
+            self.fields.pop(field_name)
+
+        return self.fields
+
+    def to_representation(self, instance):
+        response = super().to_representation(instance)
+
+        # Ensure 'expand' is iterable before processing
+        if self.expand:
+            for expand in self.expand:
+                if expand in self.fields:
+                    # Import all the expandable serializers
+                    from . import (
+                        WorkspaceLiteSerializer,
+                        ProjectLiteSerializer,
+                        UserLiteSerializer,
+                        StateLiteSerializer,
+                        IssueSerializer,
+                    )
+
+                    # Expansion mapper
+                    expansion = {
+                        "user": UserLiteSerializer,
+                        "workspace": WorkspaceLiteSerializer,
+                        "project": ProjectLiteSerializer,
+                        "default_assignee": UserLiteSerializer,
+                        "project_lead": UserLiteSerializer,
+                        "state": StateLiteSerializer,
+                        "created_by": UserLiteSerializer,
+                        "issue": IssueSerializer,
+                        "actor": UserLiteSerializer,
+                        "owned_by": UserLiteSerializer,
+                        "members": UserLiteSerializer,
+                    }
+                    # Check if field in expansion  then expand the field
+                    if expand in expansion:
+                        if isinstance(response.get(expand), list):
+                            exp_serializer = expansion[expand](
+                                getattr(instance, expand), many=True
+                            )
+                        else:
+                            exp_serializer = expansion[expand](
+                                getattr(instance, expand)
+                            )
+                        response[expand] = exp_serializer.data
+                    else:
+                        # You might need to handle this case differently
+                        response[expand] = getattr(
+                            instance, f"{expand}_id", None
+                        )
+
+        return response

apiserver/plane/api/serializers/cycle.py

@@ -1,18 +1,42 @@
+# Third party imports
+from rest_framework import serializers
+
 # Module imports
 from .base import BaseSerializer
-from .user import UserLiteSerializer
-from .issue import IssueStateSerializer
 from plane.db.models import Cycle, CycleIssue
 
 
 class CycleSerializer(BaseSerializer):
+    total_issues = serializers.IntegerField(read_only=True)
+    cancelled_issues = serializers.IntegerField(read_only=True)
+    completed_issues = serializers.IntegerField(read_only=True)
+    started_issues = serializers.IntegerField(read_only=True)
+    unstarted_issues = serializers.IntegerField(read_only=True)
+    backlog_issues = serializers.IntegerField(read_only=True)
+    total_estimates = serializers.IntegerField(read_only=True)
+    completed_estimates = serializers.IntegerField(read_only=True)
+    started_estimates = serializers.IntegerField(read_only=True)
 
-    owned_by = UserLiteSerializer(read_only=True)
+    def validate(self, data):
+        if (
+            data.get("start_date", None) is not None
+            and data.get("end_date", None) is not None
+            and data.get("start_date", None) > data.get("end_date", None)
+        ):
+            raise serializers.ValidationError(
+                "Start date cannot exceed end date"
+            )
+        return data
 
     class Meta:
         model = Cycle
         fields = "__all__"
         read_only_fields = [
+            "id",
+            "created_at",
+            "updated_at",
+            "created_by",
+            "updated_by",
             "workspace",
             "project",
             "owned_by",
@@ -20,8 +44,7 @@ class CycleSerializer(BaseSerializer):
 
 
 class CycleIssueSerializer(BaseSerializer):
-
-    issue_detail = IssueStateSerializer(read_only=True, source="issue")
+    sub_issues_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = CycleIssue
@@ -31,3 +54,9 @@ class CycleIssueSerializer(BaseSerializer):
             "project",
             "cycle",
         ]
+
+
+class CycleLiteSerializer(BaseSerializer):
+    class Meta:
+        model = Cycle
+        fields = "__all__"

apiserver/plane/api/serializers/inbox.py

@@ -0,0 +1,19 @@
+# Module improts
+from .base import BaseSerializer
+from plane.db.models import InboxIssue
+
+
+class InboxIssueSerializer(BaseSerializer):
+    class Meta:
+        model = InboxIssue
+        fields = "__all__"
+        read_only_fields = [
+            "id",
+            "workspace",
+            "project",
+            "issue",
+            "created_by",
+            "updated_by",
+            "created_at",
+            "updated_at",
+        ]

apiserver/plane/api/serializers/issue.py

@@ -1,97 +1,54 @@
-# Third Party imports
+from lxml import html
+
+
+# Django imports
+from django.utils import timezone
+
+#  Third party imports
 from rest_framework import serializers
 
 # Module imports
-from .base import BaseSerializer
-from .user import UserLiteSerializer
-from .state import StateSerializer
-from .user import UserLiteSerializer
-from .project import ProjectSerializer
-from .workspace import WorkSpaceSerializer
 from plane.db.models import (
     User,
     Issue,
-    IssueActivity,
-    IssueComment,
-    TimelineIssue,
-    IssueProperty,
-    IssueBlocker,
+    State,
     IssueAssignee,
-    IssueLabel,
     Label,
-    IssueBlocker,
-    CycleIssue,
-    Cycle,
-    Module,
-    ModuleIssue,
+    IssueLabel,
+    IssueLink,
+    IssueComment,
+    IssueAttachment,
+    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 IssueFlatSerializer(BaseSerializer):
-    ## Contain only flat fields
-
-    class Meta:
-        model = Issue
-        fields = [
-            "id",
-            "name",
-            "description",
-            "priority",
-            "start_date",
-            "target_date",
-            "sequence_id",
-        ]
-
-
-# Issue Serializer with state details
-class IssueStateSerializer(BaseSerializer):
-
-    state_detail = StateSerializer(read_only=True, source="state")
-    project_detail = ProjectSerializer(read_only=True, source="project")
-
-    class Meta:
-        model = Issue
-        fields = "__all__"
-
-
-##TODO: Find a better way to write this serializer
-## Find a better approach to save manytomany?
-class IssueCreateSerializer(BaseSerializer):
-
-    state_detail = StateSerializer(read_only=True, source="state")
-    created_by_detail = UserLiteSerializer(read_only=True, source="created_by")
-    project_detail = ProjectSerializer(read_only=True, source="project")
-    workspace_detail = WorkSpaceSerializer(read_only=True, source="workspace")
-
-    assignees_list = serializers.ListField(
-        child=serializers.PrimaryKeyRelatedField(queryset=User.objects.all()),
+class IssueSerializer(BaseSerializer):
+    assignees = serializers.ListField(
+        child=serializers.PrimaryKeyRelatedField(
+            queryset=User.objects.values_list("id", flat=True)
+        ),
         write_only=True,
         required=False,
     )
 
-    # List of issues that are blocking this issue
-    blockers_list = serializers.ListField(
-        child=serializers.PrimaryKeyRelatedField(queryset=Issue.objects.all()),
-        write_only=True,
-        required=False,
-    )
-    labels_list = serializers.ListField(
-        child=serializers.PrimaryKeyRelatedField(queryset=Label.objects.all()),
-        write_only=True,
-        required=False,
-    )
-
-    # List of issues that are blocked by this issue
-    blocks_list = serializers.ListField(
-        child=serializers.PrimaryKeyRelatedField(queryset=Issue.objects.all()),
+    labels = serializers.ListField(
+        child=serializers.PrimaryKeyRelatedField(
+            queryset=Label.objects.values_list("id", flat=True)
+        ),
         write_only=True,
         required=False,
     )
 
     class Meta:
         model = Issue
-        fields = "__all__"
         read_only_fields = [
+            "id",
             "workspace",
             "project",
             "created_by",
@@ -99,76 +56,124 @@ class IssueCreateSerializer(BaseSerializer):
             "created_at",
             "updated_at",
         ]
+        exclude = [
+            "description",
+            "description_stripped",
+        ]
 
-    def create(self, validated_data):
-        blockers = validated_data.pop("blockers_list", None)
-        assignees = validated_data.pop("assignees_list", None)
-        labels = validated_data.pop("labels_list", None)
-        blocks = validated_data.pop("blocks_list", None)
-
-        project = self.context["project"]
-        issue = Issue.objects.create(**validated_data, project=project)
-
-        if blockers is not None:
-            IssueBlocker.objects.bulk_create(
-                [
-                    IssueBlocker(
-                        block=issue,
-                        blocked_by=blocker,
-                        project=project,
-                        workspace=project.workspace,
-                        created_by=issue.created_by,
-                        updated_by=issue.updated_by,
-                    )
-                    for blocker in blockers
-                ],
-                batch_size=10,
+    def validate(self, data):
+        if (
+            data.get("start_date", None) is not None
+            and data.get("target_date", None) is not None
+            and data.get("start_date", None) > data.get("target_date", None)
+        ):
+            raise serializers.ValidationError(
+                "Start date cannot exceed target date"
             )
 
-        if assignees is not None:
+        try:
+            if data.get("description_html", None) is not None:
+                parsed = html.fromstring(data["description_html"])
+                parsed_str = html.tostring(parsed, encoding="unicode")
+                data["description_html"] = parsed_str
+
+        except Exception as e:
+            raise serializers.ValidationError(f"Invalid HTML: {str(e)}")
+
+        # Validate assignees are from project
+        if data.get("assignees", []):
+            data["assignees"] = ProjectMember.objects.filter(
+                project_id=self.context.get("project_id"),
+                is_active=True,
+                member_id__in=data["assignees"],
+            ).values_list("member_id", flat=True)
+
+        # Validate labels are from project
+        if data.get("labels", []):
+            data["labels"] = Label.objects.filter(
+                project_id=self.context.get("project_id"),
+                id__in=data["labels"],
+            ).values_list("id", flat=True)
+
+        # Check state is from the project only else raise validation error
+        if (
+            data.get("state")
+            and not State.objects.filter(
+                project_id=self.context.get("project_id"),
+                pk=data.get("state").id,
+            ).exists()
+        ):
+            raise serializers.ValidationError(
+                "State is not valid please pass a valid state_id"
+            )
+
+        # Check parent issue is from workspace as it can be cross workspace
+        if (
+            data.get("parent")
+            and not Issue.objects.filter(
+                workspace_id=self.context.get("workspace_id"),
+                pk=data.get("parent").id,
+            ).exists()
+        ):
+            raise serializers.ValidationError(
+                "Parent is not valid issue_id please pass a valid issue_id"
+            )
+
+        return data
+
+    def create(self, validated_data):
+        assignees = validated_data.pop("assignees", None)
+        labels = validated_data.pop("labels", None)
+
+        project_id = self.context["project_id"]
+        workspace_id = self.context["workspace_id"]
+        default_assignee_id = self.context["default_assignee_id"]
+
+        issue = Issue.objects.create(**validated_data, project_id=project_id)
+
+        # Issue Audit Users
+        created_by_id = issue.created_by_id
+        updated_by_id = issue.updated_by_id
+
+        if assignees is not None and len(assignees):
             IssueAssignee.objects.bulk_create(
                 [
                     IssueAssignee(
-                        assignee=user,
+                        assignee_id=assignee_id,
                         issue=issue,
-                        project=project,
-                        workspace=project.workspace,
-                        created_by=issue.created_by,
-                        updated_by=issue.updated_by,
+                        project_id=project_id,
+                        workspace_id=workspace_id,
+                        created_by_id=created_by_id,
+                        updated_by_id=updated_by_id,
                     )
-                    for user in assignees
+                    for assignee_id in assignees
                 ],
                 batch_size=10,
             )
+        else:
+            # Then assign it to default assignee
+            if default_assignee_id is not None:
+                IssueAssignee.objects.create(
+                    assignee_id=default_assignee_id,
+                    issue=issue,
+                    project_id=project_id,
+                    workspace_id=workspace_id,
+                    created_by_id=created_by_id,
+                    updated_by_id=updated_by_id,
+                )
 
-        if labels is not None:
+        if labels is not None and len(labels):
             IssueLabel.objects.bulk_create(
                 [
                     IssueLabel(
-                        label=label,
+                        label_id=label_id,
                         issue=issue,
-                        project=project,
-                        workspace=project.workspace,
-                        created_by=issue.created_by,
-                        updated_by=issue.updated_by,
+                        project_id=project_id,
+                        workspace_id=workspace_id,
+                        created_by_id=created_by_id,
+                        updated_by_id=updated_by_id,
                     )
-                    for label in labels
-                ],
-                batch_size=10,
-            )
-
-        if blocks is not None:
-            IssueBlocker.objects.bulk_create(
-                [
-                    IssueBlocker(
-                        block=block,
-                        blocked_by=issue,
-                        project=project,
-                        workspace=project.workspace,
-                        created_by=issue.created_by,
-                        updated_by=issue.updated_by,
-                    )
-                    for block in blocks
+                    for label_id in labels
                 ],
                 batch_size=10,
             )
@@ -176,42 +181,28 @@ class IssueCreateSerializer(BaseSerializer):
         return issue
 
     def update(self, instance, validated_data):
+        assignees = validated_data.pop("assignees", None)
+        labels = validated_data.pop("labels", None)
 
-        blockers = validated_data.pop("blockers_list", None)
-        assignees = validated_data.pop("assignees_list", None)
-        labels = validated_data.pop("labels_list", None)
-        blocks = validated_data.pop("blocks_list", None)
-
-        if blockers is not None:
-            IssueBlocker.objects.filter(block=instance).delete()
-            IssueBlocker.objects.bulk_create(
-                [
-                    IssueBlocker(
-                        block=instance,
-                        blocked_by=blocker,
-                        project=instance.project,
-                        workspace=instance.project.workspace,
-                        created_by=instance.created_by,
-                        updated_by=instance.updated_by,
-                    )
-                    for blocker in blockers
-                ],
-                batch_size=10,
-            )
+        # Related models
+        project_id = instance.project_id
+        workspace_id = instance.workspace_id
+        created_by_id = instance.created_by_id
+        updated_by_id = instance.updated_by_id
 
         if assignees is not None:
             IssueAssignee.objects.filter(issue=instance).delete()
             IssueAssignee.objects.bulk_create(
                 [
                     IssueAssignee(
-                        assignee=user,
+                        assignee_id=assignee_id,
                         issue=instance,
-                        project=instance.project,
-                        workspace=instance.project.workspace,
-                        created_by=instance.created_by,
-                        updated_by=instance.updated_by,
+                        project_id=project_id,
+                        workspace_id=workspace_id,
+                        created_by_id=created_by_id,
+                        updated_by_id=updated_by_id,
                     )
-                    for user in assignees
+                    for assignee_id in assignees
                 ],
                 batch_size=10,
             )
@@ -221,91 +212,46 @@ class IssueCreateSerializer(BaseSerializer):
             IssueLabel.objects.bulk_create(
                 [
                     IssueLabel(
-                        label=label,
+                        label_id=label_id,
                         issue=instance,
-                        project=instance.project,
-                        workspace=instance.project.workspace,
-                        created_by=instance.created_by,
-                        updated_by=instance.updated_by,
+                        project_id=project_id,
+                        workspace_id=workspace_id,
+                        created_by_id=created_by_id,
+                        updated_by_id=updated_by_id,
                     )
-                    for label in labels
-                ],
-                batch_size=10,
-            )
-
-        if blocks is not None:
-            IssueBlocker.objects.filter(blocked_by=instance).delete()
-            IssueBlocker.objects.bulk_create(
-                [
-                    IssueBlocker(
-                        block=block,
-                        blocked_by=instance,
-                        project=instance.project,
-                        workspace=instance.project.workspace,
-                        created_by=instance.created_by,
-                        updated_by=instance.updated_by,
-                    )
-                    for block in blocks
+                    for label_id in labels
                 ],
                 batch_size=10,
             )
 
+        # Time updation occues even when other related models are updated
+        instance.updated_at = timezone.now()
         return super().update(instance, validated_data)
 
+    def to_representation(self, instance):
+        data = super().to_representation(instance)
+        if "assignees" in self.fields:
+            if "assignees" in self.expand:
+                from .user import UserLiteSerializer
 
-class IssueActivitySerializer(BaseSerializer):
+                data["assignees"] = UserLiteSerializer(
+                    instance.assignees.all(), many=True
+                ).data
+            else:
+                data["assignees"] = [
+                    str(assignee.id) for assignee in instance.assignees.all()
+                ]
+        if "labels" in self.fields:
+            if "labels" in self.expand:
+                data["labels"] = LabelSerializer(
+                    instance.labels.all(), many=True
+                ).data
+            else:
+                data["labels"] = [
+                    str(label.id) for label in instance.labels.all()
+                ]
 
-    actor_detail = UserLiteSerializer(read_only=True, source="actor")
-
-    class Meta:
-        model = IssueActivity
-        fields = "__all__"
-
-
-class IssueCommentSerializer(BaseSerializer):
-
-    actor_detail = UserLiteSerializer(read_only=True, source="actor")
-    issue_detail = IssueFlatSerializer(read_only=True, source="issue")
-    project_detail = ProjectSerializer(read_only=True, source="project")
-
-    class Meta:
-        model = IssueComment
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
-            "issue",
-            "created_by",
-            "updated_by",
-            "created_at",
-            "updated_at",
-        ]
-
-
-class TimeLineIssueSerializer(BaseSerializer):
-    class Meta:
-        model = TimelineIssue
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
-            "issue",
-            "created_by",
-            "updated_by",
-            "created_at",
-            "updated_at",
-        ]
-
-
-class IssuePropertySerializer(BaseSerializer):
-    class Meta:
-        model = IssueProperty
-        fields = "__all__"
-        read_only_fields = [
-            "user",
-            "workspace",
-            "project",
-        ]
+        return data
 
 
 class LabelSerializer(BaseSerializer):
@@ -313,56 +259,7 @@ class LabelSerializer(BaseSerializer):
         model = Label
         fields = "__all__"
         read_only_fields = [
-            "workspace",
-            "project",
-        ]
-
-
-class IssueLabelSerializer(BaseSerializer):
-
-    # label_details = LabelSerializer(read_only=True, source="label")
-
-    class Meta:
-        model = IssueLabel
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
-        ]
-
-
-class BlockedIssueSerializer(BaseSerializer):
-
-    blocked_issue_detail = IssueFlatSerializer(source="block", read_only=True)
-
-    class Meta:
-        model = IssueBlocker
-        fields = "__all__"
-
-
-class BlockerIssueSerializer(BaseSerializer):
-
-    blocker_issue_detail = IssueFlatSerializer(source="blocked_by", read_only=True)
-
-    class Meta:
-        model = IssueBlocker
-        fields = "__all__"
-
-
-class IssueAssigneeSerializer(BaseSerializer):
-
-    assignee_details = UserLiteSerializer(read_only=True, source="assignee")
-
-    class Meta:
-        model = IssueAssignee
-        fields = "__all__"
-
-
-class CycleBaseSerializer(BaseSerializer):
-    class Meta:
-        model = Cycle
-        fields = "__all__"
-        read_only_fields = [
+            "id",
             "workspace",
             "project",
             "created_by",
@@ -372,16 +269,42 @@ class CycleBaseSerializer(BaseSerializer):
         ]
 
 
-class IssueCycleDetailSerializer(BaseSerializer):
-
-    cycle_detail = CycleBaseSerializer(read_only=True, source="cycle")
-
+class IssueLinkSerializer(BaseSerializer):
     class Meta:
-        model = CycleIssue
+        model = IssueLink
         fields = "__all__"
         read_only_fields = [
+            "id",
             "workspace",
             "project",
+            "issue",
+            "created_by",
+            "updated_by",
+            "created_at",
+            "updated_at",
+        ]
+
+    # Validation if url already exists
+    def create(self, validated_data):
+        if IssueLink.objects.filter(
+            url=validated_data.get("url"),
+            issue_id=validated_data.get("issue_id"),
+        ).exists():
+            raise serializers.ValidationError(
+                {"error": "URL already exists for this Issue"}
+            )
+        return IssueLink.objects.create(**validated_data)
+
+
+class IssueAttachmentSerializer(BaseSerializer):
+    class Meta:
+        model = IssueAttachment
+        fields = "__all__"
+        read_only_fields = [
+            "id",
+            "workspace",
+            "project",
+            "issue",
             "created_by",
             "updated_by",
             "created_at",
@@ -389,54 +312,87 @@ class IssueCycleDetailSerializer(BaseSerializer):
         ]
 
 
-class ModuleBaseSerializer(BaseSerializer):
+class IssueCommentSerializer(BaseSerializer):
+    is_member = serializers.BooleanField(read_only=True)
+
     class Meta:
-        model = Module
-        fields = "__all__"
+        model = IssueComment
         read_only_fields = [
+            "id",
             "workspace",
             "project",
+            "issue",
             "created_by",
             "updated_by",
             "created_at",
             "updated_at",
         ]
+        exclude = [
+            "comment_stripped",
+            "comment_json",
+        ]
+
+    def validate(self, data):
+        try:
+            if data.get("comment_html", None) is not None:
+                parsed = html.fromstring(data["comment_html"])
+                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
 
 
-class IssueModuleDetailSerializer(BaseSerializer):
-
-    module_detail = ModuleBaseSerializer(read_only=True, source="module")
-
+class IssueActivitySerializer(BaseSerializer):
     class Meta:
-        model = ModuleIssue
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
+        model = IssueActivity
+        exclude = [
             "created_by",
             "updated_by",
-            "created_at",
-            "updated_at",
         ]
 
 
-class IssueSerializer(BaseSerializer):
-    project_detail = ProjectSerializer(read_only=True, source="project")
-    state_detail = StateSerializer(read_only=True, source="state")
-    parent_detail = IssueFlatSerializer(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)
-    # List of issues blocked by this issue
-    blocked_issues = BlockedIssueSerializer(read_only=True, many=True)
-    # List of issues that block this issue
-    blocker_issues = BlockerIssueSerializer(read_only=True, many=True)
-    issue_cycle = IssueCycleDetailSerializer(read_only=True)
-    issue_module = IssueModuleDetailSerializer(read_only=True)
+class CycleIssueSerializer(BaseSerializer):
+    cycle = CycleSerializer(read_only=True)
+
+    class Meta:
+        fields = [
+            "cycle",
+        ]
+
+
+class ModuleIssueSerializer(BaseSerializer):
+    module = ModuleSerializer(read_only=True)
+
+    class Meta:
+        fields = [
+            "module",
+        ]
+
+
+class LabelLiteSerializer(BaseSerializer):
+    class Meta:
+        model = Label
+        fields = [
+            "id",
+            "name",
+            "color",
+        ]
+
+
+class IssueExpandSerializer(BaseSerializer):
+    cycle = CycleLiteSerializer(source="issue_cycle.cycle", read_only=True)
+    module = ModuleLiteSerializer(source="issue_module.module", read_only=True)
+    labels = LabelLiteSerializer(read_only=True, many=True)
+    assignees = UserLiteSerializer(read_only=True, many=True)
+    state = StateLiteSerializer(read_only=True)
 
     class Meta:
         model = Issue
         fields = "__all__"
         read_only_fields = [
+            "id",
             "workspace",
             "project",
             "created_by",

apiserver/plane/api/serializers/module.py

@@ -1,38 +1,38 @@
-# Third Party imports
+# Third party imports
 from rest_framework import serializers
 
 # Module imports
 from .base import BaseSerializer
-from .user import UserLiteSerializer
-from .project import ProjectSerializer
-from .issue import IssueStateSerializer
-
-from plane.db.models import User, Module, ModuleMember, ModuleIssue, ModuleLink
+from plane.db.models import (
+    User,
+    Module,
+    ModuleLink,
+    ModuleMember,
+    ModuleIssue,
+    ProjectMember,
+)
 
 
-class LinkCreateSerializer(serializers.Serializer):
-
-    url = serializers.CharField(required=True)
-    title = serializers.CharField(required=False)
-
-
-class ModuleWriteSerializer(BaseSerializer):
-
-    members_list = serializers.ListField(
-        child=serializers.PrimaryKeyRelatedField(queryset=User.objects.all()),
-        write_only=True,
-        required=False,
-    )
-    links_list = serializers.ListField(
-        child=LinkCreateSerializer(),
+class ModuleSerializer(BaseSerializer):
+    members = serializers.ListField(
+        child=serializers.PrimaryKeyRelatedField(
+            queryset=User.objects.values_list("id", flat=True)
+        ),
         write_only=True,
         required=False,
     )
+    total_issues = serializers.IntegerField(read_only=True)
+    cancelled_issues = serializers.IntegerField(read_only=True)
+    completed_issues = serializers.IntegerField(read_only=True)
+    started_issues = serializers.IntegerField(read_only=True)
+    unstarted_issues = serializers.IntegerField(read_only=True)
+    backlog_issues = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = Module
         fields = "__all__"
         read_only_fields = [
+            "id",
             "workspace",
             "project",
             "created_by",
@@ -41,23 +41,44 @@ class ModuleWriteSerializer(BaseSerializer):
             "updated_at",
         ]
 
+    def to_representation(self, instance):
+        data = super().to_representation(instance)
+        data["members"] = [str(member.id) for member in instance.members.all()]
+        return data
+
+    def validate(self, data):
+        if (
+            data.get("start_date", None) is not None
+            and data.get("target_date", None) is not None
+            and data.get("start_date", None) > data.get("target_date", None)
+        ):
+            raise serializers.ValidationError(
+                "Start date cannot exceed target date"
+            )
+
+        if data.get("members", []):
+            data["members"] = ProjectMember.objects.filter(
+                project_id=self.context.get("project_id"),
+                member_id__in=data["members"],
+            ).values_list("member_id", flat=True)
+
+        return data
+
     def create(self, validated_data):
+        members = validated_data.pop("members", None)
 
-        members = validated_data.pop("members_list", None)
-        links = validated_data.pop("links_list", None)
-
-        project = self.context["project"]
-
-        module = Module.objects.create(**validated_data, project=project)
+        project_id = self.context["project_id"]
+        workspace_id = self.context["workspace_id"]
 
+        module = Module.objects.create(**validated_data, project_id=project_id)
         if members is not None:
             ModuleMember.objects.bulk_create(
                 [
                     ModuleMember(
                         module=module,
-                        member=member,
-                        project=project,
-                        workspace=project.workspace,
+                        member_id=str(member),
+                        project_id=project_id,
+                        workspace_id=workspace_id,
                         created_by=module.created_by,
                         updated_by=module.updated_by,
                     )
@@ -67,38 +88,18 @@ class ModuleWriteSerializer(BaseSerializer):
                 ignore_conflicts=True,
             )
 
-        if links is not None:
-            ModuleLink.objects.bulk_create(
-                [
-                    ModuleLink(
-                        module=module,
-                        project=project,
-                        workspace=project.workspace,
-                        created_by=module.created_by,
-                        updated_by=module.updated_by,
-                        title=link.get("title", None),
-                        url=link.get("url", None),
-                    )
-                    for link in links
-                ],
-                batch_size=10,
-                ignore_conflicts=True,
-            )
-
         return module
 
     def update(self, instance, validated_data):
-
-        members = validated_data.pop("members_list", None)
-        links = validated_data.pop("links_list", None)
+        members = validated_data.pop("members", None)
 
         if members is not None:
-            ModuleIssue.objects.filter(module=instance).delete()
+            ModuleMember.objects.filter(module=instance).delete()
             ModuleMember.objects.bulk_create(
                 [
                     ModuleMember(
                         module=instance,
-                        member=member,
+                        member_id=str(member),
                         project=instance.project,
                         workspace=instance.project.workspace,
                         created_by=instance.created_by,
@@ -110,46 +111,11 @@ class ModuleWriteSerializer(BaseSerializer):
                 ignore_conflicts=True,
             )
 
-        if links is not None:
-            ModuleLink.objects.filter(module=instance).delete()
-            ModuleLink.objects.bulk_create(
-                [
-                    ModuleLink(
-                        module=instance,
-                        project=instance.project,
-                        workspace=instance.project.workspace,
-                        created_by=instance.created_by,
-                        updated_by=instance.updated_by,
-                        title=link.get("title", None),
-                        url=link.get("url", None),
-                    )
-                    for link in links
-                ],
-                batch_size=10,
-                ignore_conflicts=True,
-            )
-
         return super().update(instance, validated_data)
 
 
-class ModuleFlatSerializer(BaseSerializer):
-    class Meta:
-        model = Module
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
-            "created_by",
-            "updated_by",
-            "created_at",
-            "updated_at",
-        ]
-
-
 class ModuleIssueSerializer(BaseSerializer):
-
-    module_detail = ModuleFlatSerializer(read_only=True, source="module")
-    issue_detail = IssueStateSerializer(read_only=True, source="issue")
+    sub_issues_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = ModuleIssue
@@ -166,9 +132,6 @@ class ModuleIssueSerializer(BaseSerializer):
 
 
 class ModuleLinkSerializer(BaseSerializer):
-
-    created_by_detail = UserLiteSerializer(read_only=True, source="created_by")
-
     class Meta:
         model = ModuleLink
         fields = "__all__"
@@ -179,25 +142,22 @@ class ModuleLinkSerializer(BaseSerializer):
             "updated_by",
             "created_at",
             "updated_at",
+            "module",
         ]
 
+    # Validation if url already exists
+    def create(self, validated_data):
+        if ModuleLink.objects.filter(
+            url=validated_data.get("url"),
+            module_id=validated_data.get("module_id"),
+        ).exists():
+            raise serializers.ValidationError(
+                {"error": "URL already exists for this Issue"}
+            )
+        return ModuleLink.objects.create(**validated_data)
 
-class ModuleSerializer(BaseSerializer):
-
-    project_detail = ProjectSerializer(read_only=True, source="project")
-    lead_detail = UserLiteSerializer(read_only=True, source="lead")
-    members_detail = UserLiteSerializer(read_only=True, many=True, source="members")
-    issue_module = ModuleIssueSerializer(read_only=True, many=True)
-    link_module = ModuleLinkSerializer(read_only=True, many=True)
 
+class ModuleLiteSerializer(BaseSerializer):
     class Meta:
         model = Module
         fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
-            "created_by",
-            "updated_by",
-            "created_at",
-            "updated_at",
-        ]

apiserver/plane/api/serializers/people.py

@@ -1,57 +0,0 @@
-from rest_framework.serializers import (
-    ModelSerializer,
-    Serializer,
-    CharField,
-    SerializerMethodField,
-)
-from rest_framework.authtoken.models import Token
-from rest_framework_simplejwt.tokens import RefreshToken
-
-
-from plane.db.models import User
-
-
-class UserSerializer(ModelSerializer):
-    class Meta:
-        model = User
-        fields = "__all__"
-        extra_kwargs = {"password": {"write_only": True}}
-
-
-class ChangePasswordSerializer(Serializer):
-    model = User
-
-    """
-    Serializer for password change endpoint.
-    """
-    old_password = CharField(required=True)
-    new_password = CharField(required=True)
-
-
-class ResetPasswordSerializer(Serializer):
-    model = User
-
-    """
-    Serializer for password change endpoint.
-    """
-    new_password = CharField(required=True)
-    confirm_password = CharField(required=True)
-
-
-class TokenSerializer(ModelSerializer):
-
-    user = UserSerializer()
-    access_token = SerializerMethodField()
-    refresh_token = SerializerMethodField()
-
-    def get_access_token(self, obj):
-        refresh_token = RefreshToken.for_user(obj.user)
-        return str(refresh_token.access_token)
-
-    def get_refresh_token(self, obj):
-        refresh_token = RefreshToken.for_user(obj.user)
-        return str(refresh_token)
-
-    class Meta:
-        model = Token
-        fields = "__all__"

apiserver/plane/api/serializers/project.py

@@ -1,38 +1,80 @@
-# Django imports
-from django.db import IntegrityError
-
 # Third party imports
 from rest_framework import serializers
 
 # Module imports
-from .base import BaseSerializer
-from plane.api.serializers.workspace import WorkSpaceSerializer
-from plane.api.serializers.user import UserLiteSerializer
 from plane.db.models import (
     Project,
-    ProjectMember,
-    ProjectMemberInvite,
     ProjectIdentifier,
+    WorkspaceMember,
+    State,
+    Estimate,
 )
+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)
+    is_member = serializers.BooleanField(read_only=True)
+    sort_order = serializers.FloatField(read_only=True)
+    member_role = serializers.IntegerField(read_only=True)
+    is_deployed = serializers.BooleanField(read_only=True)
+
     class Meta:
         model = Project
         fields = "__all__"
         read_only_fields = [
+            "id",
+            "emoji",
             "workspace",
+            "created_at",
+            "updated_at",
+            "created_by",
+            "updated_by",
         ]
 
+    def validate(self, data):
+        # Check project lead should be a member of the workspace
+        if (
+            data.get("project_lead", None) is not None
+            and not WorkspaceMember.objects.filter(
+                workspace_id=self.context["workspace_id"],
+                member_id=data.get("project_lead"),
+            ).exists()
+        ):
+            raise serializers.ValidationError(
+                "Project lead should be a user in the workspace"
+            )
+
+        # Check default assignee should be a member of the workspace
+        if (
+            data.get("default_assignee", None) is not None
+            and not WorkspaceMember.objects.filter(
+                workspace_id=self.context["workspace_id"],
+                member_id=data.get("default_assignee"),
+            ).exists()
+        ):
+            raise serializers.ValidationError(
+                "Default assignee should be a user in the workspace"
+            )
+
+        return data
+
     def create(self, validated_data):
         identifier = validated_data.get("identifier", "").strip().upper()
         if identifier == "":
-            raise serializers.ValidationError(detail="Project Identifier is required")
+            raise serializers.ValidationError(
+                detail="Project Identifier is required"
+            )
 
         if ProjectIdentifier.objects.filter(
             name=identifier, workspace_id=self.context["workspace_id"]
         ).exists():
-            raise serializers.ValidationError(detail="Project Identifier is taken")
+            raise serializers.ValidationError(
+                detail="Project Identifier is taken"
+            )
+
         project = Project.objects.create(
             **validated_data, workspace_id=self.context["workspace_id"]
         )
@@ -43,68 +85,17 @@ class ProjectSerializer(BaseSerializer):
         )
         return project
 
-    def update(self, instance, validated_data):
-
-        identifier = validated_data.get("identifier", "").strip().upper()
-
-        # If identifier is not passed update the project and return
-        if identifier == "":
-            project = super().update(instance, validated_data)
-            return project
-
-        # If no Project Identifier is found create it
-        project_identifier = ProjectIdentifier.objects.filter(
-            name=identifier, workspace_id=instance.workspace_id
-        ).first()
-
-        if project_identifier is None:
-            project = super().update(instance, validated_data)
-            _ = ProjectIdentifier.objects.update(name=identifier, project=project)
-            return project
-
-        # If found check if the project_id to be updated and identifier project id is same
-        if project_identifier.project_id == instance.id:
-            # If same pass update
-            project = super().update(instance, validated_data)
-            return project
-
-        # If not same fail update
-        raise serializers.ValidationError(detail="Project Identifier is already taken")
-
-
-class ProjectDetailSerializer(BaseSerializer):
-
-    workspace = WorkSpaceSerializer(read_only=True)
-    default_assignee = UserLiteSerializer(read_only=True)
-    project_lead = UserLiteSerializer(read_only=True)
 
+class ProjectLiteSerializer(BaseSerializer):
     class Meta:
         model = Project
-        fields = "__all__"
-
-
-class ProjectMemberSerializer(BaseSerializer):
-
-    workspace = WorkSpaceSerializer(read_only=True)
-    project = ProjectSerializer(read_only=True)
-    member = UserLiteSerializer(read_only=True)
-
-    class Meta:
-        model = ProjectMember
-        fields = "__all__"
-
-
-class ProjectMemberInviteSerializer(BaseSerializer):
-
-    project = ProjectSerializer(read_only=True)
-    workspace = WorkSpaceSerializer(read_only=True)
-
-    class Meta:
-        model = ProjectMemberInvite
-        fields = "__all__"
-
-
-class ProjectIdentifierSerializer(BaseSerializer):
-    class Meta:
-        model = ProjectIdentifier
-        fields = "__all__"
+        fields = [
+            "id",
+            "identifier",
+            "name",
+            "cover_image",
+            "icon_prop",
+            "emoji",
+            "description",
+        ]
+        read_only_fields = fields

apiserver/plane/api/serializers/shortcut.py

@@ -1,14 +0,0 @@
-# Module imports
-from .base import BaseSerializer
-
-from plane.db.models import Shortcut
-
-
-class ShortCutSerializer(BaseSerializer):
-    class Meta:
-        model = Shortcut
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
-        ]

apiserver/plane/api/serializers/state.py

@@ -1,14 +1,38 @@
 # Module imports
 from .base import BaseSerializer
-
 from plane.db.models import State
 
 
 class StateSerializer(BaseSerializer):
+    def validate(self, data):
+        # If the default is being provided then make all other states default False
+        if data.get("default", False):
+            State.objects.filter(
+                project_id=self.context.get("project_id")
+            ).update(default=False)
+        return data
+
     class Meta:
         model = State
         fields = "__all__"
         read_only_fields = [
+            "id",
+            "created_by",
+            "updated_by",
+            "created_at",
+            "updated_at",
             "workspace",
             "project",
         ]
+
+
+class StateLiteSerializer(BaseSerializer):
+    class Meta:
+        model = State
+        fields = [
+            "id",
+            "name",
+            "color",
+            "group",
+        ]
+        read_only_fields = fields

apiserver/plane/api/serializers/user.py

@@ -1,28 +1,6 @@
-# Module import
-from .base import BaseSerializer
+# Module imports
 from plane.db.models import User
-
-
-class UserSerializer(BaseSerializer):
-    class Meta:
-        model = User
-        fields = "__all__"
-        read_only_fields = [
-            "id",
-            "created_at",
-            "updated_at",
-            "is_superuser",
-            "is_staff",
-            "last_active",
-            "last_login_time",
-            "last_logout_time",
-            "last_login_ip",
-            "last_logout_ip",
-            "last_login_uagent",
-            "token_updated_at",
-            "is_onboarded",
-        ]
-        extra_kwargs = {"password": {"write_only": True}}
+from .base import BaseSerializer
 
 
 class UserLiteSerializer(BaseSerializer):
@@ -32,9 +10,7 @@ class UserLiteSerializer(BaseSerializer):
             "id",
             "first_name",
             "last_name",
-            "email",
             "avatar",
+            "display_name",
         ]
-        read_only_fields = [
-            "id",
-        ]
+        read_only_fields = fields

apiserver/plane/api/serializers/view.py

@@ -1,14 +0,0 @@
-# Module imports
-from .base import BaseSerializer
-
-from plane.db.models import View
-
-
-class ViewSerializer(BaseSerializer):
-    class Meta:
-        model = View
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "project",
-        ]

apiserver/plane/api/serializers/workspace.py

@@ -1,95 +1,16 @@
-# Third party imports
-from rest_framework import serializers
-
 # Module imports
+from plane.db.models import Workspace
 from .base import BaseSerializer
-from .user import UserLiteSerializer
-
-from plane.db.models import User, Workspace, WorkspaceMember, Team, TeamMember
-from plane.db.models import Workspace, WorkspaceMember, Team, WorkspaceMemberInvite
 
 
-class WorkSpaceSerializer(BaseSerializer):
-
-    owner = UserLiteSerializer(read_only=True)
-    total_members = serializers.IntegerField(read_only=True)
+class WorkspaceLiteSerializer(BaseSerializer):
+    """Lite serializer with only required fields"""
 
     class Meta:
         model = Workspace
-        fields = "__all__"
-        read_only_fields = [
+        fields = [
+            "name",
+            "slug",
             "id",
-            "created_by",
-            "updated_by",
-            "created_at",
-            "updated_at",
-            "owner",
         ]
-
-
-class WorkSpaceMemberSerializer(BaseSerializer):
-
-    member = UserLiteSerializer(read_only=True)
-    workspace = WorkSpaceSerializer(read_only=True)
-
-    class Meta:
-        model = WorkspaceMember
-        fields = "__all__"
-
-
-class WorkSpaceMemberInviteSerializer(BaseSerializer):
-
-    workspace = WorkSpaceSerializer(read_only=True)
-
-    class Meta:
-        model = WorkspaceMemberInvite
-        fields = "__all__"
-
-
-class TeamSerializer(BaseSerializer):
-
-    members_detail = UserLiteSerializer(read_only=True, source="members", many=True)
-    members = serializers.ListField(
-        child=serializers.PrimaryKeyRelatedField(queryset=User.objects.all()),
-        write_only=True,
-        required=False,
-    )
-
-    class Meta:
-        model = Team
-        fields = "__all__"
-        read_only_fields = [
-            "workspace",
-            "created_by",
-            "updated_by",
-            "created_at",
-            "updated_at",
-        ]
-
-    def create(self, validated_data, **kwargs):
-        if "members" in validated_data:
-            members = validated_data.pop("members")
-            workspace = self.context["workspace"]
-            team = Team.objects.create(**validated_data, workspace=workspace)
-            team_members = [
-                TeamMember(member=member, team=team, workspace=workspace)
-                for member in members
-            ]
-            TeamMember.objects.bulk_create(team_members, batch_size=10)
-            return team
-        else:
-            team = Team.objects.create(**validated_data)
-            return team
-
-    def update(self, instance, validated_data):
-        if "members" in validated_data:
-            members = validated_data.pop("members")
-            TeamMember.objects.filter(team=instance).delete()
-            team_members = [
-                TeamMember(member=member, team=instance, workspace=instance.workspace)
-                for member in members
-            ]
-            TeamMember.objects.bulk_create(team_members, batch_size=10)
-            return super().update(instance, validated_data)
-        else:
-            return super().update(instance, validated_data)
+        read_only_fields = fields

apiserver/plane/api/urls.py

@@ -1,662 +0,0 @@
-from django.urls import path
-
-
-# Create your urls here.
-
-from plane.api.views import (
-    SignInEndpoint,
-    SignOutEndpoint,
-    MagicSignInEndpoint,
-    MagicSignInGenerateEndpoint,
-    ForgotPasswordEndpoint,
-    PeopleEndpoint,
-    UserEndpoint,
-    VerifyEmailEndpoint,
-    ResetPasswordEndpoint,
-    RequestEmailVerificationEndpoint,
-    OauthEndpoint,
-    ChangePasswordEndpoint,
-)
-
-from plane.api.views import (
-    UserWorkspaceInvitationsEndpoint,
-    WorkSpaceViewSet,
-    UserWorkSpacesEndpoint,
-    InviteWorkspaceEndpoint,
-    JoinWorkspaceEndpoint,
-    WorkSpaceMemberViewSet,
-    WorkspaceInvitationsViewset,
-    UserWorkspaceInvitationsEndpoint,
-    ProjectViewSet,
-    InviteProjectEndpoint,
-    ProjectMemberViewSet,
-    ProjectMemberInvitationsViewset,
-    StateViewSet,
-    ShortCutViewSet,
-    ViewViewSet,
-    CycleViewSet,
-    FileAssetEndpoint,
-    IssueViewSet,
-    WorkSpaceIssuesEndpoint,
-    IssueActivityEndpoint,
-    IssueCommentViewSet,
-    TeamMemberViewSet,
-    TimeLineIssueViewSet,
-    CycleIssueViewSet,
-    IssuePropertyViewSet,
-    UpdateUserOnBoardedEndpoint,
-    UserWorkspaceInvitationEndpoint,
-    UserProjectInvitationsViewset,
-    ProjectIdentifierEndpoint,
-    LabelViewSet,
-    AddMemberToProjectEndpoint,
-    ProjectJoinEndpoint,
-    BulkDeleteIssuesEndpoint,
-    ProjectUserViewsEndpoint,
-    ModuleViewSet,
-    ModuleIssueViewSet,
-    UserLastProjectWithWorkspaceEndpoint,
-    UserWorkSpaceIssues,
-    ProjectMemberUserEndpoint,
-    WorkspaceMemberUserEndpoint,
-    WorkspaceMemberUserViewsEndpoint,
-    WorkSpaceAvailabilityCheckEndpoint,
-)
-
-from plane.api.views.project import AddTeamToProjectEndpoint
-
-
-urlpatterns = [
-    #  Social Auth
-    path("social-auth/", OauthEndpoint.as_view(), name="oauth"),
-    # Auth
-    path("sign-in/", SignInEndpoint.as_view(), name="sign-in"),
-    path("sign-out/", SignOutEndpoint.as_view(), name="sign-out"),
-    # Magic Sign In/Up
-    path(
-        "magic-generate/", MagicSignInGenerateEndpoint.as_view(), name="magic-generate"
-    ),
-    path("magic-sign-in/", MagicSignInEndpoint.as_view(), name="magic-sign-in"),
-    # Email verification
-    path("email-verify/", VerifyEmailEndpoint.as_view(), name="email-verify"),
-    path(
-        "request-email-verify/",
-        RequestEmailVerificationEndpoint.as_view(),
-        name="request-reset-email",
-    ),
-    # Password Manipulation
-    path(
-        "password-reset/<uidb64>/<token>/",
-        ResetPasswordEndpoint.as_view(),
-        name="password-reset",
-    ),
-    path(
-        "forgot-password/",
-        ForgotPasswordEndpoint.as_view(),
-        name="forgot-password",
-    ),
-    # List Users
-    path("users/", PeopleEndpoint.as_view()),
-    # User Profile
-    path(
-        "users/me/",
-        UserEndpoint.as_view(
-            {"get": "retrieve", "patch": "partial_update", "delete": "destroy"}
-        ),
-        name="users",
-    ),
-    path(
-        "users/me/change-password/",
-        ChangePasswordEndpoint.as_view(),
-        name="change-password",
-    ),
-    path(
-        "users/me/onboard/",
-        UpdateUserOnBoardedEndpoint.as_view(),
-        name="change-password",
-    ),
-    # user workspaces
-    path(
-        "users/me/workspaces/",
-        UserWorkSpacesEndpoint.as_view(),
-        name="user-workspace",
-    ),
-    # user workspace invitations
-    path(
-        "users/me/invitations/workspaces/",
-        UserWorkspaceInvitationsEndpoint.as_view({"get": "list", "post": "create"}),
-        name="user-workspace-invitations",
-    ),
-    # user workspace invitation
-    path(
-        "users/me/invitations/<uuid:pk>/",
-        UserWorkspaceInvitationEndpoint.as_view(
-            {
-                "get": "retrieve",
-            }
-        ),
-        name="workspace",
-    ),
-    # user join workspace
-    path(
-        "users/me/invitations/workspaces/<str:slug>/<uuid:pk>/join/",
-        JoinWorkspaceEndpoint.as_view(),
-        name="user-join-workspace",
-    ),
-    # user project invitations
-    path(
-        "users/me/invitations/projects/",
-        UserProjectInvitationsViewset.as_view({"get": "list", "post": "create"}),
-        name="user-project-invitaions",
-    ),
-    ## Workspaces ##
-    path(
-        "workspace-slug-check/",
-        WorkSpaceAvailabilityCheckEndpoint.as_view(),
-        name="workspace-availability",
-    ),
-    path(
-        "workspaces/",
-        WorkSpaceViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/",
-        WorkSpaceViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/invite/",
-        InviteWorkspaceEndpoint.as_view(),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/invitations/",
-        WorkspaceInvitationsViewset.as_view({"get": "list"}),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/invitations/<uuid:pk>/",
-        WorkspaceInvitationsViewset.as_view(
-            {
-                "delete": "destroy",
-                "get": "retrieve",
-                "get": "retrieve",
-            }
-        ),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/members/",
-        WorkSpaceMemberViewSet.as_view({"get": "list"}),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/members/<uuid:pk>/",
-        WorkSpaceMemberViewSet.as_view(
-            {
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-                "get": "retrieve",
-            }
-        ),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/teams/",
-        TeamMemberViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/teams/<uuid:pk>/",
-        TeamMemberViewSet.as_view(
-            {
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-                "get": "retrieve",
-            }
-        ),
-        name="workspace",
-    ),
-    path(
-        "users/last-visited-workspace/",
-        UserLastProjectWithWorkspaceEndpoint.as_view(),
-        name="workspace-project-details",
-    ),
-    path(
-        "workspaces/<str:slug>/workspace-members/me/",
-        WorkspaceMemberUserEndpoint.as_view(),
-        name="workspace-member-details",
-    ),
-    path(
-        "workspaces/<str:slug>/workspace-views/",
-        WorkspaceMemberUserViewsEndpoint.as_view(),
-        name="workspace-member-details",
-    ),
-    ## End Workspaces ##
-    # Projects
-    path(
-        "workspaces/<str:slug>/projects/",
-        ProjectViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:pk>/",
-        ProjectViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/project-identifiers/",
-        ProjectIdentifierEndpoint.as_view(),
-        name="project-identifiers",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/invite/",
-        InviteProjectEndpoint.as_view(),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/members/",
-        ProjectMemberViewSet.as_view({"get": "list"}),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/members/<uuid:pk>/",
-        ProjectMemberViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/members/add/",
-        AddMemberToProjectEndpoint.as_view(),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/join/",
-        ProjectJoinEndpoint.as_view(),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/team-invite/",
-        AddTeamToProjectEndpoint.as_view(),
-        name="projects",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/invitations/",
-        ProjectMemberInvitationsViewset.as_view({"get": "list"}),
-        name="workspace",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/invitations/<uuid:pk>/",
-        ProjectMemberInvitationsViewset.as_view(
-            {
-                "get": "retrieve",
-                "delete": "destroy",
-            }
-        ),
-        name="project",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/project-views/",
-        ProjectUserViewsEndpoint.as_view(),
-        name="project-view",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/project-members/me/",
-        ProjectMemberUserEndpoint.as_view(),
-        name="project-view",
-    ),
-    # End Projects
-    #  States
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/states/",
-        StateViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-states",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/states/<uuid:pk>/",
-        StateViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-state",
-    ),
-    # End States ##
-    # Shortcuts
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/shortcuts/",
-        ShortCutViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-shortcut",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/shortcuts/<uuid:pk>/",
-        ShortCutViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-shortcut",
-    ),
-    ## End Shortcuts
-    # Views
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/views/",
-        ViewViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-view",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/views/<uuid:pk>/",
-        ViewViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-view",
-    ),
-    ## End Views
-    ## Cycles
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/",
-        CycleViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-cycle",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:pk>/",
-        CycleViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-cycle",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:cycle_id>/cycle-issues/",
-        CycleIssueViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-cycle",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:cycle_id>/cycle-issues/<uuid:pk>/",
-        CycleIssueViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-cycle",
-    ),
-    ## End Cycles
-    # Issue
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/",
-        IssueViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-issue",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:pk>/",
-        IssueViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-issue",
-    ),
-    path(
-        "workspaces/<str:slug>/issues/",
-        WorkSpaceIssuesEndpoint.as_view(),
-        name="workspace-issue",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issue-labels/",
-        LabelViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-issue-labels",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issue-labels/<uuid:pk>/",
-        LabelViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-issue-labels",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/bulk-delete-issues/",
-        BulkDeleteIssuesEndpoint.as_view(),
-    ),
-    path(
-        "workspaces/<str:slug>/my-issues/",
-        UserWorkSpaceIssues.as_view(),
-        name="workspace-issues",
-    ),
-    ## End Issues
-    ## Issue Activity
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/history/",
-        IssueActivityEndpoint.as_view(),
-        name="project-issue-history",
-    ),
-    ## Issue Activity
-    ## IssueComments
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/comments/",
-        IssueCommentViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-issue-comment",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/comments/<uuid:pk>/",
-        IssueCommentViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-issue-comment",
-    ),
-    ## End IssueComments
-    ## Roadmap
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/roadmaps/",
-        TimeLineIssueViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-issue-roadmap",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/roadmaps/<uuid:pk>/",
-        TimeLineIssueViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-issue-roadmap",
-    ),
-    ## End Roadmap
-    ## IssueProperty
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issue-properties/",
-        IssuePropertyViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-issue-roadmap",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/issue-properties/<uuid:pk>/",
-        IssuePropertyViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-issue-roadmap",
-    ),
-    ## IssueProperty Ebd
-    ## File Assets
-    path(
-        "workspaces/<str:slug>/file-assets/",
-        FileAssetEndpoint.as_view(),
-        name="File Assets",
-    ),
-    ## End File Assets
-    ## Modules
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/",
-        ModuleViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-modules",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/<uuid:pk>/",
-        ModuleViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-modules",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/<uuid:module_id>/module-issues/",
-        ModuleIssueViewSet.as_view(
-            {
-                "get": "list",
-                "post": "create",
-            }
-        ),
-        name="project-module-issues",
-    ),
-    path(
-        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/<uuid:module_id>/module-issues/<uuid:pk>/",
-        ModuleIssueViewSet.as_view(
-            {
-                "get": "retrieve",
-                "put": "update",
-                "patch": "partial_update",
-                "delete": "destroy",
-            }
-        ),
-        name="project-module-issues",
-    ),
-    ## End Modules
-    # path(
-    #     "issues/<int:pk>/all/",
-    #     IssueViewSet.as_view({"get": "list_issue_history_comments"}),
-    #     name="Issue history and comments",
-    # ),
-]

apiserver/plane/api/urls/__init__.py

@@ -0,0 +1,15 @@
+from .project import urlpatterns as project_patterns
+from .state import urlpatterns as state_patterns
+from .issue import urlpatterns as issue_patterns
+from .cycle import urlpatterns as cycle_patterns
+from .module import urlpatterns as module_patterns
+from .inbox import urlpatterns as inbox_patterns
+
+urlpatterns = [
+    *project_patterns,
+    *state_patterns,
+    *issue_patterns,
+    *cycle_patterns,
+    *module_patterns,
+    *inbox_patterns,
+]

apiserver/plane/api/urls/cycle.py

@@ -0,0 +1,35 @@
+from django.urls import path
+
+from plane.api.views.cycle import (
+    CycleAPIEndpoint,
+    CycleIssueAPIEndpoint,
+    TransferCycleIssueAPIEndpoint,
+)
+
+urlpatterns = [
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/",
+        CycleAPIEndpoint.as_view(),
+        name="cycles",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:pk>/",
+        CycleAPIEndpoint.as_view(),
+        name="cycles",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:cycle_id>/cycle-issues/",
+        CycleIssueAPIEndpoint.as_view(),
+        name="cycle-issues",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:cycle_id>/cycle-issues/<uuid:issue_id>/",
+        CycleIssueAPIEndpoint.as_view(),
+        name="cycle-issues",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:cycle_id>/transfer-issues/",
+        TransferCycleIssueAPIEndpoint.as_view(),
+        name="transfer-issues",
+    ),
+]

apiserver/plane/api/urls/inbox.py

@@ -0,0 +1,17 @@
+from django.urls import path
+
+from plane.api.views import InboxIssueAPIEndpoint
+
+
+urlpatterns = [
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/inbox-issues/",
+        InboxIssueAPIEndpoint.as_view(),
+        name="inbox-issue",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/inbox-issues/<uuid:issue_id>/",
+        InboxIssueAPIEndpoint.as_view(),
+        name="inbox-issue",
+    ),
+]

apiserver/plane/api/urls/issue.py

@@ -0,0 +1,62 @@
+from django.urls import path
+
+from plane.api.views import (
+    IssueAPIEndpoint,
+    LabelAPIEndpoint,
+    IssueLinkAPIEndpoint,
+    IssueCommentAPIEndpoint,
+    IssueActivityAPIEndpoint,
+)
+
+urlpatterns = [
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/",
+        IssueAPIEndpoint.as_view(),
+        name="issue",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:pk>/",
+        IssueAPIEndpoint.as_view(),
+        name="issue",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/labels/",
+        LabelAPIEndpoint.as_view(),
+        name="label",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/labels/<uuid:pk>/",
+        LabelAPIEndpoint.as_view(),
+        name="label",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/links/",
+        IssueLinkAPIEndpoint.as_view(),
+        name="link",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/links/<uuid:pk>/",
+        IssueLinkAPIEndpoint.as_view(),
+        name="link",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/comments/",
+        IssueCommentAPIEndpoint.as_view(),
+        name="comment",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/comments/<uuid:pk>/",
+        IssueCommentAPIEndpoint.as_view(),
+        name="comment",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/activities/",
+        IssueActivityAPIEndpoint.as_view(),
+        name="activity",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/issues/<uuid:issue_id>/activities/<uuid:pk>/",
+        IssueActivityAPIEndpoint.as_view(),
+        name="activity",
+    ),
+]

apiserver/plane/api/urls/module.py

@@ -0,0 +1,26 @@
+from django.urls import path
+
+from plane.api.views import ModuleAPIEndpoint, ModuleIssueAPIEndpoint
+
+urlpatterns = [
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/",
+        ModuleAPIEndpoint.as_view(),
+        name="modules",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/<uuid:pk>/",
+        ModuleAPIEndpoint.as_view(),
+        name="modules",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/<uuid:module_id>/module-issues/",
+        ModuleIssueAPIEndpoint.as_view(),
+        name="module-issues",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/modules/<uuid:module_id>/module-issues/<uuid:issue_id>/",
+        ModuleIssueAPIEndpoint.as_view(),
+        name="module-issues",
+    ),
+]

apiserver/plane/api/urls/project.py

@@ -0,0 +1,16 @@
+from django.urls import path
+
+from plane.api.views import ProjectAPIEndpoint
+
+urlpatterns = [
+    path(
+        "workspaces/<str:slug>/projects/",
+        ProjectAPIEndpoint.as_view(),
+        name="project",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/",
+        ProjectAPIEndpoint.as_view(),
+        name="project",
+    ),
+]

apiserver/plane/api/urls/state.py

@@ -0,0 +1,16 @@
+from django.urls import path
+
+from plane.api.views import StateAPIEndpoint
+
+urlpatterns = [
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/states/",
+        StateAPIEndpoint.as_view(),
+        name="states",
+    ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/states/<uuid:state_id>/",
+        StateAPIEndpoint.as_view(),
+        name="states",
+    ),
+]

apiserver/plane/api/views/__init__.py

@@ -1,73 +1,21 @@
-from .project import (
-    ProjectViewSet,
-    ProjectMemberViewSet,
-    UserProjectInvitationsViewset,
-    InviteProjectEndpoint,
-    AddTeamToProjectEndpoint,
-    ProjectMemberInvitationsViewset,
-    ProjectMemberInviteDetailViewSet,
-    ProjectIdentifierEndpoint,
-    AddMemberToProjectEndpoint,
-    ProjectJoinEndpoint,
-    ProjectUserViewsEndpoint,
-    ProjectMemberUserEndpoint,
-)
-from .people import (
-    PeopleEndpoint,
-    UserEndpoint,
-    UpdateUserOnBoardedEndpoint,
-)
+from .project import ProjectAPIEndpoint
 
-from .oauth import OauthEndpoint
+from .state import StateAPIEndpoint
 
-from .base import BaseAPIView, BaseViewSet
-
-from .workspace import (
-    WorkSpaceViewSet,
-    UserWorkSpacesEndpoint,
-    WorkSpaceAvailabilityCheckEndpoint,
-    InviteWorkspaceEndpoint,
-    JoinWorkspaceEndpoint,
-    WorkSpaceMemberViewSet,
-    TeamMemberViewSet,
-    WorkspaceInvitationsViewset,
-    UserWorkspaceInvitationsEndpoint,
-    UserWorkspaceInvitationEndpoint,
-    UserLastProjectWithWorkspaceEndpoint,
-    WorkspaceMemberUserEndpoint,
-    WorkspaceMemberUserViewsEndpoint,
-)
-from .state import StateViewSet
-from .shortcut import ShortCutViewSet
-from .view import ViewViewSet
-from .cycle import CycleViewSet, CycleIssueViewSet
-from .asset import FileAssetEndpoint
 from .issue import (
-    IssueViewSet,
-    WorkSpaceIssuesEndpoint,
-    IssueActivityEndpoint,
-    IssueCommentViewSet,
-    TimeLineIssueViewSet,
-    IssuePropertyViewSet,
-    LabelViewSet,
-    BulkDeleteIssuesEndpoint,
-    UserWorkSpaceIssues,
+    IssueAPIEndpoint,
+    LabelAPIEndpoint,
+    IssueLinkAPIEndpoint,
+    IssueCommentAPIEndpoint,
+    IssueActivityAPIEndpoint,
 )
 
-from .auth_extended import (
-    VerifyEmailEndpoint,
-    RequestEmailVerificationEndpoint,
-    ForgotPasswordEndpoint,
-    ResetPasswordEndpoint,
-    ChangePasswordEndpoint,
+from .cycle import (
+    CycleAPIEndpoint,
+    CycleIssueAPIEndpoint,
+    TransferCycleIssueAPIEndpoint,
 )
 
+from .module import ModuleAPIEndpoint, ModuleIssueAPIEndpoint
 
-from .authentication import (
-    SignInEndpoint,
-    SignOutEndpoint,
-    MagicSignInEndpoint,
-    MagicSignInGenerateEndpoint,
-)
-
-from .module import ModuleViewSet, ModuleIssueViewSet
+from .inbox import InboxIssueAPIEndpoint

apiserver/plane/api/views/asset.py

@@ -1,45 +0,0 @@
-# Third party imports
-from rest_framework import status
-from rest_framework.response import Response
-from rest_framework.parsers import MultiPartParser, FormParser
-from sentry_sdk import capture_exception
-
-# Module imports
-from .base import BaseAPIView
-from plane.db.models import FileAsset, Workspace
-from plane.api.serializers import FileAssetSerializer
-
-
-class FileAssetEndpoint(BaseAPIView):
-
-    parser_classes = (MultiPartParser, FormParser)
-
-    """
-    A viewset for viewing and editing task instances.
-    """
-
-    def get(self, request):
-        files = FileAsset.objects.all()
-        serializer = FileAssetSerializer(files, context={"request": request}, many=True)
-        return Response(serializer.data)
-
-    def post(self, request, slug):
-        try:
-            serializer = FileAssetSerializer(data=request.data)
-            if serializer.is_valid():
-
-                if request.user.last_workspace_id is None:
-                    return Response(
-                        {"error": "Workspace id is required"},
-                        status=status.HTTP_400_BAD_REQUEST,
-                    )
-
-                serializer.save(workspace_id=request.user.last_workspace_id)
-                return Response(serializer.data, status=status.HTTP_201_CREATED)
-            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )

apiserver/plane/api/views/auth_extended.py

@@ -1,159 +0,0 @@
-## Python imports
-import jwt
-
-## Django imports
-from django.contrib.auth.tokens import PasswordResetTokenGenerator
-from django.utils.encoding import (
-    smart_str,
-    smart_bytes,
-    DjangoUnicodeDecodeError,
-)
-from django.utils.http import urlsafe_base64_decode, urlsafe_base64_encode
-from django.contrib.sites.shortcuts import get_current_site
-from django.conf import settings
-
-## Third Party Imports
-from rest_framework import status
-from rest_framework.response import Response
-from rest_framework import permissions
-from rest_framework_simplejwt.tokens import RefreshToken
-
-from sentry_sdk import capture_exception
-
-## Module imports
-from . import BaseAPIView
-from plane.api.serializers.people import (
-    ChangePasswordSerializer,
-    ResetPasswordSerializer,
-)
-from plane.db.models import User
-from plane.bgtasks.email_verification_task import email_verification
-from plane.bgtasks.forgot_password_task import forgot_password
-
-
-class RequestEmailVerificationEndpoint(BaseAPIView):
-    def get(self, request):
-        token = RefreshToken.for_user(request.user).access_token
-        current_site = settings.WEB_URL
-        email_verification.delay(
-            request.user.first_name, request.user.email, token, current_site
-        )
-        return Response(
-            {"message": "Email sent successfully"}, status=status.HTTP_200_OK
-        )
-
-
-class VerifyEmailEndpoint(BaseAPIView):
-    def get(self, request):
-        token = request.GET.get("token")
-        try:
-            payload = jwt.decode(token, settings.SECRET_KEY, algorithms="HS256")
-            user = User.objects.get(id=payload["user_id"])
-
-            if not user.is_email_verified:
-                user.is_email_verified = True
-                user.save()
-            return Response(
-                {"email": "Successfully activated"}, status=status.HTTP_200_OK
-            )
-        except jwt.ExpiredSignatureError as indentifier:
-            return Response(
-                {"email": "Activation expired"}, status=status.HTTP_400_BAD_REQUEST
-            )
-        except jwt.exceptions.DecodeError as indentifier:
-            return Response(
-                {"email": "Invalid token"}, status=status.HTTP_400_BAD_REQUEST
-            )
-
-
-class ForgotPasswordEndpoint(BaseAPIView):
-    permission_classes = [permissions.AllowAny]
-
-    def post(self, request):
-        email = request.data.get("email")
-
-        if User.objects.filter(email=email).exists():
-            user = User.objects.get(email=email)
-            uidb64 = urlsafe_base64_encode(smart_bytes(user.id))
-            token = PasswordResetTokenGenerator().make_token(user)
-
-            current_site = settings.WEB_URL
-
-            forgot_password.delay(
-                user.first_name, user.email, uidb64, token, current_site
-            )
-
-            return Response(
-                {"messgae": "Check your email to reset your password"},
-                status=status.HTTP_200_OK,
-            )
-        return Response(
-            {"error": "Please check the email"}, status=status.HTTP_400_BAD_REQUEST
-        )
-
-
-class ResetPasswordEndpoint(BaseAPIView):
-    permission_classes = [permissions.AllowAny]
-
-    def post(self, request, uidb64, token):
-        try:
-            id = smart_str(urlsafe_base64_decode(uidb64))
-            user = User.objects.get(id=id)
-            if not PasswordResetTokenGenerator().check_token(user, token):
-                return Response(
-                    {"error": "token is not valid, please check the new one"},
-                    status=status.HTTP_401_UNAUTHORIZED,
-                )
-            serializer = ResetPasswordSerializer(data=request.data)
-
-            if serializer.is_valid():
-                # set_password also hashes the password that the user will get
-                user.set_password(serializer.data.get("new_password"))
-                user.save()
-                response = {
-                    "status": "success",
-                    "code": status.HTTP_200_OK,
-                    "message": "Password updated successfully",
-                }
-
-                return Response(response)
-            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
-
-        except DjangoUnicodeDecodeError as indentifier:
-            return Response(
-                {"error": "token is not valid, please check the new one"},
-                status=status.HTTP_401_UNAUTHORIZED,
-            )
-
-
-class ChangePasswordEndpoint(BaseAPIView):
-    def post(self, request):
-        try:
-            serializer = ChangePasswordSerializer(data=request.data)
-
-            user = User.objects.get(pk=request.user.id)
-            if serializer.is_valid():
-                # Check old password
-                if not user.object.check_password(serializer.data.get("old_password")):
-                    return Response(
-                        {"old_password": ["Wrong password."]},
-                        status=status.HTTP_400_BAD_REQUEST,
-                    )
-                # set_password also hashes the password that the user will get
-                self.object.set_password(serializer.data.get("new_password"))
-                self.object.save()
-                response = {
-                    "status": "success",
-                    "code": status.HTTP_200_OK,
-                    "message": "Password updated successfully",
-                }
-
-                return Response(response)
-
-            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )

apiserver/plane/api/views/authentication.py

@@ -1,365 +0,0 @@
-# Python imports
-import uuid
-import random
-import string
-import json
-
-# Django imports
-from django.utils import timezone
-from django.core.exceptions import ValidationError
-from django.core.validators import validate_email
-from django.conf import settings
-
-# Third party imports
-from rest_framework.response import Response
-from rest_framework.permissions import AllowAny
-from rest_framework import status
-from rest_framework_simplejwt.tokens import RefreshToken
-
-from sentry_sdk import capture_exception, capture_message
-
-# Module imports
-from . import BaseAPIView
-from plane.db.models import User
-from plane.api.serializers import UserSerializer
-from plane.settings.redis import redis_instance
-from plane.bgtasks.magic_link_code_task import magic_link
-
-
-def get_tokens_for_user(user):
-    refresh = RefreshToken.for_user(user)
-    return (
-        str(refresh.access_token),
-        str(refresh),
-    )
-
-
-class SignUpEndpoint(BaseAPIView):
-
-    permission_classes = (AllowAny,)
-
-    def post(self, request):
-        try:
-
-            email = request.data.get("email", False)
-            password = request.data.get("password", False)
-
-            ## Raise exception if any of the above are missing
-            if not email or not password:
-                return Response(
-                    {"error": "Both email and password are required"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            email = email.strip().lower()
-
-            try:
-                validate_email(email)
-            except ValidationError as e:
-                return Response(
-                    {"error": "Please provide a valid email address."},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            user = User.objects.filter(email=email).first()
-
-            if user is not None:
-                return Response(
-                    {"error": "Email ID is already taken"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            user = User.objects.create(email=email)
-            user.set_password(password)
-
-            # settings last actives for the user
-            user.last_active = timezone.now()
-            user.last_login_time = timezone.now()
-            user.last_login_ip = request.META.get("REMOTE_ADDR")
-            user.last_login_uagent = request.META.get("HTTP_USER_AGENT")
-            user.token_updated_at = timezone.now()
-            user.save()
-
-            serialized_user = UserSerializer(user).data
-
-            access_token, refresh_token = get_tokens_for_user(user)
-
-            data = {
-                "access_token": access_token,
-                "refresh_token": refresh_token,
-                "user": serialized_user,
-            }
-
-            return Response(data, status=status.HTTP_200_OK)
-
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {
-                    "error": "Something went wrong. Please try again later or contact the support team."
-                },
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class SignInEndpoint(BaseAPIView):
-    permission_classes = (AllowAny,)
-
-    def post(self, request):
-        try:
-            email = request.data.get("email", False)
-            password = request.data.get("password", False)
-
-            ## Raise exception if any of the above are missing
-            if not email or not password:
-                return Response(
-                    {"error": "Both email and password are required"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            email = email.strip().lower()
-
-            try:
-                validate_email(email)
-            except ValidationError as e:
-                return Response(
-                    {"error": "Please provide a valid email address."},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            user = User.objects.get(email=email)
-
-            if not user.check_password(password):
-                return Response(
-                    {
-                        "error": "Sorry, we could not find a user with the provided credentials. Please try again."
-                    },
-                    status=status.HTTP_403_FORBIDDEN,
-                )
-            if not user.is_active:
-                return Response(
-                    {
-                        "error": "Your account has been deactivated. Please contact your site administrator."
-                    },
-                    status=status.HTTP_403_FORBIDDEN,
-                )
-
-            serialized_user = UserSerializer(user).data
-
-            # settings last active for the user
-            user.last_active = timezone.now()
-            user.last_login_time = timezone.now()
-            user.last_login_ip = request.META.get("REMOTE_ADDR")
-            user.last_login_uagent = request.META.get("HTTP_USER_AGENT")
-            user.token_updated_at = timezone.now()
-            user.save()
-
-            access_token, refresh_token = get_tokens_for_user(user)
-
-            data = {
-                "access_token": access_token,
-                "refresh_token": refresh_token,
-                "user": serialized_user,
-            }
-
-            return Response(data, status=status.HTTP_200_OK)
-
-        except User.DoesNotExist:
-            return Response(
-                {
-                    "error": "Sorry, we could not find a user with the provided credentials. Please try again."
-                },
-                status=status.HTTP_403_FORBIDDEN,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {
-                    "error": "Something went wrong. Please try again later or contact the support team."
-                },
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class SignOutEndpoint(BaseAPIView):
-    def post(self, request):
-        try:
-            refresh_token = request.data.get("refresh_token", False)
-
-            if not refresh_token:
-                capture_message("No refresh token provided")
-                return Response(
-                    {
-                        "error": "Something went wrong. Please try again later or contact the support team."
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            user = User.objects.get(pk=request.user.id)
-
-            user.last_logout_time = timezone.now()
-            user.last_logout_ip = request.META.get("REMOTE_ADDR")
-
-            user.save()
-
-            token = RefreshToken(refresh_token)
-            token.blacklist()
-            return Response({"message": "success"}, status=status.HTTP_200_OK)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {
-                    "error": "Something went wrong. Please try again later or contact the support team."
-                },
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class MagicSignInGenerateEndpoint(BaseAPIView):
-
-    permission_classes = [
-        AllowAny,
-    ]
-
-    def post(self, request):
-        try:
-
-            email = request.data.get("email", False)
-
-            if not email:
-                return Response(
-                    {"error": "Please provide a valid email address"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            validate_email(email)
-
-            ## Generate a random token
-            token = (
-                "".join(random.choices(string.ascii_lowercase + string.digits, k=4))
-                + "-"
-                + "".join(random.choices(string.ascii_lowercase + string.digits, k=4))
-                + "-"
-                + "".join(random.choices(string.ascii_lowercase + string.digits, k=4))
-            )
-
-            ri = redis_instance()
-
-            key = "magic_" + str(email)
-
-            # Check if the key already exists in python
-            if ri.exists(key):
-                data = json.loads(ri.get(key))
-
-                current_attempt = data["current_attempt"] + 1
-
-                if data["current_attempt"] > 2:
-                    return Response(
-                        {"error": "Max attempts exhausted. Please try again later."},
-                        status=status.HTTP_400_BAD_REQUEST,
-                    )
-
-                value = {
-                    "current_attempt": current_attempt,
-                    "email": email,
-                    "token": token,
-                }
-                expiry = 600
-
-                ri.set(key, json.dumps(value), ex=expiry)
-
-            else:
-
-                value = {"current_attempt": 0, "email": email, "token": token}
-                expiry = 600
-
-                ri.set(key, json.dumps(value), ex=expiry)
-
-            current_site = settings.WEB_URL
-            magic_link.delay(email, key, token, current_site)
-
-            return Response({"key": key}, status=status.HTTP_200_OK)
-        except ValidationError:
-            return Response(
-                {"error": "Please provide a valid email address."},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class MagicSignInEndpoint(BaseAPIView):
-
-    permission_classes = [
-        AllowAny,
-    ]
-
-    def post(self, request):
-        try:
-
-            user_token = request.data.get("token", "").strip().lower()
-            key = request.data.get("key", False)
-
-            if not key or user_token == "":
-                return Response(
-                    {"error": "User token and key are required"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            ri = redis_instance()
-
-            if ri.exists(key):
-
-                data = json.loads(ri.get(key))
-
-                token = data["token"]
-                email = data["email"]
-
-                if str(token) == str(user_token):
-
-                    if User.objects.filter(email=email).exists():
-                        user = User.objects.get(email=email)
-                    else:
-                        user = User.objects.create(
-                            email=email, username=uuid.uuid4().hex
-                        )
-
-                    user.last_active = timezone.now()
-                    user.last_login_time = timezone.now()
-                    user.last_login_ip = request.META.get("REMOTE_ADDR")
-                    user.last_login_uagent = request.META.get("HTTP_USER_AGENT")
-                    user.token_updated_at = timezone.now()
-                    user.save()
-                    serialized_user = UserSerializer(user).data
-
-                    access_token, refresh_token = get_tokens_for_user(user)
-                    data = {
-                        "access_token": access_token,
-                        "refresh_token": refresh_token,
-                        "user": serialized_user,
-                    }
-
-                    return Response(data, status=status.HTTP_200_OK)
-
-                else:
-                    return Response(
-                        {"error": "Your login code was incorrect. Please try again."},
-                        status=status.HTTP_400_BAD_REQUEST,
-                    )
-
-            else:
-                return Response(
-                    {"error": "The magic code/link has expired please try again"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )

apiserver/plane/api/views/base.py

@@ -1,142 +1,183 @@
-# Django imports
-from django.urls import resolve
-from django.conf import settings
-# Third part imports
-from rest_framework import status
-from rest_framework.viewsets import ModelViewSet
-from rest_framework.exceptions import APIException
-from rest_framework.views import APIView
-from rest_framework.filters import SearchFilter
-from rest_framework.permissions import IsAuthenticated
-from rest_framework.exceptions import NotFound
+# Python imports
+import zoneinfo
+import json
 
-from django_filters.rest_framework import DjangoFilterBackend
+# Django imports
+from django.conf import settings
+from django.db import IntegrityError
+from django.core.exceptions import ObjectDoesNotExist, ValidationError
+from django.utils import timezone
+
+# Third party imports
+from rest_framework.views import APIView
+from rest_framework.response import Response
+from rest_framework.permissions import IsAuthenticated
+from rest_framework import status
+from sentry_sdk import capture_exception
 
 # Module imports
-from plane.db.models import Workspace, Project
+from plane.api.middleware.api_authentication import APIKeyAuthentication
+from plane.api.rate_limit import ApiKeyRateThrottle
 from plane.utils.paginator import BasePaginator
+from plane.bgtasks.webhook_task import send_webhook
 
 
-class BaseViewSet(ModelViewSet, BasePaginator):
+class TimezoneMixin:
+    """
+    This enables timezone conversion according
+    to the user set timezone
+    """
 
-    model = None
+    def initial(self, request, *args, **kwargs):
+        super().initial(request, *args, **kwargs)
+        if request.user.is_authenticated:
+            timezone.activate(zoneinfo.ZoneInfo(request.user.user_timezone))
+        else:
+            timezone.deactivate()
 
-    permission_classes = [
-        IsAuthenticated,
-    ]
 
-    filter_backends = (
-        DjangoFilterBackend,
-        SearchFilter,
-    )
+class WebhookMixin:
+    webhook_event = None
+    bulk = False
 
-    filterset_fields = []
+    def finalize_response(self, request, response, *args, **kwargs):
+        response = super().finalize_response(
+            request, response, *args, **kwargs
+        )
 
-    search_fields = []
-
-    def get_queryset(self):
-        try:
-            return self.model.objects.all()
-        except Exception as e:
-            print(e)
-            raise APIException(
-                "Please check the view", status.HTTP_400_BAD_REQUEST
+        # Check for the case should webhook be sent
+        if (
+            self.webhook_event
+            and self.request.method in ["POST", "PATCH", "DELETE"]
+            and response.status_code in [200, 201, 204]
+        ):
+            # Push the object to delay
+            send_webhook.delay(
+                event=self.webhook_event,
+                payload=response.data,
+                kw=self.kwargs,
+                action=self.request.method,
+                slug=self.workspace_slug,
+                bulk=self.bulk,
             )
 
-    def dispatch(self, request, *args, **kwargs):
-        response = super().dispatch(request, *args, **kwargs)
-
-        if settings.DEBUG:
-            from django.db import connection
-            print(f'# of Queries: {len(connection.queries)}')
         return response
 
-    @property
-    def workspace_slug(self):
-        return self.kwargs.get("slug", None)
 
-    @property
-    def workspace(self):
-        if self.workspace_slug:
-            try:
-                return Workspace.objects.get(slug=self.workspace_slug)
-            except Workspace.DoesNotExist:
-                raise NotFound(detail="Workspace does not exist")
-        else:
-            return None
-
-    @property
-    def project_id(self):
-        project_id = self.kwargs.get("project_id", None)
-        if project_id:
-            return project_id
-
-        if resolve(self.request.path_info).url_name == "project":
-            return self.kwargs.get("pk", None)
-
-    @property
-    def project(self):
-        if self.project_id:
-            try:
-                return Project.objects.get(pk=self.project_id)
-            except Project.DoesNotExist:
-                raise NotFound(detail="Project does not exist")
-        else:
-            return None
-
-
-class BaseAPIView(APIView, BasePaginator):
+class BaseAPIView(TimezoneMixin, APIView, BasePaginator):
+    authentication_classes = [
+        APIKeyAuthentication,
+    ]
 
     permission_classes = [
         IsAuthenticated,
     ]
 
-    filter_backends = (
-        DjangoFilterBackend,
-        SearchFilter,
-    )
-
-    filterset_fields = []
-
-    search_fields = []
+    throttle_classes = [
+        ApiKeyRateThrottle,
+    ]
 
     def filter_queryset(self, queryset):
         for backend in list(self.filter_backends):
             queryset = backend().filter_queryset(self.request, queryset, self)
         return queryset
 
+    def handle_exception(self, exc):
+        """
+        Handle any exception that occurs, by returning an appropriate response,
+        or re-raising the error.
+        """
+        try:
+            response = super().handle_exception(exc)
+            return response
+        except Exception as e:
+            if isinstance(e, IntegrityError):
+                return Response(
+                    {"error": "The payload is not valid"},
+                    status=status.HTTP_400_BAD_REQUEST,
+                )
+
+            if isinstance(e, ValidationError):
+                return Response(
+                    {
+                        "error": "The provided payload is not valid please try with a valid payload"
+                    },
+                    status=status.HTTP_400_BAD_REQUEST,
+                )
+
+            if isinstance(e, ObjectDoesNotExist):
+                return Response(
+                    {"error": f"The required object does not exist."},
+                    status=status.HTTP_404_NOT_FOUND,
+                )
+
+            if isinstance(e, KeyError):
+                return Response(
+                    {"error": f" The required key does not exist."},
+                    status=status.HTTP_400_BAD_REQUEST,
+                )
+
+            if settings.DEBUG:
+                print(e)
+            capture_exception(e)
+            return Response(
+                {"error": "Something went wrong please try again later"},
+                status=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            )
+
     def dispatch(self, request, *args, **kwargs):
-        response = super().dispatch(request, *args, **kwargs)
+        try:
+            response = super().dispatch(request, *args, **kwargs)
+            if settings.DEBUG:
+                from django.db import connection
+
+                print(
+                    f"{request.method} - {request.get_full_path()} of Queries: {len(connection.queries)}"
+                )
+            return response
+        except Exception as exc:
+            response = self.handle_exception(exc)
+            return exc
+
+    def finalize_response(self, request, response, *args, **kwargs):
+        # Call super to get the default response
+        response = super().finalize_response(
+            request, response, *args, **kwargs
+        )
+
+        # Add custom headers if they exist in the request META
+        ratelimit_remaining = request.META.get("X-RateLimit-Remaining")
+        if ratelimit_remaining is not None:
+            response["X-RateLimit-Remaining"] = ratelimit_remaining
+
+        ratelimit_reset = request.META.get("X-RateLimit-Reset")
+        if ratelimit_reset is not None:
+            response["X-RateLimit-Reset"] = ratelimit_reset
 
-        if settings.DEBUG:
-            from django.db import connection
-            print(f'# of Queries: {len(connection.queries)}')
         return response
 
     @property
     def workspace_slug(self):
         return self.kwargs.get("slug", None)
 
-    @property
-    def workspace(self):
-        if self.workspace_slug:
-            try:
-                return Workspace.objects.get(slug=self.workspace_slug)
-            except Workspace.DoesNotExist:
-                raise NotFound(detail="Workspace does not exist")
-        else:
-            return None
-
     @property
     def project_id(self):
         return self.kwargs.get("project_id", None)
 
     @property
-    def project(self):
-        if self.project_id:
-            try:
-                return Project.objects.get(pk=self.project_id)
-            except Project.DoesNotExist:
-                raise NotFound(detail="Project does not exist")
-        else:
-            return None
+    def fields(self):
+        fields = [
+            field
+            for field in self.request.GET.get("fields", "").split(",")
+            if field
+        ]
+        return fields if fields else None
+
+    @property
+    def expand(self):
+        expand = [
+            expand
+            for expand in self.request.GET.get("expand", "").split(",")
+            if expand
+        ]
+        return expand if expand else None

apiserver/plane/api/views/cycle.py

@@ -1,60 +1,353 @@
+# Python imports
+import json
+
+# Django imports
+from django.db.models import Q, Count, Sum, Prefetch, F, OuterRef, Func
+from django.utils import timezone
+from django.core import serializers
+
 # Third party imports
 from rest_framework.response import Response
 from rest_framework import status
-from sentry_sdk import capture_exception
 
 # Module imports
-from . import BaseViewSet
-from plane.api.serializers import CycleSerializer, CycleIssueSerializer
-from plane.api.permissions import ProjectEntityPermission
-from plane.db.models import Cycle, CycleIssue, Issue
+from .base import BaseAPIView, WebhookMixin
+from plane.db.models import (
+    Cycle,
+    Issue,
+    CycleIssue,
+    IssueLink,
+    IssueAttachment,
+)
+from plane.app.permissions import ProjectEntityPermission
+from plane.api.serializers import (
+    CycleSerializer,
+    CycleIssueSerializer,
+)
+from plane.bgtasks.issue_activites_task import issue_activity
 
 
-class CycleViewSet(BaseViewSet):
+class CycleAPIEndpoint(WebhookMixin, BaseAPIView):
+    """
+    This viewset automatically provides `list`, `create`, `retrieve`,
+    `update` and `destroy` actions related to cycle.
+
+    """
 
     serializer_class = CycleSerializer
     model = Cycle
+    webhook_event = "cycle"
     permission_classes = [
         ProjectEntityPermission,
     ]
 
-    def perform_create(self, serializer):
-        serializer.save(
-            project_id=self.kwargs.get("project_id"), owned_by=self.request.user
-        )
-
     def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
+        return (
+            Cycle.objects.filter(workspace__slug=self.kwargs.get("slug"))
             .filter(project_id=self.kwargs.get("project_id"))
             .filter(project__project_projectmember__member=self.request.user)
             .select_related("project")
             .select_related("workspace")
+            .select_related("owned_by")
+            .annotate(
+                total_issues=Count(
+                    "issue_cycle",
+                    filter=Q(
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                completed_issues=Count(
+                    "issue_cycle__issue__state__group",
+                    filter=Q(
+                        issue_cycle__issue__state__group="completed",
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                cancelled_issues=Count(
+                    "issue_cycle__issue__state__group",
+                    filter=Q(
+                        issue_cycle__issue__state__group="cancelled",
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                started_issues=Count(
+                    "issue_cycle__issue__state__group",
+                    filter=Q(
+                        issue_cycle__issue__state__group="started",
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                unstarted_issues=Count(
+                    "issue_cycle__issue__state__group",
+                    filter=Q(
+                        issue_cycle__issue__state__group="unstarted",
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                backlog_issues=Count(
+                    "issue_cycle__issue__state__group",
+                    filter=Q(
+                        issue_cycle__issue__state__group="backlog",
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                total_estimates=Sum("issue_cycle__issue__estimate_point")
+            )
+            .annotate(
+                completed_estimates=Sum(
+                    "issue_cycle__issue__estimate_point",
+                    filter=Q(
+                        issue_cycle__issue__state__group="completed",
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                started_estimates=Sum(
+                    "issue_cycle__issue__estimate_point",
+                    filter=Q(
+                        issue_cycle__issue__state__group="started",
+                        issue_cycle__issue__archived_at__isnull=True,
+                        issue_cycle__issue__is_draft=False,
+                    ),
+                )
+            )
+            .order_by(self.kwargs.get("order_by", "-created_at"))
             .distinct()
         )
 
+    def get(self, request, slug, project_id, pk=None):
+        if pk:
+            queryset = self.get_queryset().get(pk=pk)
+            data = CycleSerializer(
+                queryset,
+                fields=self.fields,
+                expand=self.expand,
+            ).data
+            return Response(
+                data,
+                status=status.HTTP_200_OK,
+            )
+        queryset = self.get_queryset()
+        cycle_view = request.GET.get("cycle_view", "all")
 
-class CycleIssueViewSet(BaseViewSet):
+        # Current Cycle
+        if cycle_view == "current":
+            queryset = queryset.filter(
+                start_date__lte=timezone.now(),
+                end_date__gte=timezone.now(),
+            )
+            data = CycleSerializer(
+                queryset, many=True, fields=self.fields, expand=self.expand
+            ).data
+            return Response(data, status=status.HTTP_200_OK)
+
+        # Upcoming Cycles
+        if cycle_view == "upcoming":
+            queryset = queryset.filter(start_date__gt=timezone.now())
+            return self.paginate(
+                request=request,
+                queryset=(queryset),
+                on_results=lambda cycles: CycleSerializer(
+                    cycles,
+                    many=True,
+                    fields=self.fields,
+                    expand=self.expand,
+                ).data,
+            )
+
+        # Completed Cycles
+        if cycle_view == "completed":
+            queryset = queryset.filter(end_date__lt=timezone.now())
+            return self.paginate(
+                request=request,
+                queryset=(queryset),
+                on_results=lambda cycles: CycleSerializer(
+                    cycles,
+                    many=True,
+                    fields=self.fields,
+                    expand=self.expand,
+                ).data,
+            )
+
+        # Draft Cycles
+        if cycle_view == "draft":
+            queryset = queryset.filter(
+                end_date=None,
+                start_date=None,
+            )
+            return self.paginate(
+                request=request,
+                queryset=(queryset),
+                on_results=lambda cycles: CycleSerializer(
+                    cycles,
+                    many=True,
+                    fields=self.fields,
+                    expand=self.expand,
+                ).data,
+            )
+
+        # Incomplete Cycles
+        if cycle_view == "incomplete":
+            queryset = queryset.filter(
+                Q(end_date__gte=timezone.now().date())
+                | Q(end_date__isnull=True),
+            )
+            return self.paginate(
+                request=request,
+                queryset=(queryset),
+                on_results=lambda cycles: CycleSerializer(
+                    cycles,
+                    many=True,
+                    fields=self.fields,
+                    expand=self.expand,
+                ).data,
+            )
+        return self.paginate(
+            request=request,
+            queryset=(queryset),
+            on_results=lambda cycles: CycleSerializer(
+                cycles,
+                many=True,
+                fields=self.fields,
+                expand=self.expand,
+            ).data,
+        )
+
+    def post(self, request, slug, project_id):
+        if (
+            request.data.get("start_date", None) is None
+            and request.data.get("end_date", None) is None
+        ) or (
+            request.data.get("start_date", None) is not None
+            and request.data.get("end_date", None) is not None
+        ):
+            serializer = CycleSerializer(data=request.data)
+            if serializer.is_valid():
+                serializer.save(
+                    project_id=project_id,
+                    owned_by=request.user,
+                )
+                return Response(
+                    serializer.data, status=status.HTTP_201_CREATED
+                )
+            return Response(
+                serializer.errors, status=status.HTTP_400_BAD_REQUEST
+            )
+        else:
+            return Response(
+                {
+                    "error": "Both start date and end date are either required or are to be null"
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+    def patch(self, request, slug, project_id, pk):
+        cycle = Cycle.objects.get(
+            workspace__slug=slug, project_id=project_id, pk=pk
+        )
+
+        request_data = request.data
+
+        if (
+            cycle.end_date is not None
+            and cycle.end_date < timezone.now().date()
+        ):
+            if "sort_order" in request_data:
+                # Can only change sort order
+                request_data = {
+                    "sort_order": request_data.get(
+                        "sort_order", cycle.sort_order
+                    )
+                }
+            else:
+                return Response(
+                    {
+                        "error": "The Cycle has already been completed so it cannot be edited"
+                    },
+                    status=status.HTTP_400_BAD_REQUEST,
+                )
+
+        serializer = CycleSerializer(cycle, data=request.data, partial=True)
+        if serializer.is_valid():
+            serializer.save()
+            return Response(serializer.data, status=status.HTTP_200_OK)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+    def delete(self, request, slug, project_id, pk):
+        cycle_issues = list(
+            CycleIssue.objects.filter(
+                cycle_id=self.kwargs.get("pk")
+            ).values_list("issue", flat=True)
+        )
+        cycle = Cycle.objects.get(
+            workspace__slug=slug, project_id=project_id, pk=pk
+        )
+
+        issue_activity.delay(
+            type="cycle.activity.deleted",
+            requested_data=json.dumps(
+                {
+                    "cycle_id": str(pk),
+                    "cycle_name": str(cycle.name),
+                    "issues": [str(issue_id) for issue_id in cycle_issues],
+                }
+            ),
+            actor_id=str(request.user.id),
+            issue_id=None,
+            project_id=str(project_id),
+            current_instance=None,
+            epoch=int(timezone.now().timestamp()),
+        )
+        # Delete the cycle
+        cycle.delete()
+        return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class CycleIssueAPIEndpoint(WebhookMixin, BaseAPIView):
+    """
+    This viewset automatically provides `list`, `create`,
+    and `destroy` actions related to cycle issues.
+
+    """
 
     serializer_class = CycleIssueSerializer
     model = CycleIssue
-
+    webhook_event = "cycle_issue"
+    bulk = True
     permission_classes = [
         ProjectEntityPermission,
     ]
 
-    def perform_create(self, serializer):
-        serializer.save(
-            project_id=self.kwargs.get("project_id"),
-            cycle_id=self.kwargs.get("cycle_id"),
-        )
-
     def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
+        return (
+            CycleIssue.objects.annotate(
+                sub_issues_count=Issue.issue_objects.filter(
+                    parent=OuterRef("issue_id")
+                )
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
             .filter(workspace__slug=self.kwargs.get("slug"))
             .filter(project_id=self.kwargs.get("project_id"))
             .filter(project__project_projectmember__member=self.request.user)
@@ -62,56 +355,234 @@ class CycleIssueViewSet(BaseViewSet):
             .select_related("project")
             .select_related("workspace")
             .select_related("cycle")
-            .select_related("issue")
-            .select_related("issue__state")
+            .select_related("issue", "issue__state", "issue__project")
+            .prefetch_related("issue__assignees", "issue__labels")
+            .order_by(self.kwargs.get("order_by", "-created_at"))
             .distinct()
         )
 
-    def create(self, request, slug, project_id, cycle_id):
-        try:
-
-            issues = request.data.get("issues", [])
-
-            if not len(issues):
-                return Response(
-                    {"error": "Issues are required"}, status=status.HTTP_400_BAD_REQUEST
+    def get(self, request, slug, project_id, cycle_id):
+        order_by = request.GET.get("order_by", "created_at")
+        issues = (
+            Issue.issue_objects.filter(issue_cycle__cycle_id=cycle_id)
+            .annotate(
+                sub_issues_count=Issue.issue_objects.filter(
+                    parent=OuterRef("id")
                 )
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
+            .annotate(bridge_id=F("issue_cycle__id"))
+            .filter(project_id=project_id)
+            .filter(workspace__slug=slug)
+            .select_related("project")
+            .select_related("workspace")
+            .select_related("state")
+            .select_related("parent")
+            .prefetch_related("assignees")
+            .prefetch_related("labels")
+            .order_by(order_by)
+            .annotate(
+                link_count=IssueLink.objects.filter(issue=OuterRef("id"))
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
+            .annotate(
+                attachment_count=IssueAttachment.objects.filter(
+                    issue=OuterRef("id")
+                )
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
+        )
 
-            cycle = Cycle.objects.get(
-                workspace__slug=slug, project_id=project_id, pk=cycle_id
+        return self.paginate(
+            request=request,
+            queryset=(issues),
+            on_results=lambda issues: CycleSerializer(
+                issues,
+                many=True,
+                fields=self.fields,
+                expand=self.expand,
+            ).data,
+        )
+
+    def post(self, request, slug, project_id, cycle_id):
+        issues = request.data.get("issues", [])
+
+        if not issues:
+            return Response(
+                {"error": "Issues are required"},
+                status=status.HTTP_400_BAD_REQUEST,
             )
 
-            issues = Issue.objects.filter(
-                pk__in=issues, workspace__slug=slug, project_id=project_id
+        cycle = Cycle.objects.get(
+            workspace__slug=slug, project_id=project_id, pk=cycle_id
+        )
+
+        if (
+            cycle.end_date is not None
+            and cycle.end_date < timezone.now().date()
+        ):
+            return Response(
+                {
+                    "error": "The Cycle has already been completed so no new issues can be added"
+                },
+                status=status.HTTP_400_BAD_REQUEST,
             )
 
-            # Delete old records in order to maintain the database integrity
-            CycleIssue.objects.filter(issue_id__in=issues).delete()
+        issues = Issue.objects.filter(
+            pk__in=issues, workspace__slug=slug, project_id=project_id
+        ).values_list("id", flat=True)
 
-            CycleIssue.objects.bulk_create(
-                [
+        # Get all CycleIssues already created
+        cycle_issues = list(CycleIssue.objects.filter(issue_id__in=issues))
+        update_cycle_issue_activity = []
+        record_to_create = []
+        records_to_update = []
+
+        for issue in issues:
+            cycle_issue = [
+                cycle_issue
+                for cycle_issue in cycle_issues
+                if str(cycle_issue.issue_id) in issues
+            ]
+            # Update only when cycle changes
+            if len(cycle_issue):
+                if cycle_issue[0].cycle_id != cycle_id:
+                    update_cycle_issue_activity.append(
+                        {
+                            "old_cycle_id": str(cycle_issue[0].cycle_id),
+                            "new_cycle_id": str(cycle_id),
+                            "issue_id": str(cycle_issue[0].issue_id),
+                        }
+                    )
+                    cycle_issue[0].cycle_id = cycle_id
+                    records_to_update.append(cycle_issue[0])
+            else:
+                record_to_create.append(
                     CycleIssue(
                         project_id=project_id,
                         workspace=cycle.workspace,
                         created_by=request.user,
                         updated_by=request.user,
                         cycle=cycle,
-                        issue=issue,
+                        issue_id=issue,
                     )
-                    for issue in issues
-                ],
-                batch_size=10,
-                ignore_conflicts=True,
-            )
-            return Response({"message": "Success"}, status=status.HTTP_200_OK)
+                )
 
-        except Cycle.DoesNotExist:
+        CycleIssue.objects.bulk_create(
+            record_to_create,
+            batch_size=10,
+            ignore_conflicts=True,
+        )
+        CycleIssue.objects.bulk_update(
+            records_to_update,
+            ["cycle"],
+            batch_size=10,
+        )
+
+        # Capture Issue Activity
+        issue_activity.delay(
+            type="cycle.activity.created",
+            requested_data=json.dumps({"cycles_list": str(issues)}),
+            actor_id=str(self.request.user.id),
+            issue_id=None,
+            project_id=str(self.kwargs.get("project_id", None)),
+            current_instance=json.dumps(
+                {
+                    "updated_cycle_issues": update_cycle_issue_activity,
+                    "created_cycle_issues": serializers.serialize(
+                        "json", record_to_create
+                    ),
+                }
+            ),
+            epoch=int(timezone.now().timestamp()),
+        )
+
+        # Return all Cycle Issues
+        return Response(
+            CycleIssueSerializer(self.get_queryset(), many=True).data,
+            status=status.HTTP_200_OK,
+        )
+
+    def delete(self, request, slug, project_id, cycle_id, issue_id):
+        cycle_issue = CycleIssue.objects.get(
+            issue_id=issue_id,
+            workspace__slug=slug,
+            project_id=project_id,
+            cycle_id=cycle_id,
+        )
+        issue_id = cycle_issue.issue_id
+        cycle_issue.delete()
+        issue_activity.delay(
+            type="cycle.activity.deleted",
+            requested_data=json.dumps(
+                {
+                    "cycle_id": str(self.kwargs.get("cycle_id")),
+                    "issues": [str(issue_id)],
+                }
+            ),
+            actor_id=str(self.request.user.id),
+            issue_id=str(issue_id),
+            project_id=str(self.kwargs.get("project_id", None)),
+            current_instance=None,
+            epoch=int(timezone.now().timestamp()),
+        )
+        return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class TransferCycleIssueAPIEndpoint(BaseAPIView):
+    """
+    This viewset provides `create` actions for transfering the issues into a particular cycle.
+
+    """
+
+    permission_classes = [
+        ProjectEntityPermission,
+    ]
+
+    def post(self, request, slug, project_id, cycle_id):
+        new_cycle_id = request.data.get("new_cycle_id", False)
+
+        if not new_cycle_id:
             return Response(
-                {"error": "Cycle not found"}, status=status.HTTP_404_NOT_FOUND
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
+                {"error": "New Cycle Id is required"},
                 status=status.HTTP_400_BAD_REQUEST,
             )
+
+        new_cycle = Cycle.objects.get(
+            workspace__slug=slug, project_id=project_id, pk=new_cycle_id
+        )
+
+        if (
+            new_cycle.end_date is not None
+            and new_cycle.end_date < timezone.now().date()
+        ):
+            return Response(
+                {
+                    "error": "The cycle where the issues are transferred is already completed"
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        cycle_issues = CycleIssue.objects.filter(
+            cycle_id=cycle_id,
+            project_id=project_id,
+            workspace__slug=slug,
+            issue__state__group__in=["backlog", "unstarted", "started"],
+        )
+
+        updated_cycles = []
+        for cycle_issue in cycle_issues:
+            cycle_issue.cycle_id = new_cycle_id
+            updated_cycles.append(cycle_issue)
+
+        cycle_issues = CycleIssue.objects.bulk_update(
+            updated_cycles, ["cycle_id"], batch_size=100
+        )
+
+        return Response({"message": "Success"}, status=status.HTTP_200_OK)

apiserver/plane/api/views/inbox.py

@@ -0,0 +1,374 @@
+# Python imports
+import json
+
+# Django improts
+from django.utils import timezone
+from django.db.models import Q
+from django.core.serializers.json import DjangoJSONEncoder
+
+# Third party imports
+from rest_framework import status
+from rest_framework.response import Response
+
+# Module imports
+from .base import BaseAPIView
+from plane.app.permissions import ProjectLitePermission
+from plane.api.serializers import InboxIssueSerializer, IssueSerializer
+from plane.db.models import (
+    InboxIssue,
+    Issue,
+    State,
+    ProjectMember,
+    Project,
+    Inbox,
+)
+from plane.bgtasks.issue_activites_task import issue_activity
+
+
+class InboxIssueAPIEndpoint(BaseAPIView):
+    """
+    This viewset automatically provides `list`, `create`, `retrieve`,
+    `update` and `destroy` actions related to inbox issues.
+
+    """
+
+    permission_classes = [
+        ProjectLitePermission,
+    ]
+
+    serializer_class = InboxIssueSerializer
+    model = InboxIssue
+
+    filterset_fields = [
+        "status",
+    ]
+
+    def get_queryset(self):
+        inbox = Inbox.objects.filter(
+            workspace__slug=self.kwargs.get("slug"),
+            project_id=self.kwargs.get("project_id"),
+        ).first()
+
+        project = Project.objects.get(
+            workspace__slug=self.kwargs.get("slug"),
+            pk=self.kwargs.get("project_id"),
+        )
+
+        if inbox is None and not project.inbox_view:
+            return InboxIssue.objects.none()
+
+        return (
+            InboxIssue.objects.filter(
+                Q(snoozed_till__gte=timezone.now())
+                | Q(snoozed_till__isnull=True),
+                workspace__slug=self.kwargs.get("slug"),
+                project_id=self.kwargs.get("project_id"),
+                inbox_id=inbox.id,
+            )
+            .select_related("issue", "workspace", "project")
+            .order_by(self.kwargs.get("order_by", "-created_at"))
+        )
+
+    def get(self, request, slug, project_id, issue_id=None):
+        if issue_id:
+            inbox_issue_queryset = self.get_queryset().get(issue_id=issue_id)
+            inbox_issue_data = InboxIssueSerializer(
+                inbox_issue_queryset,
+                fields=self.fields,
+                expand=self.expand,
+            ).data
+            return Response(
+                inbox_issue_data,
+                status=status.HTTP_200_OK,
+            )
+        issue_queryset = self.get_queryset()
+        return self.paginate(
+            request=request,
+            queryset=(issue_queryset),
+            on_results=lambda inbox_issues: InboxIssueSerializer(
+                inbox_issues,
+                many=True,
+                fields=self.fields,
+                expand=self.expand,
+            ).data,
+        )
+
+    def post(self, request, slug, project_id):
+        if not request.data.get("issue", {}).get("name", False):
+            return Response(
+                {"error": "Name is required"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        inbox = Inbox.objects.filter(
+            workspace__slug=slug, project_id=project_id
+        ).first()
+
+        project = Project.objects.get(
+            workspace__slug=slug,
+            pk=project_id,
+        )
+
+        # Inbox view
+        if inbox is None and not project.inbox_view:
+            return Response(
+                {
+                    "error": "Inbox is not enabled for this project enable it through the project's api"
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Check for valid priority
+        if not request.data.get("issue", {}).get("priority", "none") in [
+            "low",
+            "medium",
+            "high",
+            "urgent",
+            "none",
+        ]:
+            return Response(
+                {"error": "Invalid priority"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Create or get state
+        state, _ = State.objects.get_or_create(
+            name="Triage",
+            group="backlog",
+            description="Default state for managing all Inbox Issues",
+            project_id=project_id,
+            color="#ff7700",
+        )
+
+        # create an issue
+        issue = Issue.objects.create(
+            name=request.data.get("issue", {}).get("name"),
+            description=request.data.get("issue", {}).get("description", {}),
+            description_html=request.data.get("issue", {}).get(
+                "description_html", "<p></p>"
+            ),
+            priority=request.data.get("issue", {}).get("priority", "low"),
+            project_id=project_id,
+            state=state,
+        )
+
+        # Create an Issue Activity
+        issue_activity.delay(
+            type="issue.activity.created",
+            requested_data=json.dumps(request.data, cls=DjangoJSONEncoder),
+            actor_id=str(request.user.id),
+            issue_id=str(issue.id),
+            project_id=str(project_id),
+            current_instance=None,
+            epoch=int(timezone.now().timestamp()),
+        )
+
+        # create an inbox issue
+        inbox_issue = InboxIssue.objects.create(
+            inbox_id=inbox.id,
+            project_id=project_id,
+            issue=issue,
+            source=request.data.get("source", "in-app"),
+        )
+
+        serializer = InboxIssueSerializer(inbox_issue)
+        return Response(serializer.data, status=status.HTTP_200_OK)
+
+    def patch(self, request, slug, project_id, issue_id):
+        inbox = Inbox.objects.filter(
+            workspace__slug=slug, project_id=project_id
+        ).first()
+
+        project = Project.objects.get(
+            workspace__slug=slug,
+            pk=project_id,
+        )
+
+        # Inbox view
+        if inbox is None and not project.inbox_view:
+            return Response(
+                {
+                    "error": "Inbox is not enabled for this project enable it through the project's api"
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Get the inbox issue
+        inbox_issue = InboxIssue.objects.get(
+            issue_id=issue_id,
+            workspace__slug=slug,
+            project_id=project_id,
+            inbox_id=inbox.id,
+        )
+
+        # Get the project member
+        project_member = ProjectMember.objects.get(
+            workspace__slug=slug,
+            project_id=project_id,
+            member=request.user,
+            is_active=True,
+        )
+
+        # Only project members admins and created_by users can access this endpoint
+        if project_member.role <= 10 and str(inbox_issue.created_by_id) != str(
+            request.user.id
+        ):
+            return Response(
+                {"error": "You cannot edit inbox issues"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Get issue data
+        issue_data = request.data.pop("issue", False)
+
+        if bool(issue_data):
+            issue = Issue.objects.get(
+                pk=issue_id, workspace__slug=slug, project_id=project_id
+            )
+            # Only allow guests and viewers to edit name and description
+            if project_member.role <= 10:
+                # viewers and guests since only viewers and guests
+                issue_data = {
+                    "name": issue_data.get("name", issue.name),
+                    "description_html": issue_data.get(
+                        "description_html", issue.description_html
+                    ),
+                    "description": issue_data.get(
+                        "description", issue.description
+                    ),
+                }
+
+            issue_serializer = IssueSerializer(
+                issue, data=issue_data, partial=True
+            )
+
+            if issue_serializer.is_valid():
+                current_instance = issue
+                # Log all the updates
+                requested_data = json.dumps(issue_data, cls=DjangoJSONEncoder)
+                if issue is not None:
+                    issue_activity.delay(
+                        type="issue.activity.updated",
+                        requested_data=requested_data,
+                        actor_id=str(request.user.id),
+                        issue_id=str(issue_id),
+                        project_id=str(project_id),
+                        current_instance=json.dumps(
+                            IssueSerializer(current_instance).data,
+                            cls=DjangoJSONEncoder,
+                        ),
+                        epoch=int(timezone.now().timestamp()),
+                    )
+                issue_serializer.save()
+            else:
+                return Response(
+                    issue_serializer.errors, status=status.HTTP_400_BAD_REQUEST
+                )
+
+        # Only project admins and members can edit inbox issue attributes
+        if project_member.role > 10:
+            serializer = InboxIssueSerializer(
+                inbox_issue, data=request.data, partial=True
+            )
+
+            if serializer.is_valid():
+                serializer.save()
+                # Update the issue state if the issue is rejected or marked as duplicate
+                if serializer.data["status"] in [-1, 2]:
+                    issue = Issue.objects.get(
+                        pk=issue_id,
+                        workspace__slug=slug,
+                        project_id=project_id,
+                    )
+                    state = State.objects.filter(
+                        group="cancelled",
+                        workspace__slug=slug,
+                        project_id=project_id,
+                    ).first()
+                    if state is not None:
+                        issue.state = state
+                        issue.save()
+
+                # Update the issue state if it is accepted
+                if serializer.data["status"] in [1]:
+                    issue = Issue.objects.get(
+                        pk=issue_id,
+                        workspace__slug=slug,
+                        project_id=project_id,
+                    )
+
+                    # Update the issue state only if it is in triage state
+                    if issue.state.name == "Triage":
+                        # Move to default state
+                        state = State.objects.filter(
+                            workspace__slug=slug,
+                            project_id=project_id,
+                            default=True,
+                        ).first()
+                        if state is not None:
+                            issue.state = state
+                            issue.save()
+
+                return Response(serializer.data, status=status.HTTP_200_OK)
+            return Response(
+                serializer.errors, status=status.HTTP_400_BAD_REQUEST
+            )
+        else:
+            return Response(
+                InboxIssueSerializer(inbox_issue).data,
+                status=status.HTTP_200_OK,
+            )
+
+    def delete(self, request, slug, project_id, issue_id):
+        inbox = Inbox.objects.filter(
+            workspace__slug=slug, project_id=project_id
+        ).first()
+
+        project = Project.objects.get(
+            workspace__slug=slug,
+            pk=project_id,
+        )
+
+        # Inbox view
+        if inbox is None and not project.inbox_view:
+            return Response(
+                {
+                    "error": "Inbox is not enabled for this project enable it through the project's api"
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Get the inbox issue
+        inbox_issue = InboxIssue.objects.get(
+            issue_id=issue_id,
+            workspace__slug=slug,
+            project_id=project_id,
+            inbox_id=inbox.id,
+        )
+
+        # Get the project member
+        project_member = ProjectMember.objects.get(
+            workspace__slug=slug,
+            project_id=project_id,
+            member=request.user,
+            is_active=True,
+        )
+
+        # Check the inbox issue created
+        if project_member.role <= 10 and str(inbox_issue.created_by_id) != str(
+            request.user.id
+        ):
+            return Response(
+                {"error": "You cannot delete inbox issue"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Check the issue status
+        if inbox_issue.status in [-2, -1, 0, 2]:
+            # Delete the issue also
+            Issue.objects.filter(
+                workspace__slug=slug, project_id=project_id, pk=issue_id
+            ).delete()
+
+        inbox_issue.delete()
+        return Response(status=status.HTTP_204_NO_CONTENT)

apiserver/plane/api/views/module.py

@@ -1,115 +1,235 @@
-# Django Imports
-from django.db import IntegrityError
-from django.db.models import Prefetch
+# Python imports
+import json
+
+# Django imports
+from django.db.models import Count, Prefetch, Q, F, Func, OuterRef
+from django.utils import timezone
+from django.core import serializers
 
 # Third party imports
-from rest_framework.response import Response
 from rest_framework import status
-from sentry_sdk import capture_exception
+from rest_framework.response import Response
 
 # Module imports
-from . import BaseViewSet
+from .base import BaseAPIView, WebhookMixin
+from plane.app.permissions import ProjectEntityPermission
+from plane.db.models import (
+    Project,
+    Module,
+    ModuleLink,
+    Issue,
+    ModuleIssue,
+    IssueAttachment,
+    IssueLink,
+)
 from plane.api.serializers import (
-    ModuleWriteSerializer,
     ModuleSerializer,
     ModuleIssueSerializer,
+    IssueSerializer,
 )
-from plane.api.permissions import ProjectEntityPermission
-from plane.db.models import Module, ModuleIssue, Project, Issue, ModuleLink
+from plane.bgtasks.issue_activites_task import issue_activity
 
 
-class ModuleViewSet(BaseViewSet):
+class ModuleAPIEndpoint(WebhookMixin, BaseAPIView):
+    """
+    This viewset automatically provides `list`, `create`, `retrieve`,
+    `update` and `destroy` actions related to module.
+
+    """
 
     model = Module
     permission_classes = [
         ProjectEntityPermission,
     ]
-
-    def get_serializer_class(self):
-        return (
-            ModuleWriteSerializer
-            if self.action in ["create", "update", "partial_update"]
-            else ModuleSerializer
-        )
+    serializer_class = ModuleSerializer
+    webhook_event = "module"
 
     def get_queryset(self):
         return (
-            super()
-            .get_queryset()
-            .filter(project_id=self.kwargs.get("project_id"))
+            Module.objects.filter(project_id=self.kwargs.get("project_id"))
             .filter(workspace__slug=self.kwargs.get("slug"))
             .select_related("project")
             .select_related("workspace")
             .select_related("lead")
             .prefetch_related("members")
-            .prefetch_related(
-                Prefetch(
-                    "issue_module",
-                    queryset=ModuleIssue.objects.select_related("module", "issue"),
-                )
-            )
             .prefetch_related(
                 Prefetch(
                     "link_module",
-                    queryset=ModuleLink.objects.select_related("module"),
+                    queryset=ModuleLink.objects.select_related(
+                        "module", "created_by"
+                    ),
                 )
             )
+            .annotate(
+                total_issues=Count(
+                    "issue_module",
+                    filter=Q(
+                        issue_module__issue__archived_at__isnull=True,
+                        issue_module__issue__is_draft=False,
+                    ),
+                ),
+            )
+            .annotate(
+                completed_issues=Count(
+                    "issue_module__issue__state__group",
+                    filter=Q(
+                        issue_module__issue__state__group="completed",
+                        issue_module__issue__archived_at__isnull=True,
+                        issue_module__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                cancelled_issues=Count(
+                    "issue_module__issue__state__group",
+                    filter=Q(
+                        issue_module__issue__state__group="cancelled",
+                        issue_module__issue__archived_at__isnull=True,
+                        issue_module__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                started_issues=Count(
+                    "issue_module__issue__state__group",
+                    filter=Q(
+                        issue_module__issue__state__group="started",
+                        issue_module__issue__archived_at__isnull=True,
+                        issue_module__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                unstarted_issues=Count(
+                    "issue_module__issue__state__group",
+                    filter=Q(
+                        issue_module__issue__state__group="unstarted",
+                        issue_module__issue__archived_at__isnull=True,
+                        issue_module__issue__is_draft=False,
+                    ),
+                )
+            )
+            .annotate(
+                backlog_issues=Count(
+                    "issue_module__issue__state__group",
+                    filter=Q(
+                        issue_module__issue__state__group="backlog",
+                        issue_module__issue__archived_at__isnull=True,
+                        issue_module__issue__is_draft=False,
+                    ),
+                )
+            )
+            .order_by(self.kwargs.get("order_by", "-created_at"))
         )
 
-    def create(self, request, slug, project_id):
-        try:
-            project = Project.objects.get(workspace__slug=slug, pk=project_id)
-            serializer = ModuleWriteSerializer(
-                data=request.data, context={"project": project}
-            )
+    def post(self, request, slug, project_id):
+        project = Project.objects.get(pk=project_id, workspace__slug=slug)
+        serializer = ModuleSerializer(
+            data=request.data,
+            context={
+                "project_id": project_id,
+                "workspace_id": project.workspace_id,
+            },
+        )
+        if serializer.is_valid():
+            serializer.save()
+            module = Module.objects.get(pk=serializer.data["id"])
+            serializer = ModuleSerializer(module)
+            return Response(serializer.data, status=status.HTTP_201_CREATED)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
 
-            if serializer.is_valid():
-                serializer.save()
-                return Response(serializer.data, status=status.HTTP_201_CREATED)
-            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+    def patch(self, request, slug, project_id, pk):
+        module = Module.objects.get(
+            pk=pk, project_id=project_id, workspace__slug=slug
+        )
+        serializer = ModuleSerializer(
+            module,
+            data=request.data,
+            context={"project_id": project_id},
+            partial=True,
+        )
+        if serializer.is_valid():
+            serializer.save()
+            return Response(serializer.data, status=status.HTTP_201_CREATED)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
 
-        except Project.DoesNotExist:
+    def get(self, request, slug, project_id, pk=None):
+        if pk:
+            queryset = self.get_queryset().get(pk=pk)
+            data = ModuleSerializer(
+                queryset,
+                fields=self.fields,
+                expand=self.expand,
+            ).data
             return Response(
-                {"error": "Project was not found"}, status=status.HTTP_404_NOT_FOUND
+                data,
+                status=status.HTTP_200_OK,
             )
-        except IntegrityError as e:
-            if "already exists" in str(e):
-                return Response(
-                    {"name": "The module name is already taken"},
-                    status=status.HTTP_410_GONE,
-                )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
+        return self.paginate(
+            request=request,
+            queryset=(self.get_queryset()),
+            on_results=lambda modules: ModuleSerializer(
+                modules,
+                many=True,
+                fields=self.fields,
+                expand=self.expand,
+            ).data,
+        )
+
+    def delete(self, request, slug, project_id, pk):
+        module = Module.objects.get(
+            workspace__slug=slug, project_id=project_id, pk=pk
+        )
+        module_issues = list(
+            ModuleIssue.objects.filter(module_id=pk).values_list(
+                "issue", flat=True
             )
+        )
+        issue_activity.delay(
+            type="module.activity.deleted",
+            requested_data=json.dumps(
+                {
+                    "module_id": str(pk),
+                    "module_name": str(module.name),
+                    "issues": [str(issue_id) for issue_id in module_issues],
+                }
+            ),
+            actor_id=str(request.user.id),
+            issue_id=None,
+            project_id=str(project_id),
+            current_instance=None,
+            epoch=int(timezone.now().timestamp()),
+        )
+        module.delete()
+        return Response(status=status.HTTP_204_NO_CONTENT)
 
 
-class ModuleIssueViewSet(BaseViewSet):
+class ModuleIssueAPIEndpoint(WebhookMixin, BaseAPIView):
+    """
+    This viewset automatically provides `list`, `create`, `retrieve`,
+    `update` and `destroy` actions related to module issues.
+
+    """
 
     serializer_class = ModuleIssueSerializer
     model = ModuleIssue
-
-    filterset_fields = [
-        "issue__id",
-        "workspace__id",
-    ]
+    webhook_event = "module_issue"
+    bulk = True
 
     permission_classes = [
         ProjectEntityPermission,
     ]
 
-    def perform_create(self, serializer):
-        serializer.save(
-            project_id=self.kwargs.get("project_id"),
-            module_id=self.kwargs.get("module_id"),
-        )
-
     def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
+        return (
+            ModuleIssue.objects.annotate(
+                sub_issues_count=Issue.issue_objects.filter(
+                    parent=OuterRef("issue")
+                )
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
             .filter(workspace__slug=self.kwargs.get("slug"))
             .filter(project_id=self.kwargs.get("project_id"))
             .filter(module_id=self.kwargs.get("module_id"))
@@ -117,51 +237,167 @@ class ModuleIssueViewSet(BaseViewSet):
             .select_related("project")
             .select_related("workspace")
             .select_related("module")
-            .select_related("issue")
+            .select_related("issue", "issue__state", "issue__project")
+            .prefetch_related("issue__assignees", "issue__labels")
+            .prefetch_related("module__members")
+            .order_by(self.kwargs.get("order_by", "-created_at"))
             .distinct()
         )
 
-    def create(self, request, slug, project_id, module_id):
-        try:
-            issues = request.data.get("issues", [])
-            if not len(issues):
-                return Response(
-                    {"error": "Issues are required"}, status=status.HTTP_400_BAD_REQUEST
+    def get(self, request, slug, project_id, module_id):
+        order_by = request.GET.get("order_by", "created_at")
+        issues = (
+            Issue.issue_objects.filter(issue_module__module_id=module_id)
+            .annotate(
+                sub_issues_count=Issue.issue_objects.filter(
+                    parent=OuterRef("id")
                 )
-            module = Module.objects.get(
-                workspace__slug=slug, project_id=project_id, pk=module_id
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
             )
-
-            issues = Issue.objects.filter(
-                pk__in=issues, workspace__slug=slug, project_id=project_id
+            .annotate(bridge_id=F("issue_module__id"))
+            .filter(project_id=project_id)
+            .filter(workspace__slug=slug)
+            .select_related("project")
+            .select_related("workspace")
+            .select_related("state")
+            .select_related("parent")
+            .prefetch_related("assignees")
+            .prefetch_related("labels")
+            .order_by(order_by)
+            .annotate(
+                link_count=IssueLink.objects.filter(issue=OuterRef("id"))
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
             )
+            .annotate(
+                attachment_count=IssueAttachment.objects.filter(
+                    issue=OuterRef("id")
+                )
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
+        )
+        return self.paginate(
+            request=request,
+            queryset=(issues),
+            on_results=lambda issues: IssueSerializer(
+                issues,
+                many=True,
+                fields=self.fields,
+                expand=self.expand,
+            ).data,
+        )
 
-            # Delete old records in order to maintain the database integrity
-            ModuleIssue.objects.filter(issue_id__in=issues).delete()
+    def post(self, request, slug, project_id, module_id):
+        issues = request.data.get("issues", [])
+        if not len(issues):
+            return Response(
+                {"error": "Issues are required"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+        module = Module.objects.get(
+            workspace__slug=slug, project_id=project_id, pk=module_id
+        )
 
-            ModuleIssue.objects.bulk_create(
-                [
+        issues = Issue.objects.filter(
+            workspace__slug=slug, project_id=project_id, pk__in=issues
+        ).values_list("id", flat=True)
+
+        module_issues = list(ModuleIssue.objects.filter(issue_id__in=issues))
+
+        update_module_issue_activity = []
+        records_to_update = []
+        record_to_create = []
+
+        for issue in issues:
+            module_issue = [
+                module_issue
+                for module_issue in module_issues
+                if str(module_issue.issue_id) in issues
+            ]
+
+            if len(module_issue):
+                if module_issue[0].module_id != module_id:
+                    update_module_issue_activity.append(
+                        {
+                            "old_module_id": str(module_issue[0].module_id),
+                            "new_module_id": str(module_id),
+                            "issue_id": str(module_issue[0].issue_id),
+                        }
+                    )
+                    module_issue[0].module_id = module_id
+                    records_to_update.append(module_issue[0])
+            else:
+                record_to_create.append(
                     ModuleIssue(
                         module=module,
-                        issue=issue,
+                        issue_id=issue,
                         project_id=project_id,
                         workspace=module.workspace,
                         created_by=request.user,
                         updated_by=request.user,
                     )
-                    for issue in issues
-                ],
-                batch_size=10,
-                ignore_conflicts=True,
-            )
-            return Response({"message": "Success"}, status=status.HTTP_200_OK)
-        except Module.DoesNotExist:
-            return Response(
-                {"error": "Module Does not exists"}, status=status.HTTP_400_BAD_REQUEST
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
+                )
+
+        ModuleIssue.objects.bulk_create(
+            record_to_create,
+            batch_size=10,
+            ignore_conflicts=True,
+        )
+
+        ModuleIssue.objects.bulk_update(
+            records_to_update,
+            ["module"],
+            batch_size=10,
+        )
+
+        # Capture Issue Activity
+        issue_activity.delay(
+            type="module.activity.created",
+            requested_data=json.dumps({"modules_list": str(issues)}),
+            actor_id=str(self.request.user.id),
+            issue_id=None,
+            project_id=str(self.kwargs.get("project_id", None)),
+            current_instance=json.dumps(
+                {
+                    "updated_module_issues": update_module_issue_activity,
+                    "created_module_issues": serializers.serialize(
+                        "json", record_to_create
+                    ),
+                }
+            ),
+            epoch=int(timezone.now().timestamp()),
+        )
+
+        return Response(
+            ModuleIssueSerializer(self.get_queryset(), many=True).data,
+            status=status.HTTP_200_OK,
+        )
+
+    def delete(self, request, slug, project_id, module_id, issue_id):
+        module_issue = ModuleIssue.objects.get(
+            workspace__slug=slug,
+            project_id=project_id,
+            module_id=module_id,
+            issue_id=issue_id,
+        )
+        module_issue.delete()
+        issue_activity.delay(
+            type="module.activity.deleted",
+            requested_data=json.dumps(
+                {
+                    "module_id": str(module_id),
+                    "issues": [str(module_issue.issue_id)],
+                }
+            ),
+            actor_id=str(request.user.id),
+            issue_id=str(issue_id),
+            project_id=str(project_id),
+            current_instance=None,
+            epoch=int(timezone.now().timestamp()),
+        )
+        return Response(status=status.HTTP_204_NO_CONTENT)

apiserver/plane/api/views/oauth.py

@@ -1,269 +0,0 @@
-# Python imports
-import uuid
-import requests
-import os
-
-# Django imports
-from django.utils import timezone
-
-# Third Party modules
-from rest_framework.response import Response
-from rest_framework import exceptions
-from rest_framework.permissions import AllowAny
-from rest_framework.views import APIView
-from rest_framework_simplejwt.tokens import RefreshToken
-from rest_framework import status
-
-# sso authentication
-from google.oauth2 import id_token
-from google.auth.transport import requests as google_auth_request
-
-# Module imports
-from plane.db.models import SocialLoginConnection, User
-from plane.api.serializers import UserSerializer
-from .base import BaseAPIView
-
-
-def get_tokens_for_user(user):
-    refresh = RefreshToken.for_user(user)
-    return (
-        str(refresh.access_token),
-        str(refresh),
-    )
-
-
-def validate_google_token(token, client_id):
-    try:
-
-        id_info = id_token.verify_oauth2_token(
-            token, google_auth_request.Request(), client_id
-        )
-        email = id_info.get("email")
-        first_name = id_info.get("given_name")
-        last_name = id_info.get("family_name", "")
-        data = {
-            "email": email,
-            "first_name": first_name,
-            "last_name": last_name,
-        }
-        return data
-    except Exception as e:
-        print(e)
-        raise exceptions.AuthenticationFailed("Error with Google connection.")
-
-
-def get_access_token(request_token: str, client_id: str) -> str:
-    """Obtain the request token from github.
-    Given the client id, client secret and request issued out by GitHub, this method
-    should give back an access token
-    Parameters
-    ----------
-    CLIENT_ID: str
-        A string representing the client id issued out by github
-    CLIENT_SECRET: str
-        A string representing the client secret issued out by github
-    request_token: str
-        A string representing the request token issued out by github
-    Throws
-    ------
-    ValueError:
-        if CLIENT_ID or CLIENT_SECRET or request_token is empty or not a string
-    Returns
-    -------
-    access_token: str
-        A string representing the access token issued out by github
-    """
-
-    if not request_token:
-        raise ValueError("The request token has to be supplied!")
-
-    CLIENT_SECRET = os.environ.get("GITHUB_CLIENT_SECRET")
-
-    url = f"https://github.com/login/oauth/access_token?client_id={client_id}&client_secret={CLIENT_SECRET}&code={request_token}"
-    headers = {"accept": "application/json"}
-
-    res = requests.post(url, headers=headers)
-
-    data = res.json()
-    access_token = data["access_token"]
-
-    return access_token
-
-
-def get_user_data(access_token: str) -> dict:
-    """
-    Obtain the user data from github.
-    Given the access token, this method should give back the user data
-    """
-    if not access_token:
-        raise ValueError("The request token has to be supplied!")
-    if not isinstance(access_token, str):
-        raise ValueError("The request token has to be a string!")
-
-    access_token = "token " + access_token
-    url = "https://api.github.com/user"
-    headers = {"Authorization": access_token}
-
-    resp = requests.get(url=url, headers=headers)
-
-    userData = resp.json()
-
-    return userData
-
-
-class OauthEndpoint(BaseAPIView):
-    permission_classes = [AllowAny]
-
-    def post(self, request):
-        try:
-
-            medium = request.data.get("medium", False)
-            id_token = request.data.get("credential", False)
-            client_id = request.data.get("clientId", False)
-
-            if not medium or not id_token:
-                return Response(
-                    {
-                        "error": "Something went wrong. Please try again later or contact the support team."
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            if medium == "google":
-                data = validate_google_token(id_token, client_id)
-
-            if medium == "github":
-                access_token = get_access_token(id_token, client_id)
-                data = get_user_data(access_token)
-
-            email = data.get("email", None)
-            if email == None:
-
-                return Response(
-                    {
-                        "error": "Something went wrong. Please try again later or contact the support team."
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            if "@" in email:
-                user = User.objects.get(email=email)
-                email = data["email"]
-                channel = "email"
-                mobile_number = uuid.uuid4().hex
-                email_verified = True
-            else:
-
-                return Response(
-                    {
-                        "error": "Something went wrong. Please try again later or contact the support team."
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            ## Login Case
-
-            if not user.is_active:
-                return Response(
-                    {
-                        "error": "Your account has been deactivated. Please contact your site administrator."
-                    },
-                    status=status.HTTP_403_FORBIDDEN,
-                )
-
-            user.last_active = timezone.now()
-            user.last_login_time = timezone.now()
-            user.last_login_ip = request.META.get("REMOTE_ADDR")
-            user.last_login_medium = f"oauth"
-            user.last_login_uagent = request.META.get("HTTP_USER_AGENT")
-            user.is_email_verified = email_verified
-            user.save()
-
-            serialized_user = UserSerializer(user).data
-
-            access_token, refresh_token = get_tokens_for_user(user)
-
-            data = {
-                "access_token": access_token,
-                "refresh_token": refresh_token,
-                "user": serialized_user,
-            }
-
-            SocialLoginConnection.objects.update_or_create(
-                medium=medium,
-                extra_data={},
-                user=user,
-                defaults={
-                    "token_data": {"id_token": id_token},
-                    "last_login_at": timezone.now(),
-                },
-            )
-
-            return Response(data, status=status.HTTP_200_OK)
-
-        except User.DoesNotExist:
-            ## Signup Case
-
-            username = uuid.uuid4().hex
-
-            if "@" in email:
-                email = data["email"]
-                mobile_number = uuid.uuid4().hex
-                channel = "email"
-                email_verified = True
-            else:
-                return Response(
-                    {
-                        "error": "Something went wrong. Please try again later or contact the support team."
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            user = User(
-                username=username,
-                email=email,
-                mobile_number=mobile_number,
-                first_name=data["first_name"],
-                last_name=data["last_name"],
-                is_email_verified=email_verified,
-                is_password_autoset=True,
-            )
-
-            user.set_password(uuid.uuid4().hex)
-            user.is_password_autoset = True
-            user.last_active = timezone.now()
-            user.last_login_time = timezone.now()
-            user.last_login_ip = request.META.get("REMOTE_ADDR")
-            user.last_login_medium = "oauth"
-            user.last_login_uagent = request.META.get("HTTP_USER_AGENT")
-            user.token_updated_at = timezone.now()
-            user.save()
-            serialized_user = UserSerializer(user).data
-
-            access_token, refresh_token = get_tokens_for_user(user)
-            data = {
-                "access_token": access_token,
-                "refresh_token": refresh_token,
-                "user": serialized_user,
-                "permissions": [],
-            }
-
-            SocialLoginConnection.objects.update_or_create(
-                medium=medium,
-                extra_data={},
-                user=user,
-                defaults={
-                    "token_data": {"id_token": id_token},
-                    "last_login_at": timezone.now(),
-                },
-            )
-            return Response(data, status=status.HTTP_201_CREATED)
-        except Exception as e:
-            print(e)
-
-            return Response(
-                {
-                    "error": "Something went wrong. Please try again later or contact the support team."
-                },
-                status=status.HTTP_400_BAD_REQUEST,
-            )

apiserver/plane/api/views/people.py

@@ -1,88 +0,0 @@
-# Third party imports
-from rest_framework.response import Response
-from rest_framework import status
-
-from sentry_sdk import capture_exception
-
-# Module imports
-from plane.api.serializers import (
-    UserSerializer,
-    WorkSpaceSerializer,
-)
-
-from plane.api.views.base import BaseViewSet, BaseAPIView
-from plane.db.models import User, Workspace
-
-
-class PeopleEndpoint(BaseAPIView):
-
-    filterset_fields = ("date_joined",)
-
-    search_fields = (
-        "^first_name",
-        "^last_name",
-        "^email",
-        "^username",
-    )
-
-    def get(self, request):
-        try:
-            users = User.objects.all().order_by("-date_joined")
-            if (
-                request.GET.get("search", None) is not None
-                and len(request.GET.get("search")) < 3
-            ):
-                return Response(
-                    {"message": "Search term must be at least 3 characters long"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-            return self.paginate(
-                request=request,
-                queryset=self.filter_queryset(users),
-                on_results=lambda data: UserSerializer(data, many=True).data,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"message": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class UserEndpoint(BaseViewSet):
-    serializer_class = UserSerializer
-    model = User
-
-    def get_object(self):
-        return self.request.user
-
-    def retrieve(self, request):
-        try:
-            workspace = Workspace.objects.get(pk=request.user.last_workspace_id)
-            return Response(
-                {"user": UserSerializer(request.user).data, "slug": workspace.slug}
-            )
-        except Workspace.DoesNotExist:
-            return Response({"user": UserSerializer(request.user).data, "slug": None})
-        except Exception as e:
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class UpdateUserOnBoardedEndpoint(BaseAPIView):
-    def patch(self, request):
-        try:
-            user = User.objects.get(pk=request.user.id)
-            user.is_onboarded = request.data.get("is_onboarded", False)
-            user.save()
-            return Response(
-                {"message": "Updated successfully"}, status=status.HTTP_200_OK
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )

apiserver/plane/api/views/project.py

@@ -1,121 +1,210 @@
-# Python imports
-import jwt
-from datetime import datetime
-
 # Django imports
-from django.core.exceptions import ValidationError
 from django.db import IntegrityError
-from django.db.models import Q
-from django.core.validators import validate_email
-from django.conf import settings
+from django.db.models import Exists, OuterRef, Q, F, Func, Subquery, Prefetch
 
-# Third Party imports
-from rest_framework.response import Response
+# Third party imports
 from rest_framework import status
-from rest_framework import serializers
-from sentry_sdk import capture_exception
+from rest_framework.response import Response
+from rest_framework.serializers import ValidationError
 
 # Module imports
-from .base import BaseViewSet, BaseAPIView
-from plane.api.serializers import (
-    ProjectSerializer,
-    ProjectMemberSerializer,
-    ProjectDetailSerializer,
-    ProjectMemberInviteSerializer,
-)
-
-from plane.api.permissions import ProjectBasePermission
-
 from plane.db.models import (
-    Project,
-    ProjectMember,
     Workspace,
-    ProjectMemberInvite,
-    User,
-    WorkspaceMember,
+    Project,
+    ProjectFavorite,
+    ProjectMember,
+    ProjectDeployBoard,
     State,
-    TeamMember,
+    Cycle,
+    Module,
+    IssueProperty,
+    Inbox,
 )
-
-from plane.db.models import (
-    Project,
-    ProjectMember,
-    Workspace,
-    ProjectMemberInvite,
-    User,
-    ProjectIdentifier,
-)
-from plane.bgtasks.project_invitation_task import project_invitation
+from plane.app.permissions import ProjectBasePermission
+from plane.api.serializers import ProjectSerializer
+from .base import BaseAPIView, WebhookMixin
 
 
-class ProjectViewSet(BaseViewSet):
+class ProjectAPIEndpoint(WebhookMixin, BaseAPIView):
+    """Project Endpoints to create, update, list, retrieve and delete endpoint"""
+
     serializer_class = ProjectSerializer
     model = Project
+    webhook_event = "project"
 
     permission_classes = [
         ProjectBasePermission,
     ]
 
-    def get_serializer_class(self, *args, **kwargs):
-        if self.action == "update" or self.action == "partial_update":
-            return ProjectSerializer
-        return ProjectDetailSerializer
-
     def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .filter(Q(project_projectmember__member=self.request.user) | Q(network=2))
-            .select_related("workspace", "workspace__owner")
+        return (
+            Project.objects.filter(workspace__slug=self.kwargs.get("slug"))
+            .filter(
+                Q(project_projectmember__member=self.request.user)
+                | Q(network=2)
+            )
+            .select_related(
+                "workspace",
+                "workspace__owner",
+                "default_assignee",
+                "project_lead",
+            )
+            .annotate(
+                is_member=Exists(
+                    ProjectMember.objects.filter(
+                        member=self.request.user,
+                        project_id=OuterRef("pk"),
+                        workspace__slug=self.kwargs.get("slug"),
+                        is_active=True,
+                    )
+                )
+            )
+            .annotate(
+                total_members=ProjectMember.objects.filter(
+                    project_id=OuterRef("id"),
+                    member__is_bot=False,
+                    is_active=True,
+                )
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
+            .annotate(
+                total_cycles=Cycle.objects.filter(project_id=OuterRef("id"))
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
+            .annotate(
+                total_modules=Module.objects.filter(project_id=OuterRef("id"))
+                .order_by()
+                .annotate(count=Func(F("id"), function="Count"))
+                .values("count")
+            )
+            .annotate(
+                member_role=ProjectMember.objects.filter(
+                    project_id=OuterRef("pk"),
+                    member_id=self.request.user.id,
+                    is_active=True,
+                ).values("role")
+            )
+            .annotate(
+                is_deployed=Exists(
+                    ProjectDeployBoard.objects.filter(
+                        project_id=OuterRef("pk"),
+                        workspace__slug=self.kwargs.get("slug"),
+                    )
+                )
+            )
+            .order_by(self.kwargs.get("order_by", "-created_at"))
             .distinct()
         )
 
-    def create(self, request, slug):
+    def get(self, request, slug, project_id=None):
+        if project_id is None:
+            sort_order_query = ProjectMember.objects.filter(
+                member=request.user,
+                project_id=OuterRef("pk"),
+                workspace__slug=self.kwargs.get("slug"),
+                is_active=True,
+            ).values("sort_order")
+            projects = (
+                self.get_queryset()
+                .annotate(sort_order=Subquery(sort_order_query))
+                .prefetch_related(
+                    Prefetch(
+                        "project_projectmember",
+                        queryset=ProjectMember.objects.filter(
+                            workspace__slug=slug,
+                            is_active=True,
+                        ).select_related("member"),
+                    )
+                )
+                .order_by(request.GET.get("order_by", "sort_order"))
+            )
+            return self.paginate(
+                request=request,
+                queryset=(projects),
+                on_results=lambda projects: ProjectSerializer(
+                    projects,
+                    many=True,
+                    fields=self.fields,
+                    expand=self.expand,
+                ).data,
+            )
+        project = self.get_queryset().get(workspace__slug=slug, pk=project_id)
+        serializer = ProjectSerializer(
+            project,
+            fields=self.fields,
+            expand=self.expand,
+        )
+        return Response(serializer.data, status=status.HTTP_200_OK)
+
+    def post(self, request, slug):
         try:
-
             workspace = Workspace.objects.get(slug=slug)
-
             serializer = ProjectSerializer(
                 data={**request.data}, context={"workspace_id": workspace.id}
             )
             if serializer.is_valid():
                 serializer.save()
 
-                ## Add the user as Administrator to the project
-                ProjectMember.objects.create(
-                    project_id=serializer.data["id"], member=request.user, role=20
+                # Add the user as Administrator to the project
+                project_member = ProjectMember.objects.create(
+                    project_id=serializer.data["id"],
+                    member=request.user,
+                    role=20,
+                )
+                # Also create the issue property for the user
+                _ = IssueProperty.objects.create(
+                    project_id=serializer.data["id"],
+                    user=request.user,
                 )
 
-                ## Default states
+                if serializer.data["project_lead"] is not None and str(
+                    serializer.data["project_lead"]
+                ) != str(request.user.id):
+                    ProjectMember.objects.create(
+                        project_id=serializer.data["id"],
+                        member_id=serializer.data["project_lead"],
+                        role=20,
+                    )
+                    # Also create the issue property for the user
+                    IssueProperty.objects.create(
+                        project_id=serializer.data["id"],
+                        user_id=serializer.data["project_lead"],
+                    )
+
+                # Default states
                 states = [
                     {
                         "name": "Backlog",
-                        "color": "#5e6ad2",
+                        "color": "#A3A3A3",
                         "sequence": 15000,
                         "group": "backlog",
+                        "default": True,
                     },
                     {
                         "name": "Todo",
-                        "color": "#eb5757",
+                        "color": "#3A3A3A",
                         "sequence": 25000,
                         "group": "unstarted",
                     },
                     {
                         "name": "In Progress",
-                        "color": "#26b5ce",
+                        "color": "#F59E0B",
                         "sequence": 35000,
                         "group": "started",
                     },
                     {
                         "name": "Done",
-                        "color": "#f2c94c",
+                        "color": "#16A34A",
                         "sequence": 45000,
                         "group": "completed",
                     },
                     {
                         "name": "Cancelled",
-                        "color": "#4cb782",
+                        "color": "#EF4444",
                         "sequence": 55000,
                         "group": "cancelled",
                     },
@@ -130,14 +219,24 @@ class ProjectViewSet(BaseViewSet):
                             sequence=state["sequence"],
                             workspace=serializer.instance.workspace,
                             group=state["group"],
+                            default=state.get("default", False),
+                            created_by=request.user,
                         )
                         for state in states
                     ]
                 )
 
-                return Response(serializer.data, status=status.HTTP_201_CREATED)
+                project = (
+                    self.get_queryset()
+                    .filter(pk=serializer.data["id"])
+                    .first()
+                )
+                serializer = ProjectSerializer(project)
+                return Response(
+                    serializer.data, status=status.HTTP_201_CREATED
+                )
             return Response(
-                [serializer.errors[error][0] for error in serializer.errors],
+                serializer.errors,
                 status=status.HTTP_400_BAD_REQUEST,
             )
         except IntegrityError as e:
@@ -148,25 +247,19 @@ class ProjectViewSet(BaseViewSet):
                 )
         except Workspace.DoesNotExist as e:
             return Response(
-                {"error": "Workspace does not exist"}, status=status.HTTP_404_NOT_FOUND
+                {"error": "Workspace does not exist"},
+                status=status.HTTP_404_NOT_FOUND,
             )
-        except serializers.ValidationError as e:
+        except ValidationError as e:
             return Response(
                 {"identifier": "The project identifier is already taken"},
                 status=status.HTTP_410_GONE,
             )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
 
-    def partial_update(self, request, slug, pk=None):
+    def patch(self, request, slug, project_id=None):
         try:
             workspace = Workspace.objects.get(slug=slug)
-
-            project = Project.objects.get(pk=pk)
+            project = Project.objects.get(pk=project_id)
 
             serializer = ProjectSerializer(
                 project,
@@ -177,491 +270,50 @@ class ProjectViewSet(BaseViewSet):
 
             if serializer.is_valid():
                 serializer.save()
-                return Response(serializer.data, status=status.HTTP_200_OK)
-            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+                if serializer.data["inbox_view"]:
+                    Inbox.objects.get_or_create(
+                        name=f"{project.name} Inbox",
+                        project=project,
+                        is_default=True,
+                    )
 
+                    # Create the triage state in Backlog group
+                    State.objects.get_or_create(
+                        name="Triage",
+                        group="backlog",
+                        description="Default state for managing all Inbox Issues",
+                        project_id=project_id,
+                        color="#ff7700",
+                    )
+
+                project = (
+                    self.get_queryset()
+                    .filter(pk=serializer.data["id"])
+                    .first()
+                )
+                serializer = ProjectSerializer(project)
+                return Response(serializer.data, status=status.HTTP_200_OK)
+            return Response(
+                serializer.errors, status=status.HTTP_400_BAD_REQUEST
+            )
         except IntegrityError as e:
             if "already exists" in str(e):
                 return Response(
                     {"name": "The project name is already taken"},
                     status=status.HTTP_410_GONE,
                 )
-        except (Project.DoesNotExist or Workspace.DoesNotExist) as e:
+        except (Project.DoesNotExist, Workspace.DoesNotExist):
             return Response(
-                {"error": "Project does not exist"}, status=status.HTTP_404_NOT_FOUND
+                {"error": "Project does not exist"},
+                status=status.HTTP_404_NOT_FOUND,
             )
-        except serializers.ValidationError as e:
+        except ValidationError as e:
             return Response(
                 {"identifier": "The project identifier is already taken"},
                 status=status.HTTP_410_GONE,
             )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
 
-
-class InviteProjectEndpoint(BaseAPIView):
-
-    permission_classes = [
-        ProjectBasePermission,
-    ]
-
-    def post(self, request, slug, project_id):
-        try:
-
-            email = request.data.get("email", False)
-            role = request.data.get("role", False)
-
-            # Check if email is provided
-            if not email:
-                return Response(
-                    {"error": "Email is required"}, status=status.HTTP_400_BAD_REQUEST
-                )
-
-            validate_email(email)
-            # Check if user is already a member of workspace
-            if ProjectMember.objects.filter(
-                project_id=project_id, member__email=email
-            ).exists():
-                return Response(
-                    {"error": "User is already member of workspace"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            user = User.objects.filter(email=email).first()
-
-            if user is None:
-                token = jwt.encode(
-                    {"email": email, "timestamp": datetime.now().timestamp()},
-                    settings.SECRET_KEY,
-                    algorithm="HS256",
-                )
-                project_invitation_obj = ProjectMemberInvite.objects.create(
-                    email=email.strip().lower(),
-                    project_id=project_id,
-                    token=token,
-                    role=role,
-                )
-                domain = settings.WEB_URL
-                project_invitation.delay(email, project_id, token, domain)
-
-                return Response(
-                    {
-                        "message": "Email sent successfully",
-                        "id": project_invitation_obj.id,
-                    },
-                    status=status.HTTP_200_OK,
-                )
-
-            project_member = ProjectMember.objects.create(
-                member=user, project_id=project_id, role=role
-            )
-
-            return Response(
-                ProjectMemberSerializer(project_member).data, status=status.HTTP_200_OK
-            )
-
-        except ValidationError:
-            return Response(
-                {
-                    "error": "Invalid email address provided a valid email address is required to send the invite"
-                },
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-        except (Workspace.DoesNotExist, Project.DoesNotExist) as e:
-            return Response(
-                {"error": "Workspace or Project does not exists"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class UserProjectInvitationsViewset(BaseViewSet):
-
-    serializer_class = ProjectMemberInviteSerializer
-    model = ProjectMemberInvite
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(email=self.request.user.email)
-            .select_related("workspace")
-        )
-
-    def create(self, request):
-        try:
-
-            invitations = request.data.get("invitations")
-            project_invitations = ProjectMemberInvite.objects.filter(
-                pk__in=invitations, accepted=True
-            )
-            ProjectMember.objects.bulk_create(
-                [
-                    ProjectMember(
-                        project=invitation.project,
-                        workspace=invitation.project.workspace,
-                        member=request.user,
-                        role=invitation.role,
-                    )
-                    for invitation in project_invitations
-                ]
-            )
-
-            ## Delete joined project invites
-            project_invitations.delete()
-
-            return Response(status=status.HTTP_200_OK)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class ProjectMemberViewSet(BaseViewSet):
-
-    serializer_class = ProjectMemberSerializer
-    model = ProjectMember
-    permission_classes = [
-        ProjectBasePermission,
-    ]
-
-    search_fields = [
-        "member__email",
-        "member__first_name",
-    ]
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .filter(project_id=self.kwargs.get("project_id"))
-            .select_related("project")
-            .select_related("member")
-        )
-
-
-class AddMemberToProjectEndpoint(BaseAPIView):
-
-    permission_classes = [
-        ProjectBasePermission,
-    ]
-
-    def post(self, request, slug, project_id):
-        try:
-
-            member_id = request.data.get("member_id", False)
-            role = request.data.get("role", False)
-
-            if not member_id or not role:
-                return Response(
-                    {"error": "Member ID and role is required"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            # Check if the user is a member in the workspace
-            if not WorkspaceMember.objects.filter(
-                workspace__slug=slug, member_id=member_id
-            ).exists():
-                # TODO: Update this error message - nk
-                return Response(
-                    {
-                        "error": "User is not a member of the workspace. Invite the user to the workspace to add him to project"
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            # Check if the user is already member of project
-            if ProjectMember.objects.filter(
-                project=project_id, member_id=member_id
-            ).exists():
-                return Response(
-                    {"error": "User is already a member of the project"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            # Add the user to project
-            project_member = ProjectMember.objects.create(
-                project_id=project_id, member_id=member_id, role=role
-            )
-
-            serializer = ProjectMemberSerializer(project_member)
-
-            return Response(serializer.data, status=status.HTTP_201_CREATED)
-
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class AddTeamToProjectEndpoint(BaseAPIView):
-
-    permission_classes = [
-        ProjectBasePermission,
-    ]
-
-    def post(self, request, slug, project_id):
-
-        try:
-            team_members = TeamMember.objects.filter(
-                workspace__slug=slug, team__in=request.data.get("teams", [])
-            ).values_list("member", flat=True)
-
-            if len(team_members) == 0:
-                return Response(
-                    {"error": "No such team exists"}, status=status.HTTP_400_BAD_REQUEST
-                )
-
-            workspace = Workspace.objects.get(slug=slug)
-
-            project_members = []
-            for member in team_members:
-                project_members.append(
-                    ProjectMember(
-                        project_id=project_id,
-                        member_id=member,
-                        workspace=workspace,
-                    )
-                )
-
-            ProjectMember.objects.bulk_create(
-                project_members, batch_size=10, ignore_conflicts=True
-            )
-
-            serializer = ProjectMemberSerializer(project_members, many=True)
-            return Response(serializer.data, status=status.HTTP_201_CREATED)
-        except IntegrityError as e:
-            if "already exists" in str(e):
-                return Response(
-                    {"error": "The team with the name already exists"},
-                    status=status.HTTP_410_GONE,
-                )
-        except Workspace.DoesNotExist:
-            return Response(
-                {"error": "The requested workspace could not be found"},
-                status=status.HTTP_404_NOT_FOUND,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class ProjectMemberInvitationsViewset(BaseViewSet):
-
-    serializer_class = ProjectMemberInviteSerializer
-    model = ProjectMemberInvite
-
-    search_fields = []
-
-    permission_classes = [
-        ProjectBasePermission,
-    ]
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .filter(project_id=self.kwargs.get("project_id"))
-            .select_related("project")
-        )
-
-
-class ProjectMemberInviteDetailViewSet(BaseViewSet):
-
-    serializer_class = ProjectMemberInviteSerializer
-    model = ProjectMemberInvite
-
-    search_fields = []
-
-    permission_classes = [
-        ProjectBasePermission,
-    ]
-
-    def get_queryset(self):
-        return self.filter_queryset(super().get_queryset().select_related("project"))
-
-
-class ProjectIdentifierEndpoint(BaseAPIView):
-
-    permission_classes = [
-        ProjectBasePermission,
-    ]
-
-    def get(self, request, slug):
-        try:
-
-            name = request.GET.get("name", "").strip().upper()
-
-            if name == "":
-                return Response(
-                    {"error": "Name is required"}, status=status.HTTP_400_BAD_REQUEST
-                )
-
-            exists = ProjectIdentifier.objects.filter(
-                name=name, workspace__slug=slug
-            ).values("id", "name", "project")
-
-            return Response(
-                {"exists": len(exists), "identifiers": exists},
-                status=status.HTTP_200_OK,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-    def delete(self, request, slug):
-        try:
-
-            name = request.data.get("name", "").strip().upper()
-
-            if name == "":
-                return Response(
-                    {"error": "Name is required"}, status=status.HTTP_400_BAD_REQUEST
-                )
-
-            if Project.objects.filter(identifier=name, workspace__slug=slug).exists():
-                return Response(
-                    {"error": "Cannot delete an identifier of an existing project"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            ProjectIdentifier.objects.filter(name=name, workspace__slug=slug).delete()
-
-            return Response(
-                status=status.HTTP_204_NO_CONTENT,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class ProjectJoinEndpoint(BaseAPIView):
-    def post(self, request, slug):
-        try:
-            project_ids = request.data.get("project_ids", [])
-
-            # Get the workspace user role
-            workspace_member = WorkspaceMember.objects.get(
-                member=request.user, workspace__slug=slug
-            )
-
-            workspace_role = workspace_member.role
-            workspace = workspace_member.workspace
-
-            ProjectMember.objects.bulk_create(
-                [
-                    ProjectMember(
-                        project_id=project_id,
-                        member=request.user,
-                        role=20
-                        if workspace_role >= 15
-                        else (15 if workspace_role == 10 else workspace_role),
-                        workspace=workspace,
-                    )
-                    for project_id in project_ids
-                ],
-                ignore_conflicts=True,
-            )
-
-            return Response(
-                {"message": "Projects joined successfully"},
-                status=status.HTTP_201_CREATED,
-            )
-        except WorkspaceMember.DoesNotExist:
-            return Response(
-                {"error": "User is not a member of workspace"},
-                status=status.HTTP_403_FORBIDDEN,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class ProjectUserViewsEndpoint(BaseAPIView):
-    def post(self, request, slug, project_id):
-        try:
-
-            project = Project.objects.get(pk=project_id, workspace__slug=slug)
-
-            project_member = ProjectMember.objects.filter(
-                member=request.user, project=project
-            ).first()
-
-            if project_member is None:
-                return Response(
-                    {"error": "Forbidden"}, status=status.HTTP_403_FORBIDDEN
-                )
-
-            view_props = project_member.view_props
-            default_props = project_member.default_props
-
-            project_member.view_props = request.data.get("view_props", view_props)
-            project_member.default_props = request.data.get(
-                "default_props", default_props
-            )
-
-            project_member.save()
-
-            return Response(status=status.HTTP_200_OK)
-
-        except Project.DoesNotExist:
-            return Response(
-                {"error": "The requested resource does not exists"},
-                status=status.HTTP_404_NOT_FOUND,
-            )
-        except Exception as e:
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class ProjectMemberUserEndpoint(BaseAPIView):
-    def get(self, request, slug, project_id):
-        try:
-
-            project_member = ProjectMember.objects.get(
-                project_id=project_id, workspace__slug=slug, member=request.user
-            )
-            serializer = ProjectMemberSerializer(project_member)
-
-            return Response(serializer.data, status=status.HTTP_200_OK)
-
-        except ProjectMember.DoesNotExist:
-            return Response(
-                {"error": "User not a member of the project"},
-                status=status.HTTP_403_FORBIDDEN,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
+    def delete(self, request, slug, project_id):
+        project = Project.objects.get(pk=project_id, workspace__slug=slug)
+        project.delete()
+        return Response(status=status.HTTP_204_NO_CONTENT)

apiserver/plane/api/views/shortcut.py

@@ -1,29 +0,0 @@
-# Module imports
-from . import BaseViewSet
-from plane.api.serializers import ShortCutSerializer
-from plane.api.permissions import ProjectEntityPermission
-from plane.db.models import Shortcut
-
-
-class ShortCutViewSet(BaseViewSet):
-
-    serializer_class = ShortCutSerializer
-    model = Shortcut
-    permission_classes = [
-        ProjectEntityPermission,
-    ]
-
-    def perform_create(self, serializer):
-        serializer.save(project_id=self.kwargs.get("project_id"))
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .filter(project_id=self.kwargs.get("project_id"))
-            .filter(project__project_projectmember__member=self.request.user)
-            .select_related("project")
-            .select_related("workspace")
-            .distinct()
-        )

apiserver/plane/api/views/state.py

@@ -1,29 +1,96 @@
+# Python imports
+from itertools import groupby
+
+# Django imports
+from django.db.models import Q
+
+# Third party imports
+from rest_framework.response import Response
+from rest_framework import status
+
 # Module imports
-from . import BaseViewSet
+from .base import BaseAPIView
 from plane.api.serializers import StateSerializer
-from plane.api.permissions import ProjectEntityPermission
-from plane.db.models import State
+from plane.app.permissions import ProjectEntityPermission
+from plane.db.models import State, Issue
 
 
-class StateViewSet(BaseViewSet):
-
+class StateAPIEndpoint(BaseAPIView):
     serializer_class = StateSerializer
     model = State
     permission_classes = [
         ProjectEntityPermission,
     ]
 
-    def perform_create(self, serializer):
-        serializer.save(project_id=self.kwargs.get("project_id"))
-
     def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
+        return (
+            State.objects.filter(workspace__slug=self.kwargs.get("slug"))
             .filter(project_id=self.kwargs.get("project_id"))
             .filter(project__project_projectmember__member=self.request.user)
+            .filter(~Q(name="Triage"))
             .select_related("project")
             .select_related("workspace")
             .distinct()
         )
+
+    def post(self, request, slug, project_id):
+        serializer = StateSerializer(
+            data=request.data, context={"project_id": project_id}
+        )
+        if serializer.is_valid():
+            serializer.save(project_id=project_id)
+            return Response(serializer.data, status=status.HTTP_200_OK)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+    def get(self, request, slug, project_id, state_id=None):
+        if state_id:
+            serializer = StateSerializer(self.get_queryset().get(pk=state_id))
+            return Response(serializer.data, status=status.HTTP_200_OK)
+        return self.paginate(
+            request=request,
+            queryset=(self.get_queryset()),
+            on_results=lambda states: StateSerializer(
+                states,
+                many=True,
+                fields=self.fields,
+                expand=self.expand,
+            ).data,
+        )
+
+    def delete(self, request, slug, project_id, state_id):
+        state = State.objects.get(
+            ~Q(name="Triage"),
+            pk=state_id,
+            project_id=project_id,
+            workspace__slug=slug,
+        )
+
+        if state.default:
+            return Response(
+                {"error": "Default state cannot be deleted"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # Check for any issues in the state
+        issue_exist = Issue.issue_objects.filter(state=state_id).exists()
+
+        if issue_exist:
+            return Response(
+                {
+                    "error": "The state is not empty, only empty states can be deleted"
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        state.delete()
+        return Response(status=status.HTTP_204_NO_CONTENT)
+
+    def patch(self, request, slug, project_id, state_id=None):
+        state = State.objects.get(
+            workspace__slug=slug, project_id=project_id, pk=state_id
+        )
+        serializer = StateSerializer(state, data=request.data, partial=True)
+        if serializer.is_valid():
+            serializer.save()
+            return Response(serializer.data, status=status.HTTP_200_OK)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

apiserver/plane/api/views/view.py

@@ -1,29 +0,0 @@
-# Module imports
-from . import BaseViewSet
-from plane.api.serializers import ViewSerializer
-from plane.api.permissions import ProjectEntityPermission
-from plane.db.models import View
-
-
-class ViewViewSet(BaseViewSet):
-
-    serializer_class = ViewSerializer
-    model = View
-    permission_classes = [
-        ProjectEntityPermission,
-    ]
-
-    def perform_create(self, serializer):
-        serializer.save(project_id=self.kwargs.get("project_id"))
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .filter(project_id=self.kwargs.get("project_id"))
-            .filter(project__project_projectmember__member=self.request.user)
-            .select_related("project")
-            .select_related("workspace")
-            .distinct()
-        )

apiserver/plane/api/views/workspace.py

@@ -1,590 +0,0 @@
-# Python imports
-import jwt
-from datetime import datetime
-
-# Django imports
-from django.db import IntegrityError
-from django.db.models import Prefetch
-from django.conf import settings
-from django.utils import timezone
-from django.core.exceptions import ValidationError
-from django.core.validators import validate_email
-from django.contrib.sites.shortcuts import get_current_site
-from django.db.models import CharField, Count
-from django.db.models.functions import Cast
-
-# Third party modules
-from rest_framework import status
-from rest_framework.response import Response
-from rest_framework.permissions import AllowAny
-from sentry_sdk import capture_exception
-
-# Module imports
-from plane.api.serializers import (
-    WorkSpaceSerializer,
-    WorkSpaceMemberSerializer,
-    TeamSerializer,
-    WorkSpaceMemberInviteSerializer,
-    UserLiteSerializer,
-    ProjectMemberSerializer,
-)
-from plane.api.views.base import BaseAPIView
-from . import BaseViewSet
-from plane.db.models import (
-    User,
-    Workspace,
-    WorkspaceMember,
-    WorkspaceMemberInvite,
-    Team,
-    ProjectMember,
-)
-from plane.api.permissions import WorkSpaceBasePermission, WorkSpaceAdminPermission
-from plane.bgtasks.workspace_invitation_task import workspace_invitation
-
-
-class WorkSpaceViewSet(BaseViewSet):
-
-    model = Workspace
-    serializer_class = WorkSpaceSerializer
-    permission_classes = [
-        WorkSpaceBasePermission,
-    ]
-
-    search_fields = [
-        "name",
-    ]
-    filterset_fields = [
-        "owner",
-    ]
-
-    lookup_field = "slug"
-
-    def get_queryset(self):
-        return self.filter_queryset(super().get_queryset().select_related("owner"))
-
-    def create(self, request):
-        try:
-            serializer = WorkSpaceSerializer(data=request.data)
-
-            if serializer.is_valid():
-                serializer.save(owner=request.user)
-                # Create Workspace member
-                _ = WorkspaceMember.objects.create(
-                    workspace_id=serializer.data["id"],
-                    member=request.user,
-                    role=20,
-                    company_role=request.data.get("company_role", ""),
-                )
-                return Response(serializer.data, status=status.HTTP_201_CREATED)
-            return Response(
-                [serializer.errors[error][0] for error in serializer.errors],
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-        ## Handling unique integrity error for now
-        ## TODO: Extend this to handle other common errors which are not automatically handled by APIException
-        except IntegrityError as e:
-            if "already exists" in str(e):
-                return Response(
-                    {"slug": "The workspace with the slug already exists"},
-                    status=status.HTTP_410_GONE,
-                )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {
-                    "error": "Something went wrong please try again later",
-                    "identifier": None,
-                },
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class UserWorkSpacesEndpoint(BaseAPIView):
-
-    search_fields = [
-        "name",
-    ]
-    filterset_fields = [
-        "owner",
-    ]
-
-    def get(self, request):
-        try:
-            workspace = (
-                Workspace.objects.prefetch_related(
-                    Prefetch("workspace_member", queryset=WorkspaceMember.objects.all())
-                )
-                .filter(
-                    workspace_member__member=request.user,
-                )
-                .select_related("owner")
-            ).annotate(total_members=Count("workspace_member"))
-
-            serializer = WorkSpaceSerializer(self.filter_queryset(workspace), many=True)
-            return Response(serializer.data, status=status.HTTP_200_OK)
-
-        except Exception as e:
-            print(e)
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class WorkSpaceAvailabilityCheckEndpoint(BaseAPIView):
-    def get(self, request):
-        try:
-            slug = request.GET.get("slug", False)
-
-            if not slug or slug == "":
-                return Response(
-                    {"error": "Workspace Slug is required"},
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            workspace = Workspace.objects.filter(slug=slug).exists()
-            return Response({"status": not workspace}, status=status.HTTP_200_OK)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class InviteWorkspaceEndpoint(BaseAPIView):
-
-    permission_classes = [
-        WorkSpaceAdminPermission,
-    ]
-
-    def post(self, request, slug):
-        try:
-
-            emails = request.data.get("emails", False)
-            # Check if email is provided
-            if not emails or not len(emails):
-                return Response(
-                    {"error": "Emails are required"}, status=status.HTTP_400_BAD_REQUEST
-                )
-
-            workspace = Workspace.objects.get(slug=slug)
-
-            # Check if user is already a member of workspace
-            workspace_members = WorkspaceMember.objects.filter(
-                workspace_id=workspace.id,
-                member__email__in=[email.get("email") for email in emails],
-            )
-
-            if len(workspace_members):
-                return Response(
-                    {
-                        "error": "Some users are already member of workspace",
-                        "workspace_users": WorkSpaceMemberSerializer(
-                            workspace_members, many=True
-                        ).data,
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            workspace_invitations = []
-            for email in emails:
-                try:
-                    validate_email(email.get("email"))
-                    workspace_invitations.append(
-                        WorkspaceMemberInvite(
-                            email=email.get("email").strip().lower(),
-                            workspace_id=workspace.id,
-                            token=jwt.encode(
-                                {
-                                    "email": email,
-                                    "timestamp": datetime.now().timestamp(),
-                                },
-                                settings.SECRET_KEY,
-                                algorithm="HS256",
-                            ),
-                            role=email.get("role", 10),
-                        )
-                    )
-                except ValidationError:
-                    return Response(
-                        {
-                            "error": f"Invalid email - {email} provided a valid email address is required to send the invite"
-                        },
-                        status=status.HTTP_400_BAD_REQUEST,
-                    )
-            WorkspaceMemberInvite.objects.bulk_create(
-                workspace_invitations, batch_size=10, ignore_conflicts=True
-            )
-
-            workspace_invitations = WorkspaceMemberInvite.objects.filter(
-                email__in=[email.get("email") for email in emails]
-            ).select_related("workspace")
-
-            for invitation in workspace_invitations:
-                workspace_invitation.delay(
-                    invitation.email,
-                    workspace.id,
-                    invitation.token,
-                    settings.WEB_URL,
-                    request.user.email,
-                )
-
-            return Response(
-                {
-                    "message": "Emails sent successfully",
-                },
-                status=status.HTTP_200_OK,
-            )
-
-        except Workspace.DoesNotExist:
-            return Response(
-                {"error": "Workspace does not exists"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class JoinWorkspaceEndpoint(BaseAPIView):
-    permission_classes = [
-        AllowAny,
-    ]
-
-    def post(self, request, slug, pk):
-        try:
-
-            workspace_invite = WorkspaceMemberInvite.objects.get(
-                pk=pk, workspace__slug=slug
-            )
-
-            email = request.data.get("email", "")
-
-            if email == "" or workspace_invite.email != email:
-                return Response(
-                    {"error": "You do not have permission to join the workspace"},
-                    status=status.HTTP_403_FORBIDDEN,
-                )
-
-            if workspace_invite.responded_at is None:
-                workspace_invite.accepted = request.data.get("accepted", False)
-                workspace_invite.responded_at = timezone.now()
-                workspace_invite.save()
-
-                if workspace_invite.accepted:
-
-                    # Check if the user created account after invitation
-                    user = User.objects.filter(email=email).first()
-
-                    # If the user is present then create the workspace member
-                    if user is not None:
-                        WorkspaceMember.objects.create(
-                            workspace=workspace_invite.workspace,
-                            member=user,
-                            role=workspace_invite.role,
-                        )
-
-                        user.last_workspace_id = workspace_invite.workspace.id
-                        user.save()
-
-                        # Delete the invitation
-                        workspace_invite.delete()
-
-                    return Response(
-                        {"message": "Workspace Invitation Accepted"},
-                        status=status.HTTP_200_OK,
-                    )
-
-                return Response(
-                    {"message": "Workspace Invitation was not accepted"},
-                    status=status.HTTP_200_OK,
-                )
-
-            return Response(
-                {"error": "You have already responded to the invitation request"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-        except WorkspaceMemberInvite.DoesNotExist:
-            return Response(
-                {"error": "The invitation either got expired or could not be found"},
-                status=status.HTTP_404_NOT_FOUND,
-            )
-        except Exception as e:
-            print(e)
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class WorkspaceInvitationsViewset(BaseViewSet):
-
-    serializer_class = WorkSpaceMemberInviteSerializer
-    model = WorkspaceMemberInvite
-
-    permission_classes = [
-        WorkSpaceAdminPermission,
-    ]
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .select_related("workspace")
-        )
-
-
-class UserWorkspaceInvitationsEndpoint(BaseViewSet):
-
-    serializer_class = WorkSpaceMemberInviteSerializer
-    model = WorkspaceMemberInvite
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(email=self.request.user.email)
-            .select_related("workspace")
-        )
-
-    def create(self, request):
-        try:
-
-            invitations = request.data.get("invitations")
-            workspace_invitations = WorkspaceMemberInvite.objects.filter(
-                pk__in=invitations
-            )
-
-            WorkspaceMember.objects.bulk_create(
-                [
-                    WorkspaceMember(
-                        workspace=invitation.workspace,
-                        member=request.user,
-                        role=invitation.role,
-                    )
-                    for invitation in workspace_invitations
-                ],
-                ignore_conflicts=True,
-            )
-
-            # Delete joined workspace invites
-            workspace_invitations.delete()
-
-            return Response(status=status.HTTP_200_OK)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class WorkSpaceMemberViewSet(BaseViewSet):
-
-    serializer_class = WorkSpaceMemberSerializer
-    model = WorkspaceMember
-
-    permission_classes = [
-        WorkSpaceAdminPermission,
-    ]
-
-    search_fields = [
-        "member__email",
-        "member__first_name",
-    ]
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .select_related("workspace", "workspace__owner")
-            .select_related("member")
-        )
-
-
-class TeamMemberViewSet(BaseViewSet):
-
-    serializer_class = TeamSerializer
-    model = Team
-    permission_classes = [
-        WorkSpaceAdminPermission,
-    ]
-
-    search_fields = [
-        "member__email",
-        "member__first_name",
-    ]
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(workspace__slug=self.kwargs.get("slug"))
-            .select_related("workspace", "workspace__owner")
-            .prefetch_related("members")
-        )
-
-    def create(self, request, slug):
-
-        try:
-
-            members = list(
-                WorkspaceMember.objects.filter(
-                    workspace__slug=slug, member__id__in=request.data.get("members", [])
-                )
-                .annotate(member_str_id=Cast("member", output_field=CharField()))
-                .distinct()
-                .values_list("member_str_id", flat=True)
-            )
-
-            if len(members) != len(request.data.get("members", [])):
-
-                users = list(set(request.data.get("members", [])).difference(members))
-                users = User.objects.filter(pk__in=users)
-
-                serializer = UserLiteSerializer(users, many=True)
-                return Response(
-                    {
-                        "error": f"{len(users)} of the member(s) are not a part of the workspace",
-                        "members": serializer.data,
-                    },
-                    status=status.HTTP_400_BAD_REQUEST,
-                )
-
-            workspace = Workspace.objects.get(slug=slug)
-
-            serializer = TeamSerializer(
-                data=request.data, context={"workspace": workspace}
-            )
-            if serializer.is_valid():
-                serializer.save()
-                return Response(serializer.data, status=status.HTTP_201_CREATED)
-            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
-        except IntegrityError as e:
-            if "already exists" in str(e):
-                return Response(
-                    {"error": "The team with the name already exists"},
-                    status=status.HTTP_410_GONE,
-                )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class UserWorkspaceInvitationEndpoint(BaseViewSet):
-
-    model = WorkspaceMemberInvite
-    serializer_class = WorkSpaceMemberInviteSerializer
-
-    permission_classes = [
-        AllowAny,
-    ]
-
-    def get_queryset(self):
-        return self.filter_queryset(
-            super()
-            .get_queryset()
-            .filter(pk=self.kwargs.get("pk"))
-            .select_related("workspace")
-        )
-
-
-class UserLastProjectWithWorkspaceEndpoint(BaseAPIView):
-    def get(self, request):
-        try:
-
-            user = User.objects.get(pk=request.user.id)
-
-            last_workspace_id = user.last_workspace_id
-
-            if last_workspace_id is None:
-                return Response(
-                    {
-                        "project_details": [],
-                        "workspace_details": {},
-                    },
-                    status=status.HTTP_200_OK,
-                )
-
-            workspace = Workspace.objects.get(pk=last_workspace_id)
-            workspace_serializer = WorkSpaceSerializer(workspace)
-
-            project_member = ProjectMember.objects.filter(
-                workspace_id=last_workspace_id, member=request.user
-            ).select_related("workspace", "project", "member")
-
-            project_member_serializer = ProjectMemberSerializer(
-                project_member, many=True
-            )
-
-            return Response(
-                {
-                    "workspace_details": workspace_serializer.data,
-                    "project_details": project_member_serializer.data,
-                },
-                status=status.HTTP_200_OK,
-            )
-
-        except User.DoesNotExist:
-            return Response({"error": "Forbidden"}, status=status.HTTP_403_FORBIDDEN)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class WorkspaceMemberUserEndpoint(BaseAPIView):
-    def get(self, request, slug):
-        try:
-            workspace_member = WorkspaceMember.objects.get(
-                member=request.user, workspace__slug=slug
-            )
-            serializer = WorkSpaceMemberSerializer(workspace_member)
-            return Response(serializer.data, status=status.HTTP_200_OK)
-        except (Workspace.DoesNotExist, WorkspaceMember.DoesNotExist):
-            return Response({"error": "Forbidden"}, status=status.HTTP_403_FORBIDDEN)
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )
-
-
-class WorkspaceMemberUserViewsEndpoint(BaseAPIView):
-    def post(self, request, slug):
-        try:
-
-            workspace_member = WorkspaceMember.objects.get(
-                workspace__slug=slug, member=request.user
-            )
-            workspace_member.view_props = request.data.get("view_props", {})
-            workspace_member.save()
-
-            return Response(status=status.HTTP_200_OK)
-        except WorkspaceMember.DoesNotExist:
-            return Response(
-                {"error": "User not a member of workspace"},
-                status=status.HTTP_403_FORBIDDEN,
-            )
-        except Exception as e:
-            capture_exception(e)
-            return Response(
-                {"error": "Something went wrong please try again later"},
-                status=status.HTTP_400_BAD_REQUEST,
-            )

apiserver/plane/app/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AppApiConfig(AppConfig):
+    name = "plane.app"

apiserver/plane/app/middleware/api_authentication.py

@@ -0,0 +1,50 @@
+# Django imports
+from django.utils import timezone
+from django.db.models import Q
+
+# Third party imports
+from rest_framework import authentication
+from rest_framework.exceptions import AuthenticationFailed
+
+# Module imports
+from plane.db.models import APIToken
+
+
+class APIKeyAuthentication(authentication.BaseAuthentication):
+    """
+    Authentication with an API Key
+    """
+
+    www_authenticate_realm = "api"
+    media_type = "application/json"
+    auth_header_name = "X-Api-Key"
+
+    def get_api_token(self, request):
+        return request.headers.get(self.auth_header_name)
+
+    def validate_api_token(self, token):
+        try:
+            api_token = APIToken.objects.get(
+                Q(
+                    Q(expired_at__gt=timezone.now())
+                    | Q(expired_at__isnull=True)
+                ),
+                token=token,
+                is_active=True,
+            )
+        except APIToken.DoesNotExist:
+            raise AuthenticationFailed("Given API token is not valid")
+
+        # save api token last used
+        api_token.last_used = timezone.now()
+        api_token.save(update_fields=["last_used"])
+        return (api_token.user, api_token.token)
+
+    def authenticate(self, request):
+        token = self.get_api_token(request=request)
+        if not token:
+            return None
+
+        # Validate the API token
+        user, token = self.validate_api_token(token)
+        return user, token

apiserver/plane/app/permissions/__init__.py

@@ -0,0 +1,14 @@
+from .workspace import (
+    WorkSpaceBasePermission,
+    WorkspaceOwnerPermission,
+    WorkSpaceAdminPermission,
+    WorkspaceEntityPermission,
+    WorkspaceViewerPermission,
+    WorkspaceUserPermission,
+)
+from .project import (
+    ProjectBasePermission,
+    ProjectEntityPermission,
+    ProjectMemberPermission,
+    ProjectLitePermission,
+)

apiserver/plane/app/permissions/project.py

@@ -0,0 +1,111 @@
+# Third Party imports
+from rest_framework.permissions import BasePermission, SAFE_METHODS
+
+# Module import
+from plane.db.models import WorkspaceMember, ProjectMember
+
+# Permission Mappings
+Admin = 20
+Member = 15
+Viewer = 10
+Guest = 5
+
+
+class ProjectBasePermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        ## Safe Methods -> Handle the filtering logic in queryset
+        if request.method in SAFE_METHODS:
+            return WorkspaceMember.objects.filter(
+                workspace__slug=view.workspace_slug,
+                member=request.user,
+                is_active=True,
+            ).exists()
+
+        ## Only workspace owners or admins can create the projects
+        if request.method == "POST":
+            return WorkspaceMember.objects.filter(
+                workspace__slug=view.workspace_slug,
+                member=request.user,
+                role__in=[Admin, Member],
+                is_active=True,
+            ).exists()
+
+        ## Only Project Admins can update project attributes
+        return ProjectMember.objects.filter(
+            workspace__slug=view.workspace_slug,
+            member=request.user,
+            role=Admin,
+            project_id=view.project_id,
+            is_active=True,
+        ).exists()
+
+
+class ProjectMemberPermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        ## Safe Methods -> Handle the filtering logic in queryset
+        if request.method in SAFE_METHODS:
+            return ProjectMember.objects.filter(
+                workspace__slug=view.workspace_slug,
+                member=request.user,
+                is_active=True,
+            ).exists()
+        ## Only workspace owners or admins can create the projects
+        if request.method == "POST":
+            return WorkspaceMember.objects.filter(
+                workspace__slug=view.workspace_slug,
+                member=request.user,
+                role__in=[Admin, Member],
+                is_active=True,
+            ).exists()
+
+        ## Only Project Admins can update project attributes
+        return ProjectMember.objects.filter(
+            workspace__slug=view.workspace_slug,
+            member=request.user,
+            role__in=[Admin, Member],
+            project_id=view.project_id,
+            is_active=True,
+        ).exists()
+
+
+class ProjectEntityPermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        ## Safe Methods -> Handle the filtering logic in queryset
+        if request.method in SAFE_METHODS:
+            return ProjectMember.objects.filter(
+                workspace__slug=view.workspace_slug,
+                member=request.user,
+                project_id=view.project_id,
+                is_active=True,
+            ).exists()
+
+        ## Only project members or admins can create and edit the project attributes
+        return ProjectMember.objects.filter(
+            workspace__slug=view.workspace_slug,
+            member=request.user,
+            role__in=[Admin, Member],
+            project_id=view.project_id,
+            is_active=True,
+        ).exists()
+
+
+class ProjectLitePermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        return ProjectMember.objects.filter(
+            workspace__slug=view.workspace_slug,
+            member=request.user,
+            project_id=view.project_id,
+            is_active=True,
+        ).exists()

apiserver/plane/app/permissions/workspace.py

@@ -0,0 +1,115 @@
+# Third Party imports
+from rest_framework.permissions import BasePermission, SAFE_METHODS
+
+# Module imports
+from plane.db.models import WorkspaceMember
+
+
+# Permission Mappings
+Owner = 20
+Admin = 15
+Member = 10
+Guest = 5
+
+
+# TODO: Move the below logic to python match - python v3.10
+class WorkSpaceBasePermission(BasePermission):
+    def has_permission(self, request, view):
+        # allow anyone to create a workspace
+        if request.user.is_anonymous:
+            return False
+
+        if request.method == "POST":
+            return True
+
+        ## Safe Methods
+        if request.method in SAFE_METHODS:
+            return True
+
+        # allow only admins and owners to update the workspace settings
+        if request.method in ["PUT", "PATCH"]:
+            return WorkspaceMember.objects.filter(
+                member=request.user,
+                workspace__slug=view.workspace_slug,
+                role__in=[Owner, Admin],
+                is_active=True,
+            ).exists()
+
+        # allow only owner to delete the workspace
+        if request.method == "DELETE":
+            return WorkspaceMember.objects.filter(
+                member=request.user,
+                workspace__slug=view.workspace_slug,
+                role=Owner,
+                is_active=True,
+            ).exists()
+
+
+class WorkspaceOwnerPermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        return WorkspaceMember.objects.filter(
+            workspace__slug=view.workspace_slug,
+            member=request.user,
+            role=Owner,
+        ).exists()
+
+
+class WorkSpaceAdminPermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        return WorkspaceMember.objects.filter(
+            member=request.user,
+            workspace__slug=view.workspace_slug,
+            role__in=[Owner, Admin],
+            is_active=True,
+        ).exists()
+
+
+class WorkspaceEntityPermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        ## Safe Methods -> Handle the filtering logic in queryset
+        if request.method in SAFE_METHODS:
+            return WorkspaceMember.objects.filter(
+                workspace__slug=view.workspace_slug,
+                member=request.user,
+                is_active=True,
+            ).exists()
+
+        return WorkspaceMember.objects.filter(
+            member=request.user,
+            workspace__slug=view.workspace_slug,
+            role__in=[Owner, Admin],
+            is_active=True,
+        ).exists()
+
+
+class WorkspaceViewerPermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        return WorkspaceMember.objects.filter(
+            member=request.user,
+            workspace__slug=view.workspace_slug,
+            is_active=True,
+        ).exists()
+
+
+class WorkspaceUserPermission(BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_anonymous:
+            return False
+
+        return WorkspaceMember.objects.filter(
+            member=request.user,
+            workspace__slug=view.workspace_slug,
+            is_active=True,
+        ).exists()

apiserver/plane/app/serializers/__init__.py

@@ -0,0 +1,125 @@
+from .base import BaseSerializer
+from .user import (
+    UserSerializer,
+    UserLiteSerializer,
+    ChangePasswordSerializer,
+    ResetPasswordSerializer,
+    UserAdminLiteSerializer,
+    UserMeSerializer,
+    UserMeSettingsSerializer,
+)
+from .workspace import (
+    WorkSpaceSerializer,
+    WorkSpaceMemberSerializer,
+    TeamSerializer,
+    WorkSpaceMemberInviteSerializer,
+    WorkspaceLiteSerializer,
+    WorkspaceThemeSerializer,
+    WorkspaceMemberAdminSerializer,
+    WorkspaceMemberMeSerializer,
+    WorkspaceUserPropertiesSerializer,
+)
+from .project import (
+    ProjectSerializer,
+    ProjectListSerializer,
+    ProjectDetailSerializer,
+    ProjectMemberSerializer,
+    ProjectMemberInviteSerializer,
+    ProjectIdentifierSerializer,
+    ProjectFavoriteSerializer,
+    ProjectLiteSerializer,
+    ProjectMemberLiteSerializer,
+    ProjectDeployBoardSerializer,
+    ProjectMemberAdminSerializer,
+    ProjectPublicMemberSerializer,
+    ProjectMemberRoleSerializer,
+)
+from .state import StateSerializer, StateLiteSerializer
+from .view import (
+    GlobalViewSerializer,
+    IssueViewSerializer,
+    IssueViewFavoriteSerializer,
+)
+from .cycle import (
+    CycleSerializer,
+    CycleIssueSerializer,
+    CycleFavoriteSerializer,
+    CycleWriteSerializer,
+    CycleUserPropertiesSerializer,
+)
+from .asset import FileAssetSerializer
+from .issue import (
+    IssueCreateSerializer,
+    IssueActivitySerializer,
+    IssueCommentSerializer,
+    IssuePropertySerializer,
+    IssueAssigneeSerializer,
+    LabelSerializer,
+    IssueSerializer,
+    IssueFlatSerializer,
+    IssueStateSerializer,
+    IssueLinkSerializer,
+    IssueLiteSerializer,
+    IssueAttachmentSerializer,
+    IssueSubscriberSerializer,
+    IssueReactionSerializer,
+    CommentReactionSerializer,
+    IssueVoteSerializer,
+    IssueRelationSerializer,
+    RelatedIssueSerializer,
+    IssuePublicSerializer,
+)
+
+from .module import (
+    ModuleWriteSerializer,
+    ModuleSerializer,
+    ModuleIssueSerializer,
+    ModuleLinkSerializer,
+    ModuleFavoriteSerializer,
+    ModuleUserPropertiesSerializer,
+)
+
+from .api import APITokenSerializer, APITokenReadSerializer
+
+from .integration import (
+    IntegrationSerializer,
+    WorkspaceIntegrationSerializer,
+    GithubIssueSyncSerializer,
+    GithubRepositorySerializer,
+    GithubRepositorySyncSerializer,
+    GithubCommentSyncSerializer,
+    SlackProjectSyncSerializer,
+)
+
+from .importer import ImporterSerializer
+
+from .page import (
+    PageSerializer,
+    PageLogSerializer,
+    SubPageSerializer,
+    PageFavoriteSerializer,
+)
+
+from .estimate import (
+    EstimateSerializer,
+    EstimatePointSerializer,
+    EstimateReadSerializer,
+    WorkspaceEstimateSerializer,
+)
+
+from .inbox import (
+    InboxSerializer,
+    InboxIssueSerializer,
+    IssueStateInboxSerializer,
+    InboxIssueLiteSerializer,
+)
+
+from .analytic import AnalyticViewSerializer
+
+from .notification import NotificationSerializer, UserNotificationPreferenceSerializer
+
+from .exporter import ExporterHistorySerializer
+
+from .webhook import WebhookSerializer, WebhookLogSerializer
+
+from .dashboard import DashboardSerializer, WidgetSerializer

apiserver/plane/app/serializers/analytic.py

@@ -0,0 +1,30 @@
+from .base import BaseSerializer
+from plane.db.models import AnalyticView
+from plane.utils.issue_filters import issue_filters
+
+
+class AnalyticViewSerializer(BaseSerializer):
+    class Meta:
+        model = AnalyticView
+        fields = "__all__"
+        read_only_fields = [
+            "workspace",
+            "query",
+        ]
+
+    def create(self, validated_data):
+        query_params = validated_data.get("query_dict", {})
+        if bool(query_params):
+            validated_data["query"] = issue_filters(query_params, "POST")
+        else:
+            validated_data["query"] = {}
+        return AnalyticView.objects.create(**validated_data)
+
+    def update(self, instance, validated_data):
+        query_params = validated_data.get("query_data", {})
+        if bool(query_params):
+            validated_data["query"] = issue_filters(query_params, "POST")
+        else:
+            validated_data["query"] = {}
+        validated_data["query"] = issue_filters(query_params, "PATCH")
+        return super().update(instance, validated_data)

apiserver/plane/app/serializers/api.py

@@ -0,0 +1,28 @@
+from .base import BaseSerializer
+from plane.db.models import APIToken, APIActivityLog
+
+
+class APITokenSerializer(BaseSerializer):
+    class Meta:
+        model = APIToken
+        fields = "__all__"
+        read_only_fields = [
+            "token",
+            "expired_at",
+            "created_at",
+            "updated_at",
+            "workspace",
+            "user",
+        ]
+
+
+class APITokenReadSerializer(BaseSerializer):
+    class Meta:
+        model = APIToken
+        exclude = ("token",)
+
+
+class APIActivityLogSerializer(BaseSerializer):
+    class Meta:
+        model = APIActivityLog
+        fields = "__all__"

apiserver/plane/app/serializers/base.py

@@ -0,0 +1,148 @@
+from rest_framework import serializers
+
+
+class BaseSerializer(serializers.ModelSerializer):
+    id = serializers.PrimaryKeyRelatedField(read_only=True)
+
+
+class DynamicBaseSerializer(BaseSerializer):
+    def __init__(self, *args, **kwargs):
+        # If 'fields' is provided in the arguments, remove it and store it separately.
+        # This is done so as not to pass this custom argument up to the superclass.
+        fields = kwargs.pop("fields", [])
+        self.expand = kwargs.pop("expand", []) or []
+        fields = self.expand
+
+        # Call the initialization of the superclass.
+        super().__init__(*args, **kwargs)
+        # If 'fields' was provided, filter the fields of the serializer accordingly.
+        if fields is not None:
+            self.fields = self._filter_fields(fields)
+
+    def _filter_fields(self, fields):
+        """
+        Adjust the serializer's fields based on the provided 'fields' list.
+
+        :param fields: List or dictionary specifying which fields to include in the serializer.
+        :return: The updated fields for the serializer.
+        """
+        # Check each field_name in the provided fields.
+        for field_name in fields:
+            # If the field is a dictionary (indicating nested fields),
+            # loop through its keys and values.
+            if isinstance(field_name, dict):
+                for key, value in field_name.items():
+                    # If the value of this nested field is a list,
+                    # perform a recursive filter on it.
+                    if isinstance(value, list):
+                        self._filter_fields(self.fields[key], value)
+
+        # Create a list to store allowed fields.
+        allowed = []
+        for item in fields:
+            # If the item is a string, it directly represents a field's name.
+            if isinstance(item, str):
+                allowed.append(item)
+            # If the item is a dictionary, it represents a nested field.
+            # Add the key of this dictionary to the allowed list.
+            elif isinstance(item, dict):
+                allowed.append(list(item.keys())[0])
+
+        for field in allowed:
+            if field not in self.fields:
+                from . import (
+                    WorkspaceLiteSerializer,
+                    ProjectLiteSerializer,
+                    UserLiteSerializer,
+                    StateLiteSerializer,
+                    IssueSerializer,
+                    LabelSerializer,
+                    CycleIssueSerializer,
+                    IssueFlatSerializer,
+                    IssueRelationSerializer,
+                    InboxIssueLiteSerializer
+                )
+
+                # Expansion mapper
+                expansion = {
+                    "user": UserLiteSerializer,
+                    "workspace": WorkspaceLiteSerializer,
+                    "project": ProjectLiteSerializer,
+                    "default_assignee": UserLiteSerializer,
+                    "project_lead": UserLiteSerializer,
+                    "state": StateLiteSerializer,
+                    "created_by": UserLiteSerializer,
+                    "issue": IssueSerializer,
+                    "actor": UserLiteSerializer,
+                    "owned_by": UserLiteSerializer,
+                    "members": UserLiteSerializer,
+                    "assignees": UserLiteSerializer,
+                    "labels": LabelSerializer,
+                    "issue_cycle": CycleIssueSerializer,
+                    "parent": IssueSerializer,
+                    "issue_relation": IssueRelationSerializer,
+                    "issue_inbox" : InboxIssueLiteSerializer,
+                }
+                
+                self.fields[field] = expansion[field](many=True if field in ["members", "assignees", "labels", "issue_cycle", "issue_relation", "issue_inbox"] else False)            
+
+        return self.fields
+
+    def to_representation(self, instance):
+        response = super().to_representation(instance)
+
+        # Ensure 'expand' is iterable before processing
+        if self.expand:
+            for expand in self.expand:
+                if expand in self.fields:
+                    # Import all the expandable serializers
+                    from . import (
+                        WorkspaceLiteSerializer,
+                        ProjectLiteSerializer,
+                        UserLiteSerializer,
+                        StateLiteSerializer,
+                        IssueSerializer,
+                        LabelSerializer,
+                        CycleIssueSerializer,
+                        IssueRelationSerializer,
+                        InboxIssueLiteSerializer
+                    )
+
+                    # Expansion mapper
+                    expansion = {
+                        "user": UserLiteSerializer,
+                        "workspace": WorkspaceLiteSerializer,
+                        "project": ProjectLiteSerializer,
+                        "default_assignee": UserLiteSerializer,
+                        "project_lead": UserLiteSerializer,
+                        "state": StateLiteSerializer,
+                        "created_by": UserLiteSerializer,
+                        "issue": IssueSerializer,
+                        "actor": UserLiteSerializer,
+                        "owned_by": UserLiteSerializer,
+                        "members": UserLiteSerializer,
+                        "assignees": UserLiteSerializer,
+                        "labels": LabelSerializer,
+                        "issue_cycle": CycleIssueSerializer,
+                        "parent": IssueSerializer,
+                        "issue_relation": IssueRelationSerializer,
+                        "issue_inbox" : InboxIssueLiteSerializer,
+                    }
+                    # Check if field in expansion then expand the field
+                    if expand in expansion:
+                        if isinstance(response.get(expand), list):
+                            exp_serializer = expansion[expand](
+                                getattr(instance, expand), many=True
+                            )
+                        else:
+                            exp_serializer = expansion[expand](
+                                getattr(instance, expand)
+                            )
+                        response[expand] = exp_serializer.data
+                    else:
+                        # You might need to handle this case differently
+                        response[expand] = getattr(
+                            instance, f"{expand}_id", None
+                        )
+
+        return response

apiserver/plane/app/serializers/cycle.py

@@ -0,0 +1,129 @@
+# Third party imports
+from rest_framework import serializers
+
+# Module imports
+from .base import BaseSerializer
+from .user import UserLiteSerializer
+from .issue import IssueStateSerializer
+from .workspace import WorkspaceLiteSerializer
+from .project import ProjectLiteSerializer
+from plane.db.models import (
+    Cycle,
+    CycleIssue,
+    CycleFavorite,
+    CycleUserProperties,
+)
+
+
+class CycleWriteSerializer(BaseSerializer):
+    def validate(self, data):
+        if (
+            data.get("start_date", None) is not None
+            and data.get("end_date", None) is not None
+            and data.get("start_date", None) > data.get("end_date", None)
+        ):
+            raise serializers.ValidationError(
+                "Start date cannot exceed end date"
+            )
+        return data
+
+    class Meta:
+        model = Cycle
+        fields = "__all__"
+
+
+class CycleSerializer(BaseSerializer):
+    is_favorite = serializers.BooleanField(read_only=True)
+    total_issues = serializers.IntegerField(read_only=True)
+    cancelled_issues = serializers.IntegerField(read_only=True)
+    completed_issues = serializers.IntegerField(read_only=True)
+    started_issues = serializers.IntegerField(read_only=True)
+    unstarted_issues = serializers.IntegerField(read_only=True)
+    backlog_issues = serializers.IntegerField(read_only=True)
+    assignees = serializers.SerializerMethodField(read_only=True)
+    total_estimates = serializers.IntegerField(read_only=True)
+    completed_estimates = serializers.IntegerField(read_only=True)
+    started_estimates = serializers.IntegerField(read_only=True)
+    workspace_detail = WorkspaceLiteSerializer(
+        read_only=True, source="workspace"
+    )
+    project_detail = ProjectLiteSerializer(read_only=True, source="project")
+    status = serializers.CharField(read_only=True)
+
+    def validate(self, data):
+        if (
+            data.get("start_date", None) is not None
+            and data.get("end_date", None) is not None
+            and data.get("start_date", None) > data.get("end_date", None)
+        ):
+            raise serializers.ValidationError(
+                "Start date cannot exceed end date"
+            )
+        return data
+
+    def get_assignees(self, obj):
+        members = [
+            {
+                "avatar": assignee.avatar,
+                "display_name": assignee.display_name,
+                "id": assignee.id,
+            }
+            for issue_cycle in obj.issue_cycle.prefetch_related(
+                "issue__assignees"
+            ).all()
+            for assignee in issue_cycle.issue.assignees.all()
+        ]
+        # Use a set comprehension to return only the unique objects
+        unique_objects = {frozenset(item.items()) for item in members}
+
+        # Convert the set back to a list of dictionaries
+        unique_list = [dict(item) for item in unique_objects]
+
+        return unique_list
+
+    class Meta:
+        model = Cycle
+        fields = "__all__"
+        read_only_fields = [
+            "workspace",
+            "project",
+            "owned_by",
+        ]
+
+
+class CycleIssueSerializer(BaseSerializer):
+    issue_detail = IssueStateSerializer(read_only=True, source="issue")
+    sub_issues_count = serializers.IntegerField(read_only=True)
+
+    class Meta:
+        model = CycleIssue
+        fields = "__all__"
+        read_only_fields = [
+            "workspace",
+            "project",
+            "cycle",
+        ]
+
+
+class CycleFavoriteSerializer(BaseSerializer):
+    cycle_detail = CycleSerializer(source="cycle", read_only=True)
+
+    class Meta:
+        model = CycleFavorite
+        fields = "__all__"
+        read_only_fields = [
+            "workspace",
+            "project",
+            "user",
+        ]
+
+
+class CycleUserPropertiesSerializer(BaseSerializer):
+    class Meta:
+        model = CycleUserProperties
+        fields = "__all__"
+        read_only_fields = [
+            "workspace",
+            "project",
+            "cycle" "user",
+        ]

apiserver/plane/app/serializers/dashboard.py

@@ -0,0 +1,26 @@
+# Module imports
+from .base import BaseSerializer
+from plane.db.models import Dashboard, Widget
+
+# Third party frameworks
+from rest_framework import serializers
+
+
+class DashboardSerializer(BaseSerializer):
+    class Meta:
+        model = Dashboard
+        fields = "__all__"
+
+
+class WidgetSerializer(BaseSerializer):
+    is_visible = serializers.BooleanField(read_only=True)
+    widget_filters = serializers.JSONField(read_only=True)
+
+    class Meta:
+        model = Widget
+        fields = [
+            "id",
+            "key",
+            "is_visible",
+            "widget_filters"
+        ]

apiserver/plane/app/serializers/estimate.py

@@ -0,0 +1,78 @@
+# Module imports
+from .base import BaseSerializer
+
+from plane.db.models import Estimate, EstimatePoint
+from plane.app.serializers import (
+    WorkspaceLiteSerializer,
+    ProjectLiteSerializer,
+)
+
+from rest_framework import serializers
+
+
+class EstimateSerializer(BaseSerializer):
+    workspace_detail = WorkspaceLiteSerializer(
+        read_only=True, source="workspace"
+    )
+    project_detail = ProjectLiteSerializer(read_only=True, source="project")
+
+    class Meta:
+        model = Estimate
+        fields = "__all__"
+        read_only_fields = [
+            "workspace",
+            "project",
+        ]
+
+
+class EstimatePointSerializer(BaseSerializer):
+    def validate(self, data):
+        if not data:
+            raise serializers.ValidationError("Estimate points are required")
+        value = data.get("value")
+        if value and len(value) > 20:
+            raise serializers.ValidationError(
+                "Value can't be more than 20 characters"
+            )
+        return data
+
+    class Meta:
+        model = EstimatePoint
+        fields = "__all__"
+        read_only_fields = [
+            "estimate",
+            "workspace",
+            "project",
+        ]
+
+
+class EstimateReadSerializer(BaseSerializer):
+    points = EstimatePointSerializer(read_only=True, many=True)
+    workspace_detail = WorkspaceLiteSerializer(
+        read_only=True, source="workspace"
+    )
+    project_detail = ProjectLiteSerializer(read_only=True, source="project")
+
+    class Meta:
+        model = Estimate
+        fields = "__all__"
+        read_only_fields = [
+            "points",
+            "name",
+            "description",
+        ]
+
+
+class WorkspaceEstimateSerializer(BaseSerializer):
+    points = EstimatePointSerializer(read_only=True, many=True)
+
+    class Meta:
+        model = Estimate
+        fields = "__all__"
+        read_only_fields = [
+            "points",
+            "name",
+            "description",
+        ]
+
+

apiserver/plane/app/serializers/exporter.py

@@ -0,0 +1,28 @@
+# Module imports
+from .base import BaseSerializer
+from plane.db.models import ExporterHistory
+from .user import UserLiteSerializer
+
+
+class ExporterHistorySerializer(BaseSerializer):
+    initiated_by_detail = UserLiteSerializer(
+        source="initiated_by", read_only=True
+    )
+
+    class Meta:
+        model = ExporterHistory
+        fields = [
+            "id",
+            "created_at",
+            "updated_at",
+            "project",
+            "provider",
+            "status",
+            "url",
+            "initiated_by",
+            "initiated_by_detail",
+            "token",
+            "created_by",
+            "updated_by",
+        ]
+        read_only_fields = fields

apiserver/plane/app/serializers/importer.py

@@ -0,0 +1,20 @@
+# Module imports
+from .base import BaseSerializer
+from .user import UserLiteSerializer
+from .project import ProjectLiteSerializer
+from .workspace import WorkspaceLiteSerializer
+from plane.db.models import Importer
+
+
+class ImporterSerializer(BaseSerializer):
+    initiated_by_detail = UserLiteSerializer(
+        source="initiated_by", read_only=True
+    )
+    project_detail = ProjectLiteSerializer(source="project", read_only=True)
+    workspace_detail = WorkspaceLiteSerializer(
+        source="workspace", read_only=True
+    )
+
+    class Meta:
+        model = Importer
+        fields = "__all__"

apiserver/plane/app/serializers/inbox.py

@@ -0,0 +1,60 @@
+# Third party frameworks
+from rest_framework import serializers
+
+# Module imports
+from .base import BaseSerializer
+from .issue import IssueFlatSerializer, LabelLiteSerializer
+from .project import ProjectLiteSerializer
+from .state import StateLiteSerializer
+from .user import UserLiteSerializer
+from plane.db.models import Inbox, InboxIssue, Issue
+
+
+class InboxSerializer(BaseSerializer):
+    project_detail = ProjectLiteSerializer(source="project", read_only=True)
+    pending_issue_count = serializers.IntegerField(read_only=True)
+
+    class Meta:
+        model = Inbox
+        fields = "__all__"
+        read_only_fields = [
+            "project",
+            "workspace",
+        ]
+
+
+class InboxIssueSerializer(BaseSerializer):
+    issue_detail = IssueFlatSerializer(source="issue", read_only=True)
+    project_detail = ProjectLiteSerializer(source="project", read_only=True)
+
+    class Meta:
+        model = InboxIssue
+        fields = "__all__"
+        read_only_fields = [
+            "project",
+            "workspace",
+        ]
+
+
+class InboxIssueLiteSerializer(BaseSerializer):
+    class Meta:
+        model = InboxIssue
+        fields = ["id", "status", "duplicate_to", "snoozed_till", "source"]
+        read_only_fields = fields
+
+
+class IssueStateInboxSerializer(BaseSerializer):
+    state_detail = StateLiteSerializer(read_only=True, source="state")
+    project_detail = ProjectLiteSerializer(read_only=True, source="project")
+    label_details = LabelLiteSerializer(
+        read_only=True, source="labels", many=True
+    )
+    assignee_details = UserLiteSerializer(
+        read_only=True, source="assignees", many=True
+    )
+    sub_issues_count = serializers.IntegerField(read_only=True)
+    issue_inbox = InboxIssueLiteSerializer(read_only=True, many=True)
+
+    class Meta:
+        model = Issue
+        fields = "__all__"

apiserver/plane/app/serializers/integration/__init__.py

@@ -0,0 +1,8 @@
+from .base import IntegrationSerializer, WorkspaceIntegrationSerializer
+from .github import (
+    GithubRepositorySerializer,
+    GithubRepositorySyncSerializer,
+    GithubIssueSyncSerializer,
+    GithubCommentSyncSerializer,
+)
+from .slack import SlackProjectSyncSerializer

apiserver/plane/app/serializers/integration/base.py

@@ -0,0 +1,22 @@
+# Module imports
+from plane.app.serializers import BaseSerializer
+from plane.db.models import Integration, WorkspaceIntegration
+
+
+class IntegrationSerializer(BaseSerializer):
+    class Meta:
+        model = Integration
+        fields = "__all__"
+        read_only_fields = [
+            "verified",
+        ]
+
+
+class WorkspaceIntegrationSerializer(BaseSerializer):
+    integration_detail = IntegrationSerializer(
+        read_only=True, source="integration"
+    )
+
+    class Meta:
+        model = WorkspaceIntegration
+        fields = "__all__"