tc39 / proposal-private-methods

Private methods and getter/setters for ES6 classes
https://arai-a.github.io/ecma262-compare/?pr=1668
345 stars 37 forks source link

Do we need private accessors? #7

Closed littledan closed 6 years ago

littledan commented 7 years ago

Private methods have a clear use case--manipulating data held in private fields--but private accessors seem a little more borderline. When everything is in the same class body, and when there are no decorators creating accessors under the hood, are private accessors sufficiently motivated? It seems like you'd often be able to just call a private method instead at not much loss to ergonomics.

Thanks to @ajklein for raising this issue.

Jamesernator commented 7 years ago

I don't really see the point of allowing private accessors, accessors in general seem to only really be useful to do one of a couple things:

  1. Preventing data duplication while retaining an ergonomic API e.g.:

    const person = {
    firstName: "Bob",
    lastName: "Smith",
    get fullName() {
        return this.firstName + this.lastName
    }
    }
  2. The Liskov substitution principle:

    const yesImReallyADOMNodeTrustMe = {
    style: {
        set backgroundColor() {
            // Do some rendering to some fake DOM
        }
        ...
    }
    ...
    }

The first reason might apply internally to the class, but the Liskov substitution principle obviously doesn't apply to private fields.

It could apply though if friend classes were possible e.g.:


// syntax for friend fields irrelevant
#x
#y

class Point2D {
    // syntax irrelevant
    outer #x
    outer #y
    constructor(x, y) {
        this.#x = x
        this.#y = y
    }

    transformBy(otherPoint) {
       return new Point2D(this.#x + otherPoint.#x, this.#y + otherPoint.#y)
}

class Point3D {
    outer #x
    #optimizedPoint
    constructor(x, y, z) {
        this.#optimizedPoint = engine3D.createPoint(x, y, z)
    }

    get #x() {
        return this.#optimizedPoint.getX()
    }
}

Given that friend private fields aren't part of the current proposal I don't really see any point in having private accessors unless there's some concrete examples of where ergonomics are really improved with it.

If they are desirable for friend classes then they can always be part of whatever proposal adds friend classes.

bakkot commented 7 years ago

At committee this seemed to come down pretty firmly on the side of "yes", if I remember correctly - lots of people described use cases, often involving refactoring.

littledan commented 7 years ago

I want to leave this open for future feedback for now. In some ways, it's easier to say "yes" than "no" to complexity.

As described in the unified class features explainer, one application would be for decorators which turn a private field into a private accessor, but we could delay private accessors for now until we also have decorator integration.

Another piece of motivation is orthogonality: Anything you can do publicly should be possible to do privately, so you don't have to think about, "I'm changing this between public and private; can I do that with this sort of class element?" The answer is always, yes.

Jamesernator commented 7 years ago

@littledan Regarding orthogonality the way private fields are spec-ed there's going to be things public fields can do that private ones necessarily can't. For example deletion (delete this.#x) and dynamic access (this[privateName]) can't be directly changed to some private field equivalent.

amatiasq commented 6 years ago

Private accessors can be useful for debugging reasons. If we have a private field and want to intercept it's modifications we can change it to a private getter / setter. If we don't have private accessors we would have to rename the variable to debug it.

littledan commented 6 years ago

We've concluded that we do want to add private accessors; see further motivation in #27.