Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document link downloader to Document Library #236

Merged
merged 9 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from 7 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
1 change: 1 addition & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ module.exports = {
'^.+\\.tsx?$': 'ts-jest'
},
collectCoverage: true,
silent: true,
};
34 changes: 34 additions & 0 deletions lambda/repository/lambda_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,40 @@ def ingest_documents(event: dict, context: dict) -> dict:
}


@api_wrapper
def download_document(event: dict, context: dict) -> str:
"""Generate a pre-signed S3 URL for downloading a file from the RAG ingested files.
Args:
event (dict): The Lambda event object containing:
path_params:
repositoryId - the repository
documentId - the document

Returns:
url: The presigned URL response object with download fields and URL

Notes:
- URL expires in 300 seconds (5 mins)
"""
path_params = event.get("pathParameters", {}) or {}
repository_id = path_params.get("repositoryId")
document_id = path_params.get("documentId")

ensure_repository_access(event, find_repository_by_id(repository_id))
doc = doc_repo.find_by_id(repository_id=repository_id, document_id=document_id)

source = doc.get("source")
bucket, key = source.replace("s3://", "").split("/", 1)

url: str = s3.generate_presigned_url(
ClientMethod="get_object",
Params={"Bucket": bucket, "Key": key},
ExpiresIn=300,
)

return url


