Merge pull request #444 from acelaya-forks/feature/crawlable-option

Feature/crawlable option

CHANGELOG.md

@@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 * [#432](https://github.com/shlinkio/shlink-web-client/pull/432) Added support to provide the `servers.json` file inside a a `conf.d` folder.
 * [#440](https://github.com/shlinkio/shlink-web-client/pull/440) Added hint of what visits come potentially from a bot, in the visits table, when consuming Shlink >=2.7.
 * [#431](https://github.com/shlinkio/shlink-web-client/pull/431) Added support to filter out visits from potential bots in visits sections, when consuming Shlink >=2.7.
+* [#430](https://github.com/shlinkio/shlink-web-client/pull/430) Added support to set new and existing short URLs as crawlable, when consuming Shlink >=2.7.
 
 ### Changed
 * *Nothing*

src/short-urls/EditShortUrl.tsx

@@ -41,6 +41,7 @@ const getInitialState = (shortUrl?: ShortUrl, settings?: ShortUrlCreationSetting
     validSince: shortUrl.meta.validSince ?? undefined,
     validUntil: shortUrl.meta.validUntil ?? undefined,
     maxVisits: shortUrl.meta.maxVisits ?? undefined,
+    crawlable: shortUrl.crawlable,
     validateUrl,
   };
 };

src/short-urls/ShortUrlForm.tsx

@@ -6,6 +6,7 @@ import m from 'moment';
 import classNames from 'classnames';
 import DateInput, { DateInputProps } from '../utils/DateInput';
 import {
+  supportsCrawlableVisits,
   supportsListingDomains,
   supportsSettingShortCodeLength,
   supportsShortUrlTitle,
@@ -20,6 +21,7 @@ import { DomainSelectorProps } from '../domains/DomainSelector';
 import { formatIsoDate } from '../utils/helpers/date';
 import UseExistingIfFoundInfoIcon from './UseExistingIfFoundInfoIcon';
 import { ShortUrlData } from './data';
+import { ShortUrlFormCheckboxGroup } from './helpers/ShortUrlFormCheckboxGroup';
 import './ShortUrlForm.scss';
 
 export type Mode = 'create' | 'create-basic' | 'edit';
@@ -108,7 +110,8 @@ export const ShortUrlForm = (
     'col-sm-12': !showCustomizeCard,
   });
   const showValidateUrl = supportsValidateUrl(selectedServer);
-  const showExtraValidationsCard = showValidateUrl || !isEdit;
+  const showCrawlableControl = supportsCrawlableVisits(selectedServer);
+  const showExtraValidationsCard = showValidateUrl || showCrawlableControl || !isEdit;
 
   return (
     <form className="short-url-form" onSubmit={submit}>
@@ -167,23 +170,24 @@ export const ShortUrlForm = (
           </Row>
 
           {showExtraValidationsCard && (
-            <SimpleCard title="Extra validations" className="mb-3">
-              {!isEdit && (
-                <p>
-                  Make sure the long URL is valid, or ensure an existing short URL is returned if it matches all
-                  provided data.
-                </p>
-              )}
+            <SimpleCard title="Extra checks" className="mb-3">
               {showValidateUrl && (
-                <p>
-                  <Checkbox
-                    inline
-                    checked={shortUrlData.validateUrl}
-                    onChange={(validateUrl) => setShortUrlData({ ...shortUrlData, validateUrl })}
-                  >
-                    Validate URL
-                  </Checkbox>
-                </p>
+                <ShortUrlFormCheckboxGroup
+                  infoTooltip="If checked, Shlink will try to reach the long URL, failing in case it's not publicly accessible."
+                  checked={shortUrlData.validateUrl}
+                  onChange={(validateUrl) => setShortUrlData({ ...shortUrlData, validateUrl })}
+                >
+                  Validate URL
+                </ShortUrlFormCheckboxGroup>
+              )}
+              {showCrawlableControl && (
+                <ShortUrlFormCheckboxGroup
+                  infoTooltip="This short URL will be included in the robots.txt for your Shlink instance, allowing web crawlers (like Google) to index it."
+                  checked={shortUrlData.crawlable}
+                  onChange={(crawlable) => setShortUrlData({ ...shortUrlData, crawlable })}
+                >
+                  Make it crawlable
+                </ShortUrlFormCheckboxGroup>
               )}
               {!isEdit && (
                 <p>

src/short-urls/data/index.ts

@@ -9,6 +9,7 @@ export interface EditShortUrlData {
   validUntil?: m.Moment | string | null;
   maxVisits?: number | null;
   validateUrl?: boolean;
+  crawlable?: boolean;
 }
 
 export interface ShortUrlData extends EditShortUrlData {
@@ -29,6 +30,7 @@ export interface ShortUrl {
   tags: string[];
   domain: string | null;
   title?: string | null;
+  crawlable?: boolean;
 }
 
 export interface ShortUrlMeta {

src/short-urls/helpers/ShortUrlFormCheckboxGroup.tsx

@@ -0,0 +1,39 @@
+import { ChangeEvent, FC, useRef } from 'react';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faInfoCircle as infoIcon } from '@fortawesome/free-solid-svg-icons';
+import { UncontrolledTooltip } from 'reactstrap';
+import Checkbox from '../../utils/Checkbox';
+
+interface ShortUrlFormCheckboxGroupProps {
+  checked?: boolean;
+  onChange?: (checked: boolean, e: ChangeEvent<HTMLInputElement>) => void;
+  infoTooltip?: string;
+}
+
+const InfoTooltip: FC<{ tooltip: string }> = ({ tooltip }) => {
+  const ref = useRef<HTMLElement | null>();
+
+  return (
+    <>
+      <span
+        ref={(el) => {
+          ref.current = el;
+        }}
+      >
+        <FontAwesomeIcon icon={infoIcon} />
+      </span>
+      <UncontrolledTooltip target={(() => ref.current) as any} placement="right">{tooltip}</UncontrolledTooltip>
+    </>
+  );
+};
+
+export const ShortUrlFormCheckboxGroup: FC<ShortUrlFormCheckboxGroupProps> = (
+  { children, infoTooltip, checked, onChange },
+) => (
+  <p>
+    <Checkbox inline checked={checked} className={infoTooltip ? 'mr-2' : ''} onChange={onChange}>
+      {children}
+    </Checkbox>
+    {infoTooltip && <InfoTooltip tooltip={infoTooltip} />}
+  </p>
+);

src/utils/helpers/features.ts

@@ -25,3 +25,5 @@ export const supportsQrCodeMargin = supportsShortUrlTitle;
 export const supportsTagsInPatch = supportsShortUrlTitle;
 
 export const supportsBotVisits = serverMatchesVersions({ minVersion: '2.7.0' });
+
+export const supportsCrawlableVisits = supportsBotVisits;

test/short-urls/helpers/ShortUrlFormCheckboxGroup.test.tsx

@@ -0,0 +1,16 @@
+import { shallow } from 'enzyme';
+import { ShortUrlFormCheckboxGroup } from '../../../src/short-urls/helpers/ShortUrlFormCheckboxGroup';
+import Checkbox from '../../../src/utils/Checkbox';
+
+describe('<ShortUrlFormCheckboxGroup />', () => {
+  test.each([
+    [ undefined, '', 0 ],
+    [ 'This is the tooltip', 'mr-2', 1 ],
+  ])('renders tooltip only when provided', (infoTooltip, expectedClassName, expectedAmountOfTooltips) => {
+    const wrapper = shallow(<ShortUrlFormCheckboxGroup infoTooltip={infoTooltip} />);
+    const checkbox = wrapper.find(Checkbox);
+
+    expect(checkbox.prop('className')).toEqual(expectedClassName);
+    expect(wrapper.find('InfoTooltip')).toHaveLength(expectedAmountOfTooltips);
+  });
+});