-
Notifications
You must be signed in to change notification settings - Fork 216
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adds support for vanity subdomains
Co-authored-by: Han Qiao <[email protected]>
- Loading branch information
1 parent
f646b19
commit 76fbeee
Showing
9 changed files
with
961 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "errors" | ||
| "os" | ||
| "os/signal" | ||
|
|
||
| "github.com/spf13/afero" | ||
| "github.com/spf13/cobra" | ||
| "github.com/supabase/cli/internal/vanity_subdomains/activate" | ||
| "github.com/supabase/cli/internal/vanity_subdomains/check" | ||
| "github.com/supabase/cli/internal/vanity_subdomains/delete" | ||
| "github.com/supabase/cli/internal/vanity_subdomains/get" | ||
| ) | ||
|
|
||
| var ( | ||
| vanityCmd = &cobra.Command{ | ||
| GroupID: groupManagementAPI, | ||
| Use: "vanity-subdomains", | ||
| Short: "Manage vanity subdomains for Supabase projects", | ||
| Long: `Manage vanity subdomains for Supabase projects. | ||
| Usage of vanity subdomains and custom domains is mutually exclusive.`, | ||
| PersistentPreRunE: func(cmd *cobra.Command, args []string) error { | ||
| if !experimental { | ||
| return errors.New("must set the --experimental flag to run this command") | ||
| } | ||
| return cmd.Root().PersistentPreRunE(cmd, args) | ||
| }, | ||
| } | ||
|
|
||
| desiredSubdomain string | ||
|
|
||
| vanityActivateCmd = &cobra.Command{ | ||
| Use: "activate", | ||
| Short: "Activate a vanity subdomain", | ||
| Long: `Activate a vanity subdomain for your Supabase project. | ||
| This reconfigures your Supabase project to respond to requests on your vanity subdomain. | ||
| After the vanity subdomain is activated, your project's auth services will no longer function on the {project-ref}.{supabase-domain} hostname. | ||
| `, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| fsys := afero.NewOsFs() | ||
| if err := PromptLogin(fsys); err != nil { | ||
| return err | ||
| } | ||
| ctx, _ := signal.NotifyContext(cmd.Context(), os.Interrupt) | ||
| return activate.Run(ctx, projectRef, desiredSubdomain, fsys) | ||
| }, | ||
| } | ||
|
|
||
| vanityGetCmd = &cobra.Command{ | ||
| Use: "get", | ||
| Short: "Get the current vanity subdomain", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| fsys := afero.NewOsFs() | ||
| if err := PromptLogin(fsys); err != nil { | ||
| return err | ||
| } | ||
| ctx, _ := signal.NotifyContext(cmd.Context(), os.Interrupt) | ||
| return get.Run(ctx, projectRef, fsys) | ||
| }, | ||
| } | ||
|
|
||
| vanityCheckCmd = &cobra.Command{ | ||
| Use: "check-availability", | ||
| Short: "Checks if a desired subdomain is available for use", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx, _ := signal.NotifyContext(cmd.Context(), os.Interrupt) | ||
| return check.Run(ctx, projectRef, desiredSubdomain, afero.NewOsFs()) | ||
| }, | ||
| } | ||
|
|
||
| vanityDeleteCmd = &cobra.Command{ | ||
| Use: "delete", | ||
| Short: "Deletes a project's vanity subdomain", | ||
| Long: `Deletes the vanity subdomain for a project, and reverts to using the project ref for routing.`, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx, _ := signal.NotifyContext(cmd.Context(), os.Interrupt) | ||
| return delete.Run(ctx, projectRef, afero.NewOsFs()) | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| func init() { | ||
| vanityCmd.PersistentFlags().StringVar(&projectRef, "project-ref", "", "Project ref of the Supabase project.") | ||
| vanityActivateCmd.Flags().StringVar(&desiredSubdomain, "desired-subdomain", "", "The desired vanity subdomain to use for your Supabase project.") | ||
| vanityCheckCmd.Flags().StringVar(&desiredSubdomain, "desired-subdomain", "", "The desired vanity subdomain to use for your Supabase project.") | ||
| vanityCmd.AddCommand(vanityGetCmd) | ||
| vanityCmd.AddCommand(vanityCheckCmd) | ||
| vanityCmd.AddCommand(vanityActivateCmd) | ||
| vanityCmd.AddCommand(vanityDeleteCmd) | ||
|
|
||
| rootCmd.AddCommand(vanityCmd) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package activate | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/afero" | ||
| "github.com/supabase/cli/internal/utils" | ||
| "github.com/supabase/cli/pkg/api" | ||
| ) | ||
|
|
||
| func Run(ctx context.Context, projectRefArg string, desiredSubdomain string, fsys afero.Fs) error { | ||
| // 1. Sanity checks. | ||
| projectRef := projectRefArg | ||
| subdomain := strings.TrimSpace(desiredSubdomain) | ||
| { | ||
| if len(projectRefArg) == 0 { | ||
| ref, err := utils.LoadProjectRef(fsys) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| projectRef = ref | ||
| } else if !utils.ProjectRefPattern.MatchString(projectRef) { | ||
| return errors.New("Invalid project ref format. Must be like `abcdefghijklmnopqrst`.") | ||
| } | ||
| if len(subdomain) == 0 { | ||
| return errors.New("non-empty vanity subdomain expected") | ||
| } | ||
| } | ||
|
|
||
| // 2. create vanity subdomain | ||
| { | ||
| resp, err := utils.GetSupabase().ActivateVanitySubdomainPleaseWithResponse(ctx, projectRef, api.ActivateVanitySubdomainPleaseJSONRequestBody{ | ||
| VanitySubdomain: subdomain, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if resp.JSON201 == nil { | ||
| return errors.New("failed to create vanity subdomain config: " + string(resp.Body)) | ||
| } | ||
| fmt.Printf("Activated vanity subdomain at %s\n", resp.JSON201.CustomDomain) | ||
| return nil | ||
| } | ||
| } |
Oops, something went wrong.