Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Upgraded `tar` to `^7.5.20`. [#1474](https://github.com/sourcebot-dev/sourcebot/pull/1474)
- [EE] Preserved cached repository permissions when OAuth token refresh fails because of a transient code host outage. [#1481](https://github.com/sourcebot-dev/sourcebot/pull/1481)
- [EE] Classified code host permission sync failures by provider context before clearing cached repository permissions. [#1482](https://github.com/sourcebot-dev/sourcebot/pull/1482)
- [EE] Added action-required warnings and guided recovery when permission syncing clears cached repository access. [#1484](https://github.com/sourcebot-dev/sourcebot/pull/1484)

### Changed
- Reduced Sentry span sampling to 10% outside development. [#1475](https://github.com/sourcebot-dev/sourcebot/pull/1475)
Expand Down
132 changes: 130 additions & 2 deletions packages/backend/src/ee/accountPermissionSyncer.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import { describe, expect, test } from 'vitest';
import { classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => ({
hasEntitlement: vi.fn(),
}));

vi.mock('../entitlements.js', () => ({
hasEntitlement: mocks.hasEntitlement,
}));

import { AccountPermissionSyncer, classifyPermissionSyncFailure } from './accountPermissionSyncer.js';
import {
PermissionSyncUpstreamError,
type PermissionSyncUpstreamErrorKind,
Expand All@@ -22,6 +31,49 @@ const upstreamError = (
operation: 'list_accessible_repositories',
});

const createSyncerHarness = (syncError?: Error, permissionCount = 95) => {
const account = {
id: 'account_1',
providerId: 'bitbucket-server',
user: { email: 'user@example.com' },
};
const db = {
accountPermissionSyncJob: {
update: vi.fn().mockResolvedValue({ account }),
},
accountToRepoPermission: {
deleteMany: vi.fn().mockResolvedValue({ count: permissionCount }),
},
account: {
update: vi.fn().mockResolvedValue(account),
},
$transaction: vi.fn((queries: Array<Promise<unknown>>) => Promise.all(queries)),
};
const syncAccountPermissions = syncError
? vi.fn().mockRejectedValue(syncError)
: vi.fn().mockResolvedValue(undefined);
const syncer = Object.create(AccountPermissionSyncer.prototype) as {
db: typeof db;
syncAccountPermissions: typeof syncAccountPermissions;
runJob(job: { data: { jobId: string } }): Promise<void>;
onJobCompleted(job: { data: { jobId: string } }): Promise<void>;
};
syncer.db = db;
syncer.syncAccountPermissions = syncAccountPermissions;

return {
account,
db,
job: { data: { jobId: 'job_1' } },
syncer,
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.hasEntitlement.mockResolvedValue(true);
});

describe('classifyPermissionSyncFailure', () => {
test('fails closed when the refresh token is rejected', () => {
expect(classifyPermissionSyncFailure(tokenRefreshError('refresh_token_rejected', 400))).toEqual({
Expand DownExpand Up@@ -75,3 +127,79 @@ describe('classifyPermissionSyncFailure', () => {
});
});
});

describe('permission sync issue lifecycle', () => {
test('atomically records a reauthentication issue when the refresh token is rejected', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).toHaveBeenCalledWith({
where: { accountId: 'account_1' },
});
expect(db.account.update).toHaveBeenCalledWith({
where: { id: 'account_1' },
data: {
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
permissionSyncIssueAt: expect.any(Date),
},
});
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an issue when permissions were already cleared by an earlier attempt', async () => {
const error = tokenRefreshError('refresh_token_rejected', 400);
const { db, job, syncer } = createSyncerHarness(error, 0);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'REAUTHENTICATION_REQUIRED',
}),
}));
expect(db.$transaction).toHaveBeenCalledOnce();
});

test('records an insufficient-scope issue for scope failures', async () => {
const error = upstreamError('insufficient_scope');
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.account.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
permissionSyncIssue: 'INSUFFICIENT_SCOPE',
}),
}));
});

test('does not record an issue or clear permissions for a transient refresh failure', async () => {
const error = tokenRefreshError('transient', 500);
const { db, job, syncer } = createSyncerHarness(error);

await expect(syncer.runJob(job)).rejects.toBe(error);

expect(db.accountToRepoPermission.deleteMany).not.toHaveBeenCalled();
expect(db.account.update).not.toHaveBeenCalled();
expect(db.$transaction).not.toHaveBeenCalled();
});

test('clears the action-required issue after a successful permission sync', async () => {
const { db, job, syncer } = createSyncerHarness();

await syncer.onJobCompleted(job);

expect(db.accountPermissionSyncJob.update).toHaveBeenCalledWith(expect.objectContaining({
data: expect.objectContaining({
account: {
update: expect.objectContaining({
permissionSyncIssue: null,
permissionSyncIssueAt: null,
}),
},
}),
}));
});
});
49 changes: 39 additions & 10 deletions packages/backend/src/ee/accountPermissionSyncer.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
import * as Sentry from "@sentry/node";
import { PrismaClient, AccountPermissionSyncJobStatus, Account, PermissionSyncSource} from "@sourcebot/db";
import {
PrismaClient,
AccountPermissionSyncIssue,
AccountPermissionSyncJobStatus,
Account,
PermissionSyncSource,
} from "@sourcebot/db";
import { env, createLogger, getIdentityProviderConfig, PERMISSION_SYNC_SUPPORTED_IDENTITY_PROVIDERS } from "@sourcebot/shared";
import { hasEntitlement } from "../entitlements.js";
import { ensureFreshAccountToken, TokenRefreshError } from "./tokenRefresh.js";
Expand DownExpand Up@@ -46,10 +52,22 @@ export type PermissionCleanupDecision =
action: 'preserve_permissions';
};

const PERMISSION_CLEANUP_REASON_MESSAGES: Record<PermissionCleanupReason, string> = {
oauth_refresh_token_rejected: 'OAuth refresh token rejection',
upstream_credential_rejected: 'upstream credential rejection',
upstream_insufficient_scope: 'insufficient OAuth scope',
const PERMISSION_CLEANUP_DETAILS: Record<PermissionCleanupReason, {
message: string;
issue: AccountPermissionSyncIssue;
}> = {
oauth_refresh_token_rejected: {
message: 'OAuth refresh token rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_credential_rejected: {
message: 'upstream credential rejection',
issue: AccountPermissionSyncIssue.REAUTHENTICATION_REQUIRED,
},
upstream_insufficient_scope: {
message: 'insufficient OAuth scope',
issue: AccountPermissionSyncIssue.INSUFFICIENT_SCOPE,
},
};

export const classifyPermissionSyncFailure = (error: unknown): PermissionCleanupDecision => {
Expand DownExpand Up@@ -238,12 +256,21 @@ export class AccountPermissionSyncer {
const cleanupDecision = classifyPermissionSyncFailure(error);

if (cleanupDecision.action === 'clear_permissions') {
const { count } = await this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
});
const details = PERMISSION_CLEANUP_DETAILS[cleanupDecision.reason];
const [{ count }] = await this.db.$transaction([
this.db.accountToRepoPermission.deleteMany({
where: { accountId: account.id },
}),
this.db.account.update({
where: { id: account.id },
data: {
permissionSyncIssue: details.issue,
permissionSyncIssueAt: new Date(),
},
}),
]);
const message = error instanceof Error ? error.message : String(error);
const reason = PERMISSION_CLEANUP_REASON_MESSAGES[cleanupDecision.reason];
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${reason}: ${message}`);
logger.warn(`Cleared ${count} permission row(s) for account ${account.id} (user ${account.user.email ?? 'unknown'}) — fail-closed cleanup triggered by ${details.message}: ${message}`);
Comment thread
brendan-kellam marked this conversation as resolved.
}
throw error;
}
Expand DownExpand Up@@ -451,6 +478,8 @@ export class AccountPermissionSyncer {
account: {
update: {
permissionSyncedAt: new Date(),
permissionSyncIssue: null,
permissionSyncIssueAt: null,
Comment thread
cursor[bot] marked this conversation as resolved.
},
},
completedAt: new Date(),
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
-- CreateEnum
CREATE TYPE "AccountPermissionSyncIssue" AS ENUM ('REAUTHENTICATION_REQUIRED', 'INSUFFICIENT_SCOPE');

-- AlterTable
ALTER TABLE "Account"
ADD COLUMN "permissionSyncIssue" "AccountPermissionSyncIssue",
ADD COLUMN "permissionSyncIssueAt" TIMESTAMP(3);
Comment thread
brendan-kellam marked this conversation as resolved.
12 changes: 11 additions & 1 deletion packages/db/prisma/schema.prisma
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,6 +562,11 @@ enum PermissionSyncSource {
REPO_DRIVEN
}

enum AccountPermissionSyncIssue {
REAUTHENTICATION_REQUIRED
INSUFFICIENT_SCOPE
}

model AccountToRepoPermission {
createdAt DateTime @default(now())

Expand DownExpand Up@@ -607,7 +612,12 @@ model Account {
permissionSyncJobs AccountPermissionSyncJob[]
permissionSyncedAt DateTime?

/// Set when an OAuth token refresh fails and the account needs to be re-linked by the user.
/// Set when permission syncing fails closed and user action is required.
/// Cleared after a subsequent permission sync completes successfully.
permissionSyncIssue AccountPermissionSyncIssue?
permissionSyncIssueAt DateTime?

/// Last OAuth token refresh failure, retained for diagnostics.
/// Cleared when the user successfully re-authenticates.
tokenRefreshErrorMessage String?

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ const makeContext = (overrides: Partial<BannerContext> = {}): BannerContext => (
offlineLicense: null,
hasPermissionSyncEntitlement: false,
hasPendingFirstSync: false,
permissionSyncIssues: [],
dismissals: {},
today: TODAY,
now: NOW,
Expand All@@ -100,6 +101,22 @@ describe('resolveActiveBanner', () => {
expect(result?.id).toBe('permissionSync');
});

test('shows permission sync banner when an account requires reauthentication', () => {
const result = resolveActiveBanner(makeContext({
hasPermissionSyncEntitlement: true,
permissionSyncIssues: [{
accountId: 'account_1',
providerId: 'bitbucket-server',
providerType: 'bitbucket-server',
reason: 'REAUTHENTICATION_REQUIRED',
occurredAt: NOW.toISOString(),
isSyncing: false,
}],
}));
expect(result?.id).toBe('permissionSync');
expect(result?.dismissible).toBe(false);
});

test('license expired outranks permission sync', () => {
const result = resolveActiveBanner(makeContext({
license: makeLicense({ status: 'canceled' }),
Expand Down
15 changes: 13 additions & 2 deletions packages/web/src/app/(app)/components/banners/bannerResolver.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { InvoicePastDueBanner } from "./invoicePastDueBanner";
import { ServicePingFailedBanner } from "./servicePingFailedBanner";
import { TrialBanner } from "./trialBanner";
import { UpgradeAvailableBanner } from "./upgradeAvailableBanner";
import type { PermissionSyncStatusResponse } from "@/app/api/(server)/ee/permissionSyncStatus/api";

// Mirrors the value in `lighthouse: lambda/serviceError.ts` and the gating
// constant in `packages/shared/src/entitlements.ts`.
Expand All@@ -28,6 +29,7 @@ export interface BannerContext {
offlineLicense: OfflineLicenseMetadata | null;
hasPermissionSyncEntitlement: boolean;
hasPendingFirstSync: boolean;
permissionSyncIssues: PermissionSyncStatusResponse['issues'];
dismissals: Partial<Record<BannerId, string>>;
today: string;
now: Date;
Expand DownExpand Up@@ -155,14 +157,23 @@ function buildCandidates(ctx: BannerContext): BannerDescriptor[] {
});
}

if (ctx.hasPermissionSyncEntitlement && ctx.hasPendingFirstSync) {
if (
ctx.hasPermissionSyncEntitlement &&
(ctx.hasPendingFirstSync || ctx.permissionSyncIssues.length > 0)
) {
banners.push({
id: 'permissionSync',
priority: BannerPriority.PERMISSION_SYNC,
dismissible: false,
audience: 'everyone',
render: (props) => (
<PermissionSyncBanner {...props} initialHasPendingFirstSync={true} />
<PermissionSyncBanner
{...props}
initialStatus={{
hasPendingFirstSync: ctx.hasPendingFirstSync,
issues: ctx.permissionSyncIssues,
}}
/>
),
});
}
Expand Down
Loading
Loading