meemaw/serverless-offline-schedule

Emulate schedule events locally when developing your Serverless project

serverless-offline-schedule

Install Plugin

npm install --save-dev serverless-offline-schedule

Then in serverless.yml add following entry to the plugins array: serverless-offline-schedule

plugins:
  - serverless-offline-schedule

Using the Plugin

Standalone process

λ → sls schedule
Serverless: Starting serverless-offline-schedule in standalone process. Press CTRL+C to stop.
Serverless: Scheduling [schedule-function] cron: [*/1 * * * *] input: {"scheduler":"1-minute"}
...
Serverless: Succesfully invoked scheduled function: [my-function]

Part of serverless-offline

serverless-offline-schedule will automatically hook into serverless-offline start command hook.

λ → sls offline
...
Serverless: Scheduling [schedule-function] cron: [*/1 * * * *] input: {"scheduler":"1-minute"}
...
Serverless: Succesfully invoked scheduled function: [my-function]

serverless-offline-schedule's Issues

bugfix request: honor enabled=false in scheduled tasks

Hi Meemaw

I am not sure if this is the issue from serverless-offline or from serverless-offline-schedule but enabled: false is not honored when we run scheduled tasks offline.

for example, the example function below would run in serverless-offline:

functions:
  aggregate:
    handler: statistics.handler
    events:
      - schedule:
          rate: rate(10 minutes)
          enabled: false

I am no expert in ts script, but I think the issue lies in src/scheduler.ts, line 62, as of now (commit 4131224)

  private getFunctionConfigurations = (): FunctionConfiguration[] => {
    const functions = this.functionProvider();

    const scheduleConfigurations = Object.keys(functions).map(functionName => {
      const functionConfig = functions[functionName];
      const { events } = functionConfig;
      const scheduleEvents = events.filter(event => event.hasOwnProperty('schedule'));

      return scheduleEvents.map(event => {                                                                        //  <====line 62
        return {
          functionName,
          cron: convertExpressionToCron(event['schedule'].rate),
          input: event['schedule'].input || {},
        };
      });
    });

    return flatten(scheduleConfigurations);
  };

We should probably filter out the scheduleEvents that is disabled:

      return scheduleEvents.filter(event=>
          event.schedule.enabled
        )
        .map(event => {
          return {
            functionName,
            cron: convertExpressionToCron(event['schedule'].rate),
            input: event['schedule'].input || {},
          };
        });

I can prepare a PR if you are occupied. If you could briefly show me how to build, lint and test, that would be great. It may take me longer than expected as I am a newb in TS.
Looking forward to your feedback. Thanks.

Best
Joe

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

scheduleRate.startsWith is not a function

I am getting the error: scheduleRate.startsWith is not a function while using the plugin. I am using version 1.0.4 with serverless version 2.53.0.

Here is how my schedule looks like:
events: - schedule: description: "Test" rate: "rate(2 minutes)" enabled: true
I did try logging where the error appeard to come form and i see:

Scheduled Event: [ 'rate(2 minutes)' ]

It seems to be an Array and .startsWith fails as its not a string in function: exports.convertExpressionToCron