add hook before:step-functions-offline:start #313

vkkis93 · 2018-01-25T14:49:08Z

What did you implement:

Integration serverless-step-functions-offline with serverless-webpack

How did you implement it:

Just add hook 'before:step-functions-offline:start'

How can we verify it:

Run serverless-step-functions-offline plugin in serverless project where serverless-webpack will be first runned

plugins:
   - serverless-webpack
   ...
   - serverless-step-functions-offline

Todos:

Write tests
Write documentation
Fix linting errors
Make sure code coverage hasn't dropped
Provide verification config / commands / resources
Enable "Allow edits from maintainers" for this PR
Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

HyperBrain · 2018-01-25T14:54:10Z

Hey @vkkis93 , nice addition 👍 Will be part of the next release.

Are there any caveats if using step-functions offline together with serverless-offline, or is that not possible?

HyperBrain · 2018-01-25T14:56:30Z

index.js

@@ -153,6 +153,9 @@ class ServerlessWebpack {
        .then(this.prepareOfflineInvoke)
        .then(this.wpwatch),

+      'before:step-functions-offline:start': () => BbPromise.bind(this)
+        .then(this.validate)
+        .then(this.compile)


Watch will automatically watch for source changes. Both functionalities (offline watch and invoke local watch) set the base directory for the execution properly, e.g. for serverless-offline the location parameter is set correctly.

If there is something similar for the step-functions that needs to be done, we had to add a different "watch" or "prepare" function for step (e.g. stepWatch).

Instead of using .then(this.validate).then(this.compile) need to create separate function for plugin ?

Only if we want to support watch mode and if step-offline needs to know the compiled directory, then you can do:

.then(this.validate) .then(this.prepareStepOffline) <<<--- see here .then(this.wpwatch)

The new prepareStepOffline function should then do something similar as https://github.com/serverless-heaven/serverless-webpack/blob/master/lib/prepareOfflineInvoke.js, only that it prepares the root folder for the step-offline plugin.

Otherwise the step-offline will just run on the uncompiled code.

Need only compile code once, run step-offline and stop process.
I don't need to have watch mode
About compiled directory, user will indicate the path to directory by himself in plugin settings.

Referring to my requirements - need to change something or this code makes sense?

Makes sense with the compile, yes.

However:

About compiled directory, user will indicate the path to directory by himself.

That will not really work out, if you set package: individually. Then the compiled code will then be distributed. I think you need a "prepare" function because for the offline, it has to be set to service packaging (then the output directory is ".webpack/service") like in the prepareOffline.

With individual packaging it is ".webpack/" which is not predictable.

Can you give me the link to your plugin. Maybe I have some time over the weekend to have a look, if we can combine this in an easy and compatible way there.

@HyperBrain but looks like your approach very good.
Makes sense to rewrite it.
Only one question, serverless-webpack compiles all functions which described in section functions in serverless.yml ?

Great,
I update this pull request to Is this ready for review?: NO at this moment.
When I will rewrite code, I will notify you

Good idea. I'm already excited 😄

vkkis93 · 2018-02-20T22:02:08Z

Hi @HyperBrain .
I have changed my code and now PR is ready for review.
The only one problem I see it's coveralls.
Need to write some tests on my new file ?

HyperBrain

Hi @vkkis93 , happy to see this done now ;-)

Please add a unit test (similar to the one for serverless-offline prepare) to have the coverage up again.

HyperBrain · 2018-02-21T10:10:25Z

index.js

