pixelzoom
commented
3 years ago This sim is ready for code review. All code has been cleaned up, and I completed a "self code review" in https://github.com/phetsims/fourier-making-waves/issues/163.
This is a big sim, ~15,000 lines of code. It makes heavy use of bamboo charts, and it has a relatively involved model. It will take some time to review. Definitely start by reading model.md and implementation-notes.md.
In order to stay on track for 9/30/21 publication, this code review needs to be completed no later than 9/13/2021.
@kathy-phet @arouinfar please assign a reviewer.
kathy-phet
jonathanolson
PhET Code-Review Checklist (a.k.a "CRC")
// REVIEWcomments in the codeGitHub 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.
brands=phet, see #130Build and Run Checks
If any of these items fail, pause code review.
ea)fuzz&ea)ea&shuffleListenersandea&shuffleListeners&fuzz)?deprecationWarnings. Do not use deprecated methods in new code. See https://github.com/phetsims/vegas/issues/95, vegas.RewardNode uses deprecated Node.toImage.`Memory Leaks
grunt --minify.mangle=false. Compare to testing results done by the responsible developer. Results can be found in #130.disposefunction, or is it obvious why it isn't necessary, or is there documentation about whydisposeisn't called? An example of why no call todisposeis needed is if the component is used in aScreenViewthat would never be removed from the scene graph.Property.linkorlazyLinkis accompanied byunlink.Property.multilinkis accompanied byunmultilink.Multilinkis accompanied bydispose.DerivedPropertyis accompanied bydispose.Emitter.addListeneris accompanied byremoveListener.ObservableArrayDef.element*Emitter.addListeneris accompanied byObservableArrayDef.element*Emitter.removeListenerNode.addInputListeneris accompanied byremoveInputListenerPhetioObjectis accompanied bydispose.disposefunction have one? This should expose a publicdisposefunction that callsthis.disposeMyType(), wheredisposeMyTypeis a private function declared in the constructor.MyTypeshould exactly match the filename.Performance
webgl=false)Usability
showPointerAreas)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
stringTest=X. You should see nothing but 'X' strings.)stringTest=doubleandstringTest=long)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=xssin Studio to make sure i18n strings didn't leak to phetioDocumentation, see https://github.com/phetsims/phet-io/issues/1377StringUtils.fillInand a string pattern to ensure that strings are properly localized."{{value}} {{units}}") instead of numbered placeholders (e.g."{0} {1}").[x] Make sure the string keys are all perfect, because they are difficult to change after 1.0.0 is published. Guidelines for string keys are:
(1) Strings keys should generally match their values. E.g.:
(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.:
(3) If string key names would collide, use your judgment to disambiguate. E.g.:
(4) String keys for screen names should have the general form
"screen.{{screenName}}". E.g.:(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:Nested substructure is not yet fully supported.
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).
*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:
[x] Do filenames use an appropriate prefix? Some filenames may be prefixed with the repository name, e.g.
MolarityConstants.jsin molarity. If the repository name is long, the developer may choose to abbreviate the repository name, e.g.EEConstants.jsin expression-exchange. If the abbreviation is already used by another respository, 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.[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 reesources might not have a corresponding asset file.
[x] Was the README.md generated by
grunt published-READMEorgrunt unpublished-README?[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] Does
model.mdadequately describe the model, in terms appropriate for teachers? https://github.com/phetsims/fourier-making-waves/issues/126[x] Does
implementation-notes.mdadequately describe the implementation, with an overview that will be useful to future maintainers? CODE REVIEWER: Please review implementation-notes and wrap up https://github.com/phetsims/fourier-making-waves/issues/127.[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 aritmetic repository, or FBQueryParameters.js for Function Builder (where theFBprefix is used).[x] Query parameters that are public-facing should be identified using
public: truein the schema.[x] All sims should use a color file named
MyRepoColors.jsor, if using abbreviations,MRColors.js, and useProfileColorPropertywhere appropriate, even if they have a single (default) profile (to support color editing and PhET-iO Studio). TheColorProfilepattern was converted to*Colors.jsfiles in https://github.com/phetsims/scenery-phet/issues/515. Please see [GasPropertiesColors.js](https://github.com/phetsims/gas -properties/blob/master/js/common/GasPropertiesColors.js) for a good example.Coding Conventions
This section 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.
[x] Is the code formatted according to PhET conventions? See phet-idea-code-style.xml for IntelliJ IDEA code style.
[x] Names (types, variables, properties, Properties, functions,...) should be sufficiently descriptive and specific, and should avoid non-standard abbreviations. For example:
[x] Verify that Best Practices for Modules are followed.
[x] For constructors, use parameters for things that don’t have a default. Use options for things that have a default value. This improves readability at the call site, especially when the number of parameters is large. It also eliminates order dependency that is required by using parameters.
For example, this constructor uses parameters for everything. At the call site, the semantics of the arguments are difficult to determine without consulting the constructor.
Here’s the same constructor with an appropriate use of options. The call site is easier to read, and the order of options is flexible.
[x] When options are passed through one constructor to another, a "nested options" pattern should be used. This helps to avoid duplicating option names and/or accidentally overwriting options for different components that use the same option names. Make sure to use PHETCORE/merge instead of `.extend
or_.merge.mergewill automatically recurse to keys named*Options` and extend those as well.Example:
A possible exception to this guideline is when the constructor API is improved by hiding the implementation details, i.e. not revealing that a sub-component exists. In that case, it may make sense to use new top-level options. This is left to developer and reviewer discretion.
For more information on the history and thought process around the "nested options" pattern, please see https://github.com/phetsims/tasks/issues/730.
[x] N/A If references are needed to the enclosing object, such as for a closure,
selfshould be defined, but it should only be used in closures. Theselfvariable should not be defined unless it is needed in a closure. Example:[x] Generally, lines should not exceed 120 columns. Break up long statements, expressions, or comments into multiple lines to optimize readability. It is OK for require statements or other structured patterns to exceed 120 columns. Use your judgment!
[x] Functions should be invoked using the dot operator rather than the bracket operator. For more details, please see https://github.com/phetsims/gravity-and-orbits/issues/9. For example:
[x] It is not uncommon to use conditional shorthand and short circuiting for invocation. Use parentheses to maximize readability.
If the expression is only one item, the parentheses can be omitted. This is the most common use case.
[x] Naming for Property values: All
AXON/Propertyinstances should be declared with the suffixProperty. For example, if a visible property is added, it should have the namevisiblePropertyinstead of simplyvisible. This will help to avoid confusion with non-Property definitions. Identify violations by searching for regular expression "= new .*Property".[x] Properties should use type-specific subclasses where appropriate (e.g. BooleanProperty, NumberProperty, StringProperty) or provide documentation as to why they are not.
[x] Are
Validatorvalidation options (valueType,validValues, etc...) utilized? These are supported in a number of core types likeEmitterandProperty. Is their presence or lack thereof properly documented?[x] Files should be named like
CapitalizedCamelCasing.jswhen returning a constructor, orlowerCaseCamelCasing.jswhen returning a non-constructor function or singleton. When returning a constructor or singleton, the constructor name should match the filename. Where singletons are treated like classes with static attributes (like SimulaRasaConstants or SimulaRasaColors), uppercase should be used.[x] Assertions should be used appropriately and consistently. Type checking should not just be done in code comments. Use
Array.isArrayto type check an array.[x] If you need to namespace an inner class, use
{{namespace}}.register, and include a comment about why the inner class needs to be namespaced. Use the form'{{outerClassname}}.{{innerClassname}}'for the key. For example:[x] Putting unused parameters in callbacks is up to developer discretion, as long they are correct wrt to the actual callback signature.
For example, both of these are acceptable:
This is not acceptable, because the 3rd parameter is incorrect.
[x] ES5 getters/setters defined in sims should be used judiciously when a Property exists, only when the benefit of conciseness outweighs the potential loss of readability. If ES5 getters/setters exist, try to not mix usage of them with Property access.
[x] The model and view code should be written such that it makes no assumptions about the animation frame rate this it will encounter. The default max dt (delta time) value is defined in
Screen.js, and smaller values should be used if the default is too large. There is no minimum value for dt, which implies that there is no maximum supported frame rate. The sim should be able to handle this. For an example of a problem that resulted from assuming that a max rate of 60 FPS would be the norm, please see this GitHub issue.Documentation
This section deals with PhET documentation 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.
[x] All classes, methods and properties are documented.
[x] Documentation at the top of .js files should provide an overview of purpose, responsibilies, and (where useful) examples of API use. If the file contains a subclass definition, it should indicate what functionality it adds to the superclass.
[x] The HTML5/CSS3/JavaScript source code must be reasonably well documented. This is difficult to specify precisely, but the idea is that someone who is moderately experienced with HTML5/CSS3/JavaScript can quickly understand the general function of the source code as well as the overall flow of the code by reading through the comments. For an example of the type of documentation that is required, please see the example-sim repository.
[x] Differentiate between
Propertyand "property" in comments. They are different things.Propertyis a type in AXON; property is any value associated with a JavaScript object. Often "field" can be used in exchange for "property" which can help with clarity. Search for "property" to identify violations.[x] N/A Classes that mix in traits or mixin should use the
@mixes MyTypeannotation.[x] Line comments should generally be preceded by a blank line. For example:
[x] When documenting conditionals (if/else statements), follow these guidlines:
ifin a conditional should be about the entire conditional, not just the if block.if/else if/elseand the comment), with a space below it as to not be confused with a comment about logic below.[x] Line comments should have whitespace between the
//and the first letter of the line comment. See the preceding example.[x] Do the
@authorannotations seem correct?[x] Constructor and function documentation. Parameter types and names should be clearly specified for each constructor and function using
@paramannotations. The description for each parameter should follow a hyphen. Primitive types should use lower case. For example:[x] For most functions, the same form as above should be used, with a
@returnsannotation which identifies the return type and the meaning of the returned value. Functions should also document any side effects. For extremely simple functions that are just a few lines of simple code, an abbreviated line-comment can be used, for example:// Computes {Number} distance based on {Foo} foo.[x] Abstract methods should be annotated with
@abstractand should typically throw an Error. For example:Type Expressions
This section deals with PhET conventions for type expressions. 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.
[x] Type expressions should conform approximately to Google Closure Compiler syntax. PhET stretches the syntax in many cases (beyond the scope of this document to describe).
[x] Prefer the most basic/restrictive type expression when defining APIs. For example, if a client only needs to know that a parameter is
{Node}, don’t describe the parameter as{Rectangle}.[x] All method parameters should have type expressions. For example
@param {number} width.[x] In sim-specific code, options and fields should have type expressions when their type is not obvious from the context. “Obvious” typically means that the value type is clearly shown in the righthand-side of the definition. E.g.
const width = 42clear shows thatwidthis{number}. E.g.const checkbox = new Checkbox(…)clearly shows thatcheckboxis{Checkbox}. If the type is obvious from the context, the developer may still provide a type expression at his/her discretion. Examples:[x] In common code repositories all options and fields should have type expressions, regardless of their visibility, and regardless whether their type is obvious from the context. If the same examples from above appeared in common code:
[x] Type expressions for Enumeration values should be annotated as instances of that Enumeration, see examples in https://github.com/phetsims/phet-core/blob/master/js/Enumeration.js for more.
[x] Type expressions for functions have a variety of possibilities, increasing in complexity depending on the case. In general note that
{function}is not enough information. Here are some better options:@param {function()} noParamsAndNoReturnValue@param {function(number)} giveMeNumberAndReturnNothing@param {function(number, number):Vector2} getVector2@param {function(new:Node)} createNode - a function that takes the Node constructor@param {function(model:MyModel, length:number, name:string): Node} getLengthNode@param {function(aSelfExplanatoryNameForAString:string): Node} getStringNode@param {function(model:MyModel, length:number, name:string): Node} getLengthNode - returns the length Node that you have always wanted, name is the name of the source of your aspirations, length is a special number according to the following 24 criteria. . .[x] Type expressions for anonymous Objects have a variety of possibilities, increasing in complexity depending on the case.
@param {Object} [options] // this is great because of the extend call 5 lines downObjectwith specific properties, name them and their types like so:@param {name:string, address:{street:string}, returnNode:function(number):Node, [shoeSize:number]} personalData // note that shoeSize is optional hereObjects, where each key is some type, and the value is another type. For key value pairs use this:{Object.<string, number>}Where keys are strings, and values are numbers.{Object.<phetioID:string, count:number>}- naming each of these can help identify them too. Feel free to explain in English after the type expression if needed.*Def.jsfile (especially is used in more than one file), or a@typedefdeclaration right above the jsdoc that uses the typedef.[x] Look for cases where the use of type expressions involving Property subclasses are incorrect. Because of the structure of the
Propertyclass hierarchy, specifying type-specific Properties ({BooleanProperty},{NumberProperty},...) may be incorrect, because it precludes values of type{DerivedProperty}and{DynamicProperty}. Similarly, use of{DerivedProperty}and{DynamicProperty}precludes values of (e.g.){BooleanProperty}. Especially in common code, using{Property.<TYPE>}is typically correct, unless some specific feature of thePropertysubclass is required. For example,{Property.<boolean>}instead of{BooleanProperty}.Visibility Annotations
This section deals with PhET conventions for visibility annotations. 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.
Because JavaScript lacks visibility modifiers (public, protected, private), PhET uses JSdoc visibility annotations to document the intent of the programmer, and define the public API. Visibility annotations are required for anything that JavaScript makes public. Information about these annotations can be found here. (Note that other documentation systems like the Google Closure Compiler use slightly different syntax in some cases. Where there are differences, JSDoc is authoritative. For example, use
Array.<Object>orObject[]instead ofArray<Object>). PhET guidelines for visibility annotations are as follows:[x] Use
@publicfor anything that is intended to be part of the public API.[x] Use
@protectedfor anything that is intended for use by subtypes.[x] Use
@privatefor anything that is NOT intended to be part of the public or protected API.[x] Put qualifiers in parenthesis after the annotation, for example:
@public (read-only). This indicates that the given Property (AND its value) should not be changed by outside code (e.g. a Property should not have its value changed)@public (scenery-internal)@public (a11y)@public (phet-io)@public (scenery-internal, read-only)[x] For JSDoc-style comments, the annotation should appear in context like this:
[x] For Line comments, the annotation can appear like this:
[x] Verify that every JavaScript property and function has a visibility annotation. Here are some helpful regular expressions to search for these declarations as PhET uses them.
x.y = something:[\w]+\.[\w]+\s=[\w]+: function\(Math Libraries
DOT/Utils.toFixedorDOT/Utils.toFixedNumbershould be used instead oftoFixed. JavaScript'stoFixedis notoriously buggy. Behavior differs depending on browser, because the spec doesn't specify whether to round or floor.IE11
string.includesandstring.startsWithwhere possible.Organization, Readability, and Maintainability
TODOorFIXMEorREVIEWcomments in the code? They should be addressed or promoted to GitHub issues.{{REPO}}Constants.jsfile?PhetColorScheme. Identify any colors that might be worth adding toPhetColorScheme.DerivedPropertyinstead ofProperty?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
Alternative Input
fuzzBoard&ea)Interactive Description
N/A
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.
PhetioObjectinstances are disposed, which unregisters their tandems.dtvalues are used instead ofDate.now()or other Date functions. Perhaps tryphet.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.DOT/dotRandomas 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.undefinedvalues are omitted when serializing objects across frames. Consider this when determining whethertoStateObjectshould usenullorundefinedvalues.AXON/EnabledProperty. This should be done in both the model and the view.