Template - CSV file to JSON file

jannejjj commented 3 months ago

I previously thought that there was a bug in the SFTP.WriteFile task similar to the one in the UploadFiles, but it turns out I was just using an incorrect file path. Everything works as it should. 😄

closes #8

Checklist for review:

[x] Process name is fine, uses normal casing and descriptive
[x] Process description is fine, uses normal casing, dots and is descriptive
- [x] Element names use normal casing, no unneeded capital letters.
[x] Correct casing used for formats and terms, e.g. CSV, FTP, JSON, Avro
- [x] Element names do not contain dots
- [x] Comments / note element text are in good language and end with dots.
[x] Template parameters checked
- [x] Parameter descriptions are good and end with dots.
- [x] Sensitive parameters are marked as secrets
[x] "Turn off logging" switch is on for any task that has sensitive data as output
[x] End "balls" like error throws and return statements have titles (double-click) and reasonable information.
- [x] Results have good summaries, preferably with statistics of some sort like "processed X files"
- [x] Errors have some error info, usually from task (e.g. some ErrorMessage property contains additional error info)
[x] Process is organised with groups (dashed boxes)
[x] Straight lines are preferred where possible
[x] Subprocesses are forbidden
[x] Text mode is preferred over Expressions in expressions, e.g. instead of $"This is {#var.error}" use This is {{#var.error}}
[x] Process metadata file is present and content is fine (version number and name)
[x] Process export file is present (process.json)
[x] Process description file is present (all sections filled in)
[x] Process description has a SVG screenshot of the process
[x] Tempalte files are going to the correct folder

Summary by CodeRabbit

New Features
- Introduced a new template that downloads a CSV file from an SFTP server, converts it to JSON format, and uploads the result back to the SFTP server.
- Added metadata for the "CSV file to JSON file" transformation, including name, version, tags, and additional systems used.
- Detailed process descriptions, variable definitions, and logic flow in BPMN format for the CSV to JSON file conversion process.

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@jannejjj has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 53 seconds before requesting another review.

How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between a919e1cfdf473740e072e0b5af11a2688c5da901 and f4f2fa44ca4bb49db9e73fe17c40e91dc3a12fa4.

Walkthrough

This set of changes introduces a new template process for handling CSV files and SFTP servers. The process downloads a CSV file from an SFTP server, converts it into a JSON format, and uploads the JSON file back to the SFTP server. The changes cover process definitions, metadata, implementation details, and error handling guidelines.

Changes

File Path	Change Summary
Templates/.../CSV file to JSON file/long-description.md	Adds a summary outlining the implementation of a process for converting CSV to JSON using SFTP and provides error handling details.
Templates/.../CSV file to JSON file/metadata.json	Introduces metadata for the CSV to JSON transformation process including name, version, and tags.
Templates/.../CSV file to JSON file/process.json	Details the process for reading a CSV from SFTP, converting it to JSON, and uploading back via SFTP, including server details and logic flow in BPMN format.

Sequence Diagram(s)

sequenceDiagram
    participant SFTPClient as SFTP Client
    participant CSVProcessor as CSV Processor
    participant JSONProcessor as JSON Processor
    participant SFTPServer as SFTP Server

    SFTPClient->>SFTPServer: Request CSV file
    SFTPServer-->>SFTPClient: Send CSV file
    SFTPClient->>CSVProcessor: Read CSV file
    CSVProcessor->>JSONProcessor: Convert CSV to JSON
    JSONProcessor-->>SFTPClient: Provide JSON file
    SFTPClient->>SFTPServer: Upload JSON file

Assessment against linked issues

Objective	Addressed	Explanation
Template - CSV file to JSON file (#8)	✅

Poem

In data's dance, a rabbit's scheme,
From CSV to JSON, a coder's dream.
Through SFTP we send and receive,
Transforming files like you won't believe.
Data flows with elegant grace,
A seamless journey from place to place. 🐇✨

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 .` - `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 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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

FrendsSarlinS commented 3 months ago

1) The process and the template name should be "CSV file to JSON file" (uppercase JSON) to be in accord with other processes and templates that have to do with JSON. Right now it's "Json" for both process and template.

2) However, in metadata.json, the title is "CSV file to JSON file" as it should.

3) Description for the process has the same issue with JSON casing. Also, the grammar is not correct.

4) Process variable "TargetFileName" is missing an ending dot, or period, in the description.

5) Is it possible to get the task error message as an output as well for both Throws? Right now, the error messages seem lacking.

jannejjj commented 3 months ago

The process and the template name should be "CSV file to JSON file" (uppercase JSON) to be in accord with other processes and templates that have to do with JSON. Right now it's "Json" for both process and template.

Changed casing.

Description for the process has the same issue with JSON casing. Also, the grammar is not correct.

I don't think the process description matters, since that doesn't actually go into the template when you make a template out of the process. Changed it anyways. :D

Process variable "TargetFileName" is missing an ending dot, or period, in the description.

Added the missing period.

Is it possible to get the task error message as an output as well for both Throws? Right now, the error messages seem lacking.

Sadly, the SFTP read and upload tasks throw exceptions instead of returning error messages, meaning that actually, if the task runs into an error, the process simply stops there:

FrendsPlatform / FrendsTemplates