Drag custom query params to auth layer (e.g., utm_source) (#244)

* remove duplicate group on select view to change the logic from name to id

* fix group bug and add grouping on DNS

* fix setup key issue

docker/init_react_envs.sh

@@ -22,6 +22,10 @@ if [[ -z "${AUTH_AUDIENCE}" ]]; then
     fi
 fi
 
+if [[ "${AUTH_AUDIENCE}" == "none" ]]; then
+    unset AUTH_AUDIENCE
+fi
+
 if [[ -z "${AUTH_SUPPORTED_SCOPES}" ]]; then
     if [[ -z "${AUTH0_DOMAIN}" ]]; then
         echo "AUTH_SUPPORTED_SCOPES environment variable must be set"
@@ -54,11 +58,12 @@ export NETBIRD_MGMT_API_ENDPOINT=$(echo $NETBIRD_MGMT_API_ENDPOINT | sed -E 's/(
 export NETBIRD_MGMT_GRPC_API_ENDPOINT=${NETBIRD_MGMT_GRPC_API_ENDPOINT}
 export NETBIRD_HOTJAR_TRACK_ID=${NETBIRD_HOTJAR_TRACK_ID}
 export NETBIRD_TOKEN_SOURCE=${NETBIRD_TOKEN_SOURCE:-accessToken}
+export NETBIRD_DRAG_QUERY_PARAMS=${NETBIRD_DRAG_QUERY_PARAMS:-false}
 
 echo "NetBird latest version: ${NETBIRD_LATEST_VERSION}"
 
 # replace ENVs in the config
-ENV_STR="\$\$USE_AUTH0 \$\$AUTH_AUDIENCE \$\$AUTH_AUTHORITY \$\$AUTH_CLIENT_ID \$\$AUTH_CLIENT_SECRET \$\$AUTH_SUPPORTED_SCOPES \$\$NETBIRD_MGMT_API_ENDPOINT \$\$NETBIRD_MGMT_GRPC_API_ENDPOINT \$\$NETBIRD_HOTJAR_TRACK_ID \$\$AUTH_REDIRECT_URI \$\$AUTH_SILENT_REDIRECT_URI \$\$NETBIRD_TOKEN_SOURCE"
+ENV_STR="\$\$USE_AUTH0 \$\$AUTH_AUDIENCE \$\$AUTH_AUTHORITY \$\$AUTH_CLIENT_ID \$\$AUTH_CLIENT_SECRET \$\$AUTH_SUPPORTED_SCOPES \$\$NETBIRD_MGMT_API_ENDPOINT \$\$NETBIRD_MGMT_GRPC_API_ENDPOINT \$\$NETBIRD_HOTJAR_TRACK_ID \$\$AUTH_REDIRECT_URI \$\$AUTH_SILENT_REDIRECT_URI \$\$NETBIRD_TOKEN_SOURCE \$\$NETBIRD_DRAG_QUERY_PARAMS"
 
 MAIN_JS=$(find /usr/share/nginx/html/static/js/main.*js)
 OIDC_TRUSTED_DOMAINS="/usr/share/nginx/html/OidcTrustedDomains.js"

src/components/AccessControlEdit.tsx

@@ -630,7 +630,7 @@ const AccessControlEdit = () => {
                                 value={m.id}
                                 serchValue={m.name}
                               >
-                                {optionRender(m.name)}
+                                {optionRender(m.name, m.id)}
                               </Option>
                             ))}
                           </Select>
@@ -790,7 +790,7 @@ const AccessControlEdit = () => {
                                 value={m.id}
                                 serchValue={m.name}
                               >
-                                {optionRender(m.name)}
+                                {optionRender(m.name, m.id)}
                               </Option>
                             ))}
                           </Select>

src/components/AccessControlNew.tsx

