Prevent waitFor from fulfilling early in util/testing

[theycallmeswift]

Fixed bug where waitFor promise was being fulfilled immediately. Changed invocations to store a log of FlatfileEvents and invocationWatchers to be compatible with the existing matchEvent method on Flatfile Listeners. Also exposed invocationWatchers to the public API.

[coderabbitai]

Walkthrough

This update significantly enhances the Flatfile API's handling of asynchronous events. It addresses a bug in the waitFor promise, improves event logging, and redefines the TestListener class for better event tracking. Additionally, modifications to the testing framework streamline the workflow and enhance testing reliability. Collectively, these changes optimize event management, increase compatibility with existing features, and provide developers with improved tools for creating responsive applications.

Changes

File(s)	Change Summary
.changeset/purple-lizards-cross.md	Fixes the waitFor promise for proper synchronization, enhances event logging in invocations, and modifies invocationWatchers for better integration and public access.
utils/testing/src/test.listener.spec.ts	Adds unit tests for the TestListener class, verifying functionality in dispatchEvent and waitFor under various conditions.
utils/testing/src/test.listener.ts	Modifies TestListener to map event topics to FlatfileEvent arrays, updates watcher definitions, and enhances the waitFor method's signature and functionality.
test/unit.cleanup.js	Adds a retry mechanism for Jest tests to automatically retry failed tests up to three times, improving test reliability.
.github/workflows/test.yml	Removes the "Build" step from the GitHub Actions workflow, streamlining the testing process by eliminating unnecessary build steps.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant FlatfileAPI
    participant TestListener

    Developer->>FlatfileAPI: Dispatch Event
    FlatfileAPI->>TestListener: Log Event
    TestListener-->>FlatfileAPI: Acknowledge Event
    Developer->>TestListener: Wait for Event
    TestListener->>FlatfileAPI: Check Event Status
    FlatfileAPI-->>TestListener: Return Event Status
    TestListener->>Developer: Resolve Promise

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5d4cd76 and 998e6a7.

Files selected for processing (1)

• .github/workflows/test.yml (1 hunks)

Additional comments not posted (1)

.github/workflows/test.yml (1)

27-27: Verify the necessity of the "Build" step removal.

The "Build" step has been removed from the workflow. Ensure that the tests do not rely on any build artifacts and that the build process is no longer necessary for the tests.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)

test/toBePendingMatcher.ts (1)

1-3: Consider using a more specific import from util.

Instead of importing everything from util, import only inspect for better clarity and potentially smaller bundle size.

- import * as util from 'node:util'
+ import { inspect } from 'node:util'

[dboskovic]