fix: add await before mutateAsync functions by harshsbhat · Pull Request #2208 · unkeyed/unkey

harshsbhat · 2024-10-05T12:53:32Z

What does this PR do?

Fixes #

Add await before mutateAsync functions

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

Appreciated

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

Summary by CodeRabbit

New Features
- Introduced DefaultBytes and DefaultPrefix components for managing default settings of API keys.
- Enhanced CreateKey component to accept initial values for bytes and prefix.
- Added new procedures for setting default API bytes and prefix.
Bug Fixes
- Updated async handling in multiple components to ensure proper mutation completion before proceeding.
Documentation
- Improved the SettingsPage component to include new imports and logic for fetching keyAuth data.
Chores
- Added new methods to the API router for setting default bytes and prefix.

* feat/mobile-sidbar-sync-with-desktop * fix(billing): add missing subscription fields and audit logging to upgrade flow (unkeyed#2179) * fix(billing): add missing subscription fields and audit logging to upgrade flow * fix context properties * refactor: query audit logs from planetscale (unkeyed#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] (unkeyed#2191) * chore: Unkey PDF Viewer template * feat: add template --------- Co-authored-by: chronark <dev@chronark.com> * perf: add database indices (unkeyed#2192) * fix: add header again * docs: Removing pnpm test:routes (unkeyed#2184) * fix: revalidate /apis after creating new API (unkeyed#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 (unkeyed#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>

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

changeset-bot · 2024-10-05T12:53:37Z

⚠️ No Changeset found

Latest commit: 934aef4

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 · 2024-10-05T12:53:39Z

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

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2024 0:55am

vercel · 2024-10-05T12:53:40Z

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

A member of the Team first needs to authorize it.

coderabbitai · 2024-10-05T12:53:41Z

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request introduces several modifications across multiple files, primarily focusing on enhancing the KeyAuth type and its related components. Key changes include the addition of new properties defaultPrefix and defaultBytes to the KeyAuth type, updates to various onSubmit functions to ensure asynchronous operations are awaited, and the introduction of new components for managing default byte and prefix settings. The overall structure and functionality of existing components remain largely intact, with the primary focus on improving control flow and component flexibility.

Changes

File	Change Summary
`apps/api/src/pkg/testutil/harness.ts`	Added properties `defaultPrefix` and `defaultBytes` to `KeyAuth` type for `unkeyKeyAuth` and `userKeyAuth`.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-enabled.tsx`	Updated `onSubmit` to await `updateEnabled.mutateAsync(values)`.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-expiration.tsx`	Updated `onSubmit` to await `changeExpiration.mutateAsync(values)`.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-name.tsx`	Updated `onSubmit` to await `updateName.mutateAsync(values)`.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-ratelimit.tsx`	Updated `onSubmit` to await `updateRatelimit.mutateAsync(values)`.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-remaining.tsx`	Updated `onSubmit` to await `updateRemaining.mutateAsync(values)`.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx`	Added `defaultBytes` and `defaultPrefix` props to `CreateKey` component.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/page.tsx`	Updated `CreateKeypage` to pass `defaultBytes` and `defaultPrefix` props to `CreateKey`.
`apps/dashboard/app/(app)/apis/[apiId]/settings/default-bytes.tsx`	Introduced `DefaultBytes` component for managing default byte size settings.
`apps/dashboard/app/(app)/apis/[apiId]/settings/default-prefix.tsx`	Introduced `DefaultPrefix` component for managing default prefix settings.
`apps/dashboard/app/(app)/apis/[apiId]/settings/page.tsx`	Added imports for `DefaultBytes` and `DefaultPrefix`, and updated to render these components.
`apps/dashboard/app/(app)/apis/[apiId]/settings/update-api-name.tsx`	Updated `onSubmit` to await `updateName.mutateAsync(values)`.
`apps/dashboard/app/(app)/ratelimits/[namespaceId]/settings/update-namespace-name.tsx`	Updated `onSubmit` to await `updateName.mutateAsync(values)`.
`apps/dashboard/app/(app)/settings/general/update-workspace-name.tsx`	Updated `onSubmit` to await `updateName.mutateAsync(values)`.
`apps/dashboard/app/(app)/settings/root-keys/[keyId]/update-root-key-name.tsx`	Updated `onSubmit` to await `updateName.mutateAsync(values)`.
`apps/dashboard/lib/trpc/routers/api/setDefaultBytes.ts`	Introduced `setDefaultApiBytes` procedure for updating default byte size.
`apps/dashboard/lib/trpc/routers/api/setDefaultPrefix.ts`	Introduced `setDefaultApiPrefix` procedure for updating default prefix.
`apps/dashboard/lib/trpc/routers/index.ts`	Added `setDefaultPrefix` and `setDefaultBytes` methods to the API router.
`internal/db/src/schema/keyAuth.ts`	Added `defaultPrefix` and `defaultBytes` fields to the `keyAuth` table schema.

Possibly related issues

Lot of mutateAsync functions not being awaited #2205: Addresses the issue of missing await in mutation async functions, which is directly relevant to the changes made in this PR where several onSubmit functions were updated to include await.

Possibly related PRs

feat(settings): A user can edit the root key name #2086: Modifications to the KeyAuth type in harness.ts, relevant to the changes made in this PR regarding key management.
feat: mobile-sidbar-sync-with-desktop #2180: Enhancements to user interactions with API keys, which may relate to the overall objectives of improving key management features in this PR.

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 150 points, hacktoberfest

Suggested reviewers

perkinsjr
chronark

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 · 2024-10-05T12:53:45Z

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

harshsbhat and others added 18 commits October 2, 2024 14:41

Add default bytes and prefix

5330f39

Merge branch 'main' into harshbhat/default-byte-prefix

c36d43c

Merge branch 'main' into harshbhat/default-byte-prefix

bae0c70

Merge branch 'main' into harshbhat/default-byte-prefix

1fc7b91

adding bytes and prefix columns in harness

dd31966

fmt

35fac12

Await

ac09669

Merge branch 'main' into harshbhat/default-byte-prefix

e929d1c

Merge branch 'main' into harshbhat/default-byte-prefix

2b118b1

Merge branch 'main' into harshbhat/default-byte-prefix

96b2977

Resolved changes

795af63

typo

52c4465

Capital and Extra bracket

f37cdce

Merge branch 'main' into harshbhat/default-byte-prefix

77e5e0d

[autofix.ci] apply automated fixes

8fad37e

Add await before trpc routes

3c337d4

harshsbhat requested review from MichaelUnkey, chronark, mcstepp and perkinsjr as code owners October 5, 2024 12:53

Merge branch 'main' into harshbhat/add-await

934aef4

harshsbhat closed this Oct 5, 2024

harshsbhat deleted the harshbhat/add-await branch October 5, 2024 12:54

vercel bot temporarily deployed to Preview – engineering October 5, 2024 12:55 Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add await before mutateAsync functions#2208

fix: add await before mutateAsync functions#2208
harshsbhat wants to merge 19 commits intounkeyed:mainfrom
harshsbhat:harshbhat/add-await

harshsbhat commented Oct 5, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Oct 5, 2024 •

edited

Loading

Uh oh!

vercel bot commented Oct 5, 2024 •

edited

Loading

Uh oh!

vercel bot commented Oct 5, 2024

Uh oh!

coderabbitai bot commented Oct 5, 2024 •

edited

Loading

Review failed

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Oct 5, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

harshsbhat commented Oct 5, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Oct 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Oct 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Oct 5, 2024

Uh oh!

coderabbitai bot commented Oct 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Oct 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

harshsbhat commented Oct 5, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 5, 2024 •

edited

Loading

vercel bot commented Oct 5, 2024 •

edited

Loading

coderabbitai bot commented Oct 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Oct 5, 2024 •

edited

Loading