Skip to content

#213 Create shared DTOs package for lambdas #234

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

Open
nourshoreibah wants to merge 3 commits into
base: main
Choose a base branch
from
Open

#213 Create shared DTOs package for lambdas #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f97d963
Create shared @branch/dtos package to deduplicate DTOs across lambdas
nourshoreibah Jun 10, 2026
1b2c510
Rename @branch/dtos to @branch/types
nourshoreibah Jun 10, 2026
12ce8b2
Fix users test mocks after isAdmin became optional in shared types
nourshoreibah Jun 10, 2026
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
1 change: 1 addition & 0 deletions .github/workflows/lambda-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
branches: [main]
paths:
- 'apps/backend/lambdas/**'
- 'shared/types/**'

jobs:
detect-changes:
Expand Down
123 changes: 43 additions & 80 deletions .github/workflows/regenerate-db-types.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,65 +110,46 @@ jobs:

echo "Type generation successful"

- name: Copy generated types to lambda functions
- name: Copy generated types to shared DTOs package
run: |
echo "Copying generated types to lambda functions"
echo "Copying generated types to shared/types"

SOURCE_FILE="apps/backend/db/db-types.d.ts"
TARGET_FILE="shared/types/db-types.d.ts"

# verify the source file exists
if [ ! -f "$SOURCE_FILE" ]; then
echo "Error: Generated types file not found at $SOURCE_FILE"
exit 1
fi

# verify the source file exists and is not empty
if [ ! -s "$SOURCE_FILE" ]; then
echo "Error: Generated types file is empty"
echo "Error: Generated types file not found or empty at $SOURCE_FILE"
exit 1
fi

# Define target lambda directories
LAMBDA_DIRS=()
for dir in apps/backend/lambdas/*; do
if [ -d "$dir" ]; then
LAMBDA_DIRS+=("$dir")
echo " Found: $dir"
fi
done

if [ ${#LAMBDA_DIRS[@]} -eq 0 ]; then
echo "Error: No lambda directories found in apps/backend/lambdas/"
exit 1
fi
# Replace the kysely import with a local, structurally identical
# ColumnType so the shared package stays dependency-free and the
# lambdas stay fully self contained.
node -e '
const fs = require("fs");
const [src, target] = process.argv.slice(1);
const kyselyImport = `import type { ColumnType } from "kysely";`;
const localColumnType = [
"/**",
" * Structurally identical to kysely'"'"'s ColumnType, defined locally so this",
" * package has no dependencies and lambdas stay fully self contained.",
" */",
"type ColumnType<SelectType, InsertType = SelectType, UpdateType = SelectType> = {",
" readonly __select__: SelectType;",
" readonly __insert__: InsertType;",
" readonly __update__: UpdateType;",
"};",
].join("\n");
const contents = fs.readFileSync(src, "utf8");
if (!contents.includes(kyselyImport)) {
console.error("Error: expected kysely ColumnType import not found in " + src);
process.exit(1);
}
fs.writeFileSync(target, contents.replace(kyselyImport, localColumnType));
' "$SOURCE_FILE" "$TARGET_FILE"

# Track success and failures
SUCCESS_COUNT=0
FAIL_COUNT=0

for dir in "${LAMBDA_DIRS[@]}"; do
if [ -d "$dir" ]; then
echo "Copying to $dir/db-types.d.ts"
cp "$SOURCE_FILE" "$dir/db-types.d.ts"

if [ $? -eq 0 ]; then
((SUCCESS_COUNT++))
else
echo "Failed to copy to $dir"
((FAIL_COUNT++))
fi
else
echo "Warning: Directory $dir does not exist"
((FAIL_COUNT++))
fi
done

echo ""
echo "Copy summary: $SUCCESS_COUNT succeeded, $FAIL_COUNT failed"

if [ $SUCCESS_COUNT -eq 0 ]; then
echo "Error: Failed to copy types to any lambda function"
exit 1
fi
echo "Wrote $TARGET_FILE"

