Merge branch 'develop-postgres' into setup_script

Author: prayanshchh

.github/workflows/pull-request-target.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Add the PR Review Policy
         uses: thollander/actions-comment-pull-request@v3
         with:
-          comment_tag: pr_review_policy
+          comment-tag: pr_review_policy
           message: |
             ## Our Pull Request Approval Process
 

.github/workflows/pull-request.yml

@@ -48,8 +48,8 @@ jobs:
           echo "Error: Close this PR and try again."          
           exit 1
 
-  check_biome_ignore:
-    name: Check for biome_ignore
+  python_checks:
+    name: Run Python Checks
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -64,30 +64,19 @@ jobs:
         with:
           python-version: 3.9
 
-      - name: Run Python script
+      - name: Run Biome Ignore Check
         run: |
           python .github/workflows/scripts/biome_disable_check.py --files ${{ steps.changed-files.outputs.all_changed_files }}
 
-  check_code_coverage_disable:
-    name: Check for code coverage disable
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Get changed files
-        id: changed-files
-        uses: tj-actions/changed-files@v45
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.9
-
-      - name: Run Python script
+      - name: Run Code Coverage Disable Check
         run: |
           python .github/workflows/scripts/code_coverage_disable_check.py --files ${{ steps.changed-files.outputs.all_changed_files }}
 
+      - name: Run TS Ignore Check
+        run: |
+          python .github/workflows/scripts/detect_ts_ignore.py --files ${{ steps.changed-files.outputs.all_changed_files }}
+
   check_gql_tada:
     name: Check gql tada files and configuration
     runs-on: ubuntu-latest
@@ -195,7 +184,7 @@ jobs:
   Run-Tests:
     name: Run tests for talawa api
     runs-on: ubuntu-latest
-    needs: [Code-Quality-Checks, check_code_coverage_disable]
+    needs: [Code-Quality-Checks, python_checks]
     env:
       CODECOV_UNIQUE_NAME: ${{github.workflow}}-${{github.ref_name}}
     steps:
@@ -223,7 +212,7 @@ jobs:
         uses: VeryGoodOpenSource/very_good_coverage@v2
         with:
           path: "./coverage/lcov.info"
-          min_coverage: 45.0
+          min_coverage: 48.6
 
   Test-Docusaurus-Deployment:
     name: Test Deployment to https://docs-api.talawa.io

.github/workflows/scripts/detect_ts_ignore.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+"""Script to detect and report usage of @ts-ignore comments in TypeScript."""
+
+import argparse
+import re
+import sys
+import logging
+
+# Configure logging
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(levelname)s: %(message)s",
+)
+
+TS_IGNORE_PATTERN = r"(?://|/\*)\s*@ts-ignore(?:\s+|$)"
+
+
+def check_ts_ignore(files: list[str]) -> int:
+    """Check for occurrences of '@ts-ignore' in the given files.
+
+    Args:
+        files (list[str]): List of file paths to check.
+
+    Returns:
+        int: 0 if no violations, 1 if violations are found.
+    """
+    ts_ignore_found = False
+
+    for file in files:
+        try:
+            logging.info("Checking file: %s", file)
+            with open(file, encoding="utf-8") as f:
+                for line_num, line in enumerate(f, start=1):
+                    # Handle more variations of @ts-ignore
+                    if re.search(
+                        TS_IGNORE_PATTERN,
+                        line.strip(),
+                    ):
+                        print(
+                            "❌ Error: '@ts-ignore' found in %s at line %d",
+                            file,
+                            line_num,
+                        )
+                        logging.debug(
+                            "Found @ts-ignore in line: %s",
+                            line.strip(),
+                        )
+                        ts_ignore_found = True
+        except FileNotFoundError:
+            logging.warning("File not found: %s", file)
+        except OSError:
+            logging.exception("Could not read %s", file)
+    if not ts_ignore_found:
+        print("✅ No '@ts-ignore' comments found in the files.")
+
+    return 1 if ts_ignore_found else 0
+
+
+def main() -> None:
+    """Main function to parse arguments and run the check.
+
+    This function sets up argument parsing for file paths and runs the ts-ignore
+    check on the specified files.
+
+    Args:
+        None
+
+    Returns:
+        None: The function exits the program with status code 0 if no ts-ignore
+        comments are found, or 1 if any are detected.
+    """
+    parser = argparse.ArgumentParser(
+        description="Check for @ts-ignore in changed files.",
+    )
+    parser.add_argument(
+        "--files",
+        nargs="+",
+        help="List of changed files",
+        required=True,
+    )
+    args = parser.parse_args()
+
+    # Filter TypeScript files
+    ts_files = [f for f in args.files if f.endswith((".ts", ".tsx"))]
+    if not ts_files:
+        logging.info("No TypeScript files to check.")
+        sys.exit(0)
+
+    exit_code = check_ts_ignore(args.files)
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()

