Skip to content

Commit c269044

Browse files
authored
Merge pull request #86 from guanquann/code-execution
Code execution + code template
2 parents 345851a + a45869b commit c269044

26 files changed

+7888
-21
lines changed

.github/workflows/ci.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,13 @@ jobs:
3434
strategy:
3535
matrix:
3636
service:
37-
[question-service, user-service, matching-service, collab-service]
37+
[
38+
question-service,
39+
user-service,
40+
matching-service,
41+
collab-service,
42+
code-execution-service,
43+
]
3844
steps:
3945
- name: Checkout code
4046
uses: actions/checkout@v4
@@ -55,4 +61,5 @@ jobs:
5561
FIREBASE_CLIENT_EMAIL: ${{ secrets.FIREBASE_CLIENT_EMAIL }}
5662
FIREBASE_STORAGE_BUCKET: ${{ secrets.FIREBASE_STORAGE_BUCKET }}
5763
JWT_SECRET: ${{ secrets.JWT_SECRET }}
64+
ONE_COMPILER_KEY: ${{ secrets.ONE_COMPILER_KEY }}
5865
run: docker compose -f docker-compose-test.yml run --rm test-${{ matrix.service }}

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,6 @@ docker-compose down
2929
- User Service: http://localhost:3001
3030
- Question Service: http://localhost:3000
3131
- Matching Service: http://localhost:3002
32+
- Collab Service: http://localhost:3003
33+
- Code Execution Service: http://localhost:3004
3234
- Frontend: http://localhost:5173
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
coverage
2+
node_modules
3+
tests
4+
.env*
5+
*.md
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
NODE_ENV=development
2+
SERVICE_PORT=3004
3+
4+
ORIGINS=http://localhost:5173,http://127.0.0.1:5173
5+
6+
# One Compiler
7+
ONE_COMPILER_URL=https://onecompiler-apis.p.rapidapi.com/api/v1/run
8+
ONE_COMPILER_KEY=<ONE_COMPILER_KEY>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
FROM node:20-alpine
2+
3+
WORKDIR /code-execution-service
4+
5+
COPY package*.json .
6+
7+
RUN npm ci
8+
9+
COPY . .
10+
11+
EXPOSE 3004
12+
13+
CMD ["npm", "run", "dev"]
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Code Execution Service Guide
2+
3+
## Setting-up Code Execution Service
4+
5+
1. In the `code-execution-service` directory, create a copy of the `.env.sample` file and name it `.env`.
6+
7+
2. Sign up for a free OneCompiler API [here](https://rapidapi.com/onecompiler-onecompiler-default/api/onecompiler-apis).
8+
9+
3. Update `ONE_COMPILER_KEY` in `.env` with the the value of `x-rapidapi-key`.
10+
11+
## Running Code Execution Service without Docker
12+
13+
1. Open Command Line/Terminal and navigate into the `code-execution-service` directory.
14+
15+
2. Run the command: `npm install`. This will install all the necessary dependencies.
16+
17+
3. Run the command `npm start` to start the Code Execution Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
18+
19+
## After running
20+
21+
1. To view Code Execution Service documentation, go to http://localhost:3004/docs.
22+
23+
2. Using applications like Postman, you can interact with the Code Execution Service on port 3004. If you wish to change this, please update the `.env` file.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
import express, { Request, Response } from "express";
2+
import dotenv from "dotenv";
3+
import fs from "fs";
4+
import yaml from "yaml";
5+
import swaggerUi from "swagger-ui-express";
6+
import cors from "cors";
7+
8+
import codeExecutionRoutes from "./src/routes/codeExecutionRoutes.ts";
9+
10+
dotenv.config();
11+
12+
const allowedOrigins = process.env.ORIGINS
13+
? process.env.ORIGINS.split(",")
14+
: ["http://localhost:5173", "http://127.0.0.1:5173"];
15+
16+
const file = fs.readFileSync("./swagger.yml", "utf-8");
17+
const swaggerDocument = yaml.parse(file);
18+
19+
const app = express();
20+
21+
app.use(cors({ origin: allowedOrigins, credentials: true }));
22+
23+
app.options("*", cors({ origin: allowedOrigins, credentials: true }));
24+
25+
app.use(express.json());
26+
27+
app.use("/api/run", codeExecutionRoutes);
28+
29+
app.use("/docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
30+
31+
app.get("/", (req: Request, res: Response) => {
32+
res.status(200).json({ message: "Hello world from code execution service" });
33+
});
34+
35+
export default app;
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import globals from "globals";
2+
import pluginJs from "@eslint/js";
3+
import tseslint from "typescript-eslint";
4+
5+
export default [
6+
{ files: ["**/*.{js,mjs,cjs,ts}"] },
7+
{ languageOptions: { globals: globals.node } },
8+
pluginJs.configs.recommended,
9+
...tseslint.configs.recommended,
10+
];
Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
/**
2+
* For a detailed explanation regarding each configuration property, visit:
3+
* https://jestjs.io/docs/configuration
4+
*/
5+
6+
import type { Config } from "jest";
7+
8+
const config: Config = {
9+
// All imported modules in your tests should be mocked automatically
10+
// automock: false,
11+
12+
// Stop running tests after `n` failures
13+
// bail: 0,
14+
15+
// The directory where Jest should store its cached dependency information
16+
// cacheDirectory: "/private/var/folders/04/ng4c26hj1ksdsy_7x_21kvx80000gn/T/jest_dx",
17+
18+
// Automatically clear mock calls, instances, contexts and results before every test
19+
clearMocks: true,
20+
21+
// Indicates whether the coverage information should be collected while executing the test
22+
collectCoverage: true,
23+
24+
// An array of glob patterns indicating a set of files for which coverage information should be collected
25+
// collectCoverageFrom: undefined,
26+
27+
// The directory where Jest should output its coverage files
28+
coverageDirectory: "coverage",
29+
30+
// An array of regexp pattern strings used to skip coverage collection
31+
// coveragePathIgnorePatterns: [
32+
// "/node_modules/"
33+
// ],
34+
35+
// Indicates which provider should be used to instrument code for coverage
36+
coverageProvider: "v8",
37+
38+
// A list of reporter names that Jest uses when writing coverage reports
39+
// coverageReporters: [
40+
// "json",
41+
// "text",
42+
// "lcov",
43+
// "clover"
44+
// ],
45+
46+
// An object that configures minimum threshold enforcement for coverage results
47+
// coverageThreshold: undefined,
48+
49+
// A path to a custom dependency extractor
50+
// dependencyExtractor: undefined,
51+
52+
// Make calling deprecated APIs throw helpful error messages
53+
// errorOnDeprecated: false,
54+
55+
// The default configuration for fake timers
56+
// fakeTimers: {
57+
// "enableGlobally": false
58+
// },
59+
60+
// Force coverage collection from ignored files using an array of glob patterns
61+
// forceCoverageMatch: [],
62+
63+
// A path to a module which exports an async function that is triggered once before all test suites
64+
// globalSetup: undefined,
65+
66+
// A path to a module which exports an async function that is triggered once after all test suites
67+
// globalTeardown: undefined,
68+
69+
// A set of global variables that need to be available in all test environments
70+
// globals: {},
71+
72+
// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
73+
// maxWorkers: "50%",
74+
75+
// An array of directory names to be searched recursively up from the requiring module's location
76+
// moduleDirectories: [
77+
// "node_modules"
78+
// ],
79+
80+
// An array of file extensions your modules use
81+
// moduleFileExtensions: [
82+
// "js",
83+
// "mjs",
84+
// "cjs",
85+
// "jsx",
86+
// "ts",
87+
// "tsx",
88+
// "json",
89+
// "node"
90+
// ],
91+
92+
// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
93+
// moduleNameMapper: {},
94+
95+
// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
96+
// modulePathIgnorePatterns: [],
97+
98+
// Activates notifications for test results
99+
// notify: false,
100+
101+
// An enum that specifies notification mode. Requires { notify: true }
102+
// notifyMode: "failure-change",
103+
104+
// A preset that is used as a base for Jest's configuration
105+
preset: "ts-jest",
106+
107+
// Run tests from one or more projects
108+
// projects: undefined,
109+
110+
// Use this configuration option to add custom reporters to Jest
111+
// reporters: undefined,
112+
113+
// Automatically reset mock state before every test
114+
// resetMocks: false,
115+
116+
// Reset the module registry before running each individual test
117+
// resetModules: false,
118+
119+
// A path to a custom resolver
120+
// resolver: undefined,
121+
122+
// Automatically restore mock state and implementation before every test
123+
// restoreMocks: false,
124+
125+
// The root directory that Jest should scan for tests and modules within
126+
// rootDir: undefined,
127+
128+
// A list of paths to directories that Jest should use to search for files in
129+
// roots: [
130+
// "<rootDir>"
131+
// ],
132+
133+
// Allows you to use a custom runner instead of Jest's default test runner
134+
// runner: "jest-runner",
135+
136+
// The paths to modules that run some code to configure or set up the testing environment before each test
137+
// setupFiles: [],
138+
139+
// A list of paths to modules that run some code to configure or set up the testing framework before each test
140+
// setupFilesAfterEnv: [],
141+
142+
// The number of seconds after which a test is considered as slow and reported as such in the results.
143+
// slowTestThreshold: 5,
144+
145+
// A list of paths to snapshot serializer modules Jest should use for snapshot testing
146+
// snapshotSerializers: [],
147+
148+
// The test environment that will be used for testing
149+
// testEnvironment: "jest-environment-node",
150+
151+
// Options that will be passed to the testEnvironment
152+
// testEnvironmentOptions: {},
153+
154+
// Adds a location field to test results
155+
// testLocationInResults: false,
156+
157+
// The glob patterns Jest uses to detect test files
158+
// testMatch: [
159+
// "**/__tests__/**/*.[jt]s?(x)",
160+
// "**/?(*.)+(spec|test).[tj]s?(x)"
161+
// ],
162+
163+
// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
164+
// testPathIgnorePatterns: [
165+
// "/node_modules/"
166+
// ],
167+
168+
// The regexp pattern or array of patterns that Jest uses to detect test files
169+
// testRegex: [],
170+
171+
// This option allows the use of a custom results processor
172+
// testResultsProcessor: undefined,
173+
174+
// This option allows use of a custom test runner
175+
// testRunner: "jest-circus/runner",
176+
177+
// A map from regular expressions to paths to transformers
178+
// transform: undefined,
179+
180+
// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
181+
// transformIgnorePatterns: [
182+
// "/node_modules/",
183+
// "\\.pnp\\.[^\\/]+$"
184+
// ],
185+
186+
// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
187+
// unmockedModulePathPatterns: undefined,
188+
189+
// Indicates whether each individual test should be reported during the run
190+
// verbose: undefined,
191+
192+
// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
193+
// watchPathIgnorePatterns: [],
194+
195+
// Whether to use watchman for file crawling
196+
// watchman: true,
197+
};
198+
199+
export default config;

0 commit comments

Comments
 (0)