@hubspot/local-dev-lib 0.7.9-experimental.0 → 0.7.9-experimental.1

package/api/projects.d.ts

@@ -1,5 +1,5 @@
 import { HubSpotPromise, QueryParams } from '../types/Http.js';
-import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse, Release, FetchListReleasesResponse, AutoReleaseResponse, AutoReleaseStatusResponse } from '../types/Project.js';
+import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse } from '../types/Project.js';
 import { Build, FetchProjectBuildsResponse } from '../types/Build.js';
 import { ComponentStructureResponse, ProjectComponentsMetadata } from '../types/ComponentStructure.js';
 import { Deploy, ProjectDeployResponse, ProjectDeployResponseV1, ProjectDeletionResponse } from '../types/Deploy.js';
@@ -39,11 +39,6 @@ export declare function deleteFileFromBuild(accountId: number, projectName: stri
 export declare function cancelStagedBuild(accountId: number, projectName: string): HubSpotPromise<void>;
 export declare function fetchBuildWarnLogs(accountId: number, projectName: string, buildId: number): HubSpotPromise<WarnLogsResponse>;
 export declare function fetchDeployWarnLogs(accountId: number, projectName: string, deployId: number): HubSpotPromise<WarnLogsResponse>;
-export declare function createRelease(accountId: number, projectName: string, buildId: number): HubSpotPromise<Release>;
-export declare function listReleases(accountId: number, projectName: string, params?: QueryParams): HubSpotPromise<FetchListReleasesResponse>;
-export declare function getReleaseInfo(accountId: number, projectName: string, releaseTag: string): HubSpotPromise<Release>;
-export declare function triggerAutoRelease(accountId: number, projectId: number, buildId: number, targetPortalId: number): HubSpotPromise<AutoReleaseResponse>;
-export declare function getAutoReleaseStatus(accountId: number, projectId: number, targetPortalId: number, expectedReleaseTag: string, appId: number): HubSpotPromise<AutoReleaseStatusResponse>;
 /**
  * @deprecated
  */

package/api/projects.js

@@ -215,44 +215,6 @@ export function fetchDeployWarnLogs(accountId, projectName, deployId) {
         url: `${PROJECTS_LOGS_API_PATH}/logs/projects/${encodeURIComponent(projectName)}/deploys/${deployId}/combined/warn`,
     });
 }
-export function createRelease(accountId, projectName, buildId) {
-    return http.post(accountId, {
-        url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/releases`,
-        data: { buildId },
-    });
-}
-export function listReleases(accountId, projectName, params = {}) {
-    return http.get(accountId, {
-        url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/releases`,
-        params,
-    });
-}
-export function getReleaseInfo(accountId, projectName, releaseTag) {
-    return http.get(accountId, {
-        url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/releases/${encodeURIComponent(releaseTag)}`,
-    });
-}
-export function triggerAutoRelease(accountId, projectId, buildId, targetPortalId) {
-    return http.post(accountId, {
-        url: `${PROJECTS_DEPLOY_API_PATH}/auto-release`,
-        data: {
-            projectId,
-            buildId,
-            targetPortalId,
-        },
-    });
-}
-export function getAutoReleaseStatus(accountId, projectId, targetPortalId, expectedReleaseTag, appId) {
-    return http.get(accountId, {
-        url: `${PROJECTS_DEPLOY_API_PATH}/auto-release/status`,
-        params: {
-            projectId,
-            targetPortalId,
-            expectedReleaseTag,
-            appId,
-        },
-    });
-}
 /**
  * @deprecated
  */

package/lib/LogBuffer.d.ts

@@ -0,0 +1,26 @@
+export type LogBufferOptions = {
+    byteLimit?: number;
+};
+export type WriteBufferedLogsOptions = {
+    dir: string;
+    filenamePrefix: string;
+    maxFiles?: number;
+};
+/**
+ * In-memory ring buffer of log entries with a byte cap. Designed to be
+ * composed into a logger so that recent log output can be flushed to a file
+ * after a failure. Each record is timestamped and tagged with the level the
+ * caller provides.
+ */
+export declare class LogBuffer {
+    private entries;
+    private bytes;
+    private byteLimit;
+    constructor(options?: LogBufferOptions);
+    private static entrySize;
+    private trimToByteLimit;
+    record(level: string, args: unknown[]): void;
+    view(): string;
+    flush(): string;
+    writeToFile(options: WriteBufferedLogsOptions): string | null;
+}

package/lib/LogBuffer.js

@@ -0,0 +1,95 @@
+import fs from 'fs';
+import path from 'path';
+// 128 MiB
+const DEFAULT_BYTE_LIMIT = 128 * 1024 * 1024;
+const DEFAULT_MAX_LOG_FILES = 3;
+function sanitizeFilenamePart(name) {
+    return name.replace(/[^a-zA-Z0-9._-]+/g, '-');
+}
+function timestampForFilename() {
+    const d = new Date();
+    const pad = (n, w = 2) => String(n).padStart(w, '0');
+    const date = `${d.getFullYear()}-${pad(d.getMonth() + 1)}-${pad(d.getDate())}`;
+    const time = `${pad(d.getHours())}-${pad(d.getMinutes())}-${pad(d.getSeconds())}`;
+    return `${date}T${time}-${pad(d.getMilliseconds(), 3)}`;
+}
+function rotateLogFiles(dir, maxFiles) {
+    const entries = fs
+        .readdirSync(dir)
+        .map(name => {
+        const full = path.join(dir, name);
+        const stat = fs.statSync(full);
+        return { full, mtimeMs: stat.mtimeMs, isFile: stat.isFile() };
+    })
+        .filter(entry => entry.isFile)
+        .sort((a, b) => a.mtimeMs - b.mtimeMs);
+    while (entries.length >= maxFiles) {
+        const oldest = entries.shift();
+        if (oldest) {
+            fs.unlinkSync(oldest.full);
+        }
+    }
+}
+/**
+ * In-memory ring buffer of log entries with a byte cap. Designed to be
+ * composed into a logger so that recent log output can be flushed to a file
+ * after a failure. Each record is timestamped and tagged with the level the
+ * caller provides.
+ */
+export class LogBuffer {
+    entries = [];
+    bytes = 0;
+    byteLimit;
+    constructor(options = {}) {
+        this.byteLimit = options.byteLimit ?? DEFAULT_BYTE_LIMIT;
+    }
+    // +1 accounts for the '\n' separator that join('\n') will insert between entries.
+    static entrySize(entry) {
+        return Buffer.byteLength(entry, 'utf8') + 1;
+    }
+    // Drop oldest entries until under the cap. Always retains at least the most
+    // recent entry so a single oversized message is still captured.
+    trimToByteLimit() {
+        while (this.bytes > this.byteLimit && this.entries.length > 1) {
+            const removed = this.entries.shift();
+            this.bytes -= LogBuffer.entrySize(removed);
+        }
+    }
+    record(level, args) {
+        const message = args.map(arg => String(arg)).join(' ');
+        const entry = `[${new Date().toISOString()}] [${level}] ${message}`;
+        this.entries.push(entry);
+        this.bytes += LogBuffer.entrySize(entry);
+        this.trimToByteLimit();
+    }
+    view() {
+        return this.entries.join('\n');
+    }
+    flush() {
+        const out = this.entries.join('\n');
+        this.entries.length = 0;
+        this.bytes = 0;
+        return out;
+    }
+    // Flush the buffer to a rotating log file. Always clears the buffer (even
+    // on write failure). Returns the written file path on success, or null if
+    // the buffer was empty or the write failed.
+    writeToFile(options) {
+        const { dir, filenamePrefix, maxFiles = DEFAULT_MAX_LOG_FILES } = options;
+        const contents = this.flush();
+        if (!contents) {
+            return null;
+        }
+        try {
+            fs.mkdirSync(dir, { recursive: true });
+            rotateLogFiles(dir, maxFiles);
+            const filename = `${sanitizeFilenamePart(filenamePrefix)}-${timestampForFilename()}.log`;
+            const filePath = path.join(dir, filename);
+            fs.writeFileSync(filePath, contents, 'utf8');
+            return filePath;
+        }
+        catch (_e) {
+            return null;
+        }
+    }
+}

package/lib/logger.d.ts

@@ -1,4 +1,6 @@
 import { type ChalkInstance } from 'chalk';
+import { WriteBufferedLogsOptions } from './LogBuffer.js';
+export type { WriteBufferedLogsOptions };
 export declare const LOG_LEVEL: {
     NONE: number;
     DEBUG: number;
@@ -50,5 +52,7 @@ export declare const logger: {
     debug(...args: any[]): void;
     group(...args: any[]): void;
     groupEnd(): void;
+    viewLogBuffer(): string;
+    flushLogBuffer(): string;
+    writeBufferedLogsToFile(options: WriteBufferedLogsOptions): string | null;
 };
-export {};

package/lib/logger.js

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import chalk from 'chalk';
 import { isUnicodeSupported } from './isUnicodeSupported.js';
+import { LogBuffer } from './LogBuffer.js';
 export const LOG_LEVEL = {
     NONE: 0,
     DEBUG: 1,
@@ -127,41 +128,58 @@ export function getLogLevel() {
             return LOG_LEVEL.NONE;
     }
 }
+const _logBuffer = new LogBuffer();
 export const logger = {
     error(...args) {
+        _logBuffer.record('ERROR', args);
         if (shouldLog(LOG_LEVEL.ERROR)) {
             currentLogger.error(...args);
         }
     },
     warn(...args) {
+        _logBuffer.record('WARN', args);
         if (shouldLog(LOG_LEVEL.WARN)) {
             currentLogger.warn(...args);
         }
     },
     log(...args) {
+        _logBuffer.record('LOG', args);
         if (shouldLog(LOG_LEVEL.LOG)) {
             currentLogger.log(...args);
         }
     },
     success(...args) {
+        _logBuffer.record('SUCCESS', args);
         if (shouldLog(LOG_LEVEL.LOG)) {
             currentLogger.success(...args);
         }
     },
     info(...args) {
+        _logBuffer.record('INFO', args);
         if (shouldLog(LOG_LEVEL.LOG)) {
             currentLogger.info(...args);
         }
     },
     debug(...args) {
+        _logBuffer.record('DEBUG', args);
         if (shouldLog(LOG_LEVEL.DEBUG)) {
             currentLogger.debug(...args);
         }
     },
     group(...args) {
+        _logBuffer.record('GROUP', args);
         currentLogger.group(...args);
     },
     groupEnd() {
         currentLogger.groupEnd();
     },
+    viewLogBuffer() {
+        return _logBuffer.view();
+    },
+    flushLogBuffer() {
+        return _logBuffer.flush();
+    },
+    writeBufferedLogsToFile(options) {
+        return _logBuffer.writeToFile(options);
+    },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.7.9-experimental.0",
+    "version": "0.7.9-experimental.1",
     "type": "module",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "files": [

package/types/Project.d.ts

@@ -1,8 +1,6 @@
 import type { Build } from './Build.js';
 import { GithubSourceData } from './Github.js';
 import { ProjectLog } from './ProjectLog.js';
-import { ValueOf } from './Utils.js';
-import { SUBBUILD_TYPES } from '../enums/build.js';
 export type Project = {
     createdAt: number;
     deletedAt: number;
@@ -50,31 +48,3 @@ export type FetchPlatformVersionResponse = {
 export type WarnLogsResponse = {
     logs: Array<ProjectLog>;
 };
-export type Release = {
-    releaseTag: string;
-    buildId: number;
-    createdAt: string;
-    components?: Array<{
-        buildType: ValueOf<typeof SUBBUILD_TYPES>;
-        buildName?: string;
-        rootPath?: string;
-        id?: string;
-    }>;
-};
-export type FetchListReleasesResponse = {
-    results: Array<Release>;
-    paging: {
-        next: {
-            after: string;
-        };
-    };
-};
-export type AutoReleaseResponse = {
-    releaseTag: string;
-    status: string;
-    appId: number;
-};
-export type AutoReleaseStatusResponse = {
-    status: 'PENDING' | 'COMPLETE';
-    currentReleaseTag?: string;
-};