feat(jobs): move job scheduler starter to after api #4064
Conversation
Ref: ENG-433 Ref: #1040 Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
|
Caution Review failedThe pull request is closed. WalkthroughA new Changes
Sequence Diagram(s)sequenceDiagram
participant APIStack
participant JobsScheduler
participant ScheduledLambda
APIStack->>JobsScheduler: createJobsScheduler(props)
JobsScheduler->>ScheduledLambda: createScheduledLambda(config)
ScheduledLambda-->>JobsScheduler: Lambda scheduled
JobsScheduler-->>APIStack: Scheduler setup complete
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
npm error code ERR_SSL_WRONG_VERSION_NUMBER 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/infra/lib/jobs/jobs-scheduler.ts (1)
17-24: Consider making the function name configurable.The
getSettingsfunction works correctly, but the hardcoded function name "StartPatientJobsScheduler" reduces flexibility. Consider making it configurable through the config or props.function getSettings(props: JobsSchedulerProps, config: NonNullable<EnvConfig["jobs"]>) { return { ...props, - name: "StartPatientJobsScheduler", + name: config.lambdaName ?? "StartPatientJobsScheduler", scheduleExpression: config.startPatientJobsSchedulerScheduleExpression, url: `http://${props.apiAddress}${config.startPatientJobsSchedulerUrl}`, }; }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
packages/infra/lib/api-stack.ts(2 hunks)packages/infra/lib/jobs/jobs-scheduler.ts(1 hunks)packages/infra/lib/jobs/jobs-stack.ts(0 hunks)
💤 Files with no reviewable changes (1)
- packages/infra/lib/jobs/jobs-stack.ts
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.ts`: - Use the Onion Pattern to organize a package's code in layers - Try to use immutable code and avoid sharing state across different functions, objects, and systems - Try...
**/*.ts: - Use the Onion Pattern to organize a package's code in layers
- Try to use immutable code and avoid sharing state across different functions, objects, and systems
- Try to build code that's idempotent whenever possible
- Prefer functional programming style functions: small, deterministic, 1 input, 1 output
- Minimize coupling / dependencies
- Avoid modifying objects received as parameter
- Only add comments to code to explain why something was done, not how it works
- Naming
- classes, enums:
PascalCase- constants, variables, functions:
camelCase- file names:
kebab-case- table and column names:
snake_case- Use meaningful names, so whoever is reading the code understands what it means
- Don’t use negative names, like
notEnabled, preferisDisabled- For numeric values, if the type doesn’t convey the unit, add the unit to the name
- Typescript
- Use types
- Prefer
constinstead oflet- Avoid
anyand casting fromanyto other types- Type predicates: only applicable to narrow down the type, not to force a complete type conversion
- Prefer deconstructing parameters for functions instead of multiple parameters that might be of
the same type- Don’t use
nullinside the app, only on code interacting with external interfaces/services,
like DB and HTTP; convert toundefinedbefore sending inwards into the code- Use
async/awaitinstead of.then()- Use the strict equality operator
===, don’t use abstract equality operator==- When calling a Promise-returning function asynchronously (i.e., not awaiting), use
.catch()to
handle errors (seeprocessAsyncErrorandemptyFunctiondepending on the case)- Date and Time
- Always use
buildDayjs()to createdayjsinstances- Prefer
dayjs.duration(...)to create duration consts and keep them asduration- Prefer Nullish Coalesce (??) than the OR operator (||) to provide a default value
- Avoid creating arrow functions
- Use truthy syntax instead of
in- i.e.,if (data.link)notif ('link' in data)- Error handling
- Pass the original error as the new one’s
causeso the stack trace is persisted- Error messages should have a static message - add dynamic data to MetriportError's
additionalInfoprop- Avoid sending multiple events to Sentry for a single error
- Global constants and variables
- Move literals to constants declared after imports when possible (avoid magic numbers)
- Avoid shared, global objects
- Avoid using
console.logandconsole.errorin packages other than utils, infra and shared,
and try to useout().loginstead- Avoid multi-line logs
- don't send objects as a second parameter to
console.log()orout().log()- don't create multi-line strings when using
JSON.stringify()- Use
eslintto enforce code style- Use
prettierto format code- max column length is 100 chars
- multi-line comments use
/** */- scripts: top-level comments go after the import
packages/infra/lib/api-stack.tspackages/infra/lib/jobs/jobs-scheduler.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: check-branch
- GitHub Check: check-pr / lint-build-test
🔇 Additional comments (3)
packages/infra/lib/api-stack.ts (2)
49-49: LGTM: Clean import addition.The import follows the established pattern and correctly imports the new scheduler module.
740-746: LGTM: Proper integration of job scheduler setup.The call to
createJobsScheduleris well-positioned after the API service creation, which aligns with the PR objective of moving the job scheduler starter to after API initialization. The parameters passed are consistent with similar function calls in this file.packages/infra/lib/jobs/jobs-scheduler.ts (1)
9-15: LGTM: Well-defined interface.The
JobsSchedulerPropstype clearly defines the required parameters with appropriate types. The optionalalarmSnsActionparameter follows AWS CDK patterns.
| }; | ||
| } | ||
|
|
||
| export function createJobsScheduler(props: JobsSchedulerProps) { |
|
|
||
| export function createJobsScheduler(props: JobsSchedulerProps) { | ||
| const config = getConfig(); | ||
| if (!config.jobs) return; |
There was a problem hiding this comment.
hypernit: explicitly return undefined
Ref: ENG-433 Ref: #1040 Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-433
Issues:
Description
Testing
Release Plan
Summary by CodeRabbit
New Features
Chores