Update doc strings and give the action creator a more specific name.

canonical · Apr 17, 2020 · 3d4d50c · 3d4d50c
1 parent f3c98e8
commit 3d4d50c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/ui/src/app/base/sagas/actions.js b/ui/src/app/base/sagas/actions.js
@@ -11,7 +11,7 @@ import {
  * @param {Array} machines - A list of machine ids.
  * @returns {Array} The list of action creator functions.
  */
-export const generateActionCreators = (machines) =>
+export const generateMachinePoolActionCreators = (machines) =>
   machines.map((machineID) => (result) =>
     machineActions.setPool(machineID, result.id)
   );
@@ -28,7 +28,7 @@ export function* createPoolWithMachines(
   { payload }
 ) {
   const { machines, pool } = payload.params;
-  const actionCreators = yield call(generateActionCreators, machines);
+  const actionCreators = yield call(generateMachinePoolActionCreators, machines);
   // Send the initial action via the websocket.
   yield call(
     sendMessage,

diff --git a/ui/src/app/base/sagas/actions.test.js b/ui/src/app/base/sagas/actions.test.js
@@ -1,7 +1,7 @@
 import { expectSaga } from "redux-saga-test-plan";
 import * as matchers from "redux-saga-test-plan/matchers";
 
-import { createPoolWithMachines, generateActionCreators } from "./actions";
+import { createPoolWithMachines, generateMachinePoolActionCreators } from "./actions";
 
 jest.mock("../../../websocket-client");
 
@@ -13,7 +13,7 @@ describe("websocket sagas", () => {
     const pool = { name: "pool1", description: "a pool" };
     const action = { payload: { params: { machines: ["machine1"], pool } } };
     return expectSaga(createPoolWithMachines, socketClient, sendMessage, action)
-      .provide([[matchers.call.fn(generateActionCreators), actionCreators]])
+      .provide([[matchers.call.fn(generateMachinePoolActionCreators), actionCreators]])
       .call(
         sendMessage,
         socketClient,

diff --git a/ui/src/app/base/sagas/websockets.js b/ui/src/app/base/sagas/websockets.js
@@ -199,7 +199,8 @@ function* storeNextActions(nextActionCreators, requestIDs) {
  *
  * @param {Object} response - A websocket response.
  */
-export function* handleNextActions({ request_id, result }) {
+export function* handleNextActions(response) {
+  const { request_id, result } = response;
   const actionCreators = yield call(getNextActions, request_id);
   if (actionCreators && actionCreators.length) {
     for (let actionCreator of actionCreators) {
@@ -339,6 +340,8 @@ export function* sendMessage(socketClient, action, nextActionCreators) {
 
 /**
  * Connect to the WebSocket and watch for message.
+ * @param {Array} messageHandlers - Sagas that should handle specific messages
+ * via the websocket channel.
  */
 export function* setupWebSocket(messageHandlers = []) {
   try {