Don't save list in Field controllers (#2895)

keystonejs · May 5, 2020 · 72e0a4e · 72e0a4e
1 parent 547fd83
commit 72e0a4e
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 24 deletions.
diff --git a/.changeset/chatty-garlics-applaud.md b/.changeset/chatty-garlics-applaud.md
@@ -0,0 +1,6 @@
+---
+'@keystonejs/app-admin-ui': minor
+'@keystonejs/fields': minor
+---
+
+The base `FieldController` class no longer takes the owning list as a second argument.
diff --git a/packages/app-admin-ui/client/classes/List.js b/packages/app-admin-ui/client/classes/List.js
@@ -24,7 +24,7 @@ export default class List {
 
     this.fields = fields.map(fieldConfig => {
       const [Controller] = adminMeta.readViews([views[fieldConfig.path].Controller]);
-      return new Controller(fieldConfig, this, adminMeta, views[fieldConfig.path]);
+      return new Controller(fieldConfig, adminMeta, views[fieldConfig.path]);
     });
 
     this._fieldsByPath = arrayToObject(this.fields, 'path');

diff --git a/packages/fields/src/Controller.js b/packages/fields/src/Controller.js
@@ -1,14 +1,13 @@
 import isEqual from 'lodash.isequal';
 
 export default class FieldController {
-  constructor(config, list, adminMeta, views) {
+  constructor(config, adminMeta, views) {
     this.config = config;
     this.label = config.label;
     this.path = config.path;
     this.type = config.type;
     this.maybeAccess = config.access;
     this.isPrimaryKey = config.isPrimaryKey;
-    this.list = list;
     this.adminMeta = adminMeta;
     this.views = views;
 

diff --git a/packages/fields/tests/Controller.test.js b/packages/fields/tests/Controller.test.js
@@ -10,81 +10,72 @@ const config = {
 
 describe('new Controller()', () => {
   test('new Controller() - Smoke test', () => {
-    const controller = new FieldController(config, 'list', 'adminMeta');
+    const controller = new FieldController(config, 'adminMeta');
     expect(controller).not.toBeNull();
 
     expect(controller.config).toEqual(config);
     expect(controller.label).toEqual('label');
     expect(controller.type).toEqual('type');
-    expect(controller.list).toEqual('list');
     expect(controller.adminMeta).toEqual('adminMeta');
   });
 });
 
 test('getQueryFragment()', () => {
-  const controller = new FieldController(config, 'list', 'adminMeta');
+  const controller = new FieldController(config, 'adminMeta');
 
   const value = controller.getQueryFragment();
   expect(value).toEqual('path');
 });
 
 describe('serialize()', () => {
   test('serialize() - path exists', () => {
-    const controller = new FieldController(config, 'list', 'adminMeta');
+    const controller = new FieldController(config, 'adminMeta');
     let value = controller.serialize({ path: 'some_value' });
     expect(value).toEqual('some_value');
   });
 
   test('serialize() - path does not exist', () => {
-    const controller = new FieldController(config, 'list', 'adminMeta');
+    const controller = new FieldController(config, 'adminMeta');
     const value = controller.serialize({});
     expect(value).toEqual(null);
   });
 });
 
 describe('deserialize()', () => {
   test('deserialize() - path exists', () => {
-    const controller = new FieldController(config, 'list', 'adminMeta');
+    const controller = new FieldController(config, 'adminMeta');
     let value = controller.deserialize({ path: 'some_value' });
     expect(value).toEqual('some_value');
   });
 
   test('deserialize() - path does not exist', () => {
-    const controller = new FieldController(config, 'list', 'adminMeta');
+    const controller = new FieldController(config, 'adminMeta');
     const value = controller.deserialize({});
     expect(value).toEqual(undefined);
   });
 });
 
 describe('getDefaultValue()', () => {
   test('No default', () => {
-    const controller = new FieldController(config, 'list', 'adminMeta');
+    const controller = new FieldController(config, 'adminMeta');
     const value = controller.getDefaultValue({});
     expect(value).toEqual(undefined);
   });
 
   test('Default defined as `undefined`', () => {
-    const controller = new FieldController(
-      { ...config, defaultValue: undefined },
-      'list',
-      'adminMeta'
-    );
+    const controller = new FieldController({ ...config, defaultValue: undefined }, 'adminMeta');
     const value = controller.getDefaultValue({});
     expect(value).toEqual(undefined);
   });
 
   test('Default defined as `null`', () => {
-    const controller = new FieldController({ ...config, defaultValue: null }, 'list', 'adminMeta');
+    const controller = new FieldController({ ...config, defaultValue: null }, 'adminMeta');
     const value = controller.getDefaultValue({});
     expect(value).toEqual(null);
   });
 
   test('Default defined as a string', () => {
-    const controller = new FieldController(
-      { ...config, defaultValue: 'default' },
-      'list',
-      'adminMeta'
-    );
+    const controller = new FieldController({ ...config, defaultValue: 'default' }, 'adminMeta');
     const value = controller.getDefaultValue({});
     expect(value).toEqual('default');
   });
@@ -93,7 +84,6 @@ describe('getDefaultValue()', () => {
     test('function is executed', () => {
       const controller = new FieldController(
         { ...config, defaultValue: () => 'default' },
-        'list',
         'adminMeta'
       );
       const value = controller.getDefaultValue({});
@@ -104,7 +94,7 @@ describe('getDefaultValue()', () => {
       const originalInput = {};
       const prefill = {};
       const defaultValue = jest.fn(() => 'default');
-      const controller = new FieldController({ ...config, defaultValue }, 'list', 'adminMeta');
+      const controller = new FieldController({ ...config, defaultValue }, 'adminMeta');
       controller.getDefaultValue({ originalInput, prefill });
       expect(defaultValue).toHaveBeenCalledWith({ originalInput, prefill });
     });