Skip to content

Commit 5bd5af8

Browse files
rddimonrddimon
authored
Merge pull request #620 from amplify-education/hotfix/api-mappings-filtering
Filter by stage for the removing API mapping
2 parents 9675a20 + 8e7f8d9 commit 5bd5af8

10 files changed

+4393
-785
lines changed

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7+
## [7.3.7] - 2023-03-06
8+
9+
### Fixed
10+
- Added filtering by stage for removing API mappings. That filter is skipped in case `allowPathMatching` is enabled.
11+
- Added throwing an error for a non-existing custom domain during base path mappings setup.
12+
713
## [7.3.6] - 2023-02-13
814

915
### Changed

‎package-lock.json

+4,338-754
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "serverless-domain-manager",
3-
"version": "7.3.6",
3+
"version": "7.3.7",
44
"engines": {
55
"node": ">=14"
66
},
@@ -50,8 +50,8 @@
5050
},
5151
"devDependencies": {
5252
"@types/mocha": "^10.0.6",
53-
"@types/node": "^20.11.10",
54-
"@types/randomstring": "^1.1.11",
53+
"@types/node": "^20.11.24",
54+
"@types/randomstring": "^1.1.12",
5555
"@types/shelljs": "^0.8.15",
5656
"aws-sdk-client-mock": "^3.0.1",
5757
"chai": "^4.4.1",
@@ -63,7 +63,7 @@
6363
"eslint-plugin-promise": "^5.2.0",
6464
"@typescript-eslint/parser": "^5.62.0",
6565
"@typescript-eslint/eslint-plugin": "^5.62.0",
66-
"mocha": "^10.2.0",
66+
"mocha": "^10.3.0",
6767
"mocha-param": "^2.0.1",
6868
"nyc": "^15.1.0",
6969
"randomstring": "^1.3.0",
@@ -74,20 +74,20 @@
7474
"typescript": "^5.1.6 && <5.2"
7575
},
7676
"dependencies": {
77-
"@aws-sdk/client-acm": "^3.460.0",
78-
"@aws-sdk/client-api-gateway": "^3.460.0",
79-
"@aws-sdk/client-apigatewayv2": "^3.460.0",
80-
"@aws-sdk/client-cloudformation": "^3.460.0",
81-
"@aws-sdk/client-route-53": "^3.460.0",
82-
"@aws-sdk/client-s3": "^3.460.0",
83-
"@aws-sdk/credential-providers": "^3.460.0",
84-
"@smithy/config-resolver": "^2.0.19",
85-
"@smithy/node-config-provider": "^2.1.6",
86-
"@smithy/node-http-handler": "^2.1.10",
87-
"@smithy/smithy-client": "^2.1.16",
88-
"@smithy/types": "^2.6.0",
89-
"@smithy/util-retry": "^2.0.7",
90-
"proxy-agent": "^6.3.1"
77+
"@aws-sdk/client-acm": "^3.525.0",
78+
"@aws-sdk/client-api-gateway": "^3.525.0",
79+
"@aws-sdk/client-apigatewayv2": "^3.525.0",
80+
"@aws-sdk/client-cloudformation": "^3.526.0",
81+
"@aws-sdk/client-route-53": "^3.525.0",
82+
"@aws-sdk/client-s3": "^3.525.0",
83+
"@aws-sdk/credential-providers": "^3.525.0",
84+
"@smithy/config-resolver": "^2.1.4",
85+
"@smithy/node-config-provider": "^2.2.4",
86+
"@smithy/node-http-handler": "^2.4.1",
87+
"@smithy/smithy-client": "^2.4.2",
88+
"@smithy/types": "^2.10.1",
89+
"@smithy/util-retry": "^2.1.3",
90+
"proxy-agent": "^6.4.0"
9191
},
9292
"peerDependencies": {
9393
"serverless": "^2.60 || ^3.0.0"

‎src/aws/api-gateway-v1-wrapper.ts

+8-4
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,12 @@ class APIGatewayV1Wrapper extends APIGatewayBase {
8181
}
8282
}
8383

84-
public async getCustomDomain (domain: DomainConfig): Promise<DomainInfo> {
84+
/**
85+
* Get Custom Domain Info
86+
* @param domain: DomainConfig
87+
* @param silent: To issue an error or not. Not by default.
88+
*/
89+
public async getCustomDomain (domain: DomainConfig, silent: boolean = true): Promise<DomainInfo> {
8590
// Make API call
8691
try {
8792
const domainInfo: GetDomainNameCommandOutput = await this.apiGateway.send(
@@ -91,7 +96,7 @@ class APIGatewayV1Wrapper extends APIGatewayBase {
9196
);
9297
return new DomainInfo(domainInfo);
9398
} catch (err) {
94-
if (!err.$metadata || err.$metadata.httpStatusCode !== 404) {
99+
if (!err.$metadata || err.$metadata.httpStatusCode !== 404 || !silent) {
95100
throw new Error(
96101
`V1 - Unable to fetch information about '${domain.givenDomainName}':\n${err.message}`
97102
);
@@ -122,8 +127,7 @@ class APIGatewayV1Wrapper extends APIGatewayBase {
122127
Logging.logInfo(`V1 - Created API mapping '${domain.basePath}' for '${domain.givenDomainName}'`);
123128
} catch (err) {
124129
throw new Error(
125-
`V1 - Make sure the '${domain.givenDomainName}' exists.
126-
Unable to create base path mapping for '${domain.givenDomainName}':\n${err.message}`
130+
`V1 - Unable to create base path mapping for '${domain.givenDomainName}':\n${err.message}`
127131
);
128132
}
129133
}

‎src/aws/api-gateway-v2-wrapper.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,9 @@ class APIGatewayV2Wrapper extends APIGatewayBase {
8383
/**
8484
* Get Custom Domain Info
8585
* @param domain: DomainConfig
86+
* @param silent: To issue an error or not. Not by default.
8687
*/
87-
public async getCustomDomain (domain: DomainConfig): Promise<DomainInfo> {
88+
public async getCustomDomain (domain: DomainConfig, silent: boolean = true): Promise<DomainInfo> {
8889
// Make API call
8990
try {
9091
const domainInfo: GetDomainNameCommandOutput = await this.apiGateway.send(
@@ -94,7 +95,7 @@ class APIGatewayV2Wrapper extends APIGatewayBase {
9495
);
9596
return new DomainInfo(domainInfo);
9697
} catch (err) {
97-
if (!err.$metadata || err.$metadata.httpStatusCode !== 404) {
98+
if (!err.$metadata || err.$metadata.httpStatusCode !== 404 || !silent) {
9899
throw new Error(
99100
`V2 - Unable to fetch information about '${domain.givenDomainName}':\n${err.message}`
100101
);

‎src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ class ServerlessCustomDomain {
353353
return mapping.apiId === domain.apiId;
354354
});
355355
domain.apiMapping = filteredMappings ? filteredMappings[0] : null;
356-
domain.domainInfo = await apiGateway.getCustomDomain(domain);
356+
domain.domainInfo = await apiGateway.getCustomDomain(domain, false);
357357

358358
if (!domain.apiMapping) {
359359
await apiGateway.createBasePathMapping(domain);
@@ -385,7 +385,7 @@ class ServerlessCustomDomain {
385385
if (domain.allowPathMatching) {
386386
return mapping.basePath === domain.basePath;
387387
}
388-
return mapping.apiId === domain.apiId;
388+
return mapping.apiId === domain.apiId && mapping.stage === domain.stage;
389389
});
390390
if (domain.preserveExternalPathMappings) {
391391
externalBasePathExists = mappings.length > filteredMappings.length;

‎src/models/apigateway-base.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import DomainConfig = require("./domain-config");
55
abstract class APIGatewayBase {
66
abstract createCustomDomain(domain: DomainConfig): Promise<DomainInfo>;
77

8-
abstract getCustomDomain(domain: DomainConfig): Promise<DomainInfo>;
8+
abstract getCustomDomain(domain: DomainConfig, silent?: boolean): Promise<DomainInfo>;
99

1010
abstract deleteCustomDomain(domain: DomainConfig): Promise<void>;
1111

‎test/unit-tests/aws/api-gateway-v1-wrapper.test.ts

+6-1
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,10 @@ describe("API Gateway V1 wrapper checks", () => {
339339
restApiId: "test_rest_api_id",
340340
basePath: "test",
341341
stage: "test"
342+
},{
343+
restApiId: "test_rest_api_id2",
344+
basePath: "test2",
345+
stage: "dummy"
342346
}]
343347
});
344348

@@ -349,7 +353,8 @@ describe("API Gateway V1 wrapper checks", () => {
349353

350354
const actualResult = await apiGatewayV1Wrapper.getBasePathMappings(dc);
351355
const expectedResult = [
352-
new ApiGatewayMap("test_rest_api_id", "test", "test", null)
356+
new ApiGatewayMap("test_rest_api_id", "test", "test", null),
357+
new ApiGatewayMap("test_rest_api_id2", "test2", "dummy", null)
353358
];
354359

355360
expect(actualResult).to.eql(expectedResult);

‎test/unit-tests/aws/api-gateway-v2-wrapper.test.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,11 @@ describe("API Gateway V2 wrapper checks", () => {
372372
ApiMappingKey: "test",
373373
Stage: "test",
374374
ApiMappingId: "test_id"
375+
},{
376+
ApiId: "test_rest_api_id2",
377+
ApiMappingKey: "test2",
378+
Stage: "dummy",
379+
ApiMappingId: "test_id2"
375380
}]
376381
});
377382

@@ -382,7 +387,8 @@ describe("API Gateway V2 wrapper checks", () => {
382387

383388
const actualResult = await apiGatewayV2Wrapper.getBasePathMappings(dc);
384389
const expectedResult = [
385-
new ApiGatewayMap("test_rest_api_id", "test", "test", "test_id")
390+
new ApiGatewayMap("test_rest_api_id", "test", "test", "test_id"),
391+
new ApiGatewayMap("test_rest_api_id2", "test2", "dummy", "test_id2")
386392
];
387393

388394
expect(actualResult).to.eql(expectedResult);

‎test/unit-tests/index.test.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,10 @@ describe("Custom Domain Plugin", () => {
490490
});
491491
APIGatewayMock.on(GetBasePathMappingsCommand).resolves({
492492
items: [{
493+
restApiId: "test_rest_api_id",
494+
basePath: "test2",
495+
stage: "dummy"
496+
}, {
493497
restApiId: "test_rest_api_id",
494498
basePath: "test",
495499
stage: "test"
@@ -518,8 +522,6 @@ describe("Custom Domain Plugin", () => {
518522
const deleteDomainSpy = chaiSpy.on(plugin, "deleteDomain");
519523
await plugin.hooks["before:remove:remove"]();
520524

521-
const commandCalls = APIGatewayMock.commandCalls(DeleteBasePathMappingCommand);
522-
expect(commandCalls.length).to.equal(1);
523525
expect(deleteDomainSpy).to.have.been.called();
524526
});
525527

0 commit comments

Comments
 (0)