Env service refactor #58

Shereef · 2025-11-06T03:24:38Z

No description provided.

… stack missing error

Custom packages

…s issue

implement remove for custom providers

Copilot

Pull Request Overview

This PR upgrades dependencies (AWS CDK, aws-sdk, js-yaml, and others) and refactors the deployment provider system to support multiple Serverless Framework versions (v1, v2, v3) and AWS CDK. It also adds support for environment variable-based configuration, SNS notifications for deployment status, and secret resolution from SSM.

Updates dependencies including AWS CDK (1.94.1), aws-sdk (2.869.0), js-yaml (4.0.0), and adds new packages (chalk, flat, ncjsm)
Refactors Serverless provider to handle v1, v2, and v3 compatibility with dynamic module resolution
Adds SNS client for publishing deployment results to Frankenstack
Implements secret resolution from AWS Systems Manager Parameter Store
Renames class from ServerlessV1 to Serverless and method from destroy to remove

Reviewed Changes

Copilot reviewed 13 out of 16 changed files in this pull request and generated 18 comments.

Show a summary per file

File	Description
package.json	Updates dependencies and removes serverless package from direct dependencies
lib/utils/parseYaml.ts/js	Updates js-yaml API from deprecated safeLoad to load
lib/service/snsClient.ts/js	New service for publishing deployment status messages to SNS
lib/providers/serverless.ts/js	Major refactor to support multiple Serverless Framework versions with credential handling
lib/providers/hardcoded.ts/js	Updates property names and adds result field to response
lib/providers/cdk.ts/js	Adds remove method, credential handling, and refactors deploy logic
lib/deployer.ts/js	Adds environment variable parsing, secret resolution, and SNS integration
bin/index.ts/js	Makes file parameter optional and adds default command

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-06T03:27:46Z

lib/providers/serverless.ts

+
+                console.log('resolved config', configuration, util.inspect(variablesMeta, {showHidden: false, depth: null, colors: true}));
+            } catch(err) {
+                console.error('Error while resoving serverless template.', err);


Corrected spelling of 'resoving' to 'resolving'.

Suggested change

console.error('Error while resoving serverless template.', err);

console.error('Error while resolving serverless template.', err);

Copilot · 2025-11-06T03:27:46Z

lib/deployer.ts

+                } else {
+                    const result = {status: false}
+                    await this.publishResultToFrankenstack(result);
+                    throw `Failed to resolve secret value for paramater: ${paramName}`;


Corrected spelling of 'paramater' to 'parameter'.

Suggested change

throw `Failed to resolve secret value for paramater: ${paramName}`;

throw `Failed to resolve secret value for parameter: ${paramName}`;

Copilot · 2025-11-06T03:27:46Z

package.json

+    "@aws-cdk/core": "^1.94.1",
+    "aws-cdk": "1.94.1",
+    "aws-sdk": "^2.869.0",
+    "chalk": "^5.0.0",


Chalk v5.0.0+ is ESM-only and incompatible with CommonJS require() statements used throughout this codebase. Since chalk is not currently imported anywhere, this unused dependency should either be removed or downgraded to v4.x which supports CommonJS.

Suggested change

"chalk": "^5.0.0",

Copilot · 2025-11-06T03:27:47Z

lib/service/snsClient.ts

+const client = new SNS();
+
+module.exports = {
+    async publishJobRunFinishedMessage(jobRunFinishedResult: any) {


Missing validation for process.env.JOB_RUN_FINISHED_TOPIC_ARN. If this environment variable is undefined, the SNS publish call will fail. Add validation to ensure the TopicArn is defined before attempting to publish.

Suggested change

async publishJobRunFinishedMessage(jobRunFinishedResult: any) {

async publishJobRunFinishedMessage(jobRunFinishedResult: any) {

if (!process.env.JOB_RUN_FINISHED_TOPIC_ARN) {

throw new Error('Environment variable JOB_RUN_FINISHED_TOPIC_ARN is not defined.');

}

Copilot · 2025-11-06T03:27:47Z

lib/deployer.ts

+            return;
+        }
+        for(var key of Object.keys(this.component.inputs)) {
+            if(this.component.inputs[key].startsWith('ssm:')) {


Potential TypeError if this.component.inputs[key] is not a string. The code should verify that the value is a string before calling startsWith().

Suggested change

if(this.component.inputs[key].startsWith('ssm:')) {

if(typeof this.component.inputs[key] === 'string' && this.component.inputs[key].startsWith('ssm:')) {

Copilot · 2025-11-06T03:27:49Z

lib/providers/serverless.ts

+            options['stage'] = this.stage;
+
+            if(this.account) {
+                options['aws-profile'] = 'frank'


Avoid automated semicolon insertion (90% of all statements in the enclosing function have an explicit semicolon).

Suggested change

options['aws-profile'] = 'frank'

options['aws-profile'] = 'frank';

Copilot · 2025-11-06T03:27:50Z

lib/providers/serverless.ts

+            }
+
+            if(this.account) {
+                process.argv.push('--aws-profile', 'frank')


Avoid automated semicolon insertion (90% of all statements in the enclosing function have an explicit semicolon).

Suggested change

process.argv.push('--aws-profile', 'frank')

process.argv.push('--aws-profile', 'frank');

Copilot · 2025-11-06T03:27:50Z

lib/providers/serverless.ts

+            await sls.init();
+        }
+        try {
+            console.log("Executing serverless run.")


Avoid automated semicolon insertion (90% of all statements in the enclosing function have an explicit semicolon).

Suggested change

console.log("Executing serverless run.")

console.log("Executing serverless run.");

Copilot · 2025-11-06T03:27:50Z

lib/providers/serverless.ts

+            await sls.run();
+        } catch(err) {
+            console.error(err);
+            success = false


Avoid automated semicolon insertion (90% of all statements in the enclosing function have an explicit semicolon).

Suggested change

success = false

success = false;

Copilot · 2025-11-06T03:27:51Z

lib/providers/serverless.ts

+        return {
+            result: success,
+            outputs: outputs
+        }


Avoid automated semicolon insertion (90% of all statements in the enclosing function have an explicit semicolon).

Suggested change

}

};

Travis Walker added 30 commits December 11, 2020 14:22

support environment variables for template and include sns client

9537eeb

send job result to sns

b4ec562

fix serverless provider to work with environment service

35a4ec2

get the inputs working from env vars

80ec644

fix the parsing of the provider environment var

69cfb75

some debuggin around the cdk provider config

4dec79f

properly parse provider config from env vars

4b1cf82

try json parse of provider config items

19a2870

switch to just using a flat provider config

052d9aa

another attempt

c4893f2

some more debugging and hardcoded defaults

ab1df3a

fix cdk construct config

3b8332c

send stack outputs to sns

5dde3f2

fix hardcoded provider

398bbbf

report hardcoded provider result

93b3514

handle package import names in cdk

77efa01

some require stuff

c5199dd

explicitly state node modules

7d0a664

print stack env

728ce18

send passed build result from cdk provider

7984209

force deploy stack on cdk provider

477199a

fix serverless inputs reference

6b0328d

previous commit but built now

dd25ecf

attempt to do lookups correctly in cdk provider

58cf769

experiment with using contextproviders

c8ce0be

increase cdk verbosity

0aa48b7

write context to disk after resolving context

0a0689d

print out cdk.context.json

a88ed7e

try to make a new assembly

4664408

loop on contextprovider lookups

d9e412e

Travis Walker added 28 commits April 19, 2022 09:44

publish results for custom provider

ffb00b9

fix the serverless v3 provider by resolving vars

2b3e2c6

fix imports for serverless v3 provider

8b8119e

some debugging of sls v3 provider

b8d842f

attempt to generate commandschema

c3cfe8c

pass command schema

5690849

another try add resolving vars

e2724d2

another try add resolving vars

0940b1f

another try add resolving vars

c085330

remove infinite loop

56af885

remove infinite loop

b2a857d

try to resolve more vars

0a2c54c

try to resolve more vars

f032e44

for serverless 3 resolve variables that depend on the sls instance

e74f021

clean up serverless v3 provider

04c8ddf

clean up serverless v3 provider

e9e5bf7

try skipping the post init variable resolution to see if it fixes the…

eb8f57a

… stack missing error

some extra debugging to fix sls v3 provider

6f060e1

try to resolve sls instance specific vars again

93cb83f

log variablesMeta after resolving instance dependent vars

292817b

improve var meta logging

2c683f0

improve var meta logging

3cdb397

try marking env as a fulfilled source and try to resolve vars again

57bc954

increase retry count to 10 for cdk pulling down AWS credentials

7a0880f

Merge pull request #14 from DaySmart/custom-packages

c5fb5c6

Custom packages

don't import cdk provider unless required to workaround the construct…

59a0bc2

…s issue

implement remove for custom providers

e50a228

Merge pull request #15 from DaySmart/implement-remove-custom-providers

0625447

implement remove for custom providers

Shereef requested a review from Copilot November 6, 2025 03:24

Copilot AI reviewed Nov 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Env service refactor #58

Env service refactor #58

Uh oh!

Shereef commented Nov 6, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Copilot AI Nov 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	console.error('Error while resoving serverless template.', err);
	console.error('Error while resolving serverless template.', err);

	throw `Failed to resolve secret value for paramater: ${paramName}`;
	throw `Failed to resolve secret value for parameter: ${paramName}`;

	if(this.component.inputs[key].startsWith('ssm:')) {
	if(typeof this.component.inputs[key] === 'string' && this.component.inputs[key].startsWith('ssm:')) {

	options['aws-profile'] = 'frank'
	options['aws-profile'] = 'frank';

	process.argv.push('--aws-profile', 'frank')
	process.argv.push('--aws-profile', 'frank');

	console.log("Executing serverless run.")
	console.log("Executing serverless run.");

Env service refactor #58

Are you sure you want to change the base?

Env service refactor #58

Uh oh!

Conversation

Shereef commented Nov 6, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants