|
| 1 | +import { renderHook } from '@testing-library/react-hooks' |
| 2 | +import { describe, it, expect, vi } from 'vitest' |
| 3 | +import dedent from 'dedent' |
| 4 | + |
| 5 | +import { FileNotFound } from 'containers/Bucket/errors' |
| 6 | +import Log from 'utils/Logging' |
| 7 | +import * as Request from 'utils/useRequest' |
| 8 | +import type { Successor } from 'utils/workflows' |
| 9 | + |
| 10 | +import useSuccessors from './useSuccessors' |
| 11 | + |
| 12 | +vi.mock('constants/config', () => ({ default: {} })) |
| 13 | + |
| 14 | +// Create a stable S3 client instance |
| 15 | +const s3 = { |
| 16 | + headObject: vi.fn(() => ({ promise: () => Promise.resolve({}) })), |
| 17 | + getObject: vi.fn(), |
| 18 | +} |
| 19 | + |
| 20 | +vi.mock('utils/AWS', () => ({ S3: { use: () => s3 } })) |
| 21 | + |
| 22 | +describe('useSuccessors integration tests', () => { |
| 23 | + const CURRENT_BUCKET = 'foo-bucket' |
| 24 | + |
| 25 | + const SUCCESSOR_FOR_CURRENT_BUCKET = { |
| 26 | + copyData: true, |
| 27 | + name: CURRENT_BUCKET, |
| 28 | + slug: CURRENT_BUCKET, |
| 29 | + url: `s3://${CURRENT_BUCKET}`, |
| 30 | + } |
| 31 | + |
| 32 | + // Helper function to mock S3 getObject to return YAML config |
| 33 | + const mockS3ConfigYaml = (yamlString: string) => { |
| 34 | + s3.getObject.mockReturnValue({ |
| 35 | + promise: () => |
| 36 | + Promise.resolve({ |
| 37 | + Body: Buffer.from(yamlString, 'utf-8'), |
| 38 | + }), |
| 39 | + }) |
| 40 | + } |
| 41 | + |
| 42 | + describe('useRequest states', () => { |
| 43 | + it('should return Loading while request is in progress', async () => { |
| 44 | + s3.getObject.mockReturnValue({ |
| 45 | + promise: () => new Promise((resolve) => setTimeout(() => resolve(null), 1000)), |
| 46 | + }) |
| 47 | + |
| 48 | + const { result } = renderHook(() => useSuccessors(CURRENT_BUCKET)) |
| 49 | + |
| 50 | + expect(result.current).toBe(Request.Loading) |
| 51 | + }) |
| 52 | + |
| 53 | + it('should return Error when request fails', async () => { |
| 54 | + const loglevel = Log.getLevel() |
| 55 | + Log.setLevel('silent') |
| 56 | + |
| 57 | + const testError = new Error('Network error') |
| 58 | + s3.getObject.mockReturnValue({ |
| 59 | + promise: () => Promise.reject(testError), |
| 60 | + }) |
| 61 | + |
| 62 | + const { result, waitForValueToChange } = renderHook(() => |
| 63 | + useSuccessors(CURRENT_BUCKET), |
| 64 | + ) |
| 65 | + |
| 66 | + await waitForValueToChange(() => result.current, { timeout: 5000 }) |
| 67 | + expect(result.current).toBe(testError) |
| 68 | + |
| 69 | + Log.setLevel(loglevel) |
| 70 | + }) |
| 71 | + }) |
| 72 | + |
| 73 | + describe('when no successors are defined in workflow config', () => { |
| 74 | + it('should return empty successors (respect explicit config)', async () => { |
| 75 | + mockS3ConfigYaml(dedent` |
| 76 | + version: "1" |
| 77 | + workflows: |
| 78 | + workflow_1: |
| 79 | + name: Test Workflow |
| 80 | + `) |
| 81 | + |
| 82 | + const { result, waitForValueToChange } = renderHook(() => |
| 83 | + useSuccessors(CURRENT_BUCKET), |
| 84 | + ) |
| 85 | + await waitForValueToChange(() => result.current, { timeout: 5000 }) |
| 86 | + |
| 87 | + expect(result.current).toEqual([]) |
| 88 | + }) |
| 89 | + |
| 90 | + it('should handle empty workflow config when file not found', async () => { |
| 91 | + s3.getObject.mockReturnValue({ |
| 92 | + promise: () => Promise.reject(new FileNotFound('Object not found')), |
| 93 | + }) |
| 94 | + |
| 95 | + const { result, waitForValueToChange } = renderHook(() => |
| 96 | + useSuccessors(CURRENT_BUCKET), |
| 97 | + ) |
| 98 | + |
| 99 | + await waitForValueToChange(() => result.current, { timeout: 5000 }) |
| 100 | + expect(result.current).toEqual([SUCCESSOR_FOR_CURRENT_BUCKET]) |
| 101 | + }) |
| 102 | + |
| 103 | + it('should handle empty workflow config when file exists but is empty', async () => { |
| 104 | + mockS3ConfigYaml('') |
| 105 | + |
| 106 | + const { result, waitForValueToChange } = renderHook(() => |
| 107 | + useSuccessors(CURRENT_BUCKET), |
| 108 | + ) |
| 109 | + |
| 110 | + await waitForValueToChange(() => result.current, { timeout: 5000 }) |
| 111 | + expect(result.current).toEqual([SUCCESSOR_FOR_CURRENT_BUCKET]) |
| 112 | + }) |
| 113 | + }) |
| 114 | + |
| 115 | + describe('when successors are explicitly defined without current bucket', () => { |
| 116 | + it('should exclude current bucket and return only defined successors', async () => { |
| 117 | + mockS3ConfigYaml(dedent` |
| 118 | + version: "1" |
| 119 | + successors: |
| 120 | + s3://destination-bucket: |
| 121 | + title: Destination Bucket |
| 122 | + copy_data: true |
| 123 | + s3://another-bucket: |
| 124 | + title: Another Bucket |
| 125 | + copy_data: false |
| 126 | + workflows: |
| 127 | + workflow_1: |
| 128 | + name: Test Workflow |
| 129 | + `) |
| 130 | + |
| 131 | + const { result, waitForValueToChange } = renderHook(() => |
| 132 | + useSuccessors(CURRENT_BUCKET), |
| 133 | + ) |
| 134 | + await waitForValueToChange(() => result.current, { timeout: 5000 }) |
| 135 | + |
| 136 | + expect(result.current).toEqual([ |
| 137 | + { |
| 138 | + name: 'Destination Bucket', |
| 139 | + slug: 'destination-bucket', |
| 140 | + url: 's3://destination-bucket', |
| 141 | + copyData: true, |
| 142 | + }, |
| 143 | + { |
| 144 | + name: 'Another Bucket', |
| 145 | + slug: 'another-bucket', |
| 146 | + url: 's3://another-bucket', |
| 147 | + copyData: false, |
| 148 | + }, |
| 149 | + ]) |
| 150 | + |
| 151 | + // Verify current bucket is not included |
| 152 | + expect(result.current).not.toContainEqual( |
| 153 | + expect.objectContaining({ slug: CURRENT_BUCKET }), |
| 154 | + ) |
| 155 | + }) |
| 156 | + }) |
| 157 | + |
| 158 | + describe('when successors are explicitly defined with current bucket', () => { |
| 159 | + it('should return all defined successors without duplicating current bucket', async () => { |
| 160 | + mockS3ConfigYaml(dedent` |
| 161 | + version: "1" |
| 162 | + successors: |
| 163 | + s3://other-bucket: |
| 164 | + title: Other Bucket |
| 165 | + s3://${CURRENT_BUCKET}: |
| 166 | + title: Test Bucket (Current) |
| 167 | + copy_data: true |
| 168 | + s3://third-bucket: |
| 169 | + title: Third Bucket |
| 170 | + copy_data: false |
| 171 | + workflows: |
| 172 | + workflow_1: |
| 173 | + name: Test Workflow |
| 174 | + `) |
| 175 | + |
| 176 | + const { result, waitForValueToChange } = renderHook(() => |
| 177 | + useSuccessors(CURRENT_BUCKET), |
| 178 | + ) |
| 179 | + |
| 180 | + await waitForValueToChange(() => result.current, { timeout: 5000 }) |
| 181 | + expect(result.current).toEqual([ |
| 182 | + { |
| 183 | + copyData: true, |
| 184 | + name: 'Other Bucket', |
| 185 | + slug: 'other-bucket', |
| 186 | + url: 's3://other-bucket', |
| 187 | + }, |
| 188 | + { |
| 189 | + copyData: true, |
| 190 | + name: 'Test Bucket (Current)', |
| 191 | + slug: CURRENT_BUCKET, |
| 192 | + url: `s3://${CURRENT_BUCKET}`, |
| 193 | + }, |
| 194 | + { |
| 195 | + copyData: false, |
| 196 | + name: 'Third Bucket', |
| 197 | + slug: 'third-bucket', |
| 198 | + url: 's3://third-bucket', |
| 199 | + }, |
| 200 | + ]) |
| 201 | + |
| 202 | + // Verify current bucket is not duplicated |
| 203 | + const currentBucketMatches = (result.current as Successor[]).filter( |
| 204 | + (s) => s.slug === CURRENT_BUCKET, |
| 205 | + ) |
| 206 | + expect(currentBucketMatches).toHaveLength(1) |
| 207 | + }) |
| 208 | + }) |
| 209 | +}) |
0 commit comments