├── .eslintrc.js ├── .gitignore ├── .prettierrc ├── LICENSE.md ├── README.md ├── examples ├── infrastructure │ ├── .gitignore │ ├── .npmignore │ ├── README.md │ ├── bin │ │ └── infrastructure.ts │ ├── cdk.json │ ├── package.json │ ├── tsconfig.json │ └── yarn.lock ├── lambda.test.ts ├── local.test.ts ├── queue.test.ts └── scenarios.ts ├── jest.config.dist.js ├── jest.config.js ├── jest.integration.js ├── package.json ├── src ├── address-parser │ ├── default.test.ts │ └── default.ts ├── automation │ ├── automation.js │ ├── index.js │ └── ssm-adapter.js ├── backend │ ├── aws │ │ ├── aws.ts │ │ ├── cloudmap.ts │ │ ├── lambda.ts │ │ ├── sns.ts │ │ └── sqs.ts │ ├── backend.ts │ └── mock │ │ ├── backend.test.ts │ │ ├── function.ts │ │ ├── mock.ts │ │ ├── pubsub.ts │ │ ├── queue.ts │ │ ├── registry.ts │ │ └── types.ts ├── call-service.js ├── call-service.test.js ├── events │ ├── index.js │ ├── publisher.js │ ├── sns.js │ └── subscriber.js ├── functions │ ├── func.js │ ├── index.js │ └── lambda-adapter.js ├── helpers │ ├── call-service-helper.js │ └── call-service-helper.test.js ├── index.js ├── index.ts ├── poller │ └── poller.ts ├── queue │ ├── index.js │ ├── queue.js │ └── sqs.js ├── services │ ├── cloudmap-adapter.js │ ├── index.js │ └── services.js ├── state-machine │ ├── index.js │ ├── state-machine.js │ └── step-function-adapter.js └── types │ └── index.ts ├── tsconfig.json └── yarn.lock /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | "env": { 3 | "browser": true, 4 | "es6": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended", 8 | "plugin:@typescript-eslint/eslint-recommended" 9 | ], 10 | "globals": { 11 | "Atomics": "readonly", 12 | "SharedArrayBuffer": "readonly" 13 | }, 14 | "parser": "@typescript-eslint/parser", 15 | "parserOptions": { 16 | "ecmaVersion": 2018, 17 | "sourceType": "module" 18 | }, 19 | "plugins": [ 20 | "@typescript-eslint" 21 | ], 22 | "rules": { 23 | "no-unused-vars": "off", 24 | "@typescript-eslint/no-unused-vars": "warn" // We have a few interfaces that contain vars that aren't applicable to all cases 25 | } 26 | }; -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | _test.js 3 | .idea 4 | lib 5 | dist 6 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "trailingComma": "all", 3 | "tabWidth": 2, 4 | "endOfLine": "lf", 5 | "singleQuote": true 6 | } -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Cloud Application Framework 2 | 3 | ## Description 4 | This repository interfaces Service Discovery, in this instance CloudMap, in order to locate and communicate with different services. As opposed to storing ARN's in environment variables, this library will interface CloudMap to find a service by a user friendly naming convention, and will understand what 'type' of service you've requested, and use the correct code to communicate/call that service. 5 | 6 | ## Services supported 7 | 8 | - Lambda (`request`|`call`). 9 | - SNS (`publish`). // subscribe not supported by SNS. 10 | - SQS (`queue`|`listen`), 11 | - Automation//SSM task (`automate` | `script`). 12 | - Step function (`state-machine`). 13 | 14 | ## Examples: 15 | 16 | ### Import 17 | 18 | ```javascript 19 | const ServiceDiscovery = require('@peak-ai/ais-service-discovery'); 20 | ``` 21 | 22 | ### Call a function 23 | 24 | ```javascript 25 | await ServiceDiscovery.request('namespace.service->handler', body); 26 | ``` 27 | 28 | ### Publish an SNS event 29 | 30 | ```javascript 31 | await ServiceDiscovery.publish('namspace.service-name->topic', event, { 32 | ...opts, 33 | attributes: { // Matches params.MessageAttributes from aws-sdk 34 | tenant: { 35 | DataType: 'String', 36 | StringValue: 'foo', 37 | }, 38 | }, 39 | }); 40 | ``` 41 | 42 | ### Add message to queue 43 | ```javascript 44 | await ServiceDiscovery.queue('namespace.service-name->queue-name', message, opts // optional); 45 | ``` 46 | 47 | ### List to queue 48 | ```javascript 49 | const messages = await ServiceDiscovery.listen('namespace.service-name->queue-name', opts // optional); 50 | messages.on('message', (message) => { 51 | 52 | }); 53 | ``` 54 | 55 | ### Register a service (Cloudformation) 56 | ```yaml 57 | CloudMapService: 58 | Type: AWS::ServiceDiscovery::Service 59 | Properties: 60 | Description: discover handlers for ais-service-segment-explorer 61 | Name: segment-explorer 62 | NamespaceId: ${cf:ais-${opt:stage}-service-discovery.NamespaceId} 63 | 64 | CreateRefreshSegmentInstance: 65 | Type: "AWS::ServiceDiscovery::Instance" 66 | Properties: 67 | InstanceAttributes: 68 | arn: ${self:service}-${opt:stage}-refresh-segment 69 | type: function 70 | InstanceId: refresh-segment 71 | ServiceId: 72 | Ref: CloudMapService 73 | ``` 74 | 75 | 76 | ## Upcoming Beta version 77 | 78 | We're releasing an update which allows you to configure and write modular 'backends' for the core service discovery library. 79 | 80 | In this new version we're also introducing Typescript. 81 | 82 | For example (previous): 83 | ```typescript 84 | const ServiceDiscovery = require('@peak-ai/ais-service-discovery-js'); 85 | ServiceDiscovery.request('latest.service->instance', request); 86 | ``` 87 | 88 | The above example only deals with AWS, and there's no way to reconfigure this behaviour. 89 | 90 | This is fairly limiting, especially for testing locally. We came up with the idea of being able to 'mock' or 'stub' these requests locally, for a faster development process. 91 | 92 | New example: 93 | ```typescript 94 | import { WithMockedBackend, WithAWSBackend } from "@peak-ai/ais-service-discovery-js"; 95 | 96 | // Config to decide what to do locally 97 | const config = { 98 | "latest.service->instance": { 99 | resolver: { mockedResponse: { message: 'Hello World' } }, 100 | }, 101 | }; 102 | 103 | // Responds with mocked responses 104 | const local = WithMockedBackend(config); 105 | const res = await local.request('latest.service->instance', request); 106 | 107 | // Communicates via SQS 108 | const prod = WithAWSBackend(); 109 | await prod.queue('latest.service->instance', request); 110 | ``` 111 | 112 | ### Integration Tests 113 | 114 | #### Prerequisites 115 | 1. AWS Account Access 116 | 2. Run the infrastructure CDK plan, found in ./examples/infrastructure (follow the instructions in the README there). 117 | 3. Ensure you have your AWS_PROFILE, and AWS_REGION env vars set correctly. 118 | 119 | 120 | #### Run integration tests 121 | ```bash 122 | $ yarn run test:integration 123 | ``` 124 | -------------------------------------------------------------------------------- /examples/infrastructure/.gitignore: -------------------------------------------------------------------------------- 1 | *.js 2 | !jest.config.js 3 | *.d.ts 4 | node_modules 5 | 6 | # CDK asset staging directory 7 | .cdk.staging 8 | cdk.out 9 | 10 | # Parcel default cache directory 11 | .parcel-cache 12 | -------------------------------------------------------------------------------- /examples/infrastructure/.npmignore: -------------------------------------------------------------------------------- 1 | *.ts 2 | !*.d.ts 3 | 4 | # CDK asset staging directory 5 | .cdk.staging 6 | cdk.out 7 | -------------------------------------------------------------------------------- /examples/infrastructure/README.md: -------------------------------------------------------------------------------- 1 | # Test Infrastructure 2 | This is a test CDK set-up, which generates some basic infrastructure used to test this library. 3 | 4 | Use the following commands to generate/create: 5 | 6 | ## Useful commands 7 | 8 | * `npm run build` compile typescript to js 9 | * `npm run watch` watch for changes and compile 10 | * `npm run test` perform the jest unit tests 11 | * `cdk deploy` deploy this stack to your default AWS account/region 12 | * `cdk diff` compare deployed stack with current state 13 | * `cdk synth` emits the synthesized CloudFormation template 14 | -------------------------------------------------------------------------------- /examples/infrastructure/bin/infrastructure.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import 'source-map-support/register'; 3 | import * as cdk from '@aws-cdk/core'; 4 | import { InfrastructureStack } from '../lib/infrastructure-stack'; 5 | 6 | const app = new cdk.App(); 7 | new InfrastructureStack(app, 'InfrastructureStack'); 8 | -------------------------------------------------------------------------------- /examples/infrastructure/cdk.json: -------------------------------------------------------------------------------- 1 | { 2 | "app": "npx ts-node bin/infrastructure.ts", 3 | "context": { 4 | "@aws-cdk/core:enableStackNameDuplicates": "true", 5 | "aws-cdk:enableDiffNoFail": "true", 6 | "@aws-cdk/core:stackRelativeExports": "true" 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /examples/infrastructure/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "infrastructure", 3 | "version": "0.1.0", 4 | "bin": { 5 | "infrastructure": "bin/infrastructure.js" 6 | }, 7 | "scripts": { 8 | "build": "tsc", 9 | "watch": "tsc -w", 10 | "test": "jest", 11 | "cdk": "cdk" 12 | }, 13 | "devDependencies": { 14 | "@aws-cdk/assert": "1.62.0", 15 | "@types/jest": "^26.0.10", 16 | "@types/node": "10.17.27", 17 | "aws-cdk": "1.62.0", 18 | "jest": "^26.4.2", 19 | "ts-jest": "^26.2.0", 20 | "ts-node": "^8.1.0", 21 | "typescript": "~3.9.7" 22 | }, 23 | "dependencies": { 24 | "@aws-cdk/aws-lambda": "^1.62.0", 25 | "@aws-cdk/aws-servicediscovery": "^1.62.0", 26 | "@aws-cdk/aws-sns": "^1.62.0", 27 | "@aws-cdk/aws-sqs": "^1.62.0", 28 | "@aws-cdk/core": "1.62.0", 29 | "source-map-support": "^0.5.16" 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /examples/infrastructure/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ES2018", 4 | "module": "commonjs", 5 | "lib": ["es2018"], 6 | "declaration": true, 7 | "strict": true, 8 | "noImplicitAny": true, 9 | "strictNullChecks": true, 10 | "noImplicitThis": true, 11 | "alwaysStrict": true, 12 | "noUnusedLocals": false, 13 | "noUnusedParameters": false, 14 | "noImplicitReturns": true, 15 | "noFallthroughCasesInSwitch": false, 16 | "inlineSourceMap": true, 17 | "inlineSources": true, 18 | "experimentalDecorators": true, 19 | "strictPropertyInitialization": false, 20 | "typeRoots": ["./node_modules/@types"] 21 | }, 22 | "exclude": ["cdk.out"] 23 | } 24 | -------------------------------------------------------------------------------- /examples/lambda.test.ts: -------------------------------------------------------------------------------- 1 | import { WithAwsBackend } from '../src'; 2 | import * as scenarios from './scenarios'; 3 | import * as ServiceDiscovery from '../src'; 4 | 5 | describe('(v3:Function:Lambda)', () => { 6 | it('should get a response from a lambda', async () => { 7 | const sd = WithAwsBackend(); 8 | const response = await scenarios.makeRequest(sd); 9 | expect(response.body).toEqual('test'); 10 | }); 11 | }); 12 | 13 | describe('(v2:Function:Lambda)', () => { 14 | it('should get a response from a lambda', async () => { 15 | const response = await scenarios.makeRequest(ServiceDiscovery); 16 | expect(response.body).toEqual('test'); 17 | }); 18 | }); 19 | -------------------------------------------------------------------------------- /examples/local.test.ts: -------------------------------------------------------------------------------- 1 | import { WithMockBackend } from '../src'; 2 | 3 | describe('(Local Backend)', () => { 4 | it('should', async () => { 5 | const config = { 6 | 'namespace.service->instance': { 7 | type: 'function', 8 | resolve: { 9 | mockedResponse: 'This is a test', 10 | }, 11 | }, 12 | }; 13 | const sd = WithMockBackend(config); 14 | 15 | const request = { 16 | body: JSON.stringify({ 17 | hello: 'world', 18 | }), 19 | }; 20 | const response = await sd.request( 21 | 'namespace.service->instance', 22 | request, 23 | {}, 24 | ); 25 | expect(response.body).toEqual('This is a test'); 26 | }); 27 | }); 28 | -------------------------------------------------------------------------------- /examples/queue.test.ts: -------------------------------------------------------------------------------- 1 | import { WithAwsBackend } from '../src'; 2 | import * as scenarios from './scenarios'; 3 | import * as ServiceDiscovery from '../src'; 4 | 5 | const QUEUE_AND_LISTEN = 'should queue a message and listen for the result'; 6 | 7 | describe('(v3:Queue:SQS)', () => { 8 | it(QUEUE_AND_LISTEN, async () => { 9 | const sd = WithAwsBackend(); 10 | const request = 'hello world'; 11 | await scenarios.queueMessage(sd, request); 12 | const result = await scenarios.listenForMessage(sd); 13 | expect(result).toEqual(request); 14 | }); 15 | }); 16 | 17 | describe('(v2:Queue:SQS)', () => { 18 | it(QUEUE_AND_LISTEN, async () => { 19 | const request = 'hello world'; 20 | await scenarios.queueMessageLegacy(ServiceDiscovery, request); 21 | const result = await scenarios.listenForMessage(ServiceDiscovery); 22 | expect(result).toEqual(request); 23 | }); 24 | }); 25 | -------------------------------------------------------------------------------- /examples/scenarios.ts: -------------------------------------------------------------------------------- 1 | import Backend from '../src/backend/backend'; 2 | import { Request, Response } from '../src/types'; 3 | 4 | // @ts-ignore - ServiceDiscovery is legacy and not ts, just so happens 5 | // that it satisfies the same interface. 6 | export const makeRequest = (sd: any, body = ''): Promise => { 7 | const request = { body }; 8 | return sd.request( 9 | 'test-namespace.test-service->my-func-instance', 10 | request, 11 | {}, 12 | ); 13 | }; 14 | 15 | const expectUUID = (u: string) => 16 | expect(u).toEqual( 17 | expect.stringMatching( 18 | /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/, 19 | ), 20 | ); 21 | 22 | export const queueMessage = async (sd: Backend, message: Request) => { 23 | const response = await sd.queue( 24 | 'test-namespace.test-service->my-queue-instance', 25 | message, 26 | ); 27 | 28 | expectUUID(response.id); 29 | return response; 30 | }; 31 | 32 | // @ts-ignore 33 | export const queueMessageLegacy = async (sd: any, message: Request) => { 34 | const response = await sd.queue( 35 | 'test-namespace.test-service->my-queue-instance', 36 | message, 37 | ); 38 | 39 | // Expect a UUID 40 | expectUUID(response.MessageId); 41 | 42 | return response; 43 | }; 44 | 45 | export const listenForMessage = async (sd: Backend) => { 46 | const results = await sd.listen( 47 | 'test-namespace.test-service->my-queue-instance', 48 | ); 49 | 50 | const listen = (results) => 51 | new Promise((resolve, _) => { 52 | results.on('message', (message) => { 53 | results.stop(); 54 | message.delete(message.id); 55 | const m = JSON.parse(message.message); 56 | resolve(m); 57 | }); 58 | }); 59 | 60 | return await listen(results); 61 | }; 62 | 63 | export default { 64 | makeRequest, 65 | queueMessage, 66 | }; 67 | -------------------------------------------------------------------------------- /jest.config.dist.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /* This config runs compiled tests against our compiled source 4 | * i.e. for our pre-commit hook, CI, and publish script. 5 | * As we run tsc to determine the syntactical validity 6 | * of our TypeScript source, as well as to build the output JS 7 | * for distribution. As we also compile the tests during this 8 | * phase, we can run them without the overhead of using the 9 | * ts-jest plugin, reducing overall execution time. */ 10 | 11 | // eslint-disable-next-line no-undef 12 | module.exports = { 13 | testEnvironment: 'node', 14 | testRegex: 'dist(/.*)?/.*.test.js$', 15 | }; 16 | -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /* This config is for local development, using 4 | * ts-jest to avoid having to manually recompiling source 5 | * changes with tsc before re-running tests. This setup is 6 | * particularly useful for Jest's watch mode */ 7 | 8 | // eslint-disable-next-line no-undef 9 | module.exports = { 10 | transform: { 11 | '^.+\\.ts$': 'ts-jest', 12 | }, 13 | testEnvironment: 'node', 14 | testRegex: ['src(/.*)?/.*.test.(ts|js)$'], 15 | moduleFileExtensions: ['ts', 'js', 'json'], 16 | globals: { 17 | 'ts-jest': { 18 | tsConfig: './tsconfig.json', 19 | diagnostics: false, 20 | }, 21 | }, 22 | }; 23 | -------------------------------------------------------------------------------- /jest.integration.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /* This config is for local development, using 4 | * ts-jest to avoid having to manually recompiling source 5 | * changes with tsc before re-running tests. This setup is 6 | * particularly useful for Jest's watch mode */ 7 | 8 | // eslint-disable-next-line no-undef 9 | module.exports = { 10 | transform: { 11 | '^.+\\.ts$': 'ts-jest', 12 | }, 13 | testEnvironment: 'node', 14 | testRegex: ['examples(/.*)?/.*.test.(ts|js)$'], 15 | moduleFileExtensions: ['ts', 'js', 'json'], 16 | globals: { 17 | 'ts-jest': { 18 | tsConfig: './tsconfig.json', 19 | diagnostics: false, 20 | }, 21 | }, 22 | }; 23 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@peak-ai/ais-service-discovery", 3 | "version": "1.0.0", 4 | "main": "dist/index.js", 5 | "types": "dist/index.d.ts", 6 | "repository": "git@github.com:peak-ai/ais-service-discovery-js.git", 7 | "author": "", 8 | "license": "MIT", 9 | "publishConfig": { 10 | "access": "public" 11 | }, 12 | "husky": { 13 | "hooks": { 14 | "pre-commit": "yarn format && yarn preupdate" 15 | } 16 | }, 17 | "scripts": { 18 | "lint": "eslint jest.config*js 'src/**/*.{ts,json}' 'examples/**/*.{ts,js,json}'", 19 | "format": "prettier --write jest.config*js 'src/**/*.{ts,json}' 'examples/**/*.{ts,js,json}'", 20 | "format:check": "prettier --check jest.config*js 'src/**/*.{ts,json}' 'examples/**/*.{ts,js,json}'", 21 | "build": "tsc -p .", 22 | "preupdate": "yarn lint && yarn build && yarn test:dist", 23 | "prepublishOnly": "yarn format:check && yarn preupdate", 24 | "test": "jest", 25 | "test:dist": "jest --config jest.config.dist.js", 26 | "test:integration": "jest --config jest.integration.js ./examples", 27 | "start": "tsc -p . -w" 28 | }, 29 | "devDependencies": { 30 | "@types/jest": "^26.0.13", 31 | "@types/node": "^14.6.2", 32 | "@typescript-eslint/eslint-plugin": "2.21.0", 33 | "@typescript-eslint/parser": "2.21.0", 34 | "eslint": "^7.8.1", 35 | "eslint-config-airbnb-base": "^13.1.0", 36 | "eslint-plugin-import": "^2.16.0", 37 | "eslint-plugin-jest": "^22.3.2", 38 | "husky": "^4.2.5", 39 | "jest": "^26.4.2", 40 | "prettier": "^2.1.1", 41 | "ts-jest": "^26.3.0", 42 | "ts-node": "^9.0.0", 43 | "typescript": "^4.0.2" 44 | }, 45 | "dependencies": { 46 | "@aws-sdk/client-lambda": "^3.461.0", 47 | "@aws-sdk/client-servicediscovery": "^3.461.0", 48 | "@aws-sdk/client-sfn": "^3.461.0", 49 | "@aws-sdk/client-sns": "^3.461.0", 50 | "@aws-sdk/client-sqs": "^3.461.0", 51 | "@aws-sdk/client-ssm": "^3.461.0", 52 | "ramda": "^0.27.2" 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /src/address-parser/default.test.ts: -------------------------------------------------------------------------------- 1 | import DefaultAddressParser from './default'; 2 | 3 | describe('(DefaultAddressParser)', () => { 4 | it('should parse addresses', () => { 5 | const addr = 'namespace.service->instance'; 6 | const parser = new DefaultAddressParser(); 7 | const result = parser.parse(addr); 8 | expect(result.namespace).toBe('namespace'); 9 | expect(result.service).toBe('service'); 10 | expect(result.instance).toBe('instance'); 11 | }); 12 | }); 13 | -------------------------------------------------------------------------------- /src/address-parser/default.ts: -------------------------------------------------------------------------------- 1 | import { IAddressParser, ServiceRequest } from '../types'; 2 | 3 | class DefaultAddressParser implements IAddressParser { 4 | parse(addr: string): ServiceRequest { 5 | const [namespace, rest] = addr.split('.'); 6 | const [service, instance] = rest.split('->'); 7 | return { 8 | instance, 9 | service, 10 | namespace, 11 | }; 12 | } 13 | } 14 | 15 | export default DefaultAddressParser; 16 | -------------------------------------------------------------------------------- /src/automation/automation.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class Automation { 4 | constructor(adapter) { 5 | this.adapter = adapter; 6 | } 7 | 8 | run(arn, body, opts) { 9 | return this.adapter.run(arn, body, opts); 10 | } 11 | } 12 | 13 | module.exports = Automation; 14 | -------------------------------------------------------------------------------- /src/automation/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const SSMAdapter = require('./ssm-adapter'); 4 | const Automation = require('./automation'); 5 | 6 | module.exports = { 7 | SSMAdapter, 8 | Automation, 9 | }; 10 | -------------------------------------------------------------------------------- /src/automation/ssm-adapter.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class SSMAdapter { 4 | constructor(client) { 5 | this.client = client; 6 | } 7 | 8 | run(name, body, params) { 9 | const ssmParams = { 10 | DocumentName: name, 11 | InstanceIds: body.instanceIds, 12 | }; 13 | if (params) ssmParams.Parameters = params; 14 | return this.client.sendCommand(ssmParams); 15 | } 16 | } 17 | 18 | module.exports = SSMAdapter; 19 | -------------------------------------------------------------------------------- /src/backend/aws/aws.ts: -------------------------------------------------------------------------------- 1 | import { Lambda } from '@aws-sdk/client-lambda'; 2 | import { ServiceDiscovery } from '@aws-sdk/client-servicediscovery'; 3 | import { SNS } from '@aws-sdk/client-sns'; 4 | import { SQS } from '@aws-sdk/client-sqs'; 5 | import Backend from '../backend'; 6 | 7 | import SNSAdapter from './sns'; 8 | import SQSAdapter from './sqs'; 9 | import LambdaAdapter from './lambda'; 10 | import CloudmapDiscoverAdapter from './cloudmap'; 11 | import DefaultAddressParser from '../../address-parser/default'; 12 | import Poller from '../../poller/poller'; 13 | 14 | // Convenience factory function 15 | export function WithAwsBackend() { 16 | return new Backend( 17 | new DefaultAddressParser(), 18 | new CloudmapDiscoverAdapter(new ServiceDiscovery()), 19 | new Poller(new SQSAdapter(new SQS())), 20 | new LambdaAdapter(new Lambda()), 21 | new SNSAdapter(new SNS()), 22 | ); 23 | } 24 | -------------------------------------------------------------------------------- /src/backend/aws/cloudmap.ts: -------------------------------------------------------------------------------- 1 | import { 2 | DiscoverInstancesCommandOutput, 3 | ServiceDiscovery, 4 | } from '@aws-sdk/client-servicediscovery'; 5 | import { 6 | Opts, 7 | ServiceResponse, 8 | IDiscoverAdapter, 9 | ServiceRequest, 10 | } from '../../types'; 11 | 12 | class CloudmapAdapter implements IDiscoverAdapter { 13 | private readonly client: ServiceDiscovery; 14 | 15 | constructor(client: ServiceDiscovery) { 16 | this.client = client; 17 | } 18 | 19 | private toParams(opts: Opts = {}): Record { 20 | const o = Object.entries(opts); 21 | return o.reduce((a, b) => { 22 | const [key, value] = b; 23 | return { 24 | ...a, 25 | [key]: value as string, 26 | }; 27 | }, {}); 28 | } 29 | 30 | /* 31 | * Discover will find multiple instances by a specified 32 | * object containing metadata registered against an instance. 33 | */ 34 | private discover( 35 | namespace: string, 36 | service: string, 37 | opts?: Opts, 38 | ): Promise { 39 | const params = { 40 | NamespaceName: namespace, 41 | ServiceName: service, 42 | QueryParameters: this.toParams(opts), 43 | }; 44 | return this.client.discoverInstances(params); 45 | } 46 | 47 | public async locate( 48 | serviceRequest: ServiceRequest, 49 | opts?: Opts, 50 | ): Promise { 51 | const { namespace, service, instance } = serviceRequest; 52 | 53 | // Find the service 54 | const res = await this.discover(namespace, service, opts); 55 | if (!res?.Instances) 56 | throw new Error(`no service found: ${namespace}.${service}->${instance}`); 57 | 58 | // Filter down to the specific instance 59 | const i = res.Instances.find((item) => item.InstanceId === instance); 60 | if (!i) { 61 | throw new Error('no valid instance found with given instance id'); 62 | } 63 | 64 | const attributes = i.Attributes; 65 | if (!attributes) { 66 | throw new Error( 67 | 'no attributed found, we need these to find a usable resource id', 68 | ); 69 | } 70 | 71 | // Create an array of all of the possible set ID's. We have to do this because initially we used 72 | // 'arn', then queues used 'url', then we decided we should try to use something agnostic, so 73 | // introduced 'rid' (resource id). But, in the interest of backwards compatibility, we should check them all. 74 | const identifiers = [ 75 | attributes['id'], 76 | attributes['arn'], 77 | attributes['url'], 78 | attributes['rid'], 79 | ]; 80 | 81 | // Find the id that's used, in theory this will just find the first from the above, 82 | // that isn't 'undefined', this could cause issues if people use multiple, or happen to use 83 | // one of those attribute values for something else. 84 | const rid = identifiers.find((a) => a !== undefined); 85 | 86 | return { 87 | rid: rid as string, 88 | attributes: i.Attributes, 89 | }; 90 | } 91 | } 92 | 93 | export default CloudmapAdapter; 94 | -------------------------------------------------------------------------------- /src/backend/aws/lambda.ts: -------------------------------------------------------------------------------- 1 | import { Lambda } from '@aws-sdk/client-lambda'; 2 | import { 3 | Opts, 4 | Request, 5 | Response, 6 | ServiceResponse, 7 | IFunctionAdapter, 8 | } from '../../types'; 9 | 10 | class LambdaAdapter implements IFunctionAdapter { 11 | private client: Lambda; 12 | 13 | constructor(client: Lambda) { 14 | this.client = client; 15 | } 16 | 17 | public async request( 18 | service: ServiceResponse, 19 | request: Request, 20 | opts?: Opts, 21 | ): Promise { 22 | const params = { 23 | ...opts, 24 | FunctionName: service.rid, 25 | Payload: JSON.stringify(request.body), 26 | }; 27 | 28 | const { Payload: payload, StatusCode: statusCode } = 29 | await this.client.invoke(params); 30 | return payload ? JSON.parse(payload.toString()) : statusCode; 31 | } 32 | } 33 | 34 | export default LambdaAdapter; 35 | -------------------------------------------------------------------------------- /src/backend/aws/sns.ts: -------------------------------------------------------------------------------- 1 | import { MessageAttributeValue, SNS as AWSSNS } from '@aws-sdk/client-sns'; 2 | import { 3 | IPubSubAdapter, 4 | Request, 5 | ServiceResponse, 6 | Opts, 7 | PubSubResponse, 8 | } from '../../types'; 9 | 10 | class SNS implements IPubSubAdapter { 11 | private client: AWSSNS; 12 | 13 | constructor(client: AWSSNS) { 14 | this.client = client; 15 | } 16 | 17 | private convertAttributes( 18 | opts: Opts = {}, 19 | ): Record { 20 | const kv = Object.entries(opts); 21 | return kv.reduce((a, b) => { 22 | const [key, value] = b; 23 | return { 24 | ...a, 25 | [key]: value, 26 | }; 27 | }, {}); 28 | } 29 | 30 | public async publish( 31 | service: ServiceResponse, 32 | request: Request, 33 | opts?: Opts, 34 | ): Promise { 35 | try { 36 | const response = await this.client.publish({ 37 | TopicArn: service.rid, 38 | Message: JSON.stringify(request.body), 39 | MessageAttributes: this.convertAttributes(opts), 40 | }); 41 | 42 | if (!response.MessageId) { 43 | throw new Error('Missing message ID in response'); 44 | } 45 | 46 | return { 47 | messageId: response.MessageId, 48 | }; 49 | } catch (err) { 50 | // Handle the error appropriately 51 | throw new Error(`Failed to publish to SNS topic: ${err}`); 52 | } 53 | } 54 | 55 | public async subscribe( 56 | service: ServiceResponse, 57 | request: Request, 58 | opts?: Opts, 59 | ): Promise { 60 | let protocol = 'http'; 61 | if (opts && opts['protocol']) { 62 | protocol = opts['protocol'] as string; 63 | } 64 | 65 | try { 66 | const response = await this.client.subscribe({ 67 | TopicArn: service.rid, 68 | Protocol: protocol, 69 | }); 70 | 71 | if (!response.SubscriptionArn) { 72 | throw new Error('Missing subscription ARN in response'); 73 | } 74 | 75 | return { 76 | rid: response.SubscriptionArn, 77 | }; 78 | } catch (err) { 79 | // Handle the error appropriately 80 | throw new Error(`Failed to subscribe to SNS topic: ${err}`); 81 | } 82 | } 83 | } 84 | 85 | export default SNS; 86 | -------------------------------------------------------------------------------- /src/backend/aws/sqs.ts: -------------------------------------------------------------------------------- 1 | import { SQS as AWSSQS } from '@aws-sdk/client-sqs'; 2 | import { 3 | Opts, 4 | Request, 5 | IMessage, 6 | IEventHandler, 7 | QueueResponse, 8 | IQueueAdapter, 9 | ServiceResponse, 10 | } from '../../types'; 11 | 12 | const DEFAULT_INTERVAL = 10; 13 | 14 | type SQSOpts = { 15 | interval: number; 16 | }; 17 | 18 | class SQS implements IQueueAdapter { 19 | private readonly client: AWSSQS; 20 | private opts?: SQSOpts; 21 | 22 | constructor(client: AWSSQS, opts?: SQSOpts) { 23 | this.client = client; 24 | this.opts = opts; 25 | } 26 | 27 | public async send( 28 | service: ServiceResponse, 29 | request: Request, 30 | opts?: Opts, 31 | ): Promise { 32 | const res = await this.client.sendMessage({ 33 | QueueUrl: service.rid, 34 | MessageBody: JSON.stringify(request), 35 | ...opts, 36 | }); 37 | 38 | const id = res.MessageId; 39 | 40 | if (!id) { 41 | throw new Error('no message id in response from sqs'); 42 | } 43 | 44 | return { id }; 45 | } 46 | 47 | public async listen( 48 | service: ServiceResponse, 49 | opts?: Opts, 50 | ): Promise { 51 | const { Messages } = await this.client.receiveMessage({ 52 | QueueUrl: service.rid, 53 | WaitTimeSeconds: 54 | (opts?.interval as number) || this.opts?.interval || DEFAULT_INTERVAL, 55 | }); 56 | if (!Messages) return null; 57 | const [message] = Messages; 58 | 59 | if ( 60 | [message.Body, message.MessageId, message.ReceiptHandle].some( 61 | (a) => a === null, 62 | ) 63 | ) { 64 | return null; 65 | } 66 | 67 | return { 68 | id: message.MessageId as string, 69 | message: message.Body as string, 70 | delete: this.delete(message.ReceiptHandle as string, service.rid), 71 | }; 72 | } 73 | 74 | public delete(receipt: string, url: string): () => Promise { 75 | return async () => { 76 | await this.client.deleteMessage({ 77 | QueueUrl: url, 78 | ReceiptHandle: receipt, 79 | }); 80 | }; 81 | } 82 | } 83 | 84 | export default SQS; 85 | -------------------------------------------------------------------------------- /src/backend/backend.ts: -------------------------------------------------------------------------------- 1 | import { 2 | Request, 3 | Response, 4 | ServiceResponse, 5 | IQueueAdapter, 6 | IFunctionAdapter, 7 | IDiscoverAdapter, 8 | IAddressParser, 9 | Opts, 10 | IPubSubAdapter, 11 | QueueResponse, 12 | PubSubResponse, 13 | } from '../types'; 14 | 15 | import Poller from '../poller/poller'; 16 | 17 | class Backend { 18 | private addressParser: IAddressParser; 19 | private discoverAdapter: IDiscoverAdapter; 20 | private queueAdapter: Poller; 21 | private functionAdapter: IFunctionAdapter; 22 | private pubsubAdapter: IPubSubAdapter; 23 | 24 | constructor( 25 | addressParser: IAddressParser, 26 | discoverAdapter: IDiscoverAdapter, 27 | queueAdapter: Poller, 28 | functionAdapter: IFunctionAdapter, 29 | pubsubAdapter: IPubSubAdapter, 30 | ) { 31 | this.addressParser = addressParser; 32 | this.discoverAdapter = discoverAdapter; 33 | this.queueAdapter = queueAdapter; 34 | this.functionAdapter = functionAdapter; 35 | this.pubsubAdapter = pubsubAdapter; 36 | } 37 | 38 | public async locate(addr: string): Promise { 39 | const service = this.addressParser.parse(addr); 40 | return this.discoverAdapter.locate(service, {}); 41 | } 42 | 43 | async queue( 44 | addr: string, 45 | request: Request, 46 | opts?: Opts, 47 | ): Promise { 48 | const s = await this.locate(addr); 49 | return this.queueAdapter.send(s, request, opts); 50 | } 51 | 52 | async listen(addr: string, opts?: Opts): Promise> { 53 | const s = await this.locate(addr); 54 | return this.queueAdapter.listen(s, opts); 55 | } 56 | 57 | public async request( 58 | addr: string, 59 | request: Request, 60 | opts?: Opts, 61 | ): Promise { 62 | const s = await this.locate(addr); 63 | return this.functionAdapter.request(s, request, opts); 64 | } 65 | 66 | async publish( 67 | addr: string, 68 | request: Request, 69 | opts?: Opts, 70 | ): Promise { 71 | const s = await this.locate(addr); 72 | return this.pubsubAdapter.publish(s, request, opts); 73 | } 74 | 75 | async subscribe( 76 | addr: string, 77 | request: Request, 78 | opts?: Opts, 79 | ): Promise { 80 | const s = await this.locate(addr); 81 | return this.pubsubAdapter.subscribe(s, opts); 82 | } 83 | } 84 | 85 | export default Backend; 86 | -------------------------------------------------------------------------------- /src/backend/mock/backend.test.ts: -------------------------------------------------------------------------------- 1 | import { WithMockBackend } from './mock'; 2 | import { IMessage, IQueueAdapter } from '../../types'; 3 | import Poller from '../../poller/poller'; 4 | 5 | describe('(Mock Backend)', () => { 6 | it('can make a request', async () => { 7 | const response = JSON.stringify({ hello: 'world' }); 8 | const config = { 9 | 'latest.service->my-func': { 10 | type: 'function', 11 | resolve: { 12 | mockedResponse: response, 13 | }, 14 | }, 15 | }; 16 | 17 | const request = { body: 'test' }; 18 | const sd = WithMockBackend(config); 19 | const actual = await sd.request('latest.service->my-func', request, {}); 20 | expect(actual.body).toBe(response); 21 | }); 22 | 23 | it('can queue a message', async () => { 24 | const response = 'abc123'; 25 | const config = { 26 | 'latest.service->my-queue': { 27 | type: 'queue', 28 | resolve: { 29 | mockedResponse: response, 30 | }, 31 | }, 32 | }; 33 | 34 | const sd = WithMockBackend(config); 35 | const request = { body: 'test' }; 36 | const actual = await sd.queue('latest.service->my-queue', request, {}); 37 | expect(actual.id).toBe(response); 38 | }); 39 | 40 | it('can subscribe to a queue', async () => { 41 | const response = 'message'; 42 | const config = { 43 | 'latest.service->my-queue': { 44 | type: 'queue', 45 | resolve: { 46 | mockedResponse: response, 47 | }, 48 | }, 49 | }; 50 | 51 | const sd = WithMockBackend(config); 52 | const results = await sd.listen('latest.service->my-queue'); 53 | const listen = (results: Poller) => 54 | new Promise((resolve, reject) => { 55 | results.on('message', (message: IMessage | null) => { 56 | results.stop(); 57 | if (message) { 58 | resolve(message); 59 | return; 60 | } 61 | 62 | reject(new Error('no message found')); 63 | }); 64 | }); 65 | 66 | const result = await listen(results); 67 | expect((result as IMessage)?.message).toBe(response); 68 | }); 69 | 70 | it('can publish an event', async () => { 71 | const response = 'message-id'; 72 | const config = { 73 | 'latest.service->my-topic': { 74 | type: 'pubsub', 75 | resolve: { 76 | mockedResponse: response, 77 | }, 78 | }, 79 | }; 80 | 81 | const sd = WithMockBackend(config); 82 | const request = { body: 'Test' }; 83 | const actual = await sd.publish('latest.service->my-topic', request, {}); 84 | expect(actual.messageId).toBe(response); 85 | }); 86 | 87 | it('should subscribe to an event', async () => { 88 | const response = 'message'; 89 | const config = { 90 | 'latest.service->my-topic': { 91 | type: 'pubsub', 92 | resolve: { 93 | mockedResponse: response, 94 | }, 95 | }, 96 | }; 97 | 98 | const sd = WithMockBackend(config); 99 | const request = { body: 'Test' }; 100 | const actual = await sd.publish('latest.service->my-topic', request, {}); 101 | expect(actual.messageId).toBe(response); 102 | }); 103 | }); 104 | -------------------------------------------------------------------------------- /src/backend/mock/function.ts: -------------------------------------------------------------------------------- 1 | import { 2 | IFunctionAdapter, 3 | Opts, 4 | ServiceResponse, 5 | Request, 6 | Response, 7 | } from '../../types'; 8 | import { Config } from './types'; 9 | 10 | class FunctionAdapter implements IFunctionAdapter { 11 | private readonly config: Config; 12 | 13 | constructor(config: Config) { 14 | this.config = config; 15 | } 16 | 17 | public async request( 18 | serviceRequest: ServiceResponse, 19 | request: Request, 20 | opts?: Opts, 21 | ): Promise { 22 | const s = this.config[serviceRequest.rid]; 23 | const payload = s.resolve.mockedResponse; 24 | if (!payload) { 25 | throw new Error( 26 | 'you must configure a mockedResponse property on your resolver for this addr', 27 | ); 28 | } 29 | 30 | return { 31 | body: payload, 32 | }; 33 | } 34 | } 35 | 36 | export default FunctionAdapter; 37 | -------------------------------------------------------------------------------- /src/backend/mock/mock.ts: -------------------------------------------------------------------------------- 1 | import { Config } from './types'; 2 | import DefaultAddressParser from '../../address-parser/default'; 3 | import QueueAdapter from './queue'; 4 | import FunctionAdapter from './function'; 5 | import RegistryAdapter from './registry'; 6 | import PubSubAdapter from './pubsub'; 7 | import Backend from '../backend'; 8 | import Poller from '../../poller/poller'; 9 | 10 | // Convenience factory function 11 | export function WithMockBackend(config: Config) { 12 | return new Backend( 13 | new DefaultAddressParser(), 14 | new RegistryAdapter(config), 15 | new Poller(new QueueAdapter(config)), 16 | new FunctionAdapter(config), 17 | new PubSubAdapter(config), 18 | ); 19 | } 20 | -------------------------------------------------------------------------------- /src/backend/mock/pubsub.ts: -------------------------------------------------------------------------------- 1 | import { 2 | IPubSubAdapter, 3 | Request, 4 | ServiceResponse, 5 | Opts, 6 | PubSubResponse, 7 | } from '../../types'; 8 | 9 | import { Config } from './types'; 10 | 11 | class PubSub implements IPubSubAdapter { 12 | private readonly config: Config; 13 | 14 | constructor(config: Config) { 15 | this.config = config; 16 | } 17 | 18 | async publish( 19 | service: ServiceResponse, 20 | request: Request, 21 | opts?: Opts, 22 | ): Promise { 23 | const s = service.rid; 24 | const config = this.config[s]; 25 | return { 26 | messageId: config.resolve?.mockedResponse as string, 27 | }; 28 | } 29 | 30 | async subscribe( 31 | service: ServiceResponse, 32 | request: Request, 33 | opts?: Opts, 34 | ): Promise { 35 | const s = service.rid; 36 | const config = this.config[s]; 37 | return { 38 | rid: config.resolve?.mockedResponse as string, 39 | }; 40 | } 41 | } 42 | 43 | export default PubSub; 44 | -------------------------------------------------------------------------------- /src/backend/mock/queue.ts: -------------------------------------------------------------------------------- 1 | import { 2 | Opts, 3 | Request, 4 | IQueueAdapter, 5 | QueueResponse, 6 | ServiceResponse, 7 | IMessage, 8 | } from '../../types'; 9 | import { Config } from './types'; 10 | 11 | class Queue implements IQueueAdapter { 12 | private readonly config: Config; 13 | private messages: Request[] = []; 14 | 15 | constructor(config: Config) { 16 | this.config = config; 17 | this.messages = []; 18 | } 19 | 20 | public async send( 21 | service: ServiceResponse, 22 | request: Request, 23 | opts?: Opts, 24 | ): Promise { 25 | const s = service.rid; 26 | const config = this.config[s]; 27 | this.messages.push(request); 28 | return { id: config.resolve.mockedResponse as string }; 29 | } 30 | 31 | public async listen( 32 | service: ServiceResponse, 33 | opts?: Opts, 34 | ): Promise { 35 | const s = service.rid; 36 | const config = this.config[s]; 37 | 38 | // Use the next message that was sent, or fallback 39 | // to the mocked response, this allows us to mock 40 | // 'sends' in the same process, also. 41 | const [nextMessage] = this.messages; 42 | return { 43 | id: '', 44 | message: nextMessage?.body || (config.resolve?.mockedResponse as string), 45 | delete: this.delete('', service.rid), 46 | }; 47 | } 48 | 49 | public delete(_id: string, _rid: string): () => Promise { 50 | return async () => { 51 | // No-op 52 | }; 53 | } 54 | } 55 | 56 | export default Queue; 57 | -------------------------------------------------------------------------------- /src/backend/mock/registry.ts: -------------------------------------------------------------------------------- 1 | import { 2 | Opts, 3 | IDiscoverAdapter, 4 | ServiceRequest, 5 | ServiceResponse, 6 | } from '../../types'; 7 | import { Config } from './types'; 8 | 9 | class Registry implements IDiscoverAdapter { 10 | private readonly config: Config; 11 | 12 | constructor(config: Config) { 13 | this.config = config; 14 | } 15 | 16 | public async locate( 17 | serviceRequest: ServiceRequest, 18 | opts?: Opts, 19 | ): Promise { 20 | const { namespace, service, instance } = serviceRequest; 21 | const addr = `${namespace}.${service}->${instance}`; 22 | return { 23 | rid: addr, 24 | attributes: {}, 25 | }; 26 | } 27 | } 28 | 29 | export default Registry; 30 | -------------------------------------------------------------------------------- /src/backend/mock/types.ts: -------------------------------------------------------------------------------- 1 | export type Resolver = { 2 | type?: string; 3 | endpoint?: string; 4 | mockedResponse?: string; 5 | }; 6 | 7 | export type Service = { 8 | type: string; 9 | resolve: Resolver; 10 | }; 11 | 12 | export type Config = { 13 | [key: string]: Service; 14 | }; 15 | -------------------------------------------------------------------------------- /src/call-service.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | const { Lambda: AWSLambda} = require('@aws-sdk/client-lambda') 3 | const { SQS: AWSSQS} = require('@aws-sdk/client-sqs') 4 | const { SNS: AWSSNS} = require('@aws-sdk/client-sns') 5 | const { SSM: AWSSSM} = require('@aws-sdk/client-ssm') 6 | const {SFNClient} = require('@aws-sdk/client-sfn') 7 | const { ServiceDiscovery: AWSServiceDiscovery} = require('@aws-sdk/client-servicediscovery') 8 | 9 | 10 | 11 | const { omit } = require('ramda'); 12 | 13 | const { defaultNamespace, extractServiceParts } = require('./helpers/call-service-helper'); 14 | 15 | const lambda = new AWSLambda(); 16 | const sqs = new AWSSQS(); 17 | const sns = new AWSSNS(); 18 | const ssm = new AWSSSM(); 19 | const stateMachine = new SFNClient(); 20 | const serviceDiscovery = new AWSServiceDiscovery(); 21 | 22 | const { SNS, Publisher } = require('./events'); 23 | const { SQS, Queue } = require('./queue'); 24 | const { Func, LambdaAdapter } = require('./functions'); 25 | const { StateMachine, StepFunctionAdapter } = require('./state-machine'); 26 | const { Automation, SSMAdapter } = require('./automation'); 27 | const { Services, CloudmapAdapter } = require('./services'); 28 | 29 | const cloudmapAdapter = new CloudmapAdapter(serviceDiscovery); 30 | const services = new Services(cloudmapAdapter); 31 | 32 | const sqsQueue = new SQS(sqs); 33 | const queue = new Queue(sqsQueue); 34 | 35 | const snsPublisher = new SNS(sns); 36 | const publisher = new Publisher(snsPublisher); 37 | 38 | const lambdaAdapter = new LambdaAdapter(lambda); 39 | const func = new Func(lambdaAdapter); 40 | 41 | const stateMachineAdapter = new StepFunctionAdapter(stateMachine); 42 | const stateMachineTrigger = new StateMachine(stateMachineAdapter); 43 | 44 | const ssmAdapter = new SSMAdapter(ssm); 45 | const automation = new Automation(ssmAdapter); 46 | 47 | const maybe = (rid, other) => (rid) ? rid : other; 48 | 49 | const runService = (service, body, opts = {}) => { 50 | const { type, arn, rid, url } = service.attributes; 51 | 52 | switch (type) { 53 | case 'cloud-function': 54 | case 'function': 55 | case 'lambda': { 56 | return func.call(maybe(rid, arn), body, opts); 57 | } 58 | 59 | case 'step-function': 60 | case 'state-machine': { 61 | return stateMachineTrigger.start(maybe(rid, arn), body); 62 | } 63 | 64 | case 'script': 65 | case 'automation': { 66 | return automation.run(maybe(rid, arn), body, opts); 67 | } 68 | 69 | case 'queue': 70 | case 'sqs': { 71 | if (opts.subscribe) { 72 | return queue.listen(maybe(rid, url)); 73 | } 74 | return queue.send(maybe(rid, url), body, omit(['subscribe'], opts)); 75 | } 76 | 77 | case 'event': 78 | case 'pubsub': 79 | case 'sns': { 80 | return publisher.publish(maybe(rid, arn), body, omit(['subscribe'], opts)); 81 | } 82 | 83 | default: { 84 | return Promise.resolve(null); 85 | } 86 | } 87 | }; 88 | 89 | const callService = ({ 90 | namespace, 91 | service, 92 | instance, 93 | body, 94 | opts, 95 | } = {}) => services.find(namespace || defaultNamespace(), service, instance) 96 | .then((foundInstance) => { 97 | if (!foundInstance) { 98 | throw new Error(`couldn't find a service with instance id or instance name: ${instance}`); 99 | } 100 | 101 | return runService(foundInstance, body, opts) 102 | .then((payload) => { 103 | if (payload && payload.errorMessage && payload.errorType) { 104 | throw payload; 105 | } 106 | return payload; 107 | }); 108 | }); 109 | 110 | const request = (serviceID, body, opts) => { 111 | const { namespace, service, instance } = extractServiceParts(serviceID); 112 | return callService({ 113 | namespace, 114 | instance, 115 | service, 116 | body, 117 | opts, 118 | }); 119 | }; 120 | 121 | const publish = (serviceID, body, opts) => { 122 | const { namespace, service, instance } = extractServiceParts(serviceID); 123 | return callService({ 124 | namespace, 125 | service, 126 | instance, 127 | body, 128 | opts: { subscribe: false, ...opts }, 129 | }); 130 | }; 131 | 132 | const subscribe = (serviceID, opts = {}) => { 133 | const { namespace, service, instance } = extractServiceParts(serviceID); 134 | return callService({ 135 | namespace, 136 | service, 137 | instance, 138 | opts: { subscribe: true, ...opts }, 139 | }); 140 | }; 141 | 142 | module.exports = { 143 | call: callService, 144 | 145 | // Synchronous 146 | request, 147 | 148 | // Events 149 | publish, 150 | subscribe, 151 | 152 | // Queue: these use the same functions as 153 | // events, until the discover function is called 154 | // and we know whether it's a queue or an event listener. 155 | queue: publish, 156 | listen: subscribe, 157 | }; 158 | -------------------------------------------------------------------------------- /src/call-service.test.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const ServiceDiscovery = require('./call-service'); 4 | const { LambdaAdapter } = require('./functions'); 5 | const { CloudmapAdapter } = require('./services'); 6 | const { SQS } = require('./queue'); 7 | const { SNS } = require('./events'); 8 | const { StepFunctionAdapter } = require('./state-machine'); 9 | const { SSMAdapter } = require('./automation'); 10 | const { extractServiceParts } = require('./helpers/call-service-helper'); 11 | 12 | describe('(call)', () => { 13 | beforeAll(() => { 14 | process.env.STAGE = 'latest'; 15 | }); 16 | 17 | afterEach(() => { 18 | jest.resetAllMocks(); 19 | jest.resetModules(); 20 | }); 21 | 22 | const lambdaService = { 23 | id: 'my-func', 24 | attributes: { 25 | type: 'function', 26 | arn: 'my-test-arn', 27 | }, 28 | }; 29 | 30 | const stateMachineService = { 31 | id: 'state-machine', 32 | attributes: { 33 | type: 'state-machine', 34 | arn: 'my-test-arn', 35 | }, 36 | }; 37 | 38 | const automationService = { 39 | id: 'test', 40 | attributes: { 41 | type: 'automation', 42 | arn: 'ExampleDocumentName', 43 | }, 44 | }; 45 | 46 | const snsService = { 47 | id: 'test-topic', 48 | attributes: { 49 | type: 'sns', 50 | arn: 'test-topic', 51 | }, 52 | }; 53 | 54 | const sqsService = { 55 | id: 'sqs', 56 | attributes: { 57 | type: 'queue', 58 | url: 'test-queue', 59 | }, 60 | }; 61 | 62 | it('should call a lambda function', async () => { 63 | const expected = { name: 'test' }; 64 | CloudmapAdapter.prototype.find = jest.fn().mockReturnValue(Promise.resolve(lambdaService)); 65 | LambdaAdapter.prototype.call = jest.fn().mockImplementation(() => Promise.resolve(expected)); 66 | expect.assertions(1); 67 | const body = { name: 'Ewan' }; 68 | const res = await ServiceDiscovery.call({ 69 | service: 'test-service', 70 | instance: 'my-func', 71 | body, 72 | }); 73 | expect(res).toEqual(expected); 74 | }); 75 | 76 | it('should call a lambda using a service id', async () => { 77 | const expected = { name: 'test' }; 78 | CloudmapAdapter.prototype.find = jest.fn().mockReturnValue(Promise.resolve(lambdaService)); 79 | LambdaAdapter.prototype.call = jest.fn().mockImplementation(() => Promise.resolve(expected)); 80 | expect.assertions(1); 81 | const body = { name: 'Ewan' }; 82 | const res = await ServiceDiscovery.request('my-namespace.test-service->my-func', body); 83 | expect(res).toEqual(expected); 84 | }); 85 | 86 | it('should publish an sns event', async () => { 87 | const messageId = 'abc123'; 88 | CloudmapAdapter.prototype.find = jest.fn().mockReturnValue(Promise.resolve(snsService)); 89 | SNS.prototype.publish = jest.fn().mockImplementation(() => Promise.resolve({ 90 | MessageId: messageId, 91 | })); 92 | 93 | expect.assertions(2); 94 | 95 | const event = { name: 'Test' }; 96 | 97 | const res = await ServiceDiscovery.publish('test-namespace.test-service->test-topic', event); 98 | expect(SNS.prototype.publish).toBeCalledWith('test-topic', event, undefined); 99 | expect(res).toEqual({ MessageId: messageId }); 100 | }); 101 | 102 | it('should publish an sns event with MessageAttributes if present in the options', async () => { 103 | const messageId = 'abc123'; 104 | CloudmapAdapter.prototype.find = jest.fn().mockReturnValue(Promise.resolve(snsService)); 105 | SNS.prototype.publish = jest.fn().mockImplementation(() => Promise.resolve({ 106 | MessageId: messageId, 107 | })); 108 | 109 | expect.assertions(2); 110 | 111 | const event = { name: 'Test' }; 112 | 113 | const attributes = { 114 | tenant: { 115 | DataType: 'String', 116 | StringValue: 'foo', 117 | }, 118 | }; 119 | 120 | const options = { 121 | foo: true, 122 | attributes, 123 | }; 124 | 125 | const res = await ServiceDiscovery.publish('test-namespace.test-service->test-topic', event, options); 126 | expect(SNS.prototype.publish).toBeCalledWith('test-topic', event, attributes); 127 | expect(res).toEqual({ MessageId: messageId }); 128 | }); 129 | 130 | it('should send an sqs message', async () => { 131 | expect.assertions(5); 132 | const namespace = 'test-namespace'; 133 | const queue = 'test-queue'; 134 | const namespaceQueue = `${namespace}.${queue}`; 135 | const message = { name: 'test' }; 136 | const mockMessageId = 'abc123'; 137 | const opts = { MessageGroupId: 'abc123', MessageDeduplicationId: 'abc123' }; 138 | 139 | CloudmapAdapter.prototype.find = jest.fn().mockReturnValue(Promise.resolve(sqsService)); 140 | SQS.prototype.send = jest.fn().mockImplementation(() => Promise.resolve({ 141 | MessageId: mockMessageId, 142 | })); 143 | 144 | const { MessageId } = await ServiceDiscovery.queue(namespaceQueue, message, opts); 145 | expect(SQS.prototype.send).toBeCalledWith(queue, message, opts); 146 | expect(MessageId).toEqual(mockMessageId); 147 | 148 | const mockDelete = jest.fn(); 149 | 150 | CloudmapAdapter.prototype.find = jest.fn().mockReturnValue(Promise.resolve(sqsService)); 151 | SQS.prototype.listen = jest.fn().mockImplementation(() => Promise.resolve({ 152 | message, 153 | delete: mockDelete, 154 | })); 155 | 156 | const messages = await ServiceDiscovery.listen('test-namespace.test-service->test-queue'); 157 | messages.on('message', (msg) => { 158 | msg.delete(); 159 | expect(message).toEqual(msg.message); 160 | expect(mockDelete).toHaveBeenCalled(); 161 | messages.stop(); 162 | }); 163 | 164 | expect(SQS.prototype.listen).toBeCalledWith('test-queue'); 165 | }); 166 | 167 | it('should use the specified namespace if included in service name', async () => { 168 | expect.assertions(1); 169 | 170 | const serviceWithNamespace = 'my-namespace.service-name->instance'; 171 | 172 | expect(extractServiceParts(serviceWithNamespace)) 173 | .toEqual({ 174 | namespace: 'my-namespace', 175 | service: 'service-name', 176 | instance: 'instance', 177 | }); 178 | }); 179 | 180 | it('should use the default namespace if not included in service name', async () => { 181 | expect.assertions(1); 182 | 183 | const defaultNamespaceVal = 'default'; 184 | const serviceWithoutNamespace = 'service-name->instance'; 185 | 186 | expect(extractServiceParts(serviceWithoutNamespace)) 187 | .toEqual({ 188 | namespace: defaultNamespaceVal, 189 | service: 'service-name', 190 | instance: 'instance', 191 | }); 192 | }); 193 | 194 | it('should start a state machine', async (done) => { 195 | const expected = { name: 'testing' }; 196 | CloudmapAdapter.prototype.find = jest.fn() 197 | .mockReturnValue(Promise.resolve(stateMachineService)); 198 | StepFunctionAdapter.prototype.start = jest.fn().mockReturnValue(Promise.resolve(expected)); 199 | const body = { name: 'test', tenant: 'mock' }; 200 | 201 | const result = await ServiceDiscovery.call({ 202 | service: 'test-service', 203 | instance: 'test', 204 | body, 205 | }); 206 | 207 | expect(result).toEqual(expected); 208 | done(); 209 | }); 210 | 211 | it('should run an automation task', async (done) => { 212 | const expected = { name: 'testing' }; 213 | CloudmapAdapter.prototype.find = jest.fn() 214 | .mockReturnValue(Promise.resolve(automationService)); 215 | SSMAdapter.prototype.run = jest.fn().mockReturnValue(Promise.resolve(expected)); 216 | const body = { name: 'test', tenant: 'mock' }; 217 | 218 | const result = await ServiceDiscovery.call({ 219 | service: 'test-service', 220 | instance: 'test', 221 | body, 222 | }); 223 | 224 | expect(result).toEqual(expected); 225 | done(); 226 | }); 227 | }); 228 | -------------------------------------------------------------------------------- /src/events/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const SNS = require('./sns'); 4 | const Publisher = require('./publisher'); 5 | const Subscriber = require('./subscriber'); 6 | 7 | module.exports = { 8 | SNS, 9 | Publisher, 10 | Subscriber, 11 | }; 12 | -------------------------------------------------------------------------------- /src/events/publisher.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const EventEmitter = require('events'); 4 | 5 | class Publisher extends EventEmitter { 6 | constructor(eventHandler) { 7 | super(); 8 | this.eventHandler = eventHandler; 9 | } 10 | 11 | publish(name, message, { attributes }) { 12 | return this.eventHandler.publish(name, message, attributes); 13 | } 14 | } 15 | 16 | module.exports = Publisher; 17 | -------------------------------------------------------------------------------- /src/events/sns.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class SNS { 4 | constructor(client) { 5 | this.client = client; 6 | } 7 | 8 | async publish(name, event, attributes) { 9 | const { MessageId } = await this.client.publish({ 10 | TopicArn: name, 11 | Message: JSON.stringify(event), 12 | MessageAttributes: attributes, 13 | }); 14 | return MessageId; 15 | } 16 | 17 | subscribe(name) { 18 | return this.client.subscribe({ 19 | TopicArn: name, 20 | }); 21 | } 22 | } 23 | 24 | module.exports = SNS; 25 | -------------------------------------------------------------------------------- /src/events/subscriber.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const EventEmitter = require('events'); 4 | 5 | const privates = { 6 | async poll(name) { 7 | if (this.stopped) { 8 | return null; 9 | } 10 | 11 | try { 12 | const message = await this.eventHandler.subscribe(name); 13 | if (message) { 14 | this.emit('message', message); 15 | } else { 16 | this.emit('empty'); 17 | } 18 | } catch (e) { 19 | this.emit('error', e); 20 | } 21 | privates.poll.call(this, name); 22 | return null; 23 | }, 24 | }; 25 | 26 | class Subscriber extends EventEmitter { 27 | constructor(eventHandler) { 28 | super(); 29 | this.eventHandler = eventHandler; 30 | this.stopped = true; 31 | } 32 | 33 | async subscribe(name) { 34 | if (this.stopped) { 35 | this.stopped = false; 36 | privates.poll.call(this, name); 37 | this.emit('started'); 38 | return this; 39 | } 40 | return null; 41 | } 42 | 43 | stop() { 44 | if (!this.stopped) { 45 | this.stopped = true; 46 | this.emit('stopped'); 47 | } 48 | } 49 | } 50 | 51 | module.exports = Subscriber; 52 | -------------------------------------------------------------------------------- /src/functions/func.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class Func { 4 | constructor(adapter) { 5 | this.adapter = adapter; 6 | } 7 | 8 | call(...config) { 9 | return this.adapter.call(...config); 10 | } 11 | } 12 | 13 | module.exports = Func; 14 | -------------------------------------------------------------------------------- /src/functions/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const LambdaAdapter = require('./lambda-adapter'); 4 | const Func = require('./func'); 5 | 6 | module.exports = { 7 | LambdaAdapter, 8 | Func, 9 | }; 10 | -------------------------------------------------------------------------------- /src/functions/lambda-adapter.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class LambdaAdapter { 4 | constructor(client) { 5 | this.client = client; 6 | } 7 | 8 | async call(name, body, opts) { 9 | const params = { 10 | ...opts, 11 | FunctionName: name, 12 | Payload: JSON.stringify(body), 13 | }; 14 | const { Payload, StatusCode } = await this.client.invoke(params); 15 | 16 | // Convert Uint8Array to String 17 | const decoder = new TextDecoder('utf-8'); 18 | const resString = decoder.decode(Payload); 19 | 20 | return Payload ? JSON.parse(resString) : StatusCode; 21 | } 22 | } 23 | 24 | module.exports = LambdaAdapter; 25 | -------------------------------------------------------------------------------- /src/helpers/call-service-helper.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const defaultNamespace = () => { 4 | const { ENV } = process.env; 5 | if (ENV) { 6 | return `default-${ENV}`; 7 | } 8 | return 'default'; 9 | }; 10 | 11 | const NAMESPACE_NOTATION = '.'; 12 | 13 | const HANDLER_NOTATION = '->'; 14 | 15 | const getHandler = (serviceId) => { 16 | if (serviceId.includes(HANDLER_NOTATION)) { 17 | return serviceId.split(HANDLER_NOTATION)[1]; 18 | } 19 | return false; 20 | }; 21 | 22 | // This takes a serviceId in the user-facing form and 23 | // reconstitutes it into parts an in our internal form. 24 | // 25 | // For example, `namespace.service->handler`, becomes 26 | // `namespace.service.handler`. 27 | // 28 | // And `service->handler` becomes: 29 | // `service.handler`. This is because we have to 30 | // differentiate between the three segments as there's 31 | // no way of assuring which is a namespace and which is 32 | // a service, as a namespace is optional. 33 | const extractServiceParts = (serviceId) => { 34 | // If service ID contains a NAMESPACE_NOTATION - which denotes that 35 | // the ID contains both a namespace and a service. 36 | // Split the two, check for a handler 37 | if (serviceId.includes(NAMESPACE_NOTATION)) { 38 | const [namespace, service] = serviceId.split(NAMESPACE_NOTATION); 39 | 40 | // Check if the service contains a handler, denoted 41 | // by a HANDLER_NOTATION. 42 | const instance = getHandler(service); 43 | 44 | const [srv] = service.split(HANDLER_NOTATION); 45 | return { 46 | namespace, 47 | service: srv, 48 | instance, 49 | }; 50 | } 51 | 52 | const instance = getHandler(serviceId); 53 | const service = serviceId.split(HANDLER_NOTATION)[0]; 54 | 55 | // Default behavior, returns serviceId 56 | // given, with the default namespace. 57 | return { 58 | namespace: defaultNamespace(), 59 | service, 60 | instance, 61 | }; 62 | }; 63 | 64 | module.exports = { 65 | extractServiceParts, 66 | defaultNamespace, 67 | }; 68 | -------------------------------------------------------------------------------- /src/helpers/call-service-helper.test.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /* eslint-disable no-restricted-syntax */ 4 | 5 | const { extractServiceParts } = require('./call-service-helper'); 6 | 7 | const golden = { 8 | 'namespace.service->handler': { 9 | namespace: 'namespace', 10 | service: 'service', 11 | instance: 'handler', 12 | }, 13 | 'service->handler': { 14 | namespace: 'default', 15 | service: 'service', 16 | instance: 'handler', 17 | }, 18 | }; 19 | 20 | process.env.STAGE = 'latest'; 21 | 22 | describe('(extractServiceParts)', () => { 23 | it('should parse service ids', () => { 24 | for (const [input, expected] of Object.entries(golden)) { 25 | const result = extractServiceParts(input); 26 | expect(result).toEqual(expected); 27 | } 28 | }); 29 | }); 30 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const { 4 | call, 5 | request, 6 | publish, 7 | subscribe, 8 | queue, 9 | listen, 10 | } = require('./call-service'); 11 | 12 | module.exports = { 13 | call, 14 | request, 15 | 16 | publish, 17 | subscribe, 18 | 19 | queue, 20 | listen, 21 | 22 | }; 23 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | // @ts-ignore 2 | import { 3 | call, 4 | request, 5 | publish, 6 | subscribe, 7 | queue, 8 | listen, 9 | } from './call-service'; 10 | 11 | // Beta api - 12 | import ServiceDiscovery from './backend/backend'; 13 | import { WithMockBackend } from './backend/mock/mock'; 14 | import { WithAwsBackend } from './backend/aws/aws'; 15 | 16 | export { 17 | call, 18 | request, 19 | publish, 20 | subscribe, 21 | queue, 22 | listen, 23 | // Beta api 24 | ServiceDiscovery, 25 | WithMockBackend, 26 | WithAwsBackend, 27 | }; 28 | -------------------------------------------------------------------------------- /src/poller/poller.ts: -------------------------------------------------------------------------------- 1 | import { EventEmitter } from 'events'; 2 | import { 3 | Opts, 4 | ServiceResponse, 5 | IQueueAdapter, 6 | Request, 7 | QueueResponse, 8 | } from '../types'; 9 | 10 | class Poller extends EventEmitter { 11 | private adapter: T; 12 | private stopped: boolean; 13 | private opts?: Opts; 14 | 15 | constructor(adapter: T, opts = {}) { 16 | super(); 17 | this.emit('ready'); 18 | this.adapter = adapter; 19 | this.stopped = true; 20 | this.opts = opts; 21 | } 22 | 23 | private async poll(name: ServiceResponse, opts?: Opts) { 24 | if (this.stopped) { 25 | return null; 26 | } 27 | 28 | try { 29 | const message = await this.adapter.listen(name, opts); 30 | if (message) { 31 | this.emit('message', message); 32 | } else { 33 | this.emit('empty'); 34 | } 35 | } catch (e) { 36 | this.emit('error', e); 37 | } 38 | 39 | setTimeout(() => { 40 | this.poll.call(this, name); 41 | }, 100); 42 | return null; 43 | } 44 | 45 | public send( 46 | name: ServiceResponse, 47 | message: Request, 48 | opts?: Opts, 49 | ): Promise { 50 | return this.adapter.send(name, message, opts); 51 | } 52 | 53 | public async listen(name: ServiceResponse, opts?: Opts): Promise> { 54 | if (this.stopped) { 55 | this.stopped = false; 56 | this.poll.call(this, name, opts); 57 | this.emit('started'); 58 | return this; 59 | } 60 | 61 | return this; 62 | } 63 | 64 | public stop() { 65 | if (!this.stopped) { 66 | this.stopped = true; 67 | this.emit('stopped'); 68 | } 69 | } 70 | } 71 | 72 | export default Poller; 73 | -------------------------------------------------------------------------------- /src/queue/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const SQS = require('./sqs'); 4 | const Queue = require('./queue'); 5 | 6 | module.exports = { 7 | SQS, 8 | Queue, 9 | }; 10 | -------------------------------------------------------------------------------- /src/queue/queue.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const EventEmitter = require('events'); 4 | 5 | const privates = { 6 | async poll(name) { 7 | if (this.stopped) { 8 | return null; 9 | } 10 | 11 | try { 12 | const message = await this.adapter.listen(name); 13 | if (message) { 14 | this.emit('message', message); 15 | } else { 16 | this.emit('empty'); 17 | } 18 | } catch (e) { 19 | this.emit('error', e); 20 | } 21 | privates.poll.call(this, name); 22 | return null; 23 | }, 24 | }; 25 | 26 | class Queue extends EventEmitter { 27 | constructor(adapter, opts = {}) { 28 | super(); 29 | this.adapter = adapter; 30 | this.stopped = true; 31 | this.opts = opts; 32 | } 33 | 34 | send(name, message, opts = {}) { 35 | return this.adapter.send(name, message, opts); 36 | } 37 | 38 | async listen(name) { 39 | if (this.stopped) { 40 | this.stopped = false; 41 | privates.poll.call(this, name); 42 | this.emit('started'); 43 | return this; 44 | } 45 | return this; 46 | } 47 | 48 | stop() { 49 | if (!this.stopped) { 50 | this.stopped = true; 51 | this.emit('stopped'); 52 | } 53 | } 54 | } 55 | 56 | module.exports = Queue; 57 | -------------------------------------------------------------------------------- /src/queue/sqs.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const DEFAULT_INTERVAL = 10; 4 | class SQS { 5 | constructor(client, opts = {}) { 6 | this.client = client; 7 | this.opts = opts; 8 | } 9 | 10 | send(name, event, opts = {}) { 11 | return this.client.sendMessage({ 12 | QueueUrl: name, 13 | MessageBody: JSON.stringify(event), 14 | ...opts, 15 | }); 16 | } 17 | 18 | async listen(name) { 19 | const { Messages } = await this.client.receiveMessage({ 20 | QueueUrl: name, 21 | WaitTimeSeconds: this.opts.interval || DEFAULT_INTERVAL, 22 | }); 23 | if (!Messages) return null; 24 | const [message] = Messages; 25 | return { 26 | message: message.Body, 27 | messageId: message.MessageId, 28 | delete: this.delete(message.ReceiptHandle, name), 29 | }; 30 | } 31 | 32 | delete(receipt, url) { 33 | return () => this.client.deleteMessage({ 34 | QueueUrl: url, 35 | ReceiptHandle: receipt, 36 | }); 37 | } 38 | } 39 | 40 | module.exports = SQS; 41 | -------------------------------------------------------------------------------- /src/services/cloudmap-adapter.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class CloudmapAdapter { 4 | constructor(client) { 5 | this.client = client; 6 | } 7 | 8 | /* 9 | * Discover will find multiple instances by a specified 10 | * object containing metadata registered against an instance. 11 | */ 12 | async discover(namespace, service, queryParams = {}) { 13 | const params = { 14 | NamespaceName: namespace, 15 | ServiceName: service, 16 | QueryParameters: queryParams, 17 | }; 18 | 19 | return await this.client.discoverInstances(params) 20 | } 21 | 22 | /** 23 | * Finds a single instance by id. 24 | */ 25 | async find(namespace, service, instance, params = {}) { 26 | const res = await this.discover(namespace, service, params); 27 | const i = res.Instances.find(item => item.InstanceId === instance); 28 | if (!i) throw new Error(`no service found: ${namespace}.${service}->${instance}`); 29 | return { 30 | id: instance, 31 | attributes: i.Attributes, 32 | }; 33 | } 34 | } 35 | 36 | module.exports = CloudmapAdapter; 37 | -------------------------------------------------------------------------------- /src/services/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const Services = require('./services'); 4 | const CloudmapAdapter = require('./cloudmap-adapter'); 5 | 6 | module.exports = { 7 | Services, 8 | CloudmapAdapter, 9 | }; 10 | -------------------------------------------------------------------------------- /src/services/services.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class Services { 4 | constructor(adapter) { 5 | this.adapter = adapter; 6 | } 7 | 8 | discover(namespace, service, params = {}) { 9 | return this.adapter.discover(namespace, service, params); 10 | } 11 | 12 | find(namespace, service, instance, params = {}) { 13 | return this.adapter.find(namespace, service, instance, params); 14 | } 15 | } 16 | 17 | module.exports = Services; 18 | -------------------------------------------------------------------------------- /src/state-machine/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const StepFunctionAdapter = require('./step-function-adapter'); 4 | const StateMachine = require('./state-machine'); 5 | 6 | module.exports = { 7 | StepFunctionAdapter, 8 | StateMachine, 9 | }; 10 | -------------------------------------------------------------------------------- /src/state-machine/state-machine.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class StateMachine { 4 | constructor(adapter) { 5 | this.adapter = adapter; 6 | } 7 | 8 | start(arn, body) { 9 | return this.adapter.start(arn, body); 10 | } 11 | } 12 | 13 | module.exports = StateMachine; 14 | -------------------------------------------------------------------------------- /src/state-machine/step-function-adapter.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | class StepFunctionAdapter { 4 | constructor(client) { 5 | this.client = client; 6 | } 7 | 8 | async start(arn, body) { 9 | const params = { 10 | stateMachineArn: arn, 11 | input: JSON.stringify(body), 12 | }; 13 | const result = await this.client.startExecution(params); 14 | return result; 15 | } 16 | } 17 | 18 | module.exports = StepFunctionAdapter; 19 | -------------------------------------------------------------------------------- /src/types/index.ts: -------------------------------------------------------------------------------- 1 | export interface IQueueAdapter { 2 | send( 3 | service: ServiceResponse, 4 | request: Request, 5 | opts?: Opts, 6 | ): Promise; 7 | listen(service: ServiceResponse, opts?: Opts): Promise; 8 | } 9 | 10 | export interface IPubSubAdapter { 11 | publish( 12 | service: ServiceResponse, 13 | request: Request, 14 | opts?: Opts, 15 | ): Promise; 16 | subscribe(service: ServiceResponse, opts?: Opts): Promise; 17 | } 18 | 19 | export interface IFunctionAdapter { 20 | request( 21 | service: ServiceResponse, 22 | request: Request, 23 | opts?: Opts, 24 | ): Promise; 25 | } 26 | 27 | export type Attributes = { 28 | [key: string]: string | number | boolean; 29 | }; 30 | 31 | export type ServiceResponse = { 32 | rid: string; 33 | attributes?: Attributes; 34 | }; 35 | 36 | export interface IDiscoverAdapter { 37 | locate(serviceRequest: ServiceRequest, opts?: Opts): Promise; 38 | } 39 | 40 | export type Backend = { 41 | queueAdapter: IQueueAdapter; 42 | pubsubAdapter: IPubSubAdapter; 43 | functionAdapter: IFunctionAdapter; 44 | discoverAdapter: IDiscoverAdapter; 45 | // automationAdapter: IAutomationAdapter, @todo - not implemented, low priority 46 | }; 47 | 48 | export type Request = { 49 | body: string; 50 | }; 51 | 52 | export type Response = { 53 | body: string; 54 | }; 55 | 56 | export type Opts = { 57 | [key: string]: boolean | string | number; 58 | }; 59 | 60 | export type ServiceRequest = { 61 | instance: string; 62 | service: string; 63 | namespace: string; 64 | }; 65 | 66 | export interface IAddressParser { 67 | parse(addr: string): ServiceRequest; 68 | } 69 | 70 | // Message response, for example returns a message ID 71 | // from an SQS queue 72 | export type MessageResponse = { 73 | id: string; 74 | }; 75 | 76 | // Extends a message response with a delete method 77 | export interface IMessage extends MessageResponse { 78 | message: string; 79 | delete(receipt: string, name: string): Promise; 80 | } 81 | 82 | export type QueueResponse = { 83 | id: string; 84 | body?: string; 85 | }; 86 | 87 | export type PubSubResponse = { 88 | // Some cases we subscribe to something, which turns a resource id, 89 | // For example an SNS subscription returns an ARN. 90 | rid?: string; 91 | messageId?: string; 92 | }; 93 | 94 | export interface IEventHandler { 95 | listen(name: ServiceResponse): Promise>; 96 | send(name: ServiceResponse, message: T, opts?: Opts): Promise; 97 | } 98 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "include": ["src"], 3 | "compilerOptions": { 4 | "outDir": "dist", 5 | "strict": true, 6 | "moduleResolution": "node", 7 | "lib": ["es2020"], 8 | "target": "ES6", 9 | "module": "CommonJS", 10 | "removeComments": true, 11 | "declaration": true, 12 | "allowJs": true, 13 | "allowSyntheticDefaultImports": true, 14 | "experimentalDecorators": true 15 | } 16 | } --------------------------------------------------------------------------------