Крючки жизненного цикла сессии

Крючки жизненного цикла сессии позволяют реагировать на события начала и окончания сессии. Используйте их для:

• Инициализация контекста при начале сессий
• Очищайте ресурсы после окончания сессий
• Отслеживайте метрики сессий и аналитику
• Динамическая настройка поведения сессии

Крюк для начала сессии

          `onSessionStart` Крючок вызывается, когда начинается сессия — будь то новая или возобновлённая.

Сигнатура крюка

import type { SessionStartHookInput, HookInvocation, SessionStartHookOutput } from "@github/copilot-sdk";
type SessionStartHandler = (
  input: SessionStartHookInput,
  invocation: HookInvocation
) => Promise<
  SessionStartHookOutput | null | undefined
>;

Для сигнатур хуков в Python, Go и .NET см. репозиторийgithub/copilot-sdk.

Ввод

Поле	Тип	Описание
timestamp	число/номер	Временная метка Unix, когда срабатывал крюк
cwd	струна	Текущий рабочий справочник
source

          `"startup"`
          \|
          `"resume"`
          \|
          `"new"`
         | Как началась сессия |

| initialPrompt | Строка | неопределена | Первоначальный запрос, если был предоставлен |

Выходные данные

Поле	Тип	Описание
additionalContext	струна	Контекст для добавления при начале сессии
modifiedConfig	объект	Конфигурация сессии переопределения

Примеры

Добавьте контекст проекта в начале

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      console.log(
        `Session ${invocation.sessionId} `
        + `started (${input.source})`
      );

      const projectInfo =
        await detectProjectType(input.cwd);

      return {
        additionalContext:
          `This is a ${projectInfo.type} project.\n`
          + `Main language: `
          + `${projectInfo.language}\n`
          + `Package manager: `
          + `${projectInfo.packageManager}`,
      };
    },
  },
});

Для примеров в Python см. репозиторийgithub/copilot-sdk.

Обработка возобновления сессии

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      if (input.source === "resume") {
        const previousState =
          await loadSessionState(
            invocation.sessionId
          );

        return {
          additionalContext:
            `Session resumed. Previous context:\n`
            + `- Last topic: `
            + `${previousState.lastTopic}\n`
            + `- Open files: `
            + previousState.openFiles.join(", "),
        };
      }
      return null;
    },
  },
});

Загрузка пользовательских предпочтений

const session = await client.createSession({
  hooks: {
    onSessionStart: async () => {
      const preferences =
        await loadUserPreferences();

      const contextParts = [];

      if (preferences.language) {
        contextParts.push(
          `Preferred language: `
          + `${preferences.language}`
        );
      }
      if (preferences.codeStyle) {
        contextParts.push(
          `Code style: ${preferences.codeStyle}`
        );
      }
      if (preferences.verbosity === "concise") {
        contextParts.push(
          "Keep responses brief and "
          + "to the point."
        );
      }

      return {
        additionalContext:
          contextParts.join("\n"),
      };
    },
  },
});

Хук в конце сессии

          `onSessionEnd` Крюк вызывается, когда сессия заканчивается.

Сигнатура крюка

import {
  HookInvocation,
  SessionEndHookInput,
  SessionEndHookOutput,
} from "@github/copilot-sdk";

type SessionEndHandler = (
  input: SessionEndHookInput,
  invocation: HookInvocation
) => Promise<
  SessionEndHookOutput | null | undefined
>;

Для сигнатур хуков в Python, Go и .NET см. репозиторийgithub/copilot-sdk.

Ввод

Поле	Тип	Описание
timestamp	число/номер	Временная метка Unix, когда срабатывал крюк
cwd	струна	Текущий рабочий справочник
reason	струна	Почему сессия закончилась (см. следующую таблицу)
finalMessage	Строка | неопределена	Последнее сообщение с сессии
error	Строка | неопределена	Сообщение об ошибке, если сессия завершилась из-за ошибки

Конечные причины

Причина	Описание
"complete"	Сессия прошла нормально
"error"	Сессия завершилась из-за ошибки
"abort"	Сессия была прервана пользователем или кодом
"timeout"	Время сессии окончено
"user_exit"	Пользователь явно завершил сессию

