@dataformer/env-service 1.1.1 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @dataformer/env-service
 
+## 2.2.0
+
+### Minor Changes
+
+- removed requirement for user email from secret manager name
+
+### Patch Changes
+
+- Updated dependencies
+  - @dataformer/secret-manager-client@2.2.0
+
+## 2.0.0
+
+### Major Changes
+
+- Simplify GCP project ID resolution by removing SECRET_MANAGER_PROJECT_IDBREAKING: Replace SECRET_MANAGER_PROJECT_ID with GCP_PROJECT_ID for unified project approach. Eliminates cross-project complexity and chicken-and-egg problem with project ID resolution.Migration: Update GitHub repository secrets and CI/CD workflows to use GCP_PROJECT_ID
+
+### Patch Changes
+
+- Updated dependencies
+  - @dataformer/secret-manager-client@2.0.0
+
 ## 1.1.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -3,7 +3,7 @@ declare function obfuscateCred(cred: string | null): string;
 declare function getEnvVar(baseSecretKey: string): Promise<string | null>;
 declare function getCustomSearchApiKey(): Promise<string>;
 declare function getSearchEngineId(): Promise<string>;
-declare function getFirestoreProjectId(): Promise<string>;
+declare function getGcpProjectId(): Promise<string>;
 declare function setEnvVar(baseSecretKey: string, value: string): Promise<boolean>;
 declare const setLogToConsole: () => Promise<void>;
 declare const setPostgresUser: () => Promise<void>;
@@ -36,15 +36,14 @@ declare const getPostgresAuthType: () => Promise<string | null>;
 declare const getBigtableInstanceName: () => Promise<string | null>;
 declare const getBigtableTableName: () => Promise<string | null>;
 declare const getBigtableProjectId: () => Promise<string | null>;
+declare const getFirestoreProjectId: () => Promise<string | null>;
 declare const getJiraApiToken: () => Promise<string | null>;
 declare const getJiraApiBaseUrl: () => Promise<string | null>;
 declare const getJiraUserEmail: () => Promise<string | null>;
 declare const getGeminiApiKey: () => Promise<string | null>;
 declare const getNpmToken: () => Promise<string | null>;
 declare const getProjectRoot: () => string;
-declare const getGcpProjectId: () => Promise<string | null>;
-declare const getGcpUserEmail: () => Promise<string | null>;
 declare const printEnv: () => Promise<void>;
 declare const run: () => Promise<void>;
 
-export { askQuestion, getBigtableInstanceName, getBigtableProjectId, getBigtableTableName, getCustomSearchApiKey, getEnvVar, getFirestoreProjectId, getGcpProjectId, getGcpUserEmail, getGeminiApiKey, getJiraApiBaseUrl, getJiraApiToken, getJiraUserEmail, getLogToConsole, getNpmToken, getPostgresAuthType, getPostgresDatabase, getPostgresHostName, getPostgresInstanceConnectionName, getPostgresIpType, getPostgresPassword, getPostgresPoolSizeMax, getPostgresUser, getProjectRoot, getSearchEngineId, obfuscateCred, printEnv, run, setBigtableInstanceName, setBigtableProjectId, setBigtableTableName, setCustomSearchApiKey, setEnvVar, setFirestoreProjectId, setGeminiApiKey, setJiraApiBaseUrl, setJiraApiToken, setJiraUserEmail, setLogToConsole, setNpmToken, setPostgresAuthType, setPostgresDatabase, setPostgresHostName, setPostgresInstanceConnectionName, setPostgresIpType, setPostgresPassword, setPostgresPoolSizeMax, setPostgresUser };
+export { askQuestion, getBigtableInstanceName, getBigtableProjectId, getBigtableTableName, getCustomSearchApiKey, getEnvVar, getFirestoreProjectId, getGcpProjectId, getGeminiApiKey, getJiraApiBaseUrl, getJiraApiToken, getJiraUserEmail, getLogToConsole, getNpmToken, getPostgresAuthType, getPostgresDatabase, getPostgresHostName, getPostgresInstanceConnectionName, getPostgresIpType, getPostgresPassword, getPostgresPoolSizeMax, getPostgresUser, getProjectRoot, getSearchEngineId, obfuscateCred, printEnv, run, setBigtableInstanceName, setBigtableProjectId, setBigtableTableName, setCustomSearchApiKey, setEnvVar, setFirestoreProjectId, setGeminiApiKey, setJiraApiBaseUrl, setJiraApiToken, setJiraUserEmail, setLogToConsole, setNpmToken, setPostgresAuthType, setPostgresDatabase, setPostgresHostName, setPostgresInstanceConnectionName, setPostgresIpType, setPostgresPassword, setPostgresPoolSizeMax, setPostgresUser };

package/dist/index.js

@@ -61,12 +61,26 @@ async function getSearchEngineId() {
   }
   return searchEngineId;
 }
