Add: column waiting logic on suggestions as well by ItzNotABug · Pull Request #2663 · appwrite/console

ItzNotABug · 2025-12-02T12:19:58Z

What does this PR do?

Fixes the issue of error when generating sample data right after ai suggested columns are generated. The state mayb not always be available for columns, so we wait.

Test Plan

Manual.

Related PRs and Issues

N/A.

Have you read the Contributing Guidelines on issues?

Yes.

Summary by CodeRabbit

New Features
- Added real-time event tracking for column creation and updates in database operations with automatic monitoring and response capabilities.
Refactor
- Refactored column observation logic into a dedicated, centralized utility module to enhance code reusability, maintainability, and consistency across multiple database management components.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

appwrite · 2025-12-02T12:20:03Z

Console (appwrite/console)

Project ID: 688b7bf400350cbd60e9

Sites (1)

Site	Status	Logs	Preview	QR
console-stage `688b7cf6003b1842c9dc`	Ready	View Logs	Preview URL

Tip

Every Git commit and branch gets its own deployment URL automatically

coderabbitai · 2025-12-02T12:20:16Z

Walkthrough

This PR introduces a new setupColumnObserver module that centralizes logic for tracking column creation and updates via real-time events. The observer maintains column state, manages timeouts, and provides event handlers and promises for coordinating creation workflows. The module is then integrated into two Svelte components that previously contained inline column observation logic. The integration involves subscribing to real-time column events, wiring handlers, and using promise-based coordination to wait for column availability. Existing inline observation implementations are replaced with calls to the centralized module.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

setupColumnObserver logic: Verify promise resolution paths (timeout vs. count-based), proper state management with isActive flag, and timeout cleanup to prevent memory leaks
Real-time event subscription: Confirm correct event path patterns (databases.*.tables.*.columns.*) and handler attachment/detachment in both components
Async/await pattern changes: The onMount callback in empty.svelte changed from async to synchronous; verify that suggestColumns being called without await does not introduce race conditions or unintended concurrency issues
Cleanup and lifecycle: Ensure columnCreationHandler is properly reset in finally blocks and that the observer cleans up listeners after promises resolve or timeout
Handler coordination: Verify that the destructured startWaiting, waitPromise, and handler from setupColumnObserver are correctly wired and that the promise coordination works as intended in both integration points

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'Add: column waiting logic on suggestions as well' clearly summarizes the main change: adding waiting logic for column state in the suggestions flow to handle timing issues with AI-suggested columns.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix-sample-data

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/routes/(console)/project-[region]-[project]/databases/database-[database]/(observer)/columnObserver.ts (2)
29-33: Redundant clearTimeout call.

clearTimeout(timeout) is called on line 30, and then cleanup() on line 31 calls it again on line 40. While harmless, you could simplify by removing line 30 since cleanup() already handles it.
             if (expectedCount > 0 && availableColumns.size >= expectedCount) {
-                    clearTimeout(timeout);
                     cleanup();
                     resolvePromise();
                 }
52-56: Same redundant clearTimeout pattern.

Similar to above, line 53 clears the timeout before cleanup() is called, which also clears it.
         if (availableColumns.size >= expectedCount) {
-            clearTimeout(timeout);
             cleanup();
             resolvePromise();
         }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b3b19df and 3b172e7.

📒 Files selected for processing (3)

src/routes/(console)/project-[region]-[project]/databases/database-[database]/(observer)/columnObserver.ts (1 hunks)
src/routes/(console)/project-[region]-[project]/databases/database-[database]/(suggestions)/empty.svelte (7 hunks)
src/routes/(console)/project-[region]-[project]/databases/database-[database]/table-[table]/+layout.svelte (3 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

**/*.{ts,tsx,js,jsx,svelte}