Pull request: querylog: search clients by name, enrich http resp

Updates AdguardTeam#1273.

Squashed commit of the following:

commit 55b7815
Author: Artem Baskal <a.baskal@adguard.com>
Date:   Fri Apr 2 16:55:39 2021 +0300

    Update client_info in case of null

commit 5c80c14
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Apr 2 16:24:14 2021 +0300

    querylog: always set client_info

commit b48efd6
Merge: 4ed7eab 23c9f52
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Apr 2 16:22:08 2021 +0300

    Merge branch 'master' into 1273-querylog-client-name

commit 4ed7eab
Merge: dbf990e 70d4c70
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Apr 2 12:57:17 2021 +0300

    Merge branch 'master' into 1273-querylog-client-name

commit dbf990e
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Apr 2 12:56:13 2021 +0300

    home: imp names

commit c2cfdef
Author: Artem Baskal <a.baskal@adguard.com>
Date:   Thu Apr 1 19:26:04 2021 +0300

    Rename to whois

commit e3cc4a6
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Apr 1 19:03:42 2021 +0300

    home: imp whois more

commit 3b8ef86
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Apr 1 18:51:14 2021 +0300

    home: imp whois resp

commit fb97e0d
Author: Artem Baskal <a.baskal@adguard.com>
Date:   Thu Apr 1 18:00:03 2021 +0300

    Fix client_info ids prop types

commit 2980051
Author: Artem Baskal <a.baskal@adguard.com>
Date:   Thu Apr 1 17:58:14 2021 +0300

    Adapt changes on client

commit aa1769f
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Apr 1 17:18:36 2021 +0300

    all: add more fields to querylog client

commit 4b2a2db
Merge: cda92c3 2e4e2f6
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Apr 1 16:57:26 2021 +0300

    Merge branch 'master' into 1273-querylog-client-name

commit cda92c3
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Mar 29 18:03:51 2021 +0300

    querylog: fix windows tests

commit 5a56f0a
Merge: 627e495 e710ce1
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Mar 29 17:45:53 2021 +0300

    Merge branch 'master' into 1273-querylog-client-name

commit 627e495
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Mar 29 17:44:49 2021 +0300

    querylog: add tests, imp code, docs

commit 6dec468
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Mar 26 16:10:47 2021 +0300

    querylog: search clients by name, enrich http resp

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to
 
 ### Added
 
+- Search by clients' names in the query log ([#1273]).
 - Verbose version output with `-v --version` ([#2416]).
 - The ability to set a custom TLD for known local-network hosts ([#2393]).
 - The ability to serve DNS queries on multiple hosts and interfaces ([#1401]).
@@ -44,6 +45,7 @@ and this project adheres to
 
 - Go 1.14 support.
 
+[#1273]: https://github.com/AdguardTeam/AdGuardHome/issues/1273
 [#1401]: https://github.com/AdguardTeam/AdGuardHome/issues/1401
 [#2385]: https://github.com/AdguardTeam/AdGuardHome/issues/2385
 [#2393]: https://github.com/AdguardTeam/AdGuardHome/issues/2393

client/src/actions/queryLogs.js

@@ -1,35 +1,22 @@
 import { createAction } from 'redux-actions';
 
 import apiClient from '../api/Api';
-import { normalizeLogs, getParamsForClientsSearch, addClientInfo } from '../helpers/helpers';
+import { normalizeLogs } from '../helpers/helpers';
 import {
     DEFAULT_LOGS_FILTER, FORM_NAME, QUERY_LOGS_PAGE_LIMIT,
 } from '../helpers/constants';
 import { addErrorToast, addSuccessToast } from './toasts';
 
-const enrichWithClientInfo = async (logs) => {
-    const clientsParams = getParamsForClientsSearch(logs, 'client', 'client_id');
-
-    if (Object.keys(clientsParams).length > 0) {
-        const clients = await apiClient.findClients(clientsParams);
-        return addClientInfo(logs, clients, 'client_id', 'client');
-    }
-
-    return logs;
-};
-
 const getLogsWithParams = async (config) => {
     const { older_than, filter, ...values } = config;
     const rawLogs = await apiClient.getQueryLog({
         ...filter,
         older_than,
     });
     const { data, oldest } = rawLogs;
-    const normalizedLogs = normalizeLogs(data);
-    const logs = await enrichWithClientInfo(normalizedLogs);
 
     return {
-        logs,
+        logs: normalizeLogs(data),
         oldest,
         older_than,
         filter,
@@ -92,10 +79,8 @@ export const updateLogs = () => async (dispatch, getState) => {
     try {
         const { logs, oldest, older_than } = getState().queryLogs;
 
-        const enrichedLogs = await enrichWithClientInfo(logs);
-
         dispatch(getLogsSuccess({
-            logs: enrichedLogs,
+            logs,
             oldest,
             older_than,
         }));

client/src/components/Logs/Cells/ClientCell.js

@@ -17,11 +17,8 @@ import { updateLogs } from '../../../actions/queryLogs';
 const ClientCell = ({
     client,
     client_id,
+    client_info,
     domain,
-    info,
-    info: {
-        name, whois_info, disallowed, disallowed_rule,
-    },
     reason,
 }) => {
     const { t } = useTranslation();
@@ -33,18 +30,22 @@ const ClientCell = ({
 
     const autoClient = autoClients.find((autoClient) => autoClient.name === client);
     const source = autoClient?.source;
-    const whoisAvailable = whois_info && Object.keys(whois_info).length > 0;
-    const clientName = name || client_id;
-    const clientInfo = { ...info, name: clientName };
+    const whoisAvailable = client_info && Object.keys(client_info.whois).length > 0;
+    const clientName = client_info?.name || client_id;
+    const clientInfo = client_info && {
+        ...client_info,
+        whois_info: client_info?.whois,
+        name: clientName,
+    };
 
     const id = nanoid();
 
     const data = {
         address: client,
         name: clientName,
-        country: whois_info?.country,
-        city: whois_info?.city,
-        network: whois_info?.orgname,
+        country: client_info?.whois?.country,
+        city: client_info?.whois?.city,
+        network: client_info?.whois?.orgname,
         source_label: source,
     };
 
@@ -53,7 +54,7 @@ const ClientCell = ({
     const isFiltered = checkFiltered(reason);
 
     const nameClass = classNames('w-90 o-hidden d-flex flex-column', {
-        'mt-2': isDetailed && !name && !whoisAvailable,
+        'mt-2': isDetailed && !client_info?.name && !whoisAvailable,
         'white-space--nowrap': isDetailed,
     });
 
@@ -69,7 +70,11 @@ const ClientCell = ({
             confirmMessage,
             buttonKey: blockingClientKey,
             isNotInAllowedList,
-        } = getBlockClientInfo(client, disallowed, disallowed_rule);
+        } = getBlockClientInfo(
+            client,
+            client_info?.disallowed || false,
+            client_info?.disallowed_rule || '',
+        );
 
         const blockingForClientKey = isFiltered ? 'unblock_for_this_client_only' : 'block_for_this_client_only';
         const clientNameBlockingFor = getBlockingClientName(clients, client);
@@ -85,7 +90,11 @@ const ClientCell = ({
                 name: blockingClientKey,
                 onClick: async () => {
                     if (window.confirm(confirmMessage)) {
-                        await dispatch(toggleClientBlock(client, disallowed, disallowed_rule));
+                        await dispatch(toggleClientBlock(
+                            client,
+                            client_info?.disallowed || false,
+                            client_info?.disallowed_rule || '',
+                        ));
                         await dispatch(updateLogs());
                     }
                 },
@@ -199,20 +208,18 @@ const ClientCell = ({
 ClientCell.propTypes = {
     client: propTypes.string.isRequired,
     client_id: propTypes.string,
+    client_info: propTypes.shape({
+        ids: propTypes.arrayOf(propTypes.string).isRequired,
+        name: propTypes.string.isRequired,
+        whois: propTypes.shape({
+            country: propTypes.string,
+            city: propTypes.string,
+            orgname: propTypes.string,
+        }).isRequired,
+        disallowed: propTypes.bool.isRequired,
+        disallowed_rule: propTypes.string.isRequired,
+    }),
     domain: propTypes.string.isRequired,
-    info: propTypes.oneOfType([
-        propTypes.string,
-        propTypes.shape({
-            name: propTypes.string.isRequired,
-            whois_info: propTypes.shape({
-                country: propTypes.string,
-                city: propTypes.string,
-                orgname: propTypes.string,
-            }),
-            disallowed: propTypes.bool.isRequired,
-            disallowed_rule: propTypes.string.isRequired,
-        }),
-    ]),
     reason: propTypes.string.isRequired,
 };
 

client/src/components/Logs/Cells/index.js

@@ -29,11 +29,12 @@ import DateCell from './DateCell';
 import DomainCell from './DomainCell';
 import ResponseCell from './ResponseCell';
 import ClientCell from './ClientCell';
-import '../Logs.css';
 import { toggleClientBlock } from '../../../actions/access';
 import { getBlockClientInfo, BUTTON_PREFIX } from './helpers';
 import { updateLogs } from '../../../actions/queryLogs';
 
+import '../Logs.css';
+
 const Row = memo(({
     style,
     rowProps,
@@ -61,9 +62,7 @@ const Row = memo(({
             client,
             domain,
             elapsedMs,
-            info,
-            info: { disallowed, disallowed_rule },
-            reason,
+            client_info,
             response,
             time,
             tracker,
@@ -82,11 +81,6 @@ const Row = memo(({
         const autoClient = autoClients
             .find((autoClient) => autoClient.name === client);
 
-        const { whois_info } = info;
-        const country = whois_info?.country;
-        const city = whois_info?.city;
-        const network = whois_info?.orgname;
-
         const source = autoClient?.source;
 
         const formattedElapsedMs = formatElapsedMs(elapsedMs, t);
@@ -111,7 +105,11 @@ const Row = memo(({
             confirmMessage,
             buttonKey: blockingClientKey,
             isNotInAllowedList,
-        } = getBlockClientInfo(client, disallowed, disallowed_rule);
+        } = getBlockClientInfo(
+            client,
+            client_info?.disallowed || false,
+            client_info?.disallowed_rule || '',
+        );
 
         const blockingForClientKey = isFiltered ? 'unblock_for_this_client_only' : 'block_for_this_client_only';
         const clientNameBlockingFor = getBlockingClientName(clients, client);
@@ -122,7 +120,13 @@ const Row = memo(({
 
         const onBlockingClientClick = async () => {
             if (window.confirm(confirmMessage)) {
-                await dispatch(toggleClientBlock(client, disallowed, disallowed_rule));
+                await dispatch(
+                    toggleClientBlock(
+                        client,
+                        client_info?.disallowed || false,
+                        client_info?.disallowed_rule || '',
+                    ),
+                );
                 await dispatch(updateLogs());
                 setModalOpened(false);
             }
@@ -177,10 +181,10 @@ const Row = memo(({
             response_code: status,
             client_details: 'title',
             ip_address: client,
-            name: info?.name || client_id,
-            country,
-            city,
-            network,
+            name: client_info?.name || client_id,
+            country: client_info?.whois?.country,
+            city: client_info?.whois?.city,
+            network: client_info?.whois?.orgname,
             source_label: source,
             validated_with_dnssec: dnssec_enabled ? Boolean(answer_dnssec) : false,
             original_response: originalResponse?.join('\n'),
@@ -219,22 +223,24 @@ Row.propTypes = {
         client: propTypes.string.isRequired,
         domain: propTypes.string.isRequired,
         elapsedMs: propTypes.string.isRequired,
-        info: propTypes.oneOfType([
-            propTypes.string,
-            propTypes.shape({
-                whois_info: propTypes.shape({
-                    country: propTypes.string,
-                    city: propTypes.string,
-                    orgname: propTypes.string,
-                }),
-            })]),
         response: propTypes.array.isRequired,
         time: propTypes.string.isRequired,
         tracker: propTypes.object,
         upstream: propTypes.string.isRequired,
         type: propTypes.string.isRequired,
         client_proto: propTypes.string.isRequired,
         client_id: propTypes.string,
+        client_info: propTypes.shape({
+            ids: propTypes.arrayOf(propTypes.string).isRequired,
+            name: propTypes.string.isRequired,
+            whois: propTypes.shape({
+                country: propTypes.string,
+                city: propTypes.string,
+                orgname: propTypes.string,
+            }).isRequired,
+            disallowed: propTypes.bool.isRequired,
+            disallowed_rule: propTypes.string.isRequired,
+        }),
         rules: propTypes.arrayOf(propTypes.shape({
             text: propTypes.string.isRequired,
             filter_list_id: propTypes.number.isRequired,

client/src/components/Logs/InfiniteTable.js

@@ -56,13 +56,13 @@ const InfiniteTable = ({
     }, []);
 
     const renderRow = (row, idx) => <Row
-                    key={idx}
-                    rowProps={row}
-                    isSmallScreen={isSmallScreen}
-                    setDetailedDataCurrent={setDetailedDataCurrent}
-                    setButtonType={setButtonType}
-                    setModalOpened={setModalOpened}
-            />;
+        key={idx}
+        rowProps={row}
+        isSmallScreen={isSmallScreen}
+        setDetailedDataCurrent={setDetailedDataCurrent}
+        setButtonType={setButtonType}
+        setModalOpened={setModalOpened}
+    />;
 
     const isNothingFound = items.length === 0 && !processingGetLogs;
 

client/src/helpers/helpers.js

@@ -63,6 +63,7 @@ export const normalizeLogs = (logs) => logs.map((log) => {
         client,
         client_proto,
         client_id,
+        client_info,
         elapsedMs,
         question,
         reason,
@@ -101,6 +102,7 @@ export const normalizeLogs = (logs) => logs.map((log) => {
         client,
         client_proto,
         client_id,
+        client_info,
         /* TODO 'filterId' and 'rule' are deprecated, will be removed in 0.106 */
         filterId,
         rule,

internal/dnsforward/dnsforward.go

@@ -375,5 +375,9 @@ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 
 // IsBlockedIP - return TRUE if this client should be blocked
 func (s *Server) IsBlockedIP(ip net.IP) (bool, string) {
+	if ip == nil {
+		return false, ""
+	}
+
 	return s.access.IsBlockedIP(ip)
 }