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.

Sign up for GitHub

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

Jump to bottom

Trim and remove spaces from ID with user alert #94

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Trim and remove spaces from ID with user alert #94

merged 1 commit into from
Jun 25, 2024

Conversation

theaubmov
Copy link
Collaborator

@theaubmov theaubmov commented May 10, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Added a new function to improve ID processing across different components, enhancing input handling and consistency.

  • Bug Fixes

    • Adjusted ID assignment in various components to use the new ID processing function, ensuring more reliable and standardized IDs.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 10, 2024 •
edited
Loading

Walkthrough

The recent updates involve the addition of a new function processId across several JavaScript files in the spiffworkflow app. This function, designed to format id values by trimming and removing spaces, has been incorporated into various components to ensure consistent id processing. This change enhances data handling and improves the robustness of ID assignments throughout the application.

Changes

File Path Change Summary
.../DataObject/propertiesPanel/DataObjectArray.js Added processId import; modified id assignment in DataObjectTextField.
.../eventList.js, .../helpers.js Introduced processId function; updated imports and usage in eventList.js.

🐰✨
A hop, a skip, in the code we dip,
Trimming spaces, on a digital trip.
IDs align with a magical flair,
In the land of code, precise and fair.
Joy to the files, as changes embrace,
A rabbit’s touch in the codebase space.
🌟📄

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.

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.
  • 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[bot]
coderabbitai bot reviewed May 10, 2024
View reviewed changes
Copy link

@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: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 38f5b5d and 13694fb.
Files selected for processing (3)
  • app/spiffworkflow/DataObject/propertiesPanel/DataObjectArray.js (2 hunks)
  • app/spiffworkflow/eventList.js (2 hunks)
  • app/spiffworkflow/helpers.js (1 hunks)
Additional comments not posted (2)
app/spiffworkflow/eventList.js (1)

145-145: Proper use of processId to sanitize IDs.

This ensures consistent ID handling across the application, enhancing data integrity.

app/spiffworkflow/DataObject/propertiesPanel/DataObjectArray.js (1)

150-150: Proper use of processId to sanitize IDs.

This ensures consistent ID handling across the application, enhancing data integrity.

app/spiffworkflow/helpers.js
Comment on lines +41 to +48
export function processId(id) {
let trimmedId = id.trim();
let processedId = trimmedId.replace(/\s+/g, '');
if (id !== processedId) {
alert('ID should not contain spaces. It has been adjusted.');
}
return processedId;
}
Copy link

Choose a reason for hiding this comment

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

Consider replacing alert with a more flexible notification mechanism.

Using alert directly in a utility function can be intrusive and limits the flexibility of the application. It might be better to return a status or use a callback/event to notify the application, which can then decide how to alert the user.

@burnettk
Copy link
Contributor

please reference the related issue in the PR or the PR in the issue.

@theaubmov theaubmov self-assigned this Jun 10, 2024
@calexh-sar calexh-sar linked an issue Jun 18, 2024 that may be closed by this pull request
ID field with spaces and other special characters #91
Open
burnettk
burnettk approved these changes Jun 25, 2024
View reviewed changes
app/spiffworkflow/helpers.js

export function processId(id) {
let trimmedId = id.trim();
let processedId = trimmedId.replace(/\s+/g, '');
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe we should remove any non-alphanumeric/hyphen/underscore characters?

@burnettk burnettk merged commit 91aa2f5 into main Jun 25, 2024
1 check passed
@burnettk burnettk deleted the feature/remove-spaces-from-id branch June 25, 2024 20:21
@burnettk burnettk mentioned this pull request Jun 25, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@burnettk burnettk burnettk approved these changes

Assignees

@theaubmov theaubmov

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ID field with spaces and other special characters
2 participants
@theaubmov @burnettk