Add GCP API client functions to support App Hosting deploy from source feature

CHANGELOG.md

@@ -1,2 +1,3 @@
 - Changed artifact registry cleanup policy error to warn for CI/CD workloads #8513
 - Enhance firebase init apphosting to support local source deploys. (#8479)
+- Add GCP API client functions to support App Hosting deploy from source feature. (#8545)

src/gcp/apphosting.ts

@@ -100,7 +100,8 @@
 }
 
 interface BuildSource {
-  codebase: CodebaseSource;
+  codebase?: CodebaseSource;
+  archive?: ArchiveSource;
 }
 
 interface CodebaseSource {
@@ -116,6 +117,21 @@
   commitTime: string;
 }
 
+interface ArchiveSource {
+  // oneof reference
+  userStorageUri?: string;
+  externalSignedUri?: string;
+  // end oneof reference
+  rootDirectory?: string;
+  author?: SourceUserMetadata;
+}
+
+interface SourceUserMetadata {
+  displayName: string;
+  email: string;
+  imageUri: string;
+}
+
 interface Status {
   code: number;
   message: string;
@@ -250,7 +266,7 @@
   done: boolean;
   // oneof result
   error?: Status;
   response?: any;
   // end oneof result
 }
 
@@ -532,14 +548,14 @@
 /**
  * Ensure that the App Hosting API is enabled on the project.
  */
 export async function ensureApiEnabled(options: any): Promise<void> {
   const projectId = needProjectId(options);
   return await ensure(projectId, apphostingOrigin(), "app hosting", true);
 }
 
 /**
  * Generates the next build ID to fit with the naming scheme of the backend API.
  * @param counter Overrides the counter to use, avoiding an API call.
  */
 export async function getNextRolloutId(
   projectId: string,

src/gcp/devConnect.ts

@@ -27,7 +27,7 @@
   metadata?: OperationMetadata;
   done: boolean;
   error?: { code: number; message: string; details: unknown };
   response?: any;
 }
 
 export interface OAuthCredential {
@@ -304,6 +304,19 @@
   return res.body.installations;
 }
 
+/**
+ * Splits a Git Repository Link resource name into its parts.
+ */
+export function parseGitRepositoryLinkName(gitRepositoryLinkName: string): {
+  projectName: string;
+  location: string;
+  connectionName: string;
+  id: string;
+} {
+  const [, projectName, , location, , connectionName, , id] = gitRepositoryLinkName.split("/");
+  return { projectName, location, connectionName, id };
+}
+
 /**
  * Creates a GitRepositoryLink. Upon linking a Git Repository, Developer
  * Connect will configure the Git Repository to send webhook events to
@@ -358,9 +371,9 @@
 /**
  * sorts the given list of connections by create_time from earliest to latest
  */
 export function sortConnectionsByCreateTime(connections: Connection[]) {
   return connections.sort((a, b) => {
     return Date.parse(a.createTime!) - Date.parse(b.createTime!);
   });
 }
 
@@ -395,8 +408,8 @@
   connection: string | null;
   gitRepoLink: string | null;
 } {
   const connectionMatch = /connections\/([^\/]+)/.exec(path);
   const repositoryMatch = /gitRepositoryLinks\/([^\/]+)/.exec(path);
 
   const connection = connectionMatch ? connectionMatch[1] : null;
   const gitRepoLink = repositoryMatch ? repositoryMatch[1] : null;

src/gcp/storage.ts

@@ -142,6 +142,28 @@ interface GetDefaultBucketResponse {
   };
 }
 
+interface CreateBucketRequest {
+  name: string;
+  location: string;
+  lifecycle: {
+    rule: LifecycleRule[];
+  };
+}
+
+interface LifecycleRule {
+  action: {
+    type: string;
+  };
+  condition: {
+    age: number;
+  };
+}
+
+interface UploadObjectResponse {
+  selfLink: string;
+  mediaLink: string;
+}
+
 /** Response type for obtaining the storage service agent */
 interface StorageServiceAccountResponse {
   email_address: string;
@@ -230,7 +252,11 @@ export async function uploadObject(
   source: { file: string; stream: Readable },
   /** Bucket to upload to. */
   bucketName: string,
-): Promise<{ bucket: string; object: string; generation: string | null }> {
+): Promise<{
+  bucket: string;
+  object: string;
+  generation: string | null;
+}> {
   if (path.extname(source.file) !== ".zip") {
     throw new FirebaseError(`Expected a file name ending in .zip, got ${source.file}`);
   }
@@ -252,6 +278,20 @@ export async function uploadObject(
   };
 }
 
+/**
+ * Get a storage object from GCP.
+ * @param {string} bucketName name of the storage bucket that contains the object
+ * @param {string} objectName name of the object
+ */
+export async function getObject(
+  bucketName: string,
+  objectName: string,
+): Promise<UploadObjectResponse> {
+  const client = new Client({ urlPrefix: storageOrigin() });
+  const res = await client.get<UploadObjectResponse>(`/storage/v1/b/${bucketName}/o/${objectName}`);
+  return res.body;
+}
+
 /**
  * Deletes an object via Firebase Storage.
  * @param {string} location A Firebase Storage location, of the form "/v0/b/<bucket>/o/<object>"
@@ -280,6 +320,36 @@ export async function getBucket(bucketName: string): Promise<BucketResponse> {
   }
 }
 
+/**
+ * Creates a storage bucket on GCP.
+ * Ref: https://cloud.google.com/storage/docs/json_api/v1/buckets/insert
+ * @param {string} bucketName name of the storage bucket
+ * @return a bucket resource object
+ */
+export async function createBucket(
+  projectId: string,
+  req: CreateBucketRequest,
+): Promise<BucketResponse> {
+  try {
+    const localAPIClient = new Client({ urlPrefix: storageOrigin() });
+    const result = await localAPIClient.post<CreateBucketRequest, BucketResponse>(
+      `/storage/v1/b`,
+      req,
+      {
+        queryParams: {
+          project: projectId,
+        },
+      },
+    );
+    return result.body;
+  } catch (err: any) {
+    logger.debug(err);
+    throw new FirebaseError("Failed to create the storage bucket", {
+      original: err,
+    });
+  }
+}
+
 /**
  * Gets the list of storage buckets associated with a specific project from GCP.
  * Ref: https://cloud.google.com/storage/docs/json_api/v1/buckets/list