From f8c659a413f756fc725d61ef15c7b72cbc5c59da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dandelion=20Man=C3=A9?= <decentralion@dandelion.io>
Date: Fri, 17 May 2019 17:07:00 +0300
Subject: [PATCH] Rename `ScoredNode.node -> ScoredNode.address` (#1140)

It makes more sense that a ScoredNode has an address than that it has a
sub-node (which is an address).

Test plan: It's a simple field rename; `yarn test` suffices
---
 src/core/pagerankGraph.js      |  6 +++---
 src/core/pagerankGraph.test.js | 30 +++++++++++++++---------------
 2 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/src/core/pagerankGraph.js b/src/core/pagerankGraph.js
index 2fcbf87..d3bcae7 100644
--- a/src/core/pagerankGraph.js
+++ b/src/core/pagerankGraph.js
@@ -36,7 +36,7 @@ export type {EdgeWeight} from "./attribution/graphToMarkovChain";
 export type EdgeEvaluator = (Edge) => EdgeWeight;
 
 export type ScoredNode = {|
-  +node: NodeAddressT,
+  +address: NodeAddressT,
   +score: number,
 |};
 
@@ -259,7 +259,7 @@ export class PagerankGraph {
   *_nodesIterator(iterator: Iterator<NodeAddressT>): Iterator<ScoredNode> {
     for (const node of iterator) {
       const score = NullUtil.get(this._scores.get(node));
-      yield {node, score};
+      yield {address: node, score};
     }
   }
 
@@ -287,7 +287,7 @@ export class PagerankGraph {
     if (score == null) {
       return null;
     } else {
-      return {node: x, score};
+      return {address: x, score};
     }
   }
 
diff --git a/src/core/pagerankGraph.test.js b/src/core/pagerankGraph.test.js
index 2e76305..54f9892 100644
--- a/src/core/pagerankGraph.test.js
+++ b/src/core/pagerankGraph.test.js
@@ -60,14 +60,14 @@ describe("core/pagerankGraph", () => {
       const g = advancedGraph().graph1();
       const pg = new PagerankGraph(g, defaultEvaluator);
       const graphNodes = Array.from(g.nodes());
-      const pgNodes = Array.from(pg.nodes()).map((x) => x.node);
+      const pgNodes = Array.from(pg.nodes()).map((x) => x.address);
       expect(graphNodes.length).toEqual(pgNodes.length);
       expect(new Set(graphNodes)).toEqual(new Set(pgNodes));
     });
     it("node and nodes both return consistent scores", async () => {
       const pg = await convergedPagerankGraph();
-      for (const {node, score} of pg.nodes()) {
-        expect(score).toEqual(NullUtil.get(pg.node(node)).score);
+      for (const {address, score} of pg.nodes()) {
+        expect(score).toEqual(NullUtil.get(pg.node(address)).score);
       }
     });
     it("node and nodes both throw an error if underlying graph is modified", () => {
@@ -103,7 +103,7 @@ describe("core/pagerankGraph", () => {
 
       pagerankGraphNodes.forEach(
         (pgNode, i) =>
-          expect(pgNode.node).toEqual(graphNodes[i]) &&
+          expect(pgNode.address).toEqual(graphNodes[i]) &&
           expect(pgNode.score).toBe(0.25)
       );
     }
@@ -223,8 +223,8 @@ describe("core/pagerankGraph", () => {
         zeroEvaluator,
         syntheticLoopWeight
       );
-      for (const {node} of pg.nodes()) {
-        expect(pg.totalOutWeight(node)).toEqual(syntheticLoopWeight);
+      for (const {address} of pg.nodes()) {
+        expect(pg.totalOutWeight(address)).toEqual(syntheticLoopWeight);
       }
     });
     it("outWeight is computed correctly after JSON deserialization", () => {
@@ -403,7 +403,7 @@ describe("core/pagerankGraph", () => {
               );
               const gNeighbors = Array.from(graph.neighbors(target, options));
               const reducedPrgNeighbors = prgNeighbors.map((s) => ({
-                node: s.scoredNode.node,
+                node: s.scoredNode.address,
                 edge: s.weightedEdge.edge,
               }));
               expect(gNeighbors).toEqual(reducedPrgNeighbors);
@@ -422,7 +422,7 @@ describe("core/pagerankGraph", () => {
     });
     it("neighbor's scored contributions are computed correctly", async () => {
       const pg = await convergedPagerankGraph();
-      for (const {node: target} of pg.nodes()) {
+      for (const {address: target} of pg.nodes()) {
         for (const {
           scoredNode,
           weightedEdge,
@@ -436,7 +436,7 @@ describe("core/pagerankGraph", () => {
             rawWeight += weightedEdge.weight.froWeight;
           }
           const normalizedWeight =
-            rawWeight / pg.totalOutWeight(scoredNode.node);
+            rawWeight / pg.totalOutWeight(scoredNode.address);
           expect(scoreContribution).toEqual(
             scoredNode.score * normalizedWeight
           );
@@ -445,9 +445,9 @@ describe("core/pagerankGraph", () => {
     });
     it("synthetic score contributions are computed correctly", async () => {
       const pg = await convergedPagerankGraph();
-      for (const {node, score} of pg.nodes()) {
-        expect(pg.syntheticLoopScoreContribution(node)).toEqual(
-          (score * pg.syntheticLoopWeight()) / pg.totalOutWeight(node)
+      for (const {address, score} of pg.nodes()) {
+        expect(pg.syntheticLoopScoreContribution(address)).toEqual(
+          (score * pg.syntheticLoopWeight()) / pg.totalOutWeight(address)
         );
       }
     });
@@ -456,13 +456,13 @@ describe("core/pagerankGraph", () => {
       // neighbors (need to add the edge toWeight and froWeight if the neighbor
       // is a loop).
       const pg = await convergedPagerankGraph();
-      for (const {node, score} of pg.nodes()) {
+      for (const {address, score} of pg.nodes()) {
         // We need to include the score that came from the synthetic loop edge
         // (should be near zero for non-isolated nodes)
         let summedScoreContributions: number = pg.syntheticLoopScoreContribution(
-          node
+          address
         );
-        for (const scoredNeighbor of pg.neighbors(node, allNeighbors())) {
+        for (const scoredNeighbor of pg.neighbors(address, allNeighbors())) {
           summedScoreContributions += scoredNeighbor.scoreContribution;
         }
         expect(summedScoreContributions).toBeCloseTo(score);