chore: Add check local packages action (#1092)

* chore: Update asset-packs package

* fix: Allow dev package

* chore: Move check no local packages to a GHAction

* chore: Update asset-packs package

* fix: Convert TS file to CJS

* fix: GHAction comment id

* chore: Move local dependencies check to ci pipeline

* fix: debug downloaded files

* chore: Enhance message

* chore: simplify comment dependencies logic

* chore: Generate comment.md to properly show in the PR

* fix: string comment

* fix: error detection

* fix: check exit code

* fix: catch exit code

* chore: Update @dcl/asset-packs

Author: cyaiox

.github/scripts/check-no-local-packages.cjs

@@ -0,0 +1,85 @@
+const fs = require('fs')
+const path = require('path')
+
+// Function to recursively find all package.json files
+function findPackageJsonFiles(dir, fileList = []) {
+  const files = fs.readdirSync(dir)
+
+  for (const file of files) {
+    const filePath = path.join(dir, file)
+    const stat = fs.statSync(filePath)
+
+    if (stat.isDirectory() && !filePath.includes('node_modules')) {
+      findPackageJsonFiles(filePath, fileList)
+    } else if (file === 'package.json') {
+      fileList.push(filePath)
+    }
+  }
+
+  return fileList
+}
+
+// Check for local package dependencies
+function checkNoLocalPackages(packageJsonPath) {
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'))
+    const errors = []
+
+    // Check both dependencies and devDependencies
+    for (const deps of [packageJson.dependencies, packageJson.devDependencies]) {
+      if (!deps) continue
+
+      for (const [key, value] of Object.entries(deps)) {
+        if (
+          value.startsWith('file:') ||
+          value.startsWith('http:') ||
+          value.startsWith('https:') ||
+          value.startsWith('git:')
+        ) {
+          errors.push(`Dependency ${key} is not pointing to a published version: ${value}`)
+        }
+      }
+    }
+
+    if (errors.length) {
+      console.error(`\n\nErrors in ${packageJsonPath}:`)
+      errors.forEach((error) => console.error(`- ${error}`))
+      return false
+    }
+
+    return true
+  } catch (error) {
+    console.error(`Error processing ${packageJsonPath}: ${error.message}`)
+    return false
+  }
+}
+
+// Main function
+function main() {
+  // Check if a directory was passed as an argument
+  const targetDir = process.argv[2] || '.'
+
+  console.log(`Checking for local package dependencies in ${targetDir}...`)
+  const packageJsonFiles = findPackageJsonFiles(targetDir)
+  console.log(`Found ${packageJsonFiles.length} package.json files to check.`)
+
+  let hasErrors = false
+
+  for (const packageJsonPath of packageJsonFiles) {
+    console.log(`Checking ${packageJsonPath}...`)
+    if (!checkNoLocalPackages(packageJsonPath)) {
+      hasErrors = true
+    }
+  }
+
+  if (hasErrors) {
+    console.error(
+      `\n\nFound packages with local dependencies in ${targetDir}. Please publish these dependencies instead of using local references.`
+    )
+    process.exit(1)
+  } else {
+    console.log(`\n\nNo local dependencies found in ${targetDir}. All good!`)
+  }
+}
+
+main()

.github/workflows/ci.yml

@@ -38,35 +38,45 @@ jobs:
           cache: 'npm'
       - name: docs
         run: make docs
+
   test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
+
       - uses: actions/setup-node@v3
         with:
           node-version: 20
           cache: 'npm'
+
       - name: install
         run: make install
+
       - name: build
         run: make build
+
       - name: test
         env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
+          NODE_OPTIONS: '--max_old_space_size=4096'
         run: make test-coverage
+
       - name: test-cli
         run: make test-cli
+
       - name: test-inspector
         env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
+          NODE_OPTIONS: '--max_old_space_size=4096'
         run: make test-inspector
+
       - uses: codecov/codecov-action@v3
         if: always()
         with:
           fail_ci_if_error: false # optional (default = false)
           verbose: true # optional (default = false)
+
       - name: prepare releasable packages
         run: make prepare
+
   test-e2e:
     needs: [notify_deployment]
     runs-on: ubuntu-latest
@@ -90,8 +100,9 @@ jobs:
         run: cd packages/@dcl/inspector && npm i && cd ../../../
       - name: test-inspector E2E
         env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
