├── .gitignore ├── .vscode ├── extensions.json ├── launch.json ├── settings.json └── tasks.json ├── .vscodeignore ├── CHANGELOG.md ├── LICENSE.md ├── README.md ├── assets └── gitduck-extension-icon.png ├── package-lock.json ├── package.json ├── src ├── api │ └── index.ts ├── auth.ts ├── code-linking.ts ├── config.ts ├── extension.ts ├── status.ts ├── store.ts ├── test │ ├── extension.test.ts │ └── index.ts ├── types.ts ├── uri-handler.ts └── websocket.ts ├── tsconfig.json ├── tslint.json └── webpack.config.js /.gitignore: -------------------------------------------------------------------------------- 1 | out 2 | *.vsix 3 | .vscode-test 4 | node_modules 5 | .DS_Store 6 | .idea 7 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | // See http://go.microsoft.com/fwlink/?LinkId=827846 3 | // for the documentation about the extensions.json format 4 | "recommendations": [ 5 | "ms-vscode.vscode-typescript-tslint-plugin" 6 | ] 7 | } -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | // A launch configuration that compiles the extension and then opens it inside a new window 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | { 6 | "version": "0.2.0", 7 | "configurations": [ 8 | { 9 | "name": "Run Extension", 10 | "type": "extensionHost", 11 | "request": "launch", 12 | "runtimeExecutable": "${execPath}", 13 | "args": [ 14 | "--extensionDevelopmentPath=${workspaceFolder}" 15 | ], 16 | "outFiles": [ 17 | "${workspaceFolder}/out/**/*.js" 18 | ], 19 | "preLaunchTask": "npm: compile" 20 | }, 21 | { 22 | "name": "Extension Tests", 23 | "type": "extensionHost", 24 | "request": "launch", 25 | "runtimeExecutable": "${execPath}", 26 | "args": [ 27 | "--extensionDevelopmentPath=${workspaceFolder}", 28 | "--extensionTestsPath=${workspaceFolder}/out/test" 29 | ], 30 | "outFiles": [ 31 | "${workspaceFolder}/out/test/**/*.js" 32 | ], 33 | "preLaunchTask": "npm run webpack-dev" 34 | } 35 | ] 36 | } 37 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | // Place your settings in this file to overwrite default and user settings. 2 | { 3 | "files.exclude": { 4 | "out": false // set this to true to hide the "out" folder with the compiled JS files 5 | }, 6 | "search.exclude": { 7 | "out": true // set this to false to include "out" folder in search results 8 | }, 9 | // Turn off tsc task auto detection since we have the necessary tasks as npm scripts 10 | "typescript.tsc.autoDetect": "off" 11 | } -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | // See https://go.microsoft.com/fwlink/?LinkId=733558 2 | // for the documentation about the tasks.json format 3 | { 4 | "version": "2.0.0", 5 | "tasks": [ 6 | { 7 | "type": "npm", 8 | "script": "watch", 9 | "problemMatcher": "$tsc-watch", 10 | "isBackground": true, 11 | "presentation": { 12 | "reveal": "never" 13 | }, 14 | "group": { 15 | "kind": "build", 16 | "isDefault": true 17 | } 18 | } 19 | ] 20 | } 21 | -------------------------------------------------------------------------------- /.vscodeignore: -------------------------------------------------------------------------------- 1 | .vscode/** 2 | .vscode-test/** 3 | out/test/** 4 | src/** 5 | .gitignore 6 | vsc-extension-quickstart.md 7 | **/tsconfig.json 8 | **/tslint.json 9 | **/*.map 10 | **/*.ts 11 | tsconfig.json 12 | .idea 13 | node_modules 14 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # GitDuck Change Log 2 | 3 | ## [Version 0.0.38] 4 | 5 | - Fix: reconnect websocket when connection was lost 6 | 7 | ## [Version 0.0.37] 8 | 9 | - Fix WebSocket reliability issues. 10 | - Minor fixes. 11 | - Submit commits and snippets as soon as they happen. 12 | 13 | ## [Version 0.0.36] 14 | 15 | - Fix WebSocket reliability issues and performance. 16 | - Added health checks for WebSockets. 17 | - Minor fixes. 18 | 19 | ## [Version 0.0.35] 20 | 21 | - Fix WebSocket reliability issues. 22 | 23 | ## [Version 0.0.34] 24 | 25 | - Remove recording with FFmpeg. 26 | - Extension only does code-linking, recording is from browser. 27 | 28 | ## [Version 0.0.33] 29 | 30 | - Improve FFmpeg process termination. ([5d36cf0](https://github.com/gitduckhq/vscode-extension/commit/5d36cf0a03fca5030c8a1469d910aff6490e4e00)) 31 | 32 | ## [Version 0.0.32] 33 | 34 | - Add reconnection attempts to server if something goes wrong with the server. 35 | 36 | ## [Version 0.0.31] 37 | 38 | - Add: team selector, to record videos for a GitDuck team. [GitDuck video](https://gitduck.com/watch/5dc00122d10ecc2f59d2ac09) 39 | - Fix: small audio bug in some scenarios 40 | 41 | ## [Version 0.0.30] 42 | 43 | - Fix: extension was removing custom color scheme. [#2](https://github.com/gitduckhq/vscode-extension/issues/2) 44 | - Fix: bug with `Copy to clipboard` button. [#3](https://github.com/gitduckhq/vscode-extension/issues/4) 45 | - Reliability improvement: send healthecks to the live server while recording. Stream will be stopped if no healthchecks are not received within a certain interval. 46 | - Fix: Windows bug, video was cropped if user had a different dispaly scale than 100%. [#6](https://github.com/gitduckhq/vscode-extension/issues/6) 47 | 48 | ## [Version 0.0.29] 49 | 50 | - Change emojis for selecting screen/microphone. 51 | - Add popup when logging in to show authentication URL in case browser doesn't open. 52 | 53 | ## [Version 0.0.28] 54 | 55 | - Fix: code-linking was not working due to a broken dependency. 56 | - Add: emojis in the screen/microphone devices selector. 57 | - Fix: bug allowing non-authenticated users to stream. 58 | 59 | ## [Version 0.0.27] 60 | 61 | - Fix bug when uploading code snippets. 62 | 63 | ## [Version 0.0.26] 64 | 65 | - Fixing small bugs when uploading snippets without authentication 66 | - Enhanced performance 67 | - Reduce extension size 68 | 69 | ## [Version 0.0.25] 70 | 71 | - Fixing extension bug when using in Linux. 72 | - Fix bug with clipboard 73 | 74 | ## [Version 0.0.24] 75 | 76 | - Add new feature: right click on a selected code to attach a code snippet to a video. [Watch development on GitDuck](https://gitduck.com/watch/5d8b3775914a9c23a6e98b6d) 77 | - Other small minor fixes and improvements. 78 | 79 | ## [Version 0.0.23] 80 | 81 | - Fix bug that wasn't allowing to start streaming. 82 | 83 | ## [Version 0.0.22] 84 | 85 | - Improve README 86 | - Handle no device selected in Windows. 87 | 88 | ## [Version 0.0.21] 89 | 90 | - Initial release 91 | -------------------------------------------------------------------------------- /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 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # THIS REPOSITORY IS ARCHIVED AND OUTDATED. PLEASE CHECK THE LATEST VSCODE EXTENSION IN [VSCODE MARKETPLACE](https://marketplace.visualstudio.com/items?itemName=gitduck.code-streaming) OR [OPEN-VSX MARKETPLACE](https://open-vsx.org/extension/gitduck/code-streaming) 2 | 3 | ## GitDuck 4 | 5 | GitDuck is an open source collaboration tool for developers. It allows developers to record their screen and link their code to the video timestamps and create interactive coding videos. 6 | 7 | This extension will automatically link your code whenever you are recording a video with GitDuck. 8 | 9 | GitDuck is great for: 10 | * ☑️ Pair Programming 11 | * ☑️ Rubber Duck Debugging 12 | * ☑️ Live Coding 13 | * ☑️ Stream privately and publicly 14 | * ☑️ Record tutorials and walkthroughs 15 | 16 | 17 | ![GitDuck coding session](https://storage.googleapis.com/gitduck/img/gitduck-preview-watch.gif) 18 | 19 | 20 | ## ✨ What's new 21 | 22 | **📹 Record from our webapp** 23 | Now you can screencast directly from our webapp. Much faster than any other screen recording software. Just go to https://gitduck.com/new-video to start recording. This extension will automatically link the code to the video. 24 | 25 | **🛠 Select the video name and privacy options before recording** 26 | Select the title of the video, the team and who can view it before recording. 27 | 28 | **🏀 Teams** 29 | Create private live coding sessions that only your team can watch. Collaborate online with your remote team and work as if you were in the same room. 30 | 31 | 32 | 33 | ## Requirements 34 | 35 | GitDuck works for: 36 | * MacOS 10.12 or greater. 37 | * Windows 7, 8 and 10. 38 | * Linux. 39 | 40 | 41 | 42 | ## Installation 43 | 44 | 1. Create a GitDuck account at https://gitduck.com 45 | 2. Select your username. 46 | 3. That's it! Record your first coding session by going to https://gitduck.com/new-video 47 | 48 | 49 | 50 | ## How to watch or share 51 | 52 | All you need to do is go to the URL generated or to your profile. Your coding sessions are going to be stored there. 53 | There you can also change the title, add a description or delete the video if you want. 54 | 55 | 56 | 57 | ## Do you need help? 58 | 59 | Please contact us at help@gitduck.com 60 | 61 | Thank you! 62 | -------------------------------------------------------------------------------- /assets/gitduck-extension-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gitduckhq/vscode-extension/93a3b603ef0f75a07694783b3c7b6a095f899217/assets/gitduck-extension-icon.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "code-streaming", 3 | "displayName": "GitDuck - Screencast Video Recording", 4 | "description": "Remote Pair Programming and Rubber Duck Debugging tool.", 5 | "publisher": "gitduck", 6 | "version": "0.0.38", 7 | "engines": { 8 | "vscode": "^1.33.0" 9 | }, 10 | "categories": [ 11 | "Other" 12 | ], 13 | "homepage": "https://gitduck.com", 14 | "bugs": { 15 | "url": "https://github.com/gitduckhq/vscode-extension/issues", 16 | "email": "help@gitduck.com" 17 | }, 18 | "keywords": [ 19 | "remote teams", 20 | "video recording", 21 | "live coding", 22 | "youtube", 23 | "twitch", 24 | "record video", 25 | "loom", 26 | "git duck" 27 | 28 | ], 29 | "license": "GPL-3.0", 30 | "icon": "out/assets/gitduck-extension-icon.png", 31 | "activationEvents": [ 32 | "*" 33 | ], 34 | "main": "./out/extension.js", 35 | "contributes": { 36 | "commands": [ 37 | { 38 | "command": "gitduck.login", 39 | "title": "GitDuck: Login" 40 | }, 41 | { 42 | "command": "gitduck.logout", 43 | "title": "GitDuck: Logout" 44 | }, 45 | { 46 | "command": "gitduck.uploadSnippet", 47 | "title": "GitDuck: Upload snippet" 48 | }, 49 | { 50 | "command": "gitduck.newStream", 51 | "title": "GitDuck: Start stream" 52 | } 53 | ], 54 | "menus": { 55 | "editor/context": [ 56 | { 57 | "command": "gitduck.uploadSnippet", 58 | "when": "editorHasSelection" 59 | } 60 | ] 61 | } 62 | }, 63 | "scripts": { 64 | "vscode:prepublish": "npm run webpack-prod", 65 | "compile": "webpack --mode development", 66 | "watch": "webpack --mode development --watch", 67 | "postinstall": "node ./node_modules/vscode/bin/install", 68 | "test": "npm run compile && node ./node_modules/vscode/bin/test", 69 | "webpack": "webpack --mode development", 70 | "webpack-dev": "webpack --mode development --watch", 71 | "webpack-prod": "webpack --mode production" 72 | }, 73 | "devDependencies": { 74 | "@types/mocha": "^2.2.42", 75 | "@types/node": "^10.14.6", 76 | "copy-webpack-plugin": "^5.1.1", 77 | "ts-loader": "^6.1.2", 78 | "tslint": "^5.12.1", 79 | "typescript": "^3.3.1", 80 | "vscode": "^1.1.33", 81 | "webpack": "^4.41.0", 82 | "webpack-cli": "^3.3.9" 83 | }, 84 | "dependencies": { 85 | "@types/request-promise-native": "^1.0.17", 86 | "lodash": "^4.17.15", 87 | "parse-diff": "^0.6.0", 88 | "request": "^2.88.0", 89 | "request-promise-native": "^1.0.7", 90 | "simple-git": "^1.126.0", 91 | "ws": "^7.2.1" 92 | }, 93 | "repository": { 94 | "private": false, 95 | "type": "git", 96 | "url": "https://github.com/gitduckhq/vscode-extension.git" 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /src/api/index.ts: -------------------------------------------------------------------------------- 1 | import * as request from 'request-promise-native'; 2 | import config from '../config' 3 | import {Commit} from '../types' 4 | import {getStore} from '../store'; 5 | const {version} = require('../../package.json'); 6 | import * as os from 'os'; 7 | import * as vscode from 'vscode'; 8 | 9 | const {apiHost} = config; 10 | 11 | const getURI = (path: string) => apiHost + path; 12 | 13 | const getCommonHeaders = (): object => ({ 14 | 'X-GD-Extension-Version': version, 15 | 'X-GD-OS': `${os.platform()} ${os.release()}`, 16 | 'X-GD-IDE': vscode.env.appName, 17 | }); 18 | 19 | async function get({path, qs = {}, getFullResponse = false}: { path: string, qs?: object, getFullResponse?: boolean }): Promise { 20 | const authToken = getStore().getAuthToken(); 21 | const headers = {...getCommonHeaders(), ...(authToken ? {Authorization: authToken}: {})}; 22 | 23 | return request({ 24 | method: 'GET', 25 | uri: getURI(path), 26 | resolveWithFullResponse: getFullResponse, 27 | qs: qs, 28 | json: true, 29 | headers, 30 | }); 31 | } 32 | 33 | async function post({path, body, getFullResponse = false}: { path: string, body?: object, getFullResponse?: boolean }): Promise { 34 | const authToken = getStore().getAuthToken(); 35 | const headers = {...getCommonHeaders(), ...(authToken ? {Authorization: authToken}: {})}; 36 | 37 | 38 | return request({ 39 | method: 'POST', 40 | uri: getURI(path), 41 | json: true, 42 | body: body, 43 | resolveWithFullResponse: getFullResponse, 44 | headers, 45 | }); 46 | } 47 | 48 | async function addCommits({id, commits = [], snippets = []}: { id: string, commits?: Commit[], snippets?: object[] }) { 49 | return post({ 50 | path: `/coding-sessions/${id}/commits`, 51 | body: { 52 | commits, 53 | snippets, 54 | } 55 | }) 56 | } 57 | 58 | 59 | export { 60 | addCommits, 61 | } 62 | -------------------------------------------------------------------------------- /src/auth.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from 'vscode'; 2 | import {getStore} from './store'; 3 | import config from './config'; 4 | import status from './status'; 5 | 6 | export const authenticationCallback = (token: string, installationId: string) => { 7 | const store = getStore(); 8 | if (installationId !== store.installationId) { 9 | vscode.window.showErrorMessage('Error authenticating. Try again or contact support.'); 10 | return; 11 | } 12 | 13 | store.setAuthToken(token); 14 | status.stop(); 15 | vscode.window.showInformationMessage('Successfully authenticated'); 16 | }; 17 | 18 | export const login = () => { 19 | const store = getStore(); 20 | const URL = `${config.websiteHost}/auth/vscode?installationId=${store.installationId}`; 21 | 22 | vscode.window.showInformationMessage( 23 | `Please open this url in your browser so the extension can connect to your GitDuck account: ${URL}`, 24 | 'Copy URL' 25 | ).then(() => { 26 | vscode.env.clipboard.writeText(URL); 27 | }); 28 | vscode.env.openExternal(vscode.Uri.parse(URL)); 29 | }; 30 | 31 | export const logout = () => { 32 | const store = getStore(); 33 | store.logout(); 34 | vscode.window.showInformationMessage('Logged out'); 35 | status.login(); 36 | }; 37 | -------------------------------------------------------------------------------- /src/code-linking.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from "vscode"; 2 | import {FileSystemWatcher, FileType, Uri, workspace} from "vscode"; 3 | import * as fs from 'fs'; 4 | import * as nodePath from 'path'; 5 | import * as nodeUtil from 'util'; 6 | import * as simpleGit from 'simple-git/promise'; 7 | import {ListLogSummary} from 'simple-git/typings/response'; 8 | import {Commit} from './types'; 9 | import {getStore} from './store'; 10 | 11 | let gitFileListeners: { [path: string]: FileSystemWatcher } = {}; 12 | let commitsInSession: { [hash: string]: Commit } = {}; 13 | let gdRepoPath: string = ''; 14 | let onDidChangeWorkspaceFoldersEmitters: vscode.Disposable; 15 | 16 | async function gitExec({gitRepo, args = [], useGDRepo = false}: { gitRepo: string, args: string[], useGDRepo?: boolean }) { 17 | const git = simpleGit(gitRepo); 18 | if (useGDRepo) { 19 | git.env('GIT_DIR', gdRepoPath); 20 | git.env('GIT_WORK_TREE', gitRepo); 21 | } 22 | return git.raw(args); 23 | } 24 | 25 | async function getGitRootPath(path: string) { 26 | //@ts-ignore 27 | const stats = await workspace.fs.stat(Uri.file(path)); 28 | 29 | if (stats.type !== FileType.Directory) { 30 | const newPath = path.split('/'); 31 | newPath.pop(); 32 | path = newPath.join('/'); 33 | } 34 | 35 | return gitExec({ 36 | gitRepo: path, 37 | args: [ 38 | 'rev-parse', 39 | '--show-toplevel' 40 | ] 41 | }).then(res => res && res.trim()); 42 | } 43 | 44 | async function gitLog({gitRepo, args = [], useGDRepo = false}: { gitRepo: string, args?: string[], useGDRepo?: boolean }): Promise { 45 | const git = simpleGit(gitRepo); 46 | if (useGDRepo) { 47 | git.env('GIT_DIR', gdRepoPath); 48 | git.env('GIT_WORK_TREE', gitRepo); 49 | } 50 | return git.log(args); 51 | } 52 | 53 | async function gitShow({gitRepo, commitHash}: { gitRepo: string, commitHash: string }) { 54 | return simpleGit(gitRepo) 55 | .show([commitHash]); 56 | } 57 | 58 | async function diffCommit({gitRepo, commitHash, full = false}: { gitRepo: string, commitHash: string, full?: boolean }) { 59 | return simpleGit(gitRepo) 60 | .diff([ 61 | `${commitHash}^!`, 62 | ...(full ? ['-U5000'] : []) 63 | ]); 64 | } 65 | 66 | async function getCommitsDuringSession(gitRepo: string) { 67 | const args = [ 68 | '--branches', 69 | '--not', 70 | '--remotes', 71 | '--date=iso', 72 | ]; 73 | 74 | const {startTrackingTimestamp} = getStore(); 75 | if (startTrackingTimestamp) { 76 | args.push(`--since="${startTrackingTimestamp.toISOString()}"`); 77 | } 78 | 79 | return gitLog({ 80 | gitRepo, 81 | args, 82 | }); 83 | } 84 | 85 | async function watchGitCommits({onCommitDetected}: {onCommitDetected?: Function} = {}) { 86 | console.log('Discovering and watching .git folders'); 87 | const {workspaceFolders} = vscode.workspace; 88 | 89 | if (!workspaceFolders) { 90 | return; 91 | } 92 | 93 | const results = (await Promise.all( 94 | workspaceFolders.map(async workspaceFolder => { 95 | const workspacePath = workspaceFolder.uri.path; 96 | const rootRepoPath = await getGitRootPath(workspacePath); 97 | const gitPath = nodePath.join(rootRepoPath, '.git', 'logs/HEAD'); 98 | 99 | if (gitFileListeners[gitPath]) { 100 | console.log('Git path', gitPath, 'already tracked.'); 101 | return; 102 | } 103 | 104 | const accessFile = nodeUtil.promisify(fs.access); 105 | await accessFile(gitPath, fs.constants.R_OK); 106 | 107 | console.log('Tracking ', gitPath); 108 | 109 | gitFileListeners[gitPath] = vscode.workspace.createFileSystemWatcher( 110 | gitPath, false, false, false 111 | ); 112 | 113 | const watcher = gitFileListeners[gitPath]; 114 | 115 | watcher.onDidChange(async e => { 116 | const commitsDone = await getCommitsDuringSession(workspacePath); 117 | 118 | await Promise.all( 119 | commitsDone.all.map(async commit => { 120 | if (!commitsInSession[commit.hash]) { 121 | console.log(`Captured commit ${commit.hash}`); 122 | const gitRepo = workspacePath; 123 | const commitHash = commit.hash; 124 | const rawCommitFull = diffCommit({gitRepo, commitHash, full: true}); 125 | const rawCommit = diffCommit({gitRepo, commitHash}); 126 | 127 | commitsInSession[commit.hash] = { 128 | authorEmail: commit.author_email, 129 | authorName: commit.author_name, 130 | body: commit.body, 131 | date: new Date(commit.date), 132 | videoTimestamp: Math.floor((Date.now() - getStore().startTrackingTimestamp.getTime()) / 1000), 133 | hash: commit.hash, 134 | message: commit.message, 135 | refs: commit.refs, 136 | rawCommit: await rawCommit, 137 | rawCommitFull: await rawCommitFull, 138 | }; 139 | 140 | onCommitDetected(commitsInSession[commit.hash]) 141 | } 142 | }).map(p => p.catch(console.error)) 143 | ); 144 | 145 | console.log('Commits done in this session so far', commitsInSession); 146 | }); 147 | }) 148 | .map(p => p.catch(e => e)) 149 | )).filter(p => { 150 | if (p instanceof Error) { 151 | console.error(p); 152 | return false; 153 | } 154 | 155 | return true; 156 | }); 157 | } 158 | 159 | function cleanWatchers() { 160 | Object.entries(gitFileListeners).forEach(([key, watcher]) => { 161 | console.log('Removing listener for ', key); 162 | watcher.dispose(); 163 | }); 164 | } 165 | 166 | async function initCodeLinkingListener({onCommitDetected}: {onCommitDetected?: Function} = {}) { 167 | gitFileListeners = {}; 168 | commitsInSession = {}; 169 | 170 | watchGitCommits({onCommitDetected}).catch(console.error); 171 | onDidChangeWorkspaceFoldersEmitters = vscode.workspace.onDidChangeWorkspaceFolders(() => watchGitCommits({onCommitDetected})); 172 | } 173 | 174 | function getSessionCommits(): Array { 175 | return Object.values(commitsInSession); 176 | } 177 | 178 | function cleanupCodeLinkingSession() { 179 | console.log('Cleaning up code-linking session'); 180 | cleanWatchers(); 181 | commitsInSession = {}; 182 | gitFileListeners = {}; 183 | if (onDidChangeWorkspaceFoldersEmitters) { 184 | onDidChangeWorkspaceFoldersEmitters.dispose(); 185 | } 186 | 187 | console.log('Cleaned up code-linking session'); 188 | 189 | } 190 | 191 | export { 192 | initCodeLinkingListener, 193 | getSessionCommits, 194 | cleanupCodeLinkingSession, 195 | }; 196 | 197 | 198 | -------------------------------------------------------------------------------- /src/config.ts: -------------------------------------------------------------------------------- 1 | const isProd = process.env.NODE_ENV === 'production'; 2 | 3 | export default { 4 | isProd: isProd, 5 | apiHost: isProd ? 'https://api.gitduck.com' : 'http://localhost:3001', 6 | websiteHost: isProd ? 'https://gitduck.com' : 'http://localhost:3000', 7 | } 8 | -------------------------------------------------------------------------------- /src/extension.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from 'vscode'; 2 | import status from './status'; 3 | import {addCommits} from './api'; 4 | import config from './config'; 5 | import {getStore, initStore} from './store'; 6 | import {cleanupCodeLinkingSession, initCodeLinkingListener} from './code-linking'; 7 | import {ExtensionUriHandler} from './uri-handler'; 8 | import {login, logout} from './auth'; 9 | import {init as initWebSocket} from './websocket'; 10 | 11 | export function activate(context: vscode.ExtensionContext) { 12 | try { 13 | initStore(context); 14 | const store = getStore(); 15 | 16 | if (store.isAuthenticated()) { 17 | status.stop(); 18 | } else { 19 | status.login(); 20 | } 21 | status.show(); 22 | store.onCodingSessionStarted(onCodingSessionStart); 23 | store.onCodingSessionEnded(onCodingSessionEnd); 24 | initWebSocket(); 25 | 26 | async function onCodingSessionStart(codingSessionId, createdDateTime) { 27 | if (store.isRecording) { 28 | return 29 | } 30 | 31 | store.isRecording = true; 32 | status.loading(); 33 | try { 34 | await initCodeLinkingListener({ 35 | onCommitDetected: createOnCommitDetectedFn(codingSessionId) 36 | }); 37 | store.startTrackingTimestamp = createdDateTime ? new Date(createdDateTime) : new Date(); 38 | 39 | store.viewURL = `${config.websiteHost}/watch/${codingSessionId}`; 40 | vscode.window.showInformationMessage( 41 | `Watching commits for ${store.viewURL}`, 42 | 'Copy URL' 43 | ).then(() => { 44 | vscode.env.clipboard.writeText(store.viewURL); 45 | }); 46 | 47 | status.start(createdDateTime); 48 | } catch (error) { 49 | vscode.window.showErrorMessage('Something went wrong. If you need help please write to help@gitduck.com.'); 50 | console.error(error); 51 | store.isRecording = false; 52 | return status.stop(); 53 | } 54 | } 55 | 56 | function createOnCommitDetectedFn(codingSessionId) { 57 | return async (commit) => { 58 | try { 59 | await addCommits({ 60 | id: codingSessionId, 61 | commits: [commit] 62 | }); 63 | } catch (error) { 64 | console.error('Error uploading commit', error); 65 | await new Promise(resolve => setTimeout(resolve, 3000)); 66 | await addCommits({ 67 | id: codingSessionId, 68 | commits: [commit] 69 | }).catch(() => vscode.window.showErrorMessage('Error uploading commit')); 70 | } 71 | } 72 | } 73 | 74 | async function onCodingSessionEnd(codingSessionId) { 75 | status.uploading(); 76 | 77 | const {viewURL} = store; 78 | 79 | cleanupCodeLinkingSession(); 80 | store.cleanupCodingSession(); 81 | 82 | vscode.window.showInformationMessage( 83 | `Share your coding video: ${viewURL}`, 84 | 'Copy URL' 85 | ).then(() => { 86 | vscode.env.clipboard.writeText(viewURL); 87 | }); 88 | store.isRecording = false; 89 | status.stop(); 90 | } 91 | 92 | async function uploadSnippet() { 93 | if (!store.isAuthenticated()) { 94 | return vscode.window.showErrorMessage('Please first login to your GitDuck account.'); 95 | } 96 | 97 | if (!store.isRecording) { 98 | return vscode.window.showErrorMessage('Please start a coding session from https://gitduck.com'); 99 | } 100 | 101 | const editor = vscode.window.activeTextEditor; 102 | 103 | if (!editor) { 104 | return vscode.window.showErrorMessage('There is no selected text'); 105 | } 106 | 107 | const selection = editor.selection; 108 | const relativePath = vscode.workspace.asRelativePath(editor.document.fileName, true); 109 | const selectedText = editor.document.getText(selection); 110 | 111 | if (!selectedText) { 112 | return vscode.window.showErrorMessage('There is no selected text'); 113 | } 114 | 115 | const now = new Date(); 116 | 117 | const snippet = { 118 | code: selectedText, 119 | fromLine: selection.start.line + 1, 120 | toLine: selection.end.line + 1, 121 | path: relativePath, 122 | timestamp: now, 123 | videoTimestamp: Math.floor((Number(now) - store.startTrackingTimestamp.getTime()) / 1000), 124 | }; 125 | 126 | try { 127 | await addCommits({id: store.codingSessionId, snippets: [snippet]}); 128 | } catch (error) { 129 | console.error('Error uploading snippet', error); 130 | vscode.window.showErrorMessage('Error uploading your snippet') 131 | } 132 | } 133 | 134 | function newStream() { 135 | vscode.env.openExternal(vscode.Uri.parse(`${config.websiteHost}/new-video`)) 136 | } 137 | 138 | function stopStream() { 139 | const {viewURL} = getStore(); 140 | vscode.window.showInformationMessage(`You can stop this video from your browser.`) 141 | } 142 | 143 | const registerCommand = (id: string, cb: (...args: any) => any) => context.subscriptions.push( 144 | vscode.commands.registerCommand(id, cb) 145 | ); 146 | 147 | registerCommand('gitduck.login', login); 148 | registerCommand('gitduck.logout', logout); 149 | registerCommand('gitduck.uploadSnippet', uploadSnippet); 150 | registerCommand('gitduck.newStream', newStream); 151 | registerCommand('gitduck.stopStream', stopStream); 152 | 153 | context.subscriptions.push(status, vscode.window.registerUriHandler(new ExtensionUriHandler())); 154 | } catch (e) { 155 | console.error('Error starting GitDuck...', e); 156 | vscode.window.showErrorMessage('Something went wrong initializing GitDuck'); 157 | } 158 | } 159 | 160 | export function deactivate() { 161 | console.log('Deactivating extension....'); 162 | } 163 | -------------------------------------------------------------------------------- /src/status.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from 'vscode'; 2 | 3 | const workbenchConfig = vscode.workspace.getConfiguration('workbench'); 4 | 5 | function clean(x: number) { 6 | let res = `${Math.trunc(x)}`; 7 | if (res.length < 2) { 8 | res = `0${res}`; 9 | } 10 | return res; 11 | } 12 | 13 | class StatusBar { 14 | 15 | private item: vscode.StatusBarItem; 16 | timeout: NodeJS.Timer | null = null; 17 | counting = false; 18 | userColorCustomizations: any; 19 | gitDuckColorCustomizations: any; 20 | 21 | constructor() { 22 | this.item = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right); 23 | this.userColorCustomizations = workbenchConfig.get('colorCustomizations'); 24 | const statusBarFGColor = '#802525'; 25 | const statusBarBGColor = '#F85246'; 26 | this.gitDuckColorCustomizations = { 27 | 'statusBar.background': statusBarBGColor, 28 | 'statusBar.foreground': statusBarFGColor, 29 | 'statusBar.debuggingForeground': statusBarFGColor, 30 | 'statusBar.debuggingBackground': statusBarBGColor, 31 | 'statusBar.noFolderForeground': statusBarFGColor, 32 | 'statusBar.noFolderBackground': statusBarBGColor, 33 | }; 34 | } 35 | 36 | show() { 37 | this.item.show(); 38 | } 39 | 40 | dispose() { 41 | this.recordingStopped(); 42 | this.item.dispose(); 43 | } 44 | 45 | loading() { 46 | this.item.text = 'Loading...'; 47 | this.item.command = undefined; 48 | } 49 | 50 | uploading() { 51 | this.item.text = 'Uploading...'; 52 | this.item.command = undefined; 53 | } 54 | 55 | stop() { 56 | workbenchConfig.update('colorCustomizations', this.userColorCustomizations, true); 57 | this.item.command = 'gitduck.newStream'; 58 | this.recordingStopped(); 59 | this.item.text = '$(circle-outline) Record new video'; 60 | this.item.color = 'white'; 61 | this.counting = false; 62 | } 63 | 64 | login() { 65 | this.recordingStopped(); 66 | this.item.command = 'gitduck.login'; 67 | this.item.text = 'Login to GitDuck'; 68 | this.item.color = 'white'; 69 | this.counting = false; 70 | } 71 | 72 | stopping() { 73 | this.recordingStopped(); 74 | this.counting = false; 75 | this.item.text = '$(pulse) GitDuck Stopping...'; 76 | this.item.color = '#000000'; 77 | } 78 | 79 | recordingStopped() { 80 | if (this.timeout) { 81 | clearInterval(this.timeout); 82 | } 83 | } 84 | 85 | start(createdDateTime) { 86 | this.userColorCustomizations = workbenchConfig.get('colorCustomizations'); 87 | const colorCustomizations = {...this.userColorCustomizations, ...this.gitDuckColorCustomizations}; 88 | workbenchConfig.update('colorCustomizations', colorCustomizations, true); 89 | this.item.command = 'gitduck.stopStream'; 90 | this.item.text = '$(circle-filled) GitDuck recording'; 91 | this.item.color = '#000000'; 92 | 93 | const start = createdDateTime || Date.now(); 94 | const og = this.item.text; 95 | const sec = 1000; 96 | const min = sec * 60; 97 | const hour = min * 60; 98 | 99 | const update = () => { 100 | const time = Date.now() - start; 101 | let timeStr = `${clean((time / min) % 60)}:${clean((time / sec) % 60)}`; 102 | if (time > hour) { 103 | timeStr = `${Math.trunc(time / hour)}:${timeStr}`; 104 | } 105 | this.item.text = `${og} : ${timeStr}`; 106 | }; 107 | 108 | clearTimeout(this.timeout); 109 | this.timeout = setInterval(update, 1000); 110 | 111 | update(); 112 | } 113 | } 114 | 115 | export default new StatusBar(); 116 | -------------------------------------------------------------------------------- /src/store.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from 'vscode'; 2 | import * as crypto from 'crypto' 3 | import * as EventEmitter from 'events'; 4 | 5 | let context: vscode.ExtensionContext; 6 | let store: Store; 7 | 8 | // @ts-ignore https://stackoverflow.com/a/2117523 9 | const uuidV4 = (): string => ([1e7] + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/g, c => 10 | (c ^ crypto.randomBytes(1)[0] & 15 >> c / 4).toString(16) 11 | ); 12 | 13 | const stateKeys = { 14 | AUTH_TOKEN: 'authToken', 15 | INSTALLATION_ID: 'installationId', 16 | CURRENT_USER: 'currentUser', 17 | MY_ORGANIZATIONS: 'myOrganizations', 18 | SELECTED_ORGANIZATION_ID: 'selectedOrganizationId', 19 | }; 20 | 21 | class Store { 22 | public installationId: string | undefined; 23 | private currentUser: object | undefined; 24 | private authToken: string | undefined; 25 | private snippets: object[] = []; 26 | private eventEmitter: EventEmitter; 27 | 28 | public codingSessionId = null; 29 | public isRecording = false; 30 | public viewURL: string | undefined; 31 | public startTrackingTimestamp: Date; 32 | public events = { 33 | USER_LOGGED_IN: 'USER_LOGGED_IN', 34 | USER_LOGGED_OUT: 'USER_LOGGED_OUT', 35 | CODING_SESSION_STARTED: 'CODING_SESSION_STARTED', 36 | CODING_SESSION_ENDED: 'CODING_SESSION_ENDED', 37 | }; 38 | 39 | constructor(private context: vscode.ExtensionContext) { 40 | this.loadInitialState(); 41 | this.eventEmitter = new EventEmitter(); 42 | this.eventEmitter.on(this.events.CODING_SESSION_STARTED, (codingSessionId) => { 43 | this.codingSessionId = codingSessionId 44 | }); 45 | this.eventEmitter.on(this.events.CODING_SESSION_ENDED, () => this.codingSessionId = null); 46 | } 47 | 48 | loadInitialState() { 49 | const {globalState} = this.context; 50 | let installationId = globalState.get(stateKeys.INSTALLATION_ID); 51 | if (!installationId) { 52 | installationId = uuidV4(); 53 | globalState.update(stateKeys.INSTALLATION_ID, installationId) 54 | } 55 | 56 | this.installationId = installationId.toString(); 57 | this.authToken = globalState.get(stateKeys.AUTH_TOKEN); 58 | this.currentUser = globalState.get(stateKeys.CURRENT_USER); 59 | } 60 | 61 | onUserLoggedIn(callback) { 62 | this.eventEmitter.on(this.events.USER_LOGGED_IN, callback) 63 | } 64 | 65 | onUserLoggedOut(callback) { 66 | this.eventEmitter.on(this.events.USER_LOGGED_OUT, callback) 67 | } 68 | 69 | emitStartedCodingSession(codingSessionId, createdDateTime) { 70 | this.eventEmitter.emit(this.events.CODING_SESSION_STARTED, codingSessionId, createdDateTime) 71 | } 72 | 73 | emitEndedCodingSession(codingSessionId) { 74 | this.eventEmitter.emit(this.events.CODING_SESSION_ENDED, codingSessionId) 75 | } 76 | 77 | onCodingSessionStarted(callback) { 78 | this.eventEmitter.on(this.events.CODING_SESSION_STARTED, callback) 79 | } 80 | 81 | onCodingSessionEnded(callback) { 82 | this.eventEmitter.on(this.events.CODING_SESSION_ENDED, callback) 83 | } 84 | 85 | setAuthToken(token: string) { 86 | const {globalState} = this.context; 87 | globalState.update(stateKeys.AUTH_TOKEN, token); 88 | this.authToken = token; 89 | this.eventEmitter.emit(this.events.USER_LOGGED_IN); 90 | } 91 | 92 | getAuthToken() { 93 | return this.authToken; 94 | } 95 | 96 | isAuthenticated() { 97 | return !!this.authToken; 98 | } 99 | 100 | logout() { 101 | this.clearAuthToken(); 102 | this.eventEmitter.emit(this.events.USER_LOGGED_OUT); 103 | } 104 | 105 | clearAuthToken() { 106 | const {globalState} = this.context; 107 | globalState.update(stateKeys.AUTH_TOKEN, null); 108 | this.authToken = undefined; 109 | } 110 | 111 | addSnippet(snippet: object) { 112 | this.snippets.push(snippet); 113 | } 114 | 115 | getSnippets() { 116 | return this.snippets; 117 | } 118 | 119 | cleanupCodingSession() { 120 | this.codingSessionId = null; 121 | this.isRecording = false; 122 | this.viewURL = undefined; 123 | this.startTrackingTimestamp = undefined; 124 | this.snippets = []; 125 | } 126 | } 127 | 128 | export const initStore = (ctx: any) => context = ctx; 129 | 130 | export const getStore = () => { 131 | if (!context) { 132 | throw new Error('Store not initialized') 133 | } 134 | 135 | if (!store) { 136 | store = new Store(context); 137 | } 138 | 139 | return store; 140 | }; 141 | -------------------------------------------------------------------------------- /src/test/extension.test.ts: -------------------------------------------------------------------------------- 1 | // 2 | // Note: This example test is leveraging the Mocha test framework. 3 | // Please refer to their documentation on https://mochajs.org/ for help. 4 | // 5 | 6 | // The module 'assert' provides assertion methods from node 7 | import * as assert from 'assert'; 8 | 9 | // You can import and use all API from the 'vscode' module 10 | // as well as import your extension to test it 11 | // import * as vscode from 'vscode'; 12 | // import * as myExtension from '../extension'; 13 | 14 | // Defines a Mocha test suite to group tests of similar kind together 15 | suite("Extension Tests", function () { 16 | 17 | // Defines a Mocha unit test 18 | test("Something 1", function() { 19 | assert.equal(-1, [1, 2, 3].indexOf(5)); 20 | assert.equal(-1, [1, 2, 3].indexOf(0)); 21 | }); 22 | }); -------------------------------------------------------------------------------- /src/test/index.ts: -------------------------------------------------------------------------------- 1 | // 2 | // PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING 3 | // 4 | // This file is providing the test runner to use when running extension tests. 5 | // By default the test runner in use is Mocha based. 6 | // 7 | // You can provide your own test runner if you want to override it by exporting 8 | // a function run(testsRoot: string, clb: (error: Error, failures?: number) => void): void 9 | // that the extension host can call to run the tests. The test runner is expected to use console.log 10 | // to report the results back to the caller. When the tests are finished, return 11 | // a possible error to the callback or null if none. 12 | 13 | import * as testRunner from 'vscode/lib/testrunner'; 14 | 15 | // You can directly control Mocha options by configuring the test runner below 16 | // See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options 17 | // for more info 18 | testRunner.configure({ 19 | ui: 'tdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.) 20 | useColors: true // colored output from test results 21 | }); 22 | 23 | module.exports = testRunner; -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | export type Commit = { 2 | authorEmail: string, 3 | authorName: string, 4 | body: string, 5 | date: Date, 6 | videoTimestamp: number, 7 | hash: string, 8 | message: string, 9 | refs: string, 10 | rawCommit: string, 11 | rawCommitFull: string, 12 | } 13 | -------------------------------------------------------------------------------- /src/uri-handler.ts: -------------------------------------------------------------------------------- 1 | import * as vscode from 'vscode'; 2 | import {authenticationCallback} from './auth'; 3 | 4 | export class ExtensionUriHandler implements vscode.UriHandler { 5 | handleUri(uri: vscode.Uri): vscode.ProviderResult { 6 | const { path, query } = uri; 7 | const parsed = this.parseQuery(query); 8 | 9 | if (path === '/auth/callback') { 10 | const { token, installationId } = parsed; 11 | authenticationCallback(token, installationId); 12 | } 13 | } 14 | 15 | parseQuery(queryString: string): any { 16 | // https://stackoverflow.com/a/13419367 17 | const filtered = 18 | queryString[0] === '?' ? queryString.substr(1) : queryString; 19 | const pairs = filtered.split('&'); 20 | const query: { [key: string]: string } = {}; 21 | 22 | for (let i = 0; i < pairs.length; i++) { 23 | let pair = pairs[i].split('='); 24 | const key: string = decodeURIComponent(pair[0]); 25 | query[key] = decodeURIComponent(pair[1] || ''); 26 | } 27 | 28 | return query; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/websocket.ts: -------------------------------------------------------------------------------- 1 | import * as WebSocket from 'ws' 2 | import config from './config' 3 | import {getStore} from './store' 4 | 5 | let wsConnection; 6 | let pingTimeout; 7 | 8 | const heartbeat = () => { 9 | console.debug('WS heartbeat'); 10 | clearTimeout(pingTimeout); 11 | 12 | const timeLimit = (30 + 1) * 1000; 13 | pingTimeout = setTimeout(() => { 14 | console.debug('Terminating WS connection because failed the heartbeat'); 15 | return disconnect() 16 | }, timeLimit) 17 | }; 18 | 19 | enum WsReadyStatus { 20 | CONNECTING = 0, 21 | OPEN = 1, 22 | CLOSING = 2, 23 | CLOSED = 3, 24 | } 25 | 26 | function connectIfLoggedIn() { 27 | const store = getStore(); 28 | if (store.isAuthenticated()) { 29 | onUserLoggedIn().catch(console.error); 30 | } 31 | } 32 | 33 | 34 | export function init() { 35 | console.debug('Initiating WS library'); 36 | const store = getStore(); 37 | 38 | store.onUserLoggedIn(onUserLoggedIn); 39 | store.onUserLoggedOut(onUserLoggedOut); 40 | 41 | connectIfLoggedIn() 42 | } 43 | 44 | async function onUserLoggedIn() { 45 | const authToken = getStore().getAuthToken(); 46 | console.debug('Authenticating WS server'); 47 | await authenticate(authToken); 48 | console.debug('WS server authentication ok'); 49 | 50 | await send({type: 'subscribe_created_or_stopped_sessions'}); 51 | const ws = await getConnection(); 52 | 53 | ws.on('message', msg => { 54 | const {type, codingSessionId, createdDateTime} = JSON.parse(msg); 55 | 56 | if (type === 'coding_session_created') { 57 | getStore().emitStartedCodingSession(codingSessionId, createdDateTime && new Date(createdDateTime)) 58 | } else if (type === 'coding_session_ended') { 59 | getStore().emitEndedCodingSession(codingSessionId) 60 | } 61 | }) 62 | } 63 | 64 | async function onUserLoggedOut() { 65 | await disconnect(); 66 | } 67 | 68 | 69 | export async function send(msg) { 70 | console.debug('Sending WS msg', JSON.stringify(msg)); 71 | const ws = await getConnection(); 72 | ws.send(JSON.stringify(msg)) 73 | } 74 | 75 | export async function disconnect() { 76 | if (wsConnection && wsConnection.readyStatus === WsReadyStatus.CLOSED) { 77 | wsConnection.removeAllListeners(); 78 | wsConnection = null; 79 | return; 80 | } 81 | 82 | wsConnection.terminate(); 83 | wsConnection.removeAllListeners(); 84 | wsConnection = null; 85 | clearTimeout(pingTimeout); 86 | setTimeout(connectIfLoggedIn, 1000) 87 | } 88 | 89 | export async function getConnection() { 90 | try { 91 | // if no wsConnection or wsConnection is CLOSING or CLOSED create new Connection 92 | if (!wsConnection || [WsReadyStatus.CLOSING, WsReadyStatus.CLOSED].includes(wsConnection.readyState)) { 93 | wsConnection = new WebSocket(config.apiHost.replace('http', 'ws') + '/websocket'); 94 | 95 | wsConnection.on('open', heartbeat); 96 | wsConnection.on('ping', heartbeat); 97 | 98 | return await new Promise((resolve, reject) => { 99 | wsConnection.on('open', function onOpen() { 100 | wsConnection.off('open', onOpen); 101 | resolve(wsConnection); 102 | }); 103 | wsConnection.on('error', function onError(error) { 104 | wsConnection.off('error', onError); 105 | reject(error) 106 | }) 107 | }) 108 | } 109 | 110 | if (wsConnection.readyState === WsReadyStatus.CONNECTING) { 111 | return new Promise(resolve => { 112 | wsConnection.on('open', function onOpen() { 113 | wsConnection.off('open', onOpen); 114 | resolve(wsConnection); 115 | }); 116 | }) 117 | } 118 | 119 | return wsConnection; 120 | } catch (error) { 121 | await new Promise(resolve => setTimeout(resolve, 1000 + (1000 * Math.random()))); 122 | console.error('Error getting connection, retrying', error); 123 | return getConnection(); 124 | } 125 | } 126 | 127 | export async function authenticate(token) { 128 | return new Promise(async (resolve, reject) => { 129 | const ws = await getConnection(); 130 | await send({type: 'authenticate', authToken: token}); 131 | ws.on('message', function onMsg(msg) { 132 | const {type} = JSON.parse(msg); 133 | if (type === 'authentication_ok') { 134 | ws.off('message', onMsg); 135 | return resolve() 136 | } else if (type === 'error') { 137 | ws.off('message', onMsg); 138 | return reject('Error authenticating over web sockets') 139 | } 140 | }) 141 | }) 142 | } 143 | 144 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "target": "es6", 5 | "outDir": "out", 6 | "lib": [ 7 | "es6" 8 | ], 9 | "sourceMap": true, 10 | "rootDir": "src", 11 | "resolveJsonModule": true, 12 | "strict": false /* enable all strict type-checking options */ 13 | /* Additional Checks */ 14 | // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ 15 | // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ 16 | // "noUnusedParameters": true, /* Report errors on unused parameters. */ 17 | }, 18 | "exclude": [ 19 | "node_modules", 20 | ".vscode-test" 21 | ] 22 | } 23 | -------------------------------------------------------------------------------- /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "rules": { 3 | "no-string-throw": true, 4 | "no-unused-expression": true, 5 | "no-duplicate-variable": true, 6 | "curly": true, 7 | "class-name": true, 8 | "semicolon": [ 9 | true, 10 | "always" 11 | ], 12 | "triple-equals": true 13 | }, 14 | "defaultSeverity": "warning" 15 | } 16 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | //@ts-check 2 | 'use strict' 3 | 4 | const path = require('path') 5 | const CopyWebpackPlugin = require('copy-webpack-plugin') 6 | const childProcess = require('child_process') 7 | const {promisify} = require('util') 8 | const webpack = require('webpack') 9 | const exec = promisify(childProcess.exec) 10 | 11 | module.exports = async (env, options) => { 12 | const isProd = options.mode === 'production' 13 | 14 | await exec('rm -rf ./out') 15 | 16 | return { 17 | target: 'node', // vscode extensions run in a Node.js-context 📖 -> https://webpack.js.org/configuration/node/ 18 | entry: './src/extension.ts', // the entry point of this extension, 📖 -> https://webpack.js.org/configuration/entry-context/ 19 | output: { 20 | // the bundle is stored in the 'out' folder (check package.json), 📖 -> https://webpack.js.org/configuration/output/ 21 | path: path.resolve(__dirname, 'out'), 22 | filename: 'extension.js', 23 | libraryTarget: 'commonjs2', 24 | devtoolModuleFilenameTemplate: '../[resource-path]' 25 | }, 26 | devtool: isProd ? false : 'source-map', 27 | externals: { 28 | vscode: 'commonjs vscode' // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/ 29 | }, 30 | node: { 31 | __dirname: false, 32 | }, 33 | resolve: { 34 | // support reading TypeScript and JavaScript files, 📖 -> https://github.com/TypeStrong/ts-loader 35 | extensions: ['.ts', '.js'] 36 | }, 37 | plugins: [ 38 | new CopyWebpackPlugin([ 39 | {from: 'assets', to: 'assets'}, 40 | ]), 41 | new webpack.EnvironmentPlugin({ 42 | 'process.env.NODE_ENV': isProd ? 'production' : 'development', 43 | }), 44 | ], 45 | module: { 46 | rules: [ 47 | { 48 | test: /\.ts$/, 49 | exclude: /node_modules/, 50 | use: [ 51 | { 52 | loader: 'ts-loader' 53 | } 54 | ] 55 | } 56 | ] 57 | } 58 | } 59 | } 60 | --------------------------------------------------------------------------------