piral-cli 1.7.2 → 1.7.3-beta.7581

package/src/common/config.ts

@@ -73,6 +73,10 @@ export interface PiralCliConfig {
    * Npm registry.
    */
   registry?: string;
+  /**
+   * Allow self-signed certificates.
+   */
+  allowSelfSigned?: boolean;
 }
 
 export const config: PiralCliConfig = rc(
@@ -89,6 +93,7 @@ export const config: PiralCliConfig = rc(
     validators: {},
     schemaVersion: 'v2' as const,
     openBrowser: false,
+    allowSelfSigned: false,
     port: 1234,
     strictPort: false,
     language: 'ts' as const,

package/src/common/http.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, vitest } from 'vitest';
-import { postFile, downloadFile } from './http';
+import { postFile, downloadFile, getAgent } from './http';
 
 const apiUrl = 'http://sample.fooo.com/api/v1/pilet';
 
@@ -80,7 +80,7 @@ vitest.mock('../external', async () => {
         },
       },
     },
-    FormData: (await vitest.importActual('form-data') as any).default,
+    FormData: ((await vitest.importActual('form-data')) as any).default,
   };
 });
 
@@ -155,10 +155,11 @@ describe('HTTP Module', () => {
 
   it('downloadFile calls results in error', async () => {
     errorOther = true;
-    let result = await downloadFile('http://sample.com/', Buffer.from('example'));
+    const agent = getAgent({ ca: Buffer.from('example') });
+    let result = await downloadFile('http://sample.com/', agent);
     expect(result.length).toBe(0);
     errorOther = false;
-    result = await downloadFile('http://sample.com/', Buffer.from('example'));
+    result = await downloadFile('http://sample.com/', agent);
     expect(result.length).toBe(0);
   });
 });

package/src/common/http.ts

@@ -100,8 +100,28 @@ export function getAuthorizationHeaders(scheme: PublishScheme, key: string) {
   return {};
 }
 
