refactor: Billing service by zomars · Pull Request #15366 · calcom/cal.diy

zomars · 2024-06-07T01:18:56Z

What does this PR do?

Fixes #XXXX (GitHub issue number)
Fixes CAL-XXXX (Linear issue number - should be visible at the bottom of the GitHub issue description)

The goal of this PR is to centralize our internal billing in a shared service. This will allow us to have an overview of all the billing related logic in one place.

Implements a stripe web hook handler so we can split big API handlers by webhook event, and lazy load them.

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected)
I have added a Docs issue here if this PR makes changes that would require a documentation change
I have added or modified automated tests that prove my fix is effective or that my feature works (PRs might be rejected if logical changes are not properly tested)

How should this be tested?

Are there environment variables that should be set?
What are the minimal test data to have?
What is expected (happy path) to have (input and output)?
Any other important info that could help to test that PR

Checklist

I haven't read the contributing guide
My code doesn't follow the style guidelines of this project
I haven't commented my code, particularly in hard-to-understand areas
I haven't checked if my changes generate no new warnings

github-actions · 2024-06-07T01:19:08Z

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

Unknown release type "WIP" found in pull request title "WIP: Billing service". 

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

vercel · 2024-06-07T01:20:18Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
ai	⬜️ Ignored (Inspect)	Visit Preview	Oct 3, 2024 9:22pm
cal	⬜️ Ignored (Inspect)	Visit Preview	Oct 3, 2024 9:22pm
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview	Oct 3, 2024 9:22pm

Signed-off-by: zomars <zomars@me.com>

socket-security · 2024-06-14T01:55:00Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

zomars · 2024-09-23T14:27:23Z

+
+const handler = async (data: SWHMap["payment_intent.succeeded"]["data"]) => {
+  const paymentIntent = data.object;
+  // TODO: Implement payment intent succeeded webhook handler


I think I left it as a placeholder. RN we handle upgrades via redirect callback. I'm not sure if here we can upgrade expired subscriptions or similar.

…n.deleted.team-plan.ts Co-authored-by: Omar López <zomars@me.com>

keithwillcode · 2024-09-30T16:56:07Z

@anikdhabal could we please get your help testing this one?

anikdhabal · 2024-09-30T17:41:17Z

@anikdhabal could we please get your help testing this one?

Sure, I will test this 🙏

keithwillcode

Nice changes overall. Just have some suggestions on responsibilities and naming.

keithwillcode · 2024-09-30T18:02:35Z

+  teamId: z.coerce.number(),
+});
+
+const handler = async (data: SWHMap["customer.subscription.deleted"]["data"]) => {


Well doesn't this code look clean, simple and to the point. 🙏

keithwillcode · 2024-09-30T18:05:24Z

+  parentId: true,
+});
+
+export class TeamBilling {


I agree with @joeauyeung here. This feels more like a repository rather than a team domain object. We should rename imho.

In DDD, for example, a repository would be used to return data for a team. Then, using just a constructor, static methods like we have here or a factory, you take that data and construct a team object with it. Mixing the two responsibilities here is misleading to the caller.

keithwillcode · 2024-09-30T18:08:34Z

+  });
+
+  describe("cancel", () => {
+    const internalTeamBilling = new InternalTeamBilling(mockTeam);


What does "Internal" mean here? Is it to describe that this class is handling most of the core logic for team billing? Looking at the class, seems like TeamBillingService would be more fitting since it's doing repository calls and logical changes. i.e. It's orchestrating like an Application Service.

By internal. It means Cal.com internal billing.

keithwillcode · 2024-09-30T18:11:45Z

@@ -0,0 +1,27 @@
+import logger from "@calcom/lib/logger";


Nice approach

socket-security · 2024-10-01T08:32:24Z

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

View full report↗︎

github-actions · 2024-10-02T02:09:22Z

E2E results are ready!

Workflow #33591.1 latest results

zomars · 2024-10-03T00:11:54Z

    });
  });

-  describe("find", () => {


keithwillcode

Changes since my feedback look better. We can still optimize not having the static repo on there but can be a follow-up.

Have discussed with zomars and we agreed to put onto qa for testing.

WIP: Billing service

86ee874

keithwillcode added core area: core, team members only foundation labels Jun 7, 2024

vercel bot deployed to Preview – ai June 7, 2024 01:20 View deployment

vercel bot deployed to Preview – api June 7, 2024 01:24 View deployment

zomars added 3 commits June 6, 2024 18:24

WIP

a416e44

Update __handler.ts

da13397

Update index.ts

b62ec7c

vercel bot deployed to Preview – api June 7, 2024 01:44 View deployment

vercel bot deployed to Preview – dev June 7, 2024 01:54 View deployment

zomars added 2 commits June 7, 2024 14:13

Merge branch 'main' into fix/billing-service

f0ac333

WIP

ba90dfa

vercel bot deployed to Preview – ai June 8, 2024 03:58 View deployment

vercel bot deployed to Preview – api June 8, 2024 04:02 View deployment

vercel bot deployed to Preview – dev June 8, 2024 04:07 View deployment

zomars requested review from emrysal and keithwillcode June 8, 2024 04:08

keithwillcode added this to the v4.2 milestone Jun 11, 2024

zomars added 3 commits June 12, 2024 13:39

Merge branch 'main' into fix/billing-service

58be0df

WIP

0fbce45

Signed-off-by: zomars <zomars@me.com>

WIP

df7ca3f

Signed-off-by: zomars <zomars@me.com>

github-actions bot added the ❗️ .env changes contains changes to env variables label Jun 14, 2024

vercel bot deployed to Preview – ai June 14, 2024 00:14 View deployment

vercel bot had a problem deploying to Preview – api June 14, 2024 00:15 Failure

vercel bot deployed to Preview – dev June 14, 2024 00:23 View deployment

Update delete.handler.ts

d979f96

vercel bot had a problem deploying to Preview – api June 14, 2024 01:58 Failure

remove logs

a4d1263

sean-brydon reviewed Sep 23, 2024

View reviewed changes

Comment thread packages/trpc/server/routers/viewer/teams/inviteMember/inviteMember.handler.test.ts

emrysal reviewed Sep 23, 2024

View reviewed changes

Comment thread packages/lib/constants.ts Outdated

vercel bot had a problem deploying to Preview – api September 23, 2024 09:28 Failure

fix constants

da2edc4

zomars commented Sep 23, 2024

View reviewed changes

sean-brydon and others added 3 commits September 25, 2024 10:59

Update packages/features/ee/billing/api/webhook/_customer.subscriptio…

2fc27ce

…n.deleted.team-plan.ts Co-authored-by: Omar López <zomars@me.com>

Merge branch 'main' into fix/billing-service

e9ec314

Merge branch 'main' into fix/billing-service

52b61cd

keithwillcode reviewed Sep 27, 2024

View reviewed changes

Comment thread packages/lib/server/repository/team.ts Outdated

sean-brydon and others added 4 commits September 30, 2024 08:45

Merge branch 'main' into fix/billing-service

4dfea96

move workflow logic to a service

c213512

use static method > creating new class

6f22963

Merge branch 'main' into fix/billing-service

f266f4f

keithwillcode requested changes Sep 30, 2024

View reviewed changes

fix: remove http code deep in repo + tests

dc1fcca

zomars added 3 commits October 2, 2024 12:00

Merge branch 'main' into fix/billing-service

fbf9bd6

Feedback

32ced40

Merge branch 'main' into fix/billing-service

7b45bf6

zomars commented Oct 3, 2024

View reviewed changes

zomars and others added 4 commits October 2, 2024 17:13

Update index.ts

86509f4

Type fix

cd8a0de

Merge branch 'main' into fix/billing-service

407a195

Lazy load fixes

bcb4466

keithwillcode approved these changes Oct 4, 2024

View reviewed changes

zomars mentioned this pull request Oct 15, 2024

[CAL-4102] Org Account Not Deactivated After Failed Payment #16045

Closed

Conversation

zomars commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Checklist

Uh oh!

github-actions bot commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security bot commented Jun 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zomars Sep 23, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

keithwillcode commented Sep 30, 2024

Uh oh!

anikdhabal commented Sep 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

keithwillcode left a comment

Choose a reason for hiding this comment

Uh oh!

keithwillcode Sep 30, 2024

Choose a reason for hiding this comment

Uh oh!

keithwillcode Sep 30, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

keithwillcode Sep 30, 2024

Choose a reason for hiding this comment

Uh oh!

zomars Sep 30, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

keithwillcode Sep 30, 2024

Choose a reason for hiding this comment

Uh oh!

socket-security bot commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E results are ready!

Uh oh!

zomars Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keithwillcode left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

16 participants

zomars commented Jun 7, 2024 •

edited

Loading

github-actions bot commented Jun 7, 2024 •

edited

Loading

vercel bot commented Jun 7, 2024 •

edited

Loading

socket-security bot commented Jun 14, 2024 •

edited

Loading

anikdhabal commented Sep 30, 2024 •

edited

Loading

socket-security bot commented Oct 1, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024 •

edited

Loading

zomars Oct 3, 2024 •

edited

Loading