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

clarify that the url is a web socket #610

Merged

Conversation

claireolmstead
Copy link
Contributor

Problem

The names of the env vales are confusing.

Link to GitHub Issue(s): #567

Solution

Clarify that one is a websocket.

Steps to Verify:

  1. Run it and make sure it still works
  2. No more instances of "FREQUENCY_URL"

@claireolmstead claireolmstead self-assigned this Oct 10, 2024
@claireolmstead claireolmstead linked an issue Oct 10, 2024 that may be closed by this pull request
3 tasks
Copy link
Contributor

@aramikm aramikm left a comment

Choose a reason for hiding this comment

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

Looks good a few minor comments.

developer-docs/account/ENVIRONMENT.md Outdated Show resolved Hide resolved
developer-docs/content-publishing/ENVIRONMENT.md Outdated Show resolved Hide resolved
developer-docs/content-publishing/INSTALLING.md Outdated Show resolved Hide resolved
developer-docs/content-watcher/ENVIRONMENT.md Outdated Show resolved Hide resolved
developer-docs/content-watcher/INSTALLING.md Outdated Show resolved Hide resolved
developer-docs/graph/ENVIRONMENT.md Outdated Show resolved Hide resolved
Comment on lines +13 to 14
SIWF_NODE_RPC_URL: undefined,
SIWF_URL: undefined,
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: We already have SIWF_URL. Is this redundant or they are used differently?

Copy link
Contributor

Choose a reason for hiding this comment

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

They are different.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do we need to also change SIWF_URL to be SIWF_UI_URL? @mattheworris @aramikm

Copy link
Contributor

Choose a reason for hiding this comment

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

I do like SIWF_UI_URL but I'm fine with leaving SIWF_URL too, as you prefer.

docker-compose-e2e.account.yaml Outdated Show resolved Hide resolved
start.sh Outdated Show resolved Hide resolved
Copy link
Contributor

@mattheworris mattheworris left a comment

Choose a reason for hiding this comment

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

  • Paired with @claireolmstead on some changes
  • Read through finalized changes
  • Non-blocking comments
    🚢 it!

@claireolmstead claireolmstead force-pushed the 567-frequency_url-and-frequency_http_url-are-confusing branch from 82c66bc to 8b16c31 Compare October 11, 2024 16:51
@claireolmstead claireolmstead merged commit 4ff031c into main Oct 11, 2024
13 checks passed
@claireolmstead claireolmstead deleted the 567-frequency_url-and-frequency_http_url-are-confusing branch October 11, 2024 17:14
@JoeCap08055
Copy link
Contributor

Sorry; just getting around to looking at this--last 2 weeks with hurricane & off-site have me in catch-up mode.
A couple of points:

  • We've changed the name of the env var to include _WS_, but the config validation still allows http protocol
  • Technically, there's no reason you couldn't specify an HTTP RPC endpoint; WebSocket is only required if you're doing subscriptions, which we avoid.

We should either disallow http protocol in the config, or eliminate specifying WebSocket/WS in the docs & env name.

I'd be okay with disallowing http, since it's less efficient (needs to establish a connection with each request); however, we might want to consider that some client might have network constraints in their environment that preclude using WebSocket.

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.

FREQUENCY_URL and FREQUENCY_HTTP_URL are Confusing
4 participants