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

feat: Use new sdk instructions instead of hello READMEs #152

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions internal/quickstart/choose_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,19 +94,20 @@ func (m chooseSDKModel) View() string {
}

type sdkDetail struct {
canonicalName string
displayName string
index int
kind string
url string // custom URL if it differs from the other SDKs
canonicalName string
displayName string
index int
kind string
url string // custom URL if it differs from the other SDKs
hasInstructions bool // to remove when we get all instructions loaded
}

func (s sdkDetail) FilterValue() string { return "" }

var SDKs = []sdkDetail{
// {canonicalName: "react", displayName: "React", kind: clientSideSDK},
{canonicalName: "node-server", displayName: "Node.js (server-side)", kind: serverSideSDK},
{canonicalName: "python", displayName: "Python", kind: serverSideSDK},
{canonicalName: "python", displayName: "Python", kind: serverSideSDK, hasInstructions: true},
{canonicalName: "java", displayName: "Java", kind: serverSideSDK},
{canonicalName: "dotnet-server", displayName: ".NET (server-side)", kind: serverSideSDK},
{canonicalName: "js", displayName: "JavaScript", kind: clientSideSDK},
Expand Down
2 changes: 2 additions & 0 deletions internal/quickstart/container.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ func (m ContainerModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
m.sdk.displayName,
m.sdk.url,
m.flagKey,
m.sdk.hasInstructions,
)
cmd = m.currentModel.Init()
}
Expand All @@ -103,6 +104,7 @@ func (m ContainerModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
msg.sdk.displayName,
msg.sdk.url,
m.flagKey,
msg.sdk.hasInstructions,
)
cmd = m.currentModel.Init()
m.sdk = msg.sdk
Expand Down
12 changes: 12 additions & 0 deletions internal/quickstart/messages.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"fmt"
"io"
"net/http"
"os"

tea "github.com/charmbracelet/bubbletea"

Expand Down Expand Up @@ -134,6 +135,17 @@ func sendFetchSDKInstructionsMsg(url string) tea.Cmd {
}
}

func sendReadSDKInstructionsMsg(filename string) tea.Cmd {
return func() tea.Msg {
content, err := os.ReadFile(fmt.Sprintf("internal/sdks/sdk_instructions/%s.md", filename))
if err != nil {
return errMsg{err: err}
}

return fetchedSDKInstructions{instructions: content}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

despite the name of the function we're still sending fetchedSDKInstructions message type - figured we can update either the message name or the function name when we stop fetching from the READMEs but this way we can still just handle this one message in the showSDKInstructionsModel.Update method.

}
}

type showToggleFlagMsg struct{}

func sendShowToggleFlagMsg() tea.Cmd {
Expand Down
43 changes: 25 additions & 18 deletions internal/quickstart/show_sdk_instructions.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,19 @@ const (
)

type showSDKInstructionsModel struct {
accessToken string
baseUri string
canonicalName string
displayName string
flagKey string
help help.Model
helpKeys keyMap
instructions string
sdkKey string
spinner spinner.Model
url string
viewport viewport.Model
accessToken string
baseUri string
canonicalName string
displayName string
flagKey string
help help.Model
helpKeys keyMap
instructions string
hasInstructionsFile bool // TODO: remove when we have all instructions saved
sdkKey string
spinner spinner.Model
url string
viewport viewport.Model
}

func NewShowSDKInstructionsModel(
Expand All @@ -39,6 +40,7 @@ func NewShowSDKInstructionsModel(
displayName string,
url string,
flagKey string,
hasInstructionsFile bool,
) tea.Model {
s := spinner.New()
s.Spinner = spinner.Points
Expand All @@ -48,7 +50,6 @@ func NewShowSDKInstructionsModel(
BorderStyle(lipgloss.RoundedBorder()).
BorderForeground(lipgloss.Color("62")).
PaddingRight(2)
vp.MouseWheelEnabled = true

return showSDKInstructionsModel{
accessToken: accessToken,
Expand All @@ -61,16 +62,23 @@ func NewShowSDKInstructionsModel(
Back: BindingBack,
Quit: BindingQuit,
},
spinner: s,
url: url,
viewport: vp,
spinner: s,
url: url,
viewport: vp,
hasInstructionsFile: hasInstructionsFile,
}
}

func (m showSDKInstructionsModel) Init() tea.Cmd {
// to remove when we have all instruction files loaded
instructionsCmd := sendFetchSDKInstructionsMsg(m.url)
if m.hasInstructionsFile {
instructionsCmd = sendReadSDKInstructionsMsg(m.canonicalName)
}

return tea.Sequence(
m.spinner.Tick,
sendFetchSDKInstructionsMsg(m.url),
instructionsCmd,
sendFetchEnv(m.accessToken, m.baseUri, defaultEnvKey, defaultProjKey),
)
}
Expand Down Expand Up @@ -118,7 +126,6 @@ func (m showSDKInstructionsModel) View() string {
func (m showSDKInstructionsModel) renderMarkdown() (string, error) {
renderer, err := glamour.NewTermRenderer(
glamour.WithAutoStyle(),
glamour.WithWordWrap(viewportWidth),
)
if err != nil {
return "", err
Expand Down
57 changes: 57 additions & 0 deletions internal/sdks/sdk_instructions/python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Set up your application

If you want to skip ahead, the final code is available in our [GitHub repository](https://github.com/launchdarkly/hello-python).


Comment on lines +1 to +5
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think maybe when the instructions are all in we might want to pull this intro text out of the markdown file/viewport box

1. Create a new directory:

```bash
mkdir hello-python && cd hello-python
```

2. Next, create a file called `requirements.txt` with the SDK dependency and install it:

```bash
echo "launchdarkly-server-sdk==9.3.1" >> requirements.txt && pip install -r requirements.txt
```

3. Create a file called `test.py` and add the following code:

```python
# Import the LaunchDarkly client.
import ldclient
from ldclient import Context
from ldclient.config import Config

# Create a helper function for rendering messages.
def show_message(s):
print("*** {}".format(s))
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did change the string formatting from what's shown in the quickstart because our rendering was trying/failing to find the %s values and instead was showing MISSING values

before:

print("*** %s" % s)

image

print()

# Initialize the ldclient with your environment-specific SDK key.
if __name__ == "__main__":
ldclient.set_config(Config("1234567890abcdef"))

# The SDK starts up the first time ldclient.get() is called.
if ldclient.get().is_initialized():
show_message("SDK successfully initialized!")
else:
show_message("SDK failed to initialize")
exit()

# Set up the evaluation context. This context should appear on your LaunchDarkly contexts
# dashboard soon after you run the demo.
context = Context.builder('example-user-key').name('Sandy').build()

# Call LaunchDarkly with the feature flag key you want to evaluate.
flag_value = ldclient.get().variation("my-flag-key", context, False)

show_message("Feature flag 'my-flag-key' is {} for this user".format(flag_value))

# Here we ensure that the SDK shuts down cleanly and has a chance to deliver analytics
# events to LaunchDarkly before the program exits. If analytics events are not delivered,
# the user properties and flag usage statistics will not appear on your dashboard. In a
# normal long-running application, the SDK would continue running and events would be
# delivered automatically in the background.
ldclient.get().close()
```
Loading