@danypops/tickets 0.10.2 → 0.10.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -25
- package/package.json +3 -3
- package/src/agent-tools/error-mapping.ts +122 -0
- package/src/agent-tools/tickets-vehicle.ts +1 -11
- package/src/cli/index.ts +2 -2
- package/src/github/github.ts +11 -3
- package/src/gitlab/gitlab.ts +4 -3
- package/src/issue/errors.ts +29 -0
- package/src/jira/jira.ts +58 -22
package/README.md
CHANGED
|
@@ -18,11 +18,12 @@ GitHub/GitLab/Jira or opens the SQLite ledger directly. See
|
|
|
18
18
|
## Requirements
|
|
19
19
|
|
|
20
20
|
- **[Bun](https://bun.sh) 1.1+.** The daemon uses `bun:sqlite` and
|
|
21
|
-
`Bun.serve`
|
|
22
|
-
extension are plain TypeScript but currently ship as source
|
|
23
|
-
Bun rather than a compiled Node build.
|
|
24
|
-
- `@danypops/
|
|
25
|
-
|
|
21
|
+
`Bun.serve` through `@danypops/vehicle-server`; the CLI, library, and
|
|
22
|
+
pi-tickets extension are plain TypeScript but currently ship as source and
|
|
23
|
+
run through Bun rather than a compiled Node build.
|
|
24
|
+
- The published `@danypops/vehicle-*` packages provide the daemon, authenticated
|
|
25
|
+
RPC/Vehicle contracts, resilient client, Pi projection, and Armada service
|
|
26
|
+
integration. No local Vehicle checkout or `file:` dependency is required.
|
|
26
27
|
|
|
27
28
|
## Install
|
|
28
29
|
|
|
@@ -76,25 +77,25 @@ bun run src/cli/index.ts discover statuses -b jira
|
|
|
76
77
|
bun run src/cli/index.ts discover template -b jira --project PROJ --issue-type Bug
|
|
77
78
|
```
|
|
78
79
|
|
|
79
|
-
### Running the daemon persistently (
|
|
80
|
+
### Running the daemon persistently (Armada)
|
|
80
81
|
|
|
81
|
-
`daemon start`
|
|
82
|
-
|
|
83
|
-
it as a systemd `--user` service instead (Linux only):
|
|
82
|
+
`daemon start` is the on-demand path. For a daemon owned by the native service
|
|
83
|
+
manager and reconciled from desired state, register it with Armada:
|
|
84
84
|
|
|
85
85
|
```bash
|
|
86
|
-
bun run src/cli/index.ts service install
|
|
86
|
+
bun run src/cli/index.ts service install # Armada upsert + reconcile
|
|
87
|
+
bun run src/cli/index.ts service uninstall # Armada remove
|
|
88
|
+
|
|
89
|
+
# Direct lifecycle actions currently target systemd --user (Linux):
|
|
87
90
|
bun run src/cli/index.ts service status
|
|
88
91
|
bun run src/cli/index.ts service stop
|
|
89
92
|
bun run src/cli/index.ts service restart
|
|
90
|
-
bun run src/cli/index.ts service path # where the unit file lives
|
|
91
93
|
```
|
|
92
94
|
|
|
93
|
-
`service install`
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
needed first.
|
|
95
|
+
`service install` records the exact Bun binary, CLI entry path, version, handle
|
|
96
|
+
path, restart policy, and readiness probe in Armada's fleet manifest. Armada
|
|
97
|
+
then projects that declaration through systemd, launchd, or Windows Task
|
|
98
|
+
Scheduler. Re-run `service install` after upgrading or moving the package.
|
|
98
99
|
|
|
99
100
|
Once installed as a package, the same commands are available as `tickets`
|
|
100
101
|
and `tickets-daemon` (see `bin` in `package.json`).
|
|
@@ -273,13 +274,13 @@ member directory instead: `{ "packages": ["/path/to/tickets/packages/pi-tickets"
|
|
|
273
274
|
```bash
|
|
274
275
|
bun install # from the repo root -- links both workspace members
|
|
275
276
|
bun run typecheck # both packages
|
|
276
|
-
bun test
|
|
277
|
+
bun run test # both packages, sequential isolated test processes
|
|
277
278
|
```
|
|
278
279
|
|
|
279
|
-
Tests never hit real GitHub/GitLab/Jira/Atlassian: adapters take
|
|
280
|
-
|
|
281
|
-
`@danypops/
|
|
282
|
-
XDG root with a fake `IssueRepository`.
|
|
280
|
+
Tests never hit real GitHub/GitLab/Jira/Atlassian: adapters take injectable
|
|
281
|
+
transport implementations, and the daemon tests (`test/rpc/`, `test/sqlite/`,
|
|
282
|
+
`test/process/`) run the real `@danypops/vehicle-server` daemon/SQLite/HTTP
|
|
283
|
+
stack against a scratch XDG root with a fake `IssueRepository`.
|
|
283
284
|
|
|
284
285
|
## Architecture
|
|
285
286
|
|
|
@@ -292,13 +293,14 @@ Driver (inbound) Application Driven (outbound)
|
|
|
292
293
|
└───────────────┘ │ + Ledger │───────▶│ SQLite (Ledger) │
|
|
293
294
|
│ + Poller) │ └──────────────────┘
|
|
294
295
|
└─────────────────┘
|
|
295
|
-
built on @danypops/
|
|
296
|
-
(paths, storage,
|
|
296
|
+
built on @danypops/vehicle-server
|
|
297
|
+
(Vehicle registry, paths, storage, HTTP, logging,
|
|
298
|
+
daemon lifecycle, Armada service integration)
|
|
297
299
|
```
|
|
298
300
|
|
|
299
301
|
Hexagonal architecture: `src/domain` has zero I/O, `src/ports` defines the
|
|
300
302
|
outbound contract, `src/adapters` implement it per backend, `src/application`
|
|
301
303
|
orchestrates by parsing `backend:key` refs and routing to the named
|
|
302
304
|
repository, and `src/daemon` is the only place that owns the SQLite ledger,
|
|
303
|
-
wraps it in a Bearer-authenticated HTTP
|
|
304
|
-
poller as a
|
|
305
|
+
wraps it in a Bearer-authenticated HTTP/Vehicle surface, and runs the pooling
|
|
306
|
+
poller as a Vehicle maintenance task.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@danypops/tickets",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.4",
|
|
4
4
|
"description": "Unified CLI, daemon, and TypeScript library for issue tracking across GitHub, GitLab, and Jira.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -24,9 +24,9 @@
|
|
|
24
24
|
"typecheck": "tsc --noEmit"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@danypops/vehicle-core": "^0.12.
|
|
27
|
+
"@danypops/vehicle-core": "^0.12.5",
|
|
28
28
|
"@danypops/vehicle-server": "^0.18.2",
|
|
29
|
-
"@danypops/vehicle-client": "^0.
|
|
29
|
+
"@danypops/vehicle-client": "^0.7.0",
|
|
30
30
|
"@danypops/enigma-client": "^0.6.1",
|
|
31
31
|
"@gitbeaker/rest": "^43.8.0",
|
|
32
32
|
"commander": "^12.1.0",
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { isVehicleError, VehicleError } from "@danypops/vehicle-core";
|
|
2
|
+
import { ApiError, AuthRequiredError, BackendConfigurationError, BackendConnectionError, InvalidUrlError } from "../issue/errors.js";
|
|
3
|
+
import { statusForKnownTicketError } from "../rpc/error-status.js";
|
|
4
|
+
|
|
5
|
+
function apiErrorToVehicle(error: ApiError): VehicleError {
|
|
6
|
+
const details = { backend: error.backend, status: error.status };
|
|
7
|
+
|
|
8
|
+
if (error.status === 401 || error.status === 403) {
|
|
9
|
+
return new VehicleError("backend-authentication-failed", `${error.backend}: authentication or authorization was rejected`, {
|
|
10
|
+
category: "authorization",
|
|
11
|
+
details,
|
|
12
|
+
recovery: { message: "Check the configured credential and its backend permissions, then retry." },
|
|
13
|
+
cause: error,
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
if (error.status === 408) {
|
|
17
|
+
return new VehicleError("backend-timeout", `${error.backend}: backend request timed out`, {
|
|
18
|
+
category: "timeout",
|
|
19
|
+
retryable: true,
|
|
20
|
+
details,
|
|
21
|
+
recovery: { message: "Retry after backend connectivity recovers." },
|
|
22
|
+
cause: error,
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
if (error.status === 409) {
|
|
26
|
+
return new VehicleError("backend-conflict", `${error.backend}: backend rejected the request because its state changed`, {
|
|
27
|
+
category: "conflict",
|
|
28
|
+
details,
|
|
29
|
+
recovery: { message: "Refresh the issue and retry against its current state." },
|
|
30
|
+
cause: error,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
if (error.status === 429) {
|
|
34
|
+
return new VehicleError("backend-rate-limited", `${error.backend}: backend API rate limit exceeded`, {
|
|
35
|
+
category: "capacity",
|
|
36
|
+
retryable: true,
|
|
37
|
+
details,
|
|
38
|
+
recovery: { message: "Retry after the backend rate limit resets; cached ledger reads remain available." },
|
|
39
|
+
cause: error,
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
if (error.status >= 500) {
|
|
43
|
+
return new VehicleError("backend-unavailable", `${error.backend}: backend API is unavailable (${error.status})`, {
|
|
44
|
+
category: "unavailable",
|
|
45
|
+
retryable: true,
|
|
46
|
+
details,
|
|
47
|
+
recovery: { message: "Retry later; for reads, use ledger.search while the live backend is unavailable." },
|
|
48
|
+
cause: error,
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
return new VehicleError("backend-request-rejected", `${error.backend}: backend rejected the request (${error.status})`, {
|
|
52
|
+
category: "validation",
|
|
53
|
+
details,
|
|
54
|
+
recovery: { message: "Check the operation input and backend-specific constraints, then retry." },
|
|
55
|
+
cause: error,
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/** Converts reviewed Tickets failures into actionable, wire-safe Vehicle failures. */
|
|
60
|
+
export function toTicketsVehicleError(error: unknown): VehicleError {
|
|
61
|
+
if (isVehicleError(error)) return error;
|
|
62
|
+
|
|
63
|
+
if (error instanceof BackendConfigurationError) {
|
|
64
|
+
return new VehicleError("backend-not-configured", error.message, {
|
|
65
|
+
category: "validation",
|
|
66
|
+
recovery: { message: error.recovery },
|
|
67
|
+
cause: error,
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
if (error instanceof BackendConnectionError) {
|
|
71
|
+
return new VehicleError(error.kind === "timeout" ? "backend-timeout" : "backend-unavailable", error.message, {
|
|
72
|
+
category: error.kind === "timeout" ? "timeout" : "unavailable",
|
|
73
|
+
retryable: true,
|
|
74
|
+
details: { backend: error.backend },
|
|
75
|
+
recovery: {
|
|
76
|
+
message: "Check the configured URL and network, VPN, or DNS connectivity; cached ledger reads remain available.",
|
|
77
|
+
},
|
|
78
|
+
cause: error,
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
if (error instanceof ApiError) return apiErrorToVehicle(error);
|
|
82
|
+
if (error instanceof InvalidUrlError) {
|
|
83
|
+
return new VehicleError("invalid-backend-url", "Backend URL configuration is invalid", {
|
|
84
|
+
category: "validation",
|
|
85
|
+
recovery: { message: "Use an HTTPS backend URL (HTTP is accepted only for localhost), then restart the daemon." },
|
|
86
|
+
cause: error,
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
if (error instanceof AuthRequiredError) {
|
|
90
|
+
return new VehicleError("backend-authentication-required", error.message, {
|
|
91
|
+
category: "authorization",
|
|
92
|
+
recovery: { message: "Configure the backend credential, restart the daemon if needed, and retry." },
|
|
93
|
+
cause: error,
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
const status = statusForKnownTicketError(error);
|
|
98
|
+
if (status === 404) {
|
|
99
|
+
return new VehicleError("not-found", (error as Error).message, { category: "not_found", cause: error });
|
|
100
|
+
}
|
|
101
|
+
if (status === 400) {
|
|
102
|
+
return new VehicleError("operation-rejected", (error as Error).message, { category: "validation", cause: error });
|
|
103
|
+
}
|
|
104
|
+
if (status === 422) {
|
|
105
|
+
return new VehicleError("operation-rejected", (error as Error).message, { category: "authorization", cause: error });
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
// Unknown exceptions stay opaque: only reviewed domain/config/transport errors above
|
|
109
|
+
// may cross the daemon boundary with their original message.
|
|
110
|
+
return new VehicleError("handler-failed", "Tickets operation failed unexpectedly", {
|
|
111
|
+
category: "internal",
|
|
112
|
+
cause: error,
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
export async function withTicketsErrorParity<T>(run: () => T | Promise<T>): Promise<T> {
|
|
117
|
+
try {
|
|
118
|
+
return await run();
|
|
119
|
+
} catch (error) {
|
|
120
|
+
throw toTicketsVehicleError(error);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
@@ -16,7 +16,6 @@
|
|
|
16
16
|
*/
|
|
17
17
|
import {
|
|
18
18
|
bindVehicleOperation,
|
|
19
|
-
defineErrorMapping,
|
|
20
19
|
defineLooseObjectSchema,
|
|
21
20
|
defineVehicleOperation,
|
|
22
21
|
type LooseObjectProperty,
|
|
@@ -25,21 +24,12 @@ import {
|
|
|
25
24
|
} from "@danypops/vehicle-core";
|
|
26
25
|
import { VehicleRegistry } from "@danypops/vehicle-server";
|
|
27
26
|
import type { BackendCapabilities, TicketService } from "../issue/service.js";
|
|
28
|
-
import { statusForKnownTicketError } from "../rpc/error-status.js";
|
|
29
27
|
import type { TicketOperation } from "../rpc/ops.js";
|
|
30
28
|
import { TICKET_OP_HANDLERS, type TicketsAppDeps } from "../rpc/server.js";
|
|
29
|
+
import { withTicketsErrorParity } from "./error-mapping.js";
|
|
31
30
|
|
|
32
31
|
const OWNER = "tickets";
|
|
33
32
|
|
|
34
|
-
const withTicketsErrorParity = defineErrorMapping(
|
|
35
|
-
[
|
|
36
|
-
{ matches: (error) => statusForKnownTicketError(error) === 404, category: "not_found" },
|
|
37
|
-
{ matches: (error) => statusForKnownTicketError(error) === 400, category: "validation" },
|
|
38
|
-
{ matches: (error) => statusForKnownTicketError(error) === 422, category: "authorization" },
|
|
39
|
-
],
|
|
40
|
-
{ fallbackCategory: "internal", fallbackCode: "handler-failed", fallbackMessage: "Tickets operation failed" },
|
|
41
|
-
);
|
|
42
|
-
|
|
43
33
|
const LIMITS = { defaultTimeoutMs: 10_000, maxTimeoutMs: 30_000, maxRequestBytes: 65_536, maxResponseBytes: 262_144 };
|
|
44
34
|
|
|
45
35
|
const stringProp: LooseObjectProperty = { type: "string" };
|
package/src/cli/index.ts
CHANGED
|
@@ -500,12 +500,12 @@ program
|
|
|
500
500
|
const service = program
|
|
501
501
|
.command("service")
|
|
502
502
|
.description(
|
|
503
|
-
"
|
|
503
|
+
"register the tickets daemon with Armada's cross-platform desired-state fleet (direct start/stop/restart/status actions currently require systemd --user)",
|
|
504
504
|
);
|
|
505
505
|
|
|
506
506
|
service
|
|
507
507
|
.command("install")
|
|
508
|
-
.description("register this install with Armada as the tickets vehicle and reconcile it
|
|
508
|
+
.description("register this install with Armada as the tickets vehicle and reconcile it through the native service manager")
|
|
509
509
|
.action(() => {
|
|
510
510
|
const cli = ticketsServiceCli();
|
|
511
511
|
const result = cli.install();
|
package/src/github/github.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
import { RequestError } from "@octokit/request-error";
|
|
23
23
|
import { Octokit } from "octokit";
|
|
24
|
-
import { ApiError, AuthRequiredError, IssueNotFoundError } from "../issue/errors.js";
|
|
24
|
+
import { ApiError, AuthRequiredError, BackendConfigurationError, BackendConnectionError, IssueNotFoundError } from "../issue/errors.js";
|
|
25
25
|
import type { Comment, CreateInput, Issue, ListFilter, parsePriority, Status, UpdateInput } from "../issue/issue.js";
|
|
26
26
|
|
|
27
27
|
const DEFAULT_TIMEOUT_MS = 30_000;
|
|
@@ -90,7 +90,13 @@ export class GitHubRepository {
|
|
|
90
90
|
}
|
|
91
91
|
|
|
92
92
|
private repoName(): string {
|
|
93
|
-
if (!this.repo)
|
|
93
|
+
if (!this.repo) {
|
|
94
|
+
throw new BackendConfigurationError(
|
|
95
|
+
"github",
|
|
96
|
+
"repository is not configured; set GITHUB_REPO (or the backend's repo setting) and restart the tickets daemon",
|
|
97
|
+
"Set GITHUB_REPO (or the backend's repo setting), then restart the tickets daemon.",
|
|
98
|
+
);
|
|
99
|
+
}
|
|
94
100
|
return this.repo;
|
|
95
101
|
}
|
|
96
102
|
|
|
@@ -209,11 +215,13 @@ export class GitHubRepository {
|
|
|
209
215
|
const res = await fn(controller.signal);
|
|
210
216
|
return res.data;
|
|
211
217
|
} catch (err) {
|
|
218
|
+
if (err instanceof BackendConfigurationError) throw err;
|
|
212
219
|
if (err instanceof RequestError) {
|
|
213
220
|
if (err.status === 404) throw new IssueNotFoundError("github", err.request.url);
|
|
214
221
|
throw new ApiError("github", err.request.method, err.request.url, err.status, redact(err.message));
|
|
215
222
|
}
|
|
216
|
-
throw err;
|
|
223
|
+
if (err instanceof DOMException && err.name === "AbortError") throw new BackendConnectionError("github", "timeout", err);
|
|
224
|
+
throw new BackendConnectionError("github", "unreachable", err);
|
|
217
225
|
} finally {
|
|
218
226
|
clearTimeout(timer);
|
|
219
227
|
}
|
package/src/gitlab/gitlab.ts
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
import { isIP } from "node:net";
|
|
15
15
|
import { GitbeakerRequestError, type RequesterType, type ResourceOptions } from "@gitbeaker/requester-utils";
|
|
16
16
|
import { Gitlab } from "@gitbeaker/rest";
|
|
17
|
-
import { ApiError, AuthRequiredError, InvalidUrlError, IssueNotFoundError } from "../issue/errors.js";
|
|
17
|
+
import { ApiError, AuthRequiredError, BackendConnectionError, InvalidUrlError, IssueNotFoundError } from "../issue/errors.js";
|
|
18
18
|
import type { Comment, CreateInput, Issue, ListFilter, parsePriority, Status, UpdateInput } from "../issue/issue.js";
|
|
19
19
|
|
|
20
20
|
export interface GitLabOptions {
|
|
@@ -183,12 +183,13 @@ export class GitLabRepository {
|
|
|
183
183
|
return (await fn()) as T;
|
|
184
184
|
} catch (err) {
|
|
185
185
|
if (err instanceof GitbeakerRequestError) {
|
|
186
|
-
const status = err.cause?.response?.status
|
|
186
|
+
const status = err.cause?.response?.status;
|
|
187
187
|
const url = err.cause?.request?.url ?? "";
|
|
188
|
+
if (status === undefined) throw new BackendConnectionError("gitlab", "unreachable", err);
|
|
188
189
|
if (status === 404) throw new IssueNotFoundError("gitlab", url);
|
|
189
190
|
throw new ApiError("gitlab", err.cause?.request?.method ?? "?", url, status, redact(err.message));
|
|
190
191
|
}
|
|
191
|
-
throw err;
|
|
192
|
+
throw new BackendConnectionError("gitlab", "unreachable", err);
|
|
192
193
|
}
|
|
193
194
|
}
|
|
194
195
|
}
|
package/src/issue/errors.ts
CHANGED
|
@@ -12,6 +12,35 @@ export class AuthRequiredError extends Error {
|
|
|
12
12
|
}
|
|
13
13
|
}
|
|
14
14
|
|
|
15
|
+
/** A reviewed, user-actionable backend setup failure safe to expose to clients. */
|
|
16
|
+
export class BackendConfigurationError extends Error {
|
|
17
|
+
constructor(
|
|
18
|
+
public readonly backend: string,
|
|
19
|
+
message: string,
|
|
20
|
+
public readonly recovery: string,
|
|
21
|
+
) {
|
|
22
|
+
super(`${backend}: ${message}`);
|
|
23
|
+
this.name = "BackendConfigurationError";
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** A transport failure with no trustworthy HTTP response (DNS, VPN, connection, or timeout). */
|
|
28
|
+
export class BackendConnectionError extends Error {
|
|
29
|
+
constructor(
|
|
30
|
+
public readonly backend: string,
|
|
31
|
+
public readonly kind: "unreachable" | "timeout" = "unreachable",
|
|
32
|
+
cause?: unknown,
|
|
33
|
+
) {
|
|
34
|
+
super(
|
|
35
|
+
kind === "timeout"
|
|
36
|
+
? `${backend}: backend request timed out; retry or check backend connectivity`
|
|
37
|
+
: `${backend}: unable to reach the backend API; check the configured URL and network, VPN, or DNS connectivity`,
|
|
38
|
+
{ cause },
|
|
39
|
+
);
|
|
40
|
+
this.name = "BackendConnectionError";
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
15
44
|
export class ApiError extends Error {
|
|
16
45
|
constructor(
|
|
17
46
|
public readonly backend: string,
|
package/src/jira/jira.ts
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
import type { AxiosAdapter } from "axios";
|
|
17
17
|
import type { HttpException, Config as JiraClientConfig } from "jira.js";
|
|
18
18
|
import { AgileClient, Version2Client } from "jira.js";
|
|
19
|
-
import { ApiError, IssueNotFoundError } from "../issue/errors.js";
|
|
19
|
+
import { ApiError, BackendConfigurationError, BackendConnectionError, IssueNotFoundError } from "../issue/errors.js";
|
|
20
20
|
import type { Comment, CreateInput, Issue, IssueLink, ListFilter, parsePriority, Status, UpdateInput } from "../issue/issue.js";
|
|
21
21
|
import type { Template } from "../issue/template.js";
|
|
22
22
|
import { buildTemplateBody, extractTemplateSections } from "../issue/template.js";
|
|
@@ -39,9 +39,9 @@ export interface JiraBasicAuthOptions {
|
|
|
39
39
|
email: string;
|
|
40
40
|
token: string;
|
|
41
41
|
project?: string;
|
|
42
|
-
/** Additional project keys the
|
|
42
|
+
/** Additional default project keys, beyond the single `project` above -- widens list()/search()'s own default scope (no explicit project given) as well as the background poller's sync, both via defaultProjects(). See buildSyncQuery(). */
|
|
43
43
|
syncProjects?: string[];
|
|
44
|
-
/** When true, the poller's background sync also pools everything assigned to the authenticated user (JQL `assignee = currentUser()`), regardless of project -- covers projects not listed in `project`/`syncProjects`. */
|
|
44
|
+
/** When true, the poller's background sync also pools everything assigned to the authenticated user (JQL `assignee = currentUser()`), regardless of project -- covers projects not listed in `project`/`syncProjects`. list()/search() are unaffected -- pass an explicit assignee filter for that. */
|
|
45
45
|
syncMine?: boolean;
|
|
46
46
|
timeoutMs?: number;
|
|
47
47
|
/** Injected in tests instead of a real network call — see axios's AxiosRequestConfig.adapter. */
|
|
@@ -180,15 +180,21 @@ export class JiraRepository {
|
|
|
180
180
|
this.client = new Version2Client(this.clientConfig);
|
|
181
181
|
}
|
|
182
182
|
|
|
183
|
+
/**
|
|
184
|
+
* An explicit filter.project always wins and narrows to exactly that one
|
|
185
|
+
* project; with none given, defaults to every project this repository
|
|
186
|
+
* cares about (defaultProjects() -- the same set buildSyncQuery() pools in
|
|
187
|
+
* the background), not just the single legacy `project` config field.
|
|
188
|
+
*/
|
|
183
189
|
async list(filter: ListFilter): Promise<Issue[]> {
|
|
184
|
-
const
|
|
190
|
+
const projects = filter.project ? [filter.project] : this.defaultProjects();
|
|
185
191
|
const clauses: string[] = [];
|
|
186
|
-
|
|
192
|
+
const scope = projectClause(projects);
|
|
193
|
+
if (scope) clauses.push(scope);
|
|
187
194
|
if (filter.status) clauses.push(`status = ${jqlQuote(mapStatusToJira(filter.status))}`);
|
|
188
195
|
if (filter.assignee) clauses.push(`assignee = ${jqlQuote(filter.assignee)}`);
|
|
189
196
|
for (const label of filter.labels ?? []) clauses.push(`labels = ${jqlQuote(label)}`);
|
|
190
|
-
|
|
191
|
-
return this.searchJql(jql, filter.limit ?? 50);
|
|
197
|
+
return this.searchJql(buildJql(clauses, "AND"), filter.limit ?? 50);
|
|
192
198
|
}
|
|
193
199
|
|
|
194
200
|
async get(key: string): Promise<Issue> {
|
|
@@ -218,13 +224,19 @@ export class JiraRepository {
|
|
|
218
224
|
const message = err instanceof Error ? err.message : String(err);
|
|
219
225
|
throw new ApiError("jira", "?", key ?? "?", status, redact(message));
|
|
220
226
|
}
|
|
221
|
-
throw err;
|
|
227
|
+
throw new BackendConnectionError("jira", err instanceof DOMException && err.name === "AbortError" ? "timeout" : "unreachable", err);
|
|
222
228
|
}
|
|
223
229
|
}
|
|
224
230
|
|
|
225
231
|
async create(input: CreateInput): Promise<Issue> {
|
|
226
232
|
const project = input.project ?? this.project;
|
|
227
|
-
if (!project)
|
|
233
|
+
if (!project) {
|
|
234
|
+
throw new BackendConfigurationError(
|
|
235
|
+
"jira",
|
|
236
|
+
"project is required to create an issue; pass input.project or configure JIRA_PROJECT",
|
|
237
|
+
"Pass input.project or set JIRA_PROJECT (or the backend's project setting), then retry.",
|
|
238
|
+
);
|
|
239
|
+
}
|
|
228
240
|
const fields: Record<string, unknown> = {
|
|
229
241
|
project: { key: project },
|
|
230
242
|
summary: input.title,
|
|
@@ -259,10 +271,12 @@ export class JiraRepository {
|
|
|
259
271
|
}
|
|
260
272
|
|
|
261
273
|
async search(query: string, limit = 50, project?: string): Promise<Issue[]> {
|
|
262
|
-
const
|
|
263
|
-
const
|
|
264
|
-
const
|
|
265
|
-
|
|
274
|
+
const projects = project ? [project] : this.defaultProjects();
|
|
275
|
+
const clauses: string[] = [];
|
|
276
|
+
const scope = projectClause(projects);
|
|
277
|
+
if (scope) clauses.push(scope);
|
|
278
|
+
clauses.push(`text ~ ${jqlQuote(query)}`);
|
|
279
|
+
return this.searchJql(buildJql(clauses, "AND"), limit);
|
|
266
280
|
}
|
|
267
281
|
|
|
268
282
|
async listChildren(key: string): Promise<Issue[]> {
|
|
@@ -284,23 +298,33 @@ export class JiraRepository {
|
|
|
284
298
|
return this.searchJql(query, limit);
|
|
285
299
|
}
|
|
286
300
|
|
|
301
|
+
/**
|
|
302
|
+
* Every project this repository defaults to when a caller doesn't name one
|
|
303
|
+
* explicitly -- the single `project` config plus `syncProjects`, deduped.
|
|
304
|
+
* Shared by list()/search()'s own default-scope resolution and by
|
|
305
|
+
* buildSyncQuery() below, so "which projects do we care about" is answered
|
|
306
|
+
* in exactly one place instead of once per method.
|
|
307
|
+
*/
|
|
308
|
+
private defaultProjects(): string[] {
|
|
309
|
+
return [...new Set([this.project, ...this.syncProjects].filter((p): p is string => Boolean(p)))];
|
|
310
|
+
}
|
|
311
|
+
|
|
287
312
|
/**
|
|
288
313
|
* SyncScopeExpandable -- widens what the poller's own background sync pools
|
|
289
|
-
* into the local ledger beyond
|
|
290
|
-
* back to: every configured project (default plus syncProjects) ORed with
|
|
314
|
+
* into the local ledger beyond defaultProjects() alone: ORs in
|
|
291
315
|
* "assignee = currentUser()" when syncMine is set, so issues assigned to
|
|
292
|
-
* you in a project nobody
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
* project's own existing behavior.
|
|
316
|
+
* you in a project nobody listed still get pooled. Returns undefined --
|
|
317
|
+
* letting the poller fall back to plain list() -- when syncMine adds
|
|
318
|
+
* nothing beyond what list() already does with 0-1 default projects.
|
|
296
319
|
*/
|
|
297
320
|
buildSyncQuery(): string | undefined {
|
|
298
|
-
const projects =
|
|
321
|
+
const projects = this.defaultProjects();
|
|
299
322
|
if (projects.length <= 1 && !this.syncMine) return undefined;
|
|
300
323
|
const clauses: string[] = [];
|
|
301
|
-
|
|
324
|
+
const scope = projectClause(projects);
|
|
325
|
+
if (scope) clauses.push(scope);
|
|
302
326
|
if (this.syncMine) clauses.push("assignee = currentUser()");
|
|
303
|
-
return
|
|
327
|
+
return buildJql(clauses, "OR");
|
|
304
328
|
}
|
|
305
329
|
|
|
306
330
|
/**
|
|
@@ -586,6 +610,18 @@ function jqlQuote(value: string): string {
|
|
|
586
610
|
return `"${value.replace(/"/g, '\\"')}"`;
|
|
587
611
|
}
|
|
588
612
|
|
|
613
|
+
/** Shared by list()/search()/buildSyncQuery() -- `project = X` for one project, `project in (...)` for several, undefined for none. */
|
|
614
|
+
function projectClause(projects: readonly string[]): string | undefined {
|
|
615
|
+
if (projects.length === 0) return undefined;
|
|
616
|
+
if (projects.length === 1) return `project = ${jqlQuote(projects[0]!)}`;
|
|
617
|
+
return `project in (${projects.map(jqlQuote).join(", ")})`;
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
/** Shared by list()/search()/buildSyncQuery() -- clauses joined by `joiner`, always ordered by `orderBy`. An empty clause list still yields valid JQL ("ORDER BY ..."), matching every one of this file's own pre-existing unscoped queries. */
|
|
621
|
+
function buildJql(clauses: readonly string[], joiner: "AND" | "OR", orderBy = "created DESC"): string {
|
|
622
|
+
return `${clauses.join(` ${joiner} `)} ORDER BY ${orderBy}`.trim();
|
|
623
|
+
}
|
|
624
|
+
|
|
589
625
|
function mapStatusToJira(status: Status): string {
|
|
590
626
|
switch (status) {
|
|
591
627
|
case "backlog":
|