@forge/lint 5.16.3-next.7 → 5.17.0-next.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/lint
 
+## 5.17.0-next.8
+
+### Minor Changes
+
+- 594a6b9: Added new FunctionTimeoutLinter that detects a conflict where the same function is referenced by both a trigger and a consumer module, but has a timeoutSeconds exceeding the trigger maximum.
+
+### Patch Changes
+
+- Updated dependencies [747866d]
+  - @forge/manifest@12.5.0-next.6
+  - @forge/cli-shared@8.19.0-next.8
+
 ## 5.16.3-next.7
 
 ### Patch Changes

package/out/lint/lint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../src/lint/lint.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAexG,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,iBAAiB,WAAY,UAAU,eAAe,UAAU,EAAE,4BAAuB,IA+CrG,CAAC;AAEF,eAAO,MAAM,YAAY,gBAAiB,UAAU,EAAE,KAAG,YAQxD,CAAC;AAEF,eAAO,MAAM,eAAe,aAChB,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAOnB,CAAC;AAEF,eAAO,MAAM,IAAI,gBACF,MAAM,EAAE,YACX,QAAQ,eACL,MAAM,UACX,UAAU,kBACF,cAAc,6BAjBpB,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAAC,YAgBV,eAAe,EAAE,KAczB,QAAQ,UAAU,EAAE,CAyCtB,CAAC;AAwBF,eAAO,MAAM,QAAQ,WACX,UAAU,kBACF,cAAc,WACtB,eAAe,KACtB,QAAQ,UAAU,EAAE,CAGtB,CAAC"}
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../src/lint/lint.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAgBxG,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,iBAAiB,WAAY,UAAU,eAAe,UAAU,EAAE,4BAAuB,IA+CrG,CAAC;AAEF,eAAO,MAAM,YAAY,gBAAiB,UAAU,EAAE,KAAG,YAQxD,CAAC;AAEF,eAAO,MAAM,eAAe,aAChB,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAOnB,CAAC;AAEF,eAAO,MAAM,IAAI,gBACF,MAAM,EAAE,YACX,QAAQ,eACL,MAAM,UACX,UAAU,kBACF,cAAc,6BAjBpB,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAAC,YAgBV,eAAe,EAAE,KAezB,QAAQ,UAAU,EAAE,CAyCtB,CAAC;AAwBF,eAAO,MAAM,QAAQ,WACX,UAAU,kBACF,cAAc,WACtB,eAAe,KACtB,QAAQ,UAAU,EAAE,CAGtB,CAAC"}

package/out/lint/lint.js

@@ -20,6 +20,7 @@ const frame_component_linter_1 = require("./linters/frame-component-linter/frame
 const deprecated_egress_permissions_manifest_linter_1 = require("./linters/manifest-linter/deprecated-egress-permissions-manifest-linter");
 const llm_module_linter_1 = require("./linters/llm-module-linter/llm-module-linter");
 const deprecated_api_module_linter_1 = require("./linters/deprecated-api-module-linter/deprecated-api-module-linter");
+const function_timeout_linter_1 = require("./linters/function-timeout-linter/function-timeout-linter");
 const reportLintResults = (logger, lintResults, showSummary = true) => {
     let numErrors = 0, numWarnings = 0;
     let noProblemsFound = true;
@@ -93,7 +94,8 @@ const lint = async (filesToLint, manifest, environment, logger, statsigService,
     new frame_component_linter_1.FrameComponentLinter(environment, manifest, logger),
     new llm_module_linter_1.LlmModuleLinter(environment, manifest, logger),
     new deprecated_api_module_linter_1.DeprecatedApiModuleLinter(environment, manifest, logger),
-    new deprecated_egress_permissions_manifest_linter_1.DeprecatedEgressPermissionsManifestLinter(logger, statsigService)
+    new deprecated_egress_permissions_manifest_linter_1.DeprecatedEgressPermissionsManifestLinter(logger, statsigService),
+    new function_timeout_linter_1.FunctionTimeoutLinter(manifest, logger)
 ]) => {
     const { include, exclude } = await (0, cli_shared_1.listTSConfigIncludeExclude)(new cli_shared_1.FileSystemReader());
     const tsInclude = new Set(include);

package/out/lint/linters/function-timeout-linter/function-timeout-linter.d.ts

@@ -0,0 +1,17 @@
+import { ManifestSchema as Manifest } from '@forge/manifest';
+import { AbstractLinter } from '../../abstract-linter';
+import { LintLogger, LintResult } from '../../linter-interface';
+export declare const LONG_RUNNING_MODULE_TYPES: Set<string>;
+export declare class FunctionTimeoutLinter extends AbstractLinter {
+    private readonly manifest;
+    constructor(manifest: Manifest, logger: LintLogger);
+    bootstrap(): Promise<void>;
+    batchExecuteImpl(): Promise<LintResult[]>;
+    private getTimeoutLimit;
+    private makeError;
+    private getSharedViolationMessage;
+    private getExceededViolationMessage;
+    private findViolations;
+    private findTimeoutViolations;
+}
+//# sourceMappingURL=function-timeout-linter.d.ts.map

package/out/lint/linters/function-timeout-linter/function-timeout-linter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-timeout-linter.d.ts","sourceRoot":"","sources":["../../../../src/lint/linters/function-timeout-linter/function-timeout-linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,QAAQ,EAA0B,MAAM,iBAAiB,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAa,UAAU,EAAE,UAAU,EAAkB,MAAM,wBAAwB,CAAC;AAO3F,eAAO,MAAM,yBAAyB,aAA4C,CAAC;AA8CnF,qBAAa,qBAAsB,SAAQ,cAAc;IAErD,OAAO,CAAC,QAAQ,CAAC,QAAQ;gBAAR,QAAQ,EAAE,QAAQ,EACnC,MAAM,EAAE,UAAU;IAKd,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1B,gBAAgB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAW/C,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,yBAAyB;IAOjC,OAAO,CAAC,2BAA2B;IAWnC,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,qBAAqB;CAa9B"}

package/out/lint/linters/function-timeout-linter/function-timeout-linter.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionTimeoutLinter = exports.LONG_RUNNING_MODULE_TYPES = void 0;
+const manifest_1 = require("@forge/manifest");
+const abstract_linter_1 = require("../../abstract-linter");
+const linter_interface_1 = require("../../linter-interface");
+const text_1 = require("../../text");
+exports.LONG_RUNNING_MODULE_TYPES = new Set(['consumer', 'scheduledTrigger']);
+const MAX_TIMEOUT_SECONDS = 25;
+const WEBTRIGGER_MAX_TIMEOUT_SECONDS = 55;
+const LONG_RUNNING_MAX_TIMEOUT_SECONDS = 900;
+const hasDirectFunction = (m) => typeof m.key === 'string' && typeof m.function === 'string';
+const hasResolverFunction = (m) => typeof m.key === 'string' &&
+    typeof m.resolver === 'object' &&
+    m.resolver !== null &&
+    'function' in m.resolver &&
+    typeof m.resolver.function === 'string';
+function collectAllFunctionRefs(modules) {
+    const refs = new Map();
+    const addRef = (functionKey, moduleKey, moduleType) => {
+        const existing = refs.get(functionKey) ?? [];
+        existing.push({ moduleKey, moduleType });
+        refs.set(functionKey, existing);
+    };
+    for (const [moduleType, moduleArray] of Object.entries(modules)) {
+        if (!Array.isArray(moduleArray))
+            continue;
+        for (const m of moduleArray) {
+            if (hasDirectFunction(m))
+                addRef(m.function, m.key, moduleType);
+            if (hasResolverFunction(m))
+                addRef(m.resolver.function, m.key, moduleType);
+        }
+    }
+    return refs;
+}
+class FunctionTimeoutLinter extends abstract_linter_1.AbstractLinter {
+    manifest;
+    constructor(manifest, logger) {
+        super(logger);
+        this.manifest = manifest;
+    }
+    async bootstrap() {
+    }
+    async batchExecuteImpl() {
+        const lintResult = new linter_interface_1.LintResult(manifest_1.MANIFEST_FILE);
+        const modules = this.manifest.modules;
+        if (modules) {
+            lintResult.batchAdd(...this.findTimeoutViolations(modules));
+        }
+        return [lintResult];
+    }
+    getTimeoutLimit(ref) {
+        if (exports.LONG_RUNNING_MODULE_TYPES.has(ref.moduleType))
+            return LONG_RUNNING_MAX_TIMEOUT_SECONDS;
+        if (ref.moduleType === 'webtrigger')
+            return WEBTRIGGER_MAX_TIMEOUT_SECONDS;
+        return MAX_TIMEOUT_SECONDS;
+    }
+    makeError(msg) {
+        return { class: linter_interface_1.LintClass.Error, ...msg, line: 0, column: 0 };
+    }
+    getSharedViolationMessage(functionKey, ref) {
+        return {
+            message: text_1.messages.verifiers.functionTimeout.shared.message(functionKey, ref.moduleKey, ref.moduleType),
+            reference: text_1.messages.verifiers.functionTimeout.shared.reference
+        };
+    }
+    getExceededViolationMessage(functionKey, timeout, ref) {
+        return {
+            message: text_1.messages.verifiers.functionTimeout.exceeded.message(functionKey, timeout, ref.moduleKey, ref.moduleType),
+            reference: text_1.messages.verifiers.functionTimeout.exceeded.reference
+        };
+    }
+    findViolations(functionKey, timeout, refs) {
+        const consumerShared = refs.some((r) => exports.LONG_RUNNING_MODULE_TYPES.has(r.moduleType));
+        return refs
+            .filter((r) => {
+            const limit = this.getTimeoutLimit(r);
+            if (limit === LONG_RUNNING_MAX_TIMEOUT_SECONDS)
+                return false;
+            if (!consumerShared)
+                return true;
+            return timeout > limit;
+        })
+            .map((r) => this.makeError(consumerShared
+            ? this.getSharedViolationMessage(functionKey, r)
+            : this.getExceededViolationMessage(functionKey, timeout, r)));
+    }
+    findTimeoutViolations(modules) {
+        const allFunctionRefs = collectAllFunctionRefs(modules);
+        const functionTimeouts = new Map((modules.function ?? []).map((f) => [f.key, f.timeoutSeconds]));
+        const errors = [];
+        for (const [functionKey, refs] of allFunctionRefs) {
+            const timeout = functionTimeouts.get(functionKey);
+            if (timeout === undefined)
+                continue;
+            errors.push(...this.findViolations(functionKey, timeout, refs));
+        }
+        return errors;
+    }
+}
+exports.FunctionTimeoutLinter = FunctionTimeoutLinter;

package/out/lint/text/messages.d.ts

@@ -69,6 +69,16 @@ export declare const messages: {
             message: () => string;
             reference: string;
         };
+        functionTimeout: {
+            shared: {
+                message: (functionKey: string, conflictingModuleKey: string, conflictingModuleType: string) => string;
+                reference: string;
+            };
+            exceeded: {
+                message: (functionKey: string, timeoutSeconds: number, moduleKey: string, moduleType: string) => string;
+                reference: string;
+            };
+        };
     };
 };
 //# sourceMappingURL=messages.d.ts.map

package/out/lint/text/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/lint/text/messages.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ;;;2BAGA,MAAM;2BAEN,MAAM,KAAG,MAAM;;;;2BAKf,MAAM;2BAER,MAAM;;;;2BAKJ,MAAM;2BAEN,MAAM,KAAG,MAAM;;;;iCAKT,MAAM;;;;iCAKN,MAAM;;;;8BAKT,MAAM,OAAO,MAAM;;;;+BAKlB,MAAM,UAAU,MAAM,QAAQ,MAAM,GAAG,SAAS,SAAS,MAAM;;;;6BAKjE,MAAM;;;;+BAIJ,MAAM,QAAQ,MAAM,SAAS,MAAM;;;;8BAKpC,MAAM;;;;8BAIN,MAAM;;;;8BAIN,MAAM;;;;;;;;;oCASF,MAAM;;;;;6BAOX,MAAM,WAAW,MAAM;;;;;;;;CAU7C,CAAC"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/lint/text/messages.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ;;;2BAGA,MAAM;2BAEN,MAAM,KAAG,MAAM;;;;2BAKf,MAAM;2BAER,MAAM;;;;2BAKJ,MAAM;2BAEN,MAAM,KAAG,MAAM;;;;iCAKT,MAAM;;;;iCAKN,MAAM;;;;8BAKT,MAAM,OAAO,MAAM;;;;+BAKlB,MAAM,UAAU,MAAM,QAAQ,MAAM,GAAG,SAAS,SAAS,MAAM;;;;6BAKjE,MAAM;;;;+BAIJ,MAAM,QAAQ,MAAM,SAAS,MAAM;;;;8BAKpC,MAAM;;;;8BAIN,MAAM;;;;8BAIN,MAAM;;;;;;;;;oCASF,MAAM;;;;;6BAOX,MAAM,WAAW,MAAM;;;;;;;;;uCAWf,MAAM,wBAAwB,MAAM,yBAAyB,MAAM;;;;uCAKnE,MAAM,kBAAkB,MAAM,aAAa,MAAM,cAAc,MAAM;;;;;CAMnG,CAAC"}

package/out/lint/text/messages.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.messages = void 0;
+const function_timeout_linter_1 = require("../linters/function-timeout-linter/function-timeout-linter");
 exports.messages = {
     verifiers: {
         externalFetch: {
@@ -73,6 +74,16 @@ exports.messages = {
         deprecatedApiStorage: {
             message: () => `The \"storage\" export from \"@forge/api\" is deprecated. Use the \"@forge/kvs\" package instead.`,
             reference: 'deprecated-api-storage'
+        },
+        functionTimeout: {
+            shared: {
+                message: (functionKey, conflictingModuleKey, conflictingModuleType) => `Function "${functionKey}" is used by a consumer and ${conflictingModuleType} "${conflictingModuleKey}". Consumer functions must not be shared with other modules. Use a separate function for each module type.`,
+                reference: 'https://developer.atlassian.com/platform/forge/use-a-long-running-function/'
+            },
+            exceeded: {
+                message: (functionKey, timeoutSeconds, moduleKey, moduleType) => `Function "${functionKey}" defines timeoutSeconds (${timeoutSeconds}s) but is used by ${moduleType} "${moduleKey}". Only ${[...function_timeout_linter_1.LONG_RUNNING_MODULE_TYPES].join(' and ')} functions support custom timeouts.`,
+                reference: 'https://developer.atlassian.com/platform/forge/limits-invocation/'
+            }
         }
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/lint",
-  "version": "5.16.3-next.7",
+  "version": "5.17.0-next.8",
   "description": "Linting for forge apps",
   "main": "out/index.js",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -19,10 +19,10 @@
     "eslint-plugin-import": "^2.29.1"
   },
   "dependencies": {
-    "@forge/cli-shared": "8.19.0-next.7",
+    "@forge/cli-shared": "8.19.0-next.8",
     "@forge/csp": "5.6.1",
     "@forge/egress": "2.3.2",
-    "@forge/manifest": "12.5.0-next.5",
+    "@forge/manifest": "12.5.0-next.6",
     "@typescript-eslint/typescript-estree": "^5.62.0",
     "array.prototype.flatmap": "^1.3.3",
     "@atlassian/atlassian-openapi": "^1.0.6",