Added new setting to exclude bots from visits, wherever possible

src/settings/VisitsSettings.tsx

@@ -1,20 +1,39 @@
 import { FC } from 'react';
+import { FormGroup } from 'reactstrap';
 import { SimpleCard } from '../utils/SimpleCard';
 import { DateIntervalSelector } from '../utils/dates/DateIntervalSelector';
 import { LabeledFormGroup } from '../utils/forms/LabeledFormGroup';
 import { Settings, VisitsSettings as VisitsSettingsConfig } from './reducers/settings';
+import { ToggleSwitch } from '../utils/ToggleSwitch';
+import { FormText } from '../utils/forms/FormText';
+import { DateInterval } from '../utils/helpers/dateIntervals';
 
 interface VisitsProps {
   settings: Settings;
   setVisitsSettings: (settings: VisitsSettingsConfig) => void;
 }
 
+const currentDefaultInterval = (settings: Settings): DateInterval => settings.visits?.defaultInterval ?? 'last30Days';
+
 export const VisitsSettings: FC<VisitsProps> = ({ settings, setVisitsSettings }) => (
   <SimpleCard title="Visits" className="h-100">
+    <FormGroup>
+      <ToggleSwitch
+        checked={!!settings.visits?.excludeBots}
+        onChange={(excludeBots) => setVisitsSettings(
+          { defaultInterval: currentDefaultInterval(settings), excludeBots },
+        )}
+      >
+        Exclude bots wherever possible (this option&lsquo;s effect might depend on Shlink server&lsquo;s version).
+        <FormText>
+          The visits coming from potential bots will be <b>{settings.visits?.excludeBots ? 'excluded' : 'included'}</b>.
+        </FormText>
+      </ToggleSwitch>
+    </FormGroup>
     <LabeledFormGroup noMargin label="Default interval to load on visits sections:">
       <DateIntervalSelector
         allText="All visits"
-        active={settings.visits?.defaultInterval ?? 'last30Days'}
+        active={currentDefaultInterval(settings)}
         onChange={(defaultInterval) => setVisitsSettings({ defaultInterval })}
       />
     </LabeledFormGroup>

src/settings/reducers/settings.ts

@@ -34,6 +34,7 @@ export interface UiSettings {
 
 export interface VisitsSettings {
   defaultInterval: DateInterval;
+  excludeBots?: boolean;
 }
 
 export interface TagsSettings {

test/settings/VisitsSettings.test.tsx

@@ -17,6 +17,7 @@ describe('<VisitsSettings />', () => {
 
     expect(screen.getByRole('heading')).toHaveTextContent('Visits');
     expect(screen.getByText('Default interval to load on visits sections:')).toBeInTheDocument();
+    expect(screen.getByText(/^Exclude bots wherever possible/)).toBeInTheDocument();
   });
 
   it.each([
@@ -59,4 +60,36 @@ describe('<VisitsSettings />', () => {
     expect(setVisitsSettings).toHaveBeenNthCalledWith(2, { defaultInterval: 'last180Days' });
     expect(setVisitsSettings).toHaveBeenNthCalledWith(3, { defaultInterval: 'yesterday' });
   });
+
+  it.each([
+    [
+      Mock.all<Settings>(),
+      /The visits coming from potential bots will be included.$/,
+      /The visits coming from potential bots will be excluded.$/,
+    ],
+    [
+      Mock.of<Settings>({ visits: { excludeBots: false } }),
+      /The visits coming from potential bots will be included.$/,
+      /The visits coming from potential bots will be excluded.$/,
+    ],
+    [
+      Mock.of<Settings>({ visits: { excludeBots: true } }),
+      /The visits coming from potential bots will be excluded.$/,
+      /The visits coming from potential bots will be included.$/,
+    ],
+  ])('displays expected helper text for exclude bots control', (settings, expectedText, notExpectedText) => {
+    setUp(settings);
+
+    const visitsComponent = screen.getByText(/^Exclude bots wherever possible/);
+
+    expect(visitsComponent).toHaveTextContent(expectedText);
+    expect(visitsComponent).not.toHaveTextContent(notExpectedText);
+  });
+
+  it('invokes setVisitsSettings when bot exclusion is toggled', async () => {
+    const { user } = setUp();
+
+    await user.click(screen.getByText(/^Exclude bots wherever possible/));
+    expect(setVisitsSettings).toHaveBeenCalledWith(expect.objectContaining({ excludeBots: true }));
+  });
 });