rds_ssm_connect 1.3.0 → 1.3.4

package/.github/workflows/npm-publish.yml

@@ -9,11 +9,9 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
+          node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci
-      - name: Run lint
-        run: npm run lint
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -106,136 +106,3 @@ These modules will be automatically installed when you install the application w
 4. **Output**:
 
    The application displays the connection string and password for the RDS database along with a command to start a port forwarding session to the RDS cluster, allowing secure access from the local machine.
-
-### Code File
-
-Here is the `connect.js` file used in the application:
-
-```javascript
-#!/usr/bin/env node
-
-import { EC2Client, DescribeInstancesCommand } from "@aws-sdk/client-ec2";
-import { RDSClient, DescribeDBClustersCommand } from "@aws-sdk/client-rds";
-import { SecretsManagerClient, GetSecretValueCommand, ListSecretsCommand } from "@aws-sdk/client-secrets-manager";
-import inquirer from 'inquirer';
-import fs from 'fs';
-import os from 'os';
-import path from 'path';
-import { envPortMapping, REGION, TABLE_NAME } from './envPortMapping.js';
-
-// Load AWS config
-const awsConfigPath = path.join(os.homedir(), '.aws', 'config');
-const awsConfig = fs.readFileSync(awsConfigPath, 'utf-8');
-const ENVS = awsConfig
-  .split('\n')
-  .filter(line => line.startsWith('[') && line.endsWith(']'))
-  .map(line => line.slice(1, -1))
-  .map(line => line.replace('profile ', ''));
-
-// Initialize AWS SDK clients
-const ec2Client = new EC2Client({ region: REGION });
-const rdsClient = new RDSClient({ region: REGION });
-const secretsManagerClient = new SecretsManagerClient({ region: REGION });
-
-// Function to list secrets
-async function listSecrets() {
-  const command = new ListSecretsCommand({
-    Filters: [{ Key: 'name', Values: ['rds!cluster'] }]
-  });
-  const response = await secretsManagerClient.send(command);
-  return response.SecretList.map(secret => secret.Name);
-}
-
-// Function to get secret value
-async function getSecretValue(secretName) {
-  const command = new GetSecretValueCommand({ SecretId: secretName });
-  const response = await secretsManagerClient.send(command);
-  return JSON.parse(response.SecretString);
-}
-
-// Function to get instance ID
-async function getInstanceId() {
-  const command = new DescribeInstancesCommand({
-    Filters: [
-      { Name: 'tag:Name', Values: ['*bastion*'] },
-      { Name: 'instance-state-name', Values: ['running'] }
-    ]
-  });
-  const response = await ec2Client.send(command);
-  const instances = response.Reservations.flatMap(reservation => reservation.Instances.map(instance => instance.InstanceId));
-  return instances[0];
-}
-
-// Function to get RDS endpoint
-async function getRdsEndpoint() {
-  const command = new DescribeDBClustersCommand({
-    Filters: [{ Name: 'Status', Values: ['available'] }]
-  });
-  const response = await rdsClient.send(command);
-  const clusters = response.DBClusters.filter(cluster => cluster.DBClusterIdentifier.endsWith('-rds-aurora'));
-  return clusters[0].Endpoint;
-}
-
-async function main() {
-  const answers = await inquirer.prompt([
-    {
-      type: 'list',
-      name: 'ENV',
-      message: 'Please select the environment:',
-      choices: ENVS
-    }
-  ]);
-
-  const ENV = answers.ENV;
-  console.log(`You selected: ${ENV}`);
-
-  // Sort all environment suffixes by length, longest first
-  const allEnvSuffixes = Object.keys(envPortMapping).sort((a, b) => b.length - a.length);
-  const matchedSuffix = allEnvSuffixes.find(suffix => ENV.endsWith(suffix));
-  let portNumber = envPortMapping[matchedSuffix] || '5432';
-
-  if (portNumber === '5432') {
-    console.error(`No port number found for environment: ${ENV}. Defaulting to 5432.`);
-  }
-
-  // List secrets and get the first matching secret name
-  const secretNames = await listSecrets();
-  const SECRET_NAME = secretNames.find(name => name.startsWith('rds!cluster'));
-  if (!SECRET_NAME) {
-    console.error('No secret found with name starting with rds!cluster.');
-    return;
-  }
-
-  // Get secret value
-  const CREDENTIALS = await getSecretValue(SECRET_NAME);
-  const USERNAME = CREDENTIALS.username;
-  const PASSWORD = CREDENTIALS.password;
-
-  console.log(`Your connection string is: psql -h localhost -p ${portNumber} -U ${USERNAME} -d ${TABLE_NAME}`);
-  console.log(`Use the password: ${PASSWORD}`);
-
-  // Get instance ID
-  const INSTANCE_ID = await getInstanceId();
-  if (!INSTANCE_ID) {
-    console.error('Failed to find a running instance with tag Name=*bastion*.');
-    return;
-  }
-
-  // Get RDS endpoint
-  const RDS_ENDPOINT = await getRdsEndpoint();
-  if (!RDS_ENDPOINT) {
-    console.error('Failed to find the RDS endpoint.');
-    return;
-  }
-
-  // Start a port forwarding session (this requires AWS CLI tool as the SDK doesn't support starting sessions)
-  const portForwardingCommand = `aws ssm start-session --target ${INSTANCE_ID} --document-name AWS-StartPortForwardingSessionToRemoteHost --parameters "host=${RDS_ENDPOINT},portNumber='5432',localPortNumber='${portNumber}'" --cli-connect-timeout 0`;
-  console.log(`Run this command to start port forwarding: ${portForwardingCommand}`);
-}
-
-main().catch(err => {
-  console.error(err);
-});
-```
-
-This documentation provides detailed instructions on installation, usage, prerequisites, and how the system works, making it easy for users to understand and use your application effectively.