@api_wrapper
def presigned_url(event: dict, context: dict) -> dict:
"""Generate a pre-signed URL for uploading files to the RAG ingest bucket.
Expand Down
2 changes: 1 addition & 1 deletion lib/networking/vpc/security-group-factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export class SecurityGroupFactory {
description: string,
): ISecurityGroup {
if (securityGroupOverride) {
console.log(`Security Role Override provided. Using ${securityGroupOverride} for ${securityGroupId}`);
console.debug(`Security Role Override provided. Using ${securityGroupOverride} for ${securityGroupId}`);
const sg = SecurityGroup.fromSecurityGroupId(construct, securityGroupId, securityGroupOverride);
// Validate the security group exists
if (!sg) {
Expand Down
10 changes: 10 additions & 0 deletions lib/rag/api/repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,16 @@ export class RepositoryApi extends Construct {
...baseEnvironment,
},
},
{
name: 'download_document',
resource: 'repository',
description: 'Creates presigned url to download document within repository',
path: 'repository/{repositoryId}/{documentId}/download',
method: 'GET',
environment: {
...baseEnvironment,
},
},
];
apis.forEach((f) => {
registerAPIEndpoint(
Expand Down
8 changes: 4 additions & 4 deletions lib/rag/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -363,14 +363,14 @@ export class LisaRagStack extends Stack {
}

// Create ingest pipeline state machines for each pipeline config
console.log('[DEBUG] Checking pipelines configuration:', {
console.debug('Checking pipelines configuration:', {
hasPipelines: !!ragConfig.pipelines,
pipelinesLength: ragConfig.pipelines?.length || 0
});

if (ragConfig.pipelines) {
ragConfig.pipelines.forEach((pipelineConfig, index) => {
console.log(`[DEBUG] Creating pipeline ${index}:`, {
console.debug(`Creating pipeline ${index}:`, {
pipelineConfig: JSON.stringify(pipelineConfig, null, 2)
});

Expand Down Expand Up @@ -420,9 +420,9 @@ export class LisaRagStack extends Stack {
});
policy.attachToRole(lambdaRole);
}
console.log(`[DEBUG] Successfully created pipeline ${index}`);
console.debug(`Successfully created pipeline ${index}`);
} catch (error) {
console.error(`[ERROR] Failed to create pipeline ${index}:`, error);
console.error(`Failed to create pipeline ${index}:`, error);
throw error; // Re-throw to ensure CDK deployment fails
}
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/

import * as React from 'react';
import { ReactElement } from 'react';
import { ReactElement, useState } from 'react';
import {
ButtonDropdownProps,
CollectionPreferences,
Expand All @@ -24,7 +24,11 @@ import {
TextFilter,
} from '@cloudscape-design/components';
import SpaceBetween from '@cloudscape-design/components/space-between';
import { useDeleteRagDocumentsMutation, useListRagDocumentsQuery } from '../../shared/reducers/rag.reducer';
import {
useDeleteRagDocumentsMutation,
useLazyDownloadRagDocumentQuery,
useListRagDocumentsQuery,
} from '../../shared/reducers/rag.reducer';
import Table from '@cloudscape-design/components/table';
import ButtonDropdown from '@cloudscape-design/components/button-dropdown';
import { DEFAULT_PREFERENCES, PAGE_SIZE_OPTIONS, TABLE_DEFINITION, TABLE_PREFERENCES } from './DocumentLibraryConfig';
Expand All @@ -35,6 +39,7 @@ import { selectCurrentUserIsAdmin, selectCurrentUsername } from '../../shared/re
import { RagDocument } from '../types';
import { setConfirmationModal } from '../../shared/reducers/modal.reducer';
import { useLocalStorage } from '../../shared/hooks/use-local-storage';
import { downloadFile } from '../../shared/util/downloader';

type DocumentLibraryComponentProps = {
repositoryId?: string;
Expand All @@ -54,9 +59,8 @@ function disabledDeleteReason (selectedItems: ReadonlyArray<RagDocument>) {

export function DocumentLibraryComponent ({ repositoryId }: DocumentLibraryComponentProps): ReactElement {
const { data: allDocs, isFetching } = useListRagDocumentsQuery({ repositoryId }, { refetchOnMountOrArgChange: 5 });
const [deleteMutation, {
isLoading: isDeleteLoading,
}] = useDeleteRagDocumentsMutation();
const [deleteMutation, { isLoading: isDeleteLoading }] = useDeleteRagDocumentsMutation();

const currentUser = useAppSelector(selectCurrentUsername);
const isAdmin = useAppSelector(selectCurrentUserIsAdmin);
const [preferences, setPreferences] = useLocalStorage('DocumentRagPreferences', DEFAULT_PREFERENCES);
Expand Down Expand Up @@ -84,13 +88,19 @@ export function DocumentLibraryComponent ({ repositoryId }: DocumentLibraryCompo
selection: { trackBy: 'document_id' },
},
);

const [isDownloading, setIsDownloading] = useState<boolean>(false);
const [getDownloadUrl] = useLazyDownloadRagDocumentQuery();
Copy link
Contributor

@dustins dustins Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think instead of worrying about isDownloading you can use isFetching from the hook. I think it would look something like this…

    const [isDownloading, setIsDownloading] = useState<boolean>(false);
    const [getDownloadUrl, {isFetching: isDownloading}] = useLazyDownloadRagDocumentQuery();

Edit: I guess technically it would only say it is downloading while it is fetching the URL so maybe that isn't what you'd want. Not blocking on this, just throwing it out as an option.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Updated.

const actionItems: ButtonDropdownProps.Item[] = [
{
id: 'rm',
text: 'Delete',
disabled: !canDeleteAll(collectionProps.selectedItems, currentUser, isAdmin),
disabledReason: disabledDeleteReason(collectionProps.selectedItems),
}, {
id: 'download',
text: 'Download',
disabled: collectionProps.selectedItems.length > 1,
disabledReason: 'Only one file can be downloaded at a time',
},
];
const handleAction = async (e: any) => {
Expand All @@ -109,6 +119,14 @@ export function DocumentLibraryComponent ({ repositoryId }: DocumentLibraryCompo
);
break;
}
case 'download': {
setIsDownloading(true);
getDownloadUrl({ documentId: collectionProps.selectedItems[0].document_id, repositoryId })
.then((resp) => downloadFile(resp.data, collectionProps.selectedItems[0].document_name))
.catch((err) => console.error(err))
.finally(() => setIsDownloading(false));
break;
}
default:
console.error('Action not implemented', e.detail.id);
}
Expand Down Expand Up @@ -150,8 +168,9 @@ export function DocumentLibraryComponent ({ repositoryId }: DocumentLibraryCompo
>
<ButtonDropdown
items={actionItems}
loading={isDeleteLoading}
onItemClick={(e) => handleAction(e)}
loading={isDeleteLoading || isDownloading}
disabled={collectionProps.selectedItems.length === 0}
onItemClick={async (e) => handleAction(e)}
>
Actions
</ButtonDropdown>
Expand Down
4 changes: 2 additions & 2 deletions lib/user-interface/react/src/pages/Home.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ export function Home ({ setNav }) {
}
>
{visible && <Alert type='error'>You must sign in to access this page!</Alert>}
<Box float='center'>
<div align='center'>
<Box>
<div>
<figure>
<img
src={chatImg}
Expand Down
9 changes: 8 additions & 1 deletion lib/user-interface/react/src/shared/reducers/rag.reducer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,12 @@ export const ragApi = createApi({
},
invalidatesTags: ['Docs'],
}),
downloadRagDocument: builder.query<string, { documentId: string, repositoryId: string }>({
query: ({ documentId, repositoryId }) => ({
url: `/repository/${repositoryId}/${documentId}/download`,
method: 'GET',
}),
}),
}),
});

Expand All @@ -145,5 +151,6 @@ export const {
useIngestDocumentsMutation,
useListRagDocumentsQuery,
useDeleteRagDocumentsMutation,
useLazyGetRelevantDocumentsQuery
useLazyGetRelevantDocumentsQuery,
useLazyDownloadRagDocumentQuery,
} = ragApi;
31 changes: 31 additions & 0 deletions lib/user-interface/react/src/shared/util/downloader.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/**
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License").
You may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/**
* Download a file using hidden link
* @param url
* @param filename
*/
export function downloadFile (url: string, filename: string) {
const link = document.createElement('a');
link.href = url;
link.download = filename || 'download';
link.hidden = true;

document.body.appendChild(link);
link.click();
document.body.removeChild(link);
}
2 changes: 1 addition & 1 deletion test/cdk/stacks/nag.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const nagResults: NagResult = {
LisaIAM: [0,13,0,0],
LisaModels: [1,74,0,28],
LisaNetworking: [1,2,3,5],
LisaRAG: [2,41,0,38],
LisaRAG: [2,43,0,38],
LisaServe: [1,21,0,31],
LisaUI: [0,16,0,8],
};
Expand Down