@google-cloud/cloud-run-mcp 1.7.0 → 1.8.0

package/lib/cloud-api/run.js

@@ -15,13 +15,14 @@ limitations under the License.
 */
 
 import protofiles from 'google-proto-files';
+import {
+  getRunClient,
+  getServiceUsageClient,
+  getLoggingClient,
+} from '../clients.js';
 import { callWithRetry, ensureApisEnabled } from './helpers.js';
 import { logAndProgress } from '../util/helpers.js';
 
-let runClient;
-let serviceUsageClient;
-let loggingClient;
-
 async function listCloudRunLocations(projectId) {
   const listLocationsRequest = {
     name: `projects/${projectId}`,
@@ -29,6 +30,7 @@ async function listCloudRunLocations(projectId) {
 
   const availableLocations = [];
   try {
+    const runClient = await getRunClient(projectId);
     console.log('Listing Cloud Run supported locations:');
     const iterable = runClient.listLocationsAsync(listLocationsRequest);
     for await (const location of iterable) {
@@ -50,18 +52,9 @@ async function listCloudRunLocations(projectId) {
  * @returns {Promise<object>} - A promise that resolves to an object mapping region to list of service objects in that region.
  */
 export async function listServices(projectId) {
-  if (!runClient) {
-    const { v2 } = await import('@google-cloud/run');
-    const { ServicesClient } = v2;
-    const { ServiceUsageClient } = await import('@google-cloud/service-usage');
-    runClient = new ServicesClient({ projectId });
-    serviceUsageClient = new ServiceUsageClient({ projectId });
-  }
-  const context = {
-    runClient: runClient,
-    serviceUsageClient: serviceUsageClient,
-  };
-  await ensureApisEnabled(context, projectId, ['run.googleapis.com']);
+  const runClient = await getRunClient(projectId);
+
+  await ensureApisEnabled(projectId, ['run.googleapis.com']);
   const locations = await listCloudRunLocations(projectId);
 
   const allServices = {};
@@ -93,11 +86,7 @@ export async function listServices(projectId) {
  * @returns {Promise<object>} - A promise that resolves to the service object.
  */
 export async function getService(projectId, location, serviceId) {
-  if (!runClient) {
-    const { v2 } = await import('@google-cloud/run');
-    const { ServicesClient } = v2;
-    runClient = new ServicesClient({ projectId });
-  }
+  const runClient = await getRunClient(projectId);
 
   const servicePath = runClient.servicePath(projectId, location, serviceId);
 
@@ -138,10 +127,7 @@ export async function getServiceLogs(
   serviceId,
   requestOptions
 ) {
-  if (!loggingClient) {
-    const { Logging } = await import('@google-cloud/logging');
-    loggingClient = new Logging({ projectId });
-  }
+  const loggingClient = await getLoggingClient(projectId);
 
   try {
     const LOG_SEVERITY = 'DEFAULT'; // e.g., 'DEFAULT', 'INFO', 'WARNING', 'ERROR'
@@ -237,21 +223,16 @@ function formatLogEntry(entry) {
  * @throws {Error} If there's an error checking the service (other than not found).
  */
 export async function checkCloudRunServiceExists(
-  context,
   projectId,
   location,
   serviceId,
   progressCallback
 ) {
-  const parent = context.runClient.locationPath(projectId, location);
-  const servicePath = context.runClient.servicePath(
-    projectId,
-    location,
-    serviceId
-  );
+  const runClient = await getRunClient(projectId);
+  const servicePath = runClient.servicePath(projectId, location, serviceId);
   try {
     await callWithRetry(
-      () => context.runClient.getService({ name: servicePath }),
+      () => runClient.getService({ name: servicePath }),
       `getService ${serviceId}`
     );
     await logAndProgress(

package/lib/cloud-api/storage.js

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { getStorageClient } from '../clients.js';
 import { callWithRetry } from './helpers.js';
 import { logAndProgress } from '../util/helpers.js';
 
@@ -22,7 +23,7 @@ import { logAndProgress } from '../util/helpers.js';
  * If the bucket does not exist, it attempts to create it in the specified location.
  *
  * @async
- * @param {object} context - The context object containing clients and other parameters.
+ * @param {string} projectId - The Google Cloud project ID.
  * @param {string} bucketName - The name of the storage bucket.
  * @param {string} [location='us'] - The location to create the bucket in if it doesn't exist. Defaults to 'us'.
  * @param {function(object): void} [progressCallback] - Optional callback for progress updates.
@@ -30,12 +31,13 @@ import { logAndProgress } from '../util/helpers.js';
  * @throws {Error} If there's an error checking or creating the bucket.
  */
 export async function ensureStorageBucketExists(
-  context,
+  projectId,
   bucketName,
   location = 'us',
   progressCallback
 ) {
-  const bucket = context.storage.bucket(bucketName);
+  const storage = await getStorageClient(projectId);
+  const bucket = storage.bucket(bucketName);
   try {
     const [exists] = await callWithRetry(
       () => bucket.exists(),
@@ -54,8 +56,7 @@ export async function ensureStorageBucketExists(
       );
       try {
         const [createdBucket] = await callWithRetry(
-          () =>
-            context.storage.createBucket(bucketName, { location: location }),
+          () => storage.createBucket(bucketName, { location: location }),
           `storage.createBucket ${bucketName}`
         );
         await logAndProgress(
@@ -85,7 +86,6 @@ export async function ensureStorageBucketExists(
  * Uploads a buffer to a specified Google Cloud Storage bucket and blob name.
  *
  * @async
- * @param {object} context - The context object containing clients and other parameters.
  * @param {import('@google-cloud/storage').Bucket} bucket - The Google Cloud Storage bucket object.
  * @param {Buffer} buffer - The buffer containing the data to upload.
  * @param {string} destinationBlobName - The name for the blob in the bucket.
@@ -94,7 +94,6 @@ export async function ensureStorageBucketExists(
  * @throws {Error} If the upload fails.
  */
 export async function uploadToStorageBucket(
-  context,
   bucket,
   buffer,
   destinationBlobName,

package/lib/deployment/deployer.js

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { getRunClient } from '../clients.js';
 import { callWithRetry, ensureApisEnabled } from '../cloud-api/helpers.js';
 import { zipFiles } from '../util/archive.js';
 import {
@@ -58,7 +59,6 @@ import {
  * @throws {Error} If the deployment or update process fails.
  */
 async function deployToCloudRun(
-  context,
   projectId,
   location,
   serviceId,
@@ -69,12 +69,9 @@ async function deployToCloudRun(
   zippedSourceContainer,
   runtime
 ) {
-  const parent = context.runClient.locationPath(projectId, location);
-  const servicePath = context.runClient.servicePath(
-    projectId,
-    location,
-    serviceId
-  );
+  const runClient = await getRunClient(projectId);
+  const parent = runClient.locationPath(projectId, location);
+  const servicePath = runClient.servicePath(projectId, location, serviceId);
   const revisionName = `${serviceId}-${Date.now()}`; // Generate a unique revision name
 
   const containers =
@@ -101,7 +98,6 @@ async function deployToCloudRun(
 
   try {
     const exists = await checkCloudRunServiceExists(
-      context,
       projectId,
       location,
       serviceId,
@@ -121,7 +117,7 @@ async function deployToCloudRun(
         dryRunServiceConfig.name = servicePath;
         await callWithRetry(
           () =>
-            context.runClient.updateService({
+            runClient.updateService({
               service: dryRunServiceConfig,
               validateOnly: true,
             }),
@@ -130,7 +126,7 @@ async function deployToCloudRun(
       } else {
         await callWithRetry(
           () =>
-            context.runClient.createService({
+            runClient.createService({
               parent: parent,
               service: dryRunServiceConfig,
               serviceId: serviceId,
@@ -181,7 +177,7 @@ async function deployToCloudRun(
       );
       service.name = servicePath;
       [operation] = await callWithRetry(
-        () => context.runClient.updateService({ service }),
+        () => runClient.updateService({ service }),
         `updateService ${serviceId}`
       );
     } else {
@@ -191,7 +187,7 @@ async function deployToCloudRun(
       );
       [operation] = await callWithRetry(
         () =>
-          context.runClient.createService({
+          runClient.createService({
             parent: parent,
             service: service, // 'service' object might have invokerIamDisabled removed
             serviceId: serviceId,
@@ -242,7 +238,6 @@ async function deployToCloudRun(
  * @throws {Error} If any part of the deployment process fails.
  */
 async function deployWithZip(
-  context,
   projectId,
   region,
   serviceName,
@@ -278,14 +273,13 @@ async function deployWithZip(
     }
 
     const bucket = await ensureStorageBucketExists(
-      context,
+      projectId,
       bucketName,
       region,
       progressCallback
     );
 
     await uploadToStorageBucket(
-      context,
       bucket,
       archiveBuffer,
       archiveName,
@@ -300,7 +294,6 @@ async function deployWithZip(
     });
 
     const service = await deployToCloudRun(
-      context,
       projectId,
       region,
       serviceName,
@@ -337,7 +330,6 @@ async function deployWithZip(
  * @throws {Error} If any part of the build or deployment process fails.
  */
 async function deployWithBuild(
-  context,
   projectId,
   region,
   serviceName,
@@ -350,7 +342,7 @@ async function deployWithBuild(
   const imageUrl = `${region}-docker.pkg.dev/${projectId}/${DEPLOYMENT_CONFIG.REPO_NAME}/${serviceName}:${DEPLOYMENT_CONFIG.IMAGE_TAG}`;
 
   const bucket = await ensureStorageBucketExists(
-    context,
+    projectId,
     bucketName,
     region,
     progressCallback
@@ -360,7 +352,6 @@ async function deployWithBuild(
   const archiveName = DEPLOYMENT_CONFIG.ZIP_FILE_NAME;
 
   await uploadToStorageBucket(
-    context,
     bucket,
     archiveBuffer,
     archiveName,
@@ -369,7 +360,6 @@ async function deployWithBuild(
   await logAndProgress('Source code uploaded successfully', progressCallback);
 
   await ensureArtifactRegistryRepoExists(
-    context,
     projectId,
     region,
     DEPLOYMENT_CONFIG.REPO_NAME,
@@ -380,7 +370,6 @@ async function deployWithBuild(
   await logAndProgress(`Dockerfile: ${hasDockerfile}`, progressCallback);
 
   const buildResult = await triggerCloudBuild(
-    context,
     projectId,
     region,
     bucketName,
@@ -394,7 +383,6 @@ async function deployWithBuild(
   const builtImageUrl = buildResult.results.images[0].name;
 
   const service = await deployToCloudRun(
-    context,
     projectId,
     region,
     serviceName,
@@ -452,28 +440,8 @@ export async function deploy({
     }
   }
 
-  const { Storage } = await import('@google-cloud/storage');
-  const { CloudBuildClient } = await import('@google-cloud/cloudbuild');
-  const { ArtifactRegistryClient } = await import(
-    '@google-cloud/artifact-registry'
-  );
-  const { v2: CloudRunV2Module } = await import('@google-cloud/run');
-  const { ServicesClient } = CloudRunV2Module;
-  const { ServiceUsageClient } = await import('@google-cloud/service-usage');
-  const { Logging } = await import('@google-cloud/logging');
-
   try {
-    const context = {
-      storage: new Storage({ projectId }),
-      cloudBuildClient: new CloudBuildClient({ projectId }),
-      artifactRegistryClient: new ArtifactRegistryClient({ projectId }),
-      runClient: new ServicesClient({ projectId }),
-      serviceUsageClient: new ServiceUsageClient({ projectId }),
-      loggingClient: new Logging({ projectId }),
-    };
-
     await ensureApisEnabled(
-      context,
       projectId,
       REQUIRED_APIS.SOURCE_DEPLOY,
       progressCallback
@@ -495,7 +463,6 @@ export async function deploy({
     if (canDeployWithoutBuild({ hasDockerfile, deploymentAttrs })) {
       try {
         return await deployWithZip(
-          context,
           projectId,
           region,
           serviceName,
@@ -515,7 +482,6 @@ export async function deploy({
     }
 
     return await deployWithBuild(
-      context,
       projectId,
       region,
       serviceName,
@@ -577,18 +543,8 @@ export async function deployImage({
     }
   }
 
-  const { v2: CloudRunV2Module } = await import('@google-cloud/run');
-  const { ServicesClient } = CloudRunV2Module;
-  const { ServiceUsageClient } = await import('@google-cloud/service-usage');
-
   try {
-    const context = {
-      runClient: new ServicesClient({ projectId }),
-      serviceUsageClient: new ServiceUsageClient({ projectId }),
-    };
-
     await ensureApisEnabled(
-      context,
       projectId,
       REQUIRED_APIS.IMAGE_DEPLOY,
       progressCallback
@@ -600,7 +556,6 @@ export async function deployImage({
     await logAndProgress(`Image URL: ${imageUrl}`, progressCallback);
 
     const service = await deployToCloudRun(
-      context,
       projectId,
       region,
       serviceName,

package/lib/deployment/helpers.js

@@ -170,7 +170,7 @@ export function canDeployWithoutBuild({ hasDockerfile, deploymentAttrs }) {
  * Creates the container spec for a direct source deployment (no Cloud Build).
  * @param {object} params - The parameters for creating the container spec.
  * @param {string} params.bucketName - The GCS bucket name where the source is uploaded.
- * @param {string} params.fileName - The GCS object name (e.g., source.tar.gz).
+ * @param {string} params.fileName - The GCS object name (eg., source.tar.gz).
  * @param {{cmd: string[], args: string[], baseImage: string}} params.deploymentAttrs - Deployment attributes including command, args, and the base image to use.
  * @returns {object} The container specification object for the Cloud Run service.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/cloud-run-mcp",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "type": "module",
   "description": "Cloud Run MCP deployment tool",
   "main": "mcp-server.js",
@@ -58,6 +58,6 @@
   "devDependencies": {
     "c8": "^10.1.3",
     "esmock": "^2.7.1",
-    "prettier": "3.6.2"
+    "prettier": "^3.8.0"
   }
 }

package/test/local/clients.test.js

@@ -0,0 +1,146 @@
+import { test, describe } from 'node:test';
+import assert from 'node:assert';
+import { getClient } from '../../lib/clients.js';
+
+describe('getClient Helper', () => {
+  class MockClient {
+    constructor(options) {
+      this.options = options;
+    }
+  }
+
+  test('creates new client instance with authClient when access token provided', async () => {
+    const projectId = 'test-project-1';
+    const accessToken = 'fake-token-1';
+    const service = 'run'; // Must match keys in lib/clients.js clients object
+    const key = projectId + accessToken;
+
+    const client = await getClient(
+      service,
+      key,
+      async () => MockClient,
+      { projectId },
+      accessToken
+    );
+
+    assert.ok(client instanceof MockClient);
+    assert.strictEqual(client.options.projectId, projectId);
+    assert.ok(client.options.authClient);
+
+    const headers = client.options.authClient.getRequestHeaders();
+    assert.strictEqual(headers.get('Authorization'), 'Bearer fake-token-1');
+  });
+
+  test('creates new client instance WITHOUT authClient when NO access token provided', async () => {
+    const projectId = 'test-project-2';
+    const service = 'run';
+    const key = projectId;
+
+    const client = await getClient(
+      service,
+      key,
+      async () => MockClient,
+      { projectId },
+      null
+    );
+
+    assert.ok(client instanceof MockClient);
+    assert.strictEqual(client.options.projectId, projectId);
+    assert.strictEqual(client.options.authClient, undefined);
+  });
+
+  test('caches client instances by key', async () => {
+    const projectId = 'test-project-3';
+    const accessToken = 'token-A';
+    const service = 'run';
+    const key = projectId + accessToken;
+
+    const client1 = await getClient(
+      service,
+      key,
+      async () => MockClient,
+      { projectId },
+      accessToken
+    );
+
+    const client2 = await getClient(
+      service,
+      key,
+      async () => MockClient,
+      { projectId },
+      accessToken
+    );
+
+    assert.strictEqual(client1, client2);
+  });
+
+  test('creates DIFFERENT client instances for different keys', async () => {
+    const projectId = 'test-project-4';
+    const service = 'run';
+
+    const client1 = await getClient(
+      service,
+      projectId + 'token-A',
+      async () => MockClient,
+      { projectId },
+      'token-A'
+    );
+
+    const client2 = await getClient(
+      service,
+      projectId + 'token-B',
+      async () => MockClient,
+      { projectId },
+      'token-B'
+    );
+
+    assert.notStrictEqual(client1, client2);
+
+    const h1 = client1.options.authClient.getRequestHeaders();
+    assert.strictEqual(h1.get('Authorization'), 'Bearer token-A');
+
+    const h2 = client2.options.authClient.getRequestHeaders();
+    assert.strictEqual(h2.get('Authorization'), 'Bearer token-B');
+  });
+
+  test('supports different services', async () => {
+    const projectId = 'test-project-5';
+    const accessToken = 'token-C';
+
+    const runClient = await getClient(
+      'run',
+      projectId + accessToken,
+      async () => MockClient,
+      { projectId },
+      accessToken
+    );
+
+    const storageClient = await getClient(
+      'storage',
+      projectId + accessToken,
+      async () => MockClient,
+      { projectId },
+      accessToken
+    );
+
+    assert.notStrictEqual(runClient, storageClient); // Different maps
+    assert.ok(runClient.options.authClient);
+    assert.ok(storageClient.options.authClient);
+  });
+
+  test('passes additional options correctly', async () => {
+    const projectId = 'test-project-6';
+    const service = 'run';
+    const extraOpt = 'foo';
+
+    const client = await getClient(
+      service,
+      projectId,
+      async () => MockClient,
+      { projectId, extraOpt },
+      null
+    );
+
+    assert.strictEqual(client.options.extraOpt, extraOpt);
+  });
+});