package/connect.js

@@ -73,9 +73,12 @@ async function main () {
     const USERNAME = CREDENTIALS.username
     const PASSWORD = CREDENTIALS.password
 
-    console.log(`Your connection string is: psql -h localhost -p ${portNumber} -U ${USERNAME} -d ${TABLE_NAME}`)
-    console.log(`Use the password: ${PASSWORD}`)
-
+    console.log(`Your connection details:
+      Host: localhost
+      Port: ${portNumber}
+      User: ${USERNAME}
+      Database: ${TABLE_NAME}
+      Password: ${PASSWORD}`)
     const instanceIdCommand = `aws-vault exec ${ENV} -- aws ec2 describe-instances --region ${REGION} --filters "Name=tag:Name,Values='*bastion*'" "Name=instance-state-name,Values=running" --query "Reservations[].Instances[].[InstanceId] | [0][0]" --output text`
     const INSTANCE_ID = await runCommand(instanceIdCommand)
 
@@ -109,7 +112,7 @@ async function main () {
       console.log(`Port forwarding session ended with code ${code}`)
     })
 
-    console.log('Port forwarding session established. You can now connect to the database using the provided connection string.')
+    console.log('Port forwarding session established. You can now connect to the database using the provided connection details.')
     console.log('Press Ctrl+C to end the session.')
   } catch (error) {
     console.error(`Error: ${error.message}`)
@@ -123,4 +126,4 @@ main().catch(error => {
   setImmediate(() => {
     throw new Error('Forcing exit due to unhandled error')
   })
-})
+})

package/package.json

@@ -1,28 +1,16 @@
 {
   "name": "rds_ssm_connect",
-  "version": "1.3.0",
+  "version": "1.3.4",
   "type": "module",
   "dependencies": {
-    "@aws-sdk/client-ec2": "^3.632.0",
-    "@aws-sdk/client-rds": "^3.632.0",
-    "@aws-sdk/client-ssm": "^3.632.0",
+    "@aws-sdk/client-ec2": "^3.674.0",
+    "@aws-sdk/client-rds": "^3.674.0",
+    "@aws-sdk/client-ssm": "^3.674.0",
     "glob": "^11.0.0",
-    "inquirer": "^8.2.6",
-    "process": "^0.11.10",
+    "inquirer": "^12.0.0",
     "rimraf": "^6.0.1"
   },
   "bin": {
     "rds_ssm_connect": "./connect.js"
-  },
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "devDependencies": {
-    "eslint": "^8.57.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-promise": "^6.1.1"
   }
 }