Add Hash, Index Signature in Canonical Spec

[toothlessdev]

📎 Related issues

• resolve Partition canonical api spec output #11

📦 Scope

• @patchlogr/core
• @patchlogr/cli
• @patchlogr/oas
• @patchlogr/inspector
• @patchlogr/types
• docs, examples
• tests
• ci / cd / infra
• other (아래에 명시)

📌 Summary

• Canonical Spec 에 인덱스 시그니처 추가
• 전체 spec 에 대한 sha256 해시값 계산로직 추가

🧠 Context

• 각 partition 의 해시값을 비교하기전 전체 spec 에 대한 해시값을 우선 비교
• 변경사항이 없는경우 빠르게 diff 과정을 스킵하기 위함

⚠️ Impact

• No Breaking Changes
• Breaking Change
• Versioning 영향 있음 (major)
• 내부 리팩토링만 포함

✅ Checklist

• 요구사항 명세 충족
• 테스트 추가 / 수정
• deterministic output 확인

[gemini-code-assist]

Summary of Changes

Hello @toothlessdev, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant optimization to the 'patchlogr-core' package by implementing a global SHA256 hashing mechanism for the 'CanonicalSpec'. This allows for an initial, high-level comparison of specifications, enabling the system to quickly determine if any changes have occurred before proceeding with more detailed partition-level diffing. This change aims to improve performance by skipping unnecessary deep comparisons when the overall spec remains identical.

Highlights

• Global Spec Hashing: A SHA256 hash is now computed for the entire CanonicalSpec to enable quick change detection.
• PartitionedSpec Update: The PartitionedSpec type now includes a 'hash' property to store the global spec hash.
• Type Refactoring: The CanonicalSpec definition has been refactored from an 'interface' to a 'type' alias.
• Redundant Type Removal: The PartitionManifest type has been removed as it is no longer needed.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Test Results

76 tests   76 ✅  1s ⏱️
17 suites   0 💤
 3 files     0 ❌

Results for commit 6fcd64b.

[gemini-code-assist]

Code Review

이 PR은 전체 사양에 대한 해시를 추가하여 변경 사항이 없을 때 diff 과정을 빠르게 건너뛸 수 있도록 개선하고, CanonicalSpec의 확장성을 높이려는 의도가 엿보입니다. 전반적으로 좋은 방향의 변경이지만, 몇 가지 개선할 점이 보입니다. CanonicalSpec에 인덱스 시그니처가 누락된 부분을 수정하고, 중복되는 파티셔닝 로직을 리팩터링하여 코드의 유지보수성을 높이는 것을 제안합니다. 자세한 내용은 각 파일의 주석을 참고해주세요.