Add descriptions for EdgeTypes (#1074)

* Add descriptions for EdgeTypes

* Displays edge and node description tooltip in weight configuration UI

* Update tests

src/analysis/fallbackDeclaration.js

@@ -23,6 +23,8 @@ export const fallbackEdgeType: EdgeType = Object.freeze({
   defaultForwardWeight: 1,
   defaultBackwardWeight: 1,
   prefix: EdgeAddress.empty,
+  description:
+    "The fallback EdgeType for edges which don't have any other type",
 });
 
 export const fallbackDeclaration: PluginDeclaration = Object.freeze({

src/analysis/types.js

@@ -96,4 +96,7 @@ export type EdgeType = {|
   // of this EdgeType. A given edge `e` is a member of the type `t` if
   // `EdgeAddress.hasPrefix(e.address, t.prefix) == true`
   +prefix: EdgeAddressT,
+  // The `description` property should be a human-readable string that makes
+  // it clear to a user what each EdgeType does
+  +description: string,
 |};

src/explorer/pagerankTable/Aggregation.test.js

@@ -157,6 +157,7 @@ describe("explorer/pagerankTable/Aggregation", () => {
       defaultForwardWeight: 1,
       defaultBackwardWeight: 1,
       prefix: EdgeAddress.fromParts(["look", "like"]),
+      description: "TODO: Add a description for this EdgeType",
     };
     function aggView(aggregation: FlatAggregation) {
       const el = shallow(<AggregationView aggregation={aggregation} />);

src/explorer/pagerankTable/aggregate.test.js

@@ -66,6 +66,7 @@ describe("explorer/pagerankTable/aggregate", () => {
         defaultForwardWeight: 1,
         defaultBackwardWeight: 1,
         prefix: EdgeAddress.fromParts(["foo"]),
+        description: "TODO: Add a description for this EdgeType",
       },
       bar: {
         forwardName: "bars",
@@ -73,6 +74,7 @@ describe("explorer/pagerankTable/aggregate", () => {
         defaultForwardWeight: 1,
         defaultBackwardWeight: 1,
         prefix: EdgeAddress.fromParts(["bar"]),
+        description: "TODO: Add a description for this EdgeType",
       },
       empty: {
         forwardName: "empty",
@@ -80,6 +82,7 @@ describe("explorer/pagerankTable/aggregate", () => {
         defaultForwardWeight: 1,
         defaultBackwardWeight: 1,
         prefix: EdgeAddress.empty,
+        description: "TODO: Add a description for this EdgeType",
       },
     };
     const edgeTypesArray = [edgeTypes.foo, edgeTypes.bar];

src/explorer/weights/EdgeTypeConfig.js

@@ -15,6 +15,7 @@ export class EdgeTypeConfig extends React.Component<{
         <EdgeWeightSlider
           name={this.props.weightedType.type.backwardName}
           weight={this.props.weightedType.forwardWeight}
+          description={this.props.weightedType.type.description}
           onChange={(forwardWeight) => {
             this.props.onChange({
               ...this.props.weightedType,
@@ -25,6 +26,7 @@ export class EdgeTypeConfig extends React.Component<{
         <EdgeWeightSlider
           name={this.props.weightedType.type.forwardName}
           weight={this.props.weightedType.backwardWeight}
+          description={this.props.weightedType.type.description}
           onChange={(backwardWeight) => {
             this.props.onChange({
               ...this.props.weightedType,
@@ -57,6 +59,7 @@ export class EdgeWeightSlider extends React.Component<WeightSliderProps> {
       <WeightSlider
         name={modifiedName}
         weight={this.props.weight}
+        description={this.props.description}
         onChange={this.props.onChange}
       />
     );

src/explorer/weights/EdgeTypeConfig.test.js

@@ -54,7 +54,12 @@ describe("explorer/weights/EdgeTypeConfig", () => {
     function example() {
       const onChange = jest.fn();
       const element = shallow(
-        <EdgeWeightSlider weight={3} name="foo" onChange={onChange} />
+        <EdgeWeightSlider
+          weight={3}
+          name="foo"
+          description="Description for test slider"
+          onChange={onChange}
+        />
       );
       const weightSlider = element.find(WeightSlider);
       return {element, onChange, weightSlider};

src/explorer/weights/NodeTypeConfig.js

@@ -13,6 +13,7 @@ export class NodeTypeConfig extends React.Component<{
       <WeightSlider
         name={this.props.weightedType.type.name}
         weight={this.props.weightedType.weight}
+        description={this.props.weightedType.type.description}
         onChange={(weight) => {
           this.props.onChange({
             ...this.props.weightedType,

src/explorer/weights/WeightSlider.js

@@ -6,11 +6,12 @@ export type Props = {|
   +weight: number,
   +name: React$Node,
   +onChange: (number) => void,
+  +description: string,
 |};
 export class WeightSlider extends React.Component<Props> {
   render() {
     return (
-      <label style={{display: "flex"}}>
+      <label style={{display: "flex"}} title={this.props.description}>
         <span style={{flexGrow: 1}}>{this.props.name}</span>
         <input
           type="range"

src/explorer/weights/WeightSlider.test.js

@@ -12,7 +12,12 @@ describe("explorer/weights/WeightSlider", () => {
     function example() {
       const onChange = jest.fn();
       const element = shallow(
-        <WeightSlider weight={3} name="foo" onChange={onChange} />
+        <WeightSlider
+          weight={3}
+          name="foo"
+          description="Description for test slider"
+          onChange={onChange}
+        />
       );
       return {element, onChange};
     }

src/plugins/demo/declaration.js

@@ -28,6 +28,7 @@ export const assemblesEdgeType: EdgeType = Object.freeze({
   backwardName: "is assembled by",
   defaultBackwardWeight: 2 ** -2,
   prefix: EdgeAddress.fromParts(["factorio", "assembles"]),
+  description: "TODO: Add a description for this EdgeType",
 });
 
 export const transportsEdgeType: EdgeType = Object.freeze({
@@ -36,6 +37,7 @@ export const transportsEdgeType: EdgeType = Object.freeze({
   backwardName: "is transported by",
   defaultBackwardWeight: 2 ** -1,
   prefix: EdgeAddress.fromParts(["factorio", "transports"]),
+  description: "TODO: Add a description for this EdgeType",
 });
 
 export const declaration: PluginDeclaration = Object.freeze({

src/plugins/git/declaration.js

@@ -19,6 +19,7 @@ const hasParentEdgeType = Object.freeze({
   prefix: E.Prefix.hasParent,
   defaultForwardWeight: 1,
   defaultBackwardWeight: 1,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const nodeTypes = Object.freeze([commitNodeType]);

src/plugins/github/declaration.js

@@ -76,6 +76,7 @@ const authorsEdgeType = Object.freeze({
   defaultForwardWeight: 1 / 2,
   defaultBackwardWeight: 1,
   prefix: E.Prefix.authors,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const hasParentEdgeType = Object.freeze({
@@ -84,6 +85,7 @@ const hasParentEdgeType = Object.freeze({
   defaultForwardWeight: 1,
   defaultBackwardWeight: 1 / 4,
   prefix: E.Prefix.hasParent,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const mergedAsEdgeType = Object.freeze({
@@ -92,6 +94,7 @@ const mergedAsEdgeType = Object.freeze({
   defaultForwardWeight: 1 / 2,
   defaultBackwardWeight: 1,
   prefix: E.Prefix.mergedAs,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const referencesEdgeType = Object.freeze({
@@ -100,6 +103,7 @@ const referencesEdgeType = Object.freeze({
   defaultForwardWeight: 1,
   defaultBackwardWeight: 1 / 16,
   prefix: E.Prefix.references,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const mentionsAuthorEdgeType = Object.freeze({
@@ -109,6 +113,7 @@ const mentionsAuthorEdgeType = Object.freeze({
   // TODO(#811): Probably change this to 0
   defaultBackwardWeight: 1 / 32,
   prefix: E.Prefix.mentionsAuthor,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const reactsHeartEdgeType = Object.freeze({
@@ -118,6 +123,7 @@ const reactsHeartEdgeType = Object.freeze({
   // TODO(#811): Probably change this to 0
   defaultBackwardWeight: 1 / 32,
   prefix: E.Prefix.reactsHeart,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const reactsThumbsUpEdgeType = Object.freeze({
@@ -127,6 +133,7 @@ const reactsThumbsUpEdgeType = Object.freeze({
   // TODO(#811): Probably change this to 0
   defaultBackwardWeight: 1 / 32,
   prefix: E.Prefix.reactsThumbsUp,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const reactsHoorayEdgeType = Object.freeze({
@@ -136,6 +143,7 @@ const reactsHoorayEdgeType = Object.freeze({
   // TODO(#811): Probably change this to 0
   defaultBackwardWeight: 1 / 32,
   prefix: E.Prefix.reactsHooray,
+  description: "TODO: Add a description for this EdgeType",
 });
 
 const reactsRocketEdgeType = Object.freeze({