Skip to content
This repository was archived by the owner on Jan 28, 2025. It is now read-only.

feat: add custom inputs for lambda name #283

Merged
merged 2 commits into from
Feb 4, 2020
Merged

feat: add custom inputs for lambda name #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55b8e95
feat: add custom inputs for lambda name
TechEclipse Jan 21, 2020
b3106b8
Fix misaligned table fence
TechEclipse Jan 21, 2020
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,19 @@ myNextApplication:

Note the maximum timeout allowed for Lambda@Edge is 30 seconds. See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html

You can also set a custom name for **default** and **api** lambdas - if not the default is set by the [aws-lambda serverless component](https://github.com/serverless-components/aws-lambda) to the resource id:

```yml
# serverless.yml

myNextApplication:
component: serverless-next.js
inputs:
name:
defaultLambda: fooDefaultLambda
apiLambda: fooApiLambda
```

### Architecture

![architecture](./arch_no_grid.png)
Expand Down Expand Up @@ -205,6 +218,7 @@ The fourth cache behaviour handles next API requests `api/*`.
| nextStaticDir | `string` | `./` | If your `static` or `public` directory is not a direct child of `nextConfigDir` this is needed |
| memory | `number\|object` | `512` | When assigned a number, both the default and api lambdas will assigned memory of that value. When assigned to an object, values for the default and api lambdas can be separately defined | |
| timeout | `number\|object` | `10` | Same as above |
| name | `string\|object` | / | When assigned a string, both the default and api lambdas will assigned name of that value. When assigned to an object, values for the default and api lambdas can be separately defined |
| build | `boolean\|object` | `true` | When true builds and deploys app, when false assume the app has been built and uses the `.next` `.serverless_nextjs` directories in `nextConfigDir` to deploy. If an object is passed `build` allows for overriding what script gets called and with what arguments. |
| build.cmd | `string` | `node_modules/.bin/next` | Build command |
| build.args | `Array\|string` | `['build']` | Arguments to pass to the build |
Expand Down
14 changes: 14 additions & 0 deletions packages/serverless-nextjs-component/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,19 @@ myNextApplication:

Note the maximum timeout allowed for Lambda@Edge is 30 seconds. See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html

You can also set a custom name for **default** and **api** lambdas - if not the default is set by the [aws-lambda serverless component](https://github.com/serverless-components/aws-lambda) to the resource id:

```yml
# serverless.yml

myNextApplication:
component: serverless-next.js
inputs:
name:
defaultLambda: fooDefaultLambda
apiLambda: fooApiLambda
```

### Architecture

![architecture](./arch_no_grid.png)
Expand Down Expand Up @@ -205,6 +218,7 @@ The fourth cache behaviour handles next API requests `api/*`.
| nextStaticDir | `string` | `./` | If your `static` or `public` directory is not a direct child of `nextConfigDir` this is needed |
| memory | `number\|object` | `512` | When assigned a number, both the default and api lambdas will assigned memory of that value. When assigned to an object, values for the default and api lambdas can be separately defined | |
| timeout | `number\|object` | `10` | Same as above |
| name | `string\|object` | / | When assigned a string, both the default and api lambdas will assigned name of that value. When assigned to an object, values for the default and api lambdas can be separately defined |
| build | `boolean\|object` | `true` | When true builds and deploys app, when false assume the app has been built and uses the `.next` `.serverless_nextjs` directories in `nextConfigDir` to deploy. If an object is passed `build` allows for overriding what script gets called and with what arguments. |
| build.cmd | `string` | `node_modules/.bin/next` | Build command |
| build.args | `Array\|string` | `['build']` | Arguments to pass to the build |
Expand Down
60 changes: 60 additions & 0 deletions packages/serverless-nextjs-component/__tests__/custom-inputs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,4 +196,64 @@ describe("Custom inputs", () => {
);
});
});

