Reputation: 33998
I have the following code, but first the explanation. I am using a REACTJS Office UI Component called details list: https://developer.microsoft.com/en-us/fabric#/components/detailslist
And I want my application to be able to render information from any type of Sharepoint List regardless of the columns the source has. For that I am trying to implement a factory method design pattern like this:
export interface IListItem {
[key: string]: any;
id: string;
title: string;
modified: Date;
created: Date;
modifiedby: string;
createdby: string;
}
import {IListItem} from './IListItem';
export interface IAnnouncementListItem extends IListItem {
announcementBody: string;
expiryDate: Date;
}
import {IListItem} from './IListItem';
export interface IDirectoryListItem extends IListItem {
firstName: string;
lastName: string;
mobileNumber: string;
internalNumber: string;
}
import {IListItem} from './IListItem';
export interface INewsListItem extends IListItem {
newsheader: string;
newsbody: string;
expiryDate: Date;
}
import { IListItem } from './models/IListItem';
import { SPHttpClient, SPHttpClientResponse } from '@microsoft/sp-http';
export interface IFactory{
getItems(requester: SPHttpClient, siteUrl: string, listName: string): IListItem[];
}
import { SPHttpClient, SPHttpClientResponse } from '@microsoft/sp-http';
import { IWebPartContext } from '@microsoft/sp-webpart-base';
import { IListItem} from './models/IListItem';
import { IFactory } from './IFactory';
import { INewsListItem } from './models/INewsListItem';
import { IDirectoryListItem } from './models/IDirectoryListItem';
import { IAnnouncementListItem } from './models/IAnnouncementListItem';
export class ListItemFactory implements IFactory{
getItems(requester: SPHttpClient, siteUrl: string, listName: string): IListItem[] {
switch(listName) {
case 'List':
let items: IListItem[];
requester.get(`${siteUrl}/_api/web/lists/getbytitle('${listName}')/items?$select=Title,Id`,
SPHttpClient.configurations.v1,
{
headers: {
'Accept': 'application/json;odata=nometadata',
'odata-version': ''
}
})
.then((response: SPHttpClientResponse): Promise<{ value: IListItem[] }> => {
return response.json();
})
.then((response: { value: IListItem[] }): void => {
items= response.value;
});
return items;
case 'News':
let newsitems: INewsListItem[];
requester.get(`${siteUrl}/_api/web/lists/getbytitle('${listName}')/items?$select=Title,Id`,
SPHttpClient.configurations.v1,
{
headers: {
'Accept': 'application/json;odata=nometadata',
'odata-version': ''
}
})
.then((response: SPHttpClientResponse): Promise<{ value: INewsListItem[] }> => {
return response.json();
})
.then((response: { value: INewsListItem[] }): void => {
newsitems= response.value;
});
return newsitems;
case 'Announcements':
let announcementitems: IAnnouncementListItem[];
requester.get(`${siteUrl}/_api/web/lists/getbytitle('${listName}')/items?$select=Title,Id`,
SPHttpClient.configurations.v1,
{
headers: {
'Accept': 'application/json;odata=nometadata',
'odata-version': ''
}
})
.then((response: SPHttpClientResponse): Promise<{ value: IAnnouncementListItem[] }> => {
return response.json();
})
.then((response: { value: IAnnouncementListItem[] }): void => {
announcementitems= response.value;
});
return announcementitems;
case 'Directory':
let directoryitems: IDirectoryListItem[];
requester.get(`${siteUrl}/_api/web/lists/getbytitle('${listName}')/items?$select=Title,Id`,
SPHttpClient.configurations.v1,
{
headers: {
'Accept': 'application/json;odata=nometadata',
'odata-version': ''
}
})
.then((response: SPHttpClientResponse): Promise<{ value: IDirectoryListItem[] }> => {
return response.json();
})
.then((response: { value: IDirectoryListItem[] }): void => {
items= response.value;
});
return directoryitems;
default:
return null;
}
}
}
/* public getItems(requester: SPHttpClient, siteUrl: string, listName: string): IListItem[] {
let items: IListItem[];
requester.get(`${siteUrl}/_api/web/lists/getbytitle('${listName}')/items?$select=Title,Id`,
SPHttpClient.configurations.v1,
{
headers: {
'Accept': 'application/json;odata=nometadata',
'odata-version': ''
}
})
.then((response: SPHttpClientResponse): Promise<{ value: IListItem[] }> => {
return response.json();
})
.then((response: { value: IListItem[] }): void => {
items= response.value;
});
return items;
} */
}
The state class:
import { IListItem } from './models/IListItem';
import { INewsListItem } from './models/INewsListItem';
import { IDirectoryListItem } from './models/IDirectoryListItem';
import { IAnnouncementListItem } from './models/IAnnouncementListItem';
import {
IColumn
} from 'office-ui-fabric-react/lib/DetailsList';
export interface IFactoryMethodState{
type: string;
status: string;
DetailsListItemState: IDetailsListItemState;
DetailsNewsListItemState: IDetailsNewsListItemState;
DetailsDirectoryListItemState : IDetailsDirectoryListItemState;
DetailsAnnouncementListItemState : IDetailsAnnouncementListItemState;
}
export interface IDetailsListItemState {
columns: IColumn[];
items: IListItem[];
}
export interface IDetailsNewsListItemState {
columns: IColumn[];
items: INewsListItem[];
}
export interface IDetailsDirectoryListItemState {
columns: IColumn[];
items: IDirectoryListItem[];
}
export interface IDetailsAnnouncementListItemState {
columns: IColumn[];
items: IAnnouncementListItem[];
}
as you can see, I have different types of results, so I encapsulated that info IfactoryMethodState
Now in the component I use it like this:
import * as React from 'react';
import styles from './FactoryMethod.module.scss';
import { IFactoryMethodProps } from './IFactoryMethodProps';
import {
IDetailsListItemState,
IDetailsNewsListItemState,
IDetailsDirectoryListItemState,
IDetailsAnnouncementListItemState,
IFactoryMethodState
} from './IFactoryMethodState';
import { IListItem } from './models/IListItem';
import { IAnnouncementListItem } from './models/IAnnouncementListItem';
import { INewsListItem } from './models/INewsListItem';
import { IDirectoryListItem } from './models/IDirectoryListItem';
import { escape } from '@microsoft/sp-lodash-subset';
import { SPHttpClient, SPHttpClientResponse } from '@microsoft/sp-http';
import { ListItemFactory} from './ListItemFactory';
import { TextField } from 'office-ui-fabric-react/lib/TextField';
import {
DetailsList,
DetailsListLayoutMode,
Selection,
IColumn
} from 'office-ui-fabric-react/lib/DetailsList';
import { MarqueeSelection } from 'office-ui-fabric-react/lib/MarqueeSelection';
import { autobind } from 'office-ui-fabric-react/lib/Utilities';
let _columns = [
{
key: 'column1',
name: 'Name',
fieldName: 'name',
minWidth: 100,
maxWidth: 200,
isResizable: true
},
{
key: 'column2',
name: 'Value',
fieldName: 'value',
minWidth: 100,
maxWidth: 200,
isResizable: true
},
];
export default class FactoryMethod extends React.Component<any, IFactoryMethodState> {
private listItemEntityTypeName: string = undefined;
private _selection: Selection;
constructor(props: IFactoryMethodProps, state: any) {
super(props);
//Initialize state
this.state = {
type: 'ListItem',
status: this.listNotConfigured(this.props) ? 'Please configure list in Web Part properties' : 'Ready',
DetailsListItemState:{
columns:[],
items:[]
},
DetailsNewsListItemState:{
columns:[],
items:[]
},
DetailsDirectoryListItemState:{
columns:[],
items:[]
},
DetailsAnnouncementListItemState:{
columns:[],
items:[]
},
};
}
public componentWillReceiveProps(nextProps: IFactoryMethodProps): void {
this.listItemEntityTypeName = undefined;
//Initialize state
this.state = {
type: 'ListItem',
status: this.listNotConfigured(this.props) ? 'Please configure list in Web Part properties' : 'Ready',
DetailsListItemState:{
columns:[],
items:[]
},
DetailsNewsListItemState:{
columns:[],
items:[]
},
DetailsDirectoryListItemState:{
columns:[],
items:[]
},
DetailsAnnouncementListItemState:{
columns:[],
items:[]
},
};
}
public render(): React.ReactElement<IFactoryMethodProps> {
let { type,
status,
DetailsListItemState,
DetailsNewsListItemState,
DetailsDirectoryListItemState,
DetailsAnnouncementListItemState } = this.state;
switch(this.props.listName)
{
case "List":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsListItemState.items }
columns={ DetailsListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
case "Announcements":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsAnnouncementListItemState.items }
columns={ DetailsAnnouncementListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
case "News":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsNewsListItemState.items }
columns={ DetailsNewsListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
case "Directory":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsDirectoryListItemState.items }
columns={ DetailsDirectoryListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
default :
break;
}
}
private readItems(): void {
this.setState({
status: 'Loading all items...'
});
let factory = new ListItemFactory();
//Here its where we actually use the pattern to make our coding easier.
switch(this.props.listName)
{
case "List":
let listItems = factory.getItems(this.props.spHttpClient, this.props.siteUrl, this.props.listName);
this.setState({
status: `Successfully loaded ${listItems.length} items`,
DetailsListItemState : {
items: listItems,
columns: [
]
}
});
break;
case "Announcements":
let announcementlistItems = factory.getItems(this.props.spHttpClient, this.props.siteUrl, this.props.listName) as IAnnouncementListItem[];
this.setState({
status: `Successfully loaded ${listItems.length} items`,
DetailsAnnouncementListItemState : {
items: announcementlistItems,
columns: []
}
});
break;
case "News":
let newsListItems = factory.getItems(this.props.spHttpClient, this.props.siteUrl, this.props.listName) as INewsListItem[];
this.setState({
status: `Successfully loaded ${listItems.length} items`,
DetailsNewsListItemState : {
items: newsListItems,
columns: []
}
});
break;
case "Directory":
let directoryListItems = factory.getItems(this.props.spHttpClient, this.props.siteUrl, this.props.listName) as IDirectoryListItem[];
this.setState({
status: `Successfully loaded ${listItems.length} items`,
DetailsDirectoryListItemState : {
items: directoryListItems,
columns: []
}
});
break;
default :
break;
}
}
private _getSelectionDetails(): string {
let selectionCount = this._selection.getSelectedCount();
switch (selectionCount) {
case 0:
return 'No items selected';
case 1:
return '1 item selected: ' + (this._selection.getSelection()[0] as any).name;
default:
return `${selectionCount} items selected`;
}
}
private listNotConfigured(props: IFactoryMethodProps): boolean {
return props.listName === undefined ||
props.listName === null ||
props.listName.length === 0;
}
}
What I dont like about this code:
The switch statement, is there a way to rewrite it and make it shorter probably without the SWITCH?
The state implementation, I am not quite convinced yet about it.
Update 1: I see some things not right after making your changes:
Error 1 here:
public ListMarqueeSelection = (itemState: {fixedColumns: number, columns: {}[], items: {}[] }) => ( compact={ true }> );
Type '{ items: {}[]; columns: {}[]; setKey: "set"; layoutMode: DetailsListLayoutMode.fixedColumns; sele...' is not assignable to type 'IntrinsicAttributes & IntrinsicClassAttributes & Readonly<{ children?: ReactNode; }>...'. Type '{ items: {}[]; columns: {}[]; setKey: "set"; layoutMode: DetailsListLayoutMode.fixedColumns; sele...' is not assignable to type 'Readonly'. Types of property 'columns' are incompatible. Type '{}[]' is not assignable to type 'IColumn[]'. [ts] Type '{ items: {}[]; columns: {}[]; setKey: "set"; layoutMode: DetailsListLayoutMode.fixedColumns; sele...' is not assignable to type 'IntrinsicAttributes & IntrinsicClassAttributes & Readonly<{ children?: ReactNode; }>...'. Type '{ items: {}[]; columns: {}[]; setKey: "set"; layoutMode: DetailsListLayoutMode.fixedColumns; sele...' is not assignable to type 'Readonly'. Types of property 'columns' are incompatible. Type '{}[]' is not assignable to type 'IColumn[]'. Type '{}' is not assignable to type 'IColumn'. Property 'key' is missing in type '{}'. (parameter) itemState: { fixedColumns: number; columns: {}[]; items: {}[]; }
Error 2 here:
public render() {
let { type,
status,
DetailsListItemState,
DetailsNewsListItemState,
DetailsDirectoryListItemState,
DetailsAnnouncementListItemState } = this.state;
switch(this.props.listName)
{
case "List":
return <ListMarqueeSelection itemState={this.state.DetailsListItemState}/>;
case "News":
return <ListMarqueeSelection itemState={this.state.DetailsNewsListItemState}/>;
case "Announcements":
return <ListMarqueeSelection itemState={this.state.DetailsAnnouncementListItemState}/>;
case "Directory":
return <ListMarqueeSelection itemState={this.state.DetailsDirectoryListItemState}/>;
default:
return undefined;
}
}
Cannot find name 'ListMarqueeSelection'. Did you mean the instance member 'this.ListMarqueeSelection'?
Upvotes: 0
Views: 245
Reputation: 31823
You are right, it is too long, but that is because it is poorly factored. Fortunately, it can be improved in a straightforward fashion
To start out, all of the calls to setState
are the identical, with the exception of the *ListItemState
used, across all of the cases of readItems
. We should extract a function and call it in place, removing the duplication.
So starting with the method readItems
as
private readItems() {
this.setState({
status: 'Loading all items...'
});
let factory = new ListItemFactory();
//Here its where we actually use the pattern to make our coding easier.
switch(this.props.listName)
{
case "List":
this.setState({
status: `Successfully loaded ${listItems.length} items`,
DetailsListItemState : {
items: announcementlistItems,
columns: []
}
});
break;
break;
case "Announcements":
let announcementlistItems = factory.getItems(this.props.spHttpClient, this.props.siteUrl, this.props.listName) as IAnnouncementListItem[];
this.setState({
status: `Successfully loaded ${listItems.length} items`,
DetailsAnnouncementListItemState : {
items: announcementlistItems,
columns: []
}
});
break;
case "News":
let newsListItems = factory.getItems(this.props.spHttpClient, this.props.siteUrl, this.props.listName) as INewsListItem[];
this.setState({
status: `Successfully loaded ${listItems.length} items`,
DetailsNewsListItemState : {
items: newsListItems,
columns: []
}
});
break;
case "Directory":
let directoryListItems = factory.getItems(this.props.spHttpClient, this.props.siteUrl, this.props.listName) as IDirectoryListItem[];
this.setState<keyof {}>({
status: `Successfully loaded ${listItems.length} items`,
DetailsDirectoryListItemState : {
items: directoryListItems,
columns: []
}
});
break;
default :
break;
}
}
So lets extract a shared method
setStateWithList() {
const factory = new ListItemFactory();
const items = factory.getItems(this.props.spHttpClient,
this.props.siteUrl, this.props.listName);
const keyPart = this.props.listName === 'Items' ? '' : this.props.listName;
this.setState({
status: `Successfully loaded ${items.length} items`,
['Details' + keyPart + 'ListItemState' as keyof IFactoryMethodProps] : {
items,
columns: [
]
}
});
}
This leads us to
private readItems() {
this.setState({
status: 'Loading all items...'
});
//Here its where we actually use the pattern to make our coding easier.
if (this.props.listName) {
this.setStateWithList();
}
}
which is clear redundant so we can replace it with
private readItems() {
this.setState({
status: 'Loading all items...'
});
if (this.props.listName) {
this.setStateWithList();
}
}
Now, on to render
What we have
public render() {
let { type,
status,
DetailsListItemState,
DetailsNewsListItemState,
DetailsDirectoryListItemState,
DetailsAnnouncementListItemState } = this.state;
switch(this.props.listName)
{
case "List":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsListItemState.items }
columns={ DetailsListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
case "Announcements":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsAnnouncementListItemState.items }
columns={ DetailsAnnouncementListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
case "News":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsNewsListItemState.items }
columns={ DetailsNewsListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
case "Directory":
return (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ DetailsDirectoryListItemState.items }
columns={ DetailsDirectoryListItemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }
/>
</MarqueeSelection>
</div>
);
default :
break;
}
}
We will apply the same approach as before also apply parameterization
ListMarqueeSelection(itemState: {fixedColumns: number, colums: IColumn[], items: IListItem[] }) => (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ itemState.items }
columns={ itemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }>
</DetailsList
</MarqueeSelection>
</div>
);
which leads us to
render() {
switch(this.props.listName)
{
case "List":
return <this.ListMarqueeSelection
itemState={this.state.DetailsListItemState}/>;
case "News":
return <this.ListMarqueeSelection
itemState={this.state.DetailsNewsListItemState}/>;
case "Announcements":
return (<this.ListMarqueeSelection
itemState={this.state.DetailsAnnouncementsListItemState}/>;
case "Directory":
return <this.ListMarqueeSelection
itemState={this.state.DetailsDirectoryListItemState}/>;
default:
return undefined;
}
}
Finally, lets clean up the duplicate logic between the constructor
and componentWillReceiveProps
by extracting a shared method.
Out State
component ends up looking like
export default class FactoryMethod extends React.Component<any, IFactoryMethodState> {
listItemEntityTypeName?: string;
_selection: Selection;
constructor(props: IFactoryMethodProps, state: any) {
super(props);
setInitialState();
}
componentWillReceiveProps(nextProps: IFactoryMethodProps) {
this.listItemEntityTypeName = undefined;
setInitialState();
}
render() {
switch(this.props.listName)
{
case "List":
return <this.ListMarqueeSelection
itemState={this.state.DetailsListItemState}/>;
case "News":
return <this.ListMarqueeSelection
itemState={this.state.DetailsNewsListItemState}/>;
case "Announcements":
return (<this.ListMarqueeSelection
itemState={this.state.DetailsAnnouncementsListItemState}/>;
case "Directory":
return <this.ListMarqueeSelection
itemState={this.state.DetailsDirectoryListItemState}/>;
default:
return undefined;
}
}
readItems() {
this.setState({
status: 'Loading all items...'
});
if (this.props.listName) {
this.setStateWithList();
}
}
setInitialState() {
this.state = {
type: 'ListItem',
status: this.listNotConfigured(this.props)
? 'Please configure list in Web Part properties'
: 'Ready',
DetailsListItemState:{
columns:[],
items:[]
},
DetailsNewsListItemState:{
columns:[],
items:[]
},
DetailsDirectoryListItemState:{
columns:[],
items:[]
},
DetailsAnnouncementListItemState:{
columns:[],
items:[]
},
};
}
ListMarqueeSelection = (itemState: {fixedColumns: number, colums: {}[], items: {}[] }) => (
<div>
<MarqueeSelection selection={ this._selection }>
<DetailsList
items={ itemState.items }
columns={ itemState.columns }
setKey='set'
layoutMode={ DetailsListLayoutMode.fixedColumns }
selection={ this._selection }
selectionPreservedOnEmptyClick={ true }
compact={ true }>
</DetailsList
</MarqueeSelection>
</div>
);
setStateWithList() {
const factory = new ListItemFactory();
const items = factory.getItems(this.props.spHttpClient,
this.props.siteUrl, this.props.listName);
const keyPart = this.props.listName === 'Items' ? '' : this.props.listName;
// the explicit specification of the type argument `keyof {}` is bad and
// it should not be required.
this.setState<keyof {}>({
status: `Successfully loaded ${items.length} items`,
['Details' + keyPart + 'ListItemState'] : {
items,
columns: [
]
}
});
}
_getSelectionDetails() {
const selectionCount = this._selection.getSelectedCount();
switch (selectionCount) {
case 0:
return 'No items selected';
case 1:
return `1 item selected: ${this._selection.getSelection()[0]).name}`;
default:
return `${selectionCount} items selected`;
}
}
listNotConfigured(props: IFactoryMethodProps) {
return !props.listNane || props.listName.length === 0;
}
}
Of course we could replace switch with another mechanism and improve more but that is a significant improvement.
We can see that the problem was not switch but rather duplication and lost opportunities for ad-hoc subtyping
Upvotes: 1