@forge/bundler 4.4.0 → 4.5.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @forge/bundler
 
+## 4.5.0-next.1
+
+### Patch Changes
+
+- Updated dependencies [20c8fc14]
+- Updated dependencies [272a7845]
+- Updated dependencies [986ad5d5]
+  - @forge/runtime@4.2.0-next.1
+  - @forge/cli-shared@3.6.1-next.0
+  - @forge/lint@3.2.15-next.0
+
+## 4.5.0-next.0
+
+### Minor Changes
+
+- a90c1412: Include Forge log header in log lines, for xen-logs-ingestor to have complete data when it processes log line events
+
+### Patch Changes
+
+- Updated dependencies [18d686e4]
+- Updated dependencies [a90c1412]
+  - @forge/runtime@4.2.0-next.0
+
 ## 4.4.0
 
 ### Minor Changes

package/out/stubs/console.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-import { ConsoleMethod } from '@forge/runtime';
+import { ConsoleMethod, LogHeader } from '@forge/runtime';
 export declare const starSerializer: (arg: any) => any;
-export declare const forgeConsole: Pick<Console, ConsoleMethod>;
+export declare function forgeConsole(consoleMethod: ConsoleMethod, header: LogHeader): (...rawData: any[]) => void;
 //# sourceMappingURL=console.d.ts.map

package/out/stubs/console.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../src/stubs/console.ts"],"names":[],"mappings":";AAEA,OAAO,EAAsB,aAAa,EAA+B,MAAM,gBAAgB,CAAC;AAyChG,eAAO,MAAM,cAAc,QAAS,GAAG,KAAG,GAsBzC,CAAC;AAgDF,eAAO,MAAM,YAAY,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,CAMrD,CAAC"}
+{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../src/stubs/console.ts"],"names":[],"mappings":"AAMA,OAAO,EAEL,aAAa,EAIb,SAAS,EAEV,MAAM,gBAAgB,CAAC;AA2CxB,eAAO,MAAM,cAAc,QAAS,GAAG,KAAG,GA0BzC,CAAC;AAkDF,wBAAgB,YAAY,CAAC,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,+BAW3E"}

package/out/stubs/console.js

@@ -59,9 +59,9 @@ exports.starSerializer = starSerializer;
 function formatLogMessage(requestId, logEventData) {
     const transformedMessage = transformSandBoxLogMessage(logEventData.logArguments);
     return {
-        msg: transformedMessage.msg,
-        id: requestId,
         type: 'log',
+        id: requestId,
+        msg: transformedMessage.msg,
         P: 3,
         ts: Date.now(),
         lvl: logEventData.logLevel,
@@ -73,7 +73,7 @@ const logger = (0, bunyan_1.createLogger)({
     level: bunyan_1.levelFromName.info,
     serializers: { '*': exports.starSerializer }
 });
-function customConsole(logMethod) {
+function customConsole(logMethod, header) {
     return (...rawData) => {
         var _a;
         const runtime = (0, api_1.getRuntime)();
@@ -88,16 +88,21 @@ function customConsole(logMethod) {
                 process.stdout.write(JSON.stringify((0, exports.starSerializer)(logEventData)) + '\n');
             }
             else {
-                const data = formatLogMessage(awsRequestId, logEventData);
-                logger.info(data, data.msg);
+                const logLine = formatLogMessage(awsRequestId, logEventData);
+                const headedLogLine = Object.assign(Object.assign({}, header), logLine);
+                logger.info(headedLogLine, logLine.msg);
             }
         }
     };
 }
-exports.forgeConsole = {
-    log: customConsole('info'),
-    info: customConsole('info'),
-    warn: customConsole('warn'),
-    debug: customConsole('debug'),
-    error: customConsole('error')
-};
+function forgeConsole(consoleMethod, header) {
+    switch (consoleMethod) {
+        case 'debug':
+        case 'warn':
+        case 'error':
+            return customConsole(consoleMethod, header);
+        default:
+            return customConsole('info', header);
+    }
+}
+exports.forgeConsole = forgeConsole;

package/out/stubs/log-events.d.ts

@@ -0,0 +1,30 @@
+export declare const AWS_EXECUTION_ENV_PREFIX = "AWS_Lambda_";
+export declare const RUNTIME_NAME_FALLBACK = "node";
+export declare function getRuntimeName(): string;
+declare enum EventType {
+    HEADER = "header",
+    FOOTER = "footer",
+    LOG = "log"
+}
+export declare function emitHeaderEvent(lambdaEvent: any): {
+    type: EventType;
+    id: string;
+    time: string;
+};
+export declare function emitSuccessfulFooterEvent(): {
+    type: EventType;
+    id: string;
+    time: string;
+};
+export declare function emitFailedFooterEvent(): {
+    type: EventType;
+    id: string;
+    time: string;
+};
+export declare function emitErrorEvent(caughtObject: any): {
+    type: EventType;
+    id: string;
+    time: string;
+};
+export {};
+//# sourceMappingURL=log-events.d.ts.map

package/out/stubs/log-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-events.d.ts","sourceRoot":"","sources":["../../src/stubs/log-events.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,wBAAwB,gBAAgB,CAAC;AACtD,eAAO,MAAM,qBAAqB,SAAS,CAAC;AAE5C,wBAAgB,cAAc,IAAI,MAAM,CAavC;AA4CD,aAAK,SAAS;IACZ,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,GAAG,QAAQ;CACZ;AA8BD,wBAAgB,eAAe,CAAC,WAAW,EAAE,GAAG;;;;EAE/C;AAED,wBAAgB,yBAAyB;;;;EAExC;AAED,wBAAgB,qBAAqB;;;;EAEpC;AAED,wBAAgB,cAAc,CAAC,YAAY,EAAE,GAAG;;;;EAE/C"}

package/out/stubs/log-events.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitErrorEvent = exports.emitFailedFooterEvent = exports.emitSuccessfulFooterEvent = exports.emitHeaderEvent = exports.getRuntimeName = exports.RUNTIME_NAME_FALLBACK = exports.AWS_EXECUTION_ENV_PREFIX = void 0;
+const api_1 = require("@forge/api");
+const bunyan_1 = require("bunyan");
+const console_1 = require("./console");
+exports.AWS_EXECUTION_ENV_PREFIX = 'AWS_Lambda_';
+exports.RUNTIME_NAME_FALLBACK = 'node';
+function getRuntimeName() {
+    const awsRuntime = process.env.AWS_EXECUTION_ENV;
+    if (!awsRuntime) {
+        return exports.RUNTIME_NAME_FALLBACK;
+    }
+    if (awsRuntime.startsWith(exports.AWS_EXECUTION_ENV_PREFIX)) {
+        return awsRuntime.substring(exports.AWS_EXECUTION_ENV_PREFIX.length);
+    }
+    return awsRuntime;
+}
+exports.getRuntimeName = getRuntimeName;
+function invocationHeaderLogs(lambdaEvent) {
+    const { featureFlags, contextAri, appContext, tracing } = lambdaEvent === null || lambdaEvent === void 0 ? void 0 : lambdaEvent._meta;
+    const { appId, environmentId, appVersion, functionKey, moduleKey, moduleType } = appContext !== null && appContext !== void 0 ? appContext : {};
+    return {
+        appId,
+        environmentId,
+        appVersion,
+        installationContext: contextAri,
+        functionKey,
+        moduleType,
+        moduleKey,
+        b3: `${tracing.traceId}-${tracing.spanId}`,
+        featureFlags: featureFlags || [],
+        runtime: getRuntimeName()
+    };
+}
+function invocationFooterLogs(successfulInvocation) {
+    return {
+        success: successfulInvocation,
+        logMetadata: {
+            bytes: 0,
+            truncated: false,
+            errorCount: 0
+        },
+        outboundCalls: {
+            count: 0,
+            stargateCount: 0,
+            externalCount: 0,
+            rejectedCount: 0,
+            bytesOut: 0,
+            bytesIn: 0,
+            msWaiting: 0
+        },
+        function: {
+            bytesIn: 0,
+            bytesOut: 0,
+            durationMs: 0,
+            mem: 0
+        }
+    };
+}
+var EventType;
+(function (EventType) {
+    EventType["HEADER"] = "header";
+    EventType["FOOTER"] = "footer";
+    EventType["LOG"] = "log";
+})(EventType || (EventType = {}));
+function simpleBunyanLogEvent(eventType, eventLevel, data) {
+    function groupLogData(logData) {
+        if (eventType === 'footer' || eventType === 'header') {
+            return logData;
+        }
+        return {
+            '*': [(0, console_1.starSerializer)(logData)],
+            P: 3,
+            lvl: eventLevel,
+            ts: Date.now()
+        };
+    }
+    const invocationId = (0, api_1.getRuntime)().lambdaContext.awsRequestId;
+    const logEvent = Object.assign({ type: eventType, id: invocationId, time: new Date().toISOString() }, groupLogData(data));
+    process.stdout.write(JSON.stringify(logEvent) + '\n');
+    return logEvent;
+}
+function emitHeaderEvent(lambdaEvent) {
+    return simpleBunyanLogEvent(EventType.HEADER, bunyan_1.levelFromName.info, invocationHeaderLogs(lambdaEvent));
+}
+exports.emitHeaderEvent = emitHeaderEvent;
+function emitSuccessfulFooterEvent() {
+    return simpleBunyanLogEvent(EventType.FOOTER, bunyan_1.levelFromName.info, invocationFooterLogs(true));
+}
+exports.emitSuccessfulFooterEvent = emitSuccessfulFooterEvent;
+function emitFailedFooterEvent() {
+    return simpleBunyanLogEvent(EventType.FOOTER, bunyan_1.levelFromName.info, invocationFooterLogs(false));
+}
+exports.emitFailedFooterEvent = emitFailedFooterEvent;
+function emitErrorEvent(caughtObject) {
+    return simpleBunyanLogEvent(EventType.LOG, bunyan_1.levelFromName.error, caughtObject);
+}
+exports.emitErrorEvent = emitErrorEvent;

package/out/stubs/wrapper.js

@@ -1,88 +1,10 @@
 "use strict";
 var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-const bunyan_1 = require("bunyan");
 const api_1 = require("@forge/api");
 const runtime_1 = require("@forge/runtime");
 const console_1 = require("./console");
-for (const method of runtime_1.CONSOLE_METHODS) {
-    global.console[method] = console_1.forgeConsole[method];
-}
-function invocationHeaderLogs(lambdaEvent) {
-    const { featureFlags, contextAri, appContext, tracing } = lambdaEvent === null || lambdaEvent === void 0 ? void 0 : lambdaEvent._meta;
-    const { appId, environmentId, appVersion, functionKey, moduleKey, moduleType } = appContext !== null && appContext !== void 0 ? appContext : {};
-    return {
-        appId,
-        environmentId,
-        appVersion,
-        installationContext: contextAri,
-        functionKey,
-        moduleType,
-        moduleKey,
-        b3: `${tracing.traceId}-${tracing.spanId}`,
-        featureFlags: featureFlags || [],
-        runtime: 'banana'
-    };
-}
-function invocationFooterLogs(successfulInvocation) {
-    return {
-        success: successfulInvocation,
-        logMetadata: {
-            bytes: 0,
-            truncated: false,
-            errorCount: 0
-        },
-        outboundCalls: {
-            count: 0,
-            stargateCount: 0,
-            externalCount: 0,
-            rejectedCount: 0,
-            bytesOut: 0,
-            bytesIn: 0,
-            msWaiting: 0
-        },
-        function: {
-            bytesIn: 0,
-            bytesOut: 0,
-            durationMs: 0,
-            mem: 0
-        }
-    };
-}
-var EventType;
-(function (EventType) {
-    EventType["HEADER"] = "header";
-    EventType["FOOTER"] = "footer";
-    EventType["LOG"] = "log";
-})(EventType || (EventType = {}));
-function simpleBunyanLogEvent(eventType, eventLevel, data) {
-    function groupLogData(logData) {
-        if (eventType === 'footer' || eventType === 'header') {
-            return logData;
-        }
-        return {
-            '*': [(0, console_1.starSerializer)(logData)],
-            P: 3,
-            lvl: eventLevel,
-            ts: Date.now()
-        };
-    }
-    const invocationId = (0, api_1.getRuntime)().lambdaContext.awsRequestId;
-    const logEvent = Object.assign({ name: 'node-runtime', id: invocationId, hostname: 'some-runtime-hostname', pid: process.pid, level: 30, msg: '', time: new Date().toISOString(), v: 0, type: eventType }, groupLogData(data));
-    process.stdout.write(JSON.stringify(logEvent) + '\n');
-}
-function emitHeaderEvent(lambdaEvent) {
-    simpleBunyanLogEvent(EventType.HEADER, bunyan_1.levelFromName.info, invocationHeaderLogs(lambdaEvent));
-}
-function emitSuccessfulFooterEvent() {
-    simpleBunyanLogEvent(EventType.FOOTER, bunyan_1.levelFromName.info, invocationFooterLogs(true));
-}
-function emitFailedFooterEvent() {
-    simpleBunyanLogEvent(EventType.FOOTER, bunyan_1.levelFromName.info, invocationFooterLogs(false));
-}
-function emitErrorEvent(caughtObject) {
-    simpleBunyanLogEvent(EventType.LOG, bunyan_1.levelFromName.error, caughtObject);
-}
+const log_events_1 = require("./log-events");
 const wrappedFilename = __filename.replace(/\/[^/]+.js$/, (name) => '/bundled' + name);
 const realRequire = eval('require');
 if (!realRequire) {
@@ -108,10 +30,13 @@ const adapter = (name) => {
             process.env[key] = value;
         }
         try {
-            emitHeaderEvent(lambdaEvent);
+            const header = (0, log_events_1.emitHeaderEvent)(lambdaEvent);
+            for (const method of runtime_1.CONSOLE_METHODS) {
+                global.console[method] = (0, console_1.forgeConsole)(method, header);
+            }
             const bundled = realRequire(wrappedFilename);
             const result = await bundled[name](event, context);
-            emitSuccessfulFooterEvent();
+            (0, log_events_1.emitSuccessfulFooterEvent)();
             return {
                 success: true,
                 body: result,
@@ -119,8 +44,8 @@ const adapter = (name) => {
             };
         }
         catch (err) {
-            emitErrorEvent(err);
-            emitFailedFooterEvent();
+            (0, log_events_1.emitErrorEvent)(err);
+            (0, log_events_1.emitFailedFooterEvent)();
             const errorName = (0, api_1.isForgePlatformError)(err) ? err.name : api_1.FUNCTION_ERR;
             return {
                 success: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bundler",
-  "version": "4.4.0",
+  "version": "4.5.0-next.1",
   "description": "Default bundler for Forge apps",
   "license": "UNLICENSED",
   "author": "Atlassian",
@@ -20,9 +20,9 @@
     "@babel/preset-typescript": "^7.16.7",
     "@forge/api": "2.11.0",
     "@forge/babel-plugin-transform-ui": "1.1.0",
-    "@forge/cli-shared": "3.6.0",
-    "@forge/lint": "3.2.14",
-    "@forge/runtime": "4.1.0",
+    "@forge/cli-shared": "3.6.1-next.0",
+    "@forge/lint": "3.2.15-next.0",
+    "@forge/runtime": "4.2.0-next.1",
     "@forge/util": "1.2.0",
     "assert": "^1.1.1",
     "babel-loader": "^8.2.3",