@@ -577,7 +577,7 @@ const AccessControlNew = () => {
                       >
                         {tagGroups.map((m, index) => (
                           <Option key={index} value={m.id} serchValue={m.name}>
-                            {optionRender(m.name)}
+                            {optionRender(m.name, m.id)}
                           </Option>
                         ))}
                       </Select>
@@ -733,7 +733,7 @@ const AccessControlNew = () => {
                       >
                         {tagGroups.map((m, index) => (
                           <Option key={index} value={m.id} serchValue={m.name}>
-                            {optionRender(m.name)}
+                            {optionRender(m.name, m.id)}
                           </Option>
                         ))}
                       </Select>

src/components/NameServerGroupAdd.tsx

@@ -751,7 +751,7 @@ const NameServerGroupAdd = () => {
                     >
                       {tagGroups.map((m, index) => (
                         <Option key={index} value={m.id} serchValue={m.name}>
-                          {optionRender(m.name)}
+                          {optionRender(m.name, m.id)}
                         </Option>
                       ))}
                     </Select>

src/components/NameServerGroupUpdate.tsx

@@ -749,7 +749,7 @@ const NameServerGroupUpdate = () => {
                   >
                     {tagGroups.map((m, index) => (
                       <Option key={index} value={m.id} serchValue={m.name}>
-                        {optionRender(m.name)}
+                        {optionRender(m.name, m.id)}
                       </Option>
                     ))}
                   </Select>

src/components/PeerUpdate.tsx

@@ -908,7 +908,7 @@ const PeerUpdate = () => {
                     >
                       {tagGroups.map((m, index) => (
                         <Option key={index} value={m.id} serchValue={m.name}>
-                          {optionRender(m.name)}
+                          {optionRender(m.name, m.id)}
                         </Option>
                       ))}
                     </Select>

src/components/RouteAddNew.tsx

@@ -736,7 +736,7 @@ const RouteAddNew = (selectedPeer: any) => {
                   >
                     {tagGroups.map((m, index) => (
                       <Option key={index} value={m.id} serchValue={m.name}>
-                        {optionRender(m.name)}
+                        {optionRender(m.name, m.id)}
                       </Option>
                     ))}
                   </Select>

src/components/RoutePeerUpdate.tsx

@@ -481,7 +481,7 @@ const RoutePeerUpdate = () => {
                     >
                       {tagGroups.map((m, index) => (
                         <Option key={index} value={m.id} serchValue={m.name}>
-                          {optionRender(m.name)}
+                          {optionRender(m.name, m.id)}
                         </Option>
                       ))}
                     </Select>

src/components/RouteUpdate.tsx

@@ -479,7 +479,7 @@ const RouteAddNew = () => {
                   >
                     {tagGroups.map((m, index) => (
                       <Option key={index} value={m.id} serchValue={m.name}>
-                        {optionRender(m.name)}
+                        {optionRender(m.name, m.id)}
                       </Option>
                     ))}
                   </Select>

src/components/SetupKeyEdit.tsx

@@ -400,7 +400,7 @@ const SetupKeyNew = () => {
                     >
                       {tagGroups.map((m, index) => (
                         <Option key={index} value={m.id} serchValue={m.name}>
-                          {optionRender(m.name)}
+                          {optionRender(m.name, m.id)}
                         </Option>
                       ))}
                     </Select>

src/components/SetupKeyNew.tsx

@@ -70,13 +70,15 @@ const SetupKeyNew = () => {
 
   const createSetupKeyToSave = (): SetupKeyToSave => {
     let [existingGroups, groupsToCreate] = getExistingAndToCreateGroupsLists(
-      formSetupKey.autoGroupNames
+      formSetupKey.autoGroupNames || []
     );
-    const expiresIn = formSetupKey.expires_in * 24 * 3600; // the api expects seconds we have days
+    const expiresIn = formSetupKey.expires_in
+      ? formSetupKey.expires_in * 24 * 3600
+      : 7 * 24 * 3600; // the api expects seconds we have days
     return {
       id: formSetupKey.id,
       name: formSetupKey.name,
-      type: formSetupKey.type,
+      type: formSetupKey.type ? formSetupKey.type : "one-off",
       auto_groups: existingGroups,
       revoked: formSetupKey.revoked,
       groupsToCreate: groupsToCreate,
@@ -147,7 +149,7 @@ const SetupKeyNew = () => {
         type: "one-off",
         key: "",
         last_used: "",
-        expires: "",
+        expires: "7",
         state: "valid",
         auto_groups: [] as string[],
         usage_limit: 0,
@@ -218,25 +220,27 @@ const SetupKeyNew = () => {
   );
 
   const changesDetected = (): boolean => {
+    console.log("formSetupKey", formSetupKey);
     return (
       formSetupKey.name == null ||
       formSetupKey.name !== setupKey.name ||
-      groupsChanged() ||
-      formSetupKey.usage_limit !== setupKey.usage_limit
+      formSetupKey?.usage_limit !== setupKey.usage_limit
     );
   };
 
   const groupsChanged = (): boolean => {
+    console.log("groupsChanged", formSetupKey);
     if (
       setupKey &&
-      setupKey.auto_groups &&
-      formSetupKey.autoGroupNames.length !== setupKey.auto_groups.length
+      setupKey?.auto_groups &&
+      formSetupKey?.autoGroupNames &&
+      formSetupKey?.autoGroupNames.length !== setupKey?.auto_groups.length
     ) {
       return true;
     }
     const formGroupIds =
       groups
-        ?.filter((g) => formSetupKey.autoGroupNames.includes(g.name))
+        ?.filter((g) => formSetupKey?.autoGroupNames.includes(g.name))
         .map((g) => g.id || "") || [];
 
     return (
@@ -281,7 +285,7 @@ const SetupKeyNew = () => {
                   fontSize: "14px",
                   borderRadius: "2px",
                 }}
-                disabled={savedSetupKey.loading || !changesDetected()}
+                disabled={savedSetupKey.loading || !!!formSetupKey.name}
                 onClick={handleFormSubmit}
               >
                 Create key
@@ -342,6 +346,7 @@ const SetupKeyNew = () => {
             onValuesChange={onChange}
             initialValues={{
               usage_limit: 1,
+              expires_in: "7",
             }}
           >
             <Row>
@@ -496,7 +501,6 @@ const SetupKeyNew = () => {
                 <Form.Item
                   style={{ marginTop: "5px", marginBottom: 0 }}
                   name="autoGroupNames"
-                  rules={[{ validator: selectValidator }]}
                 >
                   <Select
                     mode="tags"
@@ -510,7 +514,7 @@ const SetupKeyNew = () => {
                   >
                     {tagGroups.map((m, index) => (
                       <Option key={index} value={m.id} serchValue={m.name}>
-                        {optionRender(m.name)}
+                        {optionRender(m.name, m.id)}
                       </Option>
                     ))}
                   </Select>

src/components/UserEdit.tsx

@@ -425,7 +425,7 @@ const UserEdit = () => {
                       >
                         {tagGroups.map((m, index) => (
                           <Option key={index} value={m.id} serchValue={m.name}>
-                            {optionRender(m.name)}
+                            {optionRender(m.name, m.id)}
                           </Option>
                         ))}
                       </Select>

src/components/popups/InviteUserPopup.tsx

@@ -336,7 +336,7 @@ const InviteUserPopup = () => {
                   >
                     {tagGroups.map((m, index) => (
                       <Option key={index} value={m.id} serchValue={m.name}>
-                        {optionRender(m.name)}
+                        {optionRender(m.name, m.id)}
                       </Option>
                     ))}
                   </Select>

src/config.json

@@ -11,5 +11,6 @@
   "hotjarTrackID": "$NETBIRD_HOTJAR_TRACK_ID",
   "redirectURI": "$AUTH_REDIRECT_URI",
   "silentRedirectURI": "$AUTH_SILENT_REDIRECT_URI",
-  "tokenSource": "$NETBIRD_TOKEN_SOURCE"
+  "tokenSource": "$NETBIRD_TOKEN_SOURCE",
+  "dragQueryParams": "$NETBIRD_DRAG_QUERY_PARAMS"
 }

src/config.ts

@@ -39,5 +39,7 @@ export function getConfig() {
     redirectURI: redirectURI,
     silentRedirectURI: silentRedirectURI,
     tokenSource: tokenSource,
+    // drags all the query params to the auth layer specified in the URL when accessing dashboard.
+    dragQueryParams: configJson.dragQueryParams == "true"
   };
 }

src/index.css

@@ -474,6 +474,18 @@ ul.ant-list-items {
   min-height: 300px;
 }
 
-.route-form.edit-form-wrapper .ant-form-item{
-      margin-bottom: 39px;
+.route-form.edit-form-wrapper .ant-form-item {
+  margin-bottom: 39px;
+}
+
+.groupsSelect {
+  max-width: 200px;
+  width: 100%;
+}
+
+@media (max-width: 1220px) {
+  .groupsSelect{
+    margin-left: 0;
+    margin-top: 15px;
+  }
 }

src/index.tsx

@@ -17,12 +17,29 @@ const config = getConfig();
 // is required for doing logout. Therefore, we need to hardcode the config for auth
 const auth0AuthorityConfig: AuthorityConfiguration = {
     authorization_endpoint: new URL("authorize", config.authority).href,
-    token_endpoint:  new URL("oauth/token", config.authority).href,
+    token_endpoint: new URL("oauth/token", config.authority).href,
     revocation_endpoint: new URL("oauth/revoke", config.authority).href,
     end_session_endpoint: new URL("v2/logout", config.authority).href,
     userinfo_endpoint: new URL("userinfo", config.authority).href,
 } as AuthorityConfiguration
 
+const buildExtras = (config: any) => {
+    type Extras = { [key: string]: string }
+    let extras: Extras = {};
+
+    if (config.dragQueryParams) {
+        const searchParams = new URLSearchParams(window.location.search);
+        searchParams.forEach((value, key) => {
+            extras[key] = value
+        });
+    }
+
+    if (config.audience) {
+        extras.audience = config.audience
+    }
+    return extras
+}
+
 const providerConfig = {
     authority: config.authority,
     client_id: config.clientId,
@@ -34,7 +51,7 @@ const providerConfig = {
     // service_worker_relative_url:'/OidcServiceWorker.js',
     service_worker_only: false,
     authority_configuration: config.auth0Auth ? auth0AuthorityConfig : undefined,
-    ...(config.audience ? {extras: {audience: config.audience}} : null),
+    extras: buildExtras(config),
     ...(config.clientSecret ? {token_request_extras: {client_secret: config.clientSecret}} : null)
 };
 

src/utils/groups.tsx

@@ -18,7 +18,7 @@ export const useGetGroupTagHelpers = () => {
     return tagRender(props, "");
   };
 
-   const tagRender = (props: CustomTagProps, color: string) => {
+  const tagRender = (props: CustomTagProps, color: string) => {
     const { value, closable, onClose } = props;
     const onPreventMouseDown = (event: React.MouseEvent<HTMLSpanElement>) => {
       event.preventDefault();
@@ -77,9 +77,9 @@ export const useGetGroupTagHelpers = () => {
     </>
   );
 
-  const optionRender = (label: string) => {
+  const optionRender = (label: string, id: any) => {
     let peersCount = "";
-    const g = groups.find((_g) => _g.name === label);
+    const g = groups.find((_g) => _g.id === id);
     if (g)
       peersCount = ` - ${g.peers_count || 0} ${
         !g.peers_count || parseInt(g.peers_count) !== 1 ? "peers" : "peer"
@@ -110,7 +110,7 @@ export const useGetGroupTagHelpers = () => {
     return [groupIDList, groupNameListToCreate];
   };
 
-   const getGroupNamesFromIDs = (groupIDList: string[]): string[] => {
+  const getGroupNamesFromIDs = (groupIDList: string[]): string[] => {
     if (!groupIDList) {
       return [];
     }

src/views/DNSSettings.tsx

@@ -11,6 +11,7 @@ import {
   Select,
   Space,
   Typography,
+  SelectProps,
 } from "antd";
 import { useGetTokenSilently } from "../utils/token";
 import { useGetGroupTagHelpers } from "../utils/groups";
@@ -20,7 +21,7 @@ import { actions as nsGroupActions } from "../store/nameservers";
 
 const { Paragraph } = Typography;
 const styleNotification = { marginTop: 85 };
-
+const { Option } = Select;
 export const DNSSettingsForm = () => {
   const { getTokenSilently } = useGetTokenSilently();
   const dispatch = useDispatch();
@@ -62,9 +63,7 @@ export const DNSSettingsForm = () => {
     if (!dnsSettingsData) return;
     dispatch(
       dnsSettingsActions.setDNSSettings({
-        disabled_management_groups: getGroupNamesFromIDs(
-          dnsSettingsData.disabled_management_groups
-        ),
+        disabled_management_groups: dnsSettingsData.disabled_management_groups,
       })
     );
   }, [dnsSettingsData]);
@@ -217,9 +216,12 @@ export const DNSSettingsForm = () => {
                       tagRender={blueTagRender}
                       onChange={handleChangeTags}
                       dropdownRender={dropDownRender}
+                      optionFilterProp="serchValue"
                     >
-                      {tagGroups.map((m) => (
-                        <Select.Option key={m}>{optionRender(m)}</Select.Option>
+                      {tagGroups.map((m, index) => (
+                        <Option key={index} value={m.id} serchValue={m.name}>
+                          {optionRender(m.name, m.id)}
+                        </Option>
                       ))}
                     </Select>
                   </Form.Item>

src/views/Peers.tsx

@@ -49,13 +49,17 @@ import { usePageSizeHelpers } from "../utils/pageSize";
 import AddPeerPopup from "../components/popups/addpeer/addpeer/AddPeerPopup";
 import { getLocalItem, setLocalItem, StorageKey } from "../services/local";
 import { useOidcUser } from "@axa-fr/react-oidc";
+import { useGetGroupTagHelpers } from "../utils/groups";
 
 const { Title, Paragraph, Text } = Typography;
 const { Column } = Table;
 const { confirm } = Modal;
+const { Option } = Select;
 
 export const Peers = () => {
   const { onChangePageSize, pageSizeOptions, pageSize } = usePageSizeHelpers();
+  const { optionRender, blueTagRender, tagGroups, dropDownRender } =
+    useGetGroupTagHelpers();
 
   const { getTokenSilently } = useGetTokenSilently();
   const dispatch = useDispatch();
@@ -79,6 +83,7 @@ export const Peers = () => {
   const [isAdmin, setIsAdmin] = useState(false);
 
   const [textToSearch, setTextToSearch] = useState("");
+  const [groupsFilterArray, setGroupsFilterArray] = useState([]);
   const [optionOnOff, setOptionOnOff] = useState("all");
   const [dataTable, setDataTable] = useState([] as PeerDataTable[]);
   const [peerToAction, setPeerToAction] = useState(
@@ -124,7 +129,7 @@ export const Peers = () => {
   }, [users]);
 
   useEffect(() => {
-    if ((!loading && peers && groups)) {
+    if (!loading && peers && groups) {
       const quickFilter = getFilterState("peerFilter", "quickFilter");
       if (quickFilter) setOptionOnOff(quickFilter);
 
@@ -134,8 +139,13 @@ export const Peers = () => {
       const pageSize = getFilterState("peerFilter", "pageSize");
       if (pageSize) onChangePageSize(pageSize, "peerFilter");
 
-      if (quickFilter || searchText || pageSize) {
-        setDataTable(transformDataTable(filterDataTable(searchText)));
+      const groupFilter = getFilterState("peerFilter", "groupFilter") || [];
+      if (groupFilter) setGroupsFilterArray(groupFilter);
+
+      if (quickFilter || searchText || pageSize || groupFilter) {
+        setDataTable(
+          transformDataTable(filterDataTable(searchText, groupFilter))
+        );
       } else {
         setDataTable(transformDataTable(peers));
       }
@@ -198,7 +208,7 @@ export const Peers = () => {
   }, [peers, groups]);
 
   useEffect(() => {
-    setDataTable(transformDataTable(filterDataTable("")));
+    setDataTable(transformDataTable(filterDataTable("", groupsFilterArray)));
   }, [textToSearch, optionOnOff]);
 
   const deleteKey = "deleting";
@@ -226,10 +236,16 @@ export const Peers = () => {
     }
   }, [deletedPeer]);
 
-  const filterDataTable = (searchText: string): Peer[] => {
-        const t = searchText
-          ? searchText.toLowerCase().trim()
-          : textToSearch.toLowerCase().trim();
+  const handleGroupChange = (value: any) => {
+    setGroupsFilterArray(value);
+    storeFilterState("peerFilter", "groupFilter", value);
+    setDataTable(transformDataTable(filterDataTable(textToSearch, value)));
+  };
+
+  const filterDataTable = (searchText: string, groupIDs: string[]): Peer[] => {
+    const t = searchText
+      ? searchText.toLowerCase().trim()
+      : textToSearch.toLowerCase().trim();
     let f: Peer[] = filter(peers, (f: Peer) => {
       let userEmail: string | null;
       const u = users?.find((u) => u.id === f.user_id)?.email;
@@ -246,21 +262,24 @@ export const Peers = () => {
     if (optionOnOff === "on") {
       f = filter(peers, (f: Peer) => f.connected);
     }
-    return f;
-  };
 
-  const getGroupNamesFromIDs = (
-    groupIDList: string[] | undefined
-  ): string[] => {
-    if (!groupIDList) {
-      return [];
+    let filterByGroupArray: any = [];
+    let tempFilterByGroupArray: any = [];
+    if (groupIDs.length) {
+      f.forEach((element) => {
+        element.groups?.forEach((element2) => {
+          if (element2.id && groupIDs.includes(element2.id)) {
+            if (!tempFilterByGroupArray.includes(element.id)) {
+              filterByGroupArray.push(element);
+              tempFilterByGroupArray.push(element.id);
+            }
+          }
+        });
+      });
+      f = filterByGroupArray;
     }
 
-    return (
-      groups
-        ?.filter((g) => groupIDList.includes(g.id!))
-        .map((g) => g.name || "") || []
-    );
+    return f;
   };
 
   const onChangeTextToSearch = (
@@ -626,7 +645,7 @@ export const Peers = () => {
                         allowClear
                         value={textToSearch}
                         // onPressEnter={searchDataTable}
-                        placeholder="Search by name, IP or owner..."
+                        placeholder="Search by name, IP, owner, or group..."
                         onChange={onChangeTextToSearch}
                       />
                     </Col>
@@ -639,7 +658,7 @@ export const Peers = () => {
                       xxl={11}
                       span={11}
                     >
-                      <Space size="middle">
+                      <Space size="middle" style={{ marginRight: "15px" }}>
                         <Radio.Group
                           options={optionsOnOff}
                           onChange={onChangeOnOff}
@@ -658,6 +677,23 @@ export const Peers = () => {
                           className="select-rows-per-page-en"
                         />
                       </Space>
+
+                      <Select
+                        mode="tags"
+                        placeholder="Filter by groups"
+                        tagRender={blueTagRender}
+                        // dropdownRender={dropDownRender}
+                        optionFilterProp="serchValue"
+                        className="groupsSelect"
+                        onChange={handleGroupChange}
+                        value={groupsFilterArray}
+                      >
+                        {tagGroups.map((m, index) => (
+                          <Option key={index} value={m.id} serchValue={m.name}>
+                            {optionRender(m.name, m.id)}
+                          </Option>
+                        ))}
+                      </Select>
                     </Col>
                     <Col xs={24} sm={24} md={5} lg={5} xl={5} xxl={5} span={5}>
                       <Row justify="end">