+          NODE_OPTIONS: '--max_old_space_size=4096'
         run: E2E_URL=https://${{steps.get-cloudflare-url.outputs.result}}/inspector make test-inspector-e2e
+
   build:
     runs-on: ubuntu-latest
     permissions:
@@ -110,7 +121,6 @@ jobs:
           node-version: 20
           cache: 'npm'
 
-
       - name: install
         run: make install
 
@@ -447,3 +457,104 @@ jobs:
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.SDK_TEAM_AWS_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.SDK_TEAM_AWS_SECRET }}
+
+  check-local-deps:
+    name: Check for development dependencies
+    needs: [build]
+    runs-on: ubuntu-latest
+    if: >
+      (github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main') ||
+      github.ref == 'refs/heads/main'
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: Download prepared packages
+        uses: actions/download-artifact@v4
+        with:
+          name: built-artifacts
+          path: downloaded-packages
+
+      - name: Set up artifacts for checking
+        run: |
+          echo "Setting up built artifacts for checking..."
+          mkdir -p extracted-packages
+
+          # Extract all packages to separate directories
+          find downloaded-packages -type f -name "*.tgz" | while read pkg; do
+            if [ -f "$pkg" ]; then
+              # Get package name from the filename
+              pkg_name=$(basename "$pkg" .tgz)
+              
+              # Create directory for this package
+              mkdir -p "extracted-packages/$pkg_name"
+              
+              echo "Extracting $pkg to extracted-packages/$pkg_name"
+              tar -xzf "$pkg" -C "extracted-packages/$pkg_name"
+            fi
+          done
+
+          # List all extracted packages
+          echo "Extracted packages:"
+          find extracted-packages -name "package.json" | sort
+
+      - name: Check for local package dependencies
+        id: dependency-check
+        continue-on-error: true
+        run: |
+          set +e
+          node .github/scripts/check-no-local-packages.cjs ./extracted-packages > check-output.txt 2>&1
+          check_exit_code=$?
+          set -e
+
+          echo "Full output from dependency check:"
+          cat check-output.txt
+
+          if [ $check_exit_code -ne 0 ]; then
+            grep -i "dependency " check-output.txt > dependency-errors.txt || echo "No specific dependency errors found" > dependency-errors.txt
+            if [ ! -s dependency-errors.txt ]; then
+              echo "⚠️ No specific dependency errors found" > dependency-errors.txt
+            fi
+            exit 1
+          fi
+
+      - name: Generate comment content
+        if: steps.dependency-check.outcome == 'failure'
+        run: |
+          echo "## ⚠️ Local Dependencies Detected" >> dependency-check-comment.md
+          echo "This PR contains package dependencies that use local paths (\`file:\`) or non-allowed URLs (\`http:\`, \`https:\`, \`git:\`)." >> dependency-check-comment.md
+          echo "These must be published and referenced properly before merging." >> dependency-check-comment.md
+          echo "### Not allowed dependencies:" >> dependency-check-comment.md
+          echo '```' >> dependency-check-comment.md
+          cat dependency-errors.txt >> dependency-check-comment.md
+          echo '```' >> dependency-check-comment.md
+          echo "Review the workflow logs for more details." >> dependency-check-comment.md
+          echo "> **Note:** This comment is automatically updated when the PR is updated." >> dependency-check-comment.md
+
+      - name: Find Local Dependencies Comment if check fails
+        if: ${{ github.event_name == 'pull_request' && steps.dependency-check.outcome == 'failure' }}
+        uses: peter-evans/find-comment@v3
+        id: fc-local-deps
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: Local Dependencies Detected
+
+      - name: Create or update Local Dependencies Comment if check fails
+        if: ${{ github.event_name == 'pull_request' && steps.dependency-check.outcome == 'failure' }}
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          comment-id: ${{ steps.fc-local-deps.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body-path: dependency-check-comment.md
+          edit-mode: replace
+
+      - name: Fail check if local dependencies found
+        if: steps.dependency-check.outcome == 'failure'
+        run: |
+          echo "❌ Local package dependencies detected! These must be fixed before merging."
+          exit 1

scripts/prepare.spec.ts

@@ -35,7 +35,6 @@ flow('build-all', () => {
     for (const dependency of processWithOptimisticDependencies(graph)) {
       const projectDirectory = resolveProjectPath(dependency)
       installCrossDependencies(projectDirectory)
-      checkNoLocalPackages(projectDirectory)
       itExecutes('npm pack', projectDirectory)
     }
   })