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.

Sign up for GitHub

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

fix: upgrade the update-feed and package-stats functions to SDK v3 #1451

Merged
merged 1 commit into from
Sep 12, 2024
+262 −257
Merged

fix: upgrade the update-feed and package-stats functions to SDK v3 #1451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 15 additions & 15 deletions src/__tests__/__snapshots__/construct-hub.test.ts.snap
View file
Open in desktop

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

93 changes: 61 additions & 32 deletions src/__tests__/backend/catalog-builder/client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
import * as AWS from 'aws-sdk';
import { AWSError } from 'aws-sdk';
import * as AWSMock from 'aws-sdk-mock';
import {
GetObjectCommand,
NoSuchBucket,
NoSuchKey,
S3Client,
} from '@aws-sdk/client-s3';
import { mockClient } from 'aws-sdk-client-mock';
import type { PackageInfo } from '../../../backend/catalog-builder';
import {
CatalogClient,
CatalogNotFoundError,
} from '../../../backend/catalog-builder/client.lambda-shared';
import * as aws from '../../../backend/shared/aws.lambda-shared';
import { stringToStream } from '../../streams';

const samplePackages: Partial<PackageInfo>[] = [
{
Expand Down Expand Up @@ -35,25 +39,26 @@ const samplePackages: Partial<PackageInfo>[] = [
},
];

const mockS3 = mockClient(S3Client);

beforeEach(() => {
process.env.CATALOG_BUCKET_NAME = 'catalog-bucket-name';
process.env.CATALOG_OBJECT_KEY = 'catalog.json';
AWSMock.setSDKInstance(AWS);
mockS3.reset();
});

afterEach(() => {
delete process.env.CATALOG_BUCKET_NAME;
delete process.env.CATALOG_OBJECT_KEY;
AWSMock.restore();
aws.reset();
});

test('s3 object not found error', async () => {
AWSMock.mock('S3', 'getObject', (_, callback) => {
const err = new Error('NoSuchKey');
(err as any).code = 'NoSuchKey';
callback(err as AWSError, undefined);
});
mockS3.on(GetObjectCommand).rejects(
new NoSuchKey({
$metadata: {},
message: 'The specified key does not exist.',
})
);

const expected = new CatalogNotFoundError('catalog-bucket-name/catalog.json');
return expect(async () => CatalogClient.newClient()).rejects.toEqual(
Expand All @@ -62,11 +67,12 @@ test('s3 object not found error', async () => {
});

test('s3 bucket not found error', async () => {
AWSMock.mock('S3', 'getObject', (_, callback) => {
const err = new Error('NoSuchBucket');
(err as any).code = 'NoSuchBucket';
callback(err as AWSError, undefined);
});
mockS3.on(GetObjectCommand).rejects(
new NoSuchBucket({
$metadata: {},
message: 'The specified bucket does not exist.',
})
);

const expected = new CatalogNotFoundError('catalog-bucket-name/catalog.json');
return expect(async () => CatalogClient.newClient()).rejects.toEqual(
Expand All @@ -75,11 +81,30 @@ test('s3 bucket not found error', async () => {
});

test('empty file', async () => {
AWSMock.mock('S3', 'getObject', (params, callback) => {
expect(params.Bucket).toBe('catalog-bucket-name');
expect(params.Key).toBe('catalog.json');
callback(undefined, { Body: '' });
});
mockS3
.on(GetObjectCommand, {
Bucket: 'catalog-bucket-name',
Key: 'catalog.json',
})
.resolves({
Body: stringToStream(''),
});

const expected = new Error(
'Catalog body is empty at catalog-bucket-name/catalog.json'
);
return expect(async () => CatalogClient.newClient()).rejects.toEqual(
expected
);
});

test('no body', async () => {
mockS3
.on(GetObjectCommand, {
Bucket: 'catalog-bucket-name',
Key: 'catalog.json',
})
.resolves({});

const expected = new Error(
'Catalog body is empty at catalog-bucket-name/catalog.json'
Expand All @@ -90,11 +115,12 @@ test('empty file', async () => {
});

test('json parsing error', async () => {
AWSMock.mock('S3', 'getObject', (params, callback) => {
expect(params.Bucket).toBe('catalog-bucket-name');
expect(params.Key).toBe('catalog.json');
callback(undefined, { Body: '09x{}' });
});
mockS3
.on(GetObjectCommand, {
Bucket: 'catalog-bucket-name',
Key: 'catalog.json',
})
.resolves({ Body: stringToStream('09x{}') });

const expected = new Error(
'Unable to parse catalog file catalog-bucket-name/catalog.json: SyntaxError: Unexpected number in JSON at position 1'
Expand All @@ -105,11 +131,14 @@ test('json parsing error', async () => {
});

test('happy path - get packages', async () => {
AWSMock.mock('S3', 'getObject', (params, callback) => {
expect(params.Bucket).toBe('catalog-bucket-name');
expect(params.Key).toBe('catalog.json');
callback(undefined, { Body: JSON.stringify({ packages: samplePackages }) });
});
mockS3
.on(GetObjectCommand, {
Bucket: 'catalog-bucket-name',
Key: 'catalog.json',
})
.resolves({
Body: stringToStream(JSON.stringify({ packages: samplePackages })),
});

const client = await CatalogClient.newClient();
expect(client.packages).toStrictEqual(samplePackages);
Expand Down
Loading