postiz-app icon indicating copy to clipboard operation
postiz-app copied to clipboard

Published 20 hours ago • verified publisher icon gitroomhq

Feature(self-hosted): Hide any integration which does not have required env variables setup

Open halkeye opened this issue 6 months ago • 3 comments

What kind of change does this PR introduce?

Feature

Why was this change needed?

While self hosting postiz, I have a bunch of services I don't have configured (like pintrest or facebook). Instead of leaving them in the UI but when clicked on, they dont work, confusing people I figured it was easier to just hide them

Other information:

eg: Did you discuss this change with anybody before working on it (not required, but can be a good idea for bigger changes). Any plans for the future, etc?

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

  • [X] I have read the CONTRIBUTING guide.
  • [X] I checked that there were not similar issues or PRs already open for this.
  • [X] This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

  • New Features
    • Social integrations now indicate their availability based on environment configuration, ensuring only active and properly configured integrations are shown and used.
  • Bug Fixes
    • Integration listings have been refined to include only available social integrations, enhancing reliability and user experience.

halkeye avatar May 31 '25 16:05 halkeye

@halkeye is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 31 '25 16:05 vercel[bot]

Walkthrough

This change introduces an available boolean property to all social integration provider classes and their interface. The IntegrationManager methods now filter social integrations by this property, ensuring only available providers are processed and returned. No changes are made to public method signatures or article integrations.

Changes

File(s) Change Summary
integrations/social/*.provider.ts (Bluesky, Lemmy, Nostr) Added available: boolean property, always set to true.
integrations/social/*.provider.ts (Discord, Dribbble, Facebook, Farcaster, Instagram, InstagramStandalone, Linkedin, Mastodon, Pinterest, Reddit, Slack, Telegram, Threads, Tiktok, Vk, X, Youtube) Added available: boolean property, set based on required environment variables.
integrations/social/social.integrations.interface.ts Added available: boolean to SocialProvider interface. Minor formatting fix in AuthTokenDetails.
integrations/integration.manager.ts Filters social integrations by available property in getAllIntegrations and getAllPlugs.
integrations/social/threads.provider.ts, x.provider.ts, youtube.provider.ts Added available: boolean property; removed unused import and performed minor formatting cleanup.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant IntegrationManager
    participant SocialProvider(s)

    Client->>IntegrationManager: getAllIntegrations() / getAllPlugs()
    IntegrationManager->>SocialProvider(s): Check available property
    alt Provider available
        IntegrationManager->>SocialProvider(s): Process integration
        SocialProvider(s)-->>IntegrationManager: Integration details / plug metadata
    else Provider unavailable
        IntegrationManager-->>IntegrationManager: Skip provider
    end
    IntegrationManager-->>Client: Return filtered integrations/plugs

Possibly related PRs

  • gitroomhq/postiz-app#511: Introduced the LemmyProvider class; this PR directly adds the available property to it and includes it in the filtering logic.
  • gitroomhq/postiz-app#568: Added the TelegramProvider integration; this PR now marks its availability and ensures it's filtered accordingly.
  • gitroomhq/postiz-app#562: Added the Farcaster social provider; this PR adds the available property and integrates it into the filtering mechanism.

Poem

A bunny with code in its paws,
Hopped through providers, fixing flaws.
Now integrations check if they're "here,"
With available flags, all is clear!
Only the ready will answer the call—
The rest take a nap, not showing at all.
🐰✨

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

libraries/nestjs-libraries/src/integrations/integration.manager.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@eslint/eslintrc' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38) at #link (node:internal/modules/esm/module_job:170:49)

libraries/nestjs-libraries/src/integrations/social/bluesky.provider.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@eslint/eslintrc' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38) at #link (node:internal/modules/esm/module_job:170:49)

libraries/nestjs-libraries/src/integrations/social/discord.provider.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@eslint/eslintrc' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38) at #link (node:internal/modules/esm/module_job:170:49)

  • 19 others
📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6caff854059d7ea5f1bae6b39df1ef919f6d99ac and b10364131464e11522ec3599ea73eefeda8222ca.

📒 Files selected for processing (22)
  • libraries/nestjs-libraries/src/integrations/integration.manager.ts (2 hunks)
  • libraries/nestjs-libraries/src/integrations/social/bluesky.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/discord.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/dribbble.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/facebook.provider.ts (2 hunks)
  • libraries/nestjs-libraries/src/integrations/social/farcaster.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/instagram.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/instagram.standalone.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/lemmy.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/linkedin.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/mastodon.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/nostr.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/pinterest.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/reddit.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/slack.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/social.integrations.interface.ts (2 hunks)
  • libraries/nestjs-libraries/src/integrations/social/telegram.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/threads.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/tiktok.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/vk.provider.ts (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/x.provider.ts (2 hunks)
  • libraries/nestjs-libraries/src/integrations/social/youtube.provider.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (22)
  • libraries/nestjs-libraries/src/integrations/social/bluesky.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/slack.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/nostr.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/lemmy.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/social.integrations.interface.ts
  • libraries/nestjs-libraries/src/integrations/social/discord.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/vk.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/instagram.standalone.provider.ts
  • libraries/nestjs-libraries/src/integrations/integration.manager.ts
  • libraries/nestjs-libraries/src/integrations/social/tiktok.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/mastodon.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/threads.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/x.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/linkedin.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/dribbble.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/reddit.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/pinterest.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/facebook.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/farcaster.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/telegram.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/youtube.provider.ts
  • libraries/nestjs-libraries/src/integrations/social/instagram.provider.ts
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot] avatar May 31 '25 16:05 coderabbitai[bot]

Pretty cool implementation, will have a look soon :)

nevo-david avatar Jun 01 '25 08:06 nevo-david

This PR is stale because it has been open for 90 days with no activity.

github-actions[bot] avatar Aug 30 '25 09:08 github-actions[bot]

This PR was closed because it has been inactive for 7 days since being marked as stale.

github-actions[bot] avatar Sep 06 '25 09:09 github-actions[bot]

@nevo-david should i resubmit this one?

halkeye avatar Sep 06 '25 15:09 halkeye