Merge pull request #803 from sparrowapp-dev/development

Merge development into release v2

Author: jatinlodhi2002

.env.example

@@ -7,6 +7,7 @@
 PORT=9000                         # Port on which the application server will run
 APP_ENV=DEV                       # Runtime environment (DEV|STAGE|PROD)
 APP_URL=http://localhost          # Base URL where the application is hosted
+APP_EDITION=MANAGED               # Edition of the application (MANAGED|SELFHOSTED) 
 
 # [AUTHENTICATION SERVICE]
 # Endpoint for authentication services
@@ -123,3 +124,7 @@ STRIPE_SECRET_KEY=                # Stripe secret key (backend - KEEP SECURE!)
 SPARROW_ADMIN_KEY=                # Sparrow admin key for privileged operations specific to Sparrow team   
 ADMIN_BASE_URL=                   # Base URL for Sparrow admin operations
 STAKEHOLDERS_EMAIL_LIST=          # Comma-separated list of sparrow admin emails
+
+# [Self Host]
+SELF_HOST_ADMIN_EMAIL=
+SELF_HOST_ADMIN_PASSWORD=

.github/workflows/sparrow-api-selfhost-publish.yml

@@ -0,0 +1,61 @@
+name: Self-host Docker Image
+on:
+  push:
+    branches:
+      - release-v2
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    environment: self-host
+
+    env:
+      DOCKER_IMAGE_NAME: sparrowapi/sparrow-api
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Read version from package.json
+        id: version
+        run: |
+          if ! command -v jq >/dev/null 2>&1; then
+            echo "jq not found"; exit 1
+          fi
+          V=$(jq -r '.version' package.json)
+          if [ -z "$V" ] || [ "$V" = "null" ]; then
+            echo "Version not found in package.json"; exit 1
+          fi
+          if ! [[ "$V" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "Version $V is not valid semver (expected X.Y.Z)"; exit 1
+          fi
+          echo "full=$V" >> "$GITHUB_OUTPUT"
+
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.SPARROW_DOCKERHUB_USERNAME }}
+          password: ${{ secrets.SPARROW_DOCKERHUB_PASSWORD }}
+
+      - name: Build and push (multi-arch)
+        run: |
+          set -euo pipefail
+          VERSION='${{ steps.version.outputs.full }}'
+          echo "Building image tag: $VERSION"
+          docker buildx build \
+            --platform linux/amd64,linux/arm64 \
+            --build-arg GITHUB_TOKEN=${{ secrets.SPARROW_GITHUB_TOKEN }} \
+            -t $DOCKER_IMAGE_NAME:$VERSION \
+            -t $DOCKER_IMAGE_NAME:latest \
+            --push .

Dockerfile

@@ -18,7 +18,7 @@ RUN apk update && apk add --no-cache python3 py3-pip build-base gcc
 # Install dependencies with the preferred package manager
 RUN npm i -g pnpm@latest
 RUN pnpm install --frozen-lockfile
-RUN pnpm add @sparrowapp-dev/stripe-billing@1.0.0
+RUN pnpm add @sparrowapp-dev/stripe-billing@1.3.1
 # RUN corepack enable pnpm && pnpm i --frozen-lockfile
 
 FROM node:18-alpine AS builder

deploymentManifests/deployment.yml

@@ -386,6 +386,21 @@ spec:
                 secretKeyRef:
                   name: sparrow-api-secret
                   key: STAKEHOLDERS_EMAIL_LIST
+            - name: APP_EDITION
+              valueFrom:
+                secretKeyRef:
+                  name: sparrow-api-secret
+                  key: APP_EDITION
+            - name: SELF_HOST_ADMIN_EMAIL
+              valueFrom:
+                secretKeyRef:
+                  name: sparrow-api-secret
+                  key: SELF_HOST_ADMIN_EMAIL
+            - name: SELF_HOST_ADMIN_PASSWORD
+              valueFrom:
+                secretKeyRef:
+                  name: sparrow-api-secret
+                  key: SELF_HOST_ADMIN_PASSWORD
 
 ---
 apiVersion: v1

deploymentManifests/release-v2.yml

@@ -355,6 +355,21 @@ spec:
                 secretKeyRef:
                   name: release-api-v2-secret
                   key: STAKEHOLDERS_EMAIL_LIST
+            - name: APP_EDITION
+              valueFrom:
+                secretKeyRef:
+                  name: release-api-v2-secret
+                  key: APP_EDITION
+            - name: SELF_HOST_ADMIN_EMAIL
+              valueFrom:
+                secretKeyRef:
+                  name: release-api-v2-secret
+                  key: SELF_HOST_ADMIN_EMAIL
+            - name: SELF_HOST_ADMIN_PASSWORD
+              valueFrom:
+                secretKeyRef:
+                  name: release-api-v2-secret
+                  key: SELF_HOST_ADMIN_PASSWORD
 
 ---
 apiVersion: v1

migrations/add-tests-to-root-request-items.migration.ts

@@ -0,0 +1,74 @@
+
+import { Injectable, OnModuleInit, Inject } from "@nestjs/common";
+import { Collections } from "@src/modules/common/enum/database.collection.enum";
+import { Db } from "mongodb";
+import { ItemTypeEnum } from "@src/modules/common/models/collection.model";
+
+
+@Injectable()
+export class AddTestsToRootRequestItemsMigration implements OnModuleInit {
+  private hasRun = false;
+  constructor(@Inject("DATABASE_CONNECTION") private db: Db) {}
+
+  async onModuleInit(): Promise<void> {
+    if (this.hasRun) return;
+    try {
+      console.log("[Nest] Starting AddTestsToRootRequestItemsMigration...");
+      const collectionCollection = this.db.collection(Collections.COLLECTION);
+      const collections = await collectionCollection.find().toArray();
+      let updatedCount = 0;
+      for (const collection of collections) {
+        let updated = false;
+
+
+        function addFieldsToRequestItems(items: any[]): void {
+          if (!Array.isArray(items)) return;
+          for (const item of items) {
+            if (item.type === ItemTypeEnum.REQUEST && item.request) {
+              // Add tests if missing
+              if (!item?.request?.tests) {
+                item.request.tests = {
+                  testCaseMode: "no-code",
+                  noCode: [
+                    {
+                      id: "case-1",
+                      name: "New Test",
+                      condition: "",
+                      expectedResult: "",
+                      testPath: "",
+                      testTarget: "",
+                    },
+                  ],
+                  script: "",
+                };
+                updated = true;
+              }
+              // Add selectedRequestAuthProfileId if missing
+              if (!item?.request?.selectedRequestAuthProfileId) {
+                item.request.selectedRequestAuthProfileId = "";
+                updated = true;
+              }
+            }
+            if (Array.isArray(item.items)) {
+              addFieldsToRequestItems(item.items);
+            }
+          }
+        }
+
+        addFieldsToRequestItems(collection.items);
+
+        if (updated) {
+          await collectionCollection.updateOne(
+            { _id: collection._id },
+            { $set: { items: collection.items } }
+          );
+          updatedCount++;
+        }
+      }
+      console.log(`[Nest] Migration completed: ${updatedCount} collections updated with tests object.`);
+      this.hasRun = true;
+    } catch (error) {
+      console.error("[Nest] Error during AddTestsToRootRequestItemsMigration:", error);
+    }
+  }
+}