@driggsby/deploy 0.2.4 → 0.3.0

package/README.md

@@ -25,7 +25,10 @@ npx @driggsby/deploy
 ```
 
 This reads `driggsby.json` in the current directory, deploys the `serve`
-folder, and makes it live. A first deploy creates the app and saves its
+folder, and makes it live. It prints two addresses: the app's page in
+Driggsby first, where it runs with the person's data, then the app's own
+`driggsby.dev` address, which shows no Driggsby data when opened
+directly. A first deploy creates the app and saves its
 assigned address back into `driggsby.json` — keep (commit) that updated
 file, because it is the only record of the app's address; a checkout that
 discards it makes the next deploy create a second app at a new address.

package/dist/base-url.d.ts

@@ -1,3 +1,4 @@
 export declare const PUBLIC_BASE_URL = "https://app.driggsby.com";
 export declare function isLoopbackBaseUrl(baseUrl: string): boolean;
 export declare function resolveBaseUrl(env: NodeJS.ProcessEnv): string;
+export declare function consoleUrlOnOrigin(consoleUrl: string | null, baseUrl: string): string | null;

package/dist/base-url.js

@@ -44,3 +44,26 @@ export function resolveBaseUrl(env) {
     }
     return trimmed;
 }
+// The Driggsby page address the server hands back after a deploy is printed
+// first and unquoted, as this tool's own word on where to go, so it is
+// accepted only on the origin this run is signed in to: an answer naming any
+// other host (a lookalike included) yields null, and the caller prints the
+// app's own address alone. Anything that does not parse as a URL, or that
+// carries userinfo (which reads as a different host), is no address either.
+// What comes back is the parsed href, so control bytes in a path arrive
+// percent-encoded rather than raw.
+export function consoleUrlOnOrigin(consoleUrl, baseUrl) {
+    if (consoleUrl === null) {
+        return null;
+    }
+    try {
+        const parsed = new URL(consoleUrl);
+        if (parsed.username !== "" || parsed.password !== "") {
+            return null;
+        }
+        return parsed.origin === new URL(baseUrl).origin ? parsed.href : null;
+    }
+    catch {
+        return null;
+    }
+}

package/dist/client.d.ts

@@ -20,6 +20,7 @@ export interface FinalizedVersion {
     versionNumber: number;
     live: boolean;
     url: string | null;
+    consoleUrl: string | null;
 }
 export interface BlobsMissing {
     kind: "blobs-missing";

package/dist/client.js

@@ -265,9 +265,16 @@ function parseFinalized(parsed) {
         appSlug: stringField(parsed, "app_slug"),
         versionNumber: integerField(parsed, "version_number"),
         live: parsed.live === true,
-        url: typeof parsed.url === "string" ? parsed.url : null,
+        url: optionalUrlField(parsed, "url"),
+        consoleUrl: optionalUrlField(parsed, "console_url"),
     };
 }
+// A blank address is no address: it would otherwise take the printed slot
+// meant for a real one.
+function optionalUrlField(record, field) {
+    const value = record[field];
+    return typeof value === "string" && value.trim() !== "" ? value : null;
+}
 function stringField(record, field) {
     const value = record[field];
     if (typeof value !== "string") {

package/dist/deploy.d.ts

@@ -11,6 +11,7 @@ export interface DeployOutcome {
     versionNumber: number;
     live: boolean;
     url: string | null;
+    consoleUrl: string | null;
     fileCount: number;
     uploadedBlobCount: number;
     uploadedBytes: number;

package/dist/deploy.js

@@ -85,6 +85,7 @@ export async function deployCollectedFiles(api, slug, collected, options) {
         versionNumber: outcome.versionNumber,
         live: outcome.live,
         url: outcome.url,
+        consoleUrl: outcome.consoleUrl,
         fileCount: collected.files.length,
         uploadedBlobCount: uploadedShas.size,
         uploadedBytes,

package/dist/entrypoint.js

@@ -8,6 +8,7 @@ import { resolveBaseUrl } from "./base-url.js";
 import { deployProjectFiles } from "./deploy.js";
 import { DeployApiError, DeployError } from "./errors.js";
 import { collectDeployFiles, formatBytes } from "./manifest.js";
+import { hasLiveAddress, liveAddresses, liveAddressLines } from "./live-addresses.js";
 import { readProjectConfig } from "./project-config.js";
 import { capForTerminal, quotedForTerminal, wrapProse } from "./terminal-text.js";
 // Server-supplied error text is bounded like every other string this bin did
@@ -74,8 +75,11 @@ export async function runDeployEntrypoint(io) {
         // sentence. The bounds never truncate legitimate values: a slug tops
         // out at 63 characters and the app URL at 84.
         io.out(`Deployed ${quotedForTerminal(outcome.appSlug, 80)} (v${outcome.versionNumber}, ${uploadedNote}).\n`);
-        if (outcome.url !== null) {
-            io.out(`Live at:\n\n  ${capForTerminal(outcome.url, 200)}\n`);
+        // The Driggsby page for the app first, where it runs with the person's
+        // data, then the app's own address: the same lines the driggsby CLI prints.
+        const addresses = liveAddresses(outcome.url, outcome.consoleUrl, baseUrl);
+        if (hasLiveAddress(addresses)) {
+            io.out(`Live at:\n${liveAddressLines(addresses)}`);
         }
         return 0;
     }

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export { DeployApiError, DeployError } from "./errors.ts";
-export { PUBLIC_BASE_URL, isLoopbackBaseUrl, resolveBaseUrl } from "./base-url.ts";
+export { PUBLIC_BASE_URL, consoleUrlOnOrigin, isLoopbackBaseUrl, resolveBaseUrl } from "./base-url.ts";
 export { MAX_FILE_BYTES, MAX_FILE_COUNT, MAX_PATH_LENGTH, MAX_TOTAL_BYTES, slugProblem, } from "./limits.ts";
 export { type ProjectConfig, readProjectConfig, writeAssignedSlug } from "./project-config.ts";
 export { type CollectedDeploy, type DeployFile, collectDeployFiles, formatBytes, } from "./manifest.ts";
 export { type BlobsMissing, type CreatedApp, type CreatedVersion, type DeployApi, type FinalizedVersion, type ManifestFile, type VersionList, type VersionSummary, createApp, createVersion, finalizeVersion, listVersions, setLiveVersion, uploadBlob, } from "./client.ts";
 export { type DeployOptions, type DeployOutcome, type ProjectDeployOptions, type ProjectDeployResult, deployCollectedFiles, deployProjectFiles, } from "./deploy.ts";
+export { type LiveAddresses, MAX_LIVE_ADDRESS_CHARS, hasLiveAddress, liveAddresses, liveAddressLines, } from "./live-addresses.ts";
 export { capForTerminal, quotedForTerminal, sanitizeForTerminal, wrapProse, } from "./terminal-text.ts";

package/dist/index.js

@@ -5,12 +5,15 @@ export { DeployApiError, DeployError } from "./errors.js";
 // The base-URL policy: which origin the token travels to, and what
 // DRIGGSBY_BASE_URL may override it with. One implementation for both this
 // package's bin and the driggsby CLI.
-export { PUBLIC_BASE_URL, isLoopbackBaseUrl, resolveBaseUrl } from "./base-url.js";
+export { PUBLIC_BASE_URL, consoleUrlOnOrigin, isLoopbackBaseUrl, resolveBaseUrl } from "./base-url.js";
 export { MAX_FILE_BYTES, MAX_FILE_COUNT, MAX_PATH_LENGTH, MAX_TOTAL_BYTES, slugProblem, } from "./limits.js";
 export { readProjectConfig, writeAssignedSlug } from "./project-config.js";
 export { collectDeployFiles, formatBytes, } from "./manifest.js";
 export { createApp, createVersion, finalizeVersion, listVersions, setLiveVersion, uploadBlob, } from "./client.js";
 export { deployCollectedFiles, deployProjectFiles, } from "./deploy.js";
+// The addresses a deploy or rollback prints, shared by this package's bin
+// and the driggsby CLI so both say the same thing.
+export { MAX_LIVE_ADDRESS_CHARS, hasLiveAddress, liveAddresses, liveAddressLines, } from "./live-addresses.js";
 // Terminal-safety helpers for anything that echoes untrusted text (file
 // names, server strings) into CLI output. See terminal-text.ts for what the
 // sanitizer strips and the deliberate boundary of that defense.

package/dist/live-addresses.d.ts

@@ -0,0 +1,8 @@
+export declare const MAX_LIVE_ADDRESS_CHARS = 200;
+export interface LiveAddresses {
+    url: string | null;
+    consoleUrl: string | null;
+}
+export declare function liveAddresses(url: string | null, consoleUrl: string | null, baseUrl: string): LiveAddresses;
+export declare function hasLiveAddress(addresses: LiveAddresses): boolean;
+export declare function liveAddressLines(addresses: LiveAddresses): string;

package/dist/live-addresses.js

@@ -0,0 +1,45 @@
+// The addresses printed under a "Live ... at:" line, by the driggsby CLI
+// and by this package's own bin alike. The Driggsby page for the app comes
+// first: that is where the person sees it running with their own data. The
+// app's own origin follows, named for what it is, because the app gets no
+// Driggsby data when opened there. Both are server-supplied strings,
+// sanitized and length-bounded before printing. A server that predates
+// the Driggsby page hands back only the app's own address, which then
+// prints alone, as it always did.
+import { consoleUrlOnOrigin } from "./base-url.js";
+import { capForTerminal, wrapProse } from "./terminal-text.js";
+// Longer than any address Driggsby issues (a slug tops out at 63
+// characters), short enough that a hostile answer cannot flood the terminal.
+export const MAX_LIVE_ADDRESS_CHARS = 200;
+// The Driggsby page is accepted only on the origin this run is signed in
+// to (see consoleUrlOnOrigin). Both values are sanitized here, so what is
+// decided on is exactly what prints; a value that sanitizes to nothing is
+// no address.
+export function liveAddresses(url, consoleUrl, baseUrl) {
+    return { url: printable(url), consoleUrl: printable(consoleUrlOnOrigin(consoleUrl, baseUrl)) };
+}
+export function hasLiveAddress(addresses) {
+    return addresses.consoleUrl !== null || addresses.url !== null;
+}
+// Empty when there is nothing to print, so "at:" is promised only when an
+// address follows.
+export function liveAddressLines(addresses) {
+    const primary = addresses.consoleUrl ?? addresses.url;
+    if (primary === null) {
+        return "";
+    }
+    let text = `\n  ${primary}\n`;
+    if (addresses.consoleUrl !== null && addresses.url !== null) {
+        text +=
+            `\n${wrapProse("The app's own address, which shows no Driggsby data when opened directly:")}\n\n` +
+                `  ${addresses.url}\n`;
+    }
+    return text;
+}
+function printable(value) {
+    if (value === null) {
+        return null;
+    }
+    const clean = capForTerminal(value, MAX_LIVE_ADDRESS_CHARS).trim();
+    return clean === "" ? null : clean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driggsby/deploy",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Deploy static Driggsby apps: the deploy protocol client used by the driggsby CLI.",
   "license": "Apache-2.0",
   "repository": {