shared: rename unwrap to nullthrows

Summary:
The `unwrap` is treated as a jotai library function so `jotai/babel/plugin-debug-label` rewrites code like:

  const parentRev = unwrap(this.singleParentRev(rev));

to:

  const parentRev = unwrap(this.singleParentRev(rev));
  parentRev.debugLabel = "parentRev";

which causes issues (since `parentRev` is a number). It does not seem there is
a way to customize the babel plugin to blocklist function names. For now let's
just rename our `unwrap` to avoid the conflict.

See https://github.com/pmndrs/jotai/blob/234dff9c89642c6a1a724d2a73398119e4ea00fc/src/babel/utils.ts#L39

Reviewed By: evangrayk

Differential Revision: D54821276

fbshipit-source-id: f2dbb2035271114c2a5aeb202bfefe4c81df25a0

addons/isl-server/proxy/existingServerStateFiles.ts

@@ -9,7 +9,7 @@ import rmtree from './rmtree';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 export type ExistingServerInfo = {
   sensitiveToken: string;
@@ -28,7 +28,7 @@ export type ExistingServerInfo = {
 
 const cacheDir =
   process.platform == 'win32'
-    ? path.join(unwrap(process.env.LOCALAPPDATA), 'cache')
+    ? path.join(nullthrows(process.env.LOCALAPPDATA), 'cache')
     : process.platform == 'darwin'
     ? path.join(os.homedir(), 'Library/Caches')
     : process.env.XDG_CACHE_HOME || path.join(os.homedir(), '.cache');

addons/isl-server/src/Repository.ts

@@ -85,7 +85,7 @@ import {RateLimiter} from 'shared/RateLimiter';
 import {TypedEventEmitter} from 'shared/TypedEventEmitter';
 import {exists} from 'shared/fs';
 import {removeLeadingPathSep} from 'shared/pathUtils';
-import {notEmpty, randomId, unwrap} from 'shared/utils';
+import {notEmpty, randomId, nullthrows} from 'shared/utils';
 
 /**
  * This class is responsible for providing information about the working copy
@@ -497,7 +497,7 @@ export class Repository {
   }
 
   private normalizeOperationArgs(cwd: string, args: Array<CommandArg>): Array<string> {
-    const repoRoot = unwrap(this.info.repoRoot);
+    const repoRoot = nullthrows(this.info.repoRoot);
     return args.flatMap(arg => {
       if (typeof arg === 'object') {
         switch (arg.type) {

addons/isl-server/src/ServerToClientAPI.ts

@@ -36,7 +36,7 @@ import {repositoryCache} from './RepositoryCache';
 import {findPublicAncestor, parseExecJson} from './utils';
 import {serializeToString, deserializeFromString} from 'isl/src/serialize';
 import {revsetForComparison} from 'shared/Comparison';
-import {randomId, unwrap} from 'shared/utils';
+import {randomId, nullthrows} from 'shared/utils';
 import {Readable} from 'stream';
 
 export type IncomingMessage = ClientToServerMessage;
@@ -254,7 +254,7 @@ export default class ServerToClientAPI {
         }
         this.tracker
           .operation('UploadImage', 'UploadImageError', {}, () =>
-            uploadFile(unwrap(this.connection.logger), {filename, data: payload}),
+            uploadFile(nullthrows(this.connection.logger), {filename, data: payload}),
           )
           .then((result: string) => {
             this.connection.logger?.info('sucessfully uploaded file', filename, result);

addons/isl-server/src/analytics/environment.ts

@@ -8,15 +8,15 @@
 import type {ApplicationInfo} from './types';
 
 import os from 'os';
-import {randomId, unwrap} from 'shared/utils';
+import {randomId, nullthrows} from 'shared/utils';
 
 export function getUsername(): string {
   try {
     return os.userInfo().username;
   } catch (osInfoError) {
     try {
       const {env} = process;
-      return unwrap(env.LOGNAME || env.USER || env.LNAME || env.USERNAME);
+      return nullthrows(env.LOGNAME || env.USER || env.LNAME || env.USERNAME);
     } catch (processEnvError) {
       throw new Error(String(processEnvError) + String(osInfoError));
     }

addons/isl-server/src/serverPlatform.ts

@@ -15,7 +15,7 @@ import type {
 
 import {spawn} from 'child_process';
 import pathModule from 'path';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 /**
  * Platform-specific server-side API for each target: vscode extension host, electron standalone, browser, ...
@@ -43,7 +43,10 @@ export const browserServerPlatform: ServerPlatform = {
   ) => {
     switch (message.type) {
       case 'platform/openContainingFolder': {
-        const absPath: AbsolutePath = pathModule.join(unwrap(repo?.info.repoRoot), message.path);
+        const absPath: AbsolutePath = pathModule.join(
+          nullthrows(repo?.info.repoRoot),
+          message.path,
+        );
         let args: Array<string> = [];
         // use OS-builtin open command to open parent directory
         // (which may open different file extensions with different programs)

addons/isl/src/Cleanup.tsx

@@ -19,7 +19,7 @@ import {type Dag, dagWithPreviews} from './previews';
 import {VSCodeButton} from '@vscode/webview-ui-toolkit/react';
 import {useAtomValue} from 'jotai';
 import {Icon} from 'shared/Icon';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 export function isStackEligibleForCleanup(
   hash: Hash,
@@ -99,7 +99,7 @@ export function CleanupAllButton() {
         contextKey="cleanup-all"
         runOperation={() => {
           return cleanableStacks.map(hash => {
-            const info = unwrap(dag.get(hash));
+            const info = nullthrows(dag.get(hash));
             return new HideOperation(latestSuccessorUnlessExplicitlyObsolete(info));
           });
         }}

addons/isl/src/CommitInfoView/CommitInfoView.tsx

@@ -87,7 +87,7 @@ import {useCallback, useEffect} from 'react';
 import {ComparisonType} from 'shared/Comparison';
 import {useContextMenu} from 'shared/ContextMenu';
 import {Icon} from 'shared/Icon';
-import {firstLine, notEmpty, unwrap} from 'shared/utils';
+import {firstLine, notEmpty, nullthrows} from 'shared/utils';
 
 import './CommitInfoView.css';
 
@@ -779,7 +779,7 @@ function ActionsBar({
                     answer,
                   );
                   setRepoInfo(info => ({
-                    ...unwrap(info),
+                    ...nullthrows(info),
                     preferredSubmitCommand: answer,
                   }));
                   // setRepoInfo updates `provider`, but we still have a stale reference in this callback.
@@ -802,7 +802,7 @@ function ActionsBar({
                 // during another amend or amend message.
                 const shouldUpdateMessage = !isCommitMode && messageSyncEnabled && anythingToCommit;
 
-                const submitOp = unwrap(provider).submitOperation(
+                const submitOp = nullthrows(provider).submitOperation(
                   commit.isHead ? [] : [commit], // [] means to submit the head commit
                   {
                     draft: shouldSubmitAsDraft,

addons/isl/src/CommitInfoView/GenerateWithAI.tsx

@@ -30,7 +30,7 @@ import {useCallback} from 'react';
 import {ComparisonType} from 'shared/Comparison';
 import {Icon} from 'shared/Icon';
 import {useThrottledEffect} from 'shared/hooks';
-import {randomId, unwrap} from 'shared/utils';
+import {randomId, nullthrows} from 'shared/utils';
 
 import './GenerateWithAI.css';
 
@@ -145,7 +145,7 @@ const generatedCommitMessages = atomFamilyWeak((hashKey: string | undefined) =>
         const comparison: Comparison = hashKey.startsWith('commit/')
           ? {type: ComparisonType.UncommittedChanges}
           : {type: ComparisonType.Committed, hash: hashKey};
-        const response = await unwrap(Internal.generateAICommitMessage)({
+        const response = await nullthrows(Internal.generateAICommitMessage)({
           comparison,
           title: latestWrittenTitle,
         });
@@ -296,7 +296,7 @@ class FunnelTracker {
   /** Get or create the funnel tracker for this hashKey */
   static get(hashKey: HashKey): FunnelTracker {
     if (this.trackersByHashKey.has(hashKey)) {
-      return unwrap(this.trackersByHashKey.get(hashKey));
+      return nullthrows(this.trackersByHashKey.get(hashKey));
     }
     const tracker = new FunnelTracker();
     this.trackersByHashKey.set(hashKey, tracker);

addons/isl/src/ComparisonView/SplitDiffView/syntaxHighlighting.tsx

@@ -22,7 +22,7 @@ import FilepathClassifier from 'shared/textmate-lib/FilepathClassifier';
 import createTextMateRegistry from 'shared/textmate-lib/createTextMateRegistry';
 import {updateTextMateGrammarCSS} from 'shared/textmate-lib/textmateStyles';
 import {tokenizeLines} from 'shared/textmate-lib/tokenize';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 import {loadWASM} from 'vscode-oniguruma';
 
 const URL_TO_ONIG_WASM = 'generated/textmate/onig.wasm';
@@ -208,7 +208,7 @@ async function tokenizeContent(
 const grammarCache: Map<string, Promise<IGrammar | null>> = new Map();
 function getGrammar(store: Registry, scopeName: string): Promise<IGrammar | null> {
   if (grammarCache.has(scopeName)) {
-    return unwrap(grammarCache.get(scopeName));
+    return nullthrows(grammarCache.get(scopeName));
   }
   const grammarPromise = store.loadGrammar(scopeName);
   grammarCache.set(scopeName, grammarPromise);

addons/isl/src/ConfirmSubmitStack.tsx

@@ -22,7 +22,7 @@ import {VSCodeDivider, VSCodeButton, VSCodeTextField} from '@vscode/webview-ui-t
 import {useAtom, useAtomValue} from 'jotai';
 import {useState} from 'react';
 import {useAutofocusRef} from 'shared/hooks';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 import './ConfirmSubmitStack.css';
 
@@ -66,7 +66,10 @@ export function useShowConfirmSubmitStack() {
 
     const provider = readAtom(codeReviewProvider);
 
-    const replace = {$numCommits: String(stack.length), $cmd: unwrap(provider).submitCommandName()};
+    const replace = {
+      $numCommits: String(stack.length),
+      $cmd: nullthrows(provider).submitCommandName(),
+    };
     const title =
       mode === 'submit'
         ? t('Submitting $numCommits commits for review with $cmd', {replace})

addons/isl/src/DownloadCommitsMenu.tsx

@@ -29,7 +29,7 @@ import {useAtom} from 'jotai';
 import {useEffect, useRef, useState} from 'react';
 import {Icon} from 'shared/Icon';
 import {KeyCode, Modifier} from 'shared/KeyboardShortcuts';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 import './DownloadCommitsMenu.css';
 
@@ -128,7 +128,7 @@ function DownloadCommitsTooltip({dismiss}: {dismiss: () => unknown}) {
       const dest =
         rebaseType === 'rebase_ontop'
           ? '.'
-          : unwrap(findCurrentPublicBase(readAtom(dagWithPreviews))?.hash);
+          : nullthrows(findCurrentPublicBase(readAtom(dagWithPreviews))?.hash);
       // Use exact revsets for sources, so that you can type a specific hash to download and not be surprised by succession.
       // Only use succession for destination, which may be in flux at the moment you start the download.
       runOperation(new Op(exactRevset(enteredDiffNum), succeedableRevset(dest)));

addons/isl/src/SettingsTooltip.tsx

@@ -39,7 +39,7 @@ import {
 import {useAtom, useAtomValue} from 'jotai';
 import {Icon} from 'shared/Icon';
 import {KeyCode, Modifier} from 'shared/KeyboardShortcuts';
-import {tryJsonParse, unwrap} from 'shared/utils';
+import {tryJsonParse, nullthrows} from 'shared/utils';
 
 import './VSCodeDropdown.css';
 import './SettingsTooltip.css';
@@ -159,7 +159,7 @@ function SettingsDropdown({
               runOperation(
                 new SetConfigOperation('local', 'github.preferred_submit_command', value),
               );
-              setRepoInfo(info => ({...unwrap(info), preferredSubmitCommand: value}));
+              setRepoInfo(info => ({...nullthrows(info), preferredSubmitCommand: value}));
             }}>
             {repoInfo.preferredSubmitCommand == null ? (
               <VSCodeOption value={'not set'}>(not set)</VSCodeOption>

addons/isl/src/__tests__/ComparisonView.test.tsx

@@ -26,7 +26,7 @@ import fs from 'fs';
 import path from 'path';
 import {ComparisonType} from 'shared/Comparison';
 import {nextTick} from 'shared/testUtils';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 afterEach(cleanup);
 
@@ -594,7 +594,7 @@ function mockFetchToSupportSyntaxHighlighting(): jest.SpyInstance {
     jest.fn(async url => {
       if (url.includes('generated/textmate')) {
         const match = /.*generated\/textmate\/(.*)$/.exec(url);
-        const filename = unwrap(match)[1];
+        const filename = nullthrows(match)[1];
         const toPublicDir = (filename: string) =>
           path.normalize(path.join(__dirname, '../../public/generated/textmate', filename));
         if (filename === 'onig.wasm') {

addons/isl/src/__tests__/FillCommitMessage.test.tsx

@@ -18,7 +18,7 @@ import {
 import {fireEvent, render, screen, waitFor, within} from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import {act} from 'react-dom/test-utils';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
@@ -110,7 +110,7 @@ describe('FillCommitMessage', () => {
     expect(loadFromLastCommit).toBeInTheDocument();
     fireEvent.click(loadFromLastCommit);
     await waitFor(() => expect(getTitleEditor().value).toMatch('Head Commit'));
-    expect(getFieldEditor(unwrap(Internal.diffFieldTag))).toHaveValue('');
+    expect(getFieldEditor(nullthrows(Internal.diffFieldTag))).toHaveValue('');
   });
 
   it('Load from commit template', async () => {

addons/isl/src/__tests__/Shelve.test.tsx

@@ -21,7 +21,7 @@ import {fireEvent, render, screen, waitFor, within} from '@testing-library/react
 import userEvent from '@testing-library/user-event';
 import {act} from 'react-dom/test-utils';
 import {ComparisonType} from 'shared/Comparison';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 describe('Shelve', () => {
   beforeEach(() => {
@@ -99,7 +99,7 @@ describe('Shelve', () => {
 
       // uncheck one file
       fireEvent.click(
-        unwrap(
+        nullthrows(
           screen.getByTestId('changed-file-src/file2.js').querySelector('input[type=checkbox]'),
         ),
       );

addons/isl/src/codeReview/CodeReviewInfo.ts

@@ -27,7 +27,7 @@ import {GithubUICodeReviewProvider} from './github/github';
 import {atom} from 'jotai';
 import {clearTrackedCache} from 'shared/LRU';
 import {debounce} from 'shared/debounce';
-import {firstLine, unwrap} from 'shared/utils';
+import {firstLine, nullthrows} from 'shared/utils';
 
 export const codeReviewProvider = atom<UICodeReviewProvider | null>(get => {
   const repoInfo = get(repositoryInfo);
@@ -88,7 +88,10 @@ registerDisposable(
 
       // merge old values with newly fetched ones
       return {
-        value: new Map([...unwrap(existing.value).entries(), ...event.summaries.value.entries()]),
+        value: new Map([
+          ...nullthrows(existing.value).entries(),
+          ...event.summaries.value.entries(),
+        ]),
       };
     });
   }),

addons/isl/src/dag/base_dag.ts

@@ -13,7 +13,7 @@ import {HashSet} from './set';
 import {Map as ImMap, Record, List} from 'immutable';
 import {LRU, cachedMethod} from 'shared/LRU';
 import {SelfUpdate} from 'shared/immutableExt';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 /**
  * Hash-map like container with graph related queries.
@@ -263,7 +263,8 @@ export class BaseDag<C extends HashWithParents> extends SelfUpdate<BaseDagRecord
     const filledSet = gap ? this.range(hashSet, hashSet) : hashSet;
     const alreadyVisited = new Set<Hash>();
     // We use concat and pop (not unshift) so the order is reversed.
-    const compareHash = (a: Hash, b: Hash) => -compare(unwrap(this.get(a)), unwrap(this.get(b)));
+    const compareHash = (a: Hash, b: Hash) =>
+      -compare(nullthrows(this.get(a)), nullthrows(this.get(b)));
     // The number of parents remaining to be visited. This ensures merges are not
     // outputted until all parents are outputted.
     const remaining = new Map<Hash, number>(

addons/isl/src/dag/dag.ts

@@ -20,7 +20,7 @@ import {arrayFromHashes, HashSet} from './set';
 import {List, Record, Map as ImMap, Set as ImSet} from 'immutable';
 import {LRU, cachedMethod} from 'shared/LRU';
 import {SelfUpdate} from 'shared/immutableExt';
-import {group, notEmpty, splitOnce, unwrap} from 'shared/utils';
+import {group, notEmpty, splitOnce, nullthrows} from 'shared/utils';
 
 /**
  * Main commit graph type used for preview calculation and queries.
@@ -369,7 +369,7 @@ export class Dag extends SelfUpdate<CommitDagRecord> {
       const pureHash = isSucc ? h.substring(REBASE_SUCC_PREFIX.length) : h;
       const isPred = !isSucc && duplicated.contains(h);
       const isRoot = srcRoots.contains(pureHash);
-      const info = unwrap(isSucc ? this.get(pureHash) : c);
+      const info = nullthrows(isSucc ? this.get(pureHash) : c);
       return info.withMutations(mut => {
         // Reset the seqNumber so the rebase preview tends to show as right-most branches.
         let newInfo = mut.set('seqNumber', undefined);
@@ -565,7 +565,7 @@ export class Dag extends SelfUpdate<CommitDagRecord> {
     // Render row by row. The main complexity is to figure out the "ancestors",
     // especially when the provided `set` is a subset of the dag.
     for (const hash of sorted) {
-      const info = unwrap(this.get(hash));
+      const info = nullthrows(this.get(hash));
       const parents: ReadonlyArray<Hash> = info?.parents ?? [];
       // directParents: solid edges
       // indirectParents: dashed edges

addons/isl/src/linelog.ts

@@ -37,7 +37,7 @@ import {hash, List, Record, Set as ImSet} from 'immutable';
 import {cached, cachedMethod, LRU} from 'shared/LRU';
 import {diffLines, splitLines} from 'shared/diff';
 import {SelfUpdate} from 'shared/immutableExt';
-import {unwrap} from 'shared/utils';
+import {nullthrows} from 'shared/utils';
 
 /** Operation code. */
 enum Op {
@@ -378,7 +378,7 @@ class Code implements ValueObject {
       if (aLinesMutable) {
         aLines[a1] = {...aLines[a1], pc: jlInst == null ? code.size : code.size + 1};
       }
-      const a1Inst = unwrap(code.get(a1Pc));
+      const a1Inst = nullthrows(code.get(a1Pc));
       if (jlInst === undefined) {
         // [3]
         code = code.push(a1Inst);
@@ -551,7 +551,7 @@ class Code implements ValueObject {
         delStack.pop();
         onStackPop?.(delStack);
       }
-      const code = unwrap(this.get(pc));
+      const code = nullthrows(this.get(pc));
       switch (code.op) {
         case Op.LINE:
           onLine?.(code);
@@ -898,7 +898,7 @@ class LineLog extends SelfUpdate<LineLogRecord> {
     let patience = this.code.getSize() * 2;
     const deleted = present == null ? () => false : (pc: Pc) => !present[pc];
     while (patience > 0) {
-      const code = unwrap(this.code.get(pc));
+      const code = nullthrows(this.code.get(pc));
       switch (code.op) {
         case Op.END:
           lines.push({data: '', rev: 0, pc, deleted: deleted(pc)});