Merge branch 'main' into j-s/signed-court-record-police

Author: unakb

apps/portals/my-pages/src/components/Loaders/AuthOverlay/AuthOverlay.tsx

@@ -2,11 +2,11 @@ import { Text } from '@island.is/island-ui/core'
 import { useLocale } from '@island.is/localization'
 import { m } from '@island.is/portals/my-pages/core'
 
-import { useBff } from '@island.is/react-spa/bff'
+import { useAuth } from '@island.is/react-spa/bff'
 import * as styles from './AuthOverlay.css'
 
 const AuthOverlay = () => {
-  const { authState } = useBff()
+  const { authState } = useAuth()
   const { formatMessage } = useLocale()
 
   if (authState === 'switching')

apps/services/bff/README.md

@@ -37,3 +37,7 @@ Runs tests with Jest and outputs coverage to `coverage/apps/services/bff`.
 ## Code owners and maintainers
 
 - [Aranja](https://github.com/orgs/island-is/teams/aranja/members)
+
+## Troubleshooting
+
+If you encounter any issues while setting up or running the BFF service, please refer to the [Troubleshooting Guide](TROUBLESHOOT_GUIDE.md)

apps/services/bff/TROUBLESHOOT_GUIDE.md

@@ -0,0 +1,37 @@
+# BFF Service Troubleshooting Guide
+
+## Common Issues and Solutions
+
+- Make sure that you are running the `dev` script and not `start` script. For example when running the service portal you should run:
+  `yarn dev service-portal` and not `yarn start service-portal`.
+
+- Make sure to install dependencies and run code generation with the following command:
+  `yarn install && yarn codegen`.
+
+- Make sure to login to the correct AWS account and region:
+
+  - Run `aws sso login --profile islandis-dev` to login to the correct AWS account.
+
+- Not necessary but a nice to have is to have Redis server running:
+
+  - Run `yarn dev-services services-bff` to start Redis server.
+  - This is necessary if you want the sessions to persist.
+
+- Make sure that you are not running the same service twice, since you could already be running a service like API.
+  Lets take `yarn dev application-system-form` as an example. This script starts the following services:
+
+  - `yarn get-secrets application-system-api`
+  - `yarn nx run application-system-api:dev-services`
+  - `yarn nx run application-system-api:migrate`
+  - `yarn nx codegen/backend-schema api`
+  - `yarn nx run services-user-profile:dev-init`
+  - `yarn nx run service-portal:start-bff`
+  - `yarn start application-system-form`
+    So make sure that you are not running the same service twice.
+
+- If you are running the service on Windows, we recommend using [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) for running the services within the repo.
+  This is because all of the scripts generated by the `infra` package are not tested on Windows and may not work as expected.
+
+- On macOS, the AirPlay Receiver is listening on the same port as the Redis server, e.g. 7000. Either change the port or disable the AirPlay Receiver.
+
+- If everything fails, then a good old computer restart might do the trick.

libs/application/ui-shell/src/components/DelegationsScreen.tsx

@@ -16,7 +16,7 @@ import {
   Text,
 } from '@island.is/island-ui/core'
 import { useLocale } from '@island.is/localization'
-import { useBff } from '@island.is/react-spa/bff'
+import { useAuth } from '@island.is/react-spa/bff'
 import { useFeatureFlagClient } from '@island.is/react/feature-flags'
 import * as kennitala from 'kennitala'
 import { format as formatKennitala } from 'kennitala'
@@ -50,7 +50,7 @@ export const DelegationsScreen = ({
   })
   const { formatMessage } = useLocale()
   const type = getTypeFromSlug(slug)
-  const { switchUser, userInfo: user } = useBff()
+  const { switchUser, userInfo: user } = useAuth()
   const featureFlagClient: FeatureFlagClient = useFeatureFlagClient()
   const navigate = useNavigate()
 

libs/react-spa/bff/src/lib/BffPoller.tsx

@@ -3,7 +3,7 @@ import { BffUser } from '@island.is/shared/types'
 import { ReactNode, useCallback, useEffect, useMemo } from 'react'
 import {
   BffBroadcastEvents,
-  useBff,
+  useAuth,
   useBffBroadcaster,
   useUserInfo,
 } from './bff.hooks'
@@ -43,7 +43,7 @@ export const BffPoller = ({
   newSessionCb,
   pollIntervalMS = 10000,
 }: BffPollerProps) => {
-  const { signIn, bffUrlGenerator } = useBff()
+  const { signIn, bffUrlGenerator } = useAuth()
   const userInfo = useUserInfo()
   const { postMessage } = useBffBroadcaster()
 

libs/react-spa/bff/src/lib/bff.hooks.ts

@@ -8,11 +8,11 @@ import { BffContext, BffContextType } from './BffContext'
 /**
  * This hook is used to get the BFF authentication context.
  */
-export const useBff = () => {
+export const useAuth = () => {
   const bffContext = useContext(BffContext)
 
   if (!bffContext) {
-    throw new Error('useBff must be used within a BffProvider')
+    throw new Error('useAuth must be used within a BffProvider')
   }
 
   return bffContext
@@ -24,7 +24,7 @@ export const useBff = () => {
 export const useDynamicBffHook = <Key extends keyof BffContextType>(
   returnField: Key,
 ): NonNullable<BffContextType[Key]> => {
-  const bffContext = useBff()
+  const bffContext = useAuth()
 
   if (!isDefined(bffContext[returnField])) {
     throw new Error(`The field ${returnField} does not exist in the BffContext`)

libs/shared/components/src/auth/UserMenu/UserDelegations.tsx

@@ -1,6 +1,6 @@
 import { Box, Stack } from '@island.is/island-ui/core'
 import { useLocale } from '@island.is/localization'
-import { useBff, useUserInfo } from '@island.is/react-spa/bff'
+import { useAuth, useUserInfo } from '@island.is/react-spa/bff'
 import { userMessages } from '@island.is/shared/translations'
 import { UserDropdownItem } from './UserDropdownItem'
 import { UserTopicCard } from './UserTopicCard'
@@ -16,7 +16,7 @@ export const UserDelegations = ({
 }: UserDelegationsProps) => {
   const user = useUserInfo()
   const { formatMessage } = useLocale()
-  const { switchUser } = useBff()
+  const { switchUser } = useAuth()
   const actor = user.profile.actor
 
   return (

libs/shared/components/src/auth/UserMenu/UserMenu.tsx

@@ -1,5 +1,5 @@
 import { Box, Hidden } from '@island.is/island-ui/core'
-import { useBff } from '@island.is/react-spa/bff'
+import { useAuth } from '@island.is/react-spa/bff'
 import { useEffect, useState } from 'react'
 import { UserButton } from './UserButton'
 import { UserDropdown } from './UserDropdown'
@@ -29,7 +29,7 @@ export const UserMenu = ({
   const [dropdownState, setDropdownState] = useState<'closed' | 'open'>(
     'closed',
   )
-  const { signOut, switchUser, userInfo: user } = useBff()
+  const { signOut, switchUser, userInfo: user } = useAuth()
 
   const handleClick = () => {
     setDropdownState(dropdownState === 'open' ? 'closed' : 'open')