docs/docs/docs/developer-resources/testing.md

@@ -61,7 +61,9 @@ This section covers how to access the GraphQL API interface.
 
 #### Interactive Web Queries With GraphiQL
 
-The url for accessing the GraphQL Playground is
+You can use GraphiQL to test your GraphQL queries interactively via a web page.
+
+The url for accessing the GraphQL Playground is:
 
 ```bash
 http://127.0.0.1:4000/graphiql

docs/docs/docs/developer-resources/troubleshooting.md

@@ -1,10 +1,100 @@
 ---
 id: troubleshooting
-title: Operation
+title: Troubleshooting
 slug: /developer-resources/troubleshooting
 sidebar_position: 5
 ---
 
 ## Introduction
 
-Coming soon.
+This page provides basic troubleshooting steps for the applications.
+
+## Docker
+
+When running the application using docker it may seem difficult at first to troubleshoot failures. This section covers some basic troubleshooting strategies.
+
+### Status Validation
+
+You can get a summary of all the running docker containers using the `docker ps` command.
+
+It will provide this information under these headings:
+
+1. **CONTAINER ID**: Container IDs
+1. **IMAGE**: Image names on which the containers are based
+1. **COMMAND**: The command that created the containers
+1. **CREATED**: The time of containers
+1. **STATUS**: Whether or not the containers are healthy
+1. **PORTS**: The exposed ports they use
+1. **NAMES**: The names of the running containers
+
+Here is an example:
+
+```
+CONTAINER ID   IMAGE           COMMAND                CREATED        STATUS        PORTS                    NAMES
+3a6743b03029   docker-app      "docker-entrypoint.s…" 42 minutes ago Up 41 minutes 0.0.0.0:4321->4321/tcp   docker-app-1
+f86a9f480819   talawa-api-dev  "/bin/bash /init-dat…" 42 minutes ago Up 42 minutes 0.0.0.0:4000->4000/tcp   talawa-api-dev
+83ae5ff56a3f   redis:8.0       "docker-entrypoint.s…" 42 minutes ago Up 42 minutes 0.0.0.0:6379->6379/tcp   talawa-api-redis
+44c8a0f38b04   minio/minio     "/usr/bin/docker-ent…" 42 minutes ago Up 42 minutes 0.0.0.0:9000->9001/tcp   talawa-api-minio-1
+3a9deccdb68e   caddy/caddy:2.9 "caddy run --config …" 42 minutes ago Up 42 minutes 0.0.0.0:9080->9080/tcp   caddy-service
+132dacf0aff4   mongo           "/bin/bash /init-mon…" 42 minutes ago Up 42 minutes 0.0.0.0:27017->27017/tcp mongo
+```
+
+You can get information on each of the headings by using filters like this:
+
+1. CONTAINER ID: `docker ps --format '{{.ID}}'`
+1. IMAGE: `docker ps --format '{{.Names}}'`
+1. COMMAND: `docker ps --format '{{.Command}}'`
+1. CREATED: `docker ps --format '{{.RunningFor}}'`
+1. STATUS: `docker ps --format '{{.Status}}'`
+1. PORTS: `docker ps --format '{{.Ports}}'`
+1. NAMES: `docker ps --format '{{.Names}}'`
+
+### Accessing The Container CLI
+
+You can access the CLI of each container using the docker interactive TTY mode flags `-it`.
+
+Here is an example accessing the `/bin/bash` CLI of the `talawa-api-dev` container:
+
+```bash
+$ docker exec -it talawa-api-dev /bin/bash
+root@f86a9f480819:/usr/src/app# ls
+CODEOWNERS          Caddyfile         Dockerfile.prod
+CODE_OF_CONDUCT.md  DOCUMENTATION.md  INSTALLATION.md
+CONTRIBUTING.md     Dockerfile.dev    ISSUE_GUIDELINES.md
+root@f86a9f480819:/usr/src/app# exit
+$
+```
+
+Here is an example accessing the `/bin/mongosh` CLI of the `mongo` container:
+
+```bash
+$ docker exec -it mongo /bin/mongosh
+...
+...
+...
+rs0 [direct: primary] test> show databases
+admin        80.00 KiB
+config      356.00 KiB
+local         1.92 MiB
+talawa-api    2.49 MiB
+rs0 [direct: primary] test> exit
+$
+```
+
+### Viewing Container Logs
+
+You can view the container logs in real time by using the `docker logs -f` command. The output will update dynamically as you run the app.
+
+In this case we see the logs of the `mongo` container. The `-n 10` flag makes the output start with the most recent 10 rows of logs which makes the output less verbose.
+
+```bash
+$ docker logs -f mongo -n 10
+```
+
+```
+mongosh","version":"6.12.0|2.3.8"},"platform":"Node.js v20.18.1, LE","os":{"name":"linux","architecture":"x64","version":"3.10.0-327.22.2.el7.x86_64","type":"Linux"},"env":{"container":{"runtime":"docker"}}}}}
+{"t":{"$date":"2025-02-22T01:14:08.038+00:00"},"s":"I",  "c":"NETWORK",  "id":51800,   "ctx":"conn2194","msg":"client metadata","attr":{"remote":"127.0.0.1:36844","client":"conn2194","negotiatedCompressors":[],"doc":{"application":{"name":"mongosh 2.3.8"},"driver":{"name":"nodejs|mongosh","version":"6.12.0|2.3.8"},"platform":"Node.js v20.18.1, LE","os":{"name":"linux","architecture":"x64","version":"3.10.0-327.22.2.el7.x86_64","type":"Linux"},"env":{"container":{"runtime":"docker"}}}}}
+{"t":{"$date":"2025-02-22T01:14:08.040+00:00"},"s":"I",  "c":"NETWORK",  "id":6788700, "ctx":"conn2193","msg":"Received first command on ingress connection since session start or auth handshake","attr":{"elapsedMillis":2}}
+{"t":{"$date":"2025-02-22T01:14:08.040+00:00"},"s":"I",  "c":"NETWORK",  "id":22943,   "ctx":"listener","msg":"Connection accepted","attr":{"remote":"127.0.0.1:36848","uuid":{"uuid":{"$uuid":"1ef5fcbd-4913-45fe-bc66-7bc3600a941a"}},"connectionId":2195,"connectionCount":24}}
+{"t":{"$date":"2025-02-22T01:14:08.043+00:00"},"s":"I",  "c":"NETWORK",  "id":22943,   "ctx":"listener","msg":"Connection accepted","attr":{"remote":"127.0.0.1:36854","uuid":{"uuid":{"$uuid":"48522796-7b00-46df-a5d1-3e2a9ec7edd8"}},"connectionId":2196,"connectionCount":25}}
+```

lefthook.yaml

@@ -30,5 +30,9 @@ pre-commit:
         pnpm fix_code_quality
         git add {staged_files}
     8_check_type_errors:
-      run: pnpm check_type_errors
-  piped: true
+      run: pnpm check_type_errors     
+    9_check_tests:
+      run: |
+        set -e
+        pnpm check_tests   
+  piped: true

package.json

@@ -92,6 +92,7 @@
     "push_drizzle_schema": "drizzle-kit push",
     "push_drizzle_test_schema": "drizzle-kit push --config=./test/drizzle.config.ts",
     "run_tests": "vitest --coverage",
+    "check_tests": "vitest run",
     "start_development_server": "tsx watch ./src/index.ts",
     "start_development_server_with_debugger": "tsx watch --inspect=${API_DEBUGGER_HOST:-127.0.0.1}:${API_DEBUGGER_PORT:-9229} ./src/index.ts",
     "start_production_server": "pnpm build_production && node ./dist/index.js",