Merge branch 'staging' into 130-fix-empty-relay-issue

This reverts commit 7e420ef583.

.eslintrc.cjs

@@ -6,7 +6,7 @@ module.exports = {
     'plugin:@typescript-eslint/recommended',
     'plugin:react-hooks/recommended'
   ],
-  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  ignorePatterns: ['dist', '.eslintrc.cjs', 'licenseChecker.cjs'],
   parser: '@typescript-eslint/parser',
   plugins: ['react-refresh'],
   rules: {

.git-hooks/commit-msg

@@ -0,0 +1,19 @@
+#!/bin/sh
+# Get the commit message (the parameter we're given is just the path to the
+# temporary file which holds the message).
+commit_message=$(cat "$1")
+
+if (echo "$commit_message" | grep -Eq "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9 \-]+\))?!?: .+$") then
+   tput setaf 2;
+   echo -e "${GREEN} ✔ Commit message meets Conventional Commit standards"
+   tput sgr0;
+   exit 0
+fi
+
+tput setaf 1;
+echo -e "${RED}❌ Commit message does not meet the Conventional Commit standard!"
+tput sgr0;
+echo "An example of a valid message is:"
+echo "  feat(login): add the 'remember me' button"
+echo "ℹ More details at: https://www.conventionalcommits.org/en/v1.0.0/#summary"
+exit 1

.git-hooks/pre-commit

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# Avoid commits to the master branch
+BRANCH=`git rev-parse --abbrev-ref HEAD`
+REGEX="^(master|main|staging|development)$"
+
+if [[ "$BRANCH" =~ $REGEX ]]; then
+  echo "You are on branch $BRANCH. Are you sure you want to commit to this branch?"
+  echo "If so, commit with -n to bypass the pre-commit hook."
+  exit 1
+fi
+
+npm run lint-staged

.gitea/workflows/release-staging.yaml

@@ -17,9 +17,21 @@ jobs:
         with:
           node-version: 18
 
+      - name: Audit
+        run: npm audit
+
       - name: Install Dependencies
         run: npm ci
 
+      - name: License check
+        run: npm run license-checker
+
+      - name: Lint check
+        run: npm run lint
+
+      - name: Formatter check
+        run: npm run formatter:check
+
       - name: Create .env File
         run: echo "VITE_MOST_POPULAR_RELAYS=${{ vars.VITE_MOST_POPULAR_RELAYS }}" > .env
 
@@ -29,6 +41,6 @@ jobs:
       - name: Release Build
         run: |
           npm -g install cloudron-surfer
-          surfer config --token ${{ secrets.STAGING_CLOUDRON_SURFER_TOKEN }} --server staging.sigit.io 
+          surfer config --token ${{ secrets.STAGING_CLOUDRON_SURFER_TOKEN }} --server staging.sigit.io
           surfer put dist/* / --all -d
-          surfer put dist/.well-known / --all  
+          surfer put dist/.well-known / --all

.gitea/workflows/staging-pull-request.yaml

@@ -0,0 +1,34 @@
+name: Open PR on Staging
+on:
+  pull_request:
+    types: [opened, edited, synchronize]
+    branches:
+      - staging
+
+jobs:
+  audit_and_check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18
+
+      - name: Audit
+        run: npm audit
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: License check
+        run: npm run license-checker
+
+      - name: Lint check
+        run: npm run lint
+
+      - name: Formatter check
+        run: npm run formatter:check

licenseChecker.cjs

@@ -0,0 +1,28 @@
+const process = require('node:process')
+const licenseChecker = require('license-checker')
+
+const check = (cwd) => {
+  return new Promise((resolve, reject) => {
+    licenseChecker.init(
+      {
+        production: true,
+        start: cwd,
+        excludePrivatePackages: true,
+        onlyAllow:
+          'AFLv2.1;Apache 2.0;Apache-2.0;Apache*;Artistic-2.0;0BSD;BSD*;BSD-2-Clause;BSD-3-Clause;BSD 3-Clause;CC0-1.0;CC-BY-3.0;CC-BY-4.0;ISC;MIT;MPL-2.0;ODC-By-1.0;Python-2.0;Unlicense;',
+        excludePackages: ''
+      },
+      (error, json) => {
+        if (error) {
+          reject(error)
+        } else {
+          resolve(json)
+        }
+      }
+    )
+  })
+}
+
+check(process.cwd(), true)
+  .then(() => console.log('All packages are licensed properly'))
+  .catch((err) => console.log('license checker err', err))

package.json

@@ -7,11 +7,16 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 41",
     "lint:fix": "eslint . --fix --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint:staged": "eslint --fix --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "formatter:check": "prettier --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,yml,md,graphql}\"",
     "formatter:fix": "prettier --write \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,yml,md,graphql}\"",
-    "preview": "vite preview"
+    "formatter:staged": "prettier --write --ignore-unknown",
+    "preview": "vite preview",
+    "preinstall": "git config core.hooksPath .git-hooks",
+    "license-checker": "node licenseChecker.cjs",
+    "lint-staged": "lint-staged"
   },
   "dependencies": {
     "@emotion/react": "11.11.4",
@@ -61,10 +66,18 @@
     "eslint": "^8.56.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.5",
+    "license-checker": "^25.0.1",
+    "lint-staged": "^15.2.8",
     "prettier": "3.2.5",
     "ts-css-modules-vite-plugin": "1.0.20",
     "typescript": "^5.2.2",
     "vite": "^5.1.4",
     "vite-tsconfig-paths": "4.3.2"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "npm run lint:staged"
+    ],
+    "*.{ts,tsx,js,jsx,html,css,sass,less,yml,md,graphql}": "npm run formatter:staged"
   }
 }

src/controllers/MetadataController.ts

@@ -164,18 +164,13 @@ export class MetadataController extends EventEmitter {
    * or a fallback RelaySet with Sigit's Relay
    */
   public findRelayListMetadata = async (hexKey: string): Promise<RelaySet> => {
-    const relayEvent =
-      (await findRelayListInCache(hexKey)) ||
-      (await findRelayListAndUpdateCache(
-        [this.specialMetadataRelay],
-        hexKey
-      )) ||
-      (await findRelayListAndUpdateCache(
-        await this.nostrController.getMostPopularRelays(),
-        hexKey
-      ))
+    const relayEvent = await findRelayListInCache(hexKey)
+      || await findRelayListAndUpdateCache([this.specialMetadataRelay], hexKey)
+      || await findRelayListAndUpdateCache(await this.nostrController.getMostPopularRelays(), hexKey)
 
-    return relayEvent ? getUserRelaySet(relayEvent.tags) : getDefaultRelaySet()
+    return relayEvent
+      ? getUserRelaySet(relayEvent.tags)
+      : getDefaultRelaySet()
   }
 
   public extractProfileMetadataContent = (event: Event) => {

src/pages/settings/relays/index.tsx

@@ -91,8 +91,7 @@ export const RelaysPage = () => {
         if (isMounted) {
           if (
             !relaysState?.mapUpdated ||
-            (newRelayMap?.mapUpdated !== undefined &&
-              newRelayMap?.mapUpdated > relaysState?.mapUpdated)
+            newRelayMap?.mapUpdated !== undefined && (newRelayMap?.mapUpdated > relaysState?.mapUpdated)
           ) {
             if (
               !relaysState?.map ||

src/pages/sign/index.tsx

@@ -5,7 +5,7 @@ import JSZip from 'jszip'
 import _ from 'lodash'
 import { MuiFileInput } from 'mui-file-input'
 import { Event, verifyEvent } from 'nostr-tools'
-import { useEffect, useState } from 'react'
+import { useCallback, useEffect, useState } from 'react'
 import { useSelector } from 'react-redux'
 import { useLocation, useNavigate } from 'react-router-dom'
 import { toast } from 'react-toastify'
@@ -208,7 +208,6 @@ export const SignPage = () => {
         const signedMarks = extractMarksFromSignedMeta(meta)
         const currentUserMarks = getCurrentUserMarks(metaMarks, signedMarks)
         setCurrentUserMarks(currentUserMarks)
-        // setCurrentUserMark(findNextCurrentUserMark(currentUserMarks) || null)
         setIsReadyToSign(isCurrentUserMarksComplete(currentUserMarks))
       }
 
@@ -218,7 +217,79 @@ export const SignPage = () => {
     if (meta) {
       handleUpdatedMeta(meta)
     }
-  }, [meta])
+  }, [meta, usersPubkey])
+
+  const decrypt = useCallback(
+    async (file: File) => {
+      setLoadingSpinnerDesc('Decrypting file')
+
+      const zip = await loadZip(file)
+      if (!zip) return
+
+      const parsedKeysJson = await parseKeysJson(zip)
+      if (!parsedKeysJson) return
+
+      const encryptedArrayBuffer = await readContentOfZipEntry(
+        zip,
+        'compressed.sigit',
+        'arraybuffer'
+      )
+
+      if (!encryptedArrayBuffer) return
+
+      const { keys, sender } = parsedKeysJson
+
+      for (const key of keys) {
+        // Set up event listener for authentication event
+        nostrController.on('nsecbunker-auth', (url) => {
+          setAuthUrl(url)
+        })
+
+        // Set up timeout promise to handle encryption timeout
+        const timeoutPromise = new Promise<never>((_, reject) => {
+          setTimeout(() => {
+            reject(new Error('Timeout occurred'))
+          }, 60000) // Timeout duration = 60 seconds
+        })
+
+        // decrypt the encryptionKey, with timeout
+        const encryptionKey = await Promise.race([
+          nostrController.nip04Decrypt(sender, key),
+          timeoutPromise
+        ])
+          .then((res) => {
+            return res
+          })
+          .catch((err) => {
+            console.log('err :>> ', err)
+            return null
+          })
+          .finally(() => {
+            setAuthUrl(undefined) // Clear authentication URL
+          })
+
+        // Return if encryption failed
+        if (!encryptionKey) continue
+
+        const arrayBuffer = await decryptArrayBuffer(
+          encryptedArrayBuffer,
+          encryptionKey
+        )
+          .catch((err) => {
+            console.log('err in decryption:>> ', err)
+            return null
+          })
+          .finally(() => {
+            setIsLoading(false)
+          })
+
+        if (arrayBuffer) return arrayBuffer
+      }
+
+      return null
+    },
+    [nostrController]
+  )
 
   useEffect(() => {
     // online mode - from create and home page views
@@ -276,7 +347,7 @@ export const SignPage = () => {
       setIsLoading(false)
       setDisplayInput(true)
     }
-  }, [decryptedArrayBuffer, uploadedZip, metaInNavState])
+  }, [decryptedArrayBuffer, uploadedZip, metaInNavState, decrypt])
 
   const handleArrayBufferFromBlossom = async (
     arrayBuffer: ArrayBuffer,
@@ -354,75 +425,6 @@ export const SignPage = () => {
     })
   }
 
