@happychef/algorithm 1.2.10 → 1.2.11

package/.github/workflows/ci-cd.yml

@@ -1,103 +1,234 @@
-name: CI/CD Pipeline
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  test:
-    name: Run Tests
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm test
-
-      - name: Run tests with coverage
-        run: npm run test:coverage
-
-      - name: Upload coverage reports
-        uses: codecov/codecov-action@v4
-        if: matrix.node-version == '20.x'
-        with:
-          files: ./coverage/lcov.info
-          flags: unittests
-          name: codecov-umbrella
-          fail_ci_if_error: false
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-  publish:
-    name: Publish to NPM
-    needs: test
-    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-          cache: 'npm'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm test
-
-      - name: Check if version changed
-        id: version-check
-        run: |
-          PACKAGE_VERSION=$(node -p "require('./package.json').version")
-          NPM_VERSION=$(npm view @happychef/algorithm version 2>/dev/null || echo "0.0.0")
-          echo "Package version: $PACKAGE_VERSION"
-          echo "NPM version: $NPM_VERSION"
-          if [ "$PACKAGE_VERSION" != "$NPM_VERSION" ]; then
-            echo "version_changed=true" >> $GITHUB_OUTPUT
-            echo "Version changed from $NPM_VERSION to $PACKAGE_VERSION"
-          else
-            echo "version_changed=false" >> $GITHUB_OUTPUT
-            echo "Version unchanged: $PACKAGE_VERSION"
-          fi
-
-      - name: Publish to NPM
-        if: steps.version-check.outputs.version_changed == 'true'
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: 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
-
-      - name: Create Git Tag
-        if: steps.version-check.outputs.version_changed == 'true'
-        run: |
-          PACKAGE_VERSION=$(node -p "require('./package.json').version")
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          git tag -a "v$PACKAGE_VERSION" -m "Release v$PACKAGE_VERSION"
-          git push origin "v$PACKAGE_VERSION"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened]
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        id: test-run
+        run: npm test -- --verbose 2>&1 | tee test-output.txt
+        continue-on-error: true
+
+      - name: Run tests with coverage
+        if: always()
+        run: npm run test:coverage
+        continue-on-error: true
+
+      - name: Generate test summary
+        if: always()
+        run: |
+          echo "## Test Results for Node.js ${{ matrix.node-version }}" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+
+          # Extract test results
+          TEST_OUTPUT=$(cat test-output.txt)
+
+          if echo "$TEST_OUTPUT" | grep -q "Tests:.*failed"; then
+            echo "❌ **Tests Failed**" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+
+            # Extract summary line
+            SUMMARY=$(echo "$TEST_OUTPUT" | grep "Test Suites:" | tail -1)
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            echo "$SUMMARY" >> $GITHUB_STEP_SUMMARY
+            echo "$TEST_OUTPUT" | grep "Tests:" | tail -1 >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+
+            # Show failed tests
+            echo "### Failed Tests:" >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            echo "$TEST_OUTPUT" | grep -A 10 "FAIL" | head -30 >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "✅ **All Tests Passed!**" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+
+            # Extract summary line
+            SUMMARY=$(echo "$TEST_OUTPUT" | grep "Test Suites:" | tail -1)
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            echo "$SUMMARY" >> $GITHUB_STEP_SUMMARY
+            echo "$TEST_OUTPUT" | grep "Tests:" | tail -1 >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+          fi
+
+      - name: Comment PR with test results
+        if: always() && github.event_name == 'pull_request' && matrix.node-version == '20.x'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            const testOutput = fs.readFileSync('test-output.txt', 'utf8');
+
+            // Check if tests failed
+            const hasFailed = testOutput.includes('FAIL');
+            const summaryLine = testOutput.match(/Test Suites:.*$/m)?.[0] || '';
+            const testsLine = testOutput.match(/Tests:.*$/m)?.[0] || '';
+
+            let comment = '';
+
+            if (hasFailed) {
+              comment = `## ❌ Tests Failed on Node.js ${{ matrix.node-version }}
+
+            **Summary:**
+            \`\`\`
+            ${summaryLine}
+            ${testsLine}
+            \`\`\`
+
+            ### 🔴 Failed Tests Details:
+
+            `;
+
+              // Extract failed test details
+              const failedTests = testOutput.match(/FAIL.*\n(.*\n){0,15}/g) || [];
+              failedTests.forEach(fail => {
+                const lines = fail.split('\n').slice(0, 10);
+                comment += '\`\`\`\n' + lines.join('\n') + '\n\`\`\`\n\n';
+              });
+
+              comment += `
+            ### 💡 What to do:
+            1. Review the failed test(s) above
+            2. Fix the issues in your code
+            3. Push the changes to this PR
+            4. Tests will run automatically again
+
+            **This PR cannot be merged until all tests pass.**
+            `;
+            } else {
+              comment = `## ✅ All Tests Passed on Node.js ${{ matrix.node-version }}
+
+            **Summary:**
+            \`\`\`
+            ${summaryLine}
+            ${testsLine}
+            \`\`\`
+
+            ### 🎉 Great work!
+            All tests are passing. This PR is ready to be reviewed and merged.
+
+            **Next steps:**
+            - Wait for code review (if required)
+            - Merge when ready
+            `;
+            }
+
+            // Post comment
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: comment
+            });
+
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v4
+        if: matrix.node-version == '20.x'
+        with:
+          files: ./coverage/lcov.info
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  publish:
+    name: Publish to NPM
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Check if version changed
+        id: version-check
+        run: |
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+          NPM_VERSION=$(npm view @happychef/algorithm version 2>/dev/null || echo "0.0.0")
+          echo "Package version: $PACKAGE_VERSION"
+          echo "NPM version: $NPM_VERSION"
+          if [ "$PACKAGE_VERSION" != "$NPM_VERSION" ]; then
+            echo "version_changed=true" >> $GITHUB_OUTPUT
+            echo "Version changed from $NPM_VERSION to $PACKAGE_VERSION"
+          else
+            echo "version_changed=false" >> $GITHUB_OUTPUT
+            echo "Version unchanged: $PACKAGE_VERSION"
+          fi
+
+      - name: Publish to NPM
+        if: steps.version-check.outputs.version_changed == 'true'
+        run: |
+          npm publish --access public
+          echo "## 📦 NPM Package Published" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Successfully published @happychef/algorithm@$(node -p "require('./package.json').version")" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "🔗 [View on NPM](https://www.npmjs.com/package/@happychef/algorithm)" >> $GITHUB_STEP_SUMMARY
+        env:
+          NODE_AUTH_TOKEN: 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
+
+      - name: Skip publishing (version unchanged)
+        if: steps.version-check.outputs.version_changed == 'false'
+        run: |
+          echo "## ⏭️ Publishing Skipped" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Version $(node -p "require('./package.json').version") is already published" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "💡 Bump the version in package.json to trigger publishing" >> $GITHUB_STEP_SUMMARY
+
+      - name: Create Git Tag
+        if: steps.version-check.outputs.version_changed == 'true'
+        run: |
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "v$PACKAGE_VERSION" -m "Release v$PACKAGE_VERSION"
+          git push origin "v$PACKAGE_VERSION"
+          echo "## 🏷️ Git Tag Created" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Created and pushed tag: v$PACKAGE_VERSION" >> $GITHUB_STEP_SUMMARY
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/BRANCH_PROTECTION_SETUP.md

@@ -0,0 +1,167 @@
+# Branch Protection Setup Guide
+
+This guide explains how to configure GitHub branch protection rules to require all tests to pass before merging pull requests.
+
+## Why Branch Protection?
+
+Branch protection ensures:
+- ✅ All tests must pass before merging PRs
+- ✅ No direct pushes to main without review (optional)
+- ✅ Code quality is maintained
+- ✅ Broken code never reaches production
+
+## Setup Instructions
+
+### Step 1: Go to Branch Protection Settings
+
+1. Navigate to your GitHub repository: `https://github.com/thibaultvandesompele2/15-happy-algorithm`
+2. Click on **Settings** (tab at the top)
+3. In the left sidebar, click **Branches** (under "Code and automation")
+4. Click **Add branch protection rule** (or **Add rule**)
+
+### Step 2: Configure the Rule
+
+#### Basic Settings:
+1. **Branch name pattern**: Enter `main`
+
+#### Required Settings:
+
+✅ **Check these boxes:**
+
+1. ☑️ **Require a pull request before merging**
+   - This prevents direct pushes to main
+   - Optional: Set "Required number of approvals" to 1 or more
+
+2. ☑️ **Require status checks to pass before merging**
+   - This is the CRITICAL setting for test enforcement
+   - Check: **Require branches to be up to date before merging**
+
+3. In the **Status checks** search box, you'll see:
+   - `Run Tests` (your test job)
+
+   ☑️ **Select both Node.js test jobs:**
+   - `Run Tests (18.x)`
+   - `Run Tests (20.x)`
+
+   *Note: These will appear after the first workflow run completes*
+
+4. ☑️ **Do not allow bypassing the above settings** (recommended)
+   - Even admins must follow these rules
+
+#### Optional but Recommended:
+
+5. ☑️ **Require conversation resolution before merging**
+   - All PR comments must be resolved
+
+6. ☑️ **Require linear history**
+   - Prevents messy merge commits
+
+### Step 3: Save
+
+1. Scroll to the bottom
+2. Click **Create** or **Save changes**
+
+## What Happens After Setup
+
+### On Pull Requests:
+- GitHub automatically runs the CI/CD tests
+- You'll see status checks at the bottom of the PR
+- **Merge button will be DISABLED** until all tests pass
+- If tests fail, you must fix them before merging
+
+### Visual Indicators:
+
+**Tests Running:**
+```
+⏳ Run Tests (18.x) — In progress
+⏳ Run Tests (20.x) — In progress
+```
+
+**Tests Passed:**
+```
+✅ Run Tests (18.x) — Passed
+✅ Run Tests (20.x) — Passed
+🟢 Merge pull request button is ENABLED
+```
+
+**Tests Failed:**
+```
+❌ Run Tests (18.x) — Failed
+❌ Run Tests (20.x) — Failed
+🔴 Merge pull request button is DISABLED
+```
+
+## Testing the Protection
+
+### Create a Test PR:
+
+1. Create a new branch:
+   ```bash
+   git checkout -b test-branch-protection
+   ```
+
+2. Make a small change:
+   ```bash
+   echo "# Test" >> test-file.txt
+   git add test-file.txt
+   git commit -m "Test branch protection"
+   git push origin test-branch-protection
+   ```
+
+3. Go to GitHub and create a pull request
+
+4. Observe:
+   - Tests run automatically
+   - Merge button is disabled until tests complete
+   - After tests pass, merge button becomes available
+
+## Workflow Behavior
+
+### For Pull Requests:
+- ✅ Runs all 70 tests on Node.js 18.x and 20.x
+- ✅ Must pass before merge is allowed
+- ✅ Shows test summary in PR
+- ❌ Does NOT publish to npm (only tests)
+
+### For Pushes to Main:
+- ✅ Runs all tests
+- ✅ If version changed AND tests pass → publishes to npm
+- ✅ Creates git tag
+- ✅ Shows summary of all actions
+
+## Troubleshooting
+
+### "Status checks not found"
+- The status checks only appear after the first workflow run completes
+- Push this branch protection setup, wait for workflow to run, then configure protection
+
+### "Can't find Run Tests in status checks"
+- Make sure the workflow has run at least once
+- Check the Actions tab to see workflow runs
+- The job name must match exactly: `Run Tests`
+
+### "Tests are running but merge button isn't disabled"
+- You need to enable "Require status checks to pass before merging"
+- Make sure you selected the specific test jobs (18.x and 20.x)
+
+## Quick Setup Checklist
+
+- [ ] Go to Settings → Branches
+- [ ] Add branch protection rule for `main`
+- [ ] Enable "Require status checks to pass before merging"
+- [ ] Select `Run Tests (18.x)` and `Run Tests (20.x)`
+- [ ] Enable "Do not allow bypassing"
+- [ ] Save the rule
+- [ ] Test with a PR
+
+## Additional Security (Optional)
+
+For additional security, you can also enable:
+
+- **Require deployments to succeed** - Wait for tests before deploying
+- **Lock branch** - Temporarily prevent all changes
+- **Restrict who can push** - Only specific users/teams can push
+
+---
+
+**Result:** After setup, no code can be merged to `main` without passing all 70 tests! 🎉