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

Jump to bottom

fix: set conditional messaging for ui-react-storage #996

Merged
merged 1 commit into from
May 1, 2023
Merged

fix: set conditional messaging for ui-react-storage #996

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
13 changes: 12 additions & 1 deletion packages/codegen-ui-react/lib/__tests__/react-studio-dependency-provider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ import semver from 'semver';
import { ReactRequiredDependencyProvider } from '..';

describe('ReactStudioDependencyProvider', () => {
const requiredDependencies = new ReactRequiredDependencyProvider().getRequiredDependencies();
const requiredDependencies = new ReactRequiredDependencyProvider().getRequiredDependencies(false);
const requiredDependenciesWithStorageManager = new ReactRequiredDependencyProvider().getRequiredDependencies(true);

describe('getRequiredDependencies', () => {
it('has required dependencies', () => {
Expand All @@ -39,5 +40,15 @@ describe('ReactStudioDependencyProvider', () => {
expect(dep.reason.length).toBeGreaterThan(0);
});
});

it('does not include ui-react-storage if user does not use StorageManager', () => {
expect(requiredDependencies.filter((dep) => dep.dependencyName !== '@aws-amplify/ui-react-storage')).toBeTruthy();
});

it('includes ui-react-storage if user is using StorageManager', () => {
expect(
requiredDependenciesWithStorageManager.filter((dep) => dep.dependencyName === '@aws-amplify/ui-react-storage'),
).toBeTruthy();
});
});
});
15 changes: 10 additions & 5 deletions packages/codegen-ui-react/lib/react-required-dependency-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ type SemVerRequiredDependency = RequiredDependency & {
};

export class ReactRequiredDependencyProvider extends RequiredDependencyProvider<SemVerRequiredDependency> {
getRequiredDependencies(): SemVerRequiredDependency[] {
return [
getRequiredDependencies(hasStorageManager?: boolean): SemVerRequiredDependency[] {
const dependencies = [
{
dependencyName: '@aws-amplify/ui-react',
supportedSemVerPattern: '^4.6.0',
Expand All @@ -32,11 +32,16 @@ export class ReactRequiredDependencyProvider extends RequiredDependencyProvider<
supportedSemVerPattern: '^5.0.2',
reason: 'Required to leverage DataStore.',
},
{
];

if (hasStorageManager) {
dependencies.push({
dependencyName: '@aws-amplify/ui-react-storage',
supportedSemVerPattern: '^1.1.0',
reason: 'Required to leverage StorageManager.',
},
];
});
}

return dependencies;
}
}
2 changes: 1 addition & 1 deletion packages/codegen-ui/lib/required-dependency-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ export type RequiredDependency = {
};

export abstract class RequiredDependencyProvider<DependencyType extends RequiredDependency> {
abstract getRequiredDependencies(): DependencyType[];
abstract getRequiredDependencies(hasStorageManager?: boolean): DependencyType[];
}