-async function getFirestoreProjectId() {
-  const projectId = await getEnvVar("FIRESTORE_PROJECT_ID");
-  if (!projectId) {
-    throw new Error("FIRESTORE_PROJECT_ID not found in environment variables.");
+async function getGcpProjectId() {
+  const envProjectId = process.env.GCP_PROJECT_ID;
+  if (envProjectId) {
+    return envProjectId;
+  }
+  try {
+    const { execSync } = await import("child_process");
+    const projectId = execSync("gcloud config get-value project", {
+      encoding: "utf8",
+      stdio: ["ignore", "pipe", "ignore"]
+    }).trim();
+    if (!projectId || projectId === "(unset)") {
+      throw new Error("No GCP project configured. Run `gcloud config set project YOUR_PROJECT_ID`");
+    }
+    return projectId;
+  } catch (error) {
+    throw new Error(
+      "GCP_PROJECT_ID not found. Either:\n1. Set GCP_PROJECT_ID environment variable (for deployed environments), or\n2. Configure gcloud: `gcloud config set project YOUR_PROJECT_ID` (for local development)"
+    );
   }
-  return projectId;
 }
 async function setEnvVar(baseSecretKey, value) {
   const sm = await getSecretManager();
@@ -202,6 +216,7 @@ var getBigtableInstanceName = async () => await getEnvVar("BIGTABLE_INSTANCE_NAM
 var getBigtableTableName = async () => await getEnvVar("BIGTABLE_TABLE_NAME");
 var getBigtableProjectId = async () => await getEnvVar("BIGTABLE_PROJECT_ID");
 var _getFirestoreProjectId = async () => await getEnvVar("FIRESTORE_PROJECT_ID");
+var getFirestoreProjectId = _getFirestoreProjectId;
 var getJiraApiToken = async () => await getEnvVar("JIRA_API_TOKEN");
 var getJiraApiBaseUrl = async () => await getEnvVar("JIRA_API_BASE_URL");
 var getJiraUserEmail = async () => await getEnvVar("JIRA_USER_EMAIL");
@@ -211,24 +226,6 @@ var getProjectRoot = () => {
   const currentDir = path.dirname(new URL(import.meta.url).pathname);
   return path.resolve(currentDir, "../..");
 };
-var _getResolvedGcpProjectId = async () => {
-  const sm = await getSecretManager();
-  if (!sm) {
-    console.warn("[EnvService.ts] SecretManager not available for _getResolvedGcpProjectId");
-    return null;
-  }
-  return sm.getResolvedProjectId();
-};
-var _getResolvedGcpUserEmail = async () => {
-  const sm = await getSecretManager();
-  if (!sm) {
-    console.warn("[EnvService.ts] SecretManager not available for _getResolvedGcpUserEmail");
-    return null;
-  }
-  return sm.getResolvedUserEmail();
-};
-var getGcpProjectId = _getResolvedGcpProjectId;
-var getGcpUserEmail = _getResolvedGcpUserEmail;
 var printEnv = async () => {
   const logToConsole = await getLogToConsole();
   const postgresUser = await getPostgresUser();
@@ -249,11 +246,9 @@ var printEnv = async () => {
   const geminiApiKey = await getGeminiApiKey();
   const customSearchApiKey = await getCustomSearchApiKey();
   const gcpProjectIdVal = await getGcpProjectId();
-  const gcpUserEmailVal = await getGcpUserEmail();
   const npmToken = await getNpmToken();
   console.log(`Project Root: ${getProjectRoot()}`);
   console.log(`GCP Project ID: ${gcpProjectIdVal}`);
-  console.log(`GCP User Email (for Secret Manager naming): ${gcpUserEmailVal}`);
   console.log(`Log to Console: ${logToConsole}`);
   console.log(`PostgreSQL User: ${postgresUser}`);
   console.log(`PostgreSQL Password: ${obfuscateCred(postgresPassword)}`);
@@ -358,7 +353,6 @@ export {
   getEnvVar,
   getFirestoreProjectId,
   getGcpProjectId,
-  getGcpUserEmail,
   getGeminiApiKey,
   getJiraApiBaseUrl,
   getJiraApiToken,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dataformer/env-service",
-  "version": "1.1.1",
+  "version": "2.2.0",
   "description": "Environment service for Dataformer",
   "type": "module",
   "main": "dist/index.js",
@@ -11,14 +11,9 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean",
-    "dev": "tsup src/index.ts --format esm --dts --watch",
-    "prepublish": "pnpm run build"
-  },
   "dependencies": {
     "@google-cloud/secret-manager": "^5.4.0",
-    "@dataformer/secret-manager-client": "^1.1.0"
+    "@dataformer/secret-manager-client": "^2.2.0"
   },
   "devDependencies": {
     "tsup": "^8.0.0",
@@ -26,5 +21,10 @@
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsup src/index.ts --format esm --dts --watch",
+    "prepublish": "pnpm run build"
   }
-}
+}

package/src/index.ts

@@ -25,14 +25,13 @@
 //      for your GCP project.
 //
 // PROJECT ID DETECTION:
-// The SecretManagerClient automatically detects the GCP project ID from:
-// 1. SECRET_MANAGER_PROJECT_ID environment variable (for CI/CD deployments)
-// 2. Your local gcloud configuration (for development: `gcloud config get-value project`)
-// 3. Explicit override via createSecretManagerClient({ projectId: "your-project" })
+// The GCP project ID is resolved from:
+// 1. GCP_PROJECT_ID environment variable (for deployed environments - set as GitHub repository secret)
+// 2. Local gcloud configuration (for development: `gcloud config get-value project`)
 //
 // SECRET NAMING CONVENTION:
-// Secrets are named using the format: {projectId}_{userEmail}_{secretId}
-// This ensures user-specific secrets that don't conflict across users or projects.
+// Secrets are named using the format: {projectId}_{secretId}
+// This ensures project-specific secrets that don't conflict across projects.
 
 import readline from 'readline';
 import path from 'path';
@@ -108,12 +107,33 @@ export async function getSearchEngineId(): Promise<string> {
   return searchEngineId;
 }
 
-export async function getFirestoreProjectId(): Promise<string> {
-  const projectId = await getEnvVar('FIRESTORE_PROJECT_ID');
-  if (!projectId) {
-    throw new Error('FIRESTORE_PROJECT_ID not found in environment variables.');
+export async function getGcpProjectId(): Promise<string> {
+  // First try environment variable (for deployed environments)
+  const envProjectId = process.env.GCP_PROJECT_ID;
+  if (envProjectId) {
+    return envProjectId;
+  }
+
+  // Fall back to gcloud config for local development
+  try {
+    const { execSync } = await import('child_process');
+    const projectId = execSync('gcloud config get-value project', { 
+      encoding: 'utf8',
+      stdio: ['ignore', 'pipe', 'ignore']
+    }).trim();
+    
+    if (!projectId || projectId === '(unset)') {
+      throw new Error('No GCP project configured. Run `gcloud config set project YOUR_PROJECT_ID`');
+    }
+    
+    return projectId;
+  } catch (error) {
+    throw new Error(
+      'GCP_PROJECT_ID not found. Either:\n' +
+      '1. Set GCP_PROJECT_ID environment variable (for deployed environments), or\n' +
+      '2. Configure gcloud: `gcloud config set project YOUR_PROJECT_ID` (for local development)'
+    );
   }
-  return projectId;
 }
 
 async function setEnvVar(baseSecretKey: string, value: string): Promise<boolean> {
@@ -274,6 +294,9 @@ const getBigtableInstanceName = async (): Promise<string | null> => await getEnv
 const getBigtableTableName = async (): Promise<string | null> => await getEnvVar('BIGTABLE_TABLE_NAME');
 const getBigtableProjectId = async (): Promise<string | null> => await getEnvVar('BIGTABLE_PROJECT_ID');
 const _getFirestoreProjectId = async (): Promise<string | null> => await getEnvVar('FIRESTORE_PROJECT_ID');
+
+// Export the firestore project ID getter
+export const getFirestoreProjectId = _getFirestoreProjectId;
 const getJiraApiToken = async (): Promise<string | null> => await getEnvVar('JIRA_API_TOKEN');
 const getJiraApiBaseUrl = async (): Promise<string | null> => await getEnvVar('JIRA_API_BASE_URL');
 const getJiraUserEmail = async (): Promise<string | null> => await getEnvVar('JIRA_USER_EMAIL');
@@ -296,18 +319,6 @@ const _getResolvedGcpProjectId = async (): Promise<string | null> => {
   return sm.getResolvedProjectId();
 };
 
-const _getResolvedGcpUserEmail = async (): Promise<string | null> => {
-  const sm = await getSecretManager();
-  if (!sm) {
-    console.warn('[EnvService.ts] SecretManager not available for _getResolvedGcpUserEmail');
-    return null;
-  }
-  return sm.getResolvedUserEmail();
-};
-
-const getGcpProjectId = _getResolvedGcpProjectId;
-const getGcpUserEmail = _getResolvedGcpUserEmail;
-
 const printEnv = async (): Promise<void> => {
   const logToConsole = await getLogToConsole();
   const postgresUser = await getPostgresUser();
@@ -328,12 +339,10 @@ const printEnv = async (): Promise<void> => {
   const geminiApiKey = await getGeminiApiKey();
   const customSearchApiKey = await getCustomSearchApiKey();
   const gcpProjectIdVal = await getGcpProjectId(); 
-  const gcpUserEmailVal = await getGcpUserEmail();
   const npmToken = await getNpmToken();
 
   console.log(`Project Root: ${getProjectRoot()}`);
   console.log(`GCP Project ID: ${gcpProjectIdVal}`);
-  console.log(`GCP User Email (for Secret Manager naming): ${gcpUserEmailVal}`);
   console.log(`Log to Console: ${logToConsole}`);
   console.log(`PostgreSQL User: ${postgresUser}`);
   console.log(`PostgreSQL Password: ${obfuscateCred(postgresPassword)}`);
@@ -440,8 +449,6 @@ export {
 
   // Synchronous Getters / Utility
   getProjectRoot,
-  getGcpProjectId,
-  getGcpUserEmail,
 
   // Generic accessors
   getEnvVar,