Skip to content

feat: add support for custom nostr relays via environment variable #824

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

pypeaday
Copy link

@pypeaday pypeaday commented Jun 18, 2025

What kind of change does this PR introduce?

feature to allow users to add other nostr relays to publish to - useful for adding local relays for testing

Why was this change needed?

I wanted to publish from postiz to my self-hosted nostr relay, but unless I run postiz from a local fork and build then I can't affect which relays get hit

Other information:

I have discussed this with no one but it arose from thinking through a but I've opened about not being able to post to nostr at all anyways #772

Checklist:

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

  • I have read the CONTRIBUTING guide.
  • I checked that there were not similar issues or PRs already open for this.
  • 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
    • Added support for fully overriding the default list of Nostr relays via a new environment variable, allowing users to customize relay URLs dynamically.

Copy link

vercel bot commented Jun 18, 2025

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

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jun 18, 2025

Walkthrough

The relay URL list was renamed from a static constant to defaultRelays and enhanced to support a fully overrideable relay list via the NOSTR_RELAYS_OVERRIDE environment variable. The final relay list is deduplicated and dynamically assigned based on this configuration. The .env.example file was updated to document this variable.

Changes

File(s) Change Summary
libraries/nestjs-libraries/src/integrations/social/nostr.provider.ts Renamed relay list constant to defaultRelays; added dynamic override of relay URLs via NOSTR_RELAYS_OVERRIDE env variable with deduplication.
.env.example Added NOSTR_RELAYS_OVERRIDE environment variable with default relay URLs and explanatory comment.

Poem

In the warren of relays, new paths now appear,
From code and environment, connections draw near.
Old friends remain, but new ones can play,
All deduped together, in a bright relay array.
🐇✨

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/social/nostr.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:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:201:49)

✨ 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.

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

🧹 Nitpick comments (3)
libraries/nestjs-libraries/src/integrations/social/nostr.provider.ts (3)

17-24: Drop the duplicated default relay entry.

wss://relay.primal.net appears twice in defaultRelays.
Although the final Set removes the duplication, keeping the source list clean avoids accidental regressions (e.g. if someone later removes the Set deduplication).

 const defaultRelays = [
   'wss://relay.primal.net',
   'wss://relay.damus.io',
   'wss://relay.snort.social',
   'wss://nostr.wine',
   'wss://nos.lol',
-  'wss://relay.primal.net',
 ];

26-28: Harden the env-relay parsing (basic URL validation).

extraRelaysFromEnv accepts any comma-separated token, which could include malformed strings.
A quick sanity filter prevents accidental connection attempts to invalid URLs:

-const extraRelaysFromEnv =
-  process.env.POSTIZ_NOSTR_EXTRA_RELAYS?.split(',').map((url: string) => url.trim()).filter((url: string) => url) || [];
+const extraRelaysFromEnv =
+  (process.env.POSTIZ_NOSTR_EXTRA_RELAYS ?? '')
+    .split(',')
+    .map((url) => url.trim())
+    .filter(
+      (url) =>
+        url &&
+        /^(ws|wss):\/\/.+/i.test(url) // basic scheme check
+    );

This keeps the public interface unchanged while guarding against obvious bad inputs.


26-28: Consider a clearer name than list.

list shadows the earlier defaultRelays concept and is fairly generic.
Renaming to something like relays improves readability throughout the class.

No action required if you prefer the current name.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ad21ea0 and 44e3121.

📒 Files selected for processing (1)
  • libraries/nestjs-libraries/src/integrations/social/nostr.provider.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-and-publish

Copy link
Collaborator

@egelhaus egelhaus left a comment

Choose a reason for hiding this comment

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

Please also change the .env.example with an example to understand how to implement it

@pypeaday
Copy link
Author

I pushed a change so that the env var is for overrides instead of extending the default - because at least for me I would want to only post to my local relay in dev, not my local relay and all the default ones... Example now has the defaults listed

I'm not a JS dev at all so definitely fine with this not going in as is and happy to make any changes necessary for the feature

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

🧹 Nitpick comments (2)
.env.example (2)

74-75: Clarify override vs. extension behavior
The comment on line 74 says “override or extend,” but the implementation either fully replaces the default list or merges with it (depending on how you handle NOSTR_RELAYS_OVERRIDE). Please update the wording to accurately describe whether custom relays completely replace the defaults or are appended (with deduplication).


75-75: Verify quoting in .env values
The URLs are wrapped in quotes, which depending on your loader might become part of the value. Confirm that the parser strips them as intended or consider dropping the surrounding quotes for a plain comma-separated list.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 44e3121 and beaf830.

📒 Files selected for processing (2)
  • .env.example (1 hunks)
  • libraries/nestjs-libraries/src/integrations/social/nostr.provider.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • libraries/nestjs-libraries/src/integrations/social/nostr.provider.ts
🧰 Additional context used
🪛 dotenv-linter (3.3.0)
.env.example

[warning] 75-75: [QuoteCharacter] The value has quote characters (', ")


[warning] 75-75: [UnorderedKey] The NOSTR_RELAYS_OVERRIDE key should go before the PINTEREST_CLIENT_ID key

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-and-publish

@pypeaday pypeaday requested a review from egelhaus June 19, 2025 10:28
Copy link
Collaborator

@egelhaus egelhaus left a comment

Choose a reason for hiding this comment

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

LGTM, but @nevo-david needs to test it, as I can't verify it really works.

@egelhaus egelhaus requested a review from nevo-david June 19, 2025 10:39
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