Merge pull request #734 from pubky/dev

v2.0.0

Author: MiguelMedeiros

.dockerignore

@@ -0,0 +1,3 @@
+/node_modules
+/.github
+.env

.env.example

@@ -1,5 +1,10 @@
-NEXT_PUBLIC_HOMESERVER=pk:z6damwc3jzj1jmtac3kmsiyrgdfxaw8awndaedfnns3obyg9tzxo
-NEXT_PUBLIC_PKARR_RELAY=http://localhost:7258
+# OPEN VARIABLES
+NEXT_PUBLIC_HOMESERVER=ufibwbmed6jeq9k4p583go95wofakh9fwpp4k734trq79pd9u1uy
+NEXT_PUBLIC_NEXUS=https://nexus.staging.pubky.app
+NEXT_PUBLIC_TESTNET=false
+NEXT_PUBLIC_DEFAULT_HTTP_RELAY=https://demo.httprelay.io/link/
 
-# NEXT_PUBLIC_HOMESERVER=pk:4unkz8qto4xec6jhw9mie9oepgcurirebdx8axyq3o36fanooxxy
-# NEXT_PUBLIC_PKARR_RELAY=https://relay.pkarr.org
+# SECRET VARIABLES
+BASE_URL_SUPPORT=
+SUPPORT_API_ACCESS_TOKEN=
+SUPPORT_ACCOUNT_ID=

.eslintrc.json

@@ -1,10 +1,20 @@
 {
   "root": true,
-  "ignorePatterns": ["**/*"],
-  "plugins": ["@nx"],
+  "ignorePatterns": [
+    "node_modules",
+    "dist"
+  ],
+  "plugins": [
+    "@nx"
+  ],
   "overrides": [
     {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "files": [
+        "*.ts",
+        "*.tsx",
+        "*.js",
+        "*.jsx"
+      ],
       "rules": {
         "@nx/enforce-module-boundaries": [
           "error",
@@ -14,22 +24,34 @@
             "depConstraints": [
               {
                 "sourceTag": "*",
-                "onlyDependOnLibsWithTags": ["*"]
+                "onlyDependOnLibsWithTags": [
+                  "*"
+                ]
               }
             ]
           }
         ]
       }
     },
     {
-      "files": ["*.ts", "*.tsx"],
-      "extends": ["plugin:@nx/typescript"],
+      "files": [
+        "*.ts",
+        "*.tsx"
+      ],
+      "extends": [
+        "plugin:@nx/typescript"
+      ],
       "rules": {}
     },
     {
-      "files": ["*.js", "*.jsx"],
-      "extends": ["plugin:@nx/javascript"],
+      "files": [
+        "*.js",
+        "*.jsx"
+      ],
+      "extends": [
+        "plugin:@nx/javascript"
+      ],
       "rules": {}
     }
   ]
-}
+}

.github/dependabot.yml

@@ -0,0 +1,54 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 10
+    ignore:
+      # Ignore Nx core packages
+      # Must migrate manually periodically running `npx nx migrate latest`
+      - dependency-name: "nx"
+      - dependency-name: "@nx/*"
+      # # Ignore TypeScript and related tools
+      # - dependency-name: "typescript"
+      # - dependency-name: "tslib"
+      # - dependency-name: "ts-node"
+      # - dependency-name: "ts-jest"
+      # - dependency-name: "@typescript-eslint/*"
+      # - dependency-name: "@types/node"
+      # - dependency-name: "@types/react"
+      # - dependency-name: "@types/react-dom"
+      # # Ignore Build and Transpilation Tools
+      # - dependency-name: "@swc/*"
+      # - dependency-name: "@swc-node/*"
+      # - dependency-name: "babel-jest"
+      # - dependency-name: "postcss"
+      # - dependency-name: "autoprefixer"
+      # # Ignore Testing Frameworks
+      # - dependency-name: "jest"
+      # - dependency-name: "jest-*"
+      # - dependency-name: "jest-environment-*"
+      # - dependency-name: "@testing-library/*"
+      # # Ignore Linting Tools
+      # - dependency-name: "eslint"
+      # - dependency-name: "eslint-config-*"
+      # - dependency-name: "eslint-plugin-*"
+      # - dependency-name: "prettier"
+      # - dependency-name: "eslint-config-next"
+      # - dependency-name: "@nx/eslint"
+      # - dependency-name: "@nx/eslint-plugin"
+      # # Ignore Framework and Core Libraries
+      # - dependency-name: "react"
+      # - dependency-name: "react-dom"
+      # - dependency-name: "next"
+      # - dependency-name: "nextjs-toploader"
+      # - dependency-name: "tailwindcss"
+      # - dependency-name: "tailwind-merge"
+      # # Optionally ignore Cypress if you prefer manual updates
+      # - dependency-name: "cypress"
+      # - dependency-name: "eslint-plugin-cypress"
+    # reviewers:
+    #  - "your-github-username"
+    # assignees:
+    #  - "your-github-username"

.github/workflows/build.yml

@@ -0,0 +1,48 @@
+name: Build Prod
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Create .env
+        env:
+          BASE_URL_SUPPORT: ${{ secrets.BASE_URL_SUPPORT }}
+          SUPPORT_API_ACCESS_TOKEN: ${{ secrets.SUPPORT_API_ACCESS_TOKEN }}
+          SUPPORT_ACCOUNT_ID: ${{ secrets.SUPPORT_ACCOUNT_ID }}
+        run: |
+          echo "NEXT_PUBLIC_HOMESERVER=ufibwbmed6jeq9k4p583go95wofakh9fwpp4k734trq79pd9u1uy" >> .env
+          echo "NEXT_PUBLIC_NEXUS=https://nexus.staging.pubky.app" >> .env
+          echo "NEXT_PUBLIC_TESTNET=false" >> .env
+          echo "BASE_URL_SUPPORT=$BASE_URL_SUPPORT" >> .env
+          echo "SUPPORT_API_ACCESS_TOKEN=$SUPPORT_API_ACCESS_TOKEN" >> .env
+          echo "SUPPORT_ACCOUNT_ID=$SUPPORT_ACCOUNT_ID" >> .env
+
+      - name: Install dependencies
+        run: npm install --omit=dev
+
+      - name: Build prod
+        env:
+          BASE_URL_SUPPORT: ${{ secrets.BASE_URL_SUPPORT }}
+          SUPPORT_API_ACCESS_TOKEN: ${{ secrets.SUPPORT_API_ACCESS_TOKEN }}
+          SUPPORT_ACCOUNT_ID: ${{ secrets.SUPPORT_ACCOUNT_ID }}
+        run: npm run build

.github/workflows/e2e-test.yml

@@ -2,45 +2,102 @@ name: e2e-test
 
 on:
   workflow_dispatch:
-  pull_request:
+  push:
+    branches:
+      - dev
+      - master
+
+concurrency:
+  group: "e2e-test"
+  cancel-in-progress: true
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        browser: [chrome, firefox]
+        browser: [firefox] # [chrome, firefox]
 
     steps:
       - name: Checkout this repository
         uses: actions/checkout@v4
         with:
           path: pubky-app
 
-      - name: Checkout skunk-works
+      - name: Checkout pubky-docker
         uses: actions/checkout@v4
         with:
-          repository: pubky/skunk-works
-          path: skunk-works
-          ssh-key: ${{ secrets.DEPLOY_KEY }}
+          repository: pubky/pubky-docker
+          ref: catch-21/update
+          path: pubky-docker
+          submodules: true
+          token: ${{ secrets.READ_REPOS }}
+          # cannot use ssh-key (deploy key) for private submodules due to the
+          # limitation where only a single key can be used per repo checkout
+          # see https://github.com/actions/checkout/issues/183
 
-      - name: Run skunk-works
-        working-directory: skunk-works
+      - name: Modify pubky-docker docker-compose.yml
+        working-directory: pubky-docker/development
         run: |
-          npm install
-          npm run link
-          cp ./.env.example ./services/backend/.env
-          npm run backend &
+          YQ_BINARY=yq_linux_amd64
+          YQ_VERSION=v4.44.3
+          wget https://github.com/mikefarah/yq/releases/download/${YQ_VERSION}/${YQ_BINARY}.tar.gz -O - | tar xz && sudo mv ${YQ_BINARY} /usr/bin/yq
+          yq -i 'del(.services.pkarr)' docker-compose.yml
+          yq -i 'del(.services.client)' docker-compose.yml
+          yq -i 'del(.services.homeserver.depends_on)' docker-compose.yml
+
+      - name: Modify homeserver.config.toml
+        working-directory: pubky-docker/development
+        run: sed -i 's/secret_key = "0123000000000000000000000000000000000000000000000000000000000000"/secret_key = "${{ secrets.HOMESERVER_SECRET_KEY }}"/' homeserver.config.toml
+
+      # reduce neo4j memory to prevent
+      # ERROR Invalid memory configuration - exceeds physical memory. Check the configured values for server.memory.pagecache.size and server.memory.heap.max_size
+      - name: Modify neo4j.env
+        working-directory: pubky-docker/development
+        run: |
+          sed -i 's/NEO4J_server_memory_pagecache_size=2G/NEO4J_server_memory_pagecache_size=1G/' neo4j.env
+          sed -i 's/NEO4J_server_memory_heap_initial__size=4G/NEO4J_server_memory_heap_initial__size=1G/' neo4j.env
+          sed -i 's/NEO4J_server_memory_heap_max__size=8G/NEO4J_server_memory_heap_max__size=2G/' neo4j.env
+
+      - name: Build and run pubky-docker
+        working-directory: pubky-docker/development
+        run: docker compose up -d
+
+      - name: Wait for pubky-docker to start
+        run: |
+          PORT=8080
+          MAX_WAIT=300     # Maximum wait time in seconds (5 minutes)
+          WAIT_INTERVAL=5  # Interval between checks in seconds
+          ELAPSED=0
+
+          while ! curl -s http://localhost:$PORT; do
+            if [ $ELAPSED -ge $MAX_WAIT ]; then
+              echo "Service did not start within 5 minutes."
+              exit 1
+            fi
+            echo "Waiting for service on port $PORT to be ready... ($ELAPSED seconds elapsed)"
+            sleep $WAIT_INTERVAL
+            ELAPSED=$((ELAPSED + WAIT_INTERVAL))
+          done
+
+          echo "Service is ready."
 
       - name: Build pubky-app frontend
         working-directory: pubky-app
         run: |