describe.each([
[undefined, { defaultName: undefined, apiName: undefined }],
[{}, { defaultName: undefined, apiName: undefined }],
["fooFunction", { defaultName: "fooFunction", apiName: "fooFunction" }],
[
{ defaultLambda: "fooFunction" },
{ defaultName: "fooFunction", apiName: undefined }
],
[
{ apiLambda: "fooFunction" },
{ defaultName: undefined, apiName: "fooFunction" }
],
[
{ defaultLambda: "fooFunction", apiLambda: "barFunction" },
{ defaultName: "fooFunction", apiName: "barFunction" }
]
])("Lambda name input", (inputName, expectedName) => {
let tmpCwd;
const fixturePath = path.join(__dirname, "./fixtures/generic-fixture");

beforeEach(async () => {
execa.mockResolvedValueOnce();

tmpCwd = process.cwd();
process.chdir(fixturePath);

mockCloudFront.mockResolvedValueOnce({
url: "https://cloudfrontdistrib.amazonaws.com"
});

const component = new NextjsComponent();
componentOutputs = await component.default({
name: inputName
});
});
it(`sets default lambda name to ${expectedName.defaultName} and api lambda name to ${expectedName.apiName}`, () => {
const { defaultName, apiName } = expectedName;

// Default Lambda
const expectedDefaultObject = {
code: path.join(fixturePath, DEFAULT_LAMBDA_CODE_DIR)
};
if (defaultName) expectedDefaultObject.name = defaultName;

expect(mockLambda).toBeCalledWith(
expect.objectContaining(expectedDefaultObject)
);

// Api Lambda
const expectedApiObject = {
code: path.join(fixturePath, API_LAMBDA_CODE_DIR)
};
if (apiName) expectedApiObject.name = apiName;

expect(mockLambda).toBeCalledWith(
expect.objectContaining(expectedApiObject)
);
});
});
});
23 changes: 19 additions & 4 deletions packages/serverless-nextjs-component/serverless.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,8 +395,13 @@ class NextjsComponent extends Component {
? inputs.timeout
: (inputs.timeout && inputs.timeout[lambdaType]) || 10;

const getLambdaName = lambdaType =>
typeof inputs.name === "string"
? inputs.name
: inputs.name && inputs.name[lambdaType];

if (hasAPIPages) {
apiEdgeLambdaOutputs = await apiEdgeLambda({
const apiEdgeLambdaInput = {
description: "API Lambda@Edge for Next CloudFront distribution",
handler: "index.handler",
code: join(nextConfigPath, API_LAMBDA_CODE_DIR),
Expand All @@ -410,7 +415,11 @@ class NextjsComponent extends Component {
},
memory: getLambdaMemory("apiLambda"),
timeout: getLambdaTimeout("apiLambda")
});
};
const apiLambdaName = getLambdaName("apiLambda");
if (apiLambdaName) apiEdgeLambdaInput.name = apiLambdaName;

apiEdgeLambdaOutputs = await apiEdgeLambda(apiEdgeLambdaInput);

apiEdgeLambdaPublishOutputs = await apiEdgeLambda.publishVersion();

Expand All @@ -431,7 +440,7 @@ class NextjsComponent extends Component {
};
}

const defaultEdgeLambdaOutputs = await defaultEdgeLambda({
const defaultEdgeLambdaInput = {
description: "Default Lambda@Edge for Next CloudFront distribution",
handler: "index.handler",
code: join(nextConfigPath, DEFAULT_LAMBDA_CODE_DIR),
Expand All @@ -445,7 +454,13 @@ class NextjsComponent extends Component {
},
memory: getLambdaMemory("defaultLambda"),
timeout: getLambdaTimeout("defaultLambda")
});
};
const defaultLambdaName = getLambdaName("defaultLambda");
if (defaultLambdaName) defaultEdgeLambdaInput.name = defaultLambdaName;

const defaultEdgeLambdaOutputs = await defaultEdgeLambda(
defaultEdgeLambdaInput
);

const defaultEdgeLambdaPublishOutputs = await defaultEdgeLambda.publishVersion();

Expand Down