feat: Add tags for GitHub integration FE (#4035)

Flagsmith · Aug 12, 2024 · 3c46a31 · 3c46a31
1 parent 7920e8e
commit 3c46a31
Show file tree

Hide file tree

Showing 12 changed files with 327 additions and 106 deletions.
diff --git a/frontend/common/constants.ts b/frontend/common/constants.ts
@@ -228,7 +228,6 @@ export default {
       ),
       'iOS': require('./code-help/traits/traits-ios')(envId, keywords, userId),
     }),
-
     keys: {
       'Java': 'java',
       'JavaScript': 'javascript',

diff --git a/frontend/common/services/useGithubRepository.ts b/frontend/common/services/useGithubRepository.ts
@@ -43,7 +43,7 @@ export const githubRepositoryService = service
       >({
         invalidatesTags: [{ id: 'LIST', type: 'GithubRepository' }],
         query: (query: Req['updateGithubRepository']) => ({
-          body: query,
+          body: query.body,
           method: 'PUT',
           url: `organisations/${query.organisation_id}/integrations/github/${query.github_id}/repositories/${query.id}/`,
         }),

diff --git a/frontend/common/types/requests.ts b/frontend/common/types/requests.ts
@@ -397,6 +397,12 @@ export type Req = {
     organisation_id: string
     github_id: string
     id: string
+    body: {
+      project: number
+      repository_name: string
+      repository_owner: string
+      tagging_enabled: boolean
+    }
   }
   deleteGithubRepository: {
     organisation_id: string

diff --git a/frontend/common/types/responses.ts b/frontend/common/types/responses.ts
@@ -115,7 +115,7 @@ export type ExternalResource = {
   url: string
   type: string
   project?: number
-  metadata?: { state?: string; title?: string }
+  metadata?: { [key: string]: string | number | boolean }
   feature: number
 }
 
@@ -160,12 +160,14 @@ export type LaunchDarklyProjectImport = {
   project: number
 }
 
-export type GithubResources = {
+export type GithubResource = {
   html_url: string
   id: number
   number: number
   title: string
   state: string
+  merged: boolean
+  draft: boolean
 }
 
 export type GithubPaginatedRepos<T> = {
@@ -187,6 +189,7 @@ export type GithubRepository = {
   project: number
   repository_owner: string
   repository_name: string
+  tagging_enabled: boolean
 }
 
 export type githubIntegration = {
@@ -685,7 +688,7 @@ export type Res = {
   externalResource: PagedResponse<ExternalResource>
   githubIntegrations: PagedResponse<githubIntegration>
   githubRepository: PagedResponse<GithubRepository>
-  githubResources: GitHubPagedResponse<GithubResources>
+  githubResources: GitHubPagedResponse<GithubResource>
   githubRepos: GithubPaginatedRepos<Repository>
   segmentPriorities: {}
   featureSegment: FeatureState['feature_segment']

diff --git a/frontend/common/useInfiniteScroll.ts b/frontend/common/useInfiniteScroll.ts
@@ -55,8 +55,11 @@ const useInfiniteScroll = <
   }, throttle)
 
   const refresh = useCallback(() => {
-    setLocalPage(1)
-  }, [])
+    queryResponse.refetch().then((newData) => {
+      setCombinedData(newData as unknown as RES)
+      setLocalPage(1)
+    })
+  }, [queryResponse])
 
   const loadMore = () => {
     if (queryResponse?.data?.next) {
@@ -70,6 +73,7 @@ const useInfiniteScroll = <
     isLoading: queryResponse.isLoading,
     loadMore,
     loadingCombinedData: loadingCombinedData && queryResponse.isFetching,
+    // refetchData,
     refresh,
     response: queryResponse,
     searchItems,

diff --git a/frontend/web/components/ExternalResourcesLinkTab.tsx b/frontend/web/components/ExternalResourcesLinkTab.tsx
@@ -3,23 +3,26 @@ import MyRepositoriesSelect from './MyRepositoriesSelect'
 import ExternalResourcesTable, {
   ExternalResourcesTableBase,
 } from './ExternalResourcesTable'
-import { ExternalResource } from 'common/types/responses'
+import { ExternalResource, GithubResource } from 'common/types/responses'
 import { GitHubResourceSelectProvider } from './GitHubResourceSelectProvider'
 import { useCreateExternalResourceMutation } from 'common/services/useExternalResource'
 import Constants from 'common/constants'
 import Button from './base/forms/Button'
 import GitHubResourcesSelect from './GitHubResourcesSelect'
 import _ from 'lodash'
+import AppActions from 'common/dispatcher/app-actions'
 
 type ExternalResourcesLinkTabType = {
   githubId: string
   organisationId: string
   featureId: string
   projectId: string
+  environmentId: string
 }
 
 type AddExternalResourceRowType = ExternalResourcesTableBase & {
   linkedExternalResources?: ExternalResource[]
+  environmentId: string
 }
 
 type GitHubStatusType = {
@@ -28,6 +31,7 @@ type GitHubStatusType = {
 }
 
 const AddExternalResourceRow: FC<AddExternalResourceRowType> = ({
+  environmentId,
   featureId,
   linkedExternalResources,
   organisationId,
@@ -36,8 +40,9 @@ const AddExternalResourceRow: FC<AddExternalResourceRowType> = ({
   repoOwner,
 }) => {
   const [externalResourceType, setExternalResourceType] = useState<string>('')
-  const [featureExternalResource, setFeatureExternalResource] =
-    useState<string>('')
+  const [featureExternalResource, setFeatureExternalResource] = useState<
+    GithubResource | undefined
+  >(undefined)
   const [lastSavedResource, setLastSavedResource] = useState<
     string | undefined
   >(undefined)
@@ -68,11 +73,13 @@ const AddExternalResourceRow: FC<AddExternalResourceRowType> = ({
               repoOwner={repoOwner}
               repoName={repoName}
               githubResource={
-                (
-                  _.find(_.values(Constants.resourceTypes), {
-                    label: externalResourceType!,
-                  }) as any
-                ).resourceType || ''
+                (externalResourceType &&
+                  (
+                    _.find(_.values(Constants.resourceTypes), {
+                      label: externalResourceType!,
+                    }) as any
+                  ).resourceType) ||
+                ''
               }
             >
               <GitHubResourcesSelect
@@ -94,19 +101,29 @@ const AddExternalResourceRow: FC<AddExternalResourceRowType> = ({
                     key as keyof typeof Constants.resourceTypes
                   ].label === externalResourceType,
               )
-              createExternalResource({
-                body: {
-                  feature: parseInt(featureId),
-                  metadata: {},
-                  type: type!,
-                  url: featureExternalResource,
-                },
-                feature_id: featureId,
-                project_id: projectId,
-              }).then(() => {
-                toast('External Resource Added')
-                setLastSavedResource(featureExternalResource)
-              })
+              if (type && featureExternalResource) {
+                createExternalResource({
+                  body: {
+                    feature: parseInt(featureId),
+                    metadata: {
+                      'draft': featureExternalResource.draft,
+                      'merged': featureExternalResource.merged,
+                      'state': featureExternalResource.state,
+                      'title': featureExternalResource.title,
+                    },
+                    type: type,
+                    url: featureExternalResource.html_url,
+                  },
+                  feature_id: featureId,
+                  project_id: projectId,
+                }).then(() => {
+                  toast('External Resource Added')
+                  setLastSavedResource(featureExternalResource.html_url)
+                  AppActions.refreshFeatures(parseInt(projectId), environmentId)
+                })
+              } else {
+                throw new Error('Invalid External Resource Data')
+              }
             }}
           >
             Save
@@ -118,6 +135,7 @@ const AddExternalResourceRow: FC<AddExternalResourceRowType> = ({
 }
 
 const ExternalResourcesLinkTab: FC<ExternalResourcesLinkTabType> = ({
+  environmentId,
   featureId,
   githubId,
   organisationId,
@@ -157,6 +175,7 @@ const ExternalResourcesLinkTab: FC<ExternalResourcesLinkTabType> = ({
         />
         {repoName && repoOwner && (
           <AddExternalResourceRow
+            environmentId={environmentId}
             featureId={featureId}
             projectId={projectId}
             organisationId={organisationId}

diff --git a/frontend/web/components/GitHubResourceSelectProvider.tsx b/frontend/web/components/GitHubResourceSelectProvider.tsx
@@ -1,6 +1,6 @@
 import { createContext, useContext, FC, useEffect, useState } from 'react'
 import { useGetGithubResourcesQuery } from 'common/services/useGithub'
-import { ExternalResource, GithubResources, Res } from 'common/types/responses'
+import { ExternalResource, GithubResource, Res } from 'common/types/responses'
 import useInfiniteScroll from 'common/useInfiniteScroll'
 import { Req } from 'common/types/requests'
 
@@ -17,13 +17,14 @@ type GitHubResourceSelectProviderType = {
 
 type GitHubResourceSelectContextType = {
   count: number
-  githubResources?: GithubResources[]
+  githubResources?: GithubResource[]
   isFetching: boolean
   isLoading: boolean
   loadMore: () => void
   loadingCombinedData: boolean
   nextPage?: string
   searchItems: (search: string) => void
+  refresh: () => void
 }
 
 const GitHubResourceSelectContext = createContext<
@@ -34,7 +35,7 @@ export const GitHubResourceSelectProvider: FC<
   GitHubResourceSelectProviderType
 > = ({ children, ...props }) => {
   const [externalResourcesSelect, setExternalResourcesSelect] =
-    useState<GithubResources[]>()
+    useState<GithubResource[]>()
 
   const throttleDelay = 300
 
@@ -44,6 +45,7 @@ export const GitHubResourceSelectProvider: FC<
     isLoading,
     loadMore,
     loadingCombinedData,
+    refresh,
     searchItems,
   } = useInfiniteScroll<Req['getGithubResources'], Res['githubResources']>(
     useGetGithubResourcesQuery,
@@ -62,7 +64,7 @@ export const GitHubResourceSelectProvider: FC<
   useEffect(() => {
     if (results && props.linkedExternalResources) {
       setExternalResourcesSelect(
-        results.filter((i: GithubResources) => {
+        results.filter((i: GithubResource) => {
           const same = props.linkedExternalResources?.some(
             (r) => i.html_url === r.url,
           )
@@ -84,6 +86,7 @@ export const GitHubResourceSelectProvider: FC<
         loadMore,
         loadingCombinedData,
         nextPage: next,
+        refresh,
         searchItems,
       }}
     >

diff --git a/frontend/web/components/GitHubResourcesSelect.tsx b/frontend/web/components/GitHubResourcesSelect.tsx
@@ -1,9 +1,13 @@
 import React, { FC, useEffect, useRef, useState } from 'react'
-import { GithubResources } from 'common/types/responses'
+import { GithubResource } from 'common/types/responses'
 import Utils from 'common/utils/utils'
 import { FixedSizeList } from 'react-window'
 import InfiniteLoader from 'react-window-infinite-loader'
 import { useGitHubResourceSelectProvider } from './GitHubResourceSelectProvider'
+import { components } from 'react-select'
+import Button from './base/forms/Button'
+import Icon from './Icon'
+import Select from 'react-select'
 
 type MenuListType = {
   children: React.ReactNode
@@ -106,6 +110,23 @@ const MenuList: FC<MenuListType> = ({
   )
 }
 
+const CustomControl = ({
+  children,
+  ...props
+}: {
+  children: React.ReactNode
+}) => {
+  const { refresh } = useGitHubResourceSelectProvider()
+  return (
+    <components.Control {...props}>
+      {children}
+      <Button style={{ marginLeft: 'auto' }} theme='icon' onClick={refresh}>
+        <Icon name='refresh' />
+      </Button>
+    </components.Control>
+  )
+}
+
 export type GitHubResourcesSelectType = {
   onChange: (value: string) => void
   lastSavedResource: string | undefined
@@ -119,15 +140,8 @@ const GitHubResourcesSelect: FC<GitHubResourcesSelectType> = ({
   lastSavedResource,
   onChange,
 }) => {
-  const {
-    githubResources,
-    isFetching,
-    isLoading,
-    loadMore,
-    loadingCombinedData,
-    nextPage,
-    searchItems,
-  } = useGitHubResourceSelectProvider()
+  const { githubResources, isFetching, isLoading, searchItems } =
+    useGitHubResourceSelectProvider()
   const [selectedOption, setSelectedOption] =
     useState<GitHubResourcesValueType | null>(null)
   const [searchText, setSearchText] = React.useState('')
@@ -152,11 +166,10 @@ const GitHubResourcesSelect: FC<GitHubResourcesSelectType> = ({
           onChange(v?.value)
         }}
         isClearable={true}
-        options={githubResources?.map((i: GithubResources) => {
+        options={githubResources?.map((i: GithubResource) => {
           return {
             label: `${i.title} #${i.number}`,
-            status: i.state,
-            value: i.html_url,
+            value: i,
           }
         })}
         noOptionsMessage={() =>
@@ -171,6 +184,7 @@ const GitHubResourcesSelect: FC<GitHubResourcesSelectType> = ({
           searchItems(Utils.safeParseEventValue(e))
         }}
         components={{
+          Control: CustomControl,
           MenuList,
         }}
         data={{ searchText }}
-Original file line number
+Diff line change
@@ Expand Up / @@ -228,7 +228,6 @@ export default { @@
           ),
           'iOS': require('./code-help/traits/traits-ios')(envId, keywords, userId),
         }),
         keys: {
           'Java': 'java',
           'JavaScript': 'javascript',
@@ Expand Down @@