Skip to content

[PB-4388]: feat/activate automatic tax when creating sub #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xabg2 merged 7 commits into from
May 22, 2025
Merged

[PB-4388]: feat/activate automatic tax when creating sub #226

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f8cb8ff
feat(object-storage): activate automatic tax when creating sub
xabg2 May 21, 2025
076ffae
tests(object-storage): coverage for create customer
xabg2 May 22, 2025
ca2c5f8
tests(object-storage): add coverage when creating sub
xabg2 May 22, 2025
0628100
fix: undo unnecessary changes for this PR
xabg2 May 22, 2025
898d92a
fix(object-storage): remove the cusotmer update if user exists
xabg2 May 22, 2025
eb350a1
fix(object-storage): attach Vat ID only for new customers
xabg2 May 22, 2025
b6b622e
tests(checkout): fix get price by id tests
xabg2 May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
204 changes: 100 additions & 104 deletions src/controller/payments.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import {
NotFoundPromoCodeByNameError,
PaymentService,
PromoCodeIsNotValidError,
UserAlreadyExistsError,
CustomerNotFoundError,
InvalidTaxIdError,
} from '../services/payment.service';
Expand All @@ -32,6 +31,7 @@ import { assertUser } from '../utils/assertUser';
import { fetchUserStorage } from '../utils/fetchUserStorage';
import { TierNotFoundError, TiersService } from '../services/tiers.service';
import { CustomerSyncService } from '../services/customerSync.service';
import { ForbiddenError } from '../errors/Errors';

type AllowedMethods = 'GET' | 'POST';

Expand All @@ -45,10 +45,6 @@ const ALLOWED_PATHS: {
'/plan-by-id': ['GET'],
'/promo-code-by-name': ['GET'],
'/promo-code-info': ['GET'],
'/object-storage-plan-by-id': ['GET'],
'/create-customer-for-object-storage': ['POST'],
'/payment-intent-for-object-storage': ['GET'],
'/create-subscription-for-object-storage': ['POST'],
};

export default function (
Expand All @@ -67,36 +63,43 @@ export default function (
});
fastify.addHook('onRequest', async (request, reply) => {
try {
const skipAuth = request.routeOptions?.config?.skipAuth;
const config: { url?: string; method?: AllowedMethods } = {
url: request.url.split('?')[0],
method: request.method as AllowedMethods,
};

if (
config.method &&
config.url &&
ALLOWED_PATHS[config.url] &&
ALLOWED_PATHS[config.url].includes(config.method)
(config.method &&
config.url &&
ALLOWED_PATHS[config.url] &&
ALLOWED_PATHS[config.url].includes(config.method)) ||
skipAuth
) {
return;
}

await request.jwtVerify();
} catch (err) {
request.log.warn(`JWT verification failed with error: ${(err as Error).message}`);
reply.status(401).send();
}
});

