Skip to content

Declare cache effects on the API and dispatch them in lite #15272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mtsgrd merged 2 commits into from
Aug 12, 2026
Merged

Declare cache effects on the API and dispatch them in lite #15272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40a0d19
Declare cache effects on the API and dispatch them in lite
mtsgrd Aug 10, 2026
b9a6fe7
Recognize a mutation's endpoint by its function
mtsgrd Aug 11, 2026
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
139 changes: 8 additions & 131 deletions apps/lite/electron/src/ipc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import type { WatcherEvent, AskpassPromptEvent } from "@gitbutler/but-sdk";
import type * as sdk from "@gitbutler/but-sdk";
import type { apiParamNames } from "@gitbutler/but-sdk/api-param-names";
import { apiParamNames } from "@gitbutler/but-sdk/api-param-names";
import type { GUISettings } from "./settings.js";

/**
* What the renderer can call: the exposed endpoints, whose signatures are the
* What the renderer can call: every SDK endpoint, whose signatures are the
* SDK's, plus the members electron implements itself.
*/
export type LiteElectronApi = {
[K in ExposedKey]: EndpointFn<K>;
[K in Endpoint]: EndpointFn<K>;
} & {
onAskpassPrompt: (callback: (event: AskpassPromptEvent) => void) => () => void;
askpassSubmitPromptResponse: (params: AskpassSubmitPromptResponseParams) => Promise<void>;
Expand All @@ -28,131 +28,12 @@ export type LiteElectronApi = {
};

/**
* The SDK endpoints the renderer may call. This list is the decision — the
* signatures, payloads and handlers all follow from it — and an endpoint's
* name is its IPC channel, so there is nothing else to keep in step.
* The SDK endpoints the renderer can call: all of them, each under its own
* name as the IPC channel, so a new declaration in Rust reaches `window.lite`
* with nothing to keep in step.
*/
export const exposedEndpoints = [
"absorb",
"absorptionPlan",
"addCommentReaction",
"addReviewLabels",
"addReviewReaction",
"apply",
"applyBranchIntegration",
"assignHunk",
"branchCannedName",
"branchCheckout",
"branchCheckoutNew",
"branchCreate",
"branchDetails",
"branchDiff",
"branchList",
"branchRemove",
"branchRename",
"changesInWorktree",
"checkGithubAuthStatus",
"checkSigningSettings",
"commentArchive",
"commentCreate",
"commentUpdate",
"commentsList",
"commitAmend",
"commitConflicts",
"commitCreate",
"commitDetailsWithLineStats",
"commitDiscard",
"commitDiscardChanges",
"commitInsertBlank",
"commitMove",
"commitMoveChangesBetween",
"commitReword",
"commitSquash",
"commitUncommit",
"commitUncommitChanges",
"createReviewComment",
"currentForgeLogin",
"deleteAllData",
"deleteProject",
"deleteUser",
"deleteReviewComment",
"discardWorktreeChanges",
"forgeCompareBranchUrl",
"forgeInfo",
"forgeProvider",
"forgetBitbucketAccount",
"forgetGithubAccount",
"forgetGitlabAccount",
"getGbConfig",
"getLoginToken",
"getInitialBranchIntegration",
"getRedoTargetSnapshot",
"getRepoInfo",
"gitTestFetch",
"gitTestPush",
"getReview",
"getReviewBaseRepoUrl",
"getReviewMergeStatus",
"getTerminalOptionsForPlatform",
"getUndoTargetSnapshot",
"getUserProfileLocal",
"initGithubDeviceOauth",
"headInfo",
"listAvailableReviewTemplates",
"loginAndPersist",
"listCiChecks",
"listCommentReactions",
"listEditors",
"listKnownBitbucketAccounts",
"listKnownGithubAccounts",
"listKnownGitlabAccounts",
"listPrograms",
"listProjectsStateless",
"listRepoLabels",
"listReviewComments",
"listReviewReactions",
"listReviewSubmissions",
"listReviewTimelineEvents",
"listReviewerCandidates",
"listReviews",
"listReviewsForBranch",
"mergeReview",
"moveBranch",
"openInProgram",
"openInTerminal",
"peelRestoreSnapshot",
"publishReview",
"removeCommentReaction",
"removeReviewLabel",
"removeReviewReaction",
"requestReview",
"resolveCommitConflictHunks",
"restoreSnapshotWithKind",
"reviewTemplate",
"setGbConfig",
"storeBitbucketApiToken",
"storeGithubPat",
"storeGitlabPat",
"setReviewAutoMerge",
"setReviewDraftiness",
"setReviewTemplate",
"setTargetRefAndInitProject",
"tearOffBranch",
"treeChangeDiffs",
"unapplyStack",
"updateProfileAndPersist",
"updateProjectSettings",
"updateReview",
"updateReviewComment",
"updateReviewFooters",
"warmCiChecksCache",
"withdrawReviewRequest",
"workspaceBranchAndAncestorsPush",
"workspaceFetchFromRemotes",
"workspaceFetchStatus",
"workspaceIntegrateUpstream",
"workspaceTargetCommits",
] satisfies Array<Endpoint>;
// `Object.keys` erases key types; the record's keys are exactly these.
export const exposedEndpoints = Object.keys(apiParamNames) as ReadonlyArray<Endpoint>;

/** Members the main process answers itself rather than forwarding to the SDK. */
export const localEndpoints = [
Expand All @@ -172,8 +53,6 @@ export const localEndpoints = [
"writeGUISettings",
] as const;

// Everything below derives the surface above from the list above.

/** An endpoint the SDK exposes to JavaScript. */
export type Endpoint = keyof typeof apiParamNames & keyof typeof sdk;

Expand Down Expand Up @@ -205,8 +84,6 @@ type EndpointFn<K extends Endpoint> = (typeof apiParamNames)[K]["length"] extend
? (arg: Parameters<(typeof sdk)[K]>[0]) => Result<K>
: (params: PayloadFor<K>) => Result<K>;

export type ExposedKey = (typeof exposedEndpoints)[number];

// Shapes electron owns: no SDK declaration behind them, so they are written
// out by hand — the only types in this file that are.

Expand Down
4 changes: 2 additions & 2 deletions apps/lite/electron/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { apiParamNames } from "@gitbutler/but-sdk/api-param-names";
import {
exposedEndpoints,
type PayloadFor,
type ExposedKey,
type Endpoint,
type LiteElectronApi,
type ShowNativeMenuParams,
type WatcherSubscribeParams,
Expand Down Expand Up @@ -308,7 +308,7 @@ type OverrideKey = keyof typeof ipcHandlerOverrides;
type DerivedKey = Exclude<TableKey, OverrideKey>;

/** Narrowing rather than asserting: an exposed endpoint may be either. */
const isOverride = (key: ExposedKey): key is ExposedKey & OverrideKey => key in ipcHandlerOverrides;
const isOverride = (key: Endpoint): key is Endpoint & OverrideKey => key in ipcHandlerOverrides;

/**
* Every other endpoint reads its arguments out of the payload by name, so
Expand Down
Loading
Loading