Skip to content

fix: update go sdk code examples to the current sdk version#2200

Merged
chronark merged 3 commits intounkeyed:mainfrom
geraldmaboshe:go_sdk
Oct 5, 2024
Merged

fix: update go sdk code examples to the current sdk version#2200
chronark merged 3 commits intounkeyed:mainfrom
geraldmaboshe:go_sdk

Conversation

@geraldmaboshe
Copy link
Contributor

@geraldmaboshe geraldmaboshe commented Oct 5, 2024

What does this PR do?

Fixes #2189
This PR updates the code examples for golang on the landing page to use the up to date code examples for the golang sdk

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Screenshot 2024-10-05 at 12 00 44 PM
Screenshot 2024-10-05 at 12 00 56 PM

Summary by CodeRabbit

  • New Features

    • Introduced new code examples for various programming languages (Typescript, Python, Go, Java, Elixir, Rust, Curl) demonstrating the Unkey API.
    • Added a dynamic FrameworkSwitcher for users to select frameworks within programming languages.
    • Implemented a clipboard functionality for easy copying of code snippets.
  • UI Enhancements

    • Improved user interface with hover effects and layout adjustments for better navigation.

@changeset-bot
Copy link

changeset-bot bot commented Oct 5, 2024

⚠️ No Changeset found

