Use exactOptionalPropertyTypes to typecheck, but not to build yet (#40973)

Change a lot of optional types to be unions with undefined so that the convex npm package typeschecks with this setting. Going to try setting the option separately because it causes changes to generated code that might be disruptive.

GitOrigin-RevId: 5735af09c704cf36a24c2dd714133aa3f5e58aff

Author: thomasballinger

src/browser/http_client.ts

@@ -60,8 +60,8 @@ export type HttpMutationOptions = {
  */
 export class ConvexHttpClient {
   private readonly address: string;
-  private auth?: string;
-  private adminAuth?: string;
+  private auth: string | undefined;
+  private adminAuth: string | undefined;
   private encodedTsPromise?: Promise<string>;
   private debug: boolean;
   private fetchOptions?: FetchOptions;
@@ -117,6 +117,8 @@ export class ConvexHttpClient {
           : instantiateDefaultLogger({ verbose: false });
     this.address = address;
     this.debug = true;
+    this.auth = undefined;
+    this.adminAuth = undefined;
     if (options?.auth) {
       this.setAuth(options.auth);
     }

src/browser/sync/client.ts

@@ -182,7 +182,7 @@ export interface SubscribeOptions {
   /**
    * @internal
    */
-  componentPath?: string;
+  componentPath?: string | undefined;
 }
 
 /**
@@ -197,7 +197,7 @@ export interface MutationOptions {
    * An optimistic update locally updates queries while a mutation is pending.
    * Once the mutation completes, the update will be rolled back.
    */
-  optimisticUpdate?: OptimisticUpdate<any>;
+  optimisticUpdate?: OptimisticUpdate<any> | undefined;
 }
 
 /**
@@ -379,7 +379,10 @@ export class BaseConvexClient {
           // browsers but we tried.
           const confirmationMessage =
             "Are you sure you want to leave? Your changes may not be saved.";
-          (e || window.event).returnValue = confirmationMessage;
+          // Recommended method for legacy (IE) browsers.
+          // casts to avoid deprecation notices
+          ((e || (window as any).event) as any).returnValue =
+            confirmationMessage;
           return confirmationMessage;
         }
       });

src/browser/sync/function_result.ts

@@ -17,6 +17,6 @@ export type FunctionSuccess = {
 export type FunctionFailure = {
   success: false;
   errorMessage: string;
-  errorData?: Value;
+  errorData?: Value | undefined;
   logLines: string[];
 };

src/browser/sync/local_state.ts

@@ -23,8 +23,8 @@ type LocalQuery = {
   canonicalizedUdfPath: string;
   args: Record<string, Value>;
   numSubscribers: number;
-  journal?: QueryJournal;
-  componentPath?: string;
+  journal?: QueryJournal | undefined;
+  componentPath?: string | undefined;
 };
 
 export class LocalSyncState {
@@ -33,11 +33,17 @@ export class LocalSyncState {
   private readonly querySet: Map<QueryToken, LocalQuery>;
   private readonly queryIdToToken: Map<QueryId, QueryToken>;
   private identityVersion: IdentityVersion;
-  private auth?: {
-    tokenType: "Admin" | "User";
-    value: string;
-    impersonating?: UserIdentityAttributes;
-  };
+  private auth:
+    | {
+        tokenType: "User";
+        value: string;
+      }
+    | {
+        tokenType: "Admin";
+        value: string;
+        impersonating?: UserIdentityAttributes | undefined;
+      }
+    | undefined;
   private readonly outstandingQueriesOlderThanRestart: Set<QueryId>;
   private outstandingAuthOlderThanRestart: boolean;
   private paused: boolean;
@@ -69,8 +75,8 @@ export class LocalSyncState {
   subscribe(
     udfPath: string,
     args: Record<string, Value>,
-    journal?: QueryJournal,
-    componentPath?: string,
+    journal?: QueryJournal | undefined,
+    componentPath?: string | undefined,
   ): {
     queryToken: QueryToken;
     modification: QuerySetModification | null;
@@ -180,7 +186,7 @@ export class LocalSyncState {
 
   setAuth(value: string): Authenticate {
     this.auth = {
-      tokenType: "User",
+      tokenType: "User" as const,
       value: value,
     };
     const baseVersion = this.identityVersion;
@@ -265,7 +271,7 @@ export class LocalSyncState {
 
   restart(
     oldRemoteQueryResults: Set<QueryId>,
-  ): [QuerySetModification, Authenticate?] {
+  ): [QuerySetModification, (Authenticate | undefined)?] {
     // Restart works whether we are paused or unpaused.
     // The `this.pendingQuerySetModifications` is not used
     // when restarting as the AddQuery and RemoveQuery are computed
@@ -315,7 +321,7 @@ export class LocalSyncState {
     this.paused = true;
   }
 
-  resume(): [QuerySetModification?, Authenticate?] {
+  resume(): [QuerySetModification | undefined, Authenticate | undefined] {
     const querySet: QuerySetModification | undefined =
       this.pendingQuerySetModifications.size > 0
         ? {

src/browser/sync/protocol.ts

@@ -120,7 +120,7 @@ type Connect = {
   sessionId: string;
   connectionCount: number;
   lastCloseReason: string | null;
-  maxObservedTimestamp?: TS;
+  maxObservedTimestamp?: TS | undefined;
   clientTs: number;
 };
 
@@ -129,11 +129,11 @@ export type AddQuery = {
   queryId: QueryId;
   udfPath: string;
   args: JSONValue[];
-  journal?: QueryJournal;
+  journal?: QueryJournal | undefined;
   /**
    * @internal
    */
-  componentPath?: string;
+  componentPath?: string | undefined;
 };
 
 export type RemoveQuery = {
@@ -155,7 +155,7 @@ export type MutationRequest = {
   args: JSONValue[];
   // Execute the mutation on a specific component.
   // Only admin auth is allowed to run mutations on non-root components.
-  componentPath?: string;
+  componentPath?: string | undefined;
 };
 
 export type ActionRequest = {
@@ -165,15 +165,15 @@ export type ActionRequest = {
   args: JSONValue[];
   // Execute the action on a specific component.
   // Only admin auth is allowed to run actions on non-root components.
-  componentPath?: string;
+  componentPath?: string | undefined;
 };
 
 export type AdminAuthentication = {
   type: "Authenticate";
   tokenType: "Admin";
   value: string;
   baseVersion: IdentityVersion;
-  impersonating?: UserIdentityAttributes;
+  impersonating?: UserIdentityAttributes | undefined;
 };
 
 export type Authenticate =
@@ -204,9 +204,12 @@ export type ClientMessage =
   | Event;
 
 type EncodedConnect = Omit<Connect, "maxObservedTimestamp"> & {
-  maxObservedTimestamp?: EncodedTS;
+  maxObservedTimestamp?: EncodedTS | undefined;
 };
 
+// It's not a big deal to add `| undefined` to any optional properties here because
+// these messages are bound for JSON.stringify() serialization, which removes properties
+// that are undefined.
 type EncodedClientMessage =
   | EncodedConnect
   | Authenticate

src/browser/sync/web_socket_manager.ts

@@ -195,7 +195,7 @@ export class WebSocketManager {
       onOpen: (reconnectMetadata: ReconnectMetadata) => void;
       onResume: () => void;
       onMessage: (message: ServerMessage) => OnMessageResponse;
-      onServerDisconnectError?: (message: string) => void;
+      onServerDisconnectError?: ((message: string) => void) | undefined;
     },
     webSocketConstructor: typeof WebSocket,
     logger: Logger,

src/bundler/context.ts

@@ -150,9 +150,9 @@ class OneoffContextImpl {
 }
 
 export const oneoffContext: (args: {
-  url?: string;
-  adminKey?: string;
-  envFile?: string;
+  url?: string | undefined;
+  adminKey?: string | undefined;
+  envFile?: string | undefined;
 }) => Promise<OneoffCtx> = async (args) => {
   const ctx = new OneoffContextImpl();
   await initializeBigBrainAuth(ctx, {

src/bundler/index.ts

@@ -46,7 +46,7 @@ type ModuleEnvironment = "node" | "isolate";
 export interface Bundle {
   path: string;
   source: string;
-  sourceMap?: string;
+  sourceMap?: string | undefined;
   environment: ModuleEnvironment;
 }
 

src/cli/configure.ts

@@ -673,11 +673,13 @@ type DeploymentOptions =
   | { kind: "dev" }
   | {
       kind: "local";
-      ports?: {
-        cloud: number;
-        site: number;
-      };
-      backendVersion?: string;
+      ports?:
+        | {
+            cloud: number;
+            site: number;
+          }
+        | undefined;
+      backendVersion?: string | undefined;
       forceUpgrade: boolean;
     };
 

src/cli/lib/codegen.ts

@@ -38,8 +38,8 @@ import {
 import { functionsDir } from "./utils/utils.js";
 
 export type CodegenOptions = {
-  url?: string;
-  adminKey?: string;
+  url?: string | undefined;
+  adminKey?: string | undefined;
   dryRun: boolean;
   debug: boolean;
   typecheck: TypeCheckMode;