@iexec/iapp-maker 0.0.1-alpha-nightly-6be476717b877e4857383c375d5f209dbd288f99 → 0.0.1-alpha-nightly-c88f1c62428cda426ca60c8b374fb74970fb6fba

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iexec/iapp-maker",
-  "version": "0.0.1-alpha-nightly-6be476717b877e4857383c375d5f209dbd288f99",
+  "version": "0.0.1-alpha-nightly-c88f1c62428cda426ca60c8b374fb74970fb6fba",
   "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

@@ -6,7 +6,10 @@ import {
 import { sconify } from '../utils/sconify.js';
 import { askForDockerhubUsername } from '../cli-helpers/askForDockerhubUsername.js';
 import { askForWalletAddress } from '../cli-helpers/askForWalletAddress.js';
-import { readPackageJonConfig } from '../utils/iAppConfigFile.js';
+import {
+  projectNameToImageName,
+  readIAppConfig,
+} from '../utils/iAppConfigFile.js';
 import { askForDockerhubAccessToken } from '../cli-helpers/askForDockerhubAccessToken.js';
 import { handleCliError } from '../cli-helpers/handleCliError.js';
 import { getSpinner } from '../cli-helpers/spinner.js';
@@ -22,6 +25,8 @@ export async function deploy() {
   const spinner = getSpinner();
   try {
     await goToProjectRoot({ spinner });
+    const { projectName } = await readIAppConfig();
+
     const dockerhubUsername = await askForDockerhubUsername({ spinner });
     const dockerhubAccessToken = await askForDockerhubAccessToken({ spinner });
 
@@ -38,6 +43,8 @@ export async function deploy() {
       throw Error('Invalid version');
     }
 
+    const imageTag = `${dockerhubUsername}/${projectNameToImageName(projectName)}:${iAppVersion}`;
+
     const appSecret = await askForAppSecret({ spinner });
 
     const walletAddress = await askForWalletAddress({ spinner });
@@ -54,11 +61,6 @@ export async function deploy() {
       iexec = getIExecDebug(privateKey);
     }
 
-    const config = await readPackageJonConfig();
-    const iAppName = config.name.toLowerCase();
-
-    const imageTag = `${dockerhubUsername}/${iAppName}:${iAppVersion}`;
-
     // just start the spinner, no need to persist success in terminal
     spinner.start('Checking docker daemon is running...');
     await checkDockerDaemon();
@@ -89,7 +91,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/init.js

@@ -1,6 +1,7 @@
 import chalk from 'chalk';
 import figlet from 'figlet';
 import { mkdir } from 'node:fs/promises';
+import { fromError } from 'zod-validation-error';
 import { folderExists } from '../utils/fs.utils.js';
 import { initIAppWorkspace } from '../utils/initIAppWorkspace.js';
 import { getSpinner } from '../cli-helpers/spinner.js';
@@ -8,6 +9,7 @@ import { handleCliError } from '../cli-helpers/handleCliError.js';
 import { generateWallet } from '../utils/generateWallet.js';
 import * as color from '../cli-helpers/color.js';
 import { hintBox } from '../cli-helpers/box.js';
+import { projectNameSchema } from '../utils/iAppConfigFile.js';
 
 const targetDir = 'hello-world';
 
@@ -30,6 +32,16 @@ export async function init() {
       name: 'projectName',
       message: `What's your project name? ${color.promptHelper('(A folder with this name will be created)')}`,
       initial: targetDir,
+      validate: (value) => {
+        try {
+          projectNameSchema.parse(value);
+          return true;
+        } catch (e) {
+          return fromError(e)
+            .details.map((issue) => issue.message)
+            .join('; ');
+        }
+      },
     });
 
     if (await folderExists(projectName)) {

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/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/iAppConfigFile.js

@@ -3,8 +3,27 @@ import { z } from 'zod';
 import { fromError } from 'zod-validation-error';
 import { CONFIG_FILE } from '../config/config.js';
 
+export const projectNameSchema = z
+  .string()
+  .min(2, 'Must contain at least 2 characters') // docker image name constraint
+  .refine(
+    (value) => !/(^\s)|(\s$)/.test(value),
+    'Should not start or end with space'
+  )
+  .refine(
+    (value) => /^[a-zA-Z0-9- ]+$/.test(value ?? ''),
+    'Only letters, numbers, spaces, and hyphens are allowed'
+  );
+
+const dockerImageNameSchema = z
+  .string()
+  .refine(
+    (value) => /^[a-z0-9-]+$/.test(value ?? ''),
+    'Invalid docker image name'
+  );
+
 const jsonConfigFileSchema = z.object({
-  projectName: z.string(),
+  projectName: projectNameSchema,
   dockerhubUsername: z.string().optional(),
   dockerhubAccessToken: z.string().optional(),
   walletAddress: z.string().optional(),
@@ -12,6 +31,12 @@ const jsonConfigFileSchema = z.object({
   appSecret: z.string().optional().nullable(), // can be null or string (null means do no use secret)
 });
 
+// transform the projectName into a suitable docker image name (no space, lowercase only)
+export function projectNameToImageName(projectName = '') {
+  const imageName = projectName.toLowerCase().replaceAll(' ', '-');
+  return dockerImageNameSchema.parse(imageName);
+}
+
 // Read JSON configuration file
 export async function readIAppConfig() {
   const configContent = await readFile(CONFIG_FILE, 'utf8').catch(() => {
@@ -37,16 +62,6 @@ export async function readIAppConfig() {
   }
 }
 
-// Read package.json file
-export async function readPackageJonConfig() {
-  try {
-    const packageContent = await readFile('./package.json', 'utf8');
-    return JSON.parse(packageContent);
-  } catch {
-    throw Error('Failed to read `package.json` file.');
-  }
-}
-
 // Utility function to write the iApp JSON configuration file
 export async function writeIAppConfig(config) {
   await writeFile(CONFIG_FILE, JSON.stringify(config, null, 2));

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/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"
   }
 }