Skip to content

chore(maintenance): migrate layers package to biome #2806

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.

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
merged 4 commits into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion layers/bin/layers.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/usr/bin/env node
import 'source-map-support/register';
import { App } from 'aws-cdk-lib';
import { LayerPublisherStack } from '../src/layer-publisher-stack';
import { CanaryStack } from 'layers/src/canary-stack';
import { LayerPublisherStack } from '../src/layer-publisher-stack';

const SSM_PARAM_LAYER_ARN = '/layers/powertools-layer-arn';

Expand Down
9 changes: 2 additions & 7 deletions layers/cdk.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
{
"app": "npx ts-node --prefer-ts-exts bin/layers.ts",
"watch": {
"include": [
"**"
],
"include": ["**"],
"exclude": [
"README.md",
"cdk*.json",
Expand All @@ -24,9 +22,6 @@
"@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": true,
"@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
"@aws-cdk/aws-ec2:uniqueImdsv2TemplateName": true,
"@aws-cdk/core:target-partitions": [
"aws",
"aws-cn"
]
"@aws-cdk/core:target-partitions": ["aws", "aws-cn"]
}
}
4 changes: 2 additions & 2 deletions layers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"jest": "jest --detectOpenHandles",
"cdk": "cdk",
"package": "echo 'Not applicable'",
"lint": "eslint --ext .ts,.js --no-error-on-unmatched-pattern .",
"lint-fix": "eslint --fix --ext .ts,.js --fix --no-error-on-unmatched-pattern .",
"lint": "biome lint .",
"lint:fix": "biome check --write .",
"test:unit": "jest --group=unit",
"test:e2e": "jest --group=e2e",
"createLayerFolder": "cdk synth --context BuildFromLocal=true"
Expand Down
14 changes: 7 additions & 7 deletions layers/src/canary-stack.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { CustomResource, Duration, Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { LayerVersion, Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
import { RetentionDays } from 'aws-cdk-lib/aws-logs';
import { randomUUID } from 'node:crypto';
import { Effect, PolicyStatement } from 'aws-cdk-lib/aws-iam';
import { Provider } from 'aws-cdk-lib/custom-resources';
import { StringParameter } from 'aws-cdk-lib/aws-ssm';
import path from 'node:path';
import { CustomResource, Duration, Stack, type StackProps } from 'aws-cdk-lib';
import { Effect, PolicyStatement } from 'aws-cdk-lib/aws-iam';
import { LayerVersion, Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
import { RetentionDays } from 'aws-cdk-lib/aws-logs';
import { StringParameter } from 'aws-cdk-lib/aws-ssm';
import { Provider } from 'aws-cdk-lib/custom-resources';
import type { Construct } from 'constructs';

export interface CanaryStackProps extends StackProps {
readonly layerName: string;
Expand Down
12 changes: 6 additions & 6 deletions layers/src/layer-publisher-stack.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import { CfnOutput, RemovalPolicy, Stack, StackProps } from 'aws-cdk-lib';
import { execSync } from 'node:child_process';
import { randomUUID } from 'node:crypto';
import { join, resolve, sep } from 'node:path';
import { CfnOutput, RemovalPolicy, Stack, type StackProps } from 'aws-cdk-lib';
import {
CfnLayerVersionPermission,
Code,
LayerVersion,
Runtime,
} from 'aws-cdk-lib/aws-lambda';
import { StringParameter } from 'aws-cdk-lib/aws-ssm';
import { Construct } from 'constructs';
import { execSync } from 'node:child_process';
import { randomUUID } from 'node:crypto';
import { join, resolve, sep } from 'node:path';
import type { Construct } from 'constructs';

export interface LayerPublisherStackProps extends StackProps {
readonly layerName?: string;
Expand Down Expand Up @@ -217,7 +217,7 @@ export class LayerPublisherStack extends Stack {

new CfnOutput(this, 'LatestLayerArn', {
value: this.lambdaLayerVersion.layerVersionArn,
exportName: props?.layerName ?? `LambdaPowerToolsForTypeScriptLayerARN`,
exportName: props?.layerName ?? 'LambdaPowerToolsForTypeScriptLayerARN',
});
}
}
20 changes: 10 additions & 10 deletions layers/tests/e2e/layerPublisher.class.test.functionCode.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import { join } from 'node:path';
import { readFile } from 'node:fs/promises';
import { join } from 'node:path';
import { BatchProcessor, EventType } from '@aws-lambda-powertools/batch';
import { DynamoDBPersistenceLayer } from '@aws-lambda-powertools/idempotency/dynamodb';
import { Logger } from '@aws-lambda-powertools/logger';
import { Metrics } from '@aws-lambda-powertools/metrics';
import { Tracer } from '@aws-lambda-powertools/tracer';
import { DynamoDBPersistenceLayer } from '@aws-lambda-powertools/idempotency/dynamodb';
import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
import { BatchProcessor, EventType } from '@aws-lambda-powertools/batch';
import { SSMProvider } from '@aws-lambda-powertools/parameters/ssm';
import { SecretsProvider } from '@aws-lambda-powertools/parameters/secrets';
import { AppConfigProvider } from '@aws-lambda-powertools/parameters/appconfig';
import { DynamoDBProvider } from '@aws-lambda-powertools/parameters/dynamodb';
import { SSMClient } from '@aws-sdk/client-ssm';
import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
import { SecretsProvider } from '@aws-lambda-powertools/parameters/secrets';
import { SSMProvider } from '@aws-lambda-powertools/parameters/ssm';
import { Tracer } from '@aws-lambda-powertools/tracer';
import { AppConfigDataClient } from '@aws-sdk/client-appconfigdata';
import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
import { SSMClient } from '@aws-sdk/client-ssm';

const logger = new Logger({
logLevel: 'DEBUG',
Expand Down Expand Up @@ -91,7 +91,7 @@ export const handler = async (): Promise<void> => {
'batch',
]) {
const moduleVersion = await getVersionFromModule(moduleName);
if (moduleVersion != expectedVersion) {
if (moduleVersion !== expectedVersion) {
throw new Error(
`Package version mismatch (${moduleName}): ${moduleVersion} != ${expectedVersion}`
);
Expand Down
38 changes: 22 additions & 16 deletions layers/tests/e2e/layerPublisher.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
*
* @group e2e/layers/all
*/
import { App } from 'aws-cdk-lib';
import { LayerVersion } from 'aws-cdk-lib/aws-lambda';
import { LayerPublisherStack } from '../../src/layer-publisher-stack';
import { join } from 'node:path';
import {
TestStack,
TestInvocationLogs,
invokeFunctionOnce,
TestStack,
generateTestUniqueName,
invokeFunctionOnce,
} from '@aws-lambda-powertools/testing-utils';
import { TestNodejsFunction } from '@aws-lambda-powertools/testing-utils/resources/lambda';
import { App } from 'aws-cdk-lib';
import { LayerVersion } from 'aws-cdk-lib/aws-lambda';
import packageJson from '../../package.json';
import { LayerPublisherStack } from '../../src/layer-publisher-stack';
import {
RESOURCE_NAME_PREFIX,
SETUP_TIMEOUT,
TEARDOWN_TIMEOUT,
} from './constants';
import { join } from 'node:path';
import packageJson from '../../package.json';

jest.spyOn(console, 'log').mockImplementation();

Expand All @@ -39,7 +39,7 @@ function assertLogs(
*
* The lambda function is invoked once and the logs are collected. The goal of the test is to verify that the layer creation and usage works as expected.
*/
describe(`Layers E2E tests`, () => {
describe('Layers E2E tests', () => {
const testStack = new TestStack({
stackNameProps: {
stackNamePrefix: RESOURCE_NAME_PREFIX,
Expand Down Expand Up @@ -96,7 +96,7 @@ describe(`Layers E2E tests`, () => {
);

// Add a lambda function for each output format to the test stack
cases.forEach((outputFormat) => {
for (const outputFormat of cases) {
new TestNodejsFunction(
testStack,
{
Expand All @@ -120,7 +120,7 @@ describe(`Layers E2E tests`, () => {
...(outputFormat === 'ESM' && { outputFormat: 'ESM' }),
}
);
});
}

// Deploy the test stack
await testStack.deploy();
Expand All @@ -141,28 +141,31 @@ describe(`Layers E2E tests`, () => {
describe.each(cases)(
'utilities tests for %s output format',
(outputFormat) => {
let invocationLogs: TestInvocationLogs;
beforeAll(() => {
it('should have no errors in the logs, which indicates the pacakges version matches the expected one', () => {
const maybeInvocationLogs = invocationLogsMap.get(outputFormat);
assertLogs(maybeInvocationLogs);
invocationLogs = maybeInvocationLogs;
});

it('should have no errors in the logs, which indicates the pacakges version matches the expected one', () => {
const invocationLogs = maybeInvocationLogs;
const logs = invocationLogs.getFunctionLogs('ERROR');

expect(logs.length).toBe(0);
});

it('should have one warning related to missing Metrics namespace', () => {
const maybeInvocationLogs = invocationLogsMap.get(outputFormat);
assertLogs(maybeInvocationLogs);
const invocationLogs = maybeInvocationLogs;
const logs = invocationLogs.getFunctionLogs('WARN');

expect(logs.length).toBe(1);
expect(logs[0]).toContain('Namespace should be defined, default used');
});

it('should have one info log related to coldstart metric', () => {
const maybeInvocationLogs = invocationLogsMap.get(outputFormat);
assertLogs(maybeInvocationLogs);
const invocationLogs = maybeInvocationLogs;
const logs = invocationLogs.getFunctionLogs();

const emfLogEntry = logs.find((log) =>
log.match(
/{"_aws":{"Timestamp":\d+,"CloudWatchMetrics":\[\{"Namespace":"\S+","Dimensions":\[\["service"\]\],"Metrics":\[\{"Name":"ColdStart","Unit":"Count"\}\]\}\]},"service":"\S+","ColdStart":1}/
Expand All @@ -173,6 +176,9 @@ describe(`Layers E2E tests`, () => {
});

it('should have one debug log with tracer subsegment info', () => {
const maybeInvocationLogs = invocationLogsMap.get(outputFormat);
assertLogs(maybeInvocationLogs);
const invocationLogs = maybeInvocationLogs;
const logs = invocationLogs.getFunctionLogs('DEBUG');

expect(logs.length).toBe(1);
Expand Down
18 changes: 7 additions & 11 deletions layers/tests/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
{
"extends": "../tsconfig.json",
"compilerOptions": {
"rootDir": "../",
"noEmit": true
},
"include": [
"../src/**/*",
"../package.json",
"./**/*",
]
}
"extends": "../tsconfig.json",
"compilerOptions": {
"rootDir": "../",
"noEmit": true
},
"include": ["../src/**/*", "../package.json", "./**/*"]
}
19 changes: 8 additions & 11 deletions layers/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
{
"extends": "../tsconfig.json",
"compilerOptions": {
"outDir": "./lib",
"rootDir": "./",
"resolveJsonModule": true
},
"include": [
"./src/**/*",
"./bin/**/*"
],
}
"extends": "../tsconfig.json",
"compilerOptions": {
"outDir": "./lib",
"rootDir": "./",
"resolveJsonModule": true
},
"include": ["./src/**/*", "./bin/**/*"]
}