CaV Code Review

[marlitas]

This is a placeholder for the Code Review Issue. I need to add the template here... don't forget @marlitas.

[pixelzoom]

I understand that I'll be doing the code review. A couple of reminders:

• The code review is preceeded by a "Self code review", for which a GitHub issue should be created. If you're planning to skip that for some reason, I don’t think that’s a good idea. It’s a shortcut that bypasses an important part of the code-review learning process. And when the self code review is skipped, it typically results in more work for me during the final code review.

• As noted in the checklist template:

  Delete (or strikethrough) items and sections that are not relevant.

[kathy-phet]

@marlitas @samreid @matthew-blackman - I agree with CM here. If you haven't already, please do do a self-code review, then Chris can do the code review. This will be Matt's first time participating in self code review, so for @matthew-blackman - you can see Martin's issue here: https://github.com/phetsims/calculus-grapher/issues/262

[samreid]

Good idea, we will do the self review in https://github.com/phetsims/center-and-variability/issues/449

[marlitas]

I also just wanted to mention that we have been self-reviewing for each issue as we've gone along. We will definitely go through the checklist as well, but I don't want to give the impression that there's been zero self-code review so far.

[samreid]

For this code review, please review both:

• center-and-variability 9300 LOC
• soccer-common 1200 LOC

soccer-common was factored out for reuse in Mean: Share and Balance.

We would prefer new issues to be created in the center-and-variability repo (even if it is for soccer-common), unless you have an objection to that.

We are organizing all the work via the project board in CaV: https://github.com/orgs/phetsims/projects/76/views/3 This project board identifies issues by priority and effort. Please be aware there are ongoing open issues, mainly related to interactive highlighting and keyboard hints.

That being said, please feel free to make any commits you wish to center-and-variability or soccer-common.

This sim supports:

• PhET-iO
• alt input
• interactive highlights
• sound

We completed the self-code review in https://github.com/phetsims/center-and-variability/issues/449

The sim design doc is listed in https://docs.google.com/document/d/19OG6qtThtkH89zCQmkIckM6ZKV8W1zkCT0ZghXKcL9U/edit# (might be a little stale, 3rd screen might be a lot stale)

PhET-iO Design Doc is listed at https://docs.google.com/document/d/1Z73-qNEMDVXinHsGYtruuaRKu8gO4EkH_6bD1Uf-ZAc/edit#heading=h.nuk4ozqbti54

Art Assets: Note that artwork has not yet been delivered for region and culture. Right now there are placeholders for the regional character sets. We plan to revisit the player graphics and review KickerNode, KickerCharacterSet and KickerCharacterSets once those assets are ready to be put in place.

The sim has not yet been through dev testing.

Thanks for reviewing!

[pixelzoom]

@samreid @marlitas @matthew-blackman and I had a kick-off Zoom meeting. This is ready for me to begin, so I'll self assign. And I'll start by grabbing the checklist from https://github.com/phetsims/center-and-variability/issues/449.

[pixelzoom]

PhET Code-Review Checklist (a.k.a "CRC")

• The responsible dev is responsible for removing the irrelevant parts

• A checked-off item doesn't mean "no problem here", it means "it was reviewed"

• Problems can be noted in side issues that reference this issue, or through // REVIEW comments in the code

  GitHub Issues

  The following standard GitHub issues should exist. If these issues are missing, or have not been completed, pause code review until the issues have been created and addressed by the responsible dev.

• [x] model.md, see https://github.com/phetsims/center-and-variability/issues/443. Familiarize yourself with the model by reading model.md. Does it adequately describe the model, in terms appropriate for teachers? Has it been reviewed by the sim designer?

• [x] implementation-notes.md, see https://github.com/phetsims/center-and-variability/issues/442. Familiarize yourself with the implementation by reading implementation-notes.md. Does it provide an overview that will be useful to future maintainers?

• [x] results of memory testing for brands=phet, see https://github.com/phetsims/center-and-variability/issues/452

• [x] results of memory testing for brands=phet-io (if the sim is instrumented for PhET-iO), see https://github.com/phetsims/center-and-variability/issues/452

• [x] performance testing and sign-off, see https://github.com/phetsims/center-and-variability/issues/461

• [x] review of pointer areas, see https://github.com/phetsims/center-and-variability/issues/462

• [x] credits (will not be completed until after RC testing), see https://github.com/phetsims/center-and-variability/issues/453

