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

[Draft] feat: Server SDK Diagrams + Generator Action #657

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

JamieSinn
Copy link
Member

@JamieSinn JamieSinn commented May 3, 2024

I don't know whether or not the actual SVG's should be rendered in the features location - but there's no other "Server SDK" global docs.

Copy link

vercel bot commented May 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
devcycle-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 27, 2024 3:08pm

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JamieSinn - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

fetch-depth: 1
- name: plantuml
id: plantuml
uses: kolchurinvv/generate-plantuml-action@master
Copy link

Choose a reason for hiding this comment

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

suggestion (code_refinement): Consider pinning the action to a specific version instead of using master.

Using a specific version or commit hash helps in maintaining consistent behavior and avoiding unexpected changes when the master branch is updated.

Suggested change
uses: kolchurinvv/generate-plantuml-action@master
uses: kolchurinvv/generate-plantuml-action@<specific-version-or-commit-hash>

group Config Manager
group Constructor/Initialization
start
if (options.UseRealtimeUpdates) then (yes)
Copy link
Contributor

Choose a reason for hiding this comment

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

this option is named wrong here

Copy link
Member Author

Choose a reason for hiding this comment

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

It's more "human" here - but if we want to make it exact that works too

Copy link
Contributor

Choose a reason for hiding this comment

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

well either use words or use the name of the option if youre going to write it as options.Something

Copy link
Member Author

Choose a reason for hiding this comment

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

I was trying to make it clear that the value is being pulled from the options passed into the initialization call - thoughts on how to better do that? Our options aren't named consistently

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 named consistently in most cases. Any case where they aren't should be fixed

Copy link
Member Author

Choose a reason for hiding this comment

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

The fact you said "most" means they aren't :P Plus - all server SDKs don't actually have this functionality enabled - so for the 1/1 for go - thoughts on using the options.EnableRealtimeUpdates ? or options.DisableRealtimeUpdates ? -
Go will be disabled by default - so will have Enabled as the option name

Copy link
Contributor

Choose a reason for hiding this comment

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

it should be named the same as the existing option in the other SDKs

Copy link
Contributor

Choose a reason for hiding this comment

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

and it should be enabled by default

Copy link
Member Author

Choose a reason for hiding this comment

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

Until we're confident in it with the test harness - it's going to be disabled by default - cc @jonathannorris

The other SDKs this is relevant to (server sdks) do not have a current option - do we want to match the client sdks?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes, we want it to match the client SDKs

@andrewdmaclean
Copy link
Contributor

@JamieSinn and/or @ajwootto - where is this PR sitting right now?

@JamieSinn
Copy link
Member Author

we'll probably make some logic changes in it as the beta works through in go/nodejs - so pending for now.

@andrewdmaclean andrewdmaclean marked this pull request as draft July 2, 2024 22:02
@andrewdmaclean andrewdmaclean changed the title feat: Server SDK Diagrams + Generator Action [Draft] feat: Server SDK Diagrams + Generator Action Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

5 participants