779391 - Move deepCopy to CommonUtils

Status: RESOLVED FIXED

(Cloud Services :: Firefox: Common, defect)

Description

[Gregory Szorc [:gps]]

Attachment: Move deepCopy into module, v1

This is required for the upcoming repositories patch. deepCopy was previously defined in head_helpers and used across tests. I need to use deepCopy from a testing-only JS module. I moved it to an importable module that seemed to make sense. I suppose I could move it to a testing-only JS module, since no release code uses it. I'll give reviewer discretion.

I took the opportunity to refactor the implementation slightly. (Mostly to meet style guidelines.)

Comment 1

[Richard Newman [:rnewman]]

Comment on attachment 647807 [details] [diff] [review]
Move deepCopy into module, v1

Review of attachment 647807 [details] [diff] [review]:
-----------------------------------------------------------------

Slightly stricter than usual, as we're lifting it into a more visible place.

::: services/common/tests/unit/test_utils_deepCopy.js
@@ +13,5 @@
> +  do_check_neq(ret.a[1], thing.a[1]);
> +  do_check_eq(ret.o.foo, thing.o.foo);
> +  do_check_eq(ret.o.bar[0], thing.o.bar[0]);
> +  do_check_eq(ret.a[0], thing.a[0]);
> +  do_check_eq(ret.a[1].bar, thing.a[1].bar);

Please add a test for deepCopy on an array. I know it's recursive, but the top-level version deserves coverage IMO.

::: services/common/utils.js
@@ +479,5 @@
> +    if (Array.isArray(thing)) {
> +      ret = [];
> +      for (let element of thing) {
> +        ret.push(this.deepCopy(element, noSort));
> +      }

Early return, avoid the `else` and the free-standing definition of `ret`.

@@ +484,5 @@
> +    } else {
> +      ret = {};
> +      let props = [p for (p in thing)];
> +
> +      if (!noSort){

Spacing.

Comment 2

[Gregory Szorc [:gps]]

Attachment: Move deepCopy into module, v2

I moved deepCopy to a testing-only JS module. Hopefully this comes with a less stringent review.

Comment 3

[Gregory Szorc [:gps]]

Attachment: Move deepCopy into module, v3

Added missing file to patch.

Comment 4

[Richard Newman [:rnewman]]

Comment on attachment 648033 [details] [diff] [review]
Move deepCopy into module, v3

Review of attachment 648033 [details] [diff] [review]:
-----------------------------------------------------------------

::: services/common/utils.js
@@ +464,5 @@
>      }
>  
>      return new BinaryInputStream(stream).readBytes(count);
>    },
> +

*chop*

Comment 5

[Gregory Szorc [:gps]]

https://hg.mozilla.org/services/services-central/rev/73d5011605a6

Comment 6

[Gregory Szorc [:gps]]

https://hg.mozilla.org/mozilla-central/rev/73d5011605a6