eoas 3.2.3-beta1 → 3.2.4

package/dist/commands/publish.d.ts

@@ -16,6 +16,7 @@ export default class Publish extends Command {
         dumpSourcemap: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'rollout-percentage': import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         'upload-rate': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        emitMetadata: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     private sanitizeFlags;
     run(): Promise<void>;

package/dist/commands/publish.js

@@ -20,6 +20,7 @@ const prompts_1 = require("../lib/prompts");
 const rateLimiter_1 = require("../lib/rateLimiter");
 const repo_1 = require("../lib/repo");
 const runtimeVersion_1 = require("../lib/runtimeVersion");
+const updateMetadata_1 = require("../lib/updateMetadata");
 const vcs_1 = require("../lib/vcs");
 const workflow_1 = require("../lib/workflow");
 class Publish extends core_1.Command {
@@ -84,6 +85,10 @@ class Publish extends core_1.Command {
             description: 'Maximum number of asset uploads started per second. Accepts decimals (e.g. 1.5). Lower this if your storage provider rate-limits uploads.',
             default: '10',
         }),
+        emitMetadata: core_1.Flags.boolean({
+            description: `Emit "${updateMetadata_1.UPDATE_METADATA_FILE}" in the output directory with the published update of each platform`,
+            default: false,
+        }),
     };
     sanitizeFlags(flags) {
         const uploadRate = Number(flags['upload-rate']);
@@ -104,6 +109,7 @@ class Publish extends core_1.Command {
             dumpSourcemap: flags.dumpSourcemap,
             rolloutPercentage: flags['rollout-percentage'],
             uploadRate,
+            emitMetadata: flags.emitMetadata,
         };
     }
     async run() {
@@ -113,7 +119,7 @@ class Publish extends core_1.Command {
             process.exit(1);
         }
         const { flags } = await this.parse(Publish);
-        const { platform, nonInteractive, branch, customServerUrl, outputDir, packageRunner, providedDeprecatedChannel, disableRepositoryCheck, message, dumpSourcemap, rolloutPercentage, uploadRate, } = this.sanitizeFlags(flags);
+        const { platform, nonInteractive, branch, customServerUrl, outputDir, packageRunner, providedDeprecatedChannel, disableRepositoryCheck, message, dumpSourcemap, rolloutPercentage, uploadRate, emitMetadata, } = this.sanitizeFlags(flags);
         if (!branch) {
             log_1.default.error('Branch name is required');
             process.exit(1);
@@ -264,6 +270,20 @@ class Publish extends core_1.Command {
             uploadFilesSpinner.fail('No files to upload');
             process.exit(1);
         }
+        const platformsToUpload = [];
+        const missingBundlePlatforms = [];
+        for (const runtime of runtimeVersions) {
+            if (files.some(file => file.platform === runtime.platform && file.isLaunchAsset)) {
+                platformsToUpload.push(runtime);
+            }
+            else {
+                missingBundlePlatforms.push(runtime.platform);
+            }
+        }
+        if (!platformsToUpload.length) {
+            uploadFilesSpinner.fail('No platforms with a bundle to upload');
+            process.exit(1);
+        }
         let uploadUrls = [];
         // One group id for the whole run: every platform update of this publish
         // shares it, so control plane servers list them as a single publish.
@@ -272,7 +292,7 @@ class Publish extends core_1.Command {
         // running spinner interleaves with its frames.
         const unchangedPlatforms = [];
         try {
-            const outcomes = await Promise.all(runtimeVersions.map(async ({ runtimeVersion, platform }) => {
+            const outcomes = await Promise.all(platformsToUpload.map(async ({ runtimeVersion, platform }) => {
                 if (!runtimeVersion) {
                     throw new Error('Runtime version is not resolved');
                 }
@@ -307,6 +327,9 @@ class Publish extends core_1.Command {
             });
             if (!uploadUrls.length) {
                 uploadFilesSpinner.warn('⚠️ No changes found in the update, nothing to deploy');
+                for (const skipped of missingBundlePlatforms) {
+                    log_1.default.withInfo(`⚠️ No bundle exported for ${skipped}, skipping.`);
+                }
                 return;
             }
             // Every path and URL the server handed back is checked here, before a
@@ -384,6 +407,9 @@ class Publish extends core_1.Command {
             for (const skipped of unchangedPlatforms) {
                 log_1.default.withInfo(`⚠️ There is no change in the update for ${skipped}, ignored...`);
             }
+            for (const skipped of missingBundlePlatforms) {
+                log_1.default.withInfo(`⚠️ No bundle exported for ${skipped}, skipping.`);
+            }
         }
         catch (e) {
             uploadFilesSpinner.fail('❌ Failed to upload static files');
@@ -391,6 +417,7 @@ class Publish extends core_1.Command {
             process.exit(1);
         }
         const markAsFinishedSpinner = (0, ora_1.ora)('🔗 Marking the updates as finished...').start();
+        const publishedUpdateUUIDs = {};
         const results = await Promise.all(uploadUrls.map(async ({ updateId, platform, runtimeVersion, rolloutPercentage: echoedRolloutPercentage, }) => {
             const markAsUploadedUrl = new URL(`${serverUrl}/${appId}/markUpdateAsUploaded/${branch}`);
             markAsUploadedUrl.searchParams.set('platform', platform);
@@ -405,6 +432,7 @@ class Publish extends core_1.Command {
             });
             // If success and status code = 200
             if (response.ok) {
+                publishedUpdateUUIDs[platform] = await (0, updateMetadata_1.readUpdateUUID)(response);
                 log_1.default.withInfo(`✅ Update ready for ${platform}`);
                 // Announce only when the server echoed the percentage back: an old server
                 // silently ignores the param and ships the update to 100% of devices.
@@ -463,6 +491,24 @@ class Publish extends core_1.Command {
                 // update has nothing to group anyway.
                 log_1.default.withInfo('ℹ️ Platform updates were published without grouping (publish groups require a server in control plane mode).');
             }
+            if (emitMetadata) {
+                const deployed = uploadUrls.filter((_, index) => results[index] === 'deployed');
+                if (deployed.some(({ platform: p }) => !publishedUpdateUUIDs[p])) {
+                    log_1.default.warn(`⚠️ ${updateMetadata_1.UPDATE_METADATA_FILE} was not written: the server did not return the update ids. Upgrade the server to use --emitMetadata.`);
+                }
+                else {
+                    const metadata = deployed.map(u => ({
+                        id: publishedUpdateUUIDs[u.platform],
+                        platform: u.platform,
+                        runtimeVersion: u.runtimeVersion,
+                        branch,
+                        group: groupAcknowledged ? publishGroupId : undefined,
+                        message: resolvedMessage,
+                    }));
+                    await (0, updateMetadata_1.writeUpdateMetadata)(path_1.default.join(projectDir, outputDir), metadata);
+                    log_1.default.withInfo(`📝 ${updateMetadata_1.UPDATE_METADATA_FILE} written to ${outputDir}`);
+                }
+            }
             log_1.default.withInfo('🔥 Your users will receive the latest update automatically!');
         }
     }

package/dist/lib/updateMetadata.d.ts

@@ -0,0 +1,13 @@
+export declare const UPDATE_METADATA_FILE = "xprem-update-metadata.json";
+export interface PublishedUpdateMetadata {
+    id: string;
+    platform: string;
+    runtimeVersion: string;
+    branch: string;
+    group?: string;
+    message?: string;
+}
+export declare function readUpdateUUID(response: {
+    text(): Promise<string>;
+}): Promise<string | undefined>;
+export declare function writeUpdateMetadata(exportDir: string, updates: PublishedUpdateMetadata[]): Promise<void>;

package/dist/lib/updateMetadata.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeUpdateMetadata = exports.readUpdateUUID = exports.UPDATE_METADATA_FILE = void 0;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
+exports.UPDATE_METADATA_FILE = 'xprem-update-metadata.json';
+// readUpdateUUID reads the manifest id from a markUpdateAsUploaded response.
+// Undefined when the server is too old to send one.
+async function readUpdateUUID(response) {
+    try {
+        const { updateUUID } = JSON.parse(await response.text());
+        return typeof updateUUID === 'string' && updateUUID ? updateUUID : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+exports.readUpdateUUID = readUpdateUUID;
+async function writeUpdateMetadata(exportDir, updates) {
+    await fs_extra_1.default.writeJson(path_1.default.join(exportDir, exports.UPDATE_METADATA_FILE), updates, { spaces: 2 });
+}
+exports.writeUpdateMetadata = writeUpdateMetadata;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eoas",
-  "version": "3.2.3-beta1",
+  "version": "3.2.4",
   "main": "index.js",
   "scripts": {
     "build": "tsc --project tsconfig.json",