Merge pull request #239 from web3well/cells-formula-rename

Use prefixKeys to avoid shadowing
getwax · Jul 5, 2022 · 565e767 · 565e767
2 parents 9cc3db2 + 49a3661
commit 565e767
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 21 deletions.
diff --git a/extension/source/Home/QuillContext.tsx b/extension/source/Home/QuillContext.tsx
@@ -79,7 +79,7 @@ function QuillContextCells(
     ...storageCells,
     networkJson: new FormulaCell(
       { network: storageCells.network },
-      ({ network }) => JSON.stringify(network, null, 2),
+      ({ $network }) => JSON.stringify($network, null, 2),
     ),
     blockNumber: QuillLongPollingCell(ethereum, 'blockNumber'),
     rpcBackgroundLogging: TransformCell.Sub(rpcLogging, 'background'),

diff --git a/extension/source/QuillStorageCells.ts b/extension/source/QuillStorageCells.ts
@@ -86,12 +86,19 @@ function QuillStorageCells(storage: CellCollection) {
 
   return {
     ...rootCells,
-    providerState: new FormulaCell(providerStateCells, (values) => values),
+    providerState: new FormulaCell(
+      providerStateCells,
+      ({ $chainId, $developerSettings, $selectedAddress }) => ({
+        chainId: $chainId,
+        developerSettings: $developerSettings,
+        selectedAddress: $selectedAddress,
+      }),
+    ),
     ...providerStateCells,
 
     theme: new FormulaCell(
       { preferences: rootCells.preferences },
-      ({ preferences: { selectedAddress, identities } }): Theme => {
+      ({ $preferences: { selectedAddress, identities } }): Theme => {
         if (selectedAddress === undefined) {
           return 'light';
         }

diff --git a/extension/source/background/CurrencyConversionCell.ts b/extension/source/background/CurrencyConversionCell.ts
@@ -33,9 +33,8 @@ export default function CurrencyConversionCell(
       chainCurrency,
       time: TimeCell(config.pollInterval),
     },
-    // eslint-disable-next-line @typescript-eslint/no-shadow
-    ({ preferredCurrency, chainCurrency }) =>
-      fetchRate(config.api, chainCurrency, preferredCurrency),
+    ({ $preferredCurrency, $chainCurrency }) =>
+      fetchRate(config.api, $chainCurrency, $preferredCurrency),
   );
 }
 

diff --git a/extension/source/background/PreferencesController.ts b/extension/source/background/PreferencesController.ts
@@ -27,8 +27,8 @@ export default class PreferencesController {
     this.preferredCurrency = new FormulaCell(
       { preferences },
       // eslint-disable-next-line @typescript-eslint/no-shadow
-      ({ preferences }) => {
-        const { selectedAddress, identities } = preferences;
+      ({ $preferences }) => {
+        const { selectedAddress, identities } = $preferences;
 
         if (selectedAddress === undefined) {
           return undefined;

diff --git a/extension/source/cells/FormulaCell.ts b/extension/source/cells/FormulaCell.ts
@@ -13,6 +13,7 @@ import MemoryCell from './MemoryCell';
 import AsyncIteratee from './AsyncIteratee';
 import Stoppable from './Stoppable';
 import nextEvent from './nextEvent';
+import prefixKeys, { PrefixKeys } from './prefixKeys';
 import assert from '../helpers/assert';
 import delay from '../helpers/delay';
 
@@ -39,7 +40,9 @@ export class FormulaCell<
 
   constructor(
     public inputCells: InputCells,
-    public formula: (inputValues: InputValues<InputCells>) => T,
+    public formula: (
+      inputValues: PrefixKeys<'$', InputValues<InputCells>>,
+    ) => T,
     public hasChanged: (
       previous: Awaited<T> | undefined,
       latest: Awaited<T>,
@@ -145,7 +148,9 @@ export class FormulaCell<
         }
 
         const latest = deepCopy(
-          await this.formula(inputValues.value as InputValues<InputCells>),
+          await this.formula(
+            prefixKeys('$', inputValues.value as InputValues<InputCells>),
+          ),
         );
 
         iterationCell.write({ value: latest });
@@ -180,12 +185,7 @@ export class FormulaCell<
       latest: Input[K],
     ) => boolean = jsonHasChanged,
   ): IReadableCell<Input[K]> {
-    return new FormulaCell(
-      { input },
-      // eslint-disable-next-line @typescript-eslint/no-shadow
-      ({ input }) => input[key],
-      hasChanged,
-    );
+    return new FormulaCell({ input }, ({ $input }) => $input[key], hasChanged);
   }
 
   /** Like Sub, but also maps undefined|null to defaultValue. */
@@ -203,8 +203,7 @@ export class FormulaCell<
   ): IReadableCell<Exclude<Input[K], undefined | null>> {
     return new FormulaCell(
       { input },
-      // eslint-disable-next-line @typescript-eslint/no-shadow
-      ({ input }) => input[key] ?? defaultValue,
+      ({ $input }) => $input[key] ?? defaultValue,
       hasChanged,
     );
   }

diff --git a/extension/source/cells/TransformCell.ts b/extension/source/cells/TransformCell.ts
@@ -25,8 +25,7 @@ export default class TransformCell<Input, T> implements ICell<Awaited<T>> {
 
     this.formulaCell = new FormulaCell(
       { input },
-      // eslint-disable-next-line @typescript-eslint/no-shadow
-      ({ input }) => mapInput(input),
+      ({ $input }) => mapInput($input),
       hasChanged,
     );
 

diff --git a/extension/source/cells/approximate.ts b/extension/source/cells/approximate.ts
@@ -8,7 +8,7 @@ export default function approximate(
   return new FormulaCell<{ value: IReadableCell<number> }, number>(
     { value },
     // eslint-disable-next-line @typescript-eslint/no-shadow
-    ({ value }) => value,
+    ({ $value }) => $value,
     (previous, latest) => {
       if (previous === undefined) {
         return true;

diff --git a/extension/source/cells/prefixKeys.ts b/extension/source/cells/prefixKeys.ts
@@ -0,0 +1,20 @@
+type RemovePrefix<
+  Prefix extends string,
+  T extends string,
+> = T extends `${Prefix}${infer AfterPrefix}` ? AfterPrefix : never;
+
+export type PrefixKeys<
+  Prefix extends string,
+  Obj extends Record<string, unknown>,
+> = {
+  [K in `${Prefix}${keyof Obj & string}`]: Obj[RemovePrefix<Prefix, K>];
+};
+
+export default function prefixKeys<
+  Prefix extends string,
+  Obj extends Record<string, unknown>,
+>(prefix: Prefix, obj: Obj): PrefixKeys<Prefix, Obj> {
+  return Object.fromEntries(
+    Object.entries(obj).map(([k, v]) => [`${prefix}${k}`, v]),
+  ) as PrefixKeys<Prefix, Obj>;
+}