refactor: improve payload type

[cpvalente]

This is a quick test to solve the issue described by the user

There are two points of improvement here

• we should attempt keeping the types defined by the user
• we should allow sending multiple commands

For the user defined case, where we want to send two integers 1 1, I believe the easiest case is to wrap this in an array [1,1], so that we can treat the arguments individually

We should take some time investigating to make sure there are no unintended side effects

Closes #953

[coderabbitai]

Important

Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (10)

• apps/client/src/common/utils/regex.ts is excluded by none and included by none
• apps/client/src/features/app-settings/panel/integrations-panel/OscIntegrations.tsx is excluded by none and included by none
• apps/server/src/services/integration-service/OscIntegration.ts is excluded by none and included by none
• apps/server/src/services/integration-service/integrationUtils.test.ts is excluded by none and included by none
• apps/server/src/utils/__tests__/oscArgParser.test.ts is excluded by none and included by none
• apps/server/src/utils/oscArgParser.ts is excluded by none and included by none
• packages/types/src/definitions/core/OscSettings.type.ts is excluded by none and included by none
• packages/utils/index.ts is excluded by none and included by none
• packages/utils/src/regex-utils/splitWhitespace.test.ts is excluded by none and included by none
• packages/utils/src/regex-utils/splitWhitespace.ts is excluded by none and included by none

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Tip

Early Access Features

• gpt-4o model for chat

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
• Mastodon
• Reddit
• LinkedIn

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to full the 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 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.

[alex-Arc]

I think it might be a bit to broad, it results i cue numbers becoming floats and so on

[cpvalente]

@alex-Arc Agreed, I dont suggest we merge this.
The PR is just to point to the place of improvement and the desired shape

I think we should try and find a way to keep the user desired format.
Perhaps just numbers and arrays of values?

Are there any apps that do this nicely?
we could ask the users to wrap variables in ""
so 1.2 is float and "1.2" is a string

[jwetzell]

Looks like you are only allowing one argument in the emit(address: string, payload?: ArgumentType) function? I am assuming payload = argument in OSC language. I think sorting out that would be the solution I would go for.

[cpvalente]

Great stuff, just left some small suggestions for the code style. Behaviour seems good to me, lets see with @alex-Arc that is more in touch with this part of the application

[alex-Arc]

looks to work good
I can setup the tests if you need help?

[jwetzell]

@alex-Arc I won't be able to get to it until later today if you want to do the tests, if I don't see anything by this evening I'll jump back and split the regex into that regex util and add the tests

[alex-Arc]

@jwetzell
if the user puts something like {{eventNow.title}} in the payload and that returns '' be course the title is empty
Should we drop that payload? We kind of have to be course '' is what we get if the user manually types an empty payload

then what if the payload is {{eventNow.title}} somthingElse then somethingElse will move it's position in the array depending on the title

[jwetzell]

@alex-Arc is this templating specific to OSC arguments or is it used in multiple places?

I'm thinking if the templating could be setup (maybe a boolean passed into it) to return empty string results as a double quoted empty string "".

[alex-Arc]

we use the same template parser for all the integrations, but we could maybe make a version for OSC