fastify.post<{ Body: { name: string; email: string; country?: string; companyVatId?: string } }>(
'/create-customer-for-object-storage',
fastify.get<{
Querystring: { email: string; customerName: string; country: string; postalCode: string; companyVatId?: string };
}>(
'/object-storage/customer',
{
schema: {
body: {
querystring: {
type: 'object',
required: ['email', 'name'],
required: ['email', 'customerName', 'country', 'postalCode'],
properties: {
name: { type: 'string' },
email: { type: 'string' },
customerName: { type: 'string' },
country: { type: 'string' },
postalCode: { type: 'string' },
companyVatId: { type: 'string' },
},
},
Expand All @@ -106,54 +109,50 @@ export default function (
max: 5,
timeWindow: '1 hour',
},
skipAuth: true,
},
},
async (req, res) => {
const { name, email, country, companyVatId } = req.body;
let customerId: Stripe.Customer['id'];
const { email, customerName, country, postalCode, companyVatId } = req.query;

if (!email) {
return res.status(404).send({
message: 'Email should be provided',
});
}
try {
const { id } = await paymentService.createOrGetCustomer(
const userExists = await paymentService.getCustomerIdByEmail(email).catch(() => null);
Copy link
Member

@sg-gs sg-gs May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming a NotFoundError is the only thing it may fail is risky and can have side-effects like duplicating customers silently (because if error -> user does not exist, then, it should be created) due to unexpected errors. It is advisable to check if it is a NotFound and then return null or else, let the error propagate or handle it appropiately


if (userExists) {
await paymentService.updateCustomer(
userExists.id,
{
name,
email,
customer: {
name: customerName,
},
},
country,
companyVatId,
);

const token = jwt.sign(
{
customerId: id,
address: {
postal_code: postalCode,
country,
},
},
config.JWT_SECRET,
);

return res.send({
customerId: id,
token,
});
} catch (err) {
const error = err as Error;
if (err instanceof UserAlreadyExistsError) {
return res.status(409).send(err.message);
}
if (err instanceof InvalidTaxIdError) {
return res.status(400).send({
message: error.message,
});
}
req.log.error(
`[OBJECT_STORAGE_CREATE_CUSTOMER_ERROR] Customer Email: ${email} - Error: ${error.stack ?? error.message}`,
);
return res.status(500).send({
message: 'Internal Server Error',
customerId = userExists.id;
} else {
const { id } = await paymentService.createCustomer({
name: customerName,
email,
address: {
country,
postal_code: postalCode,
},
});
customerId = id;
}

if (country && companyVatId) {
await paymentService.getVatIdAndAttachTaxIdToCustomer(customerId, country, companyVatId);
}

const token = jwt.sign({ customerId }, config.JWT_SECRET);

return res.send({ customerId, token });
},
);

Expand Down Expand Up @@ -375,16 +374,14 @@ export default function (
currency: string;
token: string;
promoCodeId?: string;
companyName: string;
companyVatId: string;
};
}>(
'/create-subscription-for-object-storage',
'/object-storage/subscription',
{
schema: {
body: {
type: 'object',
required: ['customerId', 'priceId'],
required: ['customerId', 'priceId', 'token'],
properties: {
customerId: {
type: 'string',
Expand All @@ -401,22 +398,15 @@ export default function (
promoCodeId: {
type: 'string',
},
companyName: {
type: 'string',
},
companyVatId: {
type: 'string',
},
},
},
},
config: {
skipAuth: true,
},
},
async (req, res) => {
const { customerId, priceId, currency, token, promoCodeId, companyName, companyVatId } = req.body;

if (!customerId || !priceId) {
throw new MissingParametersError(['customerId', 'priceId']);
}
const { customerId, priceId, currency, token, promoCodeId } = req.body;

try {
const payload = jwt.verify(token, config.JWT_SECRET) as {
Expand All @@ -425,30 +415,29 @@ export default function (
const tokenCustomerId = payload.customerId;

if (customerId !== tokenCustomerId) {
return res.status(403).send();
throw new ForbiddenError();
}
} catch (error) {
return res.status(403).send();
} catch {
throw new ForbiddenError();
}

try {
const subscriptionSetUp = await paymentService.createSubscription({
const createdSubscription = await paymentService.createSubscription({
customerId,
priceId,
currency,
companyName,
promoCodeId,
companyVatId,
additionalOptions: {
automatic_tax: {
enabled: true,
},
},
});

return res.send(subscriptionSetUp);
return res.send(createdSubscription);
} catch (err) {
const error = err as Error;
if (error instanceof MissingParametersError) {
return res.status(400).send({
message: error.message,
});
} else if (error instanceof ExistingSubscriptionError) {
if (error instanceof ExistingSubscriptionError) {
return res.status(409).send({
message: error.message,
});
Expand Down Expand Up @@ -851,6 +840,7 @@ export default function (
}
});

// TODO: Remove this useless endpoint
fastify.get<{
Querystring: {
customerId: CustomerId;
Expand Down Expand Up @@ -1136,35 +1126,41 @@ export default function (

fastify.get<{
Querystring: { planId: string; currency?: string };
schema: {
querystring: {
type: 'object';
properties: { planId: { type: 'string' }; currency: { type: 'string' } };
};
};
config: {
rateLimit: {
max: 5;
timeWindow: '1 minute';
};
};
}>('/object-storage-plan-by-id', async (req, rep) => {
const { planId, currency } = req.query;
}>(
'/object-storage/price',
{
schema: {
querystring: {
type: 'object',
properties: { planId: { type: 'string' }, currency: { type: 'string' } },
},
},
config: {
rateLimit: {
max: 5,
timeWindow: '1 minute',
},
skipAuth: true,
},
},
async (req, rep) => {
const { planId, currency } = req.query;

try {
const planObject = await paymentService.getObjectStoragePlanById(planId, currency);
try {
const planObject = await paymentService.getObjectStoragePlanById(planId, currency);

return rep.status(200).send(planObject);
} catch (error) {
const err = error as Error;
if (err instanceof NotFoundPlanByIdError) {
return rep.status(404).send({ message: err.message });
}
return rep.status(200).send(planObject);
} catch (error) {
const err = error as Error;
if (err instanceof NotFoundPlanByIdError) {
return rep.status(404).send({ message: err.message });
}

req.log.error(`[ERROR WHILE FETCHING PLAN BY ID]: ${err.message}. STACK ${err.stack ?? 'NO STACK'}`);
return rep.status(500).send({ message: 'Internal Server Error' });
}
});
req.log.error(`[ERROR WHILE FETCHING PLAN BY ID]: ${err.message}. STACK ${err.stack ?? 'NO STACK'}`);
return rep.status(500).send({ message: 'Internal Server Error' });
}
},
);

fastify.get<{
Querystring: { promotionCode: string };
Expand Down
1 change: 1 addition & 0 deletions src/services/payment.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ export class PaymentService {
}
}

// TODO: Remove this useless function
async createOrGetCustomer(payload: Stripe.CustomerCreateParams, country?: string, companyVatId?: string) {
if (!payload.email) {
throw new MissingParametersError(['email']);
Expand Down
3 changes: 3 additions & 0 deletions tests/src/controller/checkout.controller.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,9 @@ describe('Checkout controller', () => {
});

describe('Handling promo codes', () => {
beforeEach(() => {
jest.restoreAllMocks();
});
it('When the user provides a promo code with amount off, then the price is returned with the discount applied', async () => {
const mockedPrice = priceById({
bytes: 123456789,
Expand Down
Loading
Loading