Spaces:
Sleeping
Sleeping
File size: 30,795 Bytes
525d39f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 | # 08 - Development Guidelines
## 8.1 Project Structure
```
openwa/
βββ src/
β βββ main.ts # Application entry
β βββ app.module.ts # Root module
β β
β βββ common/ # Shared code
β β βββ decorators/
β β βββ dto/
β β βββ exceptions/
β β βββ filters/
β β βββ guards/
β β βββ interceptors/
β β βββ interfaces/
β β βββ pipes/
β β βββ utils/
β β
β βββ config/ # Configuration
β β βββ config.module.ts
β β βββ configuration.ts
β β
β βββ modules/ # Feature modules
β β βββ session/
β β βββ message/
β β βββ webhook/
β β βββ contact/
β β βββ group/
β β βββ auth/
β β βββ health/
β β
β βββ engine/ # WhatsApp engine
β β βββ engine.module.ts
β β βββ engine.service.ts
β β βββ interfaces/
β β
β βββ queue/ # Job queues
β β βββ queue.module.ts
β β βββ processors/
β β
β βββ database/ # Database
β βββ database.module.ts
β βββ entities/
β βββ migrations/
β
βββ test/ # Tests
β βββ unit/
β βββ integration/
β βββ e2e/
β
βββ dashboard/ # Frontend dashboard
β βββ src/
β βββ package.json
β
βββ docs/ # Documentation
βββ scripts/ # Utility scripts
βββ docker/ # Docker files
β
βββ .github/ # GitHub config
β βββ workflows/
β
βββ package.json
βββ tsconfig.json
βββ nest-cli.json
βββ .eslintrc.js
βββ .prettierrc
βββ docker-compose.yml
βββ README.md
```
## 8.2 Coding Standards
### TypeScript Configuration
```json
// tsconfig.json
{
"compilerOptions": {
"module": "commonjs",
"declaration": true,
"removeComments": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"allowSyntheticDefaultImports": true,
"target": "ES2022",
"sourceMap": true,
"outDir": "./dist",
"baseUrl": "./",
"incremental": true,
"skipLibCheck": true,
"strictNullChecks": true,
"noImplicitAny": true,
"strictBindCallApply": true,
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"paths": {
"@/*": ["src/*"],
"@common/*": ["src/common/*"],
"@modules/*": ["src/modules/*"],
"@config/*": ["src/config/*"]
}
}
}
```
### ESLint Configuration
```javascript
// .eslintrc.js
module.exports = {
parser: '@typescript-eslint/parser',
parserOptions: {
project: 'tsconfig.json',
sourceType: 'module',
},
plugins: ['@typescript-eslint/eslint-plugin'],
extends: [
'plugin:@typescript-eslint/recommended',
'plugin:prettier/recommended',
],
root: true,
env: {
node: true,
jest: true,
},
ignorePatterns: ['.eslintrc.js'],
rules: {
'@typescript-eslint/interface-name-prefix': 'off',
'@typescript-eslint/explicit-function-return-type': 'warn',
'@typescript-eslint/explicit-module-boundary-types': 'warn',
'@typescript-eslint/no-explicit-any': 'warn',
'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
'no-console': 'warn',
},
};
```
### Naming Conventions
```typescript
// Files: kebab-case
session.controller.ts
send-message.dto.ts
api-key.guard.ts
// Classes: PascalCase
class SessionController {}
class SendMessageDto {}
class ApiKeyGuard {}
// Interfaces: PascalCase with 'I' prefix (optional)
interface ISessionConfig {}
interface SessionConfig {} // Also acceptable
// Functions/Methods: camelCase
function createSession() {}
async sendMessage() {}
// Variables: camelCase
const sessionId = 'abc';
let messageCount = 0;
// Constants: UPPER_SNAKE_CASE
const MAX_RETRY_COUNT = 3;
const DEFAULT_TIMEOUT = 30000;
// Enums: PascalCase with PascalCase values
enum SessionStatus {
Created = 'created',
Ready = 'ready',
Disconnected = 'disconnected',
}
```
## 8.3 Module Structure
### Standard Module Template
```typescript
// modules/example/example.module.ts
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { ExampleController } from './example.controller';
import { ExampleService } from './example.service';
import { ExampleRepository } from './example.repository';
import { Example } from './entities/example.entity';
@Module({
imports: [TypeOrmModule.forFeature([Example])],
controllers: [ExampleController],
providers: [ExampleService, ExampleRepository],
exports: [ExampleService],
})
export class ExampleModule {}
```
### Controller Template
```typescript
// modules/example/example.controller.ts
import {
Controller,
Get,
Post,
Body,
Headers,
Param,
Delete,
UseGuards,
HttpCode,
HttpStatus,
} from '@nestjs/common';
import { ApiTags, ApiOperation, ApiResponse } from '@nestjs/swagger';
import { ApiKeyGuard } from '@common/guards/api-key.guard';
import { ExampleService } from './example.service';
import { CreateExampleDto } from './dto/create-example.dto';
import { ExampleResponseDto } from './dto/example-response.dto';
@ApiTags('examples')
@Controller('examples')
@UseGuards(ApiKeyGuard)
export class ExampleController {
constructor(private readonly exampleService: ExampleService) {}
@Post()
@HttpCode(HttpStatus.CREATED)
@ApiOperation({ summary: 'Create example' })
@ApiResponse({ status: 201, type: ExampleResponseDto })
async create(
@Body() dto: CreateExampleDto,
@Headers('x-request-id') requestId?: string
): Promise<ExampleResponseDto> {
return this.exampleService.create(dto, { requestId });
}
@Get(':id')
@ApiOperation({ summary: 'Get example by ID' })
@ApiResponse({ status: 200, type: ExampleResponseDto })
async findOne(@Param('id') id: string): Promise<ExampleResponseDto> {
return this.exampleService.findOne(id);
}
@Delete(':id')
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({ summary: 'Delete example' })
async remove(@Param('id') id: string): Promise<void> {
return this.exampleService.remove(id);
}
}
```
### Service Template
```typescript
// modules/example/example.service.ts
import { Injectable, NotFoundException, Logger } from '@nestjs/common';
import { ExampleRepository } from './example.repository';
import { CreateExampleDto } from './dto/create-example.dto';
import { Example } from './entities/example.entity';
@Injectable()
export class ExampleService {
private readonly logger = new Logger(ExampleService.name);
constructor(private readonly repository: ExampleRepository) {}
async create(
dto: CreateExampleDto,
context?: { requestId?: string }
): Promise<Example> {
this.logger.log(`Creating example: ${dto.name}`, context);
const example = this.repository.create(dto);
return this.repository.save(example);
}
async findOne(id: string): Promise<Example> {
const example = await this.repository.findOne({ where: { id } });
if (!example) {
throw new NotFoundException(`Example with ID ${id} not found`);
}
return example;
}
async remove(id: string): Promise<void> {
const example = await this.findOne(id);
await this.repository.remove(example);
this.logger.log(`Deleted example: ${id}`);
}
}
```
### DTO Template
```typescript
// modules/example/dto/create-example.dto.ts
import { IsString, IsOptional, MaxLength, IsUrl } from 'class-validator';
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
export class CreateExampleDto {
@ApiProperty({ description: 'Example name', example: 'My Example' })
@IsString()
@MaxLength(100)
name: string;
@ApiPropertyOptional({ description: 'Optional description' })
@IsOptional()
@IsString()
@MaxLength(500)
description?: string;
@ApiPropertyOptional({ description: 'Callback URL' })
@IsOptional()
@IsUrl({ protocols: ['https'] })
callbackUrl?: string;
}
```
## 8.4 Git Workflow
### Branch Strategy
```mermaid
gitGraph
commit id: "initial"
branch develop
commit id: "setup"
branch feature/session-api
commit id: "session controller"
commit id: "session service"
checkout develop
merge feature/session-api
branch feature/webhook
commit id: "webhook impl"
checkout develop
merge feature/webhook
checkout main
merge develop tag: "v1.0.0"
checkout develop
branch hotfix/bug-fix
commit id: "fix bug"
checkout main
merge hotfix/bug-fix tag: "v1.0.1"
checkout develop
merge hotfix/bug-fix
```
### Branch Naming
```
main # Production-ready code
develop # Integration branch
feature/* # New features
bugfix/* # Bug fixes
hotfix/* # Production hotfixes
release/* # Release preparation
Examples:
feature/session-management
feature/webhook-retry
bugfix/qr-code-timeout
hotfix/security-patch
release/1.0.0
```
### Commit Message Convention
```
<type>(<scope>): <subject>
<body>
<footer>
Types:
- feat: New feature
- fix: Bug fix
- docs: Documentation
- style: Formatting (no code change)
- refactor: Code refactoring
- test: Adding tests
- chore: Maintenance
Examples:
feat(session): add multi-session support
- Implement session manager for multiple sessions
- Add session limit configuration
- Update documentation
Closes #123
fix(webhook): handle timeout errors gracefully
Previously, webhook timeouts would crash the worker.
Now they are caught and logged properly.
Fixes #456
```
### Pull Request Template
```markdown
## Description
Brief description of changes
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
## Checklist
- [ ] Tests added/updated
- [ ] Documentation updated
- [ ] Lint passes
- [ ] Self-reviewed
## Screenshots (if applicable)
## Related Issues
Closes #
```
## 8.5 Testing Guidelines
### Test Structure
```
test/
βββ unit/ # Unit tests
β βββ services/
β β βββ session.service.spec.ts
β β βββ message.service.spec.ts
β βββ utils/
β βββ encryption.spec.ts
β
βββ integration/ # Integration tests
β βββ session.integration.spec.ts
β βββ webhook.integration.spec.ts
β
βββ e2e/ # End-to-end tests
βββ app.e2e-spec.ts
βββ session.e2e-spec.ts
```
### Unit Test Example
```typescript
// test/unit/services/session.service.spec.ts
import { Test, TestingModule } from '@nestjs/testing';
import { SessionService } from '@modules/session/session.service';
import { SessionRepository } from '@modules/session/session.repository';
import { EngineService } from '@engine/engine.service';
describe('SessionService', () => {
let service: SessionService;
let repository: jest.Mocked<SessionRepository>;
let engineService: jest.Mocked<EngineService>;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
SessionService,
{
provide: SessionRepository,
useValue: {
create: jest.fn(),
save: jest.fn(),
findOne: jest.fn(),
delete: jest.fn(),
},
},
{
provide: EngineService,
useValue: {
createClient: jest.fn(),
destroyClient: jest.fn(),
},
},
],
}).compile();
service = module.get<SessionService>(SessionService);
repository = module.get(SessionRepository);
engineService = module.get(EngineService);
});
describe('create', () => {
it('should create a new session', async () => {
const dto = { name: 'test-session' };
const session = { id: 'uuid', ...dto, status: 'created' };
repository.create.mockReturnValue(session as any);
repository.save.mockResolvedValue(session as any);
const result = await service.create(dto);
expect(result).toEqual(session);
expect(repository.create).toHaveBeenCalledWith(dto);
expect(repository.save).toHaveBeenCalled();
});
it('should throw error if name already exists', async () => {
const dto = { name: 'existing-session' };
repository.save.mockRejectedValue({ code: '23505' }); // Unique violation
await expect(service.create(dto)).rejects.toThrow();
});
});
});
```
### E2E Test Example
```typescript
// test/e2e/session.e2e-spec.ts
import { Test, TestingModule } from '@nestjs/testing';
import { INestApplication } from '@nestjs/common';
import * as request from 'supertest';
import { AppModule } from '@/app.module';
describe('Session (e2e)', () => {
let app: INestApplication;
const apiKey = 'test-api-key';
beforeAll(async () => {
const moduleFixture: TestingModule = await Test.createTestingModule({
imports: [AppModule],
}).compile();
app = moduleFixture.createNestApplication();
await app.init();
});
afterAll(async () => {
await app.close();
});
describe('POST /api/sessions', () => {
it('should create a session', () => {
return request(app.getHttpServer())
.post('/api/sessions')
.set('X-API-Key', apiKey)
.send({ name: 'e2e-test-session' })
.expect(201)
.expect((res) => {
expect(res.body.success).toBe(true);
expect(res.body.data.name).toBe('e2e-test-session');
expect(res.body.data.status).toBe('created');
});
});
it('should return 401 without API key', () => {
return request(app.getHttpServer())
.post('/api/sessions')
.send({ name: 'test' })
.expect(401);
});
});
});
```
### Test Coverage Requirements
| Type | Minimum Coverage |
|------|-----------------|
| Unit Tests | 80% |
| Integration Tests | 60% |
| E2E Tests | Critical paths |
## 8.6 Documentation Standards
### Code Documentation
```typescript
/**
* Session service handles all session-related operations.
*
* @example
* ```typescript
* const session = await sessionService.create({ name: 'my-bot' });
* console.log(session.id);
* ```
*/
@Injectable()
export class SessionService {
/**
* Creates a new WhatsApp session.
*
* @param dto - Session creation parameters
* @returns The created session with QR code if applicable
* @throws {ConflictException} If session name already exists
* @throws {ServiceUnavailableException} If max sessions reached
*/
async create(dto: CreateSessionDto): Promise<Session> {
// Implementation
}
}
```
### API Documentation (Swagger)
```typescript
@ApiTags('sessions')
@Controller('sessions')
export class SessionController {
@Post()
@ApiOperation({
summary: 'Create a new session',
description: 'Creates a new WhatsApp session and returns QR code for authentication',
})
@ApiBody({ type: CreateSessionDto })
@ApiResponse({
status: 201,
description: 'Session created successfully',
type: SessionResponseDto,
})
@ApiResponse({
status: 409,
description: 'Session name already exists',
})
async create(@Body() dto: CreateSessionDto): Promise<SessionResponseDto> {
// Implementation
}
}
```
## 8.7 Error Handling
### Custom Exception Classes
```typescript
// common/exceptions/business.exception.ts
export class BusinessException extends HttpException {
constructor(
public readonly code: string,
message: string,
statusCode: HttpStatus = HttpStatus.BAD_REQUEST,
public readonly details?: Record<string, any>,
) {
super({ code, message, details }, statusCode);
}
}
// Usage
throw new BusinessException(
'SESSION_NOT_READY',
'Session is not ready to send messages',
HttpStatus.BAD_REQUEST,
{ sessionId, currentStatus: session.status }
);
```
### Global Exception Filter
```typescript
// common/filters/http-exception.filter.ts
@Catch()
export class AllExceptionsFilter implements ExceptionFilter {
private readonly logger = new Logger(AllExceptionsFilter.name);
catch(exception: unknown, host: ArgumentsHost): void {
const ctx = host.switchToHttp();
const response = ctx.getResponse<Response>();
const request = ctx.getRequest<Request>();
const status = exception instanceof HttpException
? exception.getStatus()
: HttpStatus.INTERNAL_SERVER_ERROR;
const errorResponse = this.formatError(exception, request);
this.logger.error(
`${request.method} ${request.url} - ${status}`,
exception instanceof Error ? exception.stack : undefined,
);
response.status(status).json(errorResponse);
}
private formatError(exception: unknown, request: Request) {
return {
success: false,
error: {
code: this.getErrorCode(exception),
message: this.getErrorMessage(exception),
details: this.getErrorDetails(exception),
},
meta: {
timestamp: new Date().toISOString(),
requestId: request.headers['x-request-id'],
path: request.url,
},
};
}
}
```
---
## 8.8 Environment Setup
### Prerequisites
```bash
# Required
- Node.js 20 LTS
- npm 10+
- Docker & Docker Compose
- Git
# Optional (for development)
- VS Code with extensions
- Postman or Insomnia
- pgAdmin or DBeaver
```
### Quick Start
```bash
# 1. Clone repository
git clone https://github.com/rmyndharis/OpenWA.git
cd openwa
# 2. Install dependencies
npm install
# 3. Copy environment file
cp .env.example .env
# 4. Start infrastructure services
docker compose up -d postgres redis
# 5. Run database migrations
npm run migration:run
# 6. Start development server
npm run start:dev
```
### VS Code Extensions
```json
// .vscode/extensions.json
{
"recommendations": [
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"ms-azuretools.vscode-docker",
"prisma.prisma",
"humao.rest-client",
"bradlc.vscode-tailwindcss",
"orta.vscode-jest"
]
}
```
### VS Code Settings
```json
// .vscode/settings.json
{
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"typescript.preferences.importModuleSpecifier": "relative",
"files.exclude": {
"**/node_modules": true,
"**/dist": true
}
}
```
### Environment Variables
OpenWA supports multiple infrastructure configurations. Choose based on your needs:
#### Minimal Profile (Development / Single Session)
```bash
# .env.example (Minimal Profile)
# Application
NODE_ENV=development
PORT=2785
LOG_LEVEL=debug
# Database: SQLite (zero config)
DATABASE_TYPE=sqlite
DATABASE_SQLITE_PATH=./data/openwa.db
# Storage: Local filesystem
STORAGE_TYPE=local
STORAGE_LOCAL_PATH=./media
# Cache: In-memory (no Redis needed)
CACHE_TYPE=memory
# Security
ENCRYPTION_KEY=dev-encryption-key-change-in-production
API_KEY_MASTER=dev-master-key-change-in-production
# Session
SESSION_DATA_PATH=./.wwebjs_auth
MAX_SESSIONS=3
# Engine
ENGINE_TYPE=whatsapp-web.js
PUPPETEER_HEADLESS=true
# Development
SWAGGER_ENABLED=true
```
#### Standard Profile (Production / Multi-Session)
```bash
# .env.example (Standard Profile)
# Application
NODE_ENV=production
PORT=2785
LOG_LEVEL=info
# Database: PostgreSQL
DATABASE_TYPE=postgres
DATABASE_URL=postgresql://openwa:openwa@localhost:5432/openwa
# Storage: Local filesystem
STORAGE_TYPE=local
STORAGE_LOCAL_PATH=./media
# Cache: Redis
CACHE_TYPE=redis
REDIS_URL=redis://localhost:6379
# Security (generate with: openssl rand -base64 32)
ENCRYPTION_KEY=your-32-byte-encryption-key-here
API_KEY_MASTER=your-secure-master-key
# Session
SESSION_DATA_PATH=./.wwebjs_auth
MAX_SESSIONS=10
# Engine
ENGINE_TYPE=whatsapp-web.js
PUPPETEER_HEADLESS=true
# Development
SWAGGER_ENABLED=true
```
> [!TIP]
> For development, use the **Minimal Profile** with SQLite. No need to set up PostgreSQL or Redis.
## 8.9 Debugging Guide
### NestJS Debugging
```json
// .vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug NestJS",
"type": "node",
"request": "launch",
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "start:debug"],
"console": "integratedTerminal",
"restart": true,
"autoAttachChildProcesses": true
},
{
"name": "Debug Tests",
"type": "node",
"request": "launch",
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "test:debug"],
"console": "integratedTerminal"
}
]
}
```
### Logging Best Practices
```typescript
// Use Logger from NestJS
import { Logger, Inject, Scope } from '@nestjs/common';
import { REQUEST } from '@nestjs/core';
import { Request } from 'express';
@Injectable({ scope: Scope.REQUEST })
export class MyService {
private readonly logger = new Logger(MyService.name);
constructor(@Inject(REQUEST) private readonly request: Request) {}
async doSomething(id: string): Promise<void> {
// Log entry with context
const requestId = this.request?.requestId;
this.logger.log(`Processing item`, { id, requestId });
try {
await this.process(id);
this.logger.log(`Item processed successfully`, { id, requestId });
} catch (error) {
// Log error with full stack
this.logger.error(`Failed to process item`, error.stack, { id, requestId });
throw error;
}
}
}
```
> [!NOTE]
> Propagate `X-Request-ID` from controller to service and include it in all logs for easier cross-component tracing.
### Request ID Interceptor (Optional)
Use an interceptor to ensure every request has a `requestId` and propagate it to the response header.
```typescript
// common/interceptors/request-id.interceptor.ts
import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
import { Observable } from 'rxjs';
@Injectable()
export class RequestIdInterceptor implements NestInterceptor {
intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
const request = context.switchToHttp().getRequest();
const response = context.switchToHttp().getResponse();
const requestId = request.headers['x-request-id'] || `req_${Date.now()}`;
request.requestId = requestId;
response.setHeader('X-Request-ID', requestId);
return next.handle();
}
}
```
```typescript
// main.ts
async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.useGlobalInterceptors(new RequestIdInterceptor());
await app.listen(3000);
}
```
> [!NOTE]
> If you use `REQUEST` injection in a service, make sure the provider is **request-scoped** (`@Injectable({ scope: Scope.REQUEST })`) so requestId does not get mixed across requests.
### Debug WhatsApp Engine
```typescript
// Enable verbose logging for whatsapp-web.js
const client = new Client({
puppeteer: {
headless: false, // See browser window
devtools: true, // Open DevTools automatically
},
});
// Log all events for debugging
const events = ['qr', 'ready', 'authenticated', 'disconnected', 'message'];
events.forEach(event => {
client.on(event, (...args) => {
console.log(`[WA Event: ${event}]`, JSON.stringify(args, null, 2));
});
});
```
### Common Debugging Commands
```bash
# Run single test file
npm test -- session.service.spec.ts
# Run tests with verbose output
npm test -- --verbose
# Check for TypeScript errors
npm run build -- --noEmit
# Lint with auto-fix
npm run lint -- --fix
# Debug database queries (TypeORM)
# Add to .env: DEBUG=typeorm:query
# View Docker logs
docker compose logs -f app
```
## 8.10 Performance Best Practices
### Database Queries
```typescript
// β Bad: N+1 query problem
const sessions = await sessionRepo.find();
for (const session of sessions) {
session.webhooks = await webhookRepo.find({ where: { sessionId: session.id } });
}
// β
Good: Use relations
const sessions = await sessionRepo.find({
relations: ['webhooks'],
});
// β
Good: Use QueryBuilder for complex queries
const sessions = await sessionRepo
.createQueryBuilder('session')
.leftJoinAndSelect('session.webhooks', 'webhook')
.where('session.status = :status', { status: 'ready' })
.orderBy('session.createdAt', 'DESC')
.take(10)
.getMany();
```
### Caching Strategy
```typescript
// Cache frequently accessed data
@Injectable()
export class SessionService {
constructor(
private readonly cache: CacheService,
private readonly repo: SessionRepository,
) {}
async getSession(id: string): Promise<Session> {
// Check cache first
const cached = await this.cache.get<Session>(`session:${id}`);
if (cached) return cached;
// Fetch from database
const session = await this.repo.findOne({ where: { id } });
// Cache for 5 minutes
await this.cache.set(`session:${id}`, session, 300);
return session;
}
async updateSession(id: string, data: Partial<Session>): Promise<Session> {
const session = await this.repo.update(id, data);
// Invalidate cache
await this.cache.del(`session:${id}`);
return session;
}
}
```
### Async Operations
```typescript
// β Bad: Sequential execution
const contact1 = await getContact('id1');
const contact2 = await getContact('id2');
const contact3 = await getContact('id3');
// β
Good: Parallel execution
const [contact1, contact2, contact3] = await Promise.all([
getContact('id1'),
getContact('id2'),
getContact('id3'),
]);
// β
Good: Batch processing with concurrency limit
import pLimit from 'p-limit';
const limit = pLimit(5); // Max 5 concurrent
const results = await Promise.all(
chatIds.map(id => limit(() => sendMessage(id, text)))
);
```
### Memory Management
```typescript
// Session cleanup to prevent memory leaks
@Injectable()
export class SessionCleanupService {
private readonly logger = new Logger(SessionCleanupService.name);
@Cron('0 */5 * * * *') // Every 5 minutes
async cleanupInactiveSessions(): Promise<void> {
const inactiveThreshold = new Date(Date.now() - 30 * 60 * 1000); // 30 min
const inactiveSessions = await this.sessionRepo.find({
where: {
status: 'disconnected',
updatedAt: LessThan(inactiveThreshold),
},
});
for (const session of inactiveSessions) {
await this.engineService.destroy(session.id);
this.logger.log(`Cleaned up inactive session: ${session.id}`);
}
}
}
```
## 8.11 Common Gotchas & Troubleshooting
### WhatsApp Engine Issues
```markdown
## QR Code Not Generated
**Symptom:** Session stuck in 'initializing' status
**Causes & Solutions:**
1. **Chrome/Puppeteer issue**
- Ensure Chromium is installed: `which chromium`
- Check Puppeteer args: `--no-sandbox --disable-setuid-sandbox`
2. **Previous session data corrupted**
- Clear session folder: `rm -rf .wwebjs_auth/session-{id}`
3. **WhatsApp rate limit**
- Wait 5-10 minutes before retrying
## Session Disconnects Randomly
**Causes & Solutions:**
1. **Memory pressure**
- Monitor memory: `docker stats`
- Increase container memory limit
2. **Network issues**
- Check WebSocket connection stability
- Implement auto-reconnect logic
3. **WhatsApp detected automation**
- Add random delays between messages
- Avoid sending too many messages quickly
```
### Database Issues
```markdown
## Connection Pool Exhausted
**Symptom:** "too many clients already" error
**Solution:**
```typescript
// config/typeorm.config.ts
{
type: 'postgres',
// Limit pool size
extra: {
max: 20, // Default is 10
connectionTimeoutMillis: 5000,
idleTimeoutMillis: 30000,
},
}
```
## Migration Fails
**Symptom:** "relation already exists" error
**Solution:**
```bash
# Check migration status
npm run migration:show
# Revert last migration
npm run migration:revert
# Regenerate migration
npm run migration:generate -- -n FixMigration
```
```
### TypeScript/NestJS Issues
```markdown
## Circular Dependency
**Symptom:** "Cannot read property 'X' of undefined"
**Solution:**
```typescript
// Use forwardRef for circular deps
@Module({
imports: [
forwardRef(() => SessionModule),
],
})
export class WebhookModule {}
// In service
constructor(
@Inject(forwardRef(() => SessionService))
private readonly sessionService: SessionService,
) {}
```
## DI Token Not Found
**Symptom:** "Nest can't resolve dependencies"
**Solution:**
- Ensure provider is exported from its module
- Check if module is imported where needed
- Use @Injectable() decorator on services
```
### Docker Issues
```markdown
## Container Keeps Restarting
**Check logs:**
```bash
docker compose logs app --tail 100
```
**Common causes:**
1. Missing environment variables
2. Database not ready (use depends_on + healthcheck)
3. Port already in use
## Chrome Crashes in Docker
**Solution:**
```dockerfile
# Add shared memory size
docker run --shm-size=2gb openwa
```
Or in docker-compose.yml:
```yaml
services:
app:
shm_size: '2gb'
```
```
## 8.12 Contributing Guide
### Getting Started
```markdown
1. Fork the repository
2. Create feature branch: `git checkout -b feature/amazing-feature`
3. Make changes following our coding standards
4. Write/update tests
5. Run linter: `npm run lint`
6. Run tests: `npm test`
7. Commit: `git commit -m 'feat(scope): add amazing feature'`
8. Push: `git push origin feature/amazing-feature`
9. Open Pull Request
```
### Code Review Checklist
```markdown
- [ ] Code follows project style guide
- [ ] Tests are included and passing
- [ ] Documentation is updated
- [ ] No console.log statements
- [ ] Error handling is proper
- [ ] No hardcoded values
- [ ] Security considerations addressed
- [ ] Performance impact considered
```
### Issue Reporting
```markdown
**Bug Report Template:**
- **Description:** Clear description of the bug
- **Steps to Reproduce:** Numbered steps
- **Expected Behavior:** What should happen
- **Actual Behavior:** What actually happens
- **Environment:** Node version, OS, Docker version
- **Logs:** Relevant error logs
```
---
<div align="center">
[β 07 - API Collection](./07-api-collection.md) Β· [Documentation Index](./README.md) Β· [Next: 09 - Testing Strategy β](./09-testing-strategy.md)
</div>
|