@friggframework/devtools 2.0.0--canary.517.f738cdd.0 → 2.0.0--canary.531.eec57c3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,211 @@
1
+ /**
2
+ * Scheduler Builder
3
+ *
4
+ * Domain Layer - Hexagonal Architecture
5
+ *
6
+ * Responsible for:
7
+ * - Creating EventBridge Scheduler ScheduleGroup resource
8
+ * - Creating IAM Role for EventBridge Scheduler to send messages to SQS
9
+ * - Adding necessary IAM statements for Lambda to create/delete schedules
10
+ *
11
+ * This builder enables integrations to schedule one-time jobs (e.g., webhook renewals)
12
+ * using AWS EventBridge Scheduler.
13
+ */
14
+
15
+ const { InfrastructureBuilder, ValidationResult } = require('../shared/base-builder');
16
+
17
+ class SchedulerBuilder extends InfrastructureBuilder {
18
+ constructor() {
19
+ super();
20
+ this.name = 'SchedulerBuilder';
21
+ }
22
+
23
+ shouldExecute(appDefinition) {
24
+ // Enable scheduler if explicitly enabled or if any integration has webhooks
25
+ // (webhooks often need renewal scheduling)
26
+ if (appDefinition.scheduler?.enable === true) {
27
+ return true;
28
+ }
29
+
30
+ // Check if any integration has webhooks enabled
31
+ if (Array.isArray(appDefinition.integrations)) {
32
+ return appDefinition.integrations.some(
33
+ (integration) =>
34
+ integration?.Definition?.webhooks?.enabled === true ||
35
+ integration?.Definition?.webhooks === true
36
+ );
37
+ }
38
+
39
+ return false;
40
+ }
41
+
42
+ getDependencies() {
43
+ return ['IntegrationBuilder']; // Needs integration queues to exist
44
+ }
45
+
46
+ validate(appDefinition) {
47
+ const result = new ValidationResult();
48
+ // No validation required - scheduler is optional
49
+ return result;
50
+ }
51
+
52
+ async build(appDefinition, discoveredResources) {
53
+ console.log(`\n[${this.name}] Configuring EventBridge Scheduler...`);
54
+
55
+ const result = {
56
+ functions: {},
57
+ resources: {},
58
+ environment: {},
59
+ custom: {},
60
+ iamStatements: [],
61
+ };
62
+
63
+ // Create ScheduleGroup resource
64
+ this.createScheduleGroup(result);
65
+
66
+ // Create IAM Role for EventBridge Scheduler
67
+ this.createSchedulerExecutionRole(appDefinition, result);
68
+
69
+ // Add IAM statements for Lambda to manage schedules
70
+ this.addSchedulerIamStatements(result);
71
+
72
+ // Add environment variables
73
+ this.addEnvironmentVariables(result);
74
+
75
+ console.log(`[${this.name}] ✅ Scheduler configuration completed`);
76
+ return result;
77
+ }
78
+
79
+ /**
80
+ * Create EventBridge Scheduler ScheduleGroup
81
+ * Uses stage-specific naming to allow multiple deployments in same AWS account
82
+ */
83
+ createScheduleGroup(result) {
84
+ const scheduleGroupName = '${self:service}-${self:provider.stage}-schedules';
85
+
86
+ result.resources.FriggScheduleGroup = {
87
+ Type: 'AWS::Scheduler::ScheduleGroup',
88
+ Properties: {
89
+ Name: scheduleGroupName,
90
+ },
91
+ };
92
+
93
+ console.log(` ✓ Created ScheduleGroup: ${scheduleGroupName}`);
94
+ }
95
+
96
+ /**
97
+ * Create IAM Role for EventBridge Scheduler to send messages to SQS
98
+ */
99
+ createSchedulerExecutionRole(appDefinition, result) {
100
+ // Collect all integration queue ARNs
101
+ const queueArns = [];
102
+ if (Array.isArray(appDefinition.integrations)) {
103
+ appDefinition.integrations.forEach((integration) => {
104
+ const integrationName = integration?.Definition?.name;
105
+ if (integrationName) {
106
+ const capitalizedName =
107
+ integrationName.charAt(0).toUpperCase() +
108
+ integrationName.slice(1);
109
+ queueArns.push({
110
+ 'Fn::GetAtt': [`${capitalizedName}Queue`, 'Arn'],
111
+ });
112
+ }
113
+ });
114
+ }
115
+
116
+ // If no queues found, use a placeholder (shouldn't happen if IntegrationBuilder ran)
117
+ if (queueArns.length === 0) {
118
+ console.warn(
119
+ ' ⚠ No integration queues found for scheduler role'
120
+ );
121
+ queueArns.push('arn:aws:sqs:*:*:*'); // Fallback
122
+ }
123
+
124
+ result.resources.SchedulerExecutionRole = {
125
+ Type: 'AWS::IAM::Role',
126
+ Properties: {
127
+ RoleName:
128
+ '${self:service}-${self:provider.stage}-scheduler-role',
129
+ AssumeRolePolicyDocument: {
130
+ Version: '2012-10-17',
131
+ Statement: [
132
+ {
133
+ Effect: 'Allow',
134
+ Principal: {
135
+ Service: 'scheduler.amazonaws.com',
136
+ },
137
+ Action: 'sts:AssumeRole',
138
+ },
139
+ ],
140
+ },
141
+ Policies: [
142
+ {
143
+ PolicyName: 'SchedulerSQSPolicy',
144
+ PolicyDocument: {
145
+ Version: '2012-10-17',
146
+ Statement: [
147
+ {
148
+ Effect: 'Allow',
149
+ Action: ['sqs:SendMessage'],
150
+ Resource: queueArns,
151
+ },
152
+ ],
153
+ },
154
+ },
155
+ ],
156
+ },
157
+ };
158
+
159
+ console.log(' ✓ Created SchedulerExecutionRole');
160
+ }
161
+
162
+ /**
163
+ * Add IAM statements for Lambda functions to manage schedules
164
+ */
165
+ addSchedulerIamStatements(result) {
166
+ result.iamStatements.push(
167
+ {
168
+ Effect: 'Allow',
169
+ Action: [
170
+ 'scheduler:CreateSchedule',
171
+ 'scheduler:DeleteSchedule',
172
+ 'scheduler:GetSchedule',
173
+ ],
174
+ Resource: {
175
+ 'Fn::Sub': [
176
+ 'arn:aws:scheduler:${AWS::Region}:${AWS::AccountId}:schedule/${GroupName}/*',
177
+ { GroupName: { Ref: 'FriggScheduleGroup' } },
178
+ ],
179
+ },
180
+ },
181
+ {
182
+ Effect: 'Allow',
183
+ Action: ['iam:PassRole'],
184
+ Resource: { 'Fn::GetAtt': ['SchedulerExecutionRole', 'Arn'] },
185
+ Condition: {
186
+ StringEquals: {
187
+ 'iam:PassedToService': 'scheduler.amazonaws.com',
188
+ },
189
+ },
190
+ }
191
+ );
192
+
193
+ console.log(' ✓ Added scheduler IAM statements');
194
+ }
195
+
196
+ /**
197
+ * Add environment variables for scheduler configuration
198
+ */
199
+ addEnvironmentVariables(result) {
200
+ result.environment.SCHEDULER_ROLE_ARN = {
201
+ 'Fn::GetAtt': ['SchedulerExecutionRole', 'Arn'],
202
+ };
203
+ result.environment.SCHEDULE_GROUP_NAME = {
204
+ Ref: 'FriggScheduleGroup',
205
+ };
206
+
207
+ console.log(' ✓ Added scheduler environment variables');
208
+ }
209
+ }
210
+
211
+ module.exports = { SchedulerBuilder };
@@ -106,25 +106,6 @@
106
106
  * @property {string} Definition.name - Integration name
107
107
  */
108
108
 
109
- /**
110
- * Admin script definition
111
- * @typedef {Object} AdminScriptDefinition
112
- * @property {Object} Definition - Static definition from script class
113
- * @property {string} Definition.name - Script name identifier
114
- * @property {string} Definition.version - Script version (semver)
115
- * @property {string} [Definition.description] - Human-readable description
116
- * @property {Object} [Definition.schedule] - Schedule configuration
117
- * @property {boolean} [Definition.schedule.enabled] - Whether scheduling is enabled
118
- * @property {string} [Definition.schedule.cronExpression] - Cron expression
119
- */
120
-
121
- /**
122
- * Admin configuration
123
- * @typedef {Object} AdminConfig
124
- * @property {boolean} [includeBuiltinScripts] - Whether to include built-in scripts
125
- * @property {boolean} [enableScheduling] - Whether to enable EventBridge scheduling
126
- */
127
-
128
109
  /**
129
110
  * Complete application definition
130
111
  * @typedef {Object} AppDefinition
@@ -141,8 +122,6 @@
141
122
  * @property {MigrationDefinition} [migrations] - Database migration configuration
142
123
  * @property {WebsocketDefinition} [websockets] - WebSocket API configuration
143
124
  * @property {IntegrationDefinition[]} [integrations] - Integration definitions
144
- * @property {AdminScriptDefinition[]} [adminScripts] - Admin script definitions
145
- * @property {AdminConfig} [admin] - Admin configuration
146
125
  *
147
126
  * @property {Object} [environment] - Environment variables
148
127
  */
@@ -16,7 +16,7 @@ const { MigrationBuilder } = require('./domains/database/migration-builder');
16
16
  const { SsmBuilder } = require('./domains/parameters/ssm-builder');
17
17
  const { WebsocketBuilder } = require('./domains/integration/websocket-builder');
18
18
  const { IntegrationBuilder } = require('./domains/integration/integration-builder');