-          cp ./.env.example ./.env
+          echo "NEXT_PUBLIC_HOMESERVER=${{ secrets.HOMESERVER_PUBKY }}
+          NEXT_PUBLIC_NEXUS=http://localhost:8080
+          NEXT_PUBLIC_TESTNET=false
+          NEXT_PUBLIC_DEFAULT_HTTP_RELAY=https://demo.httprelay.io/link/
+          BASE_URL_SUPPORT=${{ secrets.BASE_URL_SUPPORT }}
+          SUPPORT_API_ACCESS_TOKEN=${{ secrets.SUPPORT_API_ACCESS_TOKEN }}
+          SUPPORT_ACCOUNT_ID=1" > .env
           npm install
-          npm link @pubky/sdk
 
       - name: Run e2e tests (${{ matrix.browser }})
         uses: cypress-io/github-action@v6
+        env:
+          DEBUG: '@cypress/github-action'
         with:
           working-directory: pubky-app/apps/web-e2e
           config-file: cypress.config.ts
@@ -51,6 +108,7 @@ jobs:
           install: false
           start: npm run start:prod
           wait-on: 'http://localhost:4200'
+          wait-on-timeout: 180
 
       - name: Upload ${{ matrix.browser }} screenshots
         if: ${{ always() }}
@@ -65,3 +123,7 @@ jobs:
         with:
           name: videos-${{ matrix.browser }}
           path: pubky-app/dist/cypress/apps/web-e2e/videos
+
+      - name: Dump docker logs on failure
+        if: failure()
+        uses: jwalton/gh-docker-logs@v2

.gitignore

@@ -39,7 +39,7 @@ testem.log
 .DS_Store
 Thumbs.db
 
-.nx/cache
+.nx
 
 # Next.js
 .next

Dockerfile

@@ -0,0 +1,25 @@
+# Alternatively we could use node:22.9.0-alpine3.20
+FROM node:22.9.0-slim
+
+# Set working directory
+WORKDIR /usr/src/app
+
+# Declare build arguments
+ARG NEXT_PUBLIC_HOMESERVER
+ARG NEXT_PUBLIC_NEXUS
+ARG NEXT_PUBLIC_TESTNET
+
+# Copy pubky-app
+COPY . .
+
+# Install dependencies
+RUN npm install --omit=dev
+
+# Remove devDependencies to reduce image size
+RUN npm prune --production
+
+# Build
+RUN npm run build
+
+# The command to run the pubky web server
+CMD ["npm", "run", "serve:prod"]

README.md

@@ -23,15 +23,18 @@ Create a `.env` file at the root of the project and include the following enviro
 ### :test_tube: Testnet Configuration
 
 ```
-NEXT_PUBLIC_HOMESERVER=pk:z6damwc3jzj1jmtac3kmsiyrgdfxaw8awndaedfnns3obyg9tzxo
-NEXT_PUBLIC_PKARR_RELAY=http://localhost:7258
+NEXT_PUBLIC_HOMESERVER=z6damwc3jzj1jmtac3kmsiyrgdfxaw8awndaedfnns3obyg9tzxo
+NEXT_PUBLIC_NEXUS=http://localhost:8080
+NEXT_PUBLIC_DEFAULT_HTTP_RELAY=https://demo.httprelay.io/link/
+NEXT_PUBLIC_TESTNET=true
 ```
 
 ### :earth_americas: Mainnet Configuration
 
 ```
-NEXT_PUBLIC_HOMESERVER=pk:4unkz8qto4xec6jhw9mie9oepgcurirebdx8axyq3o36fanooxxy
-NEXT_PUBLIC_PKARR_RELAY=https://relay.pkarr.org
+NEXT_PUBLIC_HOMESERVER=ufibwbmed6jeq9k4p583go95wofakh9fwpp4k734trq79pd9u1uy
+NEXT_PUBLIC_NEXUS=https://nexus.staging.pubky.app
+NEXT_PUBLIC_DEFAULT_HTTP_RELAY=https://demo.httprelay.io/link/
 ```
 
 ## :running: Running Scripts