- name: Verify TypeScript compilation
run: |
Expand All @@ -181,14 +162,10 @@ jobs:
echo "Performing basic syntax check on generated types..."

# Ensure the file is valid TypeScript
for file in apps/backend/lambdas/*/db-types.d.ts; do
if [ -f "$file" ]; then
npx tsc --noEmit --skipLibCheck "$file" || {
echo "Error: $file contains TypeScript errors"
exit 1
}
fi
done
npx tsc --noEmit --skipLibCheck shared/types/db-types.d.ts || {
echo "Error: shared/types/db-types.d.ts contains TypeScript errors"
exit 1
}
else
npx tsc --noEmit --skipLibCheck || {
echo "Error: TypeScript compilation failed"
Expand All @@ -202,17 +179,17 @@ jobs:
- name: Check for changes
id: git-check
run: |
git add -N apps/backend/lambdas/*/db-types.d.ts
git add -N shared/types/db-types.d.ts

if git diff --exit-code apps/backend/lambdas/*/db-types.d.ts; then
if git diff --exit-code shared/types/db-types.d.ts; then
echo "changes=false" >> $GITHUB_OUTPUT
echo "No changes detected in generated types"
else
echo "changes=true" >> $GITHUB_OUTPUT
echo "Changes detected in generated types"

echo "Changed files:"
git diff --name-only apps/backend/lambdas/*/db-types.d.ts
git diff --name-only shared/types/db-types.d.ts
fi

- name: Get PR author information
Expand Down Expand Up @@ -242,7 +219,7 @@ jobs:
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"

git add apps/backend/lambdas/*/db-types.d.ts
git add shared/types/db-types.d.ts

COMMIT_MESSAGE="chore: auto-regenerate database types from schema changes"

Expand All @@ -263,22 +240,13 @@ jobs:
uses: actions/github-script@v7
with:
script: |
const { execSync } = require('child_process');
const files = execSync('git diff --name-only apps/backend/lambdas/*/db-types.d.ts')
.toString()
.trim()
.split('\n')
.filter(f => f)
.map(f => `- \`${f}\``)
.join('\n');

const comment = `**Database Types Auto-Regenerated**

The database schema has changed and the Typescript definitions for these lambda functions were regenerated:
The database schema has changed and the shared TypeScript definitions were regenerated:

${files}
- \`shared/types/db-types.d.ts\`

The updated types are now in sync with schema changes.`;
All lambdas consume these types through the \`@branch/types\` package, so they are now in sync with the schema changes.`;

github.rest.issues.createComment({
issue_number: context.issue.number,
Expand Down Expand Up @@ -316,12 +284,7 @@ jobs:
echo "" >> $GITHUB_STEP_SUMMARY
echo "The following files were updated and committed:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY

for file in apps/backend/lambdas/*/db-types.d.ts; do
if [ -f "$file" ]; then
echo "- \`$file\`" >> $GITHUB_STEP_SUMMARY
fi
done
echo "- \`shared/types/db-types.d.ts\`" >> $GITHUB_STEP_SUMMARY

echo "" >> $GITHUB_STEP_SUMMARY
echo "**Next Steps:** The changes have been automatically committed to this PR. Review the updated types and merge when ready." >> $GITHUB_STEP_SUMMARY
Expand Down
3 changes: 0 additions & 3 deletions .gitmodules
View file
Open in desktop

This file was deleted.

79 changes: 0 additions & 79 deletions apps/backend/lambdas/auth/db-types.d.ts
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion apps/backend/lambdas/auth/db.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

import { Kysely, PostgresDialect } from 'kysely'
import { Pool } from 'pg'
import type { DB } from './db-types'
import type { DB } from '@branch/types'

const db = new Kysely<DB>({
dialect: new PostgresDialect({
Expand Down
Loading
Loading