Build and Run Checks

If any of these items fail, pause code review.

• [x] Does the sim build without warnings or errors?
• [x] ⚠️ See #464. Does the html file size seem reasonable, compared to other similar sims?
• [x] Does the sim start up? (unbuilt and built versions)
• [x] Does the sim experience any assertion failures? (run with query parameter ea)
• [x] Does the sim pass a scenery fuzz test? (run with query parameters fuzz&ea)
• [x] Does the sim behave correctly when listener order is shuffled? (run with query parameters ea&listenerOrder=random and ea&listenerOrder=random&fuzz)
• [x] Does the sim output any deprecation warnings? Run with ?deprecationWarnings. Do not use deprecated methods in new code.

Memory Leaks

• [x] Does a heap comparison using Chrome Developer Tools indicate a memory leak? (This process is described here.) Test on a version built using grunt --minify.mangle=false. Compare to testing results done by the responsible developer. Results can be found in https://github.com/phetsims/center-and-variability/issues/452.
• [x] For each common-code component (sun, scenery-phet, vegas, …) that opaquely registers observers or listeners, is there a call to that component’s dispose function, or is it obvious why it isn't necessary, or is there documentation about why dispose isn't called? An example of why no call to dispose is needed is if the component is used in a ScreenView that would never be removed from the scene graph. Note that it's also acceptable (and encouraged!) to describe what needs to be disposed in implementation-notes.md.
• [x] Are there leaks due to registering observers or listeners? The following guidelines should be followed unless documentation (in-line or in implementation-notes.md) describes why following them is not necessary.
  • AXON: Property.link or lazyLink is accompanied by unlink.
  • AXON: Multilink.multilink is accompanied by unmultilink.
  • AXON: Creation of Multilink is accompanied by dispose.
  • AXON: Creation of DerivedProperty is accompanied by dispose.
  • AXON: Emitter.addListener is accompanied by removeListener.
  • AXON: ObservableArrayDef.element*Emitter.addListener is accompanied by ObservableArrayDef.element*Emitter.removeListener
  • SCENERY: Node.addInputListener is accompanied by removeInputListener
  • TANDEM: Creation of an instrumented PhetioObject is accompanied by dispose.
• [x] All classes that require a dispose function should have one. This should expose a public dispose function that calls this.dispose{{CLASS_NAME}}(), where dispose{{CLASS_NAME}} is a private function declared in the constructor. {{CLASS_NAME}} should exactly match the class name.
• [x] ❌ See #463. All classes that are not disposable should either (a) use isDisposable: false, or (b) implement a dispose method that calls Disposable.assertNotDisposable. Use (a) for classes that inherit a dispose method. Use (b) for classes that do not inherit a dispose method.

Performance

• [x] Play with sim, identify any obvious performance issues. Examples: animation that slows down with large numbers of objects; animation that pauses or "hitches" during garbage collection.

Usability

• [x] Are UI components sufficiently responsive? (especially continuous UI components, such as sliders)
• [x] ⚠️ See #484. Are pointer areas optimized, especially for touch? (run with query parameter showPointerAreas)
• [x] Do pointer areas overlap? (run with query parameter showPointerAreas) Overlap may be OK in some cases, depending on the z-ordering (if the front-most object is supposed to occlude pointer areas) and whether objects can be moved.

Internationalization