19
- const { AdminScriptBuilder } = require('./domains/admin-scripts/admin-script-builder');
19
+ const { SchedulerBuilder } = require('./domains/scheduler/scheduler-builder');
20
20
 
21
21
  // Utilities
22
22
  const { modifyHandlerPaths } = require('./domains/shared/utilities/handler-path-resolver');
@@ -52,7 +52,7 @@ const composeServerlessDefinition = async (AppDefinition) => {
52
52
  new SsmBuilder(),
53
53
  new WebsocketBuilder(),
54
54
  new IntegrationBuilder(),
55
- new AdminScriptBuilder(),
55
+ new SchedulerBuilder(), // Add scheduler after IntegrationBuilder (depends on it)
56
56
  ]);
57
57
 
58
58
  // Build all infrastructure (orchestrator handles validation, dependencies, parallel execution)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@friggframework/devtools",
3
3
  "prettier": "@friggframework/prettier-config",
4
- "version": "2.0.0--canary.517.f738cdd.0",
4
+ "version": "2.0.0--canary.531.eec57c3.0",
5
5
  "bin": {
6
6
  "frigg": "./frigg-cli/index.js"
7
7
  },
@@ -25,9 +25,9 @@
25
25
  "@babel/eslint-parser": "^7.18.9",
26
26
  "@babel/parser": "^7.25.3",
27
27
  "@babel/traverse": "^7.25.3",
28
- "@friggframework/core": "2.0.0--canary.517.f738cdd.0",
29
- "@friggframework/schemas": "2.0.0--canary.517.f738cdd.0",
30
- "@friggframework/test": "2.0.0--canary.517.f738cdd.0",
28
+ "@friggframework/core": "2.0.0--canary.531.eec57c3.0",
29
+ "@friggframework/schemas": "2.0.0--canary.531.eec57c3.0",
30
+ "@friggframework/test": "2.0.0--canary.531.eec57c3.0",
31
31
  "@hapi/boom": "^10.0.1",
32
32
  "@inquirer/prompts": "^5.3.8",
33
33
  "axios": "^1.7.2",
@@ -55,8 +55,8 @@
55
55
  "validate-npm-package-name": "^5.0.0"
56
56
  },
57
57
  "devDependencies": {
58
- "@friggframework/eslint-config": "2.0.0--canary.517.f738cdd.0",
59
- "@friggframework/prettier-config": "2.0.0--canary.517.f738cdd.0",
58
+ "@friggframework/eslint-config": "2.0.0--canary.531.eec57c3.0",
59
+ "@friggframework/prettier-config": "2.0.0--canary.531.eec57c3.0",
60
60
  "aws-sdk-client-mock": "^4.1.0",
61
61
  "aws-sdk-client-mock-jest": "^4.1.0",
62
62
  "jest": "^30.1.3",
@@ -88,5 +88,5 @@
88
88
  "publishConfig": {
89
89
  "access": "public"
90
90
  },
91
- "gitHead": "f738cdd2e74529b3719a974c44e39e08cbf24313"
91
+ "gitHead": "eec57c3f5045f0392b26b97e5a12041b14986219"
92
92
  }
@@ -1,200 +0,0 @@
1
- /**
2
- * Admin Script Builder
3
- *
4
- * Domain Layer - Hexagonal Architecture
5
- *
6
- * Responsible for:
7
- * - Creating SQS queue for admin script execution
8
- * - Creating Lambda function for script execution (worker)
9
- * - Creating Lambda function for admin API routes (router)
10
- * - Creating EventBridge Scheduler resources (Phase 2)
11
- * - Creating IAM roles for scheduler to invoke Lambda
12
- */
13
-
14
- const { InfrastructureBuilder, ValidationResult } = require('../shared/base-builder');
15
-
16
- class AdminScriptBuilder extends InfrastructureBuilder {
17
- constructor() {
18
- super();
19
- this.name = 'AdminScriptBuilder';
20
- }
21
-
22
- shouldExecute(appDefinition) {
23
- return Array.isArray(appDefinition.adminScripts) && appDefinition.adminScripts.length > 0;
24
- }
25
-
26
- getDependencies() {
27
- return []; // Can run independently
28
- }
29
-
30
- validate(appDefinition) {
31
- const result = new ValidationResult();
32
-
33
- if (!appDefinition.adminScripts) {
34
- return result; // Not an error, just no scripts
35
- }
36
-
37
- if (!Array.isArray(appDefinition.adminScripts)) {
38
- result.addError('adminScripts must be an array');
39
- return result;
40
- }
41
-
42
- // Validate each script
43
- appDefinition.adminScripts.forEach((script, index) => {
44
- if (!script?.Definition?.name) {
45
- result.addError(`Admin script at index ${index} is missing Definition or name`);
46
- }
47
- });
48
-
49
- return result;
50
- }
51
-
52
- async build(appDefinition, discoveredResources) {
53
- console.log(`\n[${this.name}] Configuring admin scripts...`);
54
- console.log(` Processing ${appDefinition.adminScripts.length} scripts...`);
55
-
56
- const usePrismaLayer = appDefinition.usePrismaLambdaLayer !== false;
57
- const adminConfig = appDefinition.admin || {};
58
-
59
- const result = {
60
- functions: {},
61
- resources: {},
62
- environment: {},
63
- custom: {},
64
- iamStatements: [],
65
- };
66
-
67
- // Create admin script queue
68
- this.createAdminScriptQueue(result);
69
-
70
- // Create Lambda function for script execution
71
- this.createScriptExecutorFunction(result, usePrismaLayer);
72
-
73
- // Create API routes for script management
74
- this.createAdminScriptRoutes(result, usePrismaLayer);
75
-
76
- // Phase 2: Create EventBridge Scheduler resources
77
- if (adminConfig.enableScheduling) {
78
- this.createSchedulerResources(appDefinition, result);
79
- }
80
-
81
- // Log registered scripts
82
- appDefinition.adminScripts.forEach(script => {
83
- const name = script.Definition?.name || 'unknown';
84
- const schedule = script.Definition?.schedule;
85
- console.log(` ✓ Registered: ${name}${schedule?.enabled ? ' (scheduled)' : ''}`);
86
- });
87
-
88
- console.log(`[${this.name}] ✅ Admin script configuration completed`);
89
- return result;
90
- }
91
-
92
- createAdminScriptQueue(result) {
93
- result.resources.AdminScriptQueue = {
94
- Type: 'AWS::SQS::Queue',
95
- Properties: {
96
- QueueName: '${self:service}-${self:provider.stage}-AdminScriptQueue',
97
- MessageRetentionPeriod: 86400, // 1 day
98
- VisibilityTimeout: 900, // 15 minutes (Lambda max)
99
- RedrivePolicy: {
100
- maxReceiveCount: 3,
101
- deadLetterTargetArn: {
102
- 'Fn::GetAtt': ['InternalErrorQueue', 'Arn'],
103
- },
104
- },
105
- },
106
- };
107
-
108
- result.environment.ADMIN_SCRIPT_QUEUE_URL = { Ref: 'AdminScriptQueue' };
109
- console.log(' ✓ Created AdminScriptQueue');
110
- }
111
-
112
- createScriptExecutorFunction(result, usePrismaLayer) {
113
- result.functions.adminScriptExecutor = {
114
- handler: 'node_modules/@friggframework/admin-scripts/src/infrastructure/script-executor-handler.handler',
115
- skipEsbuild: true,
116
- ...(usePrismaLayer && { layers: [{ Ref: 'PrismaLambdaLayer' }] }),
117
- timeout: 900, // 15 minutes max
118
- memorySize: 1024,
119
- events: [
120
- {
121
- sqs: {
122
- arn: { 'Fn::GetAtt': ['AdminScriptQueue', 'Arn'] },
123
- batchSize: 1,
124
- },
125
- },
126
- ],
127
- };
128
- console.log(' ✓ Created adminScriptExecutor function');
129
- }
130
-
131
- createAdminScriptRoutes(result, usePrismaLayer) {
132
- result.functions.adminScriptRouter = {
133
- handler: 'node_modules/@friggframework/admin-scripts/src/infrastructure/admin-script-router.handler',
134
- skipEsbuild: true,
135
- ...(usePrismaLayer && { layers: [{ Ref: 'PrismaLambdaLayer' }] }),
136
- timeout: 30,
137
- events: [
138
- // List scripts
139
- { httpApi: { path: '/admin/scripts', method: 'GET' } },
140
- // Get script details
141
- { httpApi: { path: '/admin/scripts/{scriptName}', method: 'GET' } },
142
- // Execute script (sync or async)
143
- { httpApi: { path: '/admin/scripts/{scriptName}/execute', method: 'POST' } },
144
- // Get execution status
145
- { httpApi: { path: '/admin/executions/{executionId}', method: 'GET' } },
146
- // List executions
147
- { httpApi: { path: '/admin/executions', method: 'GET' } },
148
- // Schedule management (Phase 2)
149
- { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'GET' } },
150
- { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'PUT' } },
151
- { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'DELETE' } },
152
- ],
153
- };
154
- console.log(' ✓ Created adminScriptRouter function');
155
- }
156
-
157
- createSchedulerResources(appDefinition, result) {
158
- // Create IAM role for EventBridge Scheduler
159
- result.resources.AdminScriptSchedulerRole = {
160
- Type: 'AWS::IAM::Role',
161
- Properties: {
162
- RoleName: '${self:service}-${self:provider.stage}-admin-script-scheduler',
163
- AssumeRolePolicyDocument: {
164
- Version: '2012-10-17',
165
- Statement: [{
166
- Effect: 'Allow',
167
- Principal: { Service: 'scheduler.amazonaws.com' },
168
- Action: 'sts:AssumeRole',
169
- }],
170
- },
171
- Policies: [{
172
- PolicyName: 'InvokeLambda',
173
- PolicyDocument: {
174
- Version: '2012-10-17',
175
- Statement: [{
176
- Effect: 'Allow',
177
- Action: 'lambda:InvokeFunction',
178
- Resource: { 'Fn::GetAtt': ['AdminScriptExecutorLambdaFunction', 'Arn'] },
179
- }],
180
- },
181
- }],
182
- },
183
- };
184
-
185
- // Create schedule group
186
- result.resources.AdminScriptScheduleGroup = {
187
- Type: 'AWS::Scheduler::ScheduleGroup',
188
- Properties: {
189
- Name: '${self:service}-${self:provider.stage}-admin-scripts',
190
- },
191
- };
192
-
193
- result.environment.SCHEDULER_ROLE_ARN = { 'Fn::GetAtt': ['AdminScriptSchedulerRole', 'Arn'] };
194
- result.environment.SCHEDULE_GROUP_NAME = { Ref: 'AdminScriptScheduleGroup' };
195
-
196
- console.log(' ✓ Created EventBridge Scheduler resources');
197
- }
198
- }
199
-
200
- module.exports = { AdminScriptBuilder };
@@ -1,499 +0,0 @@
1
- /**
2
- * Tests for Admin Script Builder
3
- *
4
- * Tests admin script infrastructure generation including:
5
- * - SQS queue for script execution
6
- * - Lambda executor function
7
- * - Lambda router function with HTTP routes
8
- * - EventBridge Scheduler resources (optional)
9
- */
10
-
11
- const { AdminScriptBuilder } = require('./admin-script-builder');
12
- const { ValidationResult } = require('../shared/base-builder');
13
-
14
- describe('AdminScriptBuilder', () => {
15
- let adminScriptBuilder;
16
-
17
- beforeEach(() => {
18
- adminScriptBuilder = new AdminScriptBuilder();
19
- });
20
-
21
- describe('shouldExecute()', () => {
22
- it('should return false when no adminScripts', () => {
23
- const appDefinition = {};
24
-
25
- expect(adminScriptBuilder.shouldExecute(appDefinition)).toBe(false);
26
- });
27
-
28
- it('should return false when adminScripts is empty array', () => {
29
- const appDefinition = {
30
- adminScripts: [],
31
- };
32
-
33
- expect(adminScriptBuilder.shouldExecute(appDefinition)).toBe(false);
34
- });
35
-
36
- it('should return true when adminScripts has items', () => {
37
- const appDefinition = {
38
- adminScripts: [
39
- { Definition: { name: 'test-script' } },
40
- ],
41
- };
42
-
43
- expect(adminScriptBuilder.shouldExecute(appDefinition)).toBe(true);
44
- });
45
-
46
- it('should return false when adminScripts is not an array', () => {
47
- const appDefinition = {
48
- adminScripts: { name: 'test' },
49
- };
50
-
51
- expect(adminScriptBuilder.shouldExecute(appDefinition)).toBe(false);
52
- });
53
- });
54
-
55
- describe('getDependencies()', () => {
56
- it('should have no dependencies', () => {
57
- const deps = adminScriptBuilder.getDependencies();
58
-
59
- expect(deps).toEqual([]);
60
- });
61
- });
62
-
63
- describe('validate()', () => {
64
- it('should pass validation with valid adminScripts', () => {
65
- const appDefinition = {
66
- adminScripts: [
67
- { Definition: { name: 'oauth-refresh' } },
68
- { Definition: { name: 'health-check' } },
69
- ],
70
- };
71
-
72
- const result = adminScriptBuilder.validate(appDefinition);
73
-
74
- expect(result).toBeInstanceOf(ValidationResult);
75
- expect(result.valid).toBe(true);
76
- expect(result.errors).toEqual([]);
77
- });
78
-
79
- it('should pass when adminScripts is undefined', () => {
80
- const appDefinition = {};
81
-
82
- const result = adminScriptBuilder.validate(appDefinition);
83
-
84
- expect(result.valid).toBe(true);
85
- });
86
-
87
- it('should fail when adminScripts is not an array', () => {
88
- const appDefinition = {
89
- adminScripts: 'invalid',
90
- };
91
-
92
- const result = adminScriptBuilder.validate(appDefinition);
93
-
94
- expect(result.valid).toBe(false);
95
- expect(result.errors).toContain('adminScripts must be an array');
96
- });
97
-
98
- it('should fail when script missing Definition.name', () => {
99
- const appDefinition = {
100
- adminScripts: [
101
- { Definition: {} },
102
- ],
103
- };
104
-
105
- const result = adminScriptBuilder.validate(appDefinition);
106
-
107
- expect(result.valid).toBe(false);
108
- expect(result.errors).toContain(
109
- 'Admin script at index 0 is missing Definition or name'
110
- );
111
- });
112
-
113
- it('should fail when script missing Definition', () => {
114
- const appDefinition = {
115
- adminScripts: [
116
- { someOtherField: 'value' },
117
- ],
118
- };
119
-
120
- const result = adminScriptBuilder.validate(appDefinition);
121
-
122
- expect(result.valid).toBe(false);
123
- expect(result.errors).toContain(
124
- 'Admin script at index 0 is missing Definition or name'
125
- );
126
- });
127
-
128
- it('should validate all scripts', () => {
129
- const appDefinition = {
130
- adminScripts: [
131
- { Definition: { name: 'valid' } },
132
- { Definition: {} }, // Invalid - no name
133
- { someField: 'value' }, // Invalid - no Definition
134
- ],
135
- };
136
-
137
- const result = adminScriptBuilder.validate(appDefinition);
138
-
139
- expect(result.valid).toBe(false);
140
- expect(result.errors).toHaveLength(2);
141
- });
142
- });
143
-
144
- describe('build()', () => {
145
- it('should create AdminScriptQueue resource', async () => {
146
- const appDefinition = {
147
- adminScripts: [
148
- { Definition: { name: 'test-script' } },
149
- ],
150
- };
151
-
152
- const result = await adminScriptBuilder.build(appDefinition, {});
153
-
154
- expect(result.resources.AdminScriptQueue).toBeDefined();
155
- expect(result.resources.AdminScriptQueue.Type).toBe('AWS::SQS::Queue');
156
- });
157
-
158
- it('should configure AdminScriptQueue with correct retention and timeout', async () => {
159
- const appDefinition = {
160
- adminScripts: [
161
- { Definition: { name: 'test-script' } },
162
- ],
163
- };
164
-
165
- const result = await adminScriptBuilder.build(appDefinition, {});
166
-
167
- expect(result.resources.AdminScriptQueue.Properties.MessageRetentionPeriod).toBe(86400); // 1 day
168
- expect(result.resources.AdminScriptQueue.Properties.VisibilityTimeout).toBe(900); // 15 minutes
169
- });
170
-
171
- it('should configure AdminScriptQueue redrive policy to InternalErrorQueue', async () => {
172
- const appDefinition = {
173
- adminScripts: [
174
- { Definition: { name: 'test-script' } },
175
- ],
176
- };
177
-
178
- const result = await adminScriptBuilder.build(appDefinition, {});
179
-
180
- expect(result.resources.AdminScriptQueue.Properties.RedrivePolicy).toEqual({
181
- maxReceiveCount: 3,
182
- deadLetterTargetArn: {
183
- 'Fn::GetAtt': ['InternalErrorQueue', 'Arn'],
184
- },
185
- });
186
- });
187
-
188
- it('should add ADMIN_SCRIPT_QUEUE_URL to environment variables', async () => {
189
- const appDefinition = {
190
- adminScripts: [
191
- { Definition: { name: 'test-script' } },
192
- ],
193
- };
194
-
195
- const result = await adminScriptBuilder.build(appDefinition, {});
196
-
197
- expect(result.environment.ADMIN_SCRIPT_QUEUE_URL).toEqual({
198
- Ref: 'AdminScriptQueue',
199
- });
200
- });
201
-
202
- it('should create adminScriptExecutor function', async () => {
203
- const appDefinition = {
204
- adminScripts: [
205
- { Definition: { name: 'test-script' } },
206
- ],
207
- };
208
-
209
- const result = await adminScriptBuilder.build(appDefinition, {});
210
-
211
- expect(result.functions.adminScriptExecutor).toBeDefined();
212
- expect(result.functions.adminScriptExecutor.handler).toBe(
213
- 'node_modules/@friggframework/admin-scripts/src/infrastructure/script-executor-handler.handler'
214
- );
215
- });
216
-
217
- it('should configure adminScriptExecutor with SQS event', async () => {
218
- const appDefinition = {
219
- adminScripts: [
220
- { Definition: { name: 'test-script' } },
221
- ],
222
- };
223
-
224
- const result = await adminScriptBuilder.build(appDefinition, {});
225
-
226
- expect(result.functions.adminScriptExecutor.events).toEqual([
227
- {
228
- sqs: {
229
- arn: { 'Fn::GetAtt': ['AdminScriptQueue', 'Arn'] },
230
- batchSize: 1,
231
- },
232
- },
233
- ]);
234
- });
235
-
236
- it('should set adminScriptExecutor timeout to 900 seconds', async () => {
237
- const appDefinition = {
238
- adminScripts: [
239
- { Definition: { name: 'test-script' } },
240
- ],
241
- };
242
-
243
- const result = await adminScriptBuilder.build(appDefinition, {});
244
-
245
- expect(result.functions.adminScriptExecutor.timeout).toBe(900); // 15 minutes (Lambda max)
246
- });
247
-
248
- it('should set adminScriptExecutor memory size', async () => {
249
- const appDefinition = {
250
- adminScripts: [
251
- { Definition: { name: 'test-script' } },
252
- ],
253
- };
254
-
255
- const result = await adminScriptBuilder.build(appDefinition, {});
256
-
257
- expect(result.functions.adminScriptExecutor.memorySize).toBe(1024);
258
- });
259
-
260
- it('should attach Prisma layer to adminScriptExecutor', async () => {
261
- const appDefinition = {
262
- adminScripts: [
263
- { Definition: { name: 'test-script' } },
264
- ],
265
- };
266
-
267
- const result = await adminScriptBuilder.build(appDefinition, {});
268
-
269
- expect(result.functions.adminScriptExecutor.layers).toEqual([
270
- { Ref: 'PrismaLambdaLayer' }
271
- ]);
272
- });
273
-
274
- it('should create adminScriptRouter function', async () => {
275
- const appDefinition = {
276
- adminScripts: [
277
- { Definition: { name: 'test-script' } },
278
- ],
279
- };
280
-
281
- const result = await adminScriptBuilder.build(appDefinition, {});
282
-
283
- expect(result.functions.adminScriptRouter).toBeDefined();
284
- expect(result.functions.adminScriptRouter.handler).toBe(
285
- 'node_modules/@friggframework/admin-scripts/src/infrastructure/admin-script-router.handler'
286
- );
287
- });
288
-
289
- it('should configure adminScriptRouter with correct HTTP routes', async () => {
290
- const appDefinition = {
291
- adminScripts: [
292
- { Definition: { name: 'test-script' } },
293
- ],
294
- };
295
-
296
- const result = await adminScriptBuilder.build(appDefinition, {});
297
-
298
- expect(result.functions.adminScriptRouter.events).toEqual([
299
- // List scripts
300
- { httpApi: { path: '/admin/scripts', method: 'GET' } },
301
- // Get script details
302
- { httpApi: { path: '/admin/scripts/{scriptName}', method: 'GET' } },
303
- // Execute script (sync or async)
304
- { httpApi: { path: '/admin/scripts/{scriptName}/execute', method: 'POST' } },
305
- // Get execution status
306
- { httpApi: { path: '/admin/executions/{executionId}', method: 'GET' } },
307
- // List executions
308
- { httpApi: { path: '/admin/executions', method: 'GET' } },
309
- // Schedule management (Phase 2)
310
- { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'GET' } },
311
- { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'PUT' } },
312
- { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'DELETE' } },
313
- ]);
314
- });
315
-
316
- it('should set adminScriptRouter timeout to 30 seconds', async () => {
317
- const appDefinition = {
318
- adminScripts: [
319
- { Definition: { name: 'test-script' } },
320
- ],
321
- };
322
-
323
- const result = await adminScriptBuilder.build(appDefinition, {});
324
-
325
- expect(result.functions.adminScriptRouter.timeout).toBe(30);
326
- });
327
-
328
- it('should attach Prisma layer to adminScriptRouter', async () => {
329
- const appDefinition = {
330
- adminScripts: [
331
- { Definition: { name: 'test-script' } },
332
- ],
333
- };
334
-
335
- const result = await adminScriptBuilder.build(appDefinition, {});
336
-
337
- expect(result.functions.adminScriptRouter.layers).toEqual([
338
- { Ref: 'PrismaLambdaLayer' }
339
- ]);
340
- });
341
-
342
- it('should create scheduler resources when admin.enableScheduling is true', async () => {
343
- const appDefinition = {
344
- adminScripts: [
345
- { Definition: { name: 'test-script' } },
346
- ],
347
- admin: {
348
- enableScheduling: true,
349
- },
350
- };
351
-
352
- const result = await adminScriptBuilder.build(appDefinition, {});
353
-
354
- // Check for scheduler IAM role
355
- expect(result.resources.AdminScriptSchedulerRole).toBeDefined();
356
- expect(result.resources.AdminScriptSchedulerRole.Type).toBe('AWS::IAM::Role');
357
-
358
- // Check for schedule group
359
- expect(result.resources.AdminScriptScheduleGroup).toBeDefined();
360
- expect(result.resources.AdminScriptScheduleGroup.Type).toBe('AWS::Scheduler::ScheduleGroup');
361
-
362
- // Check for environment variables
363
- expect(result.environment.SCHEDULER_ROLE_ARN).toEqual({
364
- 'Fn::GetAtt': ['AdminScriptSchedulerRole', 'Arn'],
365
- });
366
- expect(result.environment.SCHEDULE_GROUP_NAME).toEqual({
367
- Ref: 'AdminScriptScheduleGroup',
368
- });
369
- });
370
-
371
- it('should not create scheduler resources when enableScheduling is false', async () => {
372
- const appDefinition = {
373
- adminScripts: [
374
- { Definition: { name: 'test-script' } },
375
- ],
376
- admin: {
377
- enableScheduling: false,
378
- },
379
- };
380
-
381
- const result = await adminScriptBuilder.build(appDefinition, {});
382
-
383
- expect(result.resources.AdminScriptSchedulerRole).toBeUndefined();
384
- expect(result.resources.AdminScriptScheduleGroup).toBeUndefined();
385
- expect(result.environment.SCHEDULER_ROLE_ARN).toBeUndefined();
386
- expect(result.environment.SCHEDULE_GROUP_NAME).toBeUndefined();
387
- });
388
-
389
- it('should not create scheduler resources when admin config is not provided', async () => {
390
- const appDefinition = {
391
- adminScripts: [
392
- { Definition: { name: 'test-script' } },
393
- ],
394
- };
395
-
396
- const result = await adminScriptBuilder.build(appDefinition, {});
397
-
398
- expect(result.resources.AdminScriptSchedulerRole).toBeUndefined();
399
- expect(result.resources.AdminScriptScheduleGroup).toBeUndefined();
400
- });
401
-
402
- it('should use skipEsbuild for all functions', async () => {
403
- const appDefinition = {
404
- adminScripts: [
405
- { Definition: { name: 'test-script' } },
406
- ],
407
- };
408
-
409
- const result = await adminScriptBuilder.build(appDefinition, {});
410
-
411
- expect(result.functions.adminScriptExecutor.skipEsbuild).toBe(true);
412
- expect(result.functions.adminScriptRouter.skipEsbuild).toBe(true);
413
- });
414
-
415
- it('should not attach Prisma layer when usePrismaLambdaLayer=false', async () => {
416
- const appDefinition = {
417
- usePrismaLambdaLayer: false,
418
- adminScripts: [
419
- { Definition: { name: 'test-script' } },
420
- ],
421
- };
422
-
423
- const result = await adminScriptBuilder.build(appDefinition, {});
424
-
425
- expect(result.functions.adminScriptExecutor.layers).toBeUndefined();
426
- expect(result.functions.adminScriptRouter.layers).toBeUndefined();
427
- });
428
-
429
- it('should handle multiple admin scripts', async () => {
430
- const appDefinition = {
431
- adminScripts: [
432
- { Definition: { name: 'oauth-refresh' } },
433
- { Definition: { name: 'health-check' } },
434
- { Definition: { name: 'attio-healing' } },
435
- ],
436
- };
437
-
438
- const result = await adminScriptBuilder.build(appDefinition, {});
439
-
440
- // Should still only create one queue and two functions
441
- expect(result.resources.AdminScriptQueue).toBeDefined();
442
- expect(result.functions.adminScriptExecutor).toBeDefined();
443
- expect(result.functions.adminScriptRouter).toBeDefined();
444
-
445
- // Should not create separate resources per script
446
- expect(Object.keys(result.resources)).toHaveLength(1); // Only AdminScriptQueue
447
- expect(Object.keys(result.functions)).toHaveLength(2); // Only executor and router
448
- });
449
-
450
- it('should configure scheduler role with correct trust policy', async () => {
451
- const appDefinition = {
452
- adminScripts: [
453
- { Definition: { name: 'test-script' } },
454
- ],
455
- admin: {
456
- enableScheduling: true,
457
- },
458
- };
459
-
460
- const result = await adminScriptBuilder.build(appDefinition, {});
461
-
462
- const trustPolicy = result.resources.AdminScriptSchedulerRole.Properties.AssumeRolePolicyDocument;
463
-
464
- expect(trustPolicy.Statement[0]).toEqual({
465
- Effect: 'Allow',
466
- Principal: { Service: 'scheduler.amazonaws.com' },
467
- Action: 'sts:AssumeRole',
468
- });
469
- });
470
-
471
- it('should configure scheduler role with Lambda invoke permission', async () => {
472
- const appDefinition = {
473
- adminScripts: [
474
- { Definition: { name: 'test-script' } },
475
- ],
476
- admin: {
477
- enableScheduling: true,
478
- },
479
- };
480
-
481
- const result = await adminScriptBuilder.build(appDefinition, {});
482
-
483
- const policies = result.resources.AdminScriptSchedulerRole.Properties.Policies;
484
-
485
- expect(policies[0].PolicyName).toBe('InvokeLambda');
486
- expect(policies[0].PolicyDocument.Statement[0]).toEqual({
487
- Effect: 'Allow',
488
- Action: 'lambda:InvokeFunction',
489
- Resource: { 'Fn::GetAtt': ['AdminScriptExecutorLambdaFunction', 'Arn'] },
490
- });
491
- });
492
- });
493
-
494
- describe('getName()', () => {
495
- it('should return AdminScriptBuilder', () => {
496
- expect(adminScriptBuilder.getName()).toBe('AdminScriptBuilder');
497
- });
498
- });
499
- });
@@ -1,5 +0,0 @@
1
- const { AdminScriptBuilder } = require('./admin-script-builder');
2
-
3
- module.exports = {
4
- AdminScriptBuilder
5
- };