├── .gitattributes
├── .github
└── workflows
│ └── ci.yml
├── .gitignore
├── animation.gif
├── contributing.md
├── grfn.svg
├── license
├── package.json
├── playground.js
├── pnpm-lock.yaml
├── readme.md
├── src
├── index.d.ts
└── index.js
├── test
└── index.ts
└── tsconfig.json
/.gitattributes:
--------------------------------------------------------------------------------
1 | * text=auto eol=lf
2 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | # Copyright 2021 Google LLC
2 | #
3 | # Licensed under the Apache License, Version 2.0 (the "License");
4 | # you may not use this file except in compliance with the License.
5 | # You may obtain a copy of the License at
6 | #
7 | # http://www.apache.org/licenses/LICENSE-2.0
8 | #
9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 |
15 | name: CI
16 |
17 | on: [push, pull_request]
18 |
19 | concurrency:
20 | group: ${{ github.workflow }}-${{ github.ref }}
21 | cancel-in-progress: true
22 |
23 | jobs:
24 | test:
25 | name: Node.js v${{ matrix.nodejs }} (${{ matrix.os }})
26 | runs-on: ${{ matrix.os }}
27 | strategy:
28 | matrix:
29 | nodejs: [18, 20]
30 | os: [ubuntu-latest, macOS-latest]
31 | fail-fast: false
32 | steps:
33 | - uses: actions/checkout@v3
34 |
35 | - name: Install Node.js
36 | uses: actions/setup-node@v3
37 | with:
38 | node-version: ${{ matrix.nodejs }}
39 |
40 | - name: Install pnpm
41 | run: npm install -g pnpm
42 |
43 | - name: Install dependencies
44 | run: pnpm install
45 |
46 | - name: Format
47 | run: pnpm format -- --no-write
48 |
49 | - name: Lint
50 | run: pnpm lint -- --no-fix
51 |
52 | - name: Typecheck
53 | run: pnpm typecheck
54 |
55 | - name: Test
56 | run: pnpm test -- --coverage
57 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | coverage
3 | dist
4 | *.tsbuildinfo
5 |
--------------------------------------------------------------------------------
/animation.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TomerAberbach/grfn/3cf70695e38b6f2aac5d5ede187e1016d27f5f56/animation.gif
--------------------------------------------------------------------------------
/contributing.md:
--------------------------------------------------------------------------------
1 | # How to Contribute
2 |
3 | We'd love to accept your patches and contributions to this project. There are
4 | just a few small guidelines you need to follow.
5 |
6 | ## Contributor License Agreement
7 |
8 | Contributions to this project must be accompanied by a Contributor License
9 | Agreement. You (or your employer) retain the copyright to your contribution;
10 | this simply gives us permission to use and redistribute your contributions as
11 | part of the project. Head over to https://cla.developers.google.com to see your
12 | current agreements on file or to sign a new one.
13 |
14 | You generally only need to submit a CLA once, so if you've already submitted one
15 | (even if it was for a different project), you probably don't need to do it
16 | again.
17 |
18 | ## Code reviews
19 |
20 | All submissions, including submissions by project members, require review. We
21 | use GitHub pull requests for this purpose. Consult
22 | [GitHub Help](https://help.github.com/articles/about-pull-requests) for more
23 | information on using pull requests.
24 |
25 | ## Community Guidelines
26 |
27 | This project follows
28 | [Google's Open Source Community Guidelines](https://opensource.google/conduct).
29 |
--------------------------------------------------------------------------------
/grfn.svg:
--------------------------------------------------------------------------------
1 |
47 |
--------------------------------------------------------------------------------
/license:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "grfn",
3 | "version": "2.0.0",
4 | "author": {
5 | "name": "Tomer Aberbach",
6 | "email": "tomer@aberba.ch",
7 | "url": "https://tomeraberba.ch"
8 | },
9 | "description": "A tiny (~315B) utility that executes a dependency graph of async functions as concurrently as possible.",
10 | "keywords": [
11 | "graph",
12 | "dag",
13 | "dependency",
14 | "concurrently",
15 | "async",
16 | "function",
17 | "solver",
18 | "topological"
19 | ],
20 | "homepage": "https://github.com/TomerAberbach/grfn",
21 | "repository": "TomerAberbach/grfn",
22 | "bugs": {
23 | "url": "https://github.com/TomerAberbach/grfn/issues"
24 | },
25 | "license": "Apache-2.0",
26 | "files": [
27 | "dist"
28 | ],
29 | "type": "module",
30 | "sideEffects": false,
31 | "engines": {
32 | "node": ">= 18"
33 | },
34 | "exports": {
35 | ".": {
36 | "types": "./dist/index.d.ts",
37 | "require": "./dist/index.min.cjs",
38 | "import": "./dist/index.min.js"
39 | },
40 | "./package.json": "./package.json"
41 | },
42 | "types": "./dist/index.d.ts",
43 | "main": "./dist/index.min.cjs",
44 | "module": "./dist/index.min.js",
45 | "scripts": {
46 | "prepare": "tomer install",
47 | "format": "tomer format",
48 | "lint": "tomer lint",
49 | "typecheck": "tomer typecheck",
50 | "test": "tomer test",
51 | "build": "tomer build",
52 | "clean": "tomer clean dist",
53 | "prepublishOnly": "tomer build"
54 | },
55 | "prettier": "tomer/prettier",
56 | "terser": {
57 | "mangle": {
58 | "properties": {
59 | "regex": "^_[^_]+"
60 | }
61 | }
62 | },
63 | "dependencies": {
64 | "type-fest": "^4.18.2"
65 | },
66 | "devDependencies": {
67 | "@types/jest": "^29.5.2",
68 | "eslint": "^8.57.0",
69 | "jest": "^29.7.0",
70 | "prettier": "^3.2.5",
71 | "tomer": "^3.2.1",
72 | "typescript": "^5.4.5"
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/playground.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2021 Google LLC
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | import grfn from './src/index.js'
18 |
19 | const delay = timeout => new Promise(resolve => setTimeout(resolve, timeout))
20 | const withLogging = fn =>
21 | Object.defineProperty(
22 | async (...args) => {
23 | console.log(`${fn.name} input: ${args.join(`, `)}`)
24 | const output = await fn(...args)
25 | console.log(`${fn.name} output: ${output}`)
26 | return output
27 | },
28 | `name`,
29 | {
30 | enumerable: false,
31 | writable: false,
32 | value: fn.name,
33 | },
34 | )
35 |
36 | const fn = grfn({
37 | e: [
38 | withLogging(async (a, c, d) => {
39 | await delay(10)
40 | return a * c * d
41 | }),
42 | [`a`, `c`, `d`],
43 | ],
44 | d: [
45 | withLogging(async b => {
46 | await delay(1)
47 | return b * 2
48 | }),
49 | [`b`],
50 | ],
51 | c: [
52 | withLogging(async (a, b) => {
53 | await delay(5)
54 | return a + b
55 | }),
56 | [`a`, `b`],
57 | ],
58 | a: withLogging(async (n1, n2, n3) => {
59 | await delay(15)
60 | return n1 + n2 + n3
61 | }),
62 | b: withLogging(async (n1, n2, n3) => {
63 | await delay(10)
64 | return n1 * n2 * n3
65 | }),
66 | })
67 | await fn(1, 2, 3)
68 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 |
3 | 
61 |
62 | ```js
63 | import { setTimeout } from 'node:timers/promises'
64 | import grfn from 'grfn'
65 |
66 | const fn = grfn({
67 | // `e` depends on `a`, `c`, and `d`. Call `e` with the results of the
68 | // functions once their returned promises resolve.
69 | e: [
70 | async (a, c, d) => {
71 | await setTimeout(10)
72 | return a * c * d
73 | },
74 | [`a`, `c`, `d`],
75 | ],
76 |
77 | // `d` depends on `b`.
78 | d: [
79 | async b => {
80 | await setTimeout(1)
81 | return b * 2
82 | },
83 | [`b`],
84 | ],
85 |
86 | // `c` depends on `a` and `b`.
87 | c: [
88 | async (a, b) => {
89 | await setTimeout(5)
90 | return a + b
91 | },
92 | [`a`, `b`],
93 | ],
94 |
95 | // `a` and `b` have no dependencies! But they must still be listed. They take
96 | // the input given to `fn`.
97 | a: async (n1, n2, n3) => {
98 | await setTimeout(15)
99 | return n1 + n2 + n3
100 | },
101 | b: async (n1, n2, n3) => {
102 | await setTimeout(10)
103 | return n1 * n2 * n3
104 | },
105 | })
106 |
107 | const output = await fn(4, 2, 3)
108 |
109 | // This will be the output of `e` because no function depends on it!
110 | console.log(`final output: ${output}`)
111 | ```
112 |
113 | Output:
114 |
115 | ```
116 | final output: 14256
117 | ```
118 |
119 | ### Debugging
120 |
121 | The graph will be automatically validated, including cycle detection, via
122 | TypeScript magic!
123 |
124 | ## API
125 |
126 | ### `grfn(vertices) => (...args) => Promise`
127 |
128 | Returns a function that runs the dependency graph of functions described by
129 | `vertices`:
130 |
131 | - Input: passed to the functions that don't have dependencies in the graph.
132 | - Output: a `Promise` that resolves to the value returned from the graph's
133 | _output function_, the function that is not depended on by any function.
134 |
135 | #### `vertices`
136 |
137 | Type: `{ [key: string]: Function | [Function, string[]?] }`
138 |
139 | An object describing a dependency graph of functions.
140 |
141 | Each value in `vertices` must be either:
142 |
143 | - A pair containing a function and its array of dependencies by key (e.g.
144 | `[fnA, ['keyB', 'keyC']]`)
145 | - Or a function (equivalent to `[fn, []]`)
146 |
147 | The following constraints, which are validated via TypeScript magic, must also
148 | be met:
149 |
150 | - Each dependency in `vertices` must also appear as a non-dependency:
151 | - Not okay (`b` doesn't appear as a non-dependency):
152 | ```js
153 | grfn({
154 | a: [fnA, [`b`]],
155 | })
156 | ```
157 | - Okay:
158 | ```js
159 | grfn({
160 | a: [fnA, [`b`]],
161 | b: fnB,
162 | })
163 | ```
164 | - `vertices` must describe an
165 | [acyclic](https://en.wikipedia.org/wiki/Directed_acyclic_graph) dependency
166 | graph:
167 | - Not okay (cycle: `a -> b -> a`):
168 | ```js
169 | grfn({
170 | a: [fnA, [`b`]],
171 | b: [fnB, [`a`]],
172 | })
173 | ```
174 | - Okay:
175 | ```js
176 | grfn({
177 | a: [fnA, [`b`]],
178 | b: fnB,
179 | })
180 | ```
181 | - `vertices` must have exactly one _output function_, a function that is not
182 | depended on by any function:
183 | - Not okay (both `b` and `c` are not depended on by any function):
184 | ```js
185 | grfn({
186 | b: [fnB, [`a`]],
187 | c: [fnC, [`a`]],
188 | a: fnA,
189 | })
190 | ```
191 | - Okay:
192 | ```js
193 | grfn({
194 | d: [fnD, [`b`, `c`]],
195 | b: [fnB, [`a`]],
196 | c: [fnC, [`a`]],
197 | a: fnA,
198 | })
199 | ```
200 |
201 | ## Contributing
202 |
203 | Stars are always welcome!
204 |
205 | For bugs and feature requests,
206 | [please create an issue](https://github.com/TomerAberbach/grfn/issues/new).
207 |
208 | For pull requests, please read the
209 | [contributing guidelines](https://github.com/TomerAberbach/grfn/blob/main/contributing.md).
210 |
211 | ## License
212 |
213 | [Apache 2.0](https://github.com/TomerAberbach/grfn/blob/main/license)
214 |
215 | This is not an official Google product.
216 |
--------------------------------------------------------------------------------
/src/index.d.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2021 Google LLC
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | /* eslint-disable typescript/no-explicit-any */
18 |
19 | import type { Join, Simplify, UnionToIntersection } from 'type-fest'
20 |
21 | declare const grfn: 
15 | 
27 |