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.

Sign up for GitHub

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

improvement(cloud): log 'not logged in' msg at info level for community #5553

Merged
merged 1 commit into from
Dec 13, 2023
Merged

improvement(cloud): log 'not logged in' msg at info level for community #5553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
140 changes: 94 additions & 46 deletions core/src/garden.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1869,59 +1869,28 @@ export const resolveGardenParams = profileAsync(async function _resolveGardenPar
const projectApiVersion = config.apiVersion
const sessionId = opts.sessionId || uuidv4()
const cloudApi = opts.cloudApi || null
const isCommunityEdition = !config.domain
const distroName = getCloudDistributionName(cloudApi?.domain || DEFAULT_GARDEN_CLOUD_DOMAIN)
const debugLevelCommands = ["dev", "serve", "exit", "quit"]
const cloudLogLevel = debugLevelCommands.includes(opts.commandInfo.name) ? LogLevel.debug : undefined
const cloudLog = log.createLog({ name: getCloudLogSectionName(distroName), fixLevel: cloudLogLevel })

let secrets: StringMap = {}
let cloudProject: CloudProject | null = null
// If true, then user is logged in and we fetch the remote project and secrets (if applicable)
if (!opts.skipCloudConnect && cloudApi) {
cloudLog.info(`Connecting project...`)

cloudProject = await getCloudProject({
cloudApi,
config,
log: cloudLog,
projectName,
projectRoot,
isCommunityEdition,
})
const cloudDomain = cloudApi?.domain || getGardenCloudDomain(config.domain)
const loggedIn = !!cloudApi

// Fetch Secrets. Not supported on the community edition.
if (cloudProject && !isCommunityEdition) {
try {
secrets = await wrapActiveSpan(
"getSecrets",
async () =>
await cloudApi.getSecrets({
log: cloudLog,
projectId: cloudProject!.id,
environmentName,
})
)
cloudLog.debug(`Fetched ${Object.keys(secrets).length} secrets from ${cloudApi.domain}`)
} catch (err) {
cloudLog.error(`Fetching secrets failed with error: ${err}`)
const { secrets, cloudProject } = opts.skipCloudConnect
? {
secrets: {},
cloudProject: null,
}
}

cloudLog.success("Ready")
} else if (!opts.skipCloudConnect) {
cloudLog.warn(
`You are not logged in. To use ${distroName}, log in with the ${styles.command("garden login")} command.`
)
}

const loggedIn = !!cloudApi
: await prepareCloud({
cloudApi,
config,
log,
projectRoot,
projectName,
environmentName,
commandName: opts.commandInfo.name,
})

// If the user is logged in and a cloud project exists we use that ID
// but fallback to the one set in the config (even if the user isn't logged in).
// Same applies for domains.
const projectId = cloudProject?.id || config.id
const cloudDomain = cloudApi?.domain || getGardenCloudDomain(config.domain)

config = resolveProjectConfig({
log,
Expand Down Expand Up @@ -2026,6 +1995,85 @@ export const resolveGardenParams = profileAsync(async function _resolveGardenPar
})
})

/**
* Helper function for getting the cloud project and its secrets.
*
* It's arguably a bit awkward that the function does both but this makes it easier
* to group together the relevant logs.
*/
async function prepareCloud({
cloudApi,
config,
log,
projectRoot,
projectName,
environmentName,
commandName,
}: {
cloudApi: CloudApi | null
config: ProjectConfig
log: Log
projectRoot: string
projectName: string
environmentName: string
commandName: string
}) {
const cloudDomain = cloudApi?.domain || getGardenCloudDomain(config.domain)
const isCommunityEdition = cloudDomain === DEFAULT_GARDEN_CLOUD_DOMAIN
const distroName = getCloudDistributionName(cloudDomain)
const debugLevelCommands = ["dev", "serve", "exit", "quit"]
const cloudLogLevel = debugLevelCommands.includes(commandName) ? LogLevel.debug : undefined
const cloudLog = log.createLog({ name: getCloudLogSectionName(distroName), fixLevel: cloudLogLevel })

let secrets: StringMap = {}
let cloudProject: CloudProject | null = null
// If true, then user is logged in and we fetch the remote project and secrets (if applicable)
if (cloudApi) {
cloudLog.info(`Connecting project...`)

cloudProject = await getCloudProject({
cloudApi,
config,
log: cloudLog,
projectName,
projectRoot,
isCommunityEdition,
})

// Fetch Secrets. Not supported on the community edition.
if (cloudProject && !isCommunityEdition) {
try {
secrets = await wrapActiveSpan(
"getSecrets",
async () =>
await cloudApi.getSecrets({
log: cloudLog,
projectId: cloudProject!.id,
environmentName,
})
)
cloudLog.debug(`Fetched ${Object.keys(secrets).length} secrets from ${cloudApi.domain}`)
} catch (err) {
cloudLog.error(`Fetching secrets failed with error: ${err}`)
}
}

cloudLog.success("Ready")
} else {
const msg = `You are not logged in. To use ${distroName}, log in with the ${styles.command(
"garden login"
)} command.`
if (isCommunityEdition) {
cloudLog.info(msg)
cloudLog.info(`Learn more at: ${styles.underline(`${DOCS_BASE_URL}/using-garden/dashboard`)}`)
} else {
cloudLog.warn(msg)
}
}

return { cloudProject, secrets }
}

/**
* Returns the cloud project for the respective cloud edition (i.e. community or commercial).
*/
Expand Down
28 changes: 27 additions & 1 deletion core/test/unit/src/garden.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ describe("Garden", () => {
expect(garden.cloudDomain).to.eql(DEFAULT_GARDEN_CLOUD_DOMAIN)
expect(garden.projectId).to.eql(undefined)
})
it("should log a warning by default", async () => {
it("should log an informational message about not being logged in for community edition", async () => {
log.root["entries"] = []
const projectName = "test"
const envName = "default"
Expand All @@ -653,6 +653,32 @@ describe("Garden", () => {

const expectedLog = log.root.getLogEntries().filter((l) => resolveMsg(l)?.includes(`You are not logged in`))

expect(expectedLog.length).to.eql(1)
expect(expectedLog[0].level).to.eql(LogLevel.info)
expect(expectedLog[0].msg).to.eql(
`You are not logged in. To use ${distroName}, log in with the ${styles.command("garden login")} command.`
)
})
it("should log a warning message about not being logged in for commercial edition", async () => {
log.root["entries"] = []
const fakeCloudDomain = "https://example.com"
const projectName = "test"
const envName = "default"
const config: ProjectConfig = createProjectConfig({
name: projectName,
path: pathFoo,
domain: fakeCloudDomain,
})

await TestGarden.factory(pathFoo, {
config,
environmentString: envName,
log,
})
const distroName = getCloudDistributionName(fakeCloudDomain)

const expectedLog = log.root.getLogEntries().filter((l) => resolveMsg(l)?.includes(`You are not logged in`))

expect(expectedLog.length).to.eql(1)
expect(expectedLog[0].level).to.eql(LogLevel.warn)
expect(expectedLog[0].msg).to.eql(
Expand Down