-
Notifications
You must be signed in to change notification settings - Fork 0
Added support to fetch credentials based on profile from existing Turbot CLI configuration. #1
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,91 @@ | ||
import dotenv from "dotenv"; | ||
import { readFileSync } from "fs"; | ||
import { parse as parseYaml } from "yaml"; | ||
|
||
// Load environment variables from .env file | ||
dotenv.config(); | ||
|
||
// Validate required environment variables | ||
const requiredEnvVars = [ | ||
const set1 = [ | ||
"TURBOT_GRAPHQL_ENDPOINT", | ||
"TURBOT_ACCESS_KEY_ID", | ||
"TURBOT_SECRET_ACCESS_KEY", | ||
]; | ||
const CLI_CREDENTIALS_DEFAULT_PATH = process.env.HOME ? `${process.env.HOME}/.config/turbot/credentials.yml` : null; | ||
const set2 = [ | ||
// TURBOT_CLI_CREDENTIALS_PATH is optional, will use default if not set | ||
"TURBOT_CLI_PROFILE", | ||
]; | ||
|
||
const hasSet1 = set1.every((envVar) => !!process.env[envVar]); | ||
|
||
// Determine if CLI credentials are valid | ||
let hasSet2 = false; | ||
if (process.env["TURBOT_CLI_PROFILE"]) { | ||
if (CLI_CREDENTIALS_DEFAULT_PATH) { | ||
hasSet2 = true; | ||
} else if (process.env["TURBOT_CLI_CREDENTIALS_PATH"]) { | ||
hasSet2 = true; | ||
} else { | ||
throw new Error( | ||
`❌ TURBOT_CLI_CREDENTIALS_PATH is required because the default credentials path could not be determined (HOME is not set).` | ||
); | ||
} | ||
} | ||
|
||
for (const envVar of requiredEnvVars) { | ||
if (!process.env[envVar]) { | ||
throw new Error(`❌ Missing required environment variable: ${envVar}`); | ||
if (!hasSet1 && !hasSet2) { | ||
// Determine which set is missing and throw a specific error | ||
if (!process.env["TURBOT_CLI_PROFILE"]) { | ||
throw new Error( | ||
`❌ Missing required environment variables for direct credentials: [${set1.join(", ")}].\n` + | ||
`Alternatively, set TURBOT_CLI_PROFILE (and optionally TURBOT_CLI_CREDENTIALS_PATH if the default path is not available).` | ||
); | ||
} else { | ||
throw new Error( | ||
`❌ Missing required environment variables for CLI credentials: TURBOT_CLI_PROFILE (and credentials file/profile must exist).\n` + | ||
`Alternatively, set all of [${set1.join(", ")}].` | ||
); | ||
} | ||
} | ||
|
||
// Export validated environment variables | ||
const config = { | ||
TURBOT_GRAPHQL_ENDPOINT: process.env.TURBOT_GRAPHQL_ENDPOINT!, | ||
TURBOT_ACCESS_KEY_ID: process.env.TURBOT_ACCESS_KEY_ID!, | ||
TURBOT_SECRET_ACCESS_KEY: process.env.TURBOT_SECRET_ACCESS_KEY!, | ||
let config: any = { | ||
Comment on lines
51
to
+52
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid using 'any' for the config variable. Defining a proper type or interface would improve type safety and maintainability. Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. agreed |
||
TURBOT_GRAPHQL_ENDPOINT: process.env.TURBOT_GRAPHQL_ENDPOINT, | ||
TURBOT_ACCESS_KEY_ID: process.env.TURBOT_ACCESS_KEY_ID, | ||
TURBOT_SECRET_ACCESS_KEY: process.env.TURBOT_SECRET_ACCESS_KEY, | ||
}; | ||
|
||
// If using CLI credentials, read and parse the YAML file and extract credentials for the profile | ||
if (hasSet2) { | ||
const credentialsPath = process.env["TURBOT_CLI_CREDENTIALS_PATH"] || CLI_CREDENTIALS_DEFAULT_PATH; | ||
const profile = process.env["TURBOT_CLI_PROFILE"]; | ||
if (!credentialsPath) { | ||
throw new Error("❌ Credentials path is not set and could not determine a default path."); | ||
} | ||
if (!profile) { | ||
throw new Error("❌ TURBOT_CLI_PROFILE is required when using CLI credentials."); | ||
} | ||
try { | ||
const fileContent = readFileSync(credentialsPath, "utf8"); | ||
const yamlData = parseYaml(fileContent); | ||
if (!Object.prototype.hasOwnProperty.call(yamlData, profile)) { | ||
throw new Error(`❌ Profile '${profile}' not found in credentials file: ${credentialsPath}`); | ||
} | ||
const profileCredentials = yamlData[profile]; | ||
// Ensure the endpoint is correctly formed | ||
let endpoint = profileCredentials.workspace; | ||
if (endpoint.endsWith('/')) { | ||
endpoint = endpoint.slice(0, -1); | ||
} | ||
endpoint = `${endpoint}/api/latest/graphql`; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should it always add this to the endpoint? Or should we check for it first? (This might be something to improve across both credential models!) |
||
config = { | ||
TURBOT_GRAPHQL_ENDPOINT: endpoint, | ||
TURBOT_ACCESS_KEY_ID: profileCredentials.accessKey, | ||
TURBOT_SECRET_ACCESS_KEY: profileCredentials.secretKey, | ||
}; | ||
} catch (err: any) { | ||
throw new Error(`❌ Failed to read credentials from ${credentialsPath}: ${err.message}`); | ||
} | ||
} | ||
|
||
export default config; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove the emoji's. They are not really required and smell like an LLM.