Выходные данные

Поле	Тип	Описание
suppressOutput	булевый	Подавить итоговый выход сессии
cleanupActions	строка[]	Список действий по очистке
sessionSummary	струна	Краткое содержание сессии по логированию/аналитике

Примеры

Метрики трековых сессий

const sessionStartTimes =
  new Map<string, number>();

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      sessionStartTimes.set(
        invocation.sessionId, input.timestamp
      );
      return null;
    },
    onSessionEnd: async (
      input, invocation
    ) => {
      const startTime = sessionStartTimes.get(
        invocation.sessionId
      );
      const duration = startTime
        ? input.timestamp - startTime
        : 0;

      await recordMetrics({
        sessionId: invocation.sessionId,
        duration,
        endReason: input.reason,
      });

      sessionStartTimes.delete(
        invocation.sessionId
      );
      return null;
    },
  },
});

Для примеров в Python см. репозиторийgithub/copilot-sdk.

Очистите ресурсы

const sessionResources =
  new Map<string, { tempFiles: string[] }>();

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      sessionResources.set(
        invocation.sessionId,
        { tempFiles: [] }
      );
      return null;
    },
    onSessionEnd: async (
      input, invocation
    ) => {
      const resources =
        sessionResources.get(
          invocation.sessionId
        );

      if (resources) {
        for (const file
          of resources.tempFiles) {
          await fs.unlink(file).catch(() => {});
        }
        sessionResources.delete(
          invocation.sessionId
        );
      }

      console.log(
        `Session ${invocation.sessionId} `
        + `ended: ${input.reason}`
      );
      return null;
    },
  },
});

Сохранить состояние сессии для резюме

const session = await client.createSession({
  hooks: {
    onSessionEnd: async (input, invocation) => {
      if (input.reason !== "error") {
        // Save state for potential resume
        await saveSessionState(invocation.sessionId, {
          endTime: input.timestamp,
          cwd: input.cwd,
          reason: input.reason,
        });
      }
      return null;
    },
  },
});

Краткое описание сессии журнала

const sessionData: Record<
  string,
  { prompts: number; tools: number;
    startTime: number }
> = {};

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      sessionData[invocation.sessionId] = {
        prompts: 0,
        tools: 0,
        startTime: input.timestamp,
      };
      return null;
    },
    onUserPromptSubmitted: async (
      _, invocation
    ) => {
      sessionData[
        invocation.sessionId
      ].prompts++;
      return null;
    },
    onPreToolUse: async (_, invocation) => {
      sessionData[
        invocation.sessionId
      ].tools++;
      return { permissionDecision: "allow" };
    },
    onSessionEnd: async (
      input, invocation
    ) => {
      const data =
        sessionData[invocation.sessionId];
      const durationSec =
        (input.timestamp - data.startTime)
        / 1000;
      console.log(
        `Session Summary:\n`
        + `  ID: ${invocation.sessionId}\n`
        + `  Duration: ${durationSec}s\n`
        + `  Prompts: ${data.prompts}\n`
        + `  Tool calls: ${data.tools}\n`
        + `  End reason: ${input.reason}`
      );

      delete sessionData[
        invocation.sessionId
      ];
      return null;
    },
  },
});

Лучшие практики

•         **Держись `onSessionStart` быстро.** Пользователи ждут, когда сессия будет готова.
  

•         **Занимайся всеми конечными причинами.** Не думайте, что сессии заканчиваются чисто; Обрабатывайте ошибки и отмены.
  

•         **Очистить ресурсы.** Используйте `onSessionEnd` для освобождения ресурсов, выделенных во время сессии.
  

•         **Сохраняйте минимальное состояние.** Если отслеживаете данные сессий, используйте лёгкий размер.
  

•         **Сделайте уборку идемпотентной.** 
          `onSessionEnd` Если процесс вылетит, может не вызвать.
  

Дополнительные материалы

•         [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/quickstart)
  

•         [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/error-handling)
  

•         [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/user-prompt-submitted)