├── .env
├── .firebaserc
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc
├── Datadog.md
├── LICENSE
├── README.md
├── database.rules.json
├── e2e
└── demo.test.ts
├── eslint.config.js
├── firebase.json
├── package-lock.json
├── package.json
├── patches
├── @codingame+monaco-vscode-api+11.1.2.patch
├── @codingame+monaco-vscode-configuration-service-override+11.1.2.patch
└── vscode+11.1.2.patch
├── playwright.config.ts
├── src
├── app.css
├── app.d.ts
├── app.html
├── lib
│ ├── assets
│ │ ├── datadog-logo-rgb.svg
│ │ └── datadog-logo.svg
│ ├── components
│ │ ├── ConfirmOverrideAuthDialog.svelte
│ │ ├── FileMenu.svelte
│ │ ├── IDELayout.svelte
│ │ ├── IDENavbar.svelte
│ │ ├── LoadingIndicator.svelte
│ │ ├── MessagePage.svelte
│ │ ├── OutputStatusBar.svelte
│ │ ├── RadioGroup.svelte
│ │ ├── RunButton.svelte
│ │ ├── SettingsDialog
│ │ │ ├── SettingsDialog.svelte
│ │ │ └── TextField.svelte
│ │ ├── TabbedPane.svelte
│ │ ├── USACOJudgeInterface.svelte
│ │ └── editor
│ │ │ ├── ConnectionStatusIndicator.svelte
│ │ │ ├── EditorLoadingPlaceholder.svelte
│ │ │ ├── RealtimeEditor.svelte
│ │ │ ├── codemirror
│ │ │ └── CodemirrorEditor.svelte
│ │ │ ├── colorFromUserId.ts
│ │ │ └── monaco
│ │ │ ├── MainMonacoEditor.svelte
│ │ │ ├── SecondaryMonacoEditor.svelte
│ │ │ ├── utils.ts
│ │ │ └── vim-1.29.0.vsix
│ ├── firebase
│ │ ├── animals.ts
│ │ └── firebase.svelte
│ ├── index.ts
│ ├── judge
│ │ └── judge.ts
│ ├── server
│ │ └── firebaseAdmin.ts
│ ├── types.ts
│ └── utils.ts
└── routes
│ ├── (index)
│ ├── +page.svelte
│ └── components
│ │ ├── Dashboard.svelte
│ │ └── FilesList.svelte
│ ├── +layout.js
│ ├── +layout.svelte
│ ├── [id]
│ ├── +page.svelte
│ ├── +page.ts
│ ├── IDE.svelte
│ ├── USACOJudgePane.svelte
│ ├── copy
│ │ ├── +page.server.ts
│ │ └── +page.svelte
│ └── utils.ts
│ ├── api
│ ├── copyFile
│ │ └── +server.ts
│ └── createUSACOFile
│ │ └── +server.ts
│ ├── new
│ ├── +page.server.ts
│ ├── +page.svelte
│ └── generateRandomFileName.ts
│ └── usaco
│ └── [id]
│ ├── +page.svelte
│ └── +page.ts
├── static
└── favicon.png
├── svelte.config.js
├── tsconfig.json
└── vite.config.ts
/.env:
--------------------------------------------------------------------------------
1 | PUBLIC_USE_FIREBASE_EMULATORS=false
2 |
3 | PUBLIC_YJS_SERVER=wss://yjs.usaco.guide:443
4 | # Uncomment this to use a local yjs server
5 | # PUBLIC_YJS_SERVER=ws://localhost:1234
6 |
7 | # Used for copying files
8 | YJS_SECURITY_KEY=
9 |
10 | # Used for firebase admin
11 | FIREBASE_DATABASE_URL=https://cp-ide-2-default-rtdb.firebaseio.com
12 | FIREBASE_PROJECT_ID=
13 | FIREBASE_PRIVATE_KEY=
14 | FIREBASE_CLIENT_EMAIL=
15 |
16 | PUBLIC_JUDGE_URL=https://v3nuswv3poqzw6giv37wmrt6su0krxvt.lambda-url.us-east-1.on.aws
17 | # PUBLIC_JUDGE_URL=http://localhost:9001
18 |
--------------------------------------------------------------------------------
/.firebaserc:
--------------------------------------------------------------------------------
1 | {
2 | "projects": {
3 | "default": "cp-ide-2"
4 | }
5 | }
6 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | test-results
2 | node_modules
3 |
4 | # Output
5 | .output
6 | .vercel
7 | .netlify
8 | .wrangler
9 | /.svelte-kit
10 | /build
11 |
12 | # OS
13 | .DS_Store
14 | Thumbs.db
15 |
16 | # Env
17 | .env.*
18 | !.env.example
19 | !.env.test
20 |
21 | # Vite
22 | vite.config.js.timestamp-*
23 | vite.config.ts.timestamp-*
24 |
25 | # Firebase
26 | database-debug.log
27 | firebase-debug.log
28 | ui-debug.log
29 |
30 | .DS_Store
31 |
--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | engine-strict=true
2 |
--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | # Package Managers
2 | package-lock.json
3 | pnpm-lock.yaml
4 | yarn.lock
5 |
--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 | "useTabs": true,
3 | "singleQuote": true,
4 | "trailingComma": "none",
5 | "printWidth": 100,
6 | "plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
7 | "overrides": [
8 | {
9 | "files": "*.svelte",
10 | "options": {
11 | "parser": "svelte"
12 | }
13 | }
14 | ]
15 | }
16 |
--------------------------------------------------------------------------------
/Datadog.md:
--------------------------------------------------------------------------------
1 | # Datadog and the USACO Guide IDE
2 |
3 | [Datadog](https://www.datadoghq.com/) has generously provided its infrastructure monitoring capabilities to the USACO Guide IDE as part of its OSS program.
4 |
5 | The USACO Guide IDE uses Datadog to monitor our YJS server, which powers our realtime collaborative text editor, as well as the code execution engine on AWS Lambda.
6 |
7 | ## YJS Server
8 |
9 | Our [YJS Server](https://github.com/cpinitiative/ide-yjs) is a simple Node.js server running on an Azure VM instance. We have had ongoing stability issues associated with the YJS server as sudden spikes in traffic can easily overwhelm the server, bringing the entire IDE down. We were able to use Datadog Monitors and Datadog Metrics to improve uptime and better understand the scope of the issue.
10 |
11 | ### Datadog Metrics
12 |
13 | Datadog's Node.js library lets us easily track a variety of custom metrics about our application, giving us insight into both stability issues as well as application usage patterns. We tracked metrics such as document load time (how long it takes for a user to load a code file), the number of concurrent users, the number of code executions, how large document sizes are, and much more.
14 |
15 | These metrics are quite helpful when deciding which features to implement next. For example, one of our next planned features was better support for very large input files. Our current YJS implementation works well for small files, but can be quite inefficient and costly for large files. However, after tracking maximum document size metrics, we realized that very few users actually have large input files, so we deprioritized this feature.
16 |
17 | ### Datadog Monitors
18 |
19 | Previously, we didn't know when the IDE went down until someone reported the issue on Github. With Datadog, we used [Datadog Monitors](https://docs.datadoghq.com/monitors/) to set up intelligent alerts to immediately notify a system administrator once the server started slowing down, which helped us resolve downtime much faster.
20 |
21 | The most naive way to implement a monitor would be to monitor system metrics such as CPU usage or HTTP response codes. Both Datadog and built-in Azure services could do this, but we found that these basic monitors were insufficient: When the server was overloaded, requests would _slow down_, but the server wouldn't always _crash_. Additionally, an overloaded server didn't always correspond to high CPU usage; sometimes it might be bottlenecked by RAM or I/O or some other unknown reason. Testing HTTP endpoint responsiveness didn't always work either: sometimes the server status page would function fine even if the rest of the server wasn't functioning anymore. As such, our basic monitors often failed to detect downtime.
22 |
23 | What we really wanted was to monitor how long it took users to load their files. If it is taking an abnormally large amount of time to load files, the server is probably overloaded or down. Since we already tracked file load time metrics with Datadog, it was very straightforward to add a Datadog monitor to notify a system administrator through email and push notification any time the P95 load time exceeded a certain threshhold. This was a far more effective monitor; in fact, it even detected temporary spikes of high load that the system naturally recovered from after a short amount of time. Previously, we weren't even aware that this was an issue, as if the server was down for only a short period of time and quickly self-recovered later, users most likely would not file a Github issue.
24 |
25 | ## Code Execution Engine
26 |
27 | Our code execution engine is written in Rust and runs on AWS Lambda. We used Datadog's built-in AWS Lambda integration to track execution latency, basic logs, and the number of invocations. Datadog supports more advanced instrumentation in Rust with [OpenTelementry](https://docs.datadoghq.com/tracing/trace_collection/custom_instrumentation/rust/), but we haven't had time to set this up yet. (It is far easier to set up Datadog's advanced instrumentation with more popular languages such as Node.js.)
28 |
29 | Metrics such as median and P95 invocation latencies are actually quite helpful. For our use case, there is a tradeoff between cold-start times and median invocation latencies (i.e. warm starts). By using Datadog's metrics, we can make more informed decisions about how to manage this tradeoff.
30 |
31 | ---
32 |
33 | Datadog has helped us reduce downtime, understand how our users use our site, and prioritize what features to implement next. Check out our [Public Datadog Dashboard](https://p.datadoghq.com/sb/fbf273aa-1551-11ef-87da-da7ad0900002-1c22ffc7d27083c1529726831826065e) to view some of the key metrics we track!
34 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Mozilla Public License Version 2.0
2 | ==================================
3 |
4 | 1. Definitions
5 | --------------
6 |
7 | 1.1. "Contributor"
8 | means each individual or legal entity that creates, contributes to
9 | the creation of, or owns Covered Software.
10 |
11 | 1.2. "Contributor Version"
12 | means the combination of the Contributions of others (if any) used
13 | by a Contributor and that particular Contributor's Contribution.
14 |
15 | 1.3. "Contribution"
16 | means Covered Software of a particular Contributor.
17 |
18 | 1.4. "Covered Software"
19 | means Source Code Form to which the initial Contributor has attached
20 | the notice in Exhibit A, the Executable Form of such Source Code
21 | Form, and Modifications of such Source Code Form, in each case
22 | including portions thereof.
23 |
24 | 1.5. "Incompatible With Secondary Licenses"
25 | means
26 |
27 | (a) that the initial Contributor has attached the notice described
28 | in Exhibit B to the Covered Software; or
29 |
30 | (b) that the Covered Software was made available under the terms of
31 | version 1.1 or earlier of the License, but not also under the
32 | terms of a Secondary License.
33 |
34 | 1.6. "Executable Form"
35 | means any form of the work other than Source Code Form.
36 |
37 | 1.7. "Larger Work"
38 | means a work that combines Covered Software with other material, in
39 | a separate file or files, that is not Covered Software.
40 |
41 | 1.8. "License"
42 | means this document.
43 |
44 | 1.9. "Licensable"
45 | means having the right to grant, to the maximum extent possible,
46 | whether at the time of the initial grant or subsequently, any and
47 | all of the rights conveyed by this License.
48 |
49 | 1.10. "Modifications"
50 | means any of the following:
51 |
52 | (a) any file in Source Code Form that results from an addition to,
53 | deletion from, or modification of the contents of Covered
54 | Software; or
55 |
56 | (b) any new file in Source Code Form that contains any Covered
57 | Software.
58 |
59 | 1.11. "Patent Claims" of a Contributor
60 | means any patent claim(s), including without limitation, method,
61 | process, and apparatus claims, in any patent Licensable by such
62 | Contributor that would be infringed, but for the grant of the
63 | License, by the making, using, selling, offering for sale, having
64 | made, import, or transfer of either its Contributions or its
65 | Contributor Version.
66 |
67 | 1.12. "Secondary License"
68 | means either the GNU General Public License, Version 2.0, the GNU
69 | Lesser General Public License, Version 2.1, the GNU Affero General
70 | Public License, Version 3.0, or any later versions of those
71 | licenses.
72 |
73 | 1.13. "Source Code Form"
74 | means the form of the work preferred for making modifications.
75 |
76 | 1.14. "You" (or "Your")
77 | means an individual or a legal entity exercising rights under this
78 | License. For legal entities, "You" includes any entity that
79 | controls, is controlled by, or is under common control with You. For
80 | purposes of this definition, "control" means (a) the power, direct
81 | or indirect, to cause the direction or management of such entity,
82 | whether by contract or otherwise, or (b) ownership of more than
83 | fifty percent (50%) of the outstanding shares or beneficial
84 | ownership of such entity.
85 |
86 | 2. License Grants and Conditions
87 | --------------------------------
88 |
89 | 2.1. Grants
90 |
91 | Each Contributor hereby grants You a world-wide, royalty-free,
92 | non-exclusive license:
93 |
94 | (a) under intellectual property rights (other than patent or trademark)
95 | Licensable by such Contributor to use, reproduce, make available,
96 | modify, display, perform, distribute, and otherwise exploit its
97 | Contributions, either on an unmodified basis, with Modifications, or
98 | as part of a Larger Work; and
99 |
100 | (b) under Patent Claims of such Contributor to make, use, sell, offer
101 | for sale, have made, import, and otherwise transfer either its
102 | Contributions or its Contributor Version.
103 |
104 | 2.2. Effective Date
105 |
106 | The licenses granted in Section 2.1 with respect to any Contribution
107 | become effective for each Contribution on the date the Contributor first
108 | distributes such Contribution.
109 |
110 | 2.3. Limitations on Grant Scope
111 |
112 | The licenses granted in this Section 2 are the only rights granted under
113 | this License. No additional rights or licenses will be implied from the
114 | distribution or licensing of Covered Software under this License.
115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a
116 | Contributor:
117 |
118 | (a) for any code that a Contributor has removed from Covered Software;
119 | or
120 |
121 | (b) for infringements caused by: (i) Your and any other third party's
122 | modifications of Covered Software, or (ii) the combination of its
123 | Contributions with other software (except as part of its Contributor
124 | Version); or
125 |
126 | (c) under Patent Claims infringed by Covered Software in the absence of
127 | its Contributions.
128 |
129 | This License does not grant any rights in the trademarks, service marks,
130 | or logos of any Contributor (except as may be necessary to comply with
131 | the notice requirements in Section 3.4).
132 |
133 | 2.4. Subsequent Licenses
134 |
135 | No Contributor makes additional grants as a result of Your choice to
136 | distribute the Covered Software under a subsequent version of this
137 | License (see Section 10.2) or under the terms of a Secondary License (if
138 | permitted under the terms of Section 3.3).
139 |
140 | 2.5. Representation
141 |
142 | Each Contributor represents that the Contributor believes its
143 | Contributions are its original creation(s) or it has sufficient rights
144 | to grant the rights to its Contributions conveyed by this License.
145 |
146 | 2.6. Fair Use
147 |
148 | This License is not intended to limit any rights You have under
149 | applicable copyright doctrines of fair use, fair dealing, or other
150 | equivalents.
151 |
152 | 2.7. Conditions
153 |
154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155 | in Section 2.1.
156 |
157 | 3. Responsibilities
158 | -------------------
159 |
160 | 3.1. Distribution of Source Form
161 |
162 | All distribution of Covered Software in Source Code Form, including any
163 | Modifications that You create or to which You contribute, must be under
164 | the terms of this License. You must inform recipients that the Source
165 | Code Form of the Covered Software is governed by the terms of this
166 | License, and how they can obtain a copy of this License. You may not
167 | attempt to alter or restrict the recipients' rights in the Source Code
168 | Form.
169 |
170 | 3.2. Distribution of Executable Form
171 |
172 | If You distribute Covered Software in Executable Form then:
173 |
174 | (a) such Covered Software must also be made available in Source Code
175 | Form, as described in Section 3.1, and You must inform recipients of
176 | the Executable Form how they can obtain a copy of such Source Code
177 | Form by reasonable means in a timely manner, at a charge no more
178 | than the cost of distribution to the recipient; and
179 |
180 | (b) You may distribute such Executable Form under the terms of this
181 | License, or sublicense it under different terms, provided that the
182 | license for the Executable Form does not attempt to limit or alter
183 | the recipients' rights in the Source Code Form under this License.
184 |
185 | 3.3. Distribution of a Larger Work
186 |
187 | You may create and distribute a Larger Work under terms of Your choice,
188 | provided that You also comply with the requirements of this License for
189 | the Covered Software. If the Larger Work is a combination of Covered
190 | Software with a work governed by one or more Secondary Licenses, and the
191 | Covered Software is not Incompatible With Secondary Licenses, this
192 | License permits You to additionally distribute such Covered Software
193 | under the terms of such Secondary License(s), so that the recipient of
194 | the Larger Work may, at their option, further distribute the Covered
195 | Software under the terms of either this License or such Secondary
196 | License(s).
197 |
198 | 3.4. Notices
199 |
200 | You may not remove or alter the substance of any license notices
201 | (including copyright notices, patent notices, disclaimers of warranty,
202 | or limitations of liability) contained within the Source Code Form of
203 | the Covered Software, except that You may alter any license notices to
204 | the extent required to remedy known factual inaccuracies.
205 |
206 | 3.5. Application of Additional Terms
207 |
208 | You may choose to offer, and to charge a fee for, warranty, support,
209 | indemnity or liability obligations to one or more recipients of Covered
210 | Software. However, You may do so only on Your own behalf, and not on
211 | behalf of any Contributor. You must make it absolutely clear that any
212 | such warranty, support, indemnity, or liability obligation is offered by
213 | You alone, and You hereby agree to indemnify every Contributor for any
214 | liability incurred by such Contributor as a result of warranty, support,
215 | indemnity or liability terms You offer. You may include additional
216 | disclaimers of warranty and limitations of liability specific to any
217 | jurisdiction.
218 |
219 | 4. Inability to Comply Due to Statute or Regulation
220 | ---------------------------------------------------
221 |
222 | If it is impossible for You to comply with any of the terms of this
223 | License with respect to some or all of the Covered Software due to
224 | statute, judicial order, or regulation then You must: (a) comply with
225 | the terms of this License to the maximum extent possible; and (b)
226 | describe the limitations and the code they affect. Such description must
227 | be placed in a text file included with all distributions of the Covered
228 | Software under this License. Except to the extent prohibited by statute
229 | or regulation, such description must be sufficiently detailed for a
230 | recipient of ordinary skill to be able to understand it.
231 |
232 | 5. Termination
233 | --------------
234 |
235 | 5.1. The rights granted under this License will terminate automatically
236 | if You fail to comply with any of its terms. However, if You become
237 | compliant, then the rights granted under this License from a particular
238 | Contributor are reinstated (a) provisionally, unless and until such
239 | Contributor explicitly and finally terminates Your grants, and (b) on an
240 | ongoing basis, if such Contributor fails to notify You of the
241 | non-compliance by some reasonable means prior to 60 days after You have
242 | come back into compliance. Moreover, Your grants from a particular
243 | Contributor are reinstated on an ongoing basis if such Contributor
244 | notifies You of the non-compliance by some reasonable means, this is the
245 | first time You have received notice of non-compliance with this License
246 | from such Contributor, and You become compliant prior to 30 days after
247 | Your receipt of the notice.
248 |
249 | 5.2. If You initiate litigation against any entity by asserting a patent
250 | infringement claim (excluding declaratory judgment actions,
251 | counter-claims, and cross-claims) alleging that a Contributor Version
252 | directly or indirectly infringes any patent, then the rights granted to
253 | You by any and all Contributors for the Covered Software under Section
254 | 2.1 of this License shall terminate.
255 |
256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257 | end user license agreements (excluding distributors and resellers) which
258 | have been validly granted by You or Your distributors under this License
259 | prior to termination shall survive termination.
260 |
261 | ************************************************************************
262 | * *
263 | * 6. Disclaimer of Warranty *
264 | * ------------------------- *
265 | * *
266 | * Covered Software is provided under this License on an "as is" *
267 | * basis, without warranty of any kind, either expressed, implied, or *
268 | * statutory, including, without limitation, warranties that the *
269 | * Covered Software is free of defects, merchantable, fit for a *
270 | * particular purpose or non-infringing. The entire risk as to the *
271 | * quality and performance of the Covered Software is with You. *
272 | * Should any Covered Software prove defective in any respect, You *
273 | * (not any Contributor) assume the cost of any necessary servicing, *
274 | * repair, or correction. This disclaimer of warranty constitutes an *
275 | * essential part of this License. No use of any Covered Software is *
276 | * authorized under this License except under this disclaimer. *
277 | * *
278 | ************************************************************************
279 |
280 | ************************************************************************
281 | * *
282 | * 7. Limitation of Liability *
283 | * -------------------------- *
284 | * *
285 | * Under no circumstances and under no legal theory, whether tort *
286 | * (including negligence), contract, or otherwise, shall any *
287 | * Contributor, or anyone who distributes Covered Software as *
288 | * permitted above, be liable to You for any direct, indirect, *
289 | * special, incidental, or consequential damages of any character *
290 | * including, without limitation, damages for lost profits, loss of *
291 | * goodwill, work stoppage, computer failure or malfunction, or any *
292 | * and all other commercial damages or losses, even if such party *
293 | * shall have been informed of the possibility of such damages. This *
294 | * limitation of liability shall not apply to liability for death or *
295 | * personal injury resulting from such party's negligence to the *
296 | * extent applicable law prohibits such limitation. Some *
297 | * jurisdictions do not allow the exclusion or limitation of *
298 | * incidental or consequential damages, so this exclusion and *
299 | * limitation may not apply to You. *
300 | * *
301 | ************************************************************************
302 |
303 | 8. Litigation
304 | -------------
305 |
306 | Any litigation relating to this License may be brought only in the
307 | courts of a jurisdiction where the defendant maintains its principal
308 | place of business and such litigation shall be governed by laws of that
309 | jurisdiction, without reference to its conflict-of-law provisions.
310 | Nothing in this Section shall prevent a party's ability to bring
311 | cross-claims or counter-claims.
312 |
313 | 9. Miscellaneous
314 | ----------------
315 |
316 | This License represents the complete agreement concerning the subject
317 | matter hereof. If any provision of this License is held to be
318 | unenforceable, such provision shall be reformed only to the extent
319 | necessary to make it enforceable. Any law or regulation which provides
320 | that the language of a contract shall be construed against the drafter
321 | shall not be used to construe this License against a Contributor.
322 |
323 | 10. Versions of the License
324 | ---------------------------
325 |
326 | 10.1. New Versions
327 |
328 | Mozilla Foundation is the license steward. Except as provided in Section
329 | 10.3, no one other than the license steward has the right to modify or
330 | publish new versions of this License. Each version will be given a
331 | distinguishing version number.
332 |
333 | 10.2. Effect of New Versions
334 |
335 | You may distribute the Covered Software under the terms of the version
336 | of the License under which You originally received the Covered Software,
337 | or under the terms of any subsequent version published by the license
338 | steward.
339 |
340 | 10.3. Modified Versions
341 |
342 | If you create software not governed by this License, and you want to
343 | create a new license for such software, you may create and use a
344 | modified version of this License if you rename the license and remove
345 | any references to the name of the license steward (except to note that
346 | such modified license differs from this License).
347 |
348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary
349 | Licenses
350 |
351 | If You choose to distribute Source Code Form that is Incompatible With
352 | Secondary Licenses under the terms of this version of the License, the
353 | notice described in Exhibit B of this License must be attached.
354 |
355 | Exhibit A - Source Code Form License Notice
356 | -------------------------------------------
357 |
358 | This Source Code Form is subject to the terms of the Mozilla Public
359 | License, v. 2.0. If a copy of the MPL was not distributed with this
360 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
361 |
362 | If it is not possible or desirable to put the notice in a particular
363 | file, then You may include the notice in a location (such as a LICENSE
364 | file in a relevant directory) where a recipient would be likely to look
365 | for such a notice.
366 |
367 | You may add additional accurate notices of copyright ownership.
368 |
369 | Exhibit B - "Incompatible With Secondary Licenses" Notice
370 | ---------------------------------------------------------
371 |
372 | This Source Code Form is "Incompatible With Secondary Licenses", as
373 | defined by the Mozilla Public License, v. 2.0.
374 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Realtime Collaborative IDE
2 |
3 | A realtime collaborative IDE with code execution, intellisense, and built-in USACO submissions. Designed primarily for Competitive Programming and USACO, with mobile support for coding on the go.
4 |
5 | This IDE is built and maintained by [Nathan Wang](https://github.com/thecodingwizard) and [Benjamin Qi](https://github.com/bqi343/), and is part of the [Competitive Programming Initiative](https://joincpi.org/).
6 |
7 | ## Running Locally
8 |
9 | This project uses the [Firebase Realtime Database](https://firebase.google.com/docs/database). [This tutorial](https://firebase.google.com/codelabs/firestore-web) is helpful (even though Cloud Firestore is not what's being used here). You'll need to install the [firebase CLI](https://firebase.google.com/docs/cli#install_the_firebase_cli) and Node.js 18.
10 |
11 | ```
12 | npm install
13 | npm run dev
14 | ```
15 |
16 | `npm run dev` will start a Firebase emulator for you. By default, the dev server uses a local firebase emulator and the production YJS server.
17 |
18 | If you want to use the production Firebase server, run `npx vite dev` instead. Note that creating new files will not work.
19 |
20 | If you want to use the local YJS server, modify the `.env` file.
21 |
22 | Note: If you get a firebase emulators timeout error on Mac, see [firebase/firebase-tools#2379 (comment)](https://github.com/firebase/firebase-tools/issues/2379#issuecomment-951884721) and Issue #67 in this repo.
23 |
24 | ### Playwright Tests
25 |
26 | TODO: Update this outdated section
27 |
28 | ```
29 | npm run dev # Start the dev server in a separate terminal
30 | npm run test
31 | ```
32 |
33 | We use Playwright for our e2e tests. The VSCode extension for Playwright can be useful for debugging tests.
34 |
35 | Note: If you are using the production YJS servers, the Copy Files test will fail because the `YJS_SECURITY_KEY` environment variable needs to be set. For local development, feel free to ignore the Copy Files CI test. Alternatively, you can run a local YJS server (see the `ide-yjs` repository) and use that instead.
36 |
37 | ### Configuring Firebase
38 |
39 | You can update the Firebase configuration (if you want to use a custom firebase project, for example) by modifying `src/lib/firebase/firebase.svelte`.
40 |
41 | ## Tech Stack
42 |
43 | - Code execution through a custom [Serverless Online Judge](https://github.com/cpinitiative/online-judge-rust)
44 | - Realtime collaboration with [YJS](https://github.com/yjs/yjs)
45 | - Codingame's VSCode / Monaco Editor (desktop)
46 | - Codemirror 6 Editor (mobile)
47 | - Code intellisense with [LSP servers running on Modal](https://github.com/cpinitiative/ide-lsp-modal)
48 | - Svelte 5 and SvelteKit
49 | - Tailwind CSS 4
50 | - Firebase Realtime Database
51 | - Playwright for end-to-end testing
52 |
53 | Infrastructure monitoring is generously provided by Datadog's OSS program.
54 |
55 |
56 |
57 | ## Updating VSCode
58 |
59 | We use TypeFox's monaco-langaugeclient, which internally uses codingame's monaco-vscode packages. To update monaco-languageclient:
60 |
61 | 1. Consult the [Changelog](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/wrapper/CHANGELOG.md)
62 | 2. Test that the language client still works, and that the EOL patch still works.
63 |
64 | ## Contact Info
65 |
66 | If you have any questions, please open an issue or reach out to us at usacoguide@gmail.com.
67 |
68 | ## Misc Notes
69 |
70 | ### VSCode + YJS EOL Browser Incompatibility
71 |
72 | See https://github.com/yjs/y-monaco/issues/6 for steps to reproduce the issue.
73 |
74 | To fix, replace something similar to
75 |
76 | ```javascript
77 | var n = this.configurationService.getValue('files.eol', {
78 | overrideIdentifier: t,
79 | resource: e,
80 | });
81 | return n && 'auto' !== n ? n : d.isLinux || d.isMacintosh ? '\n' : '\r\n';
82 | ```
83 |
84 | with
85 |
86 | ```javascript
87 | var n = this.configurationService.getValue('files.eol', {
88 | overrideIdentifier: t,
89 | resource: e,
90 | });
91 | return n && 'auto' !== n ? n : d.isLinux || d.isMacintosh ? '\n' : '\n';
92 | ```
93 |
94 | using `package-patch`. You can use `grep -r "this.configurationService.getValue('files.eol'" node_modules/ -l` to find relevant files to patch.
95 |
96 | ### Troubleshooting `firebase emulators:exec`
97 |
98 | If `firebase emulators:exec` fails for unknown reason, try running `firebase emulators:exec "yarn playwright test" || cat firebase-debug.log`.
99 |
100 | ### Tests that should be written
101 |
102 | - Compile error, stdout, stderr
103 | - Too large input
104 | - Too large output
105 | - Classrooms
106 | - Copying files (#64, this broke already lol)
107 |
--------------------------------------------------------------------------------
/database.rules.json:
--------------------------------------------------------------------------------
1 | {
2 | "rules": {
3 | "users": {
4 | "$secretid": {
5 | ".read": "$secretid == auth.uid",
6 | ".write": "auth.uid == $secretid"
7 | }
8 | },
9 | "files": {
10 | "$secretid": {
11 | ".write": true,
12 | ".read": true,
13 | "users": {
14 | ".read": "root.child('files').child($secretid).child('settings').child('defaultPermission').val() !== 'PRIVATE' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'OWNER' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'READ_WRITE' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'READ'",
15 | "$user": {
16 | ".read": "$user === auth.uid",
17 | ".write": "(auth.uid === $user && !root.child('files').child($secretid).child('settings').child('users').exists()) || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'OWNER' || (auth.uid === $user && data.child('permission').val() === newData.child('permission').val())"
18 | }
19 | },
20 |
21 | "settings": {
22 | ".read": true,
23 | "$setting": {
24 | ".write": "!root.child('files').child($secretid).child('settings').child('defaultPermission').exists() || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'OWNER' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'READ_WRITE'"
25 | },
26 | "defaultPermission": {
27 | ".write": "!root.child('files').child($secretid).child('settings').child('defaultPermission').exists() || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'OWNER'"
28 | },
29 | "creationTime": {
30 | /* only write upon creation */
31 | ".write": "!root.child('files').child($secretid).child('settings').child('creationTime').exists()"
32 | }
33 | },
34 |
35 | "chat": {
36 | ".read": "root.child('files').child($secretid).child('settings').child('defaultPermission').val() !== 'PRIVATE' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'OWNER' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'READ_WRITE' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'READ'",
37 | ".write": "root.child('files').child($secretid).child('settings').child('defaultPermission').val() === 'READ_WRITE' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'OWNER' || root.child('files').child($secretid).child('users').child(auth.uid).child('permission').val() === 'READ_WRITE'"
38 | }
39 | }
40 | },
41 | ".read": false,
42 | ".write": false
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/e2e/demo.test.ts:
--------------------------------------------------------------------------------
1 | import { expect, test } from '@playwright/test';
2 |
3 | test('home page has expected h1', async ({ page }) => {
4 | await page.goto('/');
5 | await expect(page.locator('h1')).toBeVisible();
6 | });
7 |
--------------------------------------------------------------------------------
/eslint.config.js:
--------------------------------------------------------------------------------
1 | import prettier from 'eslint-config-prettier';
2 | import js from '@eslint/js';
3 | import { includeIgnoreFile } from '@eslint/compat';
4 | import svelte from 'eslint-plugin-svelte';
5 | import globals from 'globals';
6 | import { fileURLToPath } from 'node:url';
7 | import ts from 'typescript-eslint';
8 | const gitignorePath = fileURLToPath(new URL('./.gitignore', import.meta.url));
9 |
10 | export default ts.config(
11 | includeIgnoreFile(gitignorePath),
12 | js.configs.recommended,
13 | ...ts.configs.recommended,
14 | ...svelte.configs['flat/recommended'],
15 | prettier,
16 | ...svelte.configs['flat/prettier'],
17 | {
18 | languageOptions: {
19 | globals: {
20 | ...globals.browser,
21 | ...globals.node
22 | }
23 | }
24 | },
25 | {
26 | files: ['**/*.svelte'],
27 |
28 | languageOptions: {
29 | parserOptions: {
30 | parser: ts.parser
31 | }
32 | }
33 | }
34 | );
35 |
--------------------------------------------------------------------------------
/firebase.json:
--------------------------------------------------------------------------------
1 | {
2 | "database": {
3 | "rules": "database.rules.json"
4 | },
5 | "emulators": {
6 | "auth": {
7 | "port": 9099
8 | },
9 | "database": {
10 | "port": 9000
11 | },
12 | "ui": {
13 | "enabled": true
14 | }
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "ide-svelte",
3 | "private": true,
4 | "version": "0.0.1",
5 | "type": "module",
6 | "scripts": {
7 | "dev": "cross-env PUBLIC_USE_FIREBASE_EMULATORS=true FIREBASE_AUTH_EMULATOR_HOST=\"127.0.0.1:9099\" concurrently -k \"firebase emulators:start\" \"vite dev\"",
8 | "build": "vite build",
9 | "preview": "vite preview",
10 | "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
11 | "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
12 | "format": "prettier --write .",
13 | "lint": "prettier --check . && eslint .",
14 | "test:e2e": "playwright test",
15 | "test": "npm run test:e2e",
16 | "postinstall": "patch-package",
17 | "emulators:stop": "lsof -t -i:8080 -i:9000 -i:9099 -i:9199 -i:9090 | xargs kill -9"
18 | },
19 | "devDependencies": {
20 | "@eslint/compat": "^1.2.3",
21 | "@melt-ui/pp": "^0.3.2",
22 | "@melt-ui/svelte": "^0.86.2",
23 | "@playwright/test": "^1.45.3",
24 | "@sveltejs/adapter-vercel": "^5.5.0",
25 | "@sveltejs/kit": "^2.0.0",
26 | "@sveltejs/vite-plugin-svelte": "^4.0.0",
27 | "@types/vscode": "^1.96.0",
28 | "autoprefixer": "^10.4.20",
29 | "concurrently": "^9.1.2",
30 | "cross-env": "^7.0.3",
31 | "eslint": "^9.7.0",
32 | "eslint-config-prettier": "^9.1.0",
33 | "eslint-plugin-svelte": "^2.36.0",
34 | "globals": "^15.0.0",
35 | "patch-package": "^8.0.0",
36 | "prettier": "^3.3.2",
37 | "prettier-plugin-svelte": "^3.2.6",
38 | "prettier-plugin-tailwindcss": "^0.6.5",
39 | "svelte": "^5.20.0",
40 | "svelte-check": "^4.0.0",
41 | "tailwindcss": "^4.0.0",
42 | "typescript": "^5.0.0",
43 | "typescript-eslint": "^8.0.0",
44 | "vite": "^5.4.11"
45 | },
46 | "dependencies": {
47 | "@babel/runtime": "^7.26.0",
48 | "@codemirror/lang-cpp": "^6.0.2",
49 | "@codemirror/lang-java": "^6.0.1",
50 | "@codemirror/lang-python": "^6.1.7",
51 | "@codingame/esbuild-import-meta-url-plugin": "^1.0.2",
52 | "@codingame/monaco-vscode-configuration-service-override": "^11.1.2",
53 | "@codingame/monaco-vscode-cpp-default-extension": "^11.1.2",
54 | "@codingame/monaco-vscode-files-service-override": "^11.1.2",
55 | "@codingame/monaco-vscode-java-default-extension": "^11.1.2",
56 | "@codingame/monaco-vscode-keybindings-service-override": "^11.1.2",
57 | "@codingame/monaco-vscode-python-default-extension": "^11.1.2",
58 | "@codingame/monaco-vscode-rollup-vsix-plugin": "^11.1.2",
59 | "@codingame/monaco-vscode-storage-service-override": "^11.1.2",
60 | "@codingame/monaco-vscode-theme-defaults-default-extension": "^11.1.2",
61 | "@codingame/monaco-vscode-view-status-bar-service-override": "^11.1.2",
62 | "@replit/codemirror-vim": "^6.2.1",
63 | "@tailwindcss/forms": "^0.5.9",
64 | "@tailwindcss/typography": "^0.5.15",
65 | "@tailwindcss/vite": "^4.0.3",
66 | "@uiw/codemirror-theme-github": "^4.23.7",
67 | "@uiw/codemirror-theme-vscode": "^4.23.7",
68 | "codemirror": "^6.0.1",
69 | "dayjs": "^1.11.13",
70 | "firebase": "^11.1.0",
71 | "firebase-admin": "^13.0.2",
72 | "lucide-svelte": "^0.471.0",
73 | "monaco-editor-wrapper": "^6.1.0",
74 | "split-grid": "^1.0.11",
75 | "sse.js": "^2.5.0",
76 | "y-codemirror.next": "^0.3.5",
77 | "y-monaco": "^0.1.6",
78 | "y-protocols": "^1.0.6",
79 | "y-websocket": "^2.1.0",
80 | "yjs": "^13.6.21"
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/patches/@codingame+monaco-vscode-api+11.1.2.patch:
--------------------------------------------------------------------------------
1 | diff --git a/node_modules/@codingame/monaco-vscode-api/vscode/src/vs/editor/standalone/browser/standaloneServices.js b/node_modules/@codingame/monaco-vscode-api/vscode/src/vs/editor/standalone/browser/standaloneServices.js
2 | index e344741..86c9167 100644
3 | --- a/node_modules/@codingame/monaco-vscode-api/vscode/src/vs/editor/standalone/browser/standaloneServices.js
4 | +++ b/node_modules/@codingame/monaco-vscode-api/vscode/src/vs/editor/standalone/browser/standaloneServices.js
5 | @@ -642,7 +642,7 @@ let StandaloneResourcePropertiesService = class StandaloneResourcePropertiesServ
6 | if (eol && typeof eol === 'string' && eol !== 'auto') {
7 | return eol;
8 | }
9 | - return (isLinux || isMacintosh) ? '\n' : '\r\n';
10 | + return (isLinux || isMacintosh) ? '\n' : '\n';
11 | }
12 | };
13 | StandaloneResourcePropertiesService = ( __decorate([
14 |
--------------------------------------------------------------------------------
/patches/@codingame+monaco-vscode-configuration-service-override+11.1.2.patch:
--------------------------------------------------------------------------------
1 | diff --git a/node_modules/@codingame/monaco-vscode-configuration-service-override/vscode/src/vs/workbench/services/textresourceProperties/common/textResourcePropertiesService.js b/node_modules/@codingame/monaco-vscode-configuration-service-override/vscode/src/vs/workbench/services/textresourceProperties/common/textResourcePropertiesService.js
2 | index db9440a..331f3be 100644
3 | --- a/node_modules/@codingame/monaco-vscode-configuration-service-override/vscode/src/vs/workbench/services/textresourceProperties/common/textResourcePropertiesService.js
4 | +++ b/node_modules/@codingame/monaco-vscode-configuration-service-override/vscode/src/vs/workbench/services/textresourceProperties/common/textResourcePropertiesService.js
5 | @@ -21,7 +21,7 @@ let TextResourcePropertiesService = class TextResourcePropertiesService {
6 | return eol;
7 | }
8 | const os = this.getOS(resource);
9 | - return os === 3 || os === 2 ? '\n' : '\r\n';
10 | + return os === 3 || os === 2 ? '\n' : '\n';
11 | }
12 | getOS(resource) {
13 | let os = OS;
14 |
--------------------------------------------------------------------------------
/patches/vscode+11.1.2.patch:
--------------------------------------------------------------------------------
1 | diff --git a/node_modules/vscode/vscode/src/vs/editor/standalone/browser/standaloneServices.js b/node_modules/vscode/vscode/src/vs/editor/standalone/browser/standaloneServices.js
2 | index e344741..4a5a2a2 100644
3 | --- a/node_modules/vscode/vscode/src/vs/editor/standalone/browser/standaloneServices.js
4 | +++ b/node_modules/vscode/vscode/src/vs/editor/standalone/browser/standaloneServices.js
5 | @@ -642,7 +642,7 @@ let StandaloneResourcePropertiesService = class StandaloneResourcePropertiesServ
6 | if (eol && typeof eol === 'string' && eol !== 'auto') {
7 | return eol;
8 | }
9 | - return (isLinux || isMacintosh) ? '\n' : '\r\n';
10 | + return (isLinux || isMacintosh) ? '\n' : '\n';
11 | }
12 | };
13 | StandaloneResourcePropertiesService = ( __decorate([
14 |
--------------------------------------------------------------------------------
/playwright.config.ts:
--------------------------------------------------------------------------------
1 | import { defineConfig } from '@playwright/test';
2 |
3 | export default defineConfig({
4 | webServer: {
5 | command: 'npm run build && npm run preview',
6 | port: 4173
7 | },
8 |
9 | testDir: 'e2e'
10 | });
11 |
--------------------------------------------------------------------------------
/src/app.css:
--------------------------------------------------------------------------------
1 | @import 'tailwindcss';
2 | @custom-variant dark (&:where([data-theme=dark], [data-theme=dark] *));
3 |
4 | @plugin "@tailwindcss/forms";
5 | @plugin "@tailwindcss/typography";
6 |
7 | @theme {
8 | --color-monaco-editor-bg: #1e1e1e;
9 | }
10 |
11 | body {
12 | /* Matches the color of monaco-editor */
13 | /* background-color: var(--color-monaco-editor-bg); */
14 |
15 | @apply bg-white text-gray-100 dark:bg-[var(--color-monaco-editor-bg)];
16 | }
17 |
18 | /* Styles for remote cursors for monaco */
19 | .yRemoteSelection {
20 | /* background-color: rgb(250, 129, 0, 0.5); */
21 | background-color: var(--yjs-selection-color-bg, rgb(250, 129, 0, 0.5));
22 | }
23 | .yRemoteSelectionHead {
24 | position: absolute;
25 | border-left: var(--yjs-selection-color, orange) solid 2px;
26 | border-top: var(--yjs-selection-color, orange) solid 2px;
27 | border-bottom: var(--yjs-selection-color, orange) solid 2px;
28 | height: 100%;
29 | box-sizing: border-box;
30 | }
31 | .yRemoteSelectionHead::after {
32 | position: absolute;
33 | content: ' ';
34 | border: 3px solid var(--yjs-selection-color, orange);
35 | border-radius: 4px;
36 | left: -4px;
37 | top: -5px;
38 | }
39 |
40 | button {
41 | @apply cursor-pointer;
42 | }
43 |
44 | .firebase-emulator-warning {
45 | display: none;
46 | }
47 |
--------------------------------------------------------------------------------
/src/app.d.ts:
--------------------------------------------------------------------------------
1 | // See https://svelte.dev/docs/kit/types#app.d.ts
2 | // for information about these interfaces
3 | declare global {
4 | namespace App {
5 | // interface Error {}
6 | // interface Locals {}
7 | // interface PageData {}
8 | // interface PageState {}
9 | // interface Platform {}
10 | }
11 | }
12 |
13 | export {};
14 |
--------------------------------------------------------------------------------
/src/app.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
63 | Your local data will be overwritten by your server data. Are you sure you want to 64 | proceed? 65 |
66 |43 | 49 | {problem.source} 50 | 51 |
52 |53 | 54 | {problem.title} 55 | 56 |
57 |58 | I/O: 59 | {problem.input}/{problem.output} 60 | {#if problem.input.includes('.in')} 61 | ("Run Samples" supports both file I/O and stdin/stdout) 62 | {/if} 63 |
64 |65 | The Online Judge is in early beta. Not all problems are supported. Timing and correctness 66 | information may not be perfectly accurate. Report issues here. 72 |
73 | 83 |Error: {errorMessage}
86 | {/if} 87 | {#if results} 88 |45 | Infrastructure monitoring powered by Datadog. View our 46 | 51 | Dashboard 52 | 53 | or learn more about 54 | 59 | how we use Datadog 60 | ! 61 |
62 |0 && 'px-2', 45 | 'py-3.5 text-left text-sm font-semibold text-black dark:text-gray-100' 46 | ]} 47 | > 48 | {col} 49 | | 50 | {/each} 51 |52 | Actions 53 | | 54 ||||
---|---|---|---|---|
60 | {#if file.hidden} 61 | 62 | {file.title || '(Unnamed File)'} (Hidden) 63 | 64 | {:else} 65 | 69 | {file.title || '(Unnamed File)'} 70 | 71 | {/if} 72 | | 73 |74 | {formatCreationTime(file.lastAccessTime)} 75 | | 76 |77 | {file.creationTime ? formatCreationTime(file.creationTime) : 'Unknown'} 78 | | 79 |80 | {file.language ? formatLanguage(file.language) : 'Unknown'} 81 | | 82 |85 | 91 | | 92 |