• [x] Does the sim behave correctly with dynamic layout, to support dynamic locale? Run with stringTest=dynamic and use the left/right arrow keys.
• [x] Are there any strings that are not internationalized, and does the sim layout gracefully handle internationalized strings that are shorter than the English strings? (run with query parameter stringTest=X. You should see nothing but 'X' strings.)
• [x] Does the sim layout gracefully handle internationalized strings that are longer than the English strings? (run with query parameters stringTest=double and stringTest=long)
• [x] Does the sim stay on the sim page (doesn't redirect to an external page) when running with the query parameter stringTest=xss? This test passes if sim does not redirect, OK if sim crashes or fails to fully start. Only test on one desktop platform. For PhET-iO sims, additionally test ?stringTest=xss in Studio to make sure i18n strings didn't leak to phetioDocumentation, see https://github.com/phetsims/phet-io/issues/1377
• [x] ⚠️ See #465. Avoid using concatenation to create strings that will be visible in the user interface. Use StringUtils.fillIn and a string pattern to ensure that strings are properly localized.
• [x] Use named placeholders (e.g. "{{value}} {{units}}") instead of numbered placeholders (e.g. "{0} {1}").

• [x] ⚠️ See #473. Make sure the string keys are all perfect. They are difficult to change after 1.0.0 is published. They should be literal, they should be explicit, and they should be consistent. This will also be the PhET-iO phetioID name in Studio etc. Guidelines for string keys are:

  (1) Strings keys should generally match their values. E.g.:

  "helloWorld": {
  value: "Hello World!"
  },
  "quadraticTerms": {
  value: "Quadratic Terms"
  }

  (2) If a string key would be exceptionally long, use a key name that is an abbreviated form of the string value, or that captures the purpose/essence of the value. E.g.:

  // key is abbreviated
  "iWentToTheStore": {
  value: "I went to the store to get milk, eggs, butter, and sugar."
  },
  
  // key is based on purpose
  "describeTheScreen": {
  value: "The Play Area is a small room. The Control Panel has buttons, a checkbox, and radio buttons to change conditions in the room."
  }

  (3) If string key names would collide, use your judgment to disambiguate. E.g.:

  "simplifyTitle": {
   value: "Simplify!"
  },
  "simplifyCheckbox": {
   value: "simplify"
  }

  (4) String keys for screen names should have the general form "screen.{{screenName}}". E.g.:

  "screen.explore": {
    "value": "Explore"
  },

  (5) String patterns that contain placeholders (e.g. "My name is {{first}} {{last}}") should use keys that are unlikely to conflict with strings that might be needed in the future. For example, for "{{price}}" consider using key "pricePattern" instead of "price", if you think there might be a future need for a "price" string. (6) It is acceptable to prefix families of strings with a prefix, like so:

  "material.water": {
    "value": "Water"
  },
  "material.wood": {
    "value": "Wood"
  },
  "shape.block": {
    "value": "Block"
  },
  "shape.cone": {
    "value": "Cone"
  },

Nested substructure is not yet fully supported.

• [x] ⚠️ See #467. If the sim was already released, make sure none of the original string keys have changed. If they have changed, make sure any changes have a good reason and have been discussed with @jbphet (it is likely that an issue like https://github.com/phetsims/gravity-force-lab/issues/166 should be created).

Repository Structure

• [x] The repository name should correspond to the sim title. For example, if the sim title is "Wave Interference", then the repository name should be "wave-interference".

• [x] Are all required files and directories present? For a sim repository named “my-repo”, the general structure should look like this (where assets/, images/, mipmaps/ or sounds/ may be omitted if the sim doesn’t have those types of resource files).

  my-repo/
  assets/
  doc/
    images/
      *see annotation
    model.md
    implementation-notes.md
  images/
    license.json
  js/
    (see section below)
  mipmaps/
    license.json
  sound/
    license.json
  dependencies.json
  .gitignore
  my-repo_en.html
  my-repo-strings_en.json
  Gruntfile.js
  LICENSE
  package.json
  README.md

  *Any images used in model.md or implementation-notes.md should be added here. Images specific to aiding with documentation do not need their own license.

• [x] Verify that the same image file is not present in both images/ and mipmaps/. If you need a mipmap, use it for all occurrences of the image.

• [x] Is the js/ directory properly structured? All JavaScript source should be in the js/ directory. There should be a subdirectory for each screen (this also applies for single-screen sims, where the subdirectory matches the repo name). For a multi-screen sim, code shared by 2 or more screens should be in a js/common/ subdirectory. Model and view code should be in model/ and view/ subdirectories for each screen and common/. For example, for a sim with screens “Introduction” and “Lab”, the general directory structure should look like this:

  my-repo/
  js/
  common/
    model/
    view/
  introduction/
    model/
    view/
  lab/
    model/
    view/
  my-repo-main.js
  myRepo.js
  myRepoStrings.js

• [x] Do filenames use an appropriate prefix? Some filenames may be prefixed with the repository name, e.g. MolarityConstants.js in molarity. If the repository name is long, the developer may choose to abbreviate the repository name, e.g. EEConstants.js in expression-exchange. If the abbreviation is already used by another repository, then the full name must be used. For example, if the "EE" abbreviation is already used by expression-exchange, then it should not be used in equality-explorer. Whichever convention is used, it should be used consistently within a repository - don't mix abbreviations and full names. The abbreviation should be all uppercase letters; e.g. MOTHAConstants, not MotHAConstants for "Model of the Hydrogen Atom".

• [x] Is there a file in assets/ for every resource file in sound/ and images/? Note that there is not necessarily a 1:1 correspondence between asset and resource files; for example, several related images may be in the same .ai file. Check license.json for possible documentation of why some resources might not have a corresponding asset file.

• [x] ❌ See #466 and #468 For simulations, was the README.md generated by grunt published-README or grunt unpublished-README? Common code repos can have custom README files.

• [x] Does package.json refer to any dependencies that are not used by the sim?

• [x] Is the LICENSE file correct? (Generally GPL v3 for sims and MIT for common code, see this thread for additional information).

• [x] Does .gitignore match the one in simula-rasa?

• [x] In GitHub, verify that all non-release branches have an associated issue that describes their purpose.

• [x] Are there any GitHub branches that are no longer needed and should be deleted?

• [x] Sim-specific query parameters (if any) should be identified and documented in one .js file in js/common/ or js/ (if there is no common/). The .js file should be named {{PREFIX}}QueryParameters.js, for example ArithmeticQueryParameters.js for the arithmetic repository, or FBQueryParameters.js for Function Builder (where the FB prefix is used).

• [x] Query parameters that are public-facing should be identified using public: true in the schema.

• [x] All sims should use a color file named MyRepoColors.js or, if using abbreviations, MRColors.js, and use ProfileColorProperty where appropriate, even if they have a single (default) profile (to support color editing and PhET-iO Studio). The ColorProfile pattern was converted to *Colors.js files in https://github.com/phetsims/scenery-phet/issues/515. Please see GasPropertiesColors.jtfor a good example.

Coding Conventions

• [x] Are coding conventions outlined in PhET's Coding Conventions Document followed and adhered to This document deals with PhET coding conventions. You do not need to exhaustively check every item in this section, nor do you necessarily need to check these items one at a time. The goal is to determine whether the code generally meets PhET standards.

TypeScript Conventions

• [x] Are TypeScript conventions outlined in the TypeScript Conventions Document followed and adhered to?

Math Libraries

• [x] DOT/Utils.toFixed or DOT/Utils.toFixedNumber should be used instead of toFixed. JavaScript's toFixed is notoriously buggy. Behavior differs depending on browser, because the spec doesn't specify whether to round or floor.

IE11

• [x] IE is no longer supported. With that in mind remove IE-specific workarounds
• [x] Use string.includes and string.startsWith where possible.

Organization, Readability, and Maintainability

• [x] Does the organization and structure of the code make sense? Do the model and view contain types that you would expect (or guess!) by looking at the sim? Do the names of things correspond to the names that you see in the user interface?
• [x] Are appropriate design patterns used? See phet-software-design-patterns.md. If new or inappropriate patterns are identified, create an issue.
• [x] Is inheritance used where appropriate? Does the type hierarchy make sense?
• [x] Is composition favored over inheritance where appropriate? See https://en.wikipedia.org/wiki/Composition_over_inheritance.
• [x] ❌ See #485, #491, #492, #494. Is there any unnecessary coupling? (e.g., by passing large objects to constructors, or exposing unnecessary properties/functions). In TypeScript, you can decouple by narrowing the API like so:

  public constructor( tickMarksVisibleProperty: Property<boolean>,
                    model: Pick<IntroModel, 'changeWaterLevel'>, // <-- Note the call site can pass the whole model, but we declare we will only use this part of it
                    waterCup: WaterCup, modelViewTransform: ModelViewTransform2,
                    providedOptions?: WaterCup3DNodeOptions ) {

• [x] Is there too much unnecessary decoupling? (e.g. by passing all of the properties of an object independently instead of passing the object itself)?
• [x] Are the source files reasonable in size? Scrutinize large files with too many responsibilities - can responsibilities be broken into smaller delegates? To see file sizes for TypeScript sims, run this shell command:

  cd {{repo}}/js ; wc -l `find . -name "*.ts" -print` | sort

• [x] ⚠️ See #474, #475, #476, #478, #480. Are any significant chunks of code duplicated? In addition to manual identification, tools include: WebStorm Code > Analyze Code > Locate Duplicates and https://github.com/danielstjules/jsinspect.
• [x] Is there anything that should be generalized and migrated to common code?
• [x] Are there any TODO or FIXME or REVIEW comments in the code? They should be addressed or promoted to GitHub issues. SR: Yes, they are tracked in TODO and in issues (issue URL listed in the TODO)
• [x] Are there any magic numbers that should be factored out as constants and documented?
• [x] Are there any constants that are duplicated in multiple files that should be factored out into a {{REPO}}Constants.js file?
• [x] Does the implementation rely on any specific constant values that are likely to change in the future? Identify constants that might be changed in the future. (Use your judgement about which constants are likely candidates.) Does changing the values of these constants break the sim? For example, see https://github.com/phetsims/plinko-probability/issues/84.
• [x] ⚠️ See #471. Is PhetColorScheme used where appropriate? Verify that the sim is not inventing/creating its own colors for things that have been standardized in PhetColorScheme. Identify any colors that might be worth adding to PhetColorScheme.
• [x] Are all dependent Properties modeled as DerivedProperty instead of Property?
• [x] All dynamics should be called from Sim.step(dt), do not use window.setTimeout or window.setInterval. This will help support Legends of Learning and PhET-iO.

Accessibility

This section may be omitted if the sim has not been instrumented with accessibility features. Accessibility includes various features, not all are always include. Ignore sections that do not apply.

General

• [x] Are accessibility features integrated well into the code? They should be added in a maintainable way, even if that requires upfront refactoring.

Alternative Input

• [x] Does the sim pass an accessibility fuzz test? (run with query parameters fuzzBoard&ea)
• [x] ⚠️ According to implementation-notes.md, "This simulation does not use hotkeys." Does this sim use specific keyboard shortcuts that overlap with global shortcuts? This includes the use of modifier keys like in https://github.com/phetsims/ratio-and-proportion/issues/287. NOTE: There is currently no list of global shortcuts, and therefore no way to complete this checklist item. See https://github.com/phetsims/phet-info/issues/188.

PhET-iO

This section may be omitted if the sim has not been instrumented for PhET-iO, but is likely good to glance at no matter.

• [x] Does instrumentation follow the conventions described in PhET-iO Instrumentation Guide? This could be an extensive bullet. At the very least, be sure to know what amount of instrumentation this sim supports. Describing this further goes beyond the scope of this document.
• [x] PhET-iO instantiates different objects and wires up listeners that are not present in the PhET-branded simulation. It needs to be tested separately for memory leaks. To help isolate the nature of the memory leak, this test should be run separately from the PhET brand memory leak test. Test with a colorized Data Stream, and Studio (easily accessed from phetmarks). Compare to testing results done by the responsible developer and previous releases.
• [x] Make sure unused PhetioObject instances are disposed, which unregisters their tandems.
• [x] Make sure JOIST dt values are used instead of Date.now() or other Date functions. Perhaps try phet.joist.elapsedTime. Though this has already been mentioned, it is necessary for reproducible playback via input events and deserves a comment in this PhET-iO section.
• [x] Are random numbers using DOT/dotRandom as an imported module (not a global), and all doing so after modules are declared (non-statically)? For example, the following methods (and perhaps others) should not be used: Math.random, _.shuffle, _.sample, _.random. This also deserves re-iteration due to its effect on record/playback for PhET-iO.
• [x] Like JSON, keys for undefined values are omitted when serializing objects across frames. Consider this when determining whether toStateObject should use null or undefined values.
• [x] ⚠️ See #482. PhET prefers to use the term "position" to refer to the physical (x,y) position of objects. This applies to both brands, but is more important for the PhET-iO API. See https://github.com/phetsims/phet-info/issues/126
• [x] Are your IOType state methods violating the API of the core type by accessing private fields?
• [x] ⚠️ See #483. When defining a boolean Property to indicate whether something is enabled, use AXON/EnabledProperty. This should be done in both the model and the view. If you're using a DerivedProperty, skip this item.
• [x] Do not use translated strings in phetioDocumentaton - it changes the PhET-iO API!

[pixelzoom]

Code review is done. This is a fun sim, in nice shape.

See ❌ and ⚠️ in the checklist above for notes about issues encountered during review.

Let me know if you have questions about any of the GitHub issues.

[matthew-blackman]

@samreid @marlitas and I went through the checklist from @pixelzoom and noted that all items marked with a ❌ or ⚠️ are being tracked in separate issues. We feel that this issue can be closed.