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

Aurora Data API - Support for AWS configuration options through aurora driver #5754

Merged
merged 3 commits into from May 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions ormconfig.json.dist
Expand Up @@ -90,5 +90,18 @@
"logging": false,
"useNewUrlParser": true,
"useUnifiedTopology": true
},
{
"skip": true,
"name": "aurora-data-api",
"type": "aurora-data-api",
"region": "us-east-1",
"secretArn": "mysecret",
"resourceArn": "app-dbcluster",
"database": "app-dbcluster-mine",
"serviceConfigOptions": {
"maxRetries": 3
},
"logging": false
}
]
13 changes: 6 additions & 7 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -91,7 +91,7 @@
"sqlite3": "^4.0.9",
"ts-node": "^8.0.2",
"tslint": "^5.13.1",
"typeorm-aurora-data-api-driver": "^1.1.1",
"typeorm-aurora-data-api-driver": "^1.2.0",
"typescript": "^3.3.3333"
},
"dependencies": {
Expand Down
2 changes: 2 additions & 0 deletions src/driver/aurora-data-api/AuroraDataApiConnectionOptions.ts
Expand Up @@ -21,6 +21,8 @@ export interface AuroraDataApiConnectionOptions extends BaseConnectionOptions, A

readonly database: string;

readonly serviceConfigOptions?: { [key: string]: any }; // pass optional AWS.ConfigurationOptions here

/**
* Use spatial functions like GeomFromText and AsText which are removed in MySQL 8.
* (Default: true)
Expand Down
1 change: 1 addition & 0 deletions src/driver/aurora-data-api/AuroraDataApiDriver.ts
Expand Up @@ -306,6 +306,7 @@ export class AuroraDataApiDriver implements Driver {
this.options.resourceArn,
this.options.database,
(query: string, parameters?: any[]) => this.connection.logger.logQuery(query, parameters),
this.options.serviceConfigOptions
);

// validate options to make sure everything is set
Expand Down
21 changes: 21 additions & 0 deletions test/functional/connection-manager/connection-manager.ts
Expand Up @@ -7,6 +7,10 @@ import {PrimaryGeneratedColumn} from "../../../src/decorator/columns/PrimaryGene
import {Column} from "../../../src/decorator/columns/Column";
import {Entity} from "../../../src/decorator/entity/Entity";

// Uncomment when testing the aurora data API driver
// import {AuroraDataApiDriver} from "../../../src/driver/aurora-data-api/AuroraDataApiDriver";
// import {AuroraDataApiConnectionOptions} from "../../../src/driver/aurora-data-api/AuroraDataApiConnectionOptions";

describe("ConnectionManager", () => {

@Entity()
Expand Down Expand Up @@ -68,6 +72,23 @@ describe("ConnectionManager", () => {
connection.driver.should.be.instanceOf(MysqlDriver);
connection.isConnected.should.be.true;
await connection.close();

it("should create a aurora connection when aurora-data-api driver is specified", async () => {
const options = setupSingleTestingConnection("aurora-data-api", {
name: "aurora-data-api",
dropSchema: false,
schemaCreate: false,
enabledDrivers: ["aurora-data-api"]
});
const connectionManager = new ConnectionManager();
const connection = connectionManager.create(options!);
await connection.connect();
connection.name.should.contain("aurora-data-api");
connection.driver.should.be.instanceOf(AuroraDataApiDriver);
connection.isConnected.should.be.true;
const serviceConfigOptions = (connection.options as AuroraDataApiConnectionOptions).serviceConfigOptions;
expect(serviceConfigOptions).to.include({ maxRetries: 3, region: "us-east-1" });
await connection.close();
});

/!* it("should create a postgres connection when postgres driver is specified AND connect to it", async () => {
Expand Down