Latest commit: ee8c590

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 5, 2024

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 11:02am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 11:02am
planetfall 🔄 Building (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 11:02am
planetfall-1728125821813-oGI7 ❌ Failed (Inspect) Oct 5, 2024 11:02am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 11:02am
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 11:02am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 11:02am

@vercel
Copy link

vercel bot commented Oct 5, 2024

@geraldmaboshe is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 5, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing the apps/www/app/code-examples.tsx file by adding new code examples for various programming languages and frameworks related to the Unkey API. Key updates include the introduction of a FrameworkSwitcher for dynamic selection of frameworks, improved UI elements, and clipboard functionality for copying code snippets. The structure of the code examples has been organized to facilitate easier management and interaction, leveraging TypeScript and React features for better state management.

Changes

File Path Change Summary
apps/www/app/code-examples.tsx - Added new code blocks for Typescript, Python, Go, Java, Elixir, Rust, and Curl.
- Introduced languagesList and languages constants.
- Created FrameworkSwitcher and CodeExamples components.
- Enhanced UI with hover effects and active states.
- Implemented clipboard functionality for code blocks.

Assessment against linked issues

Objective Addressed Explanation
Update Go SDK example on the landing page (#2189)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2024

Thank you for following the naming conventions for pull request titles! 🙏

Copy link
Contributor

@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

🧹 Outside diff range and nitpick comments (3)
apps/www/app/code-examples.tsx (3)

Line range hint 275-283: Set correct editorLanguage for Java code blocks

In the languagesList, the Java code blocks have their editorLanguage property set to "ts", but they should be set to "java" to ensure proper syntax highlighting for Java code. Please update the editorLanguage property to "java" for the Java code blocks.

Apply this diff to fix the issue:

 Java: [
   {
     name: "Verify key",
     Icon: JavaIcon,
     codeBlock: javaVerifyKeyCodeBlock,
-    editorLanguage: "ts",
+    editorLanguage: "java",
   },
   {
     name: "Create key",
     Icon: JavaIcon,
     codeBlock: javaCreateKeyCodeBlock,
-    editorLanguage: "ts",
+    editorLanguage: "java",
   },
 ],

Line range hint 284-288: Set correct editorLanguage for Elixir code block

In the languagesList, the Elixir code block has its editorLanguage property set to "ts", but it should be set to "elixir" to ensure proper syntax highlighting for Elixir code. Please update the editorLanguage property accordingly.

Apply this diff to fix the issue:

 Elixir: [
   {
     name: "Verify key",
     Icon: ElixirIcon,
     codeBlock: elixirCodeBlock,
-    editorLanguage: "ts",
+    editorLanguage: "elixir",
   },
 ],

Line range hint 289-299: Set correct editorLanguage for Curl code blocks

In the languagesList, the Curl code blocks have their editorLanguage property set to "tsx", but they should be set to "shell" to ensure proper syntax highlighting for shell scripts. Please update the editorLanguage property to "shell" for the Curl code blocks.

Apply this diff to fix the issue:

 Curl: [
   {
     name: "Verify key",
     Icon: CurlIcon,
     codeBlock: curlVerifyCodeBlock,
-    editorLanguage: "tsx",
+    editorLanguage: "shell",
   },
   {
     name: "Create key",
     Icon: CurlIcon,
     codeBlock: curlCreateKeyCodeBlock,
-    editorLanguage: "tsx",
+    editorLanguage: "shell",
   },
   {
     name: "Ratelimit",
     Icon: CurlIcon,
     codeBlock: curlRatelimitCodeBlock,
-    editorLanguage: "tsx",
+    editorLanguage: "shell",
   },
 ],
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0542d20 and 39617fa.

📒 Files selected for processing (1)
  • apps/www/app/code-examples.tsx (1 hunks)
🔇 Additional comments (2)
apps/www/app/code-examples.tsx (2)

357-404: ⚠️ Potential issue

Remove unintended line numbers from goCreateKeyCodeBlock

The goCreateKeyCodeBlock includes line numbers (e.g., 357~, 358~, etc.) within the code string. These line numbers are not part of the Go code and will cause syntax errors when the code is executed or displayed. Please remove these line numbers from the code string to ensure the code example is valid Go code.

Apply this diff to fix the issue:

 const goCreateKeyCodeBlock = `package main
 import(
 	unkeygo "github.com/unkeyed/unkey-go"
 	"context"
 	"github.com/unkeyed/unkey-go/models/operations"
 	"log"
 )
 
 func main() {
     s := unkeygo.New(
         unkeygo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
     )
 
     ctx := context.Background()
     res, err := s.Keys.CreateKey(ctx, operations.CreateKeyRequestBody{
         APIID: "api_123",
         Name: unkeygo.String("my key"),
         ExternalID: unkeygo.String("team_123"),
         Meta: map[string]any{
             "billingTier": "PRO",
             "trialEnds": "2023-06-16T17:16:37.161Z",
         },
         Roles: []string{
             "admin",
             "finance",
         },
         Permissions: []string{
             "domains.create_record",
             "say_hello",
         },
         Expires: unkeygo.Int64(1623869797161),
         Remaining: unkeygo.Int64(1000),
         Refill: &operations.Refill{
             Interval: operations.IntervalDaily,
             Amount: 100,
         },
         Ratelimit: &operations.Ratelimit{
             Type: operations.TypeFast.ToPointer(),
             Limit: 10,
             Duration: unkeygo.Int64(60000),
         },
         Enabled: unkeygo.Bool(false),
     })
     if err != nil {
         log.Fatal(err)
     }
     if res.Object != nil {
         // handle response
     }
 }
`;

Likely invalid or redundant comment.


317-350: ⚠️ Potential issue

Remove unintended line numbers from goVerifyKeyCodeBlock

The goVerifyKeyCodeBlock includes line numbers (e.g., 317~, 318~, etc.) within the code string. These line numbers are not part of the Go code and will cause syntax errors when the code is executed or displayed. Please remove these line numbers from the code string to ensure the code example is valid Go code.

Apply this diff to fix the issue:

 const goVerifyKeyCodeBlock = `package main
-
-import(
-	unkeygo "github.com/unkeyed/unkey-go"
-	"context"
-	"github.com/unkeyed/unkey-go/models/components"
-	"log"
-)
+import(
+	unkeygo "github.com/unkeyed/unkey-go"
+	"context"
+	"github.com/unkeyed/unkey-go/models/components"
+	"log"
+)

 func main() {
     s := unkeygo.New(
         unkeygo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
     )
 
     ctx := context.Background()
     res, err := s.Keys.VerifyKey(ctx, components.V1KeysVerifyKeyRequest{
         APIID: unkeygo.String("api_1234"),
         Key: "sk_1234",
         Ratelimits: []components.Ratelimits{
             components.Ratelimits{
                 Name: "tokens",
                 Limit: unkeygo.Int64(500),
                 Duration: unkeygo.Int64(3600000),
             },
             components.Ratelimits{
                 Name: "tokens",
                 Limit: unkeygo.Int64(20000),
                 Duration: unkeygo.Int64(86400000),
             },
         },
     })
     if err != nil {
         log.Fatal(err)
     }
     if res.V1KeysVerifyKeyResponse != nil {
         // handle response
     }
 }
`;

Likely invalid or redundant comment.

@chronark chronark merged commit faf6db7 into unkeyed:main Oct 5, 2024
@oss-gg
Copy link

oss-gg bot commented Oct 5, 2024

Awarding geraldmaboshe: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/geraldmaboshe

harshsbhat pushed a commit to harshsbhat/unkey that referenced this pull request Oct 5, 2024
…2200)

* fix: update go sdk code examples to the current sdk version

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Andreas Thomas <dev@chronark.com>
github-merge-queue bot pushed a commit that referenced this pull request Oct 5, 2024
* Add default bytes and prefix

* adding bytes and prefix columns in harness

* fmt

* Await

* Resolved changes

* typo

* Capital and Extra bracket

* [autofix.ci] apply automated fixes

* feat: mobile-sidbar-sync-with-desktop (#2180)

* feat/mobile-sidbar-sync-with-desktop

* fix(billing): add missing subscription fields and audit logging to upgrade flow (#2179)

* fix(billing): add missing subscription fields and audit logging to upgrade flow

* fix context properties

* refactor: query audit logs from planetscale (#2181)

* refactor: query audit logs from planetscale

* fix: sort logs

* [autofix.ci] apply automated fixes

* chore: remove csv export

* Update apps/dashboard/app/(app)/audit/[bucket]/page.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fmt: add comma

* ci: remove wrong lint command

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* chore: Unkey PDF Viewer template [SIDE QUEST] (#2191)

* chore: Unkey PDF Viewer template

* feat: add template

---------

Co-authored-by: chronark <dev@chronark.com>

* perf: add database indices (#2192)

* fix: add header again

* docs: Removing pnpm test:routes (#2184)

* fix: revalidate /apis after creating new API (#2183)

* fix: revalidate /apis after creating new API key

* fix: show success message after revalidate suceeds

* fix: revalidate cache before routing

* chore(deps-dev): bump @types/react-dom from 18.2.25 to 18.3.0 (#2187)

Bumps [@types/react-dom](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-dom) from 18.2.25 to 18.3.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-dom)

---
updated-dependencies:
- dependency-name: "@types/react-dom"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Refactor/workspace-navigation

* ran fmt

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Meg Stepp <mcstepp@users.noreply.github.com>
Co-authored-by: Andreas Thomas <dev@chronark.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nazar Poshtarenko <32395926+unrenamed@users.noreply.github.com>
Co-authored-by: Harsh Shrikant Bhat <90265455+harshsbhat@users.noreply.github.com>
Co-authored-by: Gerald Maboshe <maboshegerald1@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: update go sdk code examples to the current sdk version (#2200)

* fix: update go sdk code examples to the current sdk version

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Andreas Thomas <dev@chronark.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Akshay <100031493+AkshayBandi027@users.noreply.github.com>
Co-authored-by: Meg Stepp <mcstepp@users.noreply.github.com>
Co-authored-by: Andreas Thomas <dev@chronark.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nazar Poshtarenko <32395926+unrenamed@users.noreply.github.com>
Co-authored-by: Gerald Maboshe <maboshegerald1@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[🕹️] Landing page shows wrong go sdk example

2 participants