Skip to content

feat: support custom SSL certificates in SQL data sources #1696

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

Merged
merged 11 commits into from
Jul 3, 2024
Merged

feat: support custom SSL certificates in SQL data sources #1696

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1513ffd
feat: support custom SSL certificates in SQL data sources
palpatim Jun 20, 2024
fa09d6b
chore: fix 'build' script so 'watch' applies to all built directories
palpatim Jun 28, 2024
917eaba
chore: upgrade dependency graph
palpatim Jul 1, 2024
c178014
additional package lock updates from npm install
palpatim Jul 1, 2024
d465f43
update changeset
palpatim Jul 1, 2024
9a144f3
Merge branch 'main' into palpatim.feat.custom-ssl-cert-support
palpatim Jul 1, 2024
6d71946
revert changeset packages after merge from main
palpatim Jul 1, 2024
d127012
update data-construct dependency version
palpatim Jul 2, 2024
d9356f6
Merge branch 'main' into palpatim.feat.custom-ssl-cert-support
palpatim Jul 2, 2024
faaa093
update graphql-schema-generator dependency version
palpatim Jul 2, 2024
331f369
add @aws-amplify/schema-generator to changeset
palpatim Jul 3, 2024
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
5 changes: 5 additions & 0 deletions .changeset/perfect-coins-tease.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@aws-amplify/backend-data': minor
---

support custom SSL certificates in SQL data sources
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "",
"type": "module",
"scripts": {
"build": "tsc --build packages/* && tsc --build scripts",
"build": "tsc --build packages/* scripts",
Copy link
Member Author

Choose a reason for hiding this comment

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

--build takes multiple source directories as arguments. The previous construction of this command meant that the --watch argument from the watch script ("npm run build -- --watch") only applied to tsc --build scripts.

"check:api": "npm run update:api && tsx scripts/check_api_extract.ts",
"check:dependencies": "tsx scripts/check_dependencies.ts",
"check:package-lock": "tsx scripts/check_package_lock.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/backend-data/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
"dependencies": {
"@aws-amplify/backend-output-storage": "^1.0.2",
"@aws-amplify/backend-output-schemas": "^1.1.0",
"@aws-amplify/data-construct": "^1.8.0",
"@aws-amplify/data-construct": "^1.9.0",
"@aws-amplify/plugin-types": "^1.0.1",
"@aws-amplify/data-schema-types": "^1.0.0"
"@aws-amplify/data-schema-types": "^1.1.1"
}
}
120 changes: 120 additions & 0 deletions packages/backend-data/src/convert_schema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,4 +394,124 @@ void describe('convertSchemaToCDK', () => {
}
);
});

void it('produces expected definition for MySQL schema with custom SSL cert', () => {
const schema = configure({
database: {
engine: 'mysql',
connectionUri: new TestBackendSecret('SQL_CONNECTION_STRING'),
sslCert: new TestBackendSecret('CUSTOM_SSL_CERT'),
},
}).schema({
post: a
.model({
id: a.integer().required(),
title: a.string(),
})
.identifier(['id'])
.authorization((allow) => allow.publicApiKey()),
});

const modified = schema.addQueries({
oddList: a
.query()
.handler(a.handler.inlineSql('SELECT * from post where id % 2 = 1;'))
.returns(a.ref('post'))
.authorization((allow) => allow.publicApiKey()),
});

const convertedDefinition = convertSchemaToCDK(
modified,
secretResolver,
stableBackendIdentifiers
);

assert.equal(
Object.values(convertedDefinition.dataSourceStrategies).length,
1
);
assert.deepEqual(
Object.values(convertedDefinition.dataSourceStrategies)[0],
{
customSqlStatements: {},
/* eslint-disable spellcheck/spell-checker */
dbConnectionConfig: {
connectionUriSsmPath: [
'/amplify/testBackendId/testBranchName-branch-e482a1c36f/SQL_CONNECTION_STRING',
'/amplify/shared/testBackendId/SQL_CONNECTION_STRING',
],
sslCertConfig: {
ssmPath: [
'/amplify/testBackendId/testBranchName-branch-e482a1c36f/CUSTOM_SSL_CERT',
'/amplify/shared/testBackendId/CUSTOM_SSL_CERT',
],
},
},
dbType: 'MYSQL',
name: '00034dcf3444861c3ca5mysql',
vpcConfiguration: undefined,
/* eslint-enable spellcheck/spell-checker */
}
);
});

void it('produces expected definition for Postgresql schema with custom SSL cert', () => {
const schema = configure({
database: {
engine: 'postgresql',
connectionUri: new TestBackendSecret('SQL_CONNECTION_STRING'),
sslCert: new TestBackendSecret('CUSTOM_SSL_CERT'),
},
}).schema({
post: a
.model({
id: a.integer().required(),
title: a.string(),
})
.identifier(['id'])
.authorization((allow) => allow.publicApiKey()),
});

const modified = schema.addQueries({
oddList: a
.query()
.handler(a.handler.inlineSql('SELECT * from post where id % 2 = 1;'))
.returns(a.ref('post'))
.authorization((allow) => allow.publicApiKey()),
});

const convertedDefinition = convertSchemaToCDK(
modified,
secretResolver,
stableBackendIdentifiers
);

assert.equal(
Object.values(convertedDefinition.dataSourceStrategies).length,
1
);
assert.deepEqual(
Object.values(convertedDefinition.dataSourceStrategies)[0],
{
customSqlStatements: {},
/* eslint-disable spellcheck/spell-checker */
dbConnectionConfig: {
connectionUriSsmPath: [
'/amplify/testBackendId/testBranchName-branch-e482a1c36f/SQL_CONNECTION_STRING',
'/amplify/shared/testBackendId/SQL_CONNECTION_STRING',
],
sslCertConfig: {
ssmPath: [
'/amplify/testBackendId/testBranchName-branch-e482a1c36f/CUSTOM_SSL_CERT',
'/amplify/shared/testBackendId/CUSTOM_SSL_CERT',
],
},
},
dbType: 'POSTGRES',
name: '00034dcf3444861c3ca5postgresql',
vpcConfiguration: undefined,
/* eslint-enable spellcheck/spell-checker */
}
);
});
});
15 changes: 14 additions & 1 deletion packages/backend-data/src/convert_schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
AmplifyDataDefinition,
type IAmplifyDataDefinition,
type ModelDataSourceStrategy,
type SslCertSsmPathConfig,
type VpcConfig,
} from '@aws-amplify/data-construct';
import type { DataSchema, DataSchemaInput } from './types.js';
Expand Down Expand Up @@ -174,17 +175,29 @@ const convertDatabaseConfigurationToDataSourceStrategy = (

const { branchSecretPath, sharedSecretPath } =
backendSecretResolver.resolvePath(configuration.connectionUri);
return {

let sslCertConfig: SslCertSsmPathConfig | undefined;
if (configuration.sslCert) {
const { branchSecretPath, sharedSecretPath } =
backendSecretResolver.resolvePath(configuration.sslCert);
sslCertConfig = {
ssmPath: [branchSecretPath, sharedSecretPath],
};
}
const strategy: ModelDataSourceStrategy = {
dbType,
name:
provisionStrategyName +
(configuration.identifier ?? configuration.engine),
dbConnectionConfig: {
connectionUriSsmPath: [branchSecretPath, sharedSecretPath],
...(sslCertConfig ? { sslCertConfig } : undefined),
},
vpcConfiguration,
customSqlStatements,
};

return strategy;
};

/**
Expand Down