Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 47 additions & 16 deletions apps/studio/hooks/misc/useCheckPermissions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import { usePermissionsQuery } from 'data/permissions/permissions-query'
import { useProjectDetailQuery } from 'data/projects/project-detail-query'
import { IS_PLATFORM } from 'lib/constants'
import type { Permission } from 'types'
import { useSelectedOrganization } from './useSelectedOrganization'
import { useSelectedProject } from './useSelectedProject'
import { useSelectedOrganizationQuery } from './useSelectedOrganization'
import { useSelectedProjectQuery } from './useSelectedProject'

const toRegexpString = (actionOrResource: string) =>
`^${actionOrResource.replace('.', '\\.').replace('%', '.*')}$`
Expand Down Expand Up @@ -80,30 +80,50 @@ export function useGetProjectPermissions(
projectRefOverride?: string,
enabled = true
) {
const { data, isLoading, isSuccess } = usePermissionsQuery({
const {
data,
isLoading: isLoadingPermissions,
isSuccess: isSuccessPermissions,
} = usePermissionsQuery({
enabled: permissionsOverride === undefined && enabled,
})

const permissions = permissionsOverride === undefined ? data : permissionsOverride

const organizationResult = useSelectedOrganization({
enabled: organizationSlugOverride === undefined && enabled,
const organizationsQueryEnabled = organizationSlugOverride === undefined && enabled
const {
data: organizationData,
isLoading: isLoadingOrganization,
isSuccess: isSuccessOrganization,
} = useSelectedOrganizationQuery({
enabled: organizationsQueryEnabled,
})

const organization =
organizationSlugOverride === undefined ? organizationResult : { slug: organizationSlugOverride }
organizationSlugOverride === undefined ? organizationData : { slug: organizationSlugOverride }
const organizationSlug = organization?.slug

const projectResult = useSelectedProject({
enabled: projectRefOverride === undefined && enabled,
const projectsQueryEnabled = projectRefOverride === undefined && enabled
const {
data: projectData,
isLoading: isLoadingProject,
isSuccess: isSuccessProject,
} = useSelectedProjectQuery({
enabled: projectsQueryEnabled,
})

const project =
projectRefOverride === undefined || projectResult?.parent_project_ref
? projectResult
projectRefOverride === undefined || projectData?.parent_project_ref
? projectData
: { ref: projectRefOverride, parent_project_ref: undefined }
const projectRef = project?.parent_project_ref ? project.parent_project_ref : project?.ref

const isLoading =
isLoadingPermissions ||
(organizationsQueryEnabled && isLoadingOrganization) ||
(projectsQueryEnabled && isLoadingProject)
const isSuccess =
isSuccessPermissions &&
(!organizationsQueryEnabled || isSuccessOrganization) &&
(!projectsQueryEnabled || isSuccessProject)

return {
permissions,
organizationSlug,
Expand Down Expand Up @@ -196,22 +216,33 @@ export function useAsyncCheckProjectPermissions(
isSuccess: isPermissionsSuccess,
} = useGetProjectPermissions(permissions, organizationSlug, projectRef, isLoggedIn)

if (!isLoggedIn)
if (!isLoggedIn) {
return {
isLoading: true,
isSuccess: false,
can: false,
}
if (!IS_PLATFORM)
}
if (!IS_PLATFORM) {
return {
isLoading: false,
isSuccess: true,
can: true,
}
}

const can = doPermissionsCheck(
allPermissions,
action,
resource,
data,
_organizationSlug,
_projectRef
)

return {
isLoading: isPermissionsLoading,
isSuccess: isPermissionsSuccess,
can: doPermissionsCheck(allPermissions, action, resource, data, _organizationSlug, _projectRef),
can,
}
}
32 changes: 31 additions & 1 deletion apps/studio/hooks/misc/useSelectedOrganization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,20 @@ import { useIsLoggedIn, useParams } from 'common'
import { useOrganizationsQuery } from 'data/organizations/organizations-query'
import { useMemo } from 'react'

import { useProjectByRef } from './useSelectedProject'
import { useProjectByRef, useProjectByRefQuery } from './useSelectedProject'

/**
* @deprecated Use useSelectedOrganizationQuery instead for access to loading states etc
*
* Example migration:
* ```
* // Old:
* const organization = useSelectedOrganization(ref)
*
* // New:
* const { data: organization } = useSelectedOrganizationQuery(ref)
* ```
*/
export function useSelectedOrganization({ enabled = true } = {}) {
const isLoggedIn = useIsLoggedIn()

Expand All @@ -20,3 +32,21 @@ export function useSelectedOrganization({ enabled = true } = {}) {
})
}, [data, selectedProject, slug])
}

export function useSelectedOrganizationQuery({ enabled = true } = {}) {
const isLoggedIn = useIsLoggedIn()

const { ref, slug } = useParams()
const { data: selectedProject } = useProjectByRefQuery(ref)

return useOrganizationsQuery({
enabled: isLoggedIn && enabled,
select: (data) => {
return data.find((org) => {
if (slug !== undefined) return org.slug === slug
if (selectedProject !== undefined) return org.id === selectedProject.organization_id
return undefined
})
},
})
}
60 changes: 60 additions & 0 deletions apps/studio/hooks/misc/useSelectedProject.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ import { useProjectDetailQuery } from 'data/projects/project-detail-query'
import { ProjectInfo, useProjectsQuery } from 'data/projects/projects-query'
import { PROVIDERS } from 'lib/constants'

/**
* @deprecated Use useSelectedProjectQuery instead for access to loading states etc
*
* Example migration:
* ```
* // Old:
* const project = useSelectedProject()
*
* // New:
* const { data: project } = useSelectedProjectQuery()
* ```
*/
export function useSelectedProject({ enabled = true } = {}) {
const { ref } = useParams()
const { data } = useProjectDetailQuery({ ref }, { enabled })
Expand All @@ -15,6 +27,32 @@ export function useSelectedProject({ enabled = true } = {}) {
)
}

export function useSelectedProjectQuery({ enabled = true } = {}) {
const { ref } = useParams()

return useProjectDetailQuery(
{ ref },
{
enabled,
select: (data) => {
return { ...data, parentRef: data.parent_project_ref ?? data.ref }
},
}
)
}

/**
* @deprecated Use useProjectByRefQuery instead for access to loading states etc
*
* Example migration:
* ```
* // Old:
* const project = useProjectByRef(ref)
*
* // New:
* const { data: project } = useProjectByRefQuery(ref)
* ```
*/
export function useProjectByRef(
ref?: string
): Omit<ProjectInfo, 'organization_slug' | 'preview_branch_refs'> | undefined {
Expand All @@ -34,6 +72,28 @@ export function useProjectByRef(
}, [project, projects, ref])
}

export function useProjectByRefQuery(ref?: string) {
const isLoggedIn = useIsLoggedIn()

const projectQuery = useProjectDetailQuery({ ref }, { enabled: isLoggedIn })

// [Alaister]: This is here for the purpose of improving performance.
// Chances are, the user will already have the list of projects in the cache.
// We can't exclusively rely on this method, as useProjectsQuery does not return branch projects.
const projectsQuery = useProjectsQuery({
enabled: isLoggedIn,
select: (data) => {
return data.find((project) => project.ref === ref)
},
})

if (projectQuery.isSuccess) {
return projectQuery
}

return projectsQuery
}

export const useIsAwsCloudProvider = () => {
const project = useSelectedProject()
const isAws = project?.cloud_provider === PROVIDERS.AWS.id
Expand Down
2 changes: 1 addition & 1 deletion apps/studio/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"@graphiql/react": "^0.19.4",
"@graphiql/toolkit": "^0.9.1",
"@gregnr/postgres-meta": "^0.82.0-dev.2",
"@hcaptcha/react-hcaptcha": "^1.11.1",
"@hcaptcha/react-hcaptcha": "^1.12.0",
"@headlessui/react": "^1.7.17",
"@heroicons/react": "^2.1.3",
"@hookform/resolvers": "^3.1.1",
Expand Down
2 changes: 1 addition & 1 deletion apps/www/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"dependencies": {
"@code-hike/mdx": "^0.9.0",
"@codesandbox/sandpack-react": "^2.20.0",
"@hcaptcha/react-hcaptcha": "^1.11.1",
"@hcaptcha/react-hcaptcha": "^1.12.0",
"@heroicons/react": "^1.0.6",
"@mdx-js/react": "^2.3.0",
"@next/bundle-analyzer": "15.3.1",
Expand Down
28 changes: 14 additions & 14 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading