Skip to content

fix: searchable field values #53

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

Merged
merged 2 commits into from
Sep 2, 2024
Merged

fix: searchable field values #53

merged 2 commits into from
Sep 2, 2024

Conversation

kshitij-k-osmosys
Copy link
Contributor

@kshitij-k-osmosys kshitij-k-osmosys commented Aug 29, 2024

API PR Checklist

Pre-requisites

  • I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
  • I have performed preliminary unit testing.
  • I have updated the required api docs as applicable.
  • I have added/updated test cases to the test suite as applicable

PR Details

PR details have been updated as per the given format (see below)

  • PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
  • Description has been added
  • Related changes have been added (optional)
  • Screenshots have been added (optional)
  • Query request and response examples have been added (as applicable, in case added or updated)
  • Documentation changes have been listed (as applicable)
  • Test suite output is added (as applicable)
  • Pending actions have been added (optional)
  • Any other additional notes have been added (optional)

Additional Information

  • Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
  • Assignee(s) and reviewer(s) have been added (optional)

Description:

Update searchable fields list so that we can use GraphQL search property

Related changes:

  • Update search fields
  • Before update, the following error was present because we do not have data, result columns
{
    "errors": [
        {
            "message": "Unknown column 'summary.data' in 'where clause'",
            "locations": [
                {
                    "line": 2,
                    "column": 3
                }
            ],
            "path": [
                "summaries"
            ],
            "extensions": {
                "code": "INTERNAL_SERVER_ERROR",
                "stacktrace": [
                    "QueryFailedError: Unknown column 'summary.data' in 'where clause'",
                    "    at Query.onResult (osm-transcript-summarizer/apps/api/node_modules/typeorm/driver/src/driver/mysql/MysqlQueryRunner.ts:246:33)",
                    "    at Query.execute (osm-transcript-summarizer/apps/api/node_modules/mysql2/lib/commands/command.js:36:14)",
                    "    at PoolConnection.handlePacket (osm-transcript-summarizer/apps/api/node_modules/mysql2/lib/connection.js:481:34)",
                    "    at PacketParser.onPacket (osm-transcript-summarizer/apps/api/node_modules/mysql2/lib/connection.js:97:12)",
                    "    at PacketParser.executeStart (osm-transcript-summarizer/apps/api/node_modules/mysql2/lib/packet_parser.js:75:16)",
                    "    at Socket.<anonymous> (osm-transcript-summarizer/apps/api/node_modules/mysql2/lib/connection.js:104:25)",
                    "    at Socket.emit (node:events:519:28)",
                    "    at addChunk (node:internal/streams/readable:559:12)",
                    "    at readableAddChunkPushByteMode (node:internal/streams/readable:510:3)",
                    "    at Readable.push (node:internal/streams/readable:390:5)"
                ]
            }
        }
    ],
    "data": null
}

Screenshots:

NA

Query request and response:

NA

Documentation changes:

NA

Test suite output:

NA

Pending actions:

NA

Additional notes:

NA

Summary by CodeRabbit

  • New Features

    • Updated job search criteria to focus on inputFile and outputText attributes, enhancing the relevance of search results.
  • Bug Fixes

    • Adjusted functionality to ensure the findAll method retrieves data based on the new searchable fields without affecting overall performance.

@kshitij-k-osmosys kshitij-k-osmosys added the Ready for review Ready for review label Aug 29, 2024
@kshitij-k-osmosys kshitij-k-osmosys self-assigned this Aug 29, 2024
Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes in the SummaryService class involve an update to the searchableFields array, modifying the criteria used for job searches. The fields data and result have been replaced with inputFile and outputText, indicating a shift in focus for job attribute queries. The findAll method's overall functionality remains unchanged, but the specific searchable fields have been adjusted.

Changes

Files Change Summary
apps/api/src/modules/summary/summary.service.ts Updated searchableFields to replace data and result with inputFile and outputText.

Poem

🐇 In fields of code, where changes bloom,
A shift in focus makes room for new,
From data's grasp to files we chase,
Output and input now take their place.
Hooray for updates, let the search begin,
A hop of joy for the changes within! 🌼


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:

  • 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 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 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.
Early access features: disabled

We are currently testing the following features in early access:

  • Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues on the discussion post.

@kshitij-k-osmosys kshitij-k-osmosys mentioned this pull request Aug 29, 2024
15 tasks
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e4d5631 and 2e3cf36.

Files selected for processing (1)
  • apps/api/src/modules/summary/summary.service.ts (1 hunks)
Additional comments not posted (1)
apps/api/src/modules/summary/summary.service.ts (1)

86-86: LGTM! But verify the database schema.

The searchableFields array has been updated to include inputFile and outputText, replacing data and result. Ensure that the new fields are correctly indexed and available in the database schema to avoid any potential issues during queries.

The code changes are approved.

Run the following script to verify the database schema:

Verification successful

Fields inputFile and outputText are correctly integrated into the database schema.

The fields inputFile and outputText are present in the entity definitions and are used throughout the application, confirming their integration into the database schema and application logic. No further action is required.

  • Found in apps/api/src/modules/summary/entities/summary.entity.ts
  • Used in apps/api/src/modules/summary/dto/create-summary.dto.ts
  • Utilized in apps/api/src/modules/summary/summary.service.ts
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the new fields `inputFile` and `outputText` are indexed and available in the database schema.

# Test: Search for the new fields in the database schema. Expect: Fields are indexed and available.
rg --type sql -A 5 $'inputFile|outputText'

Length of output: 192


Script:

#!/bin/bash
# Locate potential ORM model or migration files and search for `inputFile` and `outputText`.

# Find files that might contain schema definitions, such as ORM models or migrations.
fd --type f --extension ts --extension js --extension json --extension yml --extension yaml --extension sql

# Search for the fields `inputFile` and `outputText` in the located files.
rg 'inputFile|outputText' $(fd --type f --extension ts --extension js --extension json --extension yml --extension yaml --extension sql)

Length of output: 9444

@xixas xixas merged commit 4ec5070 into main Sep 2, 2024
6 checks passed
@xixas xixas deleted the fix/searchableFields branch September 2, 2024 05:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ready for review Ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants