paperclip-github-plugin 0.8.5 → 0.8.6

package/dist/manifest.js

@@ -535,7 +535,7 @@ var COMPANY_METRIC_API_ROUTE_URL_PATH = `/api/plugins/${GITHUB_SYNC_PLUGIN_ID}/a
 var require2 = createRequire(import.meta.url);
 var packageJson = require2("../package.json");
 var SCHEDULE_TICK_CRON = "* * * * *";
-var MANIFEST_VERSION = "0.8.5"?.trim() || typeof packageJson.version === "string" && packageJson.version.trim() || process.env.npm_package_version?.trim() || "0.0.0-dev";
+var MANIFEST_VERSION = "0.8.6"?.trim() || typeof packageJson.version === "string" && packageJson.version.trim() || process.env.npm_package_version?.trim() || "0.0.0-dev";
 var manifest = {
   id: GITHUB_SYNC_PLUGIN_ID,
   apiVersion: 1,

package/dist/worker.js

@@ -1498,6 +1498,88 @@ function getErrorResponseDataMessage(error) {
   const message = data.message;
   return typeof message === "string" && message.trim() ? message.trim() : void 0;
 }
+function getGitHubRequestId(error) {
+  const requestId = getErrorResponseHeaders(error)["x-github-request-id"]?.trim();
+  return requestId || void 0;
+}
+function buildGitHubOctokitLogMetadata(context) {
+  const metadata = {};
+  const companyId = normalizeCompanyId(context.companyId);
+  const operation = normalizeOptionalString2(context.operation);
+  const repositoryUrl = normalizeOptionalString2(context.repositoryUrl);
+  const toolName = normalizeOptionalString2(context.toolName);
+  if (companyId) {
+    metadata.companyId = companyId;
+  }
+  if (operation) {
+    metadata.operation = operation;
+  }
+  if (repositoryUrl) {
+    metadata.repositoryUrl = repositoryUrl;
+  }
+  if (context.syncTrigger) {
+    metadata.syncTrigger = context.syncTrigger;
+  }
+  if (toolName) {
+    metadata.toolName = toolName;
+  }
+  return metadata;
+}
+function getGitHubOctokitRequestPath(url, baseUrl) {
+  if (typeof url !== "string" || !url.trim()) {
+    return void 0;
+  }
+  const trimmedUrl = url.trim();
+  if (typeof baseUrl === "string" && baseUrl.trim() && trimmedUrl.startsWith(baseUrl.trim())) {
+    return trimmedUrl.slice(baseUrl.trim().length) || "/";
+  }
+  try {
+    const parsed = new URL(trimmedUrl);
+    return `${parsed.pathname}${parsed.search}`;
+  } catch {
+    return trimmedUrl;
+  }
+}
+function createGitHubOctokit(ctx, token, context = {}) {
+  const octokit = new Octokit({
+    auth: token,
+    log: {
+      debug: () => void 0,
+      info: () => void 0,
+      warn: (message) => {
+        ctx.logger.warn("GitHub Octokit warning.", {
+          ...buildGitHubOctokitLogMetadata(context),
+          message
+        });
+      },
+      error: () => void 0
+    }
+  });
+  if (context.logFailures === false) {
+    return octokit;
+  }
+  octokit.hook.wrap("request", async (request, options) => {
+    const start = Date.now();
+    const requestOptions = octokit.request.endpoint.parse(options);
+    try {
+      return await request(options);
+    } catch (error) {
+      const responseMessage = getErrorResponseDataMessage(error);
+      ctx.logger.warn("GitHub API request failed.", {
+        ...buildGitHubOctokitLogMetadata(context),
+        method: requestOptions.method,
+        path: getGitHubOctokitRequestPath(requestOptions.url, options.baseUrl),
+        status: getErrorStatus(error) ?? null,
+        requestId: getGitHubRequestId(error) ?? null,
+        durationMs: Date.now() - start,
+        error: getErrorMessage(error),
+        ...responseMessage ? { responseMessage } : {}
+      });
+      throw error;
+    }
+  });
+  return octokit;
+}
 function getErrorResponseDataErrors(error) {
   if (!error || typeof error !== "object" || !("response" in error)) {
     return [];
@@ -9778,12 +9860,16 @@ async function handleCompanyMetricApiRoute(ctx, input) {
     }
   };
 }
-async function createGitHubToolOctokit(ctx, companyId) {
+async function createGitHubToolOctokit(ctx, companyId, context = {}) {
   const token = (await resolveGithubToken(ctx, { companyId })).trim();
   if (!token) {
     throw new Error(MISSING_GITHUB_TOKEN_SYNC_MESSAGE);
   }
-  return new Octokit({ auth: token });
+  return createGitHubOctokit(ctx, token, {
+    companyId,
+    operation: "github-api",
+    ...context
+  });
 }
 async function listGitHubRepositoryOpenPullRequestNumbers(octokit, repository) {
   const response = await octokit.rest.pulls.list({
@@ -12684,8 +12770,11 @@ function mergeNamedValues(currentValues, params) {
   }
   return [...values.values()];
 }
-async function validateGithubToken(token) {
-  const octokit = new Octokit({ auth: token.trim() });
+async function validateGithubToken(ctx, token) {
+  const octokit = createGitHubOctokit(ctx, token.trim(), {
+    logFailures: false,
+    operation: "settings.validateToken"
+  });
   try {
     const response = await octokit.rest.users.getAuthenticated();
     return {
@@ -12797,7 +12886,12 @@ async function performSync(ctx, trigger, options = {}) {
     return saveSettingsSyncState(ctx, settings, next.syncState, targetCompanyId);
   }
   activePaperclipApiAuthTokensByCompanyId = await resolvePaperclipApiAuthTokens(ctx, settings, config, mappings);
-  const octokit = new Octokit({ auth: token });
+  const octokitLogContext = {
+    companyId: targetCompanyId,
+    operation: "sync.github-issues",
+    syncTrigger: trigger
+  };
+  const octokit = createGitHubOctokit(ctx, token, octokitLogContext);
   let syncedIssuesCount = 0;
   let createdIssuesCount = 0;
   let skippedIssuesCount = 0;
@@ -12947,6 +13041,7 @@ async function performSync(ctx, trigger, options = {}) {
       await throwIfSyncCancelled();
       try {
         const repository = requireRepositoryReference(mapping.repositoryUrl);
+        octokitLogContext.repositoryUrl = repository.url;
         const importedIssueRecords = nextRegistry.filter((entry) => doesImportedIssueRecordMatchMapping(entry, mapping)).filter((entry) => doesImportedIssueMatchTarget(entry, options.target));
         const shouldLoadClosedIssues = options.target?.kind === "issue" || importedIssueRecords.length > 0;
         currentProgress = {
@@ -13068,6 +13163,7 @@ async function performSync(ctx, trigger, options = {}) {
       await throwIfSyncCancelled();
       try {
         const { mapping, advancedSettings, repository, repositoryIndex, allIssuesById, issues, pullRequestLinks } = plan;
+        octokitLogContext.repositoryUrl = repository.url;
         const companyId = mapping.companyId;
         let availableLabels = companyId ? companyLabelDirectoryCache.get(companyId) : void 0;
         if (!availableLabels) {
@@ -13509,13 +13605,19 @@ async function startSync(ctx, trigger, options = {}) {
   }
 }
 function registerGitHubAgentTools(ctx) {
+  async function createAgentToolOctokit(runCtx, toolName, repository) {
+    return createGitHubToolOctokit(ctx, runCtx.companyId, {
+      toolName,
+      ...repository ? { repositoryUrl: repository.url } : {}
+    });
+  }
   ctx.tools.register(
     "search_repository_items",
     getGitHubAgentToolDeclaration("search_repository_items"),
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
       const repository = await resolveGitHubToolRepository(ctx, runCtx, input);
+      const octokit = await createAgentToolOctokit(runCtx, "search_repository_items", repository);
       const rawQuery = normalizeOptionalToolString(input.query);
       if (!rawQuery) {
         throw new Error("query is required.");
@@ -13583,7 +13685,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubIssueToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "get_issue", target.repository);
       const response = await octokit.rest.issues.get({
         owner: target.repository.owner,
         repo: target.repository.repo,
@@ -13630,7 +13732,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubIssueToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "list_issue_comments", target.repository);
       const comments = await listAllGitHubIssueComments(octokit, target.repository, target.issueNumber);
       return buildToolSuccessResult(
         `Loaded ${comments.length} GitHub ${comments.length === 1 ? "comment" : "comments"} from issue #${target.issueNumber}.`,
@@ -13648,7 +13750,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubIssueToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "update_issue", target.repository);
       const currentResponse = await octokit.rest.issues.get({
         owner: target.repository.owner,
         repo: target.repository.repo,
@@ -13721,7 +13823,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubIssueToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "assign_to_current_user", target.repository);
       const [currentResponse, authenticatedUserResponse] = await Promise.all([
         octokit.rest.issues.get({
           owner: target.repository.owner,
@@ -13781,7 +13883,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubIssueToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "add_issue_comment", target.repository);
       const body = appendAiAuthorshipFooter(String(input.body ?? ""), "comment", normalizeOptionalToolString(input.llmModel));
       const response = await octokit.rest.issues.createComment({
         owner: target.repository.owner,
@@ -13831,7 +13933,7 @@ function registerGitHubAgentTools(ctx) {
         "pull request description",
         normalizeOptionalToolString(input.llmModel)
       ) : void 0;
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "create_pull_request", repository);
       const response = await octokit.rest.pulls.create({
         owner: repository.owner,
         repo: repository.repo,
@@ -13907,7 +14009,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubPullRequestToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "get_pull_request", target.repository);
       const response = await octokit.rest.pulls.get({
         owner: target.repository.owner,
         repo: target.repository.repo,
@@ -13955,7 +14057,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubPullRequestToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "update_pull_request", target.repository);
       let currentResponse = await octokit.rest.pulls.get({
         owner: target.repository.owner,
         repo: target.repository.repo,
@@ -14021,7 +14123,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubPullRequestToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "list_pull_request_files", target.repository);
       const files = await listAllPullRequestFiles(octokit, target.repository, target.pullRequestNumber);
       return buildToolSuccessResult(
         `Loaded ${files.length} changed ${files.length === 1 ? "file" : "files"} from pull request #${target.pullRequestNumber}.`,
@@ -14039,7 +14141,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubPullRequestToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "get_pull_request_checks", target.repository);
       const pullRequestResponse = await octokit.rest.pulls.get({
         owner: target.repository.owner,
         repo: target.repository.repo,
@@ -14138,7 +14240,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubPullRequestToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "list_pull_request_review_threads", target.repository);
       const threads = await listDetailedPullRequestReviewThreads(octokit, target.repository, target.pullRequestNumber);
       return buildToolSuccessResult(
         `Loaded ${threads.length} review ${threads.length === 1 ? "thread" : "threads"} from pull request #${target.pullRequestNumber}.`,
@@ -14160,7 +14262,7 @@ function registerGitHubAgentTools(ctx) {
         throw new Error("threadId is required.");
       }
       const body = appendAiAuthorshipFooter(String(input.body ?? ""), "comment", normalizeOptionalToolString(input.llmModel));
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "reply_to_review_thread");
       const response = await octokit.graphql(
         GITHUB_ADD_PULL_REQUEST_REVIEW_THREAD_REPLY_MUTATION,
         {
@@ -14195,7 +14297,7 @@ function registerGitHubAgentTools(ctx) {
       if (!threadId) {
         throw new Error("threadId is required.");
       }
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "resolve_review_thread");
       const response = await octokit.graphql(
         GITHUB_RESOLVE_REVIEW_THREAD_MUTATION,
         {
@@ -14226,7 +14328,7 @@ function registerGitHubAgentTools(ctx) {
       if (!threadId) {
         throw new Error("threadId is required.");
       }
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "unresolve_review_thread");
       const response = await octokit.graphql(
         GITHUB_UNRESOLVE_REVIEW_THREAD_MUTATION,
         {
@@ -14259,7 +14361,7 @@ function registerGitHubAgentTools(ctx) {
       if (userReviewers.length === 0 && teamReviewers.length === 0) {
         throw new Error("Provide at least one user reviewer or team reviewer.");
       }
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "request_pull_request_reviewers", target.repository);
       const response = await octokit.rest.pulls.requestReviewers({
         owner: target.repository.owner,
         repo: target.repository.repo,
@@ -14290,7 +14392,7 @@ function registerGitHubAgentTools(ctx) {
       if (!organization) {
         throw new Error("organization is required.");
       }
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "list_organization_projects");
       const projects = await listGitHubOrganizationProjects(octokit, organization, {
         includeClosed: input.includeClosed === true,
         query: normalizeOptionalToolString(input.query),
@@ -14311,7 +14413,7 @@ function registerGitHubAgentTools(ctx) {
     async (params, runCtx) => executeGitHubTool(async () => {
       const input = getToolInputRecord(params);
       const target = await resolveGitHubPullRequestToolTarget(ctx, runCtx, input);
-      const octokit = await createGitHubToolOctokit(ctx, runCtx.companyId);
+      const octokit = await createAgentToolOctokit(runCtx, "add_pull_request_to_project", target.repository);
       const projectTarget = await resolveGitHubProjectToolTarget(octokit, input);
       const pullRequest = await getGitHubPullRequestProjectItems(
         octokit,
@@ -14380,6 +14482,7 @@ function shouldStartWorkerHost(moduleUrl, entry = process.argv[1]) {
 }
 var __testing = {
   buildSyncFallbackExecutionStatePatch,
+  createGitHubToolOctokit,
   hasUnresolvedPaperclipIssueBlocker,
   isHealthyMaintainerWaitTransition,
   resolveSyncTransitionAssignee
@@ -14681,7 +14784,7 @@ var plugin = definePlugin({
       if (!trimmedToken) {
         throw new Error("Enter a GitHub token.");
       }
-      return validateGithubToken(trimmedToken);
+      return validateGithubToken(ctx, trimmedToken);
     });
     ctx.actions.register("project.pullRequests.createIssue", async (input) => {
       const record = input && typeof input === "object" ? input : {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paperclip-github-plugin",
-  "version": "0.8.5",
+  "version": "0.8.6",
   "description": "Paperclip plugin for synchronizing GitHub issues into Paperclip projects.",
   "license": "Apache-2.0",
   "type": "module",