chore: bump version before release + fixes (#321)

* chore: bump version before release + fixes

* fix: reorder apply domains to container

* fix: small log message change

* fix: prettier diff

* test: try to add a sleep to see if it helps

* fix: fmt

* fix: deprecated auth in tests

* fix: fmt

* fix: omg it might work

* fix: fmt

* fix: some more tests

* fix: add blabla

* fix: change authconfig

* Revert "fix: change authconfig"

This reverts commit 2823e72.

* fix: change authconfig again

* fix: oopsie

* fix: oopsie again

* fix: registryAuth invalid region

* fix: change it again

Author: cyclimse

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.5.0
+
+### Added
+
+- Implement `buildArgs` parameter for container build
+
+### Changed
+
+- Handle deprecation of `redeploy: false` parameter in `UpdateContainer`
+
+### Fixed
+
+- When pushing a built to the remote registry, use the correct credentials instead of relying on the local docker configuration.
+
 ## 0.4.18
 
 ### Fixed

deploy/lib/buildAndPushContainers.js

@@ -167,8 +167,8 @@ module.exports = {
       password: this.provider.scwToken,
     };
 
-    // Used for building: see https://docs.docker.com/engine/api/v1.37/#tag/Image/operation/ImageBuild
-    const registryAuth = { [`rg.${this.provider.region}.scw.cloud`]: auth };
+    // Used for building, see https://docs.docker.com/engine/api/v1.37/#tag/Image/operation/ImageBuild
+    const registryAuth = { [`rg.${this.provider.scwRegion}.scw.cloud`]: auth };
 
     try {
       await docker.checkAuth(registryAuth);
@@ -178,21 +178,28 @@ module.exports = {
 
     const { containers } = this.provider.serverless.service.custom;
 
-    const buildPromises = Object.keys(containers).map((containerName) => {
-      const containerConfig = Object.assign(containers[containerName], {
-        name: containerName,
+    const buildPromises = Object.keys(containers)
+      .map((containerName) => {
+        const containerConfig = {
+          ...containers[containerName],
+          name: containerName,
+        };
+        return containerConfig;
+      })
+      // If directory is not specified, the container does not need to be built,
+      // we can directly create it from the registry image.
+      .filter((containerConfig) => containerConfig.directory !== undefined)
+      .map((containerConfig) => {
+        validateContainerConfigBeforeBuild(containerConfig);
+
+        return buildAndPushContainer.call(
+          this,
+          registryAuth,
+          auth,
+          containerConfig
+        );
       });
 
-      validateContainerConfigBeforeBuild(containerConfig);
-
-      return buildAndPushContainer.call(
-        this,
-        registryAuth,
-        auth,
-        containerConfig
-      );
-    });
-
     await Promise.all(buildPromises);
   },
 };

deploy/lib/createContainers.js

@@ -180,10 +180,18 @@ module.exports = {
 
     this.serverless.cli.log(`Creating container ${container.name}...`);
 
-    return this.createContainer(params);
+    return this.createContainer(params).then((createdContainer) => {
+      return this.deployContainer(createdContainer.id);
+    });
   },
 
   async updateSingleContainer(container, foundContainer) {
+    // Assign domains to the container before updating it, as it's not possible to manage domains
+    // while the container is updating or pending, and we already wait for the container
+    // to be in a final status before updating it.
+    // => This order of operation is simpler and does not require performing two separate waits.
+    this.applyDomainsContainer(foundContainer.id, container.custom_domains);
+
     let privateNetworkId = container.privateNetworkId;
     const hasToDeletePrivateNetwork =
       foundContainer.private_network_id && !container.privateNetworkId;
@@ -192,7 +200,6 @@ module.exports = {
     }
 
     const params = {
-      redeploy: false,
       environment_variables: container.env,
       secret_environment_variables: await secrets.mergeSecretEnvVars(
         foundContainer.secret_environment_variables,
@@ -225,9 +232,22 @@ module.exports = {
 
     this.serverless.cli.log(`Updating container ${container.name}...`);
 
-    // assign domains
-    this.applyDomainsContainer(foundContainer.id, container.custom_domains);
+    return this.updateContainer(foundContainer.id, params).then(
+      (updatedContainer) => {
+        // If the container is updating, no need to do anything, a redeploy is already in progress.
+        if (
+          updatedContainer.status === "pending" ||
+          updatedContainer.status === "updating"
+        ) {
+          return updatedContainer;
+        }
 
-    return this.updateContainer(foundContainer.id, params);
+        this.serverless.cli.log(
+          `Redeploying container ${container.name} to apply changes...`
+        );
+
+        return this.deployContainer(updatedContainer.id);
+      }
+    );
   },
 };

deploy/lib/deployContainers.js

@@ -18,7 +18,7 @@ module.exports = {
 
           this.waitDomainsAreDeployedContainer(container.id).then((domains) => {
             domains.forEach((domain) => {
-              this.serverless.cli.log(`Domain ready : ${domain.hostname}`);
+              this.serverless.cli.log(`Domain ready: ${domain.hostname}`);
             });
           });
         });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-scaleway-functions",
-  "version": "0.4.18",
+  "version": "0.5.0",
   "description": "Provider plugin for the Serverless Framework v3.x which adds support for Scaleway Functions.",
   "main": "index.js",
   "author": "scaleway.com",

shared/api/utils.js

@@ -1,7 +1,7 @@
 const axios = require("axios");
 const https = require("https");
 
-const version = "0.4.18";
+const version = "0.5.0";
 
 const invalidArgumentsType = "invalid_arguments";
 

tests/containers/containers.test.js

@@ -106,32 +106,40 @@ describe("Service Lifecyle Integration Test", () => {
       password: scwToken,
     };
 
-    const regEndpoint = `rg.${scwRegion}.scw.cloud`;
-    const registryAuth = {};
-    registryAuth[regEndpoint] = auth;
-
-    await docker.checkAuth(registryAuth);
-
-    await docker.buildImage(
-      {
-        context: path.join(tmpDir, "my-container"),
-        src: ["Dockerfile", "server.py", "requirements.txt"],
-      },
-      {
-        t: imageName,
-        registryconfig: registryAuth,
-      }
-    );
+    // Build image and wait for completion
+    await new Promise((resolve, reject) => {
+      docker.buildImage(
+        {
+          context: path.join(tmpDir, "my-container"),
+          src: ["Dockerfile", "server.py", "requirements.txt"],
+        },
+        // Ensure no credentials are sent to Docker Hub.
+        { t: imageName, authconfig: {} },
+        (err, stream) => {
+          if (err) return reject(err);
+          docker.modem.followProgress(stream, (err, res) =>
+            err ? reject(err) : resolve(res)
+          );
+        }
+      );
+    });
+
     const image = docker.getImage(imageName);
-    await image.push(auth);
+
+    // Push image and wait for completion
+    await new Promise((resolve, reject) => {
+      image.push({ authconfig: auth }, (err, stream) => {
+        if (err) return reject(err);
+        docker.modem.followProgress(stream, (err, res) =>
+          err ? reject(err) : resolve(res)
+        );
+      });
+    });
 
     // registry lag
     await sleep(60000);
 
-    const params = {
-      redeploy: false,
-      registry_image: imageName,
-    };
+    const params = { registry_image: imageName };
     await api
       .updateContainer(namespace.containers[0].id, params)
       .catch((err) => console.error(err));
@@ -178,12 +186,20 @@ describe("Service Lifecyle Integration Test", () => {
   });
 
   it("should deploy with registry image specified", () => {
+    // Instead of building the container from the directory, we specify a registry image.
+    replaceTextInFile(
+      "serverless.yml",
+      "directory: my-container",
+      "# directory: my-container"
+    );
     replaceTextInFile(
       "serverless.yml",
       '# registryImage: ""',
       "registryImage: docker.io/library/nginx:latest"
     );
     replaceTextInFile("serverless.yml", "# port: 8080", "port: 80");
+    // Need to change the probe path to / since Nginx doesn't have /health endpoint
+    replaceTextInFile("serverless.yml", "httpPath: /health", "httpPath: /");
     serverlessDeploy(options);
   });
 

tests/containers/containers_private_registry.test.js

@@ -85,20 +85,30 @@ describe("Build and deploy on container with a base image private", () => {
     const pullStream = await docker
       .pull(`${originalImageRepo}:${imageTag}`)
       .then();
+
     // Wait for pull to finish
     await new Promise((res) => docker.modem.followProgress(pullStream, res));
-    const originalImage = await docker.getImage(
-      `${originalImageRepo}:${imageTag}`
-    );
+    const originalImage = docker.getImage(`${originalImageRepo}:${imageTag}`);
     await originalImage.tag({ repo: privateRegistryImageRepo, tag: imageTag });
+
     const privateRegistryImage = docker.getImage(
       `${privateRegistryImageRepo}:${imageTag}`
     );
-    await privateRegistryImage.push({
-      stream: false,
+
+    const auth = {
       username: "nologin",
       password: scwToken,
+    };
+
+    await new Promise((resolve, reject) => {
+      privateRegistryImage.push({ authconfig: auth }, (err, stream) => {
+        if (err) return reject(err);
+        docker.modem.followProgress(stream, (err, res) =>
+          err ? reject(err) : resolve(res)
+        );
+      });
     });
+
     await privateRegistryImage.remove();
   });
 

tests/utils/misc/index.js

@@ -110,10 +110,23 @@ function sleep(ms) {
 
 async function createProject() {
   const accountApi = new AccountApi(ACCOUNT_API_URL, secretKey);
-  return accountApi.createProject({
+
+  // Unfortunately, there's a small delay between the creation of a project and its availability for API calls.
+  // We wait 1 minute to ensure there's no issue with IAM cache.
+  const project = await accountApi.createProject({
     name: `test-slsframework-${crypto.randomBytes(6).toString("hex")}`,
     organization_id: organizationId,
   });
+
+  console.log(
+    `Project ${project.name} created, waiting for it to be available...`
+  );
+
+  await sleep(60000);
+
+  console.log(`Project ${project.name} is now available.`);
+
+  return project;
 }
 
 module.exports = {