Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: attachments, query-params plugin & test coverage #62

Merged
merged 16 commits into from
Feb 29, 2024

Conversation

voznik
Copy link
Owner

@voznik voznik commented Feb 29, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[x] Bugfix
[x] Feature
[x] Code style update (formatting, local variables)
[x] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the new behavior?

  • New Features
    • Introduce a plugin for collection filtering functionality with query parameters in the URL for persisting collection queries.
    • Introduce methods in collection service to work with attachments
    • Example: show usage of query-params plugin for filtering documents in Todo collection
    • Example: Implemented sorting functionality for todo items with ascending and descending options.
    • Example: Added a context menu for todo items with options for managing attachments (upload, download, remove).
  • Enhancements
    • withCollectionService accepts query, subscribes to documents with query (provided or via plugin)
    • withCollectionService introduces computed countAll, countFiltered for use-cases of displaying entities
  • Bug Fixes
    • Example: Fixed CouchDB sync
  • Refactor
    • Reorganized imports and adjusted module setups across various components and services.
  • Tests
    • Expanded test coverage for withCollectionService and new functionalities like managing attachments and handling query parameters.

Does this PR introduce a breaking change?

[x] Yes
[ ] No

Other information

Copy link

coderabbitai bot commented Feb 29, 2024

Walkthrough

The updates encompass a variety of enhancements and adjustments across the project, focusing on integrating CouchDB configurations, refining ESLint and Angular module configurations, and enhancing RxDB functionality with new plugins and query parameter management. Notably, there's a strong emphasis on improving the user experience in the demo application through UI adjustments and adding context menu and attachment management to todos. The project also sees structural improvements with better error handling, testing enhancements, and streamlined configurations for RxDB collections and Angular services.

Changes

Files Summary
.env.example Added CouchDB configuration.
.eslintrc.json Reformatted extends property to a single-line array.
README.md, packages/rxdb/README.md Updated Angular configuration setup and minor modifications.
examples/demo/src/..., examples/standalone/src/... Enhanced UI/UX with new plugins, context menus, attachment dialog, and sorting functionality. Improved CSS styling and Angular service configurations.
examples/shared/... Introduced new shared modules for animations, configurations, conflict handling, migrations, and models.
packages/rxdb/CHANGELOG.md Enhanced change detection and fixed multi-tabs demo issue.
packages/rxdb/collection/src/lib/..., packages/rxdb/core/src/lib/..., packages/rxdb/query-params/src/..., packages/rxdb/replication-kinto/src/..., packages/rxdb/signals/src/..., packages/rxdb/testing/src/lib/mocks.ts, packages/rxdb/utils/src/lib/... Improved RxDB functionality with better plugin management, query parameters handling, error logging, and testing.
packages/rxdb/config/src/lib/rxdb.config.ts, packages/rxdb/src/lib/rxdb.providers.ts Updated RxDB configuration and collection service setup.

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@voznik
Copy link
Owner Author

voznik commented Feb 29, 2024

@coderabbitai review

@voznik voznik added the WTD label Feb 29, 2024
Copy link

sonarcloud bot commented Feb 29, 2024

Quality Gate Passed Quality Gate passed

Issues
34 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@voznik voznik merged commit 1398283 into master Feb 29, 2024
3 checks passed
@voznik voznik deleted the fix/with-collection-tests branch February 29, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant