Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.
TypeScript agentaiai-agentsall-in-onecrmcrm-systememaillinearmcpmessagingnotesnotionofficerustslackslack-alternativestartupstartup-toolstypescriptworkspace
import { err as resultErr, ok as resultOk } from 'neverthrow';
import { beforeEach, describe, expect, it, vi } from 'vitest';
const mocks = vi.hoisted(() => ({
enrichGithubPullRequests: vi.fn(),
getDocumentGithubPullRequests: vi.fn(),
}));
vi.mock('@service-auth/client', () => ({
authServiceClient: {
enrichGithubPullRequests: mocks.enrichGithubPullRequests,
},
}));
vi.mock('@service-storage/client', () => ({
storageServiceClient: {
getDocumentGithubPullRequests: mocks.getDocumentGithubPullRequests,
},
}));
import type { ResultError } from '@core/util/result';
import type { EnrichedGithubPullRequest } from '@service-auth/generated/schemas';
import type { GithubPullRequest } from '@service-storage/generated/schemas';
import { QueryClient, QueryClientProvider } from '@tanstack/solid-query';
import { createRoot } from 'solid-js';
import {
fetchDocumentGithubPullRequests,
useRefreshGithubPullRequest,
} from './github-pull-requests';
import { githubPullRequestRefreshKeys } from './keys';
const rawPullRequest: GithubPullRequest = {
displayName: 'macro/macro#42',
githubKey: 'macro/macro/pull/42',
number: 42,
owner: 'macro',
repo: 'macro',
url: 'https://github.com/macro/macro/pull/42',
};
const rawResponse = { pullRequests: [rawPullRequest] };
const storageMetadataPullRequest: GithubPullRequest = {
...rawPullRequest,
additions: 12,
checks: [
{
conclusion: 'success',
id: 1001,
name: 'build',
status: 'completed',
},
],
comments: [
{
body: 'Stored review comment',
id: 2001,
source: 'review_comment',
},
],
deletions: 3,
foreignEntityId: 'foreign-entity-1',
name: 'Stored GitHub metadata',
status: 'open',
};
function createError(code: string): ResultError<string> {
return { code, message: code };
}
function createShallowAuthPullRequest(
pullRequest: GithubPullRequest
): EnrichedGithubPullRequest {
return {
displayName: pullRequest.displayName,
githubKey: pullRequest.githubKey,
number: pullRequest.number,
owner: pullRequest.owner,
repo: pullRequest.repo,
url: pullRequest.url,
};
}
beforeEach(() => {
mocks.enrichGithubPullRequests.mockReset();
mocks.getDocumentGithubPullRequests.mockReset();
mocks.getDocumentGithubPullRequests.mockResolvedValue(resultOk(rawResponse));
});
describe('fetchDocumentGithubPullRequests', () => {
it('keeps the raw PR fallback for GitHub reauthentication enrichment errors', async () => {
mocks.enrichGithubPullRequests.mockResolvedValue(
resultErr([createError('REAUTHENTICATION_REQUIRED')])
);
const response = await fetchDocumentGithubPullRequests('document-1');
expect(response).toEqual(rawResponse);
expect(mocks.enrichGithubPullRequests).toHaveBeenCalledWith({
pullRequests: [
{
displayName: rawPullRequest.displayName,
githubKey: rawPullRequest.githubKey,
number: rawPullRequest.number,
owner: rawPullRequest.owner,
repo: rawPullRequest.repo,
url: rawPullRequest.url,
},
],
});
});
it('keeps the raw PR fallback for unrelated enrichment errors', async () => {
mocks.enrichGithubPullRequests.mockResolvedValue(
resultErr([createError('SERVER_ERROR')])
);
const response = await fetchDocumentGithubPullRequests('document-1');
expect(response).toEqual(rawResponse);
});
it('returns enriched PRs when enrichment succeeds', async () => {
const enrichedPullRequest: EnrichedGithubPullRequest = {
...rawPullRequest,
additions: 10,
deletions: 2,
name: 'Improve GitHub auth',
status: 'open',
};
mocks.enrichGithubPullRequests.mockResolvedValue(
resultOk({ pullRequests: [enrichedPullRequest] })
);
const response = await fetchDocumentGithubPullRequests('document-1');
expect(response).toEqual({ pullRequests: [enrichedPullRequest] });
});
it('preserves storage metadata when auth enrichment succeeds with a shallow PR', async () => {
const shallowAuthPullRequest = createShallowAuthPullRequest(rawPullRequest);
mocks.getDocumentGithubPullRequests.mockResolvedValue(
resultOk({ pullRequests: [storageMetadataPullRequest] })
);
mocks.enrichGithubPullRequests.mockResolvedValue(
resultOk({ pullRequests: [shallowAuthPullRequest] })
);
const response = await fetchDocumentGithubPullRequests('document-1');
expect(response).toEqual({
pullRequests: [storageMetadataPullRequest],
});
});
it('emits storage-enriched PRs before auth enrichment resolves', async () => {
const shallowAuthPullRequest = createShallowAuthPullRequest(rawPullRequest);
const onInitialResponse = vi.fn();
let resolveEnrichment!: (response: unknown) => void;
const enrichmentPromise = new Promise((resolve) => {
resolveEnrichment = resolve;
});
mocks.getDocumentGithubPullRequests.mockResolvedValue(
resultOk({ pullRequests: [storageMetadataPullRequest] })
);
mocks.enrichGithubPullRequests.mockReturnValue(enrichmentPromise);
const responsePromise = fetchDocumentGithubPullRequests('document-1', {
onInitialResponse,
});
await vi.waitFor(() => {
expect(onInitialResponse).toHaveBeenCalledWith({
pullRequests: [storageMetadataPullRequest],
});
});
resolveEnrichment(resultOk({ pullRequests: [shallowAuthPullRequest] }));
await expect(responsePromise).resolves.toEqual({
pullRequests: [storageMetadataPullRequest],
});
});
it('does not emit shallow storage PRs as an initial enriched response', async () => {
const onInitialResponse = vi.fn();
mocks.enrichGithubPullRequests.mockResolvedValue(
resultOk({ pullRequests: [createShallowAuthPullRequest(rawPullRequest)] })
);
await fetchDocumentGithubPullRequests('document-1', { onInitialResponse });
expect(onInitialResponse).not.toHaveBeenCalled();
});
it('uses auth enrichment metadata when present while preserving the foreign entity id', async () => {
const enrichedPullRequest: EnrichedGithubPullRequest = {
...rawPullRequest,
additions: 20,
checks: [
{
conclusion: 'failure',
id: 1002,
name: 'build',
status: 'completed',
},
],
comments: [
{
body: 'Fresh review comment',
id: 2002,
source: 'review_comment',
},
],
deletions: 5,
name: 'Fresh GitHub metadata',
status: 'closed',
};
mocks.getDocumentGithubPullRequests.mockResolvedValue(
resultOk({ pullRequests: [storageMetadataPullRequest] })
);
mocks.enrichGithubPullRequests.mockResolvedValue(
resultOk({ pullRequests: [enrichedPullRequest] })
);
const response = await fetchDocumentGithubPullRequests('document-1');
expect(response).toEqual({
pullRequests: [
{
...enrichedPullRequest,
foreignEntityId: storageMetadataPullRequest.foreignEntityId,
},
],
});
});
});
describe('useRefreshGithubPullRequest', () => {
const refreshedKeys = [
['pr-foreign-entity', 'foreign-entity-1'],
['summary'],
];
function mountRefresh(client: QueryClient) {
return createRoot((dispose) => {
QueryClientProvider({
client,
get children() {
useRefreshGithubPullRequest(
() => rawPullRequest,
() => refreshedKeys
);
return null;
},
});
return dispose;
});
}
it('invalidates the refreshed keys after a successful refresh', async () => {
mocks.enrichGithubPullRequests.mockResolvedValue(resultOk([]));
const client = new QueryClient();
const invalidate = vi.spyOn(client, 'invalidateQueries');
const dispose = mountRefresh(client);
await vi.waitFor(() => expect(invalidate).toHaveBeenCalledTimes(2));
expect(invalidate).toHaveBeenCalledWith({ queryKey: refreshedKeys[0] });
expect(invalidate).toHaveBeenCalledWith({ queryKey: refreshedKeys[1] });
dispose();
});
it('still invalidates when the refresh finishes after unmount', async () => {
let resolveEnrichment: (value: unknown) => void = () => {};
mocks.enrichGithubPullRequests.mockReturnValue(
new Promise((resolve) => {
resolveEnrichment = resolve;
})
);
const client = new QueryClient();
const invalidate = vi.spyOn(client, 'invalidateQueries');
const dispose = mountRefresh(client);
await vi.waitFor(() =>
expect(mocks.enrichGithubPullRequests).toHaveBeenCalledTimes(1)
);
dispose();
resolveEnrichment(resultOk([]));
await vi.waitFor(() => expect(invalidate).toHaveBeenCalledTimes(2));
expect(invalidate).toHaveBeenCalledWith({ queryKey: refreshedKeys[0] });
expect(invalidate).toHaveBeenCalledWith({ queryKey: refreshedKeys[1] });
});
it('leaves the stored copy alone when the refresh fails', async () => {
mocks.enrichGithubPullRequests.mockResolvedValue(
resultErr([createError('UNAUTHORIZED')])
);
const client = new QueryClient();
const invalidate = vi.spyOn(client, 'invalidateQueries');
const dispose = mountRefresh(client);
const refreshKey = githubPullRequestRefreshKeys.refresh(
rawPullRequest.githubKey
).queryKey;
await vi.waitFor(() => expect(client.getQueryData(refreshKey)).toBe(false));
expect(invalidate).not.toHaveBeenCalled();
dispose();
});
});