-  const decrypt = async (file: File) => {
-    setLoadingSpinnerDesc('Decrypting file')
-
-    const zip = await loadZip(file)
-    if (!zip) return
-
-    const parsedKeysJson = await parseKeysJson(zip)
-    if (!parsedKeysJson) return
-
-    const encryptedArrayBuffer = await readContentOfZipEntry(
-      zip,
-      'compressed.sigit',
-      'arraybuffer'
-    )
-
-    if (!encryptedArrayBuffer) return
-
-    const { keys, sender } = parsedKeysJson
-
-    for (const key of keys) {
-      // Set up event listener for authentication event
-      nostrController.on('nsecbunker-auth', (url) => {
-        setAuthUrl(url)
-      })
-
-      // Set up timeout promise to handle encryption timeout
-      const timeoutPromise = new Promise<never>((_, reject) => {
-        setTimeout(() => {
-          reject(new Error('Timeout occurred'))
-        }, 60000) // Timeout duration = 60 seconds
-      })
-
-      // decrypt the encryptionKey, with timeout
-      const encryptionKey = await Promise.race([
-        nostrController.nip04Decrypt(sender, key),
-        timeoutPromise
-      ])
-        .then((res) => {
-          return res
-        })
-        .catch((err) => {
-          console.log('err :>> ', err)
-          return null
-        })
-        .finally(() => {
-          setAuthUrl(undefined) // Clear authentication URL
-        })
-
-      // Return if encryption failed
-      if (!encryptionKey) continue
-
-      const arrayBuffer = await decryptArrayBuffer(
-        encryptedArrayBuffer,
-        encryptionKey
-      )
-        .catch((err) => {
-          console.log('err in decryption:>> ', err)
-          return null
-        })
-        .finally(() => {
-          setIsLoading(false)
-        })
-
-      if (arrayBuffer) return arrayBuffer
-    }
-
-    return null
-  }
-
   const handleDecryptedArrayBuffer = async (arrayBuffer: ArrayBuffer) => {
     const decryptedZipFile = new File([arrayBuffer], 'decrypted.zip')
 
@@ -618,10 +620,12 @@ export const SignPage = () => {
   }
 
   // Handle errors during zip file generation
-  const handleZipError = (err: any) => {
+  const handleZipError = (err: unknown) => {
     console.log('Error in zip:>> ', err)
     setIsLoading(false)
-    toast.error(err.message || 'Error occurred in generating zip file')
+    if (err instanceof Error) {
+      toast.error(err.message || 'Error occurred in generating zip file')
+    }
     return null
   }
 

src/utils/relays.ts

@@ -5,8 +5,8 @@ import { localCache } from '../services'
 import { ONE_WEEK_IN_MS, SIGIT_RELAY } from './const.ts'
 import { RelayMap, RelaySet } from '../types'
 
-const READ_MARKER = 'read'
-const WRITE_MARKET = 'write'
+const READ_MARKER = "read"
+const WRITE_MARKET = "write"
 
 /**
  * Attempts to find a relay list from the provided lookUpRelays.
@@ -15,10 +15,7 @@ const WRITE_MARKET = 'write'
  * @param hexKey
  * @return found relay list or null
  */
-const findRelayListAndUpdateCache = async (
-  lookUpRelays: string[],
-  hexKey: string
-): Promise<Event | null> => {
+const findRelayListAndUpdateCache = async (lookUpRelays: string[], hexKey: string): Promise<Event | null> => {
   try {
     const eventFilter: Filter = {
       kinds: [RelayList],
@@ -45,14 +42,10 @@ const findRelayListAndUpdateCache = async (
 const findRelayListInCache = async (hexKey: string): Promise<Event | null> => {
   try {
     // Attempt to retrieve the metadata event from the local cache
-    const cachedRelayListMetadataEvent =
-      await localCache.getUserRelayListMetadata(hexKey)
+    const cachedRelayListMetadataEvent = await localCache.getUserRelayListMetadata(hexKey)
 
     // Check if the cached event is not older than one week
-    if (
-      cachedRelayListMetadataEvent &&
-      isOlderThanOneWeek(cachedRelayListMetadataEvent.cachedAt)
-    ) {
+    if (cachedRelayListMetadataEvent && isOlderThanOneWeek(cachedRelayListMetadataEvent.cachedAt)) {
       return cachedRelayListMetadataEvent.event
     }
 
@@ -111,5 +104,5 @@ export {
   findRelayListInCache,
   getUserRelaySet,
   getDefaultRelaySet,
-  getDefaultRelayMap
-}
+  getDefaultRelayMap,
+}