Southclaws / storyden

With a fresh new take on traditional bulletin board forum software, Storyden is a modern, secure and extensible platform for building communities.
https://www.storyden.org/
Mozilla Public License 2.0
93 stars 11 forks source link

Rework search and datagraph types #285

Closed Southclaws closed 1 week ago

vercel[bot] commented 1 week ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
storyden ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 10, 2024 9:36pm
1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **storyden-homepage** | ⬜️ Ignored ([Inspect](https://vercel.com/southclaws-projects/storyden-homepage/BS7H5Q2rTmYSQ4R8Qb8i9Sz3BetN)) | [Visit Preview](https://storyden-homepage-git-rework-datagra-c6fa7d-southclaws-projects.vercel.app) | | Nov 10, 2024 9:36pm |
coderabbitai[bot] commented 1 week ago

[!CAUTION]

Review failed

The pull request is closed.

📝 Walkthrough ## Walkthrough The pull request introduces significant enhancements to the `datagraph` package, particularly the `Kind` type, by adding new constants such as `KindThread`, `KindReply`, `KindCollection`, and `KindEvent`. It also updates the `NewKind` function to accommodate these new types. Other changes include the introduction of type aliases, modifications to existing components to handle new item types, and updates to serialization logic across various files. Additionally, several components are restructured to use the new types, improving overall data handling in the application. ## Changes | File Path | Change Summary | |----------------------------------------------------|-------------------------------------------------------------------------------------------------------| | app/resources/datagraph/datagraph_enum_gen.go | Added constants: `KindThread`, `KindReply`, `KindCollection`, `KindEvent`; updated `NewKind` function. | | app/resources/datagraph/indexable.go | Added type alias `OptAsset`; updated `WithCover` interface to return `OptAsset`. | | app/resources/datagraph/kind.go | Added constants: `kindThread`, `kindReply`, `kindCollection`, `kindEvent`. | | app/resources/event/event.go | Updated `GetKind` method to return `datagraph.KindEvent` instead of `datagraph.KindPost`. | | app/resources/mq/message_types.go | Renamed `IndexPost` to `IndexThread` and added `ID` field. | | app/resources/post/reply/reply.go | Added field `Slug` to `Reply` struct; defined `GetKind` method returning `datagraph.KindReply`. | | app/resources/post/thread/thread.go | Added `GetKind()` method to `Thread` struct returning `datagraph.KindThread`. | | app/services/reply/create.go | Updated message type published to index queue from `mq.IndexPost` to `mq.IndexReply`. | | app/services/reply/service.go | Updated `indexQueue` type from `pubsub.Topic[mq.IndexPost]` to `pubsub.Topic[mq.IndexReply]`. | | app/services/reply/update.go | Updated message type published to index queue from `mq.IndexPost` to `mq.IndexReply`. | | app/services/semdex/index_job/indexer.go | Added `threadRepo`; replaced `qpost` with `qthread` and `qreply`; added `indexThread` and `indexReply` methods. | | app/services/semdex/index_job/job.go | Replaced `qpost` with `qthread` and `qreply` in `runIndexConsumer` function. | | app/services/semdex/index_job/provider.go | Updated `fx.Provide` parameters to use `queue.New[mq.IndexThread]` and `queue.New[mq.IndexReply]`. | | app/services/semdex/index_job/reindex/job.go | Updated parameters in `runReindexer` from `qpost` to `qthread` and `qreply`. | | app/services/semdex/index_job/reindex/reindexer.go| Removed `qpost`; added `qthread` and `qreply`; updated reindexing methods. | | app/services/semdex/semdexer/refhydrate/hydrator.go| Introduced `withRelevance` type; refactored `Hydrate` method for concurrency. | | app/services/semdex/semdexer/weaviate_semdexer/mapping.go | Added new types for Weaviate data handling; updated `mapToNodeReference` function. | | app/services/semdex/semdexer/weaviate_semdexer/relevance.go | Removed unused functions related to Weaviate response mapping. | | app/services/semdex/semdexer/weaviate_semdexer/search.go | Modified `Search` method to change how Weaviate data is queried. | | web/src/api/openapi-schema/collectionItem.ts | Updated `CollectionItem` type definition to include `CollectionItemAllOf`. | | web/src/api/openapi-schema/collectionItemAllOf.ts | Added new type `CollectionItemAllOf`. | | web/src/api/openapi-schema/datagraphItem.ts | Changed `DatagraphItem` from an interface to a union type. | | web/src/api/openapi-schema/datagraphItemKind.ts | Added new properties to `DatagraphItemKind`. | | web/src/api/openapi-schema/datagraphItemNode.ts | Added new interface `DatagraphItemNode`. | | web/src/api/openapi-schema/datagraphItemNodeKind.ts | Added type `DatagraphItemNodeKind`. | | web/src/api/openapi-schema/datagraphItemPost.ts | Added new interface `DatagraphItemPost`. | | web/src/api/openapi-schema/datagraphItemPostKind.ts | Added type `DatagraphItemPostKind`. | | web/src/api/openapi-schema/datagraphItemProfile.ts | Added new interface `DatagraphItemProfile`. | | web/src/api/openapi-schema/datagraphItemProfileKind.ts | Added type `DatagraphItemProfileKind`. | | web/src/api/openapi-schema/datagraphItemReply.ts | Added new interface `DatagraphItemReply`. | | web/src/api/openapi-schema/datagraphItemReplyKind.ts | Added type `DatagraphItemReplyKind`. | | web/src/api/openapi-schema/datagraphItemThread.ts | Added new interface `DatagraphItemThread`. | | web/src/api/openapi-schema/datagraphItemThreadKind.ts | Added type `DatagraphItemThreadKind`. | | web/src/api/openapi-schema/index.ts | Added new export statements for various modules. | | web/src/components/datagraph/DatagraphItemCard.tsx | Restructured rendering logic; added new card components for different item types. | | web/src/components/feed/FeedItem/FeedItem.tsx | Removed `FeedItem` component. | | web/src/components/library/NodeCard.tsx | Removed `context` property from `Props`. | | web/src/components/library/NodeCardList.tsx | Updated `NodeCard` usage to remove `context` prop. | | web/src/components/notifications/NotificationCardList.tsx | Updated title generation logic using `getCommonProperties`. | | web/src/components/notifications/useNotifications.ts | Updated `getNotificationContent` to use `getCommonProperties`. | | web/src/components/post/PostCard.tsx | Introduced new `PostCard` component for displaying post details. | | web/src/components/post/ThreadCard.tsx | Renamed `ThreadItem` to `ThreadReferenceCard`; updated imports. | | web/src/components/post/ThreadReferenceList.tsx | Updated to use `ThreadReferenceCard` instead of `ThreadItem`. | | web/src/components/profile/ProfileContent/ProfileContent.tsx | Replaced `ThreadItemList` with `ThreadReferenceList`. | | web/src/components/search/DatagraphSearchResults.tsx | Removed `DatagraphResultItem`; updated rendering logic. | | web/src/components/thread/ThreadIndexView/ThreadIndexView.tsx | Replaced `ThreadItemList` with `ThreadReferenceList`. | | web/src/lib/datagraph/item.ts | Introduced `getCommonProperties` function for extracting common properties from items. | | web/src/screens/collection/CollectionScreen.tsx | Updated `item` prop passed to `DatagraphItemCard`. | | web/src/screens/drafts/DraftListScreen.tsx | Updated import to use `ThreadReferenceList` instead of `ThreadItemList`. | | web/src/screens/feed/ThreadFeedScreen.tsx | Updated to use `ThreadReferenceList` instead of `ThreadItemList`. | | web/src/screens/tags/TagScreen.tsx | Updated to use `DatagraphItemCard` instead of `DatagraphResultItem`. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant UI participant Service participant Queue participant Database User->>UI: Create Thread UI->>Service: Send Thread Data Service->>Queue: Publish mq.IndexThread Queue->>Database: Store Thread Database-->>Queue: Acknowledge Queue-->>Service: Acknowledge Service-->>UI: Confirm Creation ``` ## Possibly related PRs - **#202**: The changes in the main PR regarding the `Kind` type and the addition of new constants (`KindThread`, `KindReply`, etc.) are related to the modifications in the `NotificationItem` type in the retrieved PR, which includes a property of type `DatagraphItem`. This indicates a connection in how different kinds of items, including notifications, are categorized and handled within the application. ## Poem > 🐇 In the datagraph's lively den, > New kinds hop, like threads and men. > With replies and events in tow, > Our data dances, watch it grow! > From posts to cards, a joyful spree, > A world of stories, come and see! 🌟

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.