@iexec/iapp-maker 0.0.1-alpha-nightly-79e0105f6025d93833a45abc311c73fb2b5b6c26 → 0.0.1-alpha-nightly-ef579faebe1b4ee041f6da3e79851c51d6dd180e

package/README.md

@@ -14,6 +14,21 @@ This CLI provides an interface to guide you through different steps:
   (`iapp init` will also propose you to do so)
 - Docker
 
+> ℹ️ For MacOS users
+>
+> This tool use `docker buildx` to build images for `linux/amd64` platform
+> compatible with iExec's decentralized workers.
+>
+> Make sure your docker builder supports AMD64 architecture:
+>
+> ```sh
+> docker buildx inspect --bootstrap | grep -i platforms
+> ```
+>
+> The output should include `linux/amd64` in the list of supported platforms. If
+> not update te the latest Docker Desktop version which includes these
+> requirements.
+
 ## Install
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iexec/iapp-maker",
-  "version": "0.0.1-alpha-nightly-79e0105f6025d93833a45abc311c73fb2b5b6c26",
+  "version": "0.0.1-alpha-nightly-ef579faebe1b4ee041f6da3e79851c51d6dd180e",
   "description": "A CLI to guide you through the process of building an iExec iApp",
   "main": "src/index.js",
   "type": "module",
@@ -44,7 +44,6 @@
     "magic-bytes.js": "^1.10.0",
     "ora": "^8.1.1",
     "prompts": "^2.4.2",
-    "undici": "^6.21.0",
     "uuid": "^11.0.3",
     "yargs": "^17.7.2",
     "zod": "^3.23.8",

package/src/cmd/deploy.js

@@ -89,7 +89,6 @@ export async function deploy() {
       'Transforming your image into a TEE image and deploying on iExec, this may take a few minutes...'
     );
     const { sconifiedImage, appContractAddress } = await sconify({
-      sconifyForProd: false,
       iAppNameToSconify: imageTag,
       walletAddress,
       dockerhubAccessToken,

package/src/cmd/run.js

@@ -133,8 +133,7 @@ export async function runInDebug({
     tag: SCONE_TAG,
   });
   const apporder = await iexec.order.signApporder(apporderTemplate);
-  await iexec.order.publishApporder(apporder);
-  spinner.succeed('AppOrder created and published');
+  spinner.succeed('AppOrder created');
 
   // Dataset Order
   let datasetorder;

package/src/cmd/test.js

@@ -113,7 +113,7 @@ export async function testApp({
   const imageId = await dockerBuild({
     isForTest: true,
     progressCallback: (msg) => {
-      spinner.text = spinner.text + +color.comment(msg);
+      spinner.text = spinner.text + color.comment(msg);
     },
   });
   spinner.succeed(`App docker image built (${imageId})`);

package/src/execDocker/docker.js

@@ -24,22 +24,19 @@ export async function dockerBuild({
     src: ['./'],
   };
 
-  let platform;
-  if (osType === 'Darwin') {
-    // For MacOS
-    if (isForTest) {
-      // ARM64 variant for local testing only
-      platform = 'linux/arm64';
-    } else {
-      // AMD64 variant to deploy to iExec stack
-      platform = 'linux/amd64';
-    }
+  // by default force to build amd64 image which is architecture used in iExec workers
+  // this require buildx builder to support 'linux/amd64' (some devices may need QEMU for amd64 architecture emulation)
+  let platform = 'linux/amd64';
+  // for MacOS local testing only build arm64 variant
+  if (osType === 'Darwin' && isForTest) {
+    platform = 'linux/arm64';
   }
 
   // Perform the Docker build operation
   const buildImageStream = await docker.buildImage(buildArgs, {
     t: tag,
     platform,
+    pull: true, // docker store does not support multi platform image, this can cause issues when switching build target platform, pulling ensures the right image is used
   });
 
   const imageId = await new Promise((resolve, reject) => {

package/src/utils/dockerhub.js

@@ -29,6 +29,17 @@ export async function getAuthToken({
       `Fail to get authorization token for scope=${repository}:${action}`
     );
   }
-  const { token } = await response.json();
-  return token;
+  return response
+    .json()
+    .catch(() => {
+      throw Error(`Unexpected response from dockerhub auth server`);
+    })
+    .then(({ token }) => {
+      if (!token) {
+        throw Error(
+          `Unexpected response from dockerhub auth server: Missing token`
+        );
+      }
+      return token;
+    });
 }

package/src/utils/initIAppWorkspace.js

@@ -91,6 +91,9 @@ async function copyChosenTemplateFiles({
   const files = await fs.readdir(templateDir);
   await Promise.all(files.map((file) => write(file)));
 
+  // rename _.gitignore (npm does not allow publishing files named .gitignore in a package)
+  await fs.rename('_.gitignore', '.gitignore');
+
   // transform template: remove unwanted feature code inside " // <<feature>> ... // <</feature>>" tags
   const code = (await fs.readFile(srcFile)).toString('utf8');
   let modifiedCode = code;

package/src/utils/prepareInputFile.js

@@ -1,6 +1,5 @@
 import { mkdir, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
-import { request } from 'undici';
 import { TEST_INPUT_DIR } from '../config/config.js';
 
 // TODO we may want to cache to avoid downloading large input files over and over
@@ -19,9 +18,7 @@ export async function prepareInputFile(url) {
     if (name === '.' || name === '..') {
       throw Error('Invalid computed file name');
     }
-    await request(url, {
-      throwOnError: true,
-    }).then(async (response) => {
+    await fetch(url).then(async (response) => {
       await mkdir(TEST_INPUT_DIR, { recursive: true }); // ensure input dir
       await writeFile(join(TEST_INPUT_DIR, name), response.body);
     });

package/src/utils/sconify.js

@@ -1,19 +1,19 @@
-import { request } from 'undici';
 import { addDeploymentData } from './cacheExecutions.js';
 import { SCONIFY_API_URL } from '../config/config.js';
 import { getAuthToken } from '../utils/dockerhub.js';
+import { sleep } from './sleep.js';
+
+const INITIAL_RETRY_PERIOD = 20 * 1000; // 20s
+
+class TooManyRequestsError extends Error {}
 
 export async function sconify({
-  sconifyForProd,
   iAppNameToSconify,
   walletAddress,
   dockerhubAccessToken,
   dockerhubUsername,
+  tryCount = 0,
 }) {
-  if (sconifyForProd) {
-    throw Error('This feature is not yet implemented. Coming soon ...');
-  }
-
   let appContractAddress;
   let sconifiedImage;
   try {
@@ -26,7 +26,7 @@ export async function sconify({
       dockerhubUsername,
     });
 
-    const { body } = await request(`${SCONIFY_API_URL}/sconify`, {
+    const jsonResponse = await fetch(`${SCONIFY_API_URL}/sconify`, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
@@ -37,26 +37,56 @@ export async function sconify({
         dockerhubPushToken: pushToken, // used for pushing sconified image on user repo
         yourWalletPublicAddress: walletAddress,
       }),
-      throwOnError: true,
-    });
+    })
+      .catch(() => {
+        throw Error("Can't reach TEE transformation server!");
+      })
+      .then((res) => {
+        if (res.ok) {
+          return res.json().catch(() => {
+            // failed to parse body
+            throw Error('Unexpected server response');
+          });
+        }
+        if (res.status === 429) {
+          throw new TooManyRequestsError(
+            'TEE transformation server is busy, retry later'
+          );
+        }
+        // try getting error message from json body
+        return res
+          .json()
+          .catch(() => {
+            // failed to parse body
+            throw Error('Unknown server error');
+          })
+          .then(({ error }) => {
+            throw Error(error || 'Unknown server error');
+          });
+      });
 
     // Extract necessary information
-    const json = await body.json();
-    sconifiedImage = json.sconifiedImage;
-    appContractAddress = json.appContractAddress;
+    if (!jsonResponse.appContractAddress) {
+      throw Error('Unexpected server response: missing appContractAddress');
+    }
+    if (!jsonResponse.sconifiedImage) {
+      throw Error('Unexpected server response: missing sconifiedImage');
+    }
+    appContractAddress = jsonResponse.appContractAddress;
+    sconifiedImage = jsonResponse.sconifiedImage;
   } catch (err) {
-    let reason;
-    if (err.body) {
-      reason = err.body;
-    } else if (
-      err?.code === 'ECONNREFUSED' ||
-      err?.code === 'UND_ERR_CONNECT_TIMEOUT'
-    ) {
-      reason = "Can't reach TEE transformation server!";
-    } else {
-      reason = err.toString();
+    // retry with exponential backoff
+    if (err instanceof TooManyRequestsError && tryCount < 3) {
+      await sleep(INITIAL_RETRY_PERIOD * Math.pow(2, tryCount));
+      return sconify({
+        iAppNameToSconify,
+        walletAddress,
+        dockerhubAccessToken,
+        dockerhubUsername,
+        tryCount: tryCount + 1,
+      });
     }
-    throw Error(`Failed to transform your app into a TEE app: ${reason}`);
+    throw Error(`Failed to transform your app into a TEE app: ${err.message}`);
   }
 
   // Add deployment data to deployments.json

package/src/utils/sleep.js

@@ -0,0 +1 @@
+export const sleep = async (ms) => new Promise((res) => setTimeout(res, ms));

package/templates/js/_.gitignore

@@ -0,0 +1,9 @@
+# iapp config file may contain secrets
+iapp.config.json
+
+# dependencies
+node_modules
+
+# test directories
+input
+output

package/templates/js/package-lock.json

@@ -1,13 +1,13 @@
 {
-  "name": "hello-world",
-  "version": "1.0.0",
+  "name": "iexec-hello-world-iapp",
+  "version": "0.0.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
     "@iexec/dataprotector-deserializer": {
-      "version": "0.1.0",
-      "resolved": "https://registry.npmjs.org/@iexec/dataprotector-deserializer/-/dataprotector-deserializer-0.1.0.tgz",
-      "integrity": "sha512-qjrcWR286qegASxcHMSZCmt6dKubIHXIqceXqSscq4vzEDHn4nIwHUabDbTLQbvdrF0XGswNeQuYc10vgjZtow==",
+      "version": "0.1.1",
+      "resolved": "https://registry.npmjs.org/@iexec/dataprotector-deserializer/-/dataprotector-deserializer-0.1.1.tgz",
+      "integrity": "sha512-CSz1JWnslm2X3gjL1cx/qqovnmvJSFWDyJMw0ZGvqnYnNatgIqHn+Aky2iO4K0HsArfqmgV3ySIpdPfu/N2M0w==",
       "requires": {
         "borsh": "^2.0.0",
         "jszip": "^3.10.1"

package/templates/js/package.json

@@ -8,7 +8,7 @@
     "npm": "<7.0.0"
   },
   "dependencies": {
-    "@iexec/dataprotector-deserializer": "^0.1.0",
+    "@iexec/dataprotector-deserializer": "^0.1.1",
     "figlet": "^1.7.0"
   }
 }