piral-cli 1.4.0-beta.6250 → 1.4.0-beta.6253

package/src/common/website.ts

@@ -1,10 +1,10 @@
-import { join, resolve } from 'path';
+import { join, relative, resolve } from 'path';
 import { createPiralStubIndexIfNotExists } from './template';
 import { packageJson } from './constants';
 import { ForceOverwrite } from './enums';
-import { createDirectory, writeBinary } from './io';
+import { createDirectory, readJson, writeBinary } from './io';
 import { writeJson } from './io';
-import { progress } from './log';
+import { progress, log } from './log';
 import { axios } from '../external';
 import { EmulatorWebsiteManifestFiles, EmulatorWebsiteManifest } from '../types';
 
@@ -21,16 +21,14 @@ async function downloadEmulatorFiles(manifestUrl: string, target: string, files:
   );
 }
 
-export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl: string) {
-  progress(`Downloading emulator from %s ...`, manifestUrl);
-  const response = await axios.default.get(manifestUrl);
-  const emulatorJson: EmulatorWebsiteManifest = response.data;
-
-  const targetDir = resolve(rootDir, 'node_modules', emulatorJson.name);
-  const appDirName = 'app';
+async function createEmulatorFiles(
+  targetDir: string,
+  appDir: string,
+  manifestUrl: string,
+  emulatorJson: EmulatorWebsiteManifest,
+) {
   const mainFile = 'index.js';
-  const appDir = resolve(targetDir, appDirName);
-  await createDirectory(appDir);
+  const appDirName = relative(targetDir, appDir);
 
   await writeJson(
     targetDir,
@@ -48,9 +46,9 @@ export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl:
         generated: true,
       },
       files: emulatorJson.files.assets,
-      main: `./${join(appDirName, mainFile)}`,
-      typings: `./${join(appDirName, emulatorJson.files.typings)}`,
-      app: `./${join(appDirName, emulatorJson.files.app)}`,
+      main: join(appDirName, mainFile),
+      typings: join(appDirName, emulatorJson.files.typings),
+      app: join(appDirName, emulatorJson.files.app),
       peerDependencies: {},
       optionalDependencies: emulatorJson.dependencies.optional,
       devDependencies: emulatorJson.dependencies.included,
@@ -65,5 +63,38 @@ export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl:
   });
 
   await downloadEmulatorFiles(manifestUrl, appDir, emulatorJson.files);
-  return emulatorJson.name;
+}
+
+export async function updateFromEmulatorWebsite(targetDir: string, manifestUrl: string) {
+  progress(`Updating emulator from %s ...`, manifestUrl);
+
+  try {
+    const response = await axios.default.get(manifestUrl);
+    const nextEmulator: EmulatorWebsiteManifest = response.data;
+    const currentEmulator = await readJson(targetDir, packageJson);
+
+    if (currentEmulator.name !== nextEmulator.name) {
+      log('remoteEmulatorNameChanged_0121', currentEmulator.name);
+    } else if (currentEmulator.piralCLI.timstamp !== nextEmulator.timestamp) {
+      log('generalDebug_0003', `The timestamp on "${currentEmulator.name}" is different (${nextEmulator.timestamp}).`);
+      const appDir = resolve(targetDir, 'app');
+      await createEmulatorFiles(targetDir, appDir, manifestUrl, nextEmulator);
+    } else {
+      log('generalDebug_0003', `Nothing to update for "${currentEmulator.name}".`);
+    }
+  } catch (ex) {
+    log('generalDebug_0003', `HTTP request for emulator update failed: ${ex}`);
+    log('skipEmulatorUpdate_0120', manifestUrl);
+  }
+}
+
+export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl: string) {
+  progress(`Downloading emulator from %s ...`, manifestUrl);
+  const response = await axios.default.get(manifestUrl);
+  const emulatorJson: EmulatorWebsiteManifest = response.data;
+  const targetDir = resolve(rootDir, 'node_modules', emulatorJson.name);
+  const appDir = resolve(targetDir, 'app');
+  await createDirectory(appDir);
+  await createEmulatorFiles(targetDir, appDir, manifestUrl, emulatorJson);
+  return { name: emulatorJson.name, path: targetDir };
 }

package/src/injectors/pilet-injector.ts

@@ -343,8 +343,18 @@ export default class PiletInjector implements KrasInjector {
 
       if (!fileInfo || fileInfo.mtime < this.proxyInfo.date) {
         const url = new URL(path, this.proxyInfo.source);
-        const response = await axios.default.get(url.href, { responseType: 'arraybuffer' });
-        await writeFile(target, response.data);
+
+        try {
+          const response = await axios.default.get(url.href, { responseType: 'arraybuffer' });
+          await writeFile(target, response.data);
+        } catch (ex) {
+          log('generalDebug_0003', `HTTP request for emulator asset retrieval failed: ${ex}`);
+          log(
+            fileInfo ? 'optionalEmulatorAssetUpdateSkipped_0122' : 'requiredEmulatorAssetDownloadSkipped_0123',
+            url.href,
+          );
+          return !!fileInfo;
+        }
       }
 
       return true;

package/src/messages.ts

@@ -2492,6 +2492,99 @@ export function publishFeedMissingVersion_0116(): QuickMessage {
   ];
 }
 
+/**
+ * @kind Info
+ *
+ * @summary
+ * The remote emulator could not be updated using its given manifest URL.
+ *
+ * @abstract
+ * The remote emulator could not be retrieved from its specified URL. This could be due to a problem with
+ * the network or due to the emulator website not being available right now.
+ *
+ * This is just an informative message. In the current scenario the emulator has been downloaded previously
+ * already. Therefore, only potential updates are blocked due to the error.
+ *
+ * If the error persists please try to access the emulator's URL in your browser. In case this works make
+ * sure that the browser does not have different proxy settings compared ot the rest of your system.
+ *
+ * @see
+ * - [Chrome proxy settings](https://oxylabs.io/resources/integrations/chrome)
+ * - [Firefox proxy settings](https://support.mozilla.org/en-US/kb/connection-settings-firefox)
+ */
+export function skipEmulatorUpdate_0120(manifestUrl: string): QuickMessage {
+  return [LogLevels.info, '0120', `Failed to retrieve current emulator from "${manifestUrl}". Skipping update.`];
+}
+
+/**
+ * @kind Warning
+ *
+ * @summary
+ * The remote emulator could not be updated as the given manifest URL returns a differently named emulator.
+ *
+ * @abstract
+ * When a remote emulator is first installed it will be integrated using its specified name as shell name.
+ * The remote emulator is always auto-updated whenever the Piral CLI is running pilet commands. However,
+ * in case the current emulator manifest has a different name the update will be blocked. In this case a
+ * reinstallation of the emulator is necessary.
+ *
+ * Use "pilet remove-piral-instance" and "pilet add-piral-instance" to remove the old instance (by its given
+ * name) and add the new instance (by the manifest URL).
+ *
+ * @see
+ * - [Chrome proxy settings](https://oxylabs.io/resources/integrations/chrome)
+ * - [Firefox proxy settings](https://support.mozilla.org/en-US/kb/connection-settings-firefox)
+ */
+export function remoteEmulatorNameChanged_0121(name: string): QuickMessage {
+  return [LogLevels.warning, '0121', `The name of the emulator has changed. Skipping updates for "${name}".`];
+}
+
+/**
+ * @kind Info
+ *
+ * @summary
+ * An asset of the remote emulator could not be updated.
+ *
+ * @abstract
+ * The metadata of an remote emulator has been updated, however, one of the asset files could
+ * not be updated. The previously downloaded version of this file will be used as a fallback.
+ *
+ * Using the previously downloaded version of a file might just work, however, for several
+ * reasons this might also break. In any case, if you see this info then any kinds of issues
+ * appearing could potentially be solved by just giving your machine network access again or
+ * waiting for the remote sources to be accessible again.
+ *
+ * @see
+ * - [Chrome proxy settings](https://oxylabs.io/resources/integrations/chrome)
+ * - [Firefox proxy settings](https://support.mozilla.org/en-US/kb/connection-settings-firefox)
+ */
+export function optionalEmulatorAssetUpdateSkipped_0122(url: string): QuickMessage {
+  return [LogLevels.info, '0122', `Could not update asset file at "${url}".`];
+}
+
+/**
+ * @kind Warning
+ *
+ * @summary
+ * An asset of the remote emulator could not be downloaded.
+ *
+ * @abstract
+ * The metadata of an remote emulator has been downloaded, however, one of the asset files
+ * could not be downloaded. Consequently, the fallback (index.html) will be used as
+ * replacement in the dev server.
+ *
+ * If you see this warning then any kinds of issues appearing could potentially be solved by
+ * just giving your machine network access again or waiting for the remote sources to be
+ * accessible again.
+ *
+ * @see
+ * - [Chrome proxy settings](https://oxylabs.io/resources/integrations/chrome)
+ * - [Firefox proxy settings](https://support.mozilla.org/en-US/kb/connection-settings-firefox)
+ */
+export function requiredEmulatorAssetDownloadSkipped_0123(url: string): QuickMessage {
+  return [LogLevels.warning, '0123', `Could not download asset file at "${url}".`];
+}
+
 /**
  * @kind Warning
  *