Fix Deep* types in metaprogramming. Simplify API libraries (#6728)

* Fix Deep* types in metaprogramming. Simplify API libraries * Changes to clean up diff
firebase · Feb 9, 2024 · f584799 · f584799
1 parent 0d975e3
commit f584799
Show file tree

Hide file tree

Showing 10 changed files with 166 additions and 134 deletions.
diff --git a/src/firebaseConfig.ts b/src/firebaseConfig.ts
@@ -5,9 +5,17 @@
 // 'npm run generate:json-schema' to regenerate the schema files.
 //
 
-import { RequireAtLeastOne } from "./metaprogramming";
 import type { HttpsOptions } from "firebase-functions/v2/https";
 import { IngressSetting, MemoryOption, VpcEgressSetting } from "firebase-functions/v2/options";
+/**
+ * Creates a type that requires at least one key to be present in an interface
+ * type. For example, RequireAtLeastOne<{ foo: string; bar: string }> can hold
+ * a value of { foo: "a" }, { bar: "b" }, or { foo: "a", bar: "b" } but not {}
+ * Sourced from - https://docs.microsoft.com/en-us/javascript/api/@azure/keyvault-certificates/requireatleastone?view=azure-node-latest
+ */
+export type RequireAtLeastOne<T> = {
+  [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
 
 // should be sourced from - https://github.com/firebase/firebase-tools/blob/master/src/deploy/functions/runtimes/index.ts#L15
 type CloudFunctionRuntimes =

diff --git a/src/gcp/apphosting.ts b/src/gcp/apphosting.ts
@@ -5,6 +5,7 @@ import { apphostingOrigin } from "../api";
 import { ensure } from "../ensureApiEnabled";
 import * as deploymentTool from "../deploymentTool";
 import { FirebaseError } from "../error";
+import { DeepOmit, RecursiveKeyOf, assertImplements } from "../metaprogramming";
 
 export const API_HOST = new URL(apphostingOrigin).host;
 export const API_VERSION = "v1alpha";
@@ -44,6 +45,8 @@ export interface Backend {
 
 export type BackendOutputOnlyFields = "name" | "createTime" | "updateTime" | "uri";
 
+assertImplements<BackendOutputOnlyFields, RecursiveKeyOf<Backend>>();
+
 export interface Build {
   name: string;
   state: BuildState;
@@ -81,7 +84,14 @@ export type BuildOutputOnlyFields =
   | "etag"
   | "createTime"
   | "updateTime"
-  | "deleteTime";
+  | "deleteTime"
+  | "source.codebase.displayName"
+  | "source.codebase.hash"
+  | "source.codebase.commitMessage"
+  | "source.codebase.uri"
+  | "source.codebase.commitTime";
+
+assertImplements<BuildOutputOnlyFields, RecursiveKeyOf<Build>>();
 
 export interface BuildConfig {
   minInstances?: number;
@@ -105,19 +115,6 @@ interface CodebaseSource {
   commitTime: string;
 }
 
-export type CodebaseSourceOutputOnlyFields =
-  | "displayName"
-  | "hash"
-  | "commitMessage"
-  | "uri"
-  | "commitTime";
-
-export type BuildInput = Omit<Build, BuildOutputOnlyFields | "source"> & {
-  source: Omit<BuildSource, "codebase"> & {
-    codebase: Omit<CodebaseSource, CodebaseSourceOutputOnlyFields>;
-  };
-};
-
 interface Status {
   code: number;
   message: string;
@@ -165,6 +162,8 @@ export type RolloutOutputOnlyFields =
   | "etag"
   | "reconciling";
 
+assertImplements<RolloutOutputOnlyFields, RecursiveKeyOf<Rollout>>();
+
 export interface ListRolloutsResponse {
   rollouts: Rollout[];
   unreachable: string[];
@@ -192,7 +191,12 @@ export type TrafficOutputOnlyFields =
   | "createTime"
   | "updateTime"
   | "etag"
-  | "uid";
+  | "uid"
+  | "rolloutPolicy.disabledTime"
+  | "rolloutPolicy.stages.startTime"
+  | "rolloutPolicy.stages.endTime";
+
+assertImplements<TrafficOutputOnlyFields, RecursiveKeyOf<Traffic>>();
 
 export interface TrafficSet {
   splits: TrafficSplit[];
@@ -215,16 +219,6 @@ export interface RolloutPolicy {
   disabledTime: string;
 }
 
-export type RolloutPolicyOutputOnlyFields = "disabledTime";
-
-export type RolloutPolicyInput = Omit<RolloutPolicy, RolloutPolicyOutputOnlyFields | "stages"> & {
-  stages: Omit<RolloutStage, "startTime" | "endTime">[];
-};
-
-export type TrafficInput = Omit<Traffic, TrafficOutputOnlyFields | "rolloutPolicy"> & {
-  rolloutPolicy: RolloutPolicyInput;
-};
-
 export type RolloutProgression =
   | "PROGRESSION_UNSPECIFIED"
   | "IMMEDIATE"
@@ -243,8 +237,6 @@ export interface RolloutStage {
   endTime: string;
 }
 
-export type RolloutStageOutputOnlyFields = "startTime" | "endTime";
-
 interface OperationMetadata {
   createTime: string;
   endTime: string;
@@ -275,10 +267,10 @@ export interface ListBackendsResponse {
 export async function createBackend(
   projectId: string,
   location: string,
-  backendReqBoby: Omit<Backend, BackendOutputOnlyFields>,
+  backendReqBoby: DeepOmit<Backend, BackendOutputOnlyFields>,
   backendId: string,
 ): Promise<Operation> {
-  const res = await client.post<Omit<Backend, BackendOutputOnlyFields>, Operation>(
+  const res = await client.post<DeepOmit<Backend, BackendOutputOnlyFields>, Operation>(
     `projects/${projectId}/locations/${location}/backends`,
     {
       ...backendReqBoby,
@@ -382,9 +374,9 @@ export async function createBuild(
   location: string,
   backendId: string,
   buildId: string,
-  buildInput: Omit<BuildInput, "name">,
+  buildInput: DeepOmit<Build, BuildOutputOnlyFields | "name">,
 ): Promise<Operation> {
-  const res = await client.post<Omit<BuildInput, "name">, Operation>(
+  const res = await client.post<DeepOmit<Build, BuildOutputOnlyFields | "name">, Operation>(
     `projects/${projectId}/locations/${location}/backends/${backendId}/builds`,
     {
       ...buildInput,
@@ -406,9 +398,9 @@ export async function createRollout(
   location: string,
   backendId: string,
   rolloutId: string,
-  rollout: Omit<Rollout, RolloutOutputOnlyFields | "name">,
+  rollout: DeepOmit<Rollout, RolloutOutputOnlyFields | "name">,
 ): Promise<Operation> {
-  const res = await client.post<Omit<Rollout, RolloutOutputOnlyFields | "name">, Operation>(
+  const res = await client.post<DeepOmit<Rollout, RolloutOutputOnlyFields | "name">, Operation>(
     `projects/${projectId}/locations/${location}/backends/${backendId}/rollouts`,
     {
       ...rollout,
@@ -456,21 +448,16 @@ export async function updateTraffic(
   projectId: string,
   location: string,
   backendId: string,
-  traffic: Omit<TrafficInput, "name">,
+  traffic: DeepOmit<Traffic, TrafficOutputOnlyFields | "name">,
 ): Promise<Operation> {
   // BUG(b/322891558): setting deep fields on rolloutPolicy doesn't work for some
-  // reason. Create a copy without deep fields to force the updateMask to be
-  // correct.
-  const trafficCopy = { ...traffic };
-  if ("rolloutPolicy" in traffic) {
-    trafficCopy.rolloutPolicy = {} as any;
-  }
-  const fieldMasks = proto.fieldMasks(trafficCopy);
+  // reason. Prevent recursion into that field.
+  const fieldMasks = proto.fieldMasks(traffic, "rolloutPolicy");
   const queryParams = {
     updateMask: fieldMasks.join(","),
   };
   const name = `projects/${projectId}/locations/${location}/backends/${backendId}/traffic`;
-  const res = await client.patch<TrafficInput, Operation>(
+  const res = await client.patch<DeepOmit<Traffic, TrafficOutputOnlyFields>, Operation>(
     name,
     { ...traffic, name },
     {
@@ -510,11 +497,11 @@ export async function listLocations(projectId: string): Promise<Location[]> {
 }
 
 /**
- * Ensure that Frameworks API is enabled on the project.
+ * 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, API_HOST, "frameworks", true);
+  return await ensure(projectId, API_HOST, "app hosting", true);
 }
 
 /**

diff --git a/src/hosting/config.ts b/src/hosting/config.ts
@@ -13,7 +13,6 @@ import {
   HostingSource,
 } from "../firebaseConfig";
 import { partition } from "../functional";
-import { RequireAtLeastOne } from "../metaprogramming";
 import { dirExistsSync } from "../fsutils";
 import { resolveProjectPath } from "../projectPath";
 import { HostingOptions } from "./options";
@@ -117,10 +116,8 @@ export function extract(options: HostingOptions): HostingMultiple {
 
   if (!Array.isArray(config.hosting)) {
     // Upgrade the type because we pinky swear to ensure site exists as a backup.
-    const res = cloneDeep(config.hosting) as unknown as RequireAtLeastOne<{
-      site: string;
-      target: string;
-    }>;
+    const res = cloneDeep(config.hosting) as unknown as HostingMultiple[number];
+
     // earlier the default RTDB instance was used as the hosting site
     // because it used to be created along with the Firebase project.
     // RTDB instance creation is now deferred and decoupled from project creation.

diff --git a/src/hosting/options.ts b/src/hosting/options.ts
@@ -1,5 +1,5 @@
 import { FirebaseConfig } from "../firebaseConfig";
-import { Implements } from "../metaprogramming";
+import { assertImplements } from "../metaprogramming";
 import { Options } from "../options";
 import { HostingResolved } from "./config";
 
@@ -27,5 +27,4 @@ export interface HostingOptions {
 
 // This line caues a compile-time error if HostingOptions has a field that is
 // missing in Options or incompatible with the type in Options.
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-const optionsAreHostingOptions: Implements<Options, HostingOptions> = true;
+assertImplements<Options, HostingOptions>();
diff --git a/src/init/features/apphosting/index.ts b/src/init/features/apphosting/index.ts
@@ -9,7 +9,6 @@ import {
   BackendOutputOnlyFields,
   API_VERSION,
   Build,
-  BuildInput,
   Rollout,
 } from "../../../gcp/apphosting";
 import { Repository } from "../../../gcp/cloudbuild";
@@ -18,6 +17,7 @@ import { promptOnce } from "../../../prompt";
 import { DEFAULT_REGION } from "./constants";
 import { ensure } from "../../../ensureApiEnabled";
 import * as deploymentTool from "../../../deploymentTool";
+import { DeepOmit } from "../../../metaprogramming";
 
 const apphostingPollerOptions: Omit<poller.OperationPollerOptions, "operationResourceName"> = {
   apiOrigin: apphostingOrigin,
@@ -86,7 +86,7 @@ export async function doSetup(setup: any, projectId: string): Promise<void> {
     default: "main",
     message: "Pick a branch for continuous deployment",
   });
-  const traffic: Omit<apphosting.TrafficInput, "name"> = {
+  const traffic: DeepOmit<apphosting.Traffic, apphosting.TrafficOutputOnlyFields | "name"> = {
     rolloutPolicy: {
       codebaseBranch: branch,
       stages: [
@@ -157,7 +157,7 @@ async function promptLocation(projectId: string, locations: string[]): Promise<s
   })) as string;
 }
 
-function toBackend(cloudBuildConnRepo: Repository): Omit<Backend, BackendOutputOnlyFields> {
+function toBackend(cloudBuildConnRepo: Repository): DeepOmit<Backend, BackendOutputOnlyFields> {
   return {
     servingLocality: "GLOBAL_ACCESS",
     codebase: {
@@ -206,7 +206,7 @@ export async function onboardRollout(
   projectId: string,
   location: string,
   backendId: string,
-  buildInput: Omit<BuildInput, "name">,
+  buildInput: DeepOmit<Build, apphosting.BuildOutputOnlyFields | "name">,
 ): Promise<{ rollout: Rollout; build: Build }> {
   logBullet("Starting a new rollout... this may take a few minutes.");
   const buildId = await apphosting.getNextRolloutId(projectId, location, backendId, 1);