openmeter icon indicating copy to clipboard operation
openmeter copied to clipboard

Subscription IsCustom

Open GAlexIHU opened this issue 9 months ago • 2 comments

Overview

  • Storing the timestamp of the last edit on the subscription
  • Adding IsCustom field: if a subscription doesn't have a plan ref (created as a custom sub) or is edited (has edit timestamp) it will be a custom subscription.
  • We don't try to guess last edit times for existing subscriptions: for existing subs, they'll only be custom if they dont have a planref

Summary by CodeRabbit

  • New Features
    • Subscriptions now show a “custom” indicator to reveal whether they were customized.
    • A “last edited” timestamp has been added to subscription details, offering better visibility into recent modifications.
    • Updates to subscription editing now validate that customizations are provided, ensuring users receive clear error feedback when input is missing.

GAlexIHU avatar Mar 11 '25 13:03 GAlexIHU

📝 Walkthrough

Walkthrough

This pull request introduces two major changes to the subscription models. First, a new boolean field (IsCustom/isCustom) is added to various subscription definitions (both API schemas and client models) to indicate custom subscriptions. Second, a new timestamp field (last_edited_at) is integrated into the database schema and the ORM layer with comprehensive support through added methods for setting, clearing, and querying. Additional repository and service logic has been updated to handle marking subscriptions as edited, and new SQL migrations ensure the database schema reflects these changes.

Changes

File(s) Change Summary
api/api.gen.go, api/client/go/client.gen.go, api/client/javascript/src/client/schemas.ts, api/openapi.{cloud,yaml}, api/spec/src/productcatalog/subscription.tsp Added a new boolean field (IsCustom/isCustom) to the Subscription and SubscriptionExpanded models/schemas. Minor updates to the swaggerSpec string were also applied.
openmeter/ent/db/{migrate/schema.go, mutation.go, setorclear.go, subscription.go, subscription/where.go, subscription_create.go, subscription_update.go}, openmeter/ent/schema/subscription.go Introduced a new last_edited_at column/field. Added methods for setting, clearing, and querying this field in mutations and updates, updated scanning/assignment logic, and adjusted foreign keys and indices accordingly.
openmeter/{productcatalog/subscription/http/mapping.go, subscription/repo/{mapping.go, subscriptionrepo.go}, subscription/{repository.go, service/service.go, service/workflowservice{.go,_test.go}, subscription.go} Enhanced API mapping and domain logic to propagate the IsCustom and LastEditedAt fields. Added a repository method (MarkEdited) and updated the service layer to mark subscriptions as edited, including additional validation and error handling (with corresponding test updates).
tools/migrate/migrations/{20250312103404_subscription-editedat.up.sql, 20250312103404_subscription-editedat.down.sql} Added SQL migration files to create a new last_edited_at column in the subscriptions table and to provide a rollback operation by dropping this column.

Possibly related PRs

  • openmeterio/openmeter#2429: The changes in the main PR are related to those in the retrieved PR as both introduce a new boolean field IsCustom to the Subscription and SubscriptionExpanded structs, indicating whether a subscription is custom.
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Mar 11 '25 13:03 coderabbitai[bot]

Please rebase

tothandras avatar Mar 14 '25 00:03 tothandras