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.

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

🐛 Fix namings api #365

Merged
merged 3 commits into from
Apr 17, 2024
Merged

🐛 Fix namings api #365

merged 3 commits into from
Apr 17, 2024

Conversation

naelob
Copy link
Contributor

@naelob naelob commented Apr 17, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced cloud integration for CRM, ticketing, accounting, and marketing automation services.
  • Documentation

    • Updated documentation titles, descriptions, and URLs for marketing automation features.
  • Refactor

    • Standardized environment variable naming by appending "_CLOUD" to service-related variables.
    • Corrected import paths and unified naming conventions across the platform.
  • Style

    • Minor adjustments in code formatting and indentation.
  • Chores

    • Updated configuration settings and dependencies in Docker compositions.

Copy link

changeset-bot bot commented Apr 17, 2024

⚠️ No Changeset found

Latest commit: c9b996a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

coderabbitai bot commented Apr 17, 2024

Walkthrough

The recent updates aim to standardize naming conventions across configurations and code by appending "_CLOUD" to service-related variables and refining import paths. Changes include enhancing function signatures to accommodate a new parameter softwareMode and updating documentation for better alignment with these standards.

Changes

File Path Change Summary
docker-compose.*.yml Standardized environment variables, updated service names, and adjusted dependencies and policies.
docs/..., packages/shared/src/... Updated titles, URLs, corrected typos, and refined enums and constants for naming consistency.
packages/api/src/... (various files under connections and utils) Corrected import paths, updated variable names, added softwareMode parameter, and adjusted logic in functions.

🐰✨
In the realm of code where changes brew,
Variables dance with a fresh view.
Clouds and clean names paint the scene,
Paths align in a harmonious sheen.
Data flows smoother, a joy to behold,
Thanks to updates, in code we're bold!
🌟🐇


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2441127 and c9b996a.
Files selected for processing (5)
  • apps/client-ts/src/app/api-keys/layout.tsx (2 hunks)
  • apps/client-ts/src/app/configuration/layout.tsx (2 hunks)
  • apps/client-ts/src/app/connections/layout.tsx (2 hunks)
  • apps/client-ts/src/app/dashboard/layout.tsx (2 hunks)
  • apps/client-ts/src/app/events/layout.tsx (2 hunks)
Additional comments not posted (6)
apps/client-ts/src/app/api-keys/layout.tsx (1)

18-18: The conditional logic in useEffect correctly checks the config.DISTRIBUTION before redirecting. However, consider adding a comment explaining why the redirect to "/b2c/login" is necessary when config.DISTRIBUTION is not "selfhost".

apps/client-ts/src/app/configuration/layout.tsx (1)

18-18: The conditional logic in useEffect correctly checks the config.DISTRIBUTION before redirecting. However, consider adding a comment explaining why the redirect to "/b2c/login" is necessary when config.DISTRIBUTION is not "selfhost".

apps/client-ts/src/app/connections/layout.tsx (1)

20-20: The conditional logic in useEffect correctly checks the config.DISTRIBUTION before redirecting. However, consider adding a comment explaining why the redirect to "/b2c/login" is necessary when config.DISTRIBUTION is not "selfhost".

apps/client-ts/src/app/dashboard/layout.tsx (2)

8-8: Ensure the import path "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json to avoid module resolution errors.


20-20: The conditional logic in useEffect correctly checks the config.DISTRIBUTION before redirecting. However, consider adding a comment explaining why the redirect to "/b2c/login" is necessary when config.DISTRIBUTION is not "selfhost".

apps/client-ts/src/app/events/layout.tsx (1)

20-20: The conditional logic in useEffect correctly checks the config.DISTRIBUTION before redirecting. However, consider adding a comment explaining why the redirect to "/b2c/login" is necessary when config.DISTRIBUTION is not "selfhost".


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.

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: 2

Actionable comments outside the diff hunks (1)
docs/open-source/contributors.mdx (1)

Line range hint 9-9: Typographical correction: Change 'Setup' to 'Set up' to use the correct form of the verb.

- Setup your environment
+ Set up your environment

@@ -94,7 +94,7 @@ export class PodiumConnectionService
access_token: this.cryptoService.encrypt(data.access_token),
refresh_token: this.cryptoService.encrypt(data.refresh_token),
account_url:
providersConfig['marketing_automation']['podium'].urls.apiUrl,
providersConfig['marketingautomation']['podium'].urls.apiUrl,
Copy link
Contributor

Choose a reason for hiding this comment

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

The URL access within providersConfig has been updated. However, there is a typo in the URL key on line 114 ('pdoum' should be 'podium'). Correct this to ensure proper URL retrieval.

- providersConfig['marketingautomation']['pdoum'].urls.apiUrl
+ providersConfig['marketingautomation']['podium'].urls.apiUrl

Also applies to: 114-114


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
providersConfig['marketingautomation']['podium'].urls.apiUrl,
providersConfig['marketingautomation']['podium'].urls.apiUrl,

## [<u>Click here</u>](https://tally.so/r/3Exrdl?integration_category=marketingautomation) to be notified once this feature is live!
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the Markdown link syntax.

- ## [<u>Click here</u>](https://tally.so/r/3Exrdl?integration_category=marketingautomation) to be notified once this feature is live!
+ ## [<u>Click here</u>](https://tally.so/r/3Exrdl?integration_category=marketingautomation) to be notified once this feature is live!

Ensure that the Markdown link is correctly formatted to avoid rendering issues on the website.


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## [<u>Click here</u>](https://tally.so/r/3Exrdl?integration_category=marketingautomation) to be notified once this feature is live!
## [<u>Click here</u>](https://tally.so/r/3Exrdl?integration_category=marketingautomation) to be notified once this feature is live!

@naelob naelob merged commit db5d916 into main Apr 17, 2024
10 of 12 checks passed
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: 4

@@ -5,6 +5,7 @@ import { RootLayout } from "@/components/RootLayout";
import { useStytchSession } from "@stytch/nextjs";
import { useRouter } from "next/navigation";
import { useEffect } from "react";
import config from "@/lib/config";
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The alias "@/lib/config" is not configured in the tsconfig.json of the apps/client-ts application. This could potentially lead to module resolution errors when trying to import config using this alias in the code. It is recommended to add the necessary configuration in the tsconfig.json or verify the correct path if it's configured differently.

Analysis chain

Ensure the import path "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json to avoid module resolution errors.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check if the alias "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json
rg '("@/lib/config":)' jsconfig.json tsconfig.json

Length of output: 160



Script:

#!/bin/bash
# Search for jsconfig.json or tsconfig.json files in the repository
fd '(jsconfig\.json|tsconfig\.json)$'

Length of output: 197



Script:

#!/bin/bash
# Check if the alias "@/lib/config" is correctly configured in the tsconfig.json of the client-ts application
rg '("@/lib/config":)' apps/client-ts/tsconfig.json

Length of output: 53

@@ -5,6 +5,7 @@ import { RootLayout } from "@/components/RootLayout";
import { useStytchSession } from "@stytch/nextjs";
import { useRouter } from "next/navigation";
import { useEffect } from "react";
import config from "@/lib/config";
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The import path "@/lib/config" does not appear to be configured in the tsconfig.json of the apps/client-ts directory. This could lead to module resolution errors as indicated in the review comment. It is recommended to either add the necessary alias configuration in the tsconfig.json or verify if it is configured in another relevant file.

Analysis chain

Ensure the import path "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json to avoid module resolution errors.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check if the alias "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json
rg '("@/lib/config":)' jsconfig.json tsconfig.json

Length of output: 160



Script:

#!/bin/bash
# Search for jsconfig.json or tsconfig.json in the entire repository
fd '(jsconfig\.json|tsconfig\.json)$'

Length of output: 197



Script:

#!/bin/bash
# Check if the alias "@/lib/config" is correctly configured in the tsconfig.json of the apps/client-ts directory
rg '("@/lib/config":)' apps/client-ts/tsconfig.json

Length of output: 53

@@ -5,6 +5,7 @@ import { RootLayout } from "@/components/RootLayout";
import { useStytchSession } from "@stytch/nextjs";
import { useRouter } from "next/navigation";
import { useEffect } from "react";
import config from "@/lib/config";
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The search for the "@/lib/config" alias in the apps/client-ts/tsconfig.json did not yield any results, indicating that the alias is not configured in this file. This could potentially lead to module resolution errors in the project.

Action Required:
Please ensure that the "@/lib/config" alias is correctly configured in the tsconfig.json for the apps/client-ts directory to avoid module resolution issues. This configuration is crucial for the correct functioning of imports using this alias.

Analysis chain

Ensure the import path "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json to avoid module resolution errors.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check if the alias "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json
rg '("@/lib/config":)' jsconfig.json tsconfig.json

Length of output: 160



Script:

#!/bin/bash
# Check if jsconfig.json or tsconfig.json exist anywhere in the repository
fd '(jsconfig.json|tsconfig.json)'

Length of output: 194



Script:

#!/bin/bash
# Check if the "@/lib/config" alias is configured in the apps/client-ts/tsconfig.json
rg '("@/lib/config":)' apps/client-ts/tsconfig.json

Length of output: 53

@@ -5,6 +5,7 @@ import { RootLayout } from "@/components/RootLayout";
import { useStytchSession } from "@stytch/nextjs";
import { useRouter } from "next/navigation";
import { useEffect } from "react";
import config from "@/lib/config";
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The import path "@/lib/config" is not configured in the tsconfig.json for the apps/client-ts project. This could potentially lead to module resolution errors when trying to import config using this alias in the file apps/client-ts/src/app/events/layout.tsx.

Please ensure that the alias "@/lib/config" is correctly set up in the tsconfig.json or consider using a direct relative path for importing modules to avoid any issues.

Analysis chain

Ensure the import path "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json to avoid module resolution errors.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check if the alias "@/lib/config" is correctly configured in jsconfig.json or tsconfig.json
rg '("@/lib/config":)' jsconfig.json tsconfig.json

Length of output: 160



Script:

#!/bin/bash
# Search for jsconfig.json or tsconfig.json in the repository
fd '(jsconfig\.json|tsconfig\.json)$'

Length of output: 197



Script:

#!/bin/bash
# Check the content of the relevant tsconfig.json for "@/lib/config" configuration
cat apps/client-ts/tsconfig.json | rg '("@/lib/config":)'

Length of output: 59

@naelob naelob deleted the feat/naming-fixes branch July 27, 2024 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants