Skip to content

Commit 0747a2d

Browse files
thomas-tacquetthomas-tacquet
authored
add support for custom domains on containers and refracto + tests (#105)
1 parent c4a429e commit 0747a2d

File tree

12 files changed

+1032
-818
lines changed

12 files changed

+1032
-818
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,8 @@ You may refer to the follow examples:
344344

345345
Custom domains allows users to use their own domains.
346346

347-
For domain configuration please [Refer to Scaleway Documentation](https://www.scaleway.com/en/docs/compute/functions/how-to/add-a-custom-domain-name-to-a-function/)
347+
For domain configuration please refer to [custom domains on Function](https://www.scaleway.com/en/docs/compute/functions/how-to/add-a-custom-domain-name-to-a-function/) or
348+
[custom domains on Container](https://www.scaleway.com/en/docs/compute/containers/how-to/add-a-custom-domain-to-a-container/)
348349

349350
Integration with serverless framework example :
350351

‎deploy/lib/createContainers.js‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
const BbPromise = require('bluebird');
44
const singleSource = require('../../shared/singleSource');
55
const secrets = require('../../shared/secrets');
6+
const domainUtils = require('../../shared/domains');
67

78
module.exports = {
89
createContainers() {
@@ -18,12 +19,33 @@ module.exports = {
1819
`Container ${res.name} removed from config file, deleting it...`
1920
);
2021
this.waitForContainerStatus(containerIdToDelete, "deleted").then(
21-
this.serverless.cli.log(`Container ${res.name} deleted`)
22+
this.serverless.cli.log(`Container ${res.name} deleted`),
2223
);
2324
});
2425
});
2526
},
2627

28+
29+
applyDomainsContainer(containerId, customDomains) {
30+
this.listDomainsContainer(containerId).then((domains) => {
31+
const existingDomains = domainUtils.formatDomainsStructure(domains);
32+
const domainsToCreate = domainUtils.getDomainsToCreate(customDomains, existingDomains);
33+
const domainsIdToDelete = domainUtils.getDomainsToDelete(customDomains, existingDomains);
34+
35+
domainsToCreate.forEach((newDomain) => {
36+
const createDomainParams = { container_id: containerId, hostname: newDomain };
37+
38+
this.createDomainAndLog(createDomainParams);
39+
});
40+
41+
domainsIdToDelete.forEach((domainId) => {
42+
this.deleteDomain(domainId).then((res) => {
43+
this.serverless.cli.log(`Deleting domain ${res.hostname}`);
44+
});
45+
});
46+
});
47+
},
48+
2749
createOrUpdateContainers(foundContainers) {
2850
const { containers } = this.provider.serverless.service.custom;
2951

@@ -68,6 +90,12 @@ module.exports = {
6890
port: container.port,
6991
};
7092

93+
// checking if there is custom_domains set on container creation.
94+
if (container.custom_domains && container.custom_domains.length > 0) {
95+
this.serverless.cli.log("WARNING: custom_domains are available on container update only. "+
96+
"Redeploy your container to apply custom domains. Doc : https://www.scaleway.com/en/docs/compute/containers/how-to/add-a-custom-domain-to-a-container/")
97+
}
98+
7199
this.serverless.cli.log(`Creating container ${container.name}...`);
72100

73101
return this.createContainer(params)
@@ -93,6 +121,10 @@ module.exports = {
93121
};
94122

95123
this.serverless.cli.log(`Updating container ${container.name}...`);
124+
125+
// assign domains
126+
this.applyDomainsContainer(foundContainer.id, container.custom_domains);
127+
96128
return this.updateContainer(foundContainer.id, params)
97129
.then(response => Object.assign(response, { directory: container.directory }));
98130
},

‎deploy/lib/createFunctions.js‎

Lines changed: 9 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
const BbPromise = require('bluebird');
44
const secrets = require('../../shared/secrets');
55
const singleSource = require('../../shared/singleSource');
6+
const domainUtils = require('../../shared/domains');
67
const { RUNTIME_STATUS_AVAILABLE, RUNTIME_STATUS_EOL, RUNTIME_STATUS_EOS } = require('../../shared/runtimes');
78

89
module.exports = {
@@ -53,77 +54,21 @@ module.exports = {
5354
});
5455
},
5556

56-
applyDomains(funcId, customDomains) {
57+
applyDomainsFunc(funcId, customDomains) {
5758
// we make a diff to know which domains to add or delete
58-
const domainsToCreate = [];
59-
const domainsIdToDelete = [];
60-
const existingDomains = [];
6159

62-
this.listDomains(funcId).then((domains) => {
63-
domains.forEach((domain) => {
64-
existingDomains.push({ hostname: domain.hostname, id: domain.id });
65-
});
66-
67-
if (
68-
customDomains !== undefined &&
69-
customDomains !== null &&
70-
customDomains.length > 0
71-
) {
72-
customDomains.forEach((customDomain) => {
73-
domainsIdToDelete.push(customDomain.id);
74-
75-
let domainFound = false;
76-
77-
existingDomains.forEach((existingDom) => {
78-
if (existingDom.hostname === customDomain) {
79-
domainFound = true;
80-
return false;
81-
}
82-
});
83-
if (!domainFound) {
84-
domainsToCreate.push(customDomain);
85-
}
86-
});
87-
}
88-
89-
existingDomains.forEach((existingDomain) => {
90-
if (
91-
(customDomains === undefined || customDomains === null) &&
92-
existingDomain.id !== undefined
93-
) {
94-
domainsIdToDelete.push(existingDomain.id);
95-
} else if (!customDomains.includes(existingDomain.hostname)) {
96-
domainsIdToDelete.push(existingDomain.id);
97-
}
98-
});
60+
this.listDomainsFunction(funcId).then((domains) => {
61+
const existingDomains = domainUtils.formatDomainsStructure(domains);
62+
const domainsToCreate = domainUtils.getDomainsToCreate(customDomains, existingDomains);
63+
const domainsIdToDelete = domainUtils.getDomainsToDelete(customDomains, existingDomains);
9964

10065
domainsToCreate.forEach((newDomain) => {
10166
const createDomainParams = { function_id: funcId, hostname: newDomain };
10267

103-
this.createDomain(createDomainParams)
104-
.then((res) => {
105-
this.serverless.cli.log(`Creating domain ${res.hostname}`);
106-
})
107-
.then(
108-
() => {},
109-
(reason) => {
110-
this.serverless.cli.log(
111-
`Error on domain : ${newDomain}, reason : ${reason.message}`
112-
);
113-
114-
if (reason.message.includes("could not validate")) {
115-
this.serverless.cli.log(
116-
"Ensure CNAME configuration is ok, it can take some time for a record to propagate"
117-
);
118-
}
119-
}
120-
);
68+
this.createDomainAndLog(createDomainParams);
12169
});
12270

12371
domainsIdToDelete.forEach((domainId) => {
124-
if (domainId === undefined) {
125-
return;
126-
}
12772
this.deleteDomain(domainId).then((res) => {
12873
this.serverless.cli.log(`Deleting domain ${res.hostname}`);
12974
});
@@ -226,7 +171,7 @@ Runtime lifecycle doc : https://www.scaleway.com/en/docs/compute/functions/refer
226171
params.runtime = this.validateRuntime(
227172
func,
228173
availableRuntimes,
229-
this.serverless.cli
174+
this.serverless.cli,
230175
);
231176

232177
// checking if there is custom_domains set on function creation.
@@ -270,7 +215,7 @@ Runtime lifecycle doc : https://www.scaleway.com/en/docs/compute/functions/refer
270215
this.serverless.cli.log(`Updating function ${func.name}...`);
271216

272217
// assign domains
273-
this.applyDomains(foundFunc.id, func.custom_domains);
218+
this.applyDomainsFunc(foundFunc.id, func.custom_domains);
274219

275220
return this.updateFunction(foundFunc.id, params).then((response) =>
276221
Object.assign(response, { handler: func.handler })

‎deploy/lib/deployContainers.js‎

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,41 @@ const BbPromise = require('bluebird');
44

55
module.exports = {
66
deployContainers() {
7-
this.serverless.cli.log('Deploying Containers...');
7+
this.serverless.cli.log("Deploying Containers...");
88
return BbPromise.bind(this)
99
.then(this.deployEachContainer)
10-
.then(() => this.serverless.cli.log('Waiting for container deployments, this may take multiple minutes...'))
10+
.then(() =>
11+
this.serverless.cli.log(
12+
"Waiting for container deployments, this may take multiple minutes..."
13+
)
14+
)
1115
.then(this.printContainerEndpointsAfterDeployment);
1216
},
1317

1418
deployEachContainer() {
15-
const promises = this.containers.map(
16-
container => this.deployContainer(container.id),
19+
const promises = this.containers.map((container) =>
20+
this.deployContainer(container.id)
1721
);
1822
return Promise.all(promises);
1923
},
2024

2125
printContainerEndpointsAfterDeployment() {
22-
return this.waitContainersAreDeployed(this.namespace.id)
23-
.then(containers => containers.forEach(
24-
container => this.serverless.cli.log(`Container ${container.name} has been deployed to: https://${container.domain_name}`),
25-
));
26+
return this.waitContainersAreDeployed(this.namespace.id).then(
27+
(containers) => {
28+
containers.forEach((container) => {
29+
this.serverless.cli.log(
30+
`Container ${container.name} has been deployed to: https://${container.domain_name}`
31+
);
32+
33+
this.serverless.cli.log("Waiting for domains deployment...");
34+
35+
this.waitDomainsAreDeployedContainer(container.id).then((domains) => {
36+
domains.forEach((domain) => {
37+
this.serverless.cli.log(`Domain ready : ${domain.hostname}`);
38+
});
39+
});
40+
});
41+
}
42+
);
2643
},
2744
};

‎deploy/lib/deployFunctions.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ module.exports = {
4040
'Waiting for domains deployment...',
4141
);
4242

43-
this.waitDomainsAreDeployed(func.id)
43+
this.waitDomainsAreDeployedFunction(func.id)
4444
.then((domains) => {
4545
domains.forEach((domain) => {
4646
this.serverless.cli.log(`Domain ready : ${domain.hostname}`);

0 commit comments

Comments
 (0)