updates runv2.ts with listServices function and trigger updates (#9482)

* updates runv2.ts with listServices function and trigger updates

Author: brittanycho

CHANGELOG.md

@@ -0,0 +1 @@
+- Adds listServices and also defines trigger within runv2.ts [#9482]

src/gcp/runv2.spec.ts

@@ -1,9 +1,12 @@
 import { expect } from "chai";
+import * as sinon from "sinon";
 
 import * as runv2 from "./runv2";
 import * as backend from "../deploy/functions/backend";
 import { latest } from "../deploy/functions/runtimes/supported";
 import { CODEBASE_LABEL } from "../functions/constants";
+import { Client } from "../apiv2";
+import { FirebaseError } from "../error";
 
 describe("runv2", () => {
   const PROJECT_ID = "project-id";
@@ -201,13 +204,11 @@ describe("runv2", () => {
       const service: Omit<runv2.Service, runv2.ServiceOutputFields> = {
         ...BASE_RUN_SERVICE,
         name: `projects/${PROJECT_ID}/locations/${LOCATION}/services/${SERVICE_ID}`,
-        labels: {
-          [runv2.RUNTIME_LABEL]: latest("nodejs"),
-        },
         annotations: {
           ...BASE_RUN_SERVICE.annotations,
           [runv2.FUNCTION_ID_ANNOTATION]: FUNCTION_ID, // Using FUNCTION_ID_ANNOTATION as primary source for id
           [runv2.FUNCTION_TARGET_ANNOTATION]: "customEntryPoint",
+          [runv2.TRIGGER_TYPE_ANNOTATION]: "HTTP_TRIGGER",
         },
         template: {
           containers: [
@@ -239,6 +240,7 @@ describe("runv2", () => {
         httpsTrigger: {},
         labels: {
           [runv2.RUNTIME_LABEL]: latest("nodejs"),
+          [runv2.CLIENT_NAME_LABEL]: "firebase-functions",
         },
         environmentVariables: {},
         secretEnvironmentVariables: [],
@@ -259,6 +261,7 @@ describe("runv2", () => {
           ...BASE_RUN_SERVICE.annotations,
           [runv2.FUNCTION_ID_ANNOTATION]: FUNCTION_ID, // Using FUNCTION_ID_ANNOTATION as primary source for id
           [runv2.FUNCTION_TARGET_ANNOTATION]: "customEntryPoint",
+          [runv2.TRIGGER_TYPE_ANNOTATION]: "HTTP_TRIGGER",
         },
         template: {
           containers: [
@@ -442,7 +445,7 @@ describe("runv2", () => {
         entryPoint: SERVICE_ID, // No FUNCTION_TARGET_ANNOTATION
         availableMemoryMb: 128,
         cpu: 0.5,
-        httpsTrigger: {},
+        eventTrigger: { eventType: "unknown", retry: false },
         labels: {},
         environmentVariables: {},
         secretEnvironmentVariables: [],
@@ -452,4 +455,114 @@ describe("runv2", () => {
       expect(runv2.endpointFromService(service)).to.deep.equal(expectedEndpoint);
     });
   });
+
+  describe("listServices", () => {
+    let sandbox: sinon.SinonSandbox;
+    let getStub: sinon.SinonStub;
+
+    beforeEach(() => {
+      sandbox = sinon.createSandbox();
+      getStub = sandbox.stub(Client.prototype, "get");
+    });
+
+    afterEach(() => {
+      sandbox.restore();
+    });
+
+    it("should return a list of services", async () => {
+      const mockServices = [
+        {
+          name: "service1",
+          labels: { "goog-managed-by": "cloud-functions" },
+        },
+        {
+          name: "service2",
+          labels: { "goog-managed-by": "firebase-functions" },
+        },
+      ];
+      getStub.resolves({ status: 200, body: { services: mockServices } });
+
+      const services = await runv2.listServices(PROJECT_ID);
+
+      expect(services).to.deep.equal(mockServices);
+      expect(getStub).to.have.been.calledOnceWithExactly(
+        `/projects/${PROJECT_ID}/locations/-/services`,
+        { queryParams: {} },
+      );
+    });
+
+    it("should handle pagination", async () => {
+      const mockServices1 = [
+        {
+          name: "service1",
+          labels: { "goog-managed-by": "cloud-functions" },
+        },
+      ];
+      const mockServices2 = [
+        {
+          name: "service2",
+          labels: { "goog-managed-by": "firebase-functions" },
+        },
+      ];
+      getStub
+        .onFirstCall()
+        .resolves({ status: 200, body: { services: mockServices1, nextPageToken: "nextPage" } });
+      getStub.onSecondCall().resolves({ status: 200, body: { services: mockServices2 } });
+
+      const services = await runv2.listServices(PROJECT_ID);
+
+      expect(services).to.deep.equal([...mockServices1, ...mockServices2]);
+      expect(getStub).to.have.been.calledTwice;
+      expect(getStub.firstCall).to.have.been.calledWithExactly(
+        `/projects/${PROJECT_ID}/locations/-/services`,
+        { queryParams: {} },
+      );
+      expect(getStub.secondCall).to.have.been.calledWithExactly(
+        `/projects/${PROJECT_ID}/locations/-/services`,
+        { queryParams: { pageToken: "nextPage" } },
+      );
+    });
+
+    it("should throw an error if the API call fails", async () => {
+      getStub.resolves({ status: 500, body: "Internal Server Error" });
+
+      try {
+        await runv2.listServices(PROJECT_ID);
+        expect.fail("Should have thrown an error");
+      } catch (err: any) {
+        expect(err).to.be.instanceOf(FirebaseError);
+        expect(err.message).to.contain("Failed to list services. HTTP Error: 500");
+      }
+    });
+
+    it("should filter for gcfv2 and firebase-managed services", async () => {
+      const mockServices = [
+        {
+          name: "service1",
+          labels: { "goog-managed-by": "cloud-functions" },
+        },
+        {
+          name: "service2",
+          labels: { "goog-managed-by": "firebase-functions" },
+        },
+        {
+          name: "service3",
+          labels: { "goog-managed-by": "other" },
+        },
+        {
+          name: "service4",
+          labels: {},
+        },
+      ];
+      getStub.resolves({ status: 200, body: { services: mockServices } });
+
+      const services = await runv2.listServices(PROJECT_ID);
+
+      expect(services).to.deep.equal([mockServices[0], mockServices[1]]);
+      expect(getStub).to.have.been.calledOnceWithExactly(
+        `/projects/${PROJECT_ID}/locations/-/services`,
+        { queryParams: {} },
+      );
+    });
+  });
 });

src/gcp/runv2.ts

@@ -200,6 +200,49 @@ export async function updateService(service: Omit<Service, ServiceOutputFields>)
   return svc;
 }
 
+/**
+ * Lists Cloud Run services in the given project.
+ *
+ * This method only returns services with the "goog-managed-by" label set to
+ * "cloud-functions" or "firebase-functions".
+ */
+export async function listServices(projectId: string): Promise<Service[]> {
+  const allServices: Service[] = [];
+  let pageToken: string | undefined = undefined;
+
+  do {
+    const queryParams: Record<string, string> = {};
+    if (pageToken) {
+      queryParams["pageToken"] = pageToken;
+    }
+
+    const res = await client.get<{ services?: Service[]; nextPageToken?: string }>(
+      `/projects/${projectId}/locations/-/services`,
+      { queryParams },
+    );
+
+    if (res.status !== 200) {
+      throw new FirebaseError(`Failed to list services. HTTP Error: ${res.status}`, {
+        original: res.body as any,
+      });
+    }
+
+    if (res.body.services) {
+      for (const service of res.body.services) {
+        if (
+          service.labels?.[CLIENT_NAME_LABEL] === "cloud-functions" ||
+          service.labels?.[CLIENT_NAME_LABEL] === "firebase-functions"
+        ) {
+          allServices.push(service);
+        }
+      }
+    }
+    pageToken = res.body.nextPageToken;
+  } while (pageToken);
+
+  return allServices;
+}
+
 // TODO: Replace with real version:
 function functionNameToServiceName(id: string): string {
   return id.toLowerCase().replace(/_/g, "-");
@@ -487,9 +530,16 @@ export function endpointFromService(service: Omit<Service, ServiceOutputFields>)
       service.annotations?.[FUNCTION_TARGET_ANNOTATION] ||
       service.annotations?.[FUNCTION_ID_ANNOTATION] ||
       id,
-
-    // TODO: trigger types.
-    httpsTrigger: {},
+    // TODO: Figure out how to encode all trigger types to the underlying Run service that is compatible with both V2 functions and "direct to run" functions
+    ...(service.annotations?.[TRIGGER_TYPE_ANNOTATION] === "HTTP_TRIGGER"
+      ? { httpsTrigger: {} }
+      : {
+          eventTrigger: {
+            eventType: service.annotations?.[TRIGGER_TYPE_ANNOTATION] || "unknown",
+            // TODO: Figure out how to recover the retry info from Run (vs Functions API) as we currently default to false.
+            retry: false,
+          },
+        }),
   };
   proto.renameIfPresent(endpoint, service.template, "concurrency", "containerConcurrency");
   proto.renameIfPresent(endpoint, service.labels || {}, "codebase", CODEBASE_LABEL);