@@ -153,6 +155,10 @@ class ServerlessWebpack {
        .then(this.prepareOfflineInvoke)
        .then(this.wpwatch),

+      'before:step-functions-offline:start': () => BbPromise.bind(this)
+         .then(this.validate)


You already spawn the webpack:validate in the prepareStepOfflineInvoke function, so you can remove the line here.

ahh, you're right.
I missed that

vkkis93 · 2018-02-21T14:25:32Z

@HyperBrain can you show the example of unit tests for serverless-offline ?

HyperBrain · 2018-02-21T14:28:38Z

Oops. Just saw that these unit test are also missing.

I will add the prepare unit tests for StepOffline to this PR, so you don't have to take care of them 😄

vkkis93 · 2018-02-21T14:37:29Z

@HyperBrain great news ☺️

vkkis93 · 2018-02-26T19:31:48Z

Hi @HyperBrain .
What should be done in order to close this PR?

HyperBrain · 2018-02-26T20:07:14Z

I'll finish it tomorrow and merge it. Sorry for the delay, was busy over the weekend ;-)

j0k3r · 2018-02-26T20:58:56Z

lib/prepareStepOfflineInvoke.js

+const path = require('path');
+
+/**
+ * Special settings for use with serverless-offline.


This should be step-functions-offline instead of serverless-offline.

Changed
Should be serverless-step-functions-offline (it's name of plugin)

vkkis93 · 2018-02-27T08:03:02Z

Thanks a lot

HyperBrain · 2018-02-27T11:26:26Z

The new implementation is now covered 100%. The decrease is because a different unrelated file is not correctly tested. I will merge this PR now and fix the other unit test in a separate PR.
@vkkis93 Thanks again for the PR 👍

j0k3r · 2018-02-27T11:54:14Z

@vkkis93 Good job!

stephanschubert · 2018-02-27T12:14:12Z

👍 Looking forward to 4.4.0

HyperBrain · 2018-03-02T13:06:33Z

Released with 4.4.0

add hook *before:step-functions-offline:start*

vkkis93 added 2 commits January 25, 2018 16:38

add hook *before:step-functions-offline:start*

c9dbb6c

use compile instead of wpwatch

f78d5e9

HyperBrain reviewed Jan 25, 2018

View reviewed changes

vkkis93 added 3 commits February 10, 2018 21:16

Update index.js

a1631bc

Create prepareStepOfflineInvoke.js

bab15c8

fix eslint

ba7ec41

HyperBrain requested changes Feb 21, 2018

View reviewed changes

Update index.js

b4e98d2

vkkis93 mentioned this pull request Feb 26, 2018

Compatibility with serverless-webpack vkkis93/serverless-step-functions-offline#3

Closed

j0k3r requested changes Feb 26, 2018

View reviewed changes

Update prepareStepOfflineInvoke.js

bd46cd9

j0k3r approved these changes Feb 27, 2018

View reviewed changes

HyperBrain added this to the 4.4.0 milestone Feb 27, 2018

Added unit tests for prepareStepOfflineInvoke

20f84a1

Added step-offline to separate supported plugins section

245ced2

HyperBrain merged commit d38a385 into serverless-heaven:master Feb 27, 2018

This was referenced Sep 23, 2018

Update dependency serverless-webpack to v4.4.0 - autoclosed y13i/amirotate#15

Closed

Update dependency serverless-webpack to v5 - autoclosed y13i/amirotate#22

Closed

This was referenced Sep 23, 2018

Update dependency serverless-webpack to v4.4.0 otofu-square/serverless-kinesis#46

Open

Update dependency serverless-webpack to v5 otofu-square/serverless-kinesis#48

Open

jamesmbourne pushed a commit to jamesmbourne/serverless-webpack that referenced this pull request Oct 15, 2019

Merge pull request serverless-heaven#313 from vkkis93/master

3432b66

add hook *before:step-functions-offline:start*

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add hook before:step-functions-offline:start #313

add hook before:step-functions-offline:start #313

vkkis93 commented Jan 25, 2018 •

edited

Loading

HyperBrain commented Jan 25, 2018

HyperBrain Jan 25, 2018 •

edited

Loading

vkkis93 Jan 25, 2018

HyperBrain Jan 25, 2018 •

edited

Loading

vkkis93 Jan 25, 2018 •

edited

Loading

HyperBrain Jan 25, 2018

HyperBrain Jan 25, 2018

vkkis93 Jan 25, 2018 •

edited

Loading

HyperBrain Jan 25, 2018

vkkis93 Jan 25, 2018

HyperBrain Jan 25, 2018

vkkis93 commented Feb 20, 2018 •

edited

Loading

HyperBrain left a comment

HyperBrain Feb 21, 2018

vkkis93 Feb 21, 2018

vkkis93 commented Feb 21, 2018

HyperBrain commented Feb 21, 2018

vkkis93 commented Feb 21, 2018

vkkis93 commented Feb 26, 2018

HyperBrain commented Feb 26, 2018

j0k3r Feb 26, 2018

vkkis93 Feb 27, 2018 •

edited

Loading

vkkis93 commented Feb 27, 2018

HyperBrain commented Feb 27, 2018

j0k3r commented Feb 27, 2018

stephanschubert commented Feb 27, 2018

HyperBrain commented Mar 2, 2018

add hook *before:step-functions-offline:start* #313

add hook *before:step-functions-offline:start* #313

Conversation

vkkis93 commented Jan 25, 2018 • edited Loading

What did you implement:

How did you implement it:

How can we verify it:

Todos:

HyperBrain commented Jan 25, 2018

HyperBrain Jan 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HyperBrain Jan 25, 2018 • edited Loading

Choose a reason for hiding this comment

vkkis93 Jan 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vkkis93 Jan 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vkkis93 commented Feb 20, 2018 • edited Loading

HyperBrain left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vkkis93 commented Feb 21, 2018

HyperBrain commented Feb 21, 2018

vkkis93 commented Feb 21, 2018

vkkis93 commented Feb 26, 2018

HyperBrain commented Feb 26, 2018

Choose a reason for hiding this comment

vkkis93 Feb 27, 2018 • edited Loading

Choose a reason for hiding this comment

vkkis93 commented Feb 27, 2018

HyperBrain commented Feb 27, 2018

j0k3r commented Feb 27, 2018

stephanschubert commented Feb 27, 2018

HyperBrain commented Mar 2, 2018

add hook before:step-functions-offline:start #313

add hook before:step-functions-offline:start #313

vkkis93 commented Jan 25, 2018 •

edited

Loading

HyperBrain Jan 25, 2018 •

edited

Loading

HyperBrain Jan 25, 2018 •

edited

Loading

vkkis93 Jan 25, 2018 •

edited

Loading

vkkis93 Jan 25, 2018 •

edited

Loading

vkkis93 commented Feb 20, 2018 •

edited

Loading

vkkis93 Feb 27, 2018 •

edited

Loading