fix: login/logout using the configured domain (#4050)

* fix: login/logout using the configured domain * fix: use findProjectConfig instead of cli which is not always available * fix: added login/logout to dev help listing * fix: remove hidden flag on login/logout * docs: adding login/logout to reference docs
garden-io · Apr 11, 2023 · 1e444e7 · 1e444e7
1 parent d4f3ef0
commit 1e444e7
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 37 deletions.
diff --git a/core/src/commands/login.ts b/core/src/commands/login.ts
@@ -15,13 +15,14 @@ import { ConfigurationError, InternalError, TimeoutError } from "../exceptions"
 import { AuthRedirectServer } from "../cloud/auth"
 import { EventBus } from "../events"
 import { getCloudDistributionName } from "../util/util"
+import { ProjectResource } from "../config/project"
+import { findProjectConfig } from "../config/base"
 
 const loginTimeoutSec = 60
 
 export class LoginCommand extends Command {
   name = "login"
   help = "Log in to Garden Cloud."
-  hidden = true
 
   /**
    * Since we're logging in, we don't want to resolve e.g. the project config (since it may use secrets, which are
@@ -37,27 +38,25 @@ export class LoginCommand extends Command {
     printHeader(headerLog, "Login", "☁️")
   }
 
-  async action({ cli, garden, log }: CommandParams): Promise<CommandResult> {
-    // The Enterprise API is missing from the Garden class for commands with noProject
-    // so we initialize it here.
-    const globalConfigStore = garden.globalConfigStore
-
-    let configuredDomain = garden.cloudDomain
-
-    if (!configuredDomain) {
-      const projectConfig = await cli?.getProjectConfig(log, garden.projectRoot)
-
-      // Fail if this is not run within a garden project
-      if (!projectConfig) {
-        throw new ConfigurationError(
-          `Not a project directory (or any of the parent directories): ${garden.projectRoot}`,
-          {
-            root: garden.projectRoot,
-          }
-        )
-      }
+  async action({ garden, log }: CommandParams): Promise<CommandResult> {
+    // NOTE: The Cloud API is missing from the Garden class for commands with noProject
+    // so we initialize it here. noProject also make sure that the project config is not
+    // initialized in the garden class, so we need to read it in here to get the cloud
+    // domain.
+    const projectConfig: ProjectResource | undefined = await findProjectConfig(log, garden.projectRoot)
+
+    // Fail if this is not run within a garden project
+    if (!projectConfig) {
+      throw new ConfigurationError(
+        `Not a project directory (or any of the parent directories): ${garden.projectRoot}`,
+        {
+          root: garden.projectRoot,
+        }
+      )
     }
 
+    const globalConfigStore = garden.globalConfigStore
+
     // Garden works by default without Garden Cloud. In order to use cloud, a domain
     // must be known to cloud for any command needing a logged in user.
     //
@@ -68,7 +67,7 @@ export class LoginCommand extends Command {
     //
     // If the fallback was used, we rely on the token to decide if the Cloud API instance
     // should use the default domain or not. The token lifecycle ends on logout.
-    let cloudDomain: string = getGardenCloudDomain(configuredDomain)
+    let cloudDomain: string = getGardenCloudDomain(projectConfig?.domain)
 
     const distroName = getCloudDistributionName(cloudDomain)
 

diff --git a/core/src/commands/logout.ts b/core/src/commands/logout.ts
@@ -12,11 +12,12 @@ import { CloudApi, getGardenCloudDomain } from "../cloud/api"
 import { dedent } from "../util/string"
 import { getCloudDistributionName } from "../util/util"
 import { ConfigurationError } from "../exceptions"
+import { ProjectResource } from "../config/project"
+import { findProjectConfig } from "../config/base"
 
 export class LogOutCommand extends Command {
   name = "logout"
   help = "Log out of Garden Cloud."
-  hidden = true
   noProject = true
 
   description = dedent`
@@ -27,26 +28,22 @@ export class LogOutCommand extends Command {
     printHeader(headerLog, "Log out", "☁️")
   }
 
-  async action({ cli, garden, log }: CommandParams): Promise<CommandResult> {
+  async action({ garden, log }: CommandParams): Promise<CommandResult> {
     // The Enterprise API is missing from the Garden class for commands with noProject
     // so we initialize it here.
-    let configuredDomain = garden.cloudDomain
+    const projectConfig: ProjectResource | undefined = await findProjectConfig(log, garden.projectRoot)
 
-    if (!configuredDomain) {
-      const projectConfig = await cli?.getProjectConfig(log, garden.projectRoot)
-
-      // Fail if this is not run within a garden project
-      if (!projectConfig) {
-        throw new ConfigurationError(
-          `Not a project directory (or any of the parent directories): ${garden.projectRoot}`,
-          {
-            root: garden.projectRoot,
-          }
-        )
-      }
+    // Fail if this is not run within a garden project
+    if (!projectConfig) {
+      throw new ConfigurationError(
+        `Not a project directory (or any of the parent directories): ${garden.projectRoot}`,
+        {
+          root: garden.projectRoot,
+        }
+      )
     }
 
-    const cloudDomain: string | undefined = getGardenCloudDomain(configuredDomain)
+    const cloudDomain: string | undefined = getGardenCloudDomain(projectConfig?.domain)
 
     const distroName = getCloudDistributionName(cloudDomain)
 

diff --git a/docs/reference/commands.md b/docs/reference/commands.md
@@ -3010,6 +3010,30 @@ sources:
     path:
 ```
 
+### garden login
+
+**Log in to Garden Cloud.**
+
+Logs you in to Garden Cloud. Subsequent commands will have access to cloud features.
+
+#### Usage
+
+    garden login 
+
+
+
+### garden logout
+
+**Log out of Garden Cloud.**
+
+Logs you out of Garden Cloud.
+
+#### Usage
+
+    garden logout 
+
+
+
 ### garden logs
 
 **Retrieves the most recent logs for the specified Deploy(s).**