@mastra/github-signals 0.2.5 → 0.3.0-alpha.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mastra/github-signals
 
+## 0.3.0-alpha.0
+
+### Minor Changes
+
+- Added intent-aware GitHub pull request subscription modes. Review mode follows code revisions, authorized comments, review-thread state, and terminal PR state without CI or mergeability noise, while omitted modes retain working behavior. ([#21542](https://github.com/mastra-ai/mastra/pull/21542))
+
+  ```ts
+  await githubSignals.subscribeThreadToPR({ threadId, resourceId, pr, mode: 'review' });
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`4ff3ee2`](https://github.com/mastra-ai/mastra/commit/4ff3ee2bff7ed07528b4817f8f49639031c72a4d), [`c24754c`](https://github.com/mastra-ai/mastra/commit/c24754c1fb6fe144e5051e536e98c8a18b0214ac), [`45dd6ee`](https://github.com/mastra-ai/mastra/commit/45dd6ee089bd7df0d0c98a10098e483fd388e04a), [`32d3583`](https://github.com/mastra-ai/mastra/commit/32d358332cb8ac2306b83b73cf3536e74dbd435e), [`aca2869`](https://github.com/mastra-ai/mastra/commit/aca2869b2031982f3c4a2f52525c9be7cf123ef8)]:
+  - @mastra/core@1.62.0-alpha.11
+
 ## 0.2.5
 
 ### Patch Changes

package/dist/index.cjs

@@ -47,8 +47,8 @@ const DEFAULT_AUTHORIZED_PERMISSIONS = [
 ];
 const DEFAULT_AUTHORIZED_BOTS = ["coderabbitai[bot]", "devin-ai-integration[bot]"];
 const PERMISSION_CACHE_TTL_MS = 300 * 1e3;
-/** Notification kinds driven by comment/review activity that should be gated by author permission. */
-const AUTHOR_GATED_NOTIFICATION_KINDS = /* @__PURE__ */ new Set(["pull-request-activity", "pull-request-review-activity"]);
+/** Notification kinds that include comment content and should be gated by author permission. */
+const AUTHOR_GATED_NOTIFICATION_KINDS = /* @__PURE__ */ new Set(["pull-request-activity"]);
 const createGithubTool = _mastra_core_tools.createTool;
 function isPlainObject(value) {
 	return typeof value === "object" && value !== null && !Array.isArray(value);
@@ -60,6 +60,12 @@ function readNumber(value) {
 	if (typeof value === "number" && Number.isInteger(value) && value > 0) return value;
 	if (typeof value === "string" && /^\d+$/.test(value)) return Number(value);
 }
+function normalizeGithubSubscriptionMode(value) {
+	return value === "review" ? "review" : "working";
+}
+function getGithubTerminalState(snapshot) {
+	return snapshot?.state === "closed" || snapshot?.state === "merged" ? snapshot.state : void 0;
+}
 function stableJson(value) {
 	if (Array.isArray(value)) return `[${value.map(stableJson).join(",")}]`;
 	if (isPlainObject(value)) return `{${Object.keys(value).sort().map((key) => `${JSON.stringify(key)}:${stableJson(value[key])}`).join(",")}}`;
@@ -120,6 +126,7 @@ function getGithubMetadata(threadMetadata) {
 			owner,
 			repo,
 			number,
+			mode: normalizeGithubSubscriptionMode(rawSubscription.mode),
 			subscribedAt,
 			updatedAt,
 			lastSubscribeSignalId,
@@ -174,8 +181,11 @@ function getPrLabel(subscription, snapshot) {
 	const pr = `${subscription.owner}/${subscription.repo}#${subscription.number}`;
 	return snapshot?.title ? `${pr}: ${snapshot.title}` : pr;
 }
+function getTerminalNotificationSummary(label, terminalState) {
+	return `${label} was ${terminalState}. This thread has been automatically unsubscribed from this PR. Resubscribe if you still need updates.`;
+}
 function getMergedNotificationSummary(label) {
-	return `${label} was merged. This thread has been automatically unsubscribed from this PR. Resubscribe if you still need updates.`;
+	return getTerminalNotificationSummary(label, "merged");
 }
 /**
 * Removes a hidden block (its delimiters *and* its content) starting at every `open` marker.
@@ -273,7 +283,10 @@ const githubActivityNotificationPriority = {
 	medium: 1
 };
 function getGithubActivityNotificationRank(notification) {
-	return notification.kind === "pull-request-activity" ? 0 : 1;
+	if (notification.kind === "pull-request-activity") return 0;
+	if (notification.kind === "pull-request-code-activity") return 1;
+	if (notification.kind === "pull-request-review-activity") return 2;
+	return 3;
 }
 function compareGithubActivityNotifications(a, b) {
 	if (!a && !b) return 0;
@@ -293,6 +306,28 @@ function classifyGithubCommentActivityNotification(input) {
 		summary
 	};
 }
+function classifyGithubTerminalActivityNotification(input) {
+	return {
+		kind: input.terminalState === "merged" ? "pull-request-merged" : "pull-request-closed",
+		priority: "high",
+		summary: getTerminalNotificationSummary(getPrLabel(input.subscription, input.snapshot), input.terminalState)
+	};
+}
+function classifyGithubHeadActivityNotification(input) {
+	return {
+		kind: "pull-request-code-activity",
+		priority: "medium",
+		summary: `New head revision for ${getPrLabel(input.subscription, input.snapshot)}.`
+	};
+}
+function classifyGithubReviewStateActivityNotification(input) {
+	const count = input.snapshot.unresolvedReviewThreads ?? 0;
+	return {
+		kind: "pull-request-review-activity",
+		priority: "medium",
+		summary: count === 0 ? `All review threads are resolved for ${getPrLabel(input.subscription, input.snapshot)}.` : `${getPrLabel(input.subscription, input.snapshot)} has ${count} unresolved review ${count === 1 ? "thread" : "threads"}.`
+	};
+}
 function getCheckUpdatedTime(check) {
 	const value = check.updatedAt ? Date.parse(check.updatedAt) : NaN;
 	return Number.isFinite(value) ? value : 0;
@@ -703,6 +738,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 	static signals = {
 		subscribeToPR(input) {
 			const normalized = typeof input === "number" ? { number: input } : input;
+			const mode = normalizeGithubSubscriptionMode(normalized.mode);
 			return {
 				type: "reactive",
 				tagName: GITHUB_SUBSCRIBE_PR_TAG,
@@ -710,11 +746,13 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 				attributes: {
 					...normalized.owner ? { owner: normalized.owner } : {},
 					...normalized.repo ? { repo: normalized.repo } : {},
-					number: normalized.number
+					number: normalized.number,
+					mode
 				},
 				metadata: { github: {
 					action: "subscribeToPR",
-					...normalized
+					...normalized,
+					mode
 				} }
 			};
 		},
@@ -794,6 +832,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 		return this.#subscribe({
 			id: `github-command-subscribe-${(0, crypto.randomUUID)()}`,
 			...pr,
+			mode: normalizeGithubSubscriptionMode(input.mode),
 			threadId: input.threadId,
 			resourceId: input.resourceId
 		});
@@ -898,10 +937,11 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			abortSignal: args.abortSignal
 		});
 		if (result.alreadyProcessed) return { tools };
+		const terminalMessage = result.terminalState ? `Not subscribed to ${result.owner}/${result.repo}#${result.number} in review mode because it is already ${result.terminalState}.` : void 0;
 		await this.#sendStatus(args, result, {
-			status: result.syncResult?.ok === false ? "sync_error" : "subscribed",
+			status: result.terminalState ? "not_subscribed_terminal" : result.syncResult?.ok === false ? "sync_error" : "subscribed",
 			action: "subscribeToPR",
-			message: result.syncResult?.ok === false ? `Subscribed to ${result.owner}/${result.repo}#${result.number}, but gitcrawl sync failed: ${result.syncResult.error}` : `Subscribed to ${result.owner}/${result.repo}#${result.number}.`
+			message: terminalMessage ?? (result.syncResult?.ok === false ? `Subscribed to ${result.owner}/${result.repo}#${result.number} in ${result.mode} mode, but gitcrawl sync failed: ${result.syncResult.error}` : `Subscribed to ${result.owner}/${result.repo}#${result.number} in ${result.mode} mode.`)
 		});
 		return { tools };
 	}
@@ -941,8 +981,12 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 		await args.sendSignal?.({
 			type: "reactive",
 			tagName: "system-reminder",
-			contents: `Looks like you're working with ${repository.owner}/${repository.repo}#${evidence.number}. Use /github subscribe ${evidence.number} or the github_subscribe_pr tool to follow updates.`,
-			attributes: { type: "github-subscription-hint" },
+			contents: `Choose whether to follow ${repository.owner}/${repository.repo}#${evidence.number}: use /github subscribe ${evidence.number} --mode review for new commits, authorized latest PR comments, review-thread-state changes including all threads resolved, and PR close or merge updates; use --mode working for all actionable PR activity. Do not subscribe for a one-off inspection.`,
+			attributes: {
+				type: "github-subscription-hint",
+				availableModes: "review,working",
+				defaultMode: null
+			},
 			metadata: { github: {
 				action: "subscriptionHint",
 				owner: repository.owner,
@@ -973,11 +1017,12 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			...args.tools,
 			github_subscribe_pr: createGithubTool({
 				id: "github_subscribe_pr",
-				description: "Subscribe this thread to a GitHub pull request. Syncs only the requested PR with gitcrawl and stores the subscription on the thread.",
+				description: "Subscribe this thread to a GitHub pull request. Use review mode for new commits, authorized latest PR comments, review-thread-state changes including all threads resolved, and PR close or merge updates. Use working mode for all actionable PR activity. Omitted mode defaults to working. Do not subscribe for a one-off inspection.",
 				inputSchema: zod.default.object({
 					number: zod.default.number().int().positive(),
 					owner: zod.default.string().optional(),
-					repo: zod.default.string().optional()
+					repo: zod.default.string().optional(),
+					mode: zod.default.enum(["working", "review"]).optional()
 				}),
 				execute: async (input, context) => {
 					const executionThreadContext = getExecutionThreadContext(context);
@@ -986,16 +1031,28 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 						owner: input.owner,
 						repo: input.repo,
 						number: input.number,
+						mode: normalizeGithubSubscriptionMode(input.mode),
 						threadId: executionThreadContext.threadId,
 						resourceId: executionThreadContext.resourceId
 					});
+					if (result.terminalState) return {
+						subscribed: false,
+						mode: result.mode,
+						terminalState: result.terminalState,
+						reason: "terminal",
+						owner: result.owner,
+						repo: result.repo,
+						number: result.number,
+						message: `Not subscribed to ${result.owner}/${result.repo}#${result.number} in review mode because it is already ${result.terminalState}.`
+					};
 					return {
 						subscribed: true,
+						mode: result.mode,
 						owner: result.owner,
 						repo: result.repo,
 						number: result.number,
 						syncStatus: result.syncResult?.ok === false ? "error" : result.syncResult ? "success" : void 0,
-						message: result.syncResult?.ok === false ? `Subscribed to ${result.owner}/${result.repo}#${result.number}, but gitcrawl sync failed: ${result.syncResult.error}` : `Subscribed to ${result.owner}/${result.repo}#${result.number}.`
+						message: result.syncResult?.ok === false ? `Subscribed to ${result.owner}/${result.repo}#${result.number} in ${result.mode} mode, but gitcrawl sync failed: ${result.syncResult.error}` : `Subscribed to ${result.owner}/${result.repo}#${result.number} in ${result.mode} mode.`
 					};
 				}
 			}),
@@ -1135,15 +1192,19 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 				const previousContentHash = subscription.lastObservedContentHash;
 				const previousThreadContentHash = subscription.lastObservedThreadContentHash;
 				const previousHeadSha = subscription.lastObservedHeadSha;
+				const previousReviewStateHash = subscription.lastObservedReviewStateHash;
 				const latestCommentTimestampChanged = !!previousGithubUpdatedAt && !!snapshot?.latestCommentUpdatedAt && Date.parse(snapshot.latestCommentUpdatedAt) > Date.parse(previousGithubUpdatedAt);
 				const existingBotCommentEdited = latestCommentTimestampChanged && !!snapshot && isExistingBotCommentEdit(subscription, snapshot);
 				const latestCommentChanged = latestCommentTimestampChanged && !existingBotCommentEdited;
+				const headChanged = !!previousHeadSha && !!snapshot?.headSha && previousHeadSha !== snapshot.headSha;
+				const reviewStateChanged = !!previousReviewStateHash && !!snapshot?.reviewStateHash && previousReviewStateHash !== snapshot.reviewStateHash;
 				if (snapshot) applySnapshotCursor(nextSubscription, snapshot);
 				const isFirstObservation = syncResult.ok && snapshot && !previousGithubUpdatedAt && !previousContentHash;
 				const legacyAggregateChanged = previousContentHash && snapshot?.contentHash && previousContentHash !== snapshot.contentHash && !previousThreadContentHash && !previousHeadSha;
-				const changed = isFirstObservation || syncResult.ok && snapshot && (legacyAggregateChanged || latestCommentChanged || previousThreadContentHash && snapshot.threadContentHash && previousThreadContentHash !== snapshot.threadContentHash && !existingBotCommentEdited || previousHeadSha && snapshot.headSha && previousHeadSha !== snapshot.headSha || subscription.lastObservedState && snapshot.state && subscription.lastObservedState !== snapshot.state || hasMeaningfulMergeableStateChange(subscription.lastObservedMergeableState, snapshot.mergeableState) || subscription.lastObservedCiState && snapshot.ciState && subscription.lastObservedCiState !== snapshot.ciState || subscription.lastObservedReviewStateHash && snapshot.reviewStateHash && subscription.lastObservedReviewStateHash !== snapshot.reviewStateHash);
-				let shouldKeepSubscription = true;
-				if (changed && snapshot && isCurrentGeneration()) {
+				const changed = isFirstObservation || syncResult.ok && snapshot && (legacyAggregateChanged || latestCommentChanged || previousThreadContentHash && snapshot.threadContentHash && previousThreadContentHash !== snapshot.threadContentHash && !existingBotCommentEdited || headChanged || subscription.lastObservedState && snapshot.state && subscription.lastObservedState !== snapshot.state || hasMeaningfulMergeableStateChange(subscription.lastObservedMergeableState, snapshot.mergeableState) || subscription.lastObservedCiState && snapshot.ciState && subscription.lastObservedCiState !== snapshot.ciState || reviewStateChanged);
+				const terminalState = subscription.mode === "review" ? getGithubTerminalState(snapshot) : void 0;
+				let shouldKeepSubscription = !terminalState;
+				if ((changed || terminalState) && snapshot && !(subscription.mode === "review" && isFirstObservation && !terminalState) && isCurrentGeneration()) {
 					const notifications = await this.#sendActivityNotifications({
 						polling: input,
 						subscription,
@@ -1151,6 +1212,9 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 						previousGithubUpdatedAt,
 						previousContentHash,
 						latestCommentChanged,
+						headChanged,
+						reviewStateChanged,
+						terminalState,
 						isCurrentGeneration
 					});
 					if (!isCurrentGeneration()) return 0;
@@ -1160,7 +1224,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 						nextSubscription.lastNotificationKind = primaryNotification.kind;
 						nextSubscription.lastNotificationPriority = primaryNotification.priority;
 						nextSubscription.lastNotificationSummary = primaryNotification.summary;
-						shouldKeepSubscription = notifications.every((notification) => notification.kind !== "pull-request-merged");
+						if (!terminalState) shouldKeepSubscription = notifications.every((notification) => notification.kind !== "pull-request-merged");
 					}
 				}
 				if (shouldKeepSubscription) subscriptions.push(nextSubscription);
@@ -1210,6 +1274,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 				owner: input.subscription.owner,
 				repo: input.subscription.repo,
 				number: input.subscription.number,
+				mode: input.subscription.mode,
 				...input.snapshot.title ? { title: input.snapshot.title } : {},
 				...input.snapshot.state ? { state: input.snapshot.state } : {},
 				...input.snapshot.htmlUrl ? { url: input.snapshot.htmlUrl } : {},
@@ -1229,6 +1294,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 				owner: input.subscription.owner,
 				repo: input.subscription.repo,
 				number: input.subscription.number,
+				mode: input.subscription.mode,
 				title: input.snapshot.title,
 				state: input.snapshot.state,
 				htmlUrl: input.snapshot.htmlUrl,
@@ -1371,14 +1437,36 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 	async #sendActivityNotifications(input) {
 		const agent = this.#getNotificationAgent(input.polling);
 		if (!agent?.sendNotificationSignal) return [];
-		const notifications = [classifyGithubActivityNotification({
-			subscription: input.subscription,
-			snapshot: input.snapshot
-		})];
-		if (input.latestCommentChanged && notifications[0]?.kind !== "pull-request-activity") notifications.push(classifyGithubCommentActivityNotification({
+		const notifications = [];
+		if (input.subscription.mode === "review") if (input.terminalState) notifications.push(classifyGithubTerminalActivityNotification({
 			subscription: input.subscription,
-			snapshot: input.snapshot
+			snapshot: input.snapshot,
+			terminalState: input.terminalState
 		}));
+		else {
+			if (input.latestCommentChanged) notifications.push(classifyGithubCommentActivityNotification({
+				subscription: input.subscription,
+				snapshot: input.snapshot
+			}));
+			if (input.headChanged) notifications.push(classifyGithubHeadActivityNotification({
+				subscription: input.subscription,
+				snapshot: input.snapshot
+			}));
+			if (input.reviewStateChanged) notifications.push(classifyGithubReviewStateActivityNotification({
+				subscription: input.subscription,
+				snapshot: input.snapshot
+			}));
+		}
+		else {
+			notifications.push(classifyGithubActivityNotification({
+				subscription: input.subscription,
+				snapshot: input.snapshot
+			}));
+			if (input.latestCommentChanged && notifications[0]?.kind !== "pull-request-activity") notifications.push(classifyGithubCommentActivityNotification({
+				subscription: input.subscription,
+				snapshot: input.snapshot
+			}));
+		}
 		const sent = [];
 		const notificationInputs = [];
 		for (const notification of notifications.sort(compareGithubActivityNotifications)) {
@@ -1418,6 +1506,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 		return sent;
 	}
 	async #subscribe(input) {
+		const mode = normalizeGithubSubscriptionMode(input.mode);
 		const { owner, repo } = await this.#resolveRepository(input);
 		const { threadStore, loadedThread } = await this.#loadThread(input);
 		const githubMetadata = getGithubMetadata(loadedThread.metadata);
@@ -1427,6 +1516,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			owner,
 			repo,
 			number: input.number,
+			mode: existing.mode,
 			subscription: existing,
 			alreadyProcessed: true
 		};
@@ -1435,6 +1525,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			owner,
 			repo,
 			number: input.number,
+			mode,
 			subscribedAt: existing?.subscribedAt ?? now,
 			updatedAt: now,
 			lastSubscribeSignalId: input.id,
@@ -1478,6 +1569,35 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			baselineSnapshot = snapshot;
 			if (snapshot) applySnapshotCursor(subscription, snapshot);
 		} else subscription.lastSyncStatus = "skipped";
+		const terminalState = mode === "review" ? getGithubTerminalState(baselineSnapshot) : void 0;
+		if (terminalState) {
+			const subscriptions = githubMetadata.subscriptions.filter((candidate) => !(candidate.owner === owner && candidate.repo === repo && candidate.number === input.number));
+			await threadStore.saveThread({ thread: {
+				...loadedThread,
+				id: input.threadId,
+				resourceId: input.resourceId,
+				createdAt: loadedThread.createdAt ?? /* @__PURE__ */ new Date(),
+				updatedAt: /* @__PURE__ */ new Date(),
+				metadata: setGithubMetadata(loadedThread.metadata, { subscriptions })
+			} });
+			this.#notifySubscriptionsChanged({
+				threadId: input.threadId,
+				resourceId: input.resourceId,
+				subscriptions
+			});
+			if (subscriptions.length === 0) this.stopPollingForThread({
+				threadId: input.threadId,
+				resourceId: input.resourceId
+			});
+			return {
+				owner,
+				repo,
+				number: input.number,
+				mode,
+				terminalState,
+				syncResult
+			};
+		}
 		const subscriptions = [subscription];
 		await threadStore.saveThread({ thread: {
 			...loadedThread,
@@ -1492,7 +1612,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			resourceId: input.resourceId,
 			subscriptions
 		});
-		if (baselineSnapshot) await this.#sendBaselineNotification({
+		if (baselineSnapshot && mode === "working") await this.#sendBaselineNotification({
 			threadId: input.threadId,
 			resourceId: input.resourceId,
 			subscription,
@@ -1506,6 +1626,7 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			owner,
 			repo,
 			number: input.number,
+			mode,
 			subscription,
 			syncResult
 		};
@@ -1558,7 +1679,8 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 			id: readString(signal.id) ?? message.id,
 			owner: readString(attributes.owner) ?? readString(github.owner),
 			repo: readString(attributes.repo) ?? readString(github.repo),
-			number
+			number,
+			...signal.tagName === "github-subscribe-pr" ? { mode: normalizeGithubSubscriptionMode(attributes.mode ?? github.mode) } : {}
 		};
 	}
 	async #sendStatus(args, signal, status) {
@@ -1570,14 +1692,18 @@ var GithubSignals = class extends _mastra_core_signals.SignalProvider {
 				status: status.status,
 				owner: signal.owner,
 				repo: signal.repo,
-				number: signal.number
+				number: signal.number,
+				...signal.mode ? { mode: signal.mode } : {},
+				...signal.terminalState ? { terminalState: signal.terminalState } : {}
 			},
 			metadata: { github: {
 				action: status.action,
 				status: status.status,
 				owner: signal.owner,
 				repo: signal.repo,
-				number: signal.number
+				number: signal.number,
+				...signal.mode ? { mode: signal.mode } : {},
+				...signal.terminalState ? { terminalState: signal.terminalState } : {}
 			} }
 		});
 	}