-export function downloadFile(target: string, ca?: Buffer): Promise<Array<string>> {
-  const httpsAgent = ca ? new Agent({ ca }) : undefined;
+export interface AgentOptions {
+  ca?: Buffer;
+  allowSelfSigned?: boolean;
+}
+
+export async function getDefaultAgent() {
+  const ca = await getCertificate();
+  const allowSelfSigned = config.allowSelfSigned;
+  return getAgent({ ca, allowSelfSigned });
+}
+
+export function getAgent({ allowSelfSigned, ca }: AgentOptions) {
+  if (ca) {
+    return new Agent({ ca });
+  } else if (allowSelfSigned) {
+    return new Agent({ rejectUnauthorized: false });
+  } else {
+    return undefined;
+  }
+}
+
+export function downloadFile(target: string, httpsAgent: Agent): Promise<Array<string>> {
   return axios.default
     .get<Stream>(target, {
       responseType: 'stream',
@@ -206,10 +226,9 @@ export async function postForm(
   key: string,
   formData: FormDataObj,
   customHeaders: Record<string, string> = {},
-  ca?: Buffer,
+  httpsAgent?: Agent,
   interactive = false,
 ): Promise<PostFormResult> {
-  const httpsAgent = ca ? new Agent({ ca }) : undefined;
   const form = createAxiosForm(formData);
 
   const headers: Record<string, string> = {
@@ -237,7 +256,7 @@ export async function postForm(
       error,
       interactive,
       httpsAgent,
-      (mode, token) => postForm(target, mode, token, formData, customHeaders, ca, false),
+      (mode, token) => postForm(target, mode, token, formData, customHeaders, httpsAgent, false),
       (status, statusText, response) => {
         if (status === 500) {
           log('failedHttpPost_0065', response);
@@ -266,9 +285,9 @@ export function postFile(
   file: Buffer,
   customFields: Record<string, string> = {},
   customHeaders: Record<string, string> = {},
-  ca?: Buffer,
+  agent?: Agent,
   interactive = false,
 ): Promise<PostFormResult> {
   const data: FormDataObj = { ...customFields, file: [file, 'pilet.tgz'] };
-  return postForm(target, scheme, key, data, customHeaders, ca, interactive);
+  return postForm(target, scheme, key, data, customHeaders, agent, interactive);
 }

package/src/common/package.ts

@@ -1,3 +1,4 @@
+import { Agent } from 'https';
 import { resolve, join, extname, basename, dirname, relative } from 'path';
 import { log, fail } from './log';
 import { cliVersion } from './info';
@@ -161,7 +162,8 @@ async function loadPiralInstance(root: string, details?: PiralInstanceDetails):
 export async function findPiralInstance(
   proposedApp: string,
   rootDir: string,
-  details?: PiralInstanceDetails,
+  details: PiralInstanceDetails,
+  agent: Agent,
   interactive = false,
 ) {
   const path = findPackageRoot(proposedApp, rootDir);
@@ -172,13 +174,13 @@ export async function findPiralInstance(
 
     if (url) {
       log('generalDebug_0003', `Updating the emulator from remote "${url}" ...`);
-      await updateFromEmulatorWebsite(root, url, interactive);
+      await updateFromEmulatorWebsite(root, url, agent, interactive);
     }
 
     return await loadPiralInstance(root, details);
   } else if (url) {
     log('generalDebug_0003', `Piral instance not installed yet - trying from remote "${url}" ...`);
-    const emulator = await scaffoldFromEmulatorWebsite(rootDir, url);
+    const emulator = await scaffoldFromEmulatorWebsite(rootDir, url, agent);
     return await loadPiralInstance(emulator.path, details);
   }
 
@@ -190,6 +192,7 @@ export async function findPiralInstances(
   piletPackage: PiletPackageData,
   piletDefinition: undefined | PiletDefinition,
   rootDir: string,
+  agent: Agent,
   interactive?: boolean,
 ) {
   if (proposedApps) {
@@ -208,7 +211,7 @@ export async function findPiralInstances(
   if (proposedApps.length > 0) {
     return Promise.all(
       proposedApps.map((proposedApp) =>
-        findPiralInstance(proposedApp, rootDir, piletDefinition?.piralInstances?.[proposedApp], interactive),
+        findPiralInstance(proposedApp, rootDir, piletDefinition?.piralInstances?.[proposedApp], agent, interactive),
       ),
     );
   }
@@ -280,11 +283,7 @@ export async function getPiralPackage(app: string, data: PiralInstanceData, vers
   };
 }
 
-async function getAvailableFiles(
-  root: string,
-  name: string,
-  dirName: string,
-): Promise<Array<FileDescriptor>> {
+async function getAvailableFiles(root: string, name: string, dirName: string): Promise<Array<FileDescriptor>> {
   const source = getPiralPath(root, name);
   const tgz = `${dirName}.tar`;
   log('generalDebug_0003', `Checking if "${tgz}" exists in "${source}" ...`);
@@ -780,13 +779,13 @@ export async function findPiletRoot(proposedRoot: string) {
   return dirname(packageJsonPath);
 }
 
-export async function retrievePiletData(target: string, app?: string, interactive?: boolean) {
+export async function retrievePiletData(target: string, app?: string, agent?: Agent, interactive?: boolean) {
   const piletJsonPath = await findFile(target, piletJson);
   const proposedRoot = piletJsonPath ? dirname(piletJsonPath) : target;
   const root = await findPiletRoot(proposedRoot);
   const piletPackage = await readJson(root, packageJson);
   const piletDefinition: PiletDefinition = piletJsonPath && (await readJson(proposedRoot, piletJson));
-  const appPackages = await findPiralInstances(app && [app], piletPackage, piletDefinition, root, interactive);
+  const appPackages = await findPiralInstances(app && [app], piletPackage, piletDefinition, root, agent, interactive);
   const apps: Array<AppDefinition> = [];
 
   for (const appPackage of appPackages) {

package/src/common/release.ts

@@ -1,3 +1,4 @@
+import { Agent } from 'https';
 import { basename, dirname, relative } from 'path';
 import { readBinary } from './io';
 import { publishNpmPackage } from './npm';
@@ -39,7 +40,7 @@ export async function publishWebsiteEmulator(
   files: Array<string>,
   interactive: boolean,
   headers?: Record<string, string>,
-  ca?: Buffer,
+  agent?: Agent,
 ) {
   const data: FormDataObj = {
     version,
@@ -53,5 +54,5 @@ export async function publishWebsiteEmulator(
     data[relPath] = [content, fileName];
   }
 
-  return await postForm(url, mode, apiKey, data, headers, ca, interactive);
+  return await postForm(url, mode, apiKey, data, headers, agent, interactive);
 }

package/src/common/shell.ts

@@ -1,3 +1,4 @@
+import { Agent } from 'https';
 import { progress } from './log';
 import { packageJson, piletJson } from './constants';
 import { readJson, updateExistingJson, writeJson } from './io';
@@ -55,12 +56,13 @@ export async function installPiralInstance(
   baseDir: string,
   rootDir: string,
   npmClient: NpmClientType,
+  agent: Agent,
   selected?: boolean,
 ): Promise<string> {
   const [sourceName, sourceVersion, hadVersion, type] = await dissectPackageName(baseDir, usedSource);
 
   if (type === 'remote') {
-    const emulator = await scaffoldFromEmulatorWebsite(rootDir, sourceName);
+    const emulator = await scaffoldFromEmulatorWebsite(rootDir, sourceName, agent);
     const packageName = emulator.name;
     await updatePiletJson(rootDir, packageName, {
       selected,

package/src/common/website.ts

@@ -1,7 +1,7 @@
 import { Agent } from 'https';
 import { posix, relative, resolve } from 'path';
 import { createPiralStubIndexIfNotExists } from './template';
-import { getAuthorizationHeaders, getAxiosOptions, getCertificate, handleAxiosError } from './http';
+import { getAuthorizationHeaders, getAxiosOptions, handleAxiosError } from './http';
 import { packageJson } from './constants';
 import { updateConfig } from './config';
 import { ForceOverwrite } from './enums';
@@ -11,7 +11,7 @@ import { progress, log } from './log';
 import { axios, isInteractive } from '../external';
 import { EmulatorWebsiteManifestFiles, EmulatorWebsiteManifest } from '../types';
 
-async function requestManifest(url: string, interactive: boolean, httpsAgent?: Agent) {
+async function requestManifest(url: string, httpsAgent: Agent, interactive: boolean) {
   const opts = getAxiosOptions(url);
 
   try {
@@ -26,7 +26,7 @@ async function requestManifest(url: string, interactive: boolean, httpsAgent?: A
           value: headers.authorization,
         },
       });
-      return await requestManifest(url, false, httpsAgent);
+      return await requestManifest(url, httpsAgent, false);
     });
   }
 }
@@ -105,13 +105,11 @@ async function createEmulatorFiles(
   await downloadEmulatorFiles(manifestUrl, targetDir, appDir, emulatorJson.files, httpsAgent);
 }
 
-export async function updateFromEmulatorWebsite(targetDir: string, manifestUrl: string, interactive: boolean) {
+export async function updateFromEmulatorWebsite(targetDir: string, manifestUrl: string, httpsAgent: Agent, interactive: boolean) {
   progress(`Updating emulator from %s ...`, manifestUrl);
-  const ca = await getCertificate();
-  const httpsAgent = ca ? new Agent({ ca }) : undefined;
 
   try {
-    const response = await requestManifest(manifestUrl, interactive, httpsAgent);
+    const response = await requestManifest(manifestUrl, httpsAgent, interactive);
     const nextEmulator: EmulatorWebsiteManifest = response.data;
     const currentEmulator = await readJson(targetDir, packageJson);
 
@@ -130,12 +128,10 @@ export async function updateFromEmulatorWebsite(targetDir: string, manifestUrl:
   }
 }
 
-export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl: string) {
+export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl: string, httpsAgent: Agent) {
   progress(`Downloading emulator from %s ...`, manifestUrl);
-  const ca = await getCertificate();
-  const httpsAgent = ca ? new Agent({ ca }) : undefined;
   const interactive = isInteractive();
-  const response = await requestManifest(manifestUrl, interactive, httpsAgent);
+  const response = await requestManifest(manifestUrl, httpsAgent, interactive);
   const emulatorJson: EmulatorWebsiteManifest = response.data;
   const targetDir = resolve(rootDir, 'node_modules', emulatorJson.name);
   const appDir = resolve(targetDir, 'app');