Merge pull request #5643 from Shopify/mattellig/path-value-arrays

Use `PropertyPath` in path value methods

Author: mattellig

.changeset/funny-pots-visit.md

@@ -0,0 +1,5 @@
+---
+'@shopify/cli-kit': minor
+---
+
+Update `getPathValue`, `setPathValue`, and `unsetPathValue` to support the lodash `PropertyPath` type

packages/cli-kit/src/public/common/object.test.ts

@@ -184,6 +184,17 @@ describe('getPathValue', () => {
     // Then
     expect(result).toBeUndefined()
   })
+
+  test('gets a property whose name contains dots using array notation', () => {
+    // Given
+    const obj: object = {'key1.with.dots': 'value'}
+
+    // When
+    const result = getPathValue(obj, ['key1.with.dots'])
+
+    // Then
+    expect(result).toEqual('value')
+  })
 })
 
 describe('setPathValue', () => {
@@ -242,6 +253,47 @@ describe('setPathValue', () => {
     // Then
     expect(getPathValue(result, 'key1')).toEqual({key11: 2})
   })
+
+  test('set the path value using an array path notation', () => {
+    // Given
+    const obj: object = {
+      key1: {
+        key11: 3,
+      },
+    }
+
+    // When
+    const result = setPathValue(obj, ['key1', 'key11'], 4)
+
+    // Then
+    expect(getPathValue(result, 'key1.key11')).toEqual(4)
+  })
+
+  test('set a property whose name contains dots using array notation', () => {
+    // Given
+    const obj: object = {}
+
+    // When
+    const result = setPathValue(obj, ['key1.with.dots'], 'value')
+
+    // Then
+    expect(result).toEqual({'key1.with.dots': 'value'})
+    // Should NOT create a nested structure
+    expect(getPathValue(result, ['key1.with.dots'])).toEqual('value')
+    // Should be accessible as a top-level property
+    expect((result as {[key: string]: string})['key1.with.dots']).toEqual('value')
+  })
+
+  test('set nested property under a key that contains dots', () => {
+    // Given
+    const obj: object = {'key1.with.dots': {}}
+
+    // When
+    const result = setPathValue(obj, ['key1.with.dots', 'nested'], 'value')
+
+    // Then
+    expect(result).toEqual({'key1.with.dots': {nested: 'value'}})
+  })
 })
 
 describe('compact', () => {
@@ -358,4 +410,33 @@ describe('unsetPathValue', () => {
     expect(result).toBeFalsy()
     expect(Object.prototype.hasOwnProperty.call(obj, 'key1')).toBeTruthy()
   })
+
+  test('removes the path value using array path notation', () => {
+    // Given
+    const obj: object = {
+      key1: {
+        key11: 2,
+        key12: 3,
+      },
+    }
+
+    // When
+    const result = unsetPathValue(obj, ['key1', 'key11'])
+
+    // Then
+    expect(result).toBeTruthy()
+    expect(obj).toEqual({key1: {key12: 3}})
+  })
+
+  test('removes a property whose name contains dots using array notation', () => {
+    // Given
+    const obj: object = {'key1.with.dots': 'value', regular: 'value2'}
+
+    // When
+    const result = unsetPathValue(obj, ['key1.with.dots'])
+
+    // Then
+    expect(result).toBeTruthy()
+    expect(obj).toEqual({regular: 'value2'})
+  })
 })

packages/cli-kit/src/public/common/object.ts

@@ -1,6 +1,6 @@
 import {unionArrayStrategy} from '../../private/common/array.js'
 import deepMerge from 'deepmerge'
-import {Dictionary, ObjectIterator, ValueKeyIteratee} from 'lodash'
+import {Dictionary, ObjectIterator, PropertyPath, ValueKeyIteratee} from 'lodash'
 import lodashPickBy from 'lodash/pickBy.js'
 import lodashMapValues from 'lodash/mapValues.js'
 import lodashIsEqual from 'lodash/isEqual.js'
@@ -88,7 +88,7 @@ export function deepDifference(one: object, two: object): [object, object] {
  * @param path - The path of the property to get.
  * @returns - Returns the resolved value.
  */
-export function getPathValue<T = object>(object: object, path: string): T | undefined {
+export function getPathValue<T = object>(object: object, path: PropertyPath): T | undefined {
   return get(object, path) === undefined ? undefined : (get(object, path) as T)
 }
 
@@ -100,7 +100,7 @@ export function getPathValue<T = object>(object: object, path: string): T | unde
  * @param value - The value to set.
  * @returns - Returns object.
  */
-export function setPathValue(object: object, path: string, value?: unknown): object {
+export function setPathValue(object: object, path: PropertyPath, value?: unknown): object {
   return set(object, path, value)
 }
 
@@ -111,7 +111,7 @@ export function setPathValue(object: object, path: string, value?: unknown): obj
  * @param path - The path of the property to unset.
  * @returns - Returns true if the property is deleted or not found, else false.
  */
-export function unsetPathValue(object: object, path: string): boolean {
+export function unsetPathValue(object: object, path: PropertyPath): boolean {
   return unset(object, path)
 }