Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
NEXT_PUBLIC_API_URL=http://localhost:8080
# Optional: gateway address used by the Next.js server (defaults to NEXT_PUBLIC_API_URL)
# PLAYGROUND_API_INTERNAL_URL=http://gateway:8080
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ NEXT_PUBLIC_API_URL=http://localhost:8080
| 변수 | 설명 |
|------|------|
| `NEXT_PUBLIC_API_URL` | Connect Gateway 의 origin. 빌드 시점에 번들에 들어가며, CSP `connect-src` 에도 이 origin 만 허용됩니다 |
| `PLAYGROUND_API_INTERNAL_URL` | (선택) Next.js 서버가 첫 화면용 언어 목록을 가져올 때 쓰는 Gateway 주소. 컨테이너 내부 주소처럼 브라우저와 다른 경로로 닿을 때 지정합니다. 없으면 `NEXT_PUBLIC_API_URL` 을 씁니다. 실행 시점에 읽습니다 |
| `NEXT_PUBLIC_RPC_FAKE` | `1` 이면 **개발 서버(`npm run dev`)에서만** 백엔드 대신 가짜 RPC 전송(`src/lib/rpc/fake.ts`)을 씁니다. 프로덕션 빌드에서는 켤 수 없습니다 (아래 참고) |

### 백엔드 없이 UI 작업하기 (가짜 RPC 전송)
Expand Down
572 changes: 572 additions & 0 deletions src/app/[locale]/PlaygroundClient.tsx

Large diffs are not rendered by default.

579 changes: 15 additions & 564 deletions src/app/[locale]/page.tsx

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions src/features/editor/__tests__/useLanguages.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,25 @@ describe('useLanguages', () => {
expect(result.current.code).toBe('print(1)');
});
});

describe('useLanguages with server-rendered languages', () => {
const languages = [create(LanguageSchema, { id: 'python' }), create(LanguageSchema, { id: 'kingsejong', defaultTemplateId: 'hello_world' })];

it('starts ready with the server data and sends no request', async () => {
const listLanguages = vi.fn(() => ({ languages: [] }));
const { wrapper } = rpcWrapper(({ service }) => service(LanguageService, { listLanguages } as never));
const initial = { languages, starter: { languageId: 'kingsejong', entryFile: 'main.ksj', files: [{ path: 'main.ksj', content: '출력("서버")' }] } };
const { result } = renderHook(() => useLanguages(initial), { wrapper });
expect(result.current.loading).toBe(false);
expect(result.current.selectedLanguage).toBe('kingsejong');
expect(result.current.code).toBe('출력("서버")');
await act(async () => {});
expect(listLanguages).not.toHaveBeenCalled();
});

it('uses the built-in sample when the starter is missing', () => {
const { wrapper } = rpcWrapper(() => {});
const { result } = renderHook(() => useLanguages({ languages }), { wrapper });
expect(result.current.code).toContain('출력(');
});
});
24 changes: 24 additions & 0 deletions src/features/editor/language-defaults.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* Which language a new visitor starts with and which template seeds it.
* Free of React so server components can use it too.
*/
import type { Language } from '@kingsejong-lang/playground-proto';

/** Template id used when a language does not name its own default template. */
export const FALLBACK_TEMPLATE_ID = 'hello_world';

/** Preferred default language ids, in order (new contract id first, then the legacy id). */
export const PREFERRED_DEFAULTS = ['kingsejong', 'kingsejong_v0_3'];

export function pickDefaultLanguage(langs: readonly Language[]): Language | undefined {
for (const id of PREFERRED_DEFAULTS) {
const found = langs.find((l) => l.id === id);
if (found) return found;
}
return langs.find((l) => l.id.startsWith('kingsejong')) ?? langs[0];
}

/** The template that seeds a new editor for this language. */
export function defaultTemplateId(language: Pick<Language, 'defaultTemplateId'> | undefined): string {
return language?.defaultTemplateId || FALLBACK_TEMPLATE_ID;
}
2 changes: 1 addition & 1 deletion src/features/editor/templates.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import type { SourceFile } from '@kingsejong-lang/playground-proto';

/** Content of the entry file if named, else of the first file, else "". */
export function firstFileContent(files: readonly SourceFile[], entryFile?: string): string {
export function firstFileContent(files: readonly Pick<SourceFile, 'path' | 'content'>[], entryFile?: string): string {
if (entryFile) {
const entry = files.find((f) => f.path === entryFile);
if (entry) return entry.content;
Expand Down
53 changes: 27 additions & 26 deletions src/features/editor/useLanguages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@
import { useState, useEffect, useCallback } from 'react';
import { useTranslations } from 'next-intl';
import type { Language } from '@kingsejong-lang/playground-proto';
import { toRpcFailure, useRpc, type ApiClients, type RpcFailureKind } from '@/lib/rpc';
import { toRpcFailure, useRpc, type ApiClients, type InitialLanguages, type RpcFailureKind } from '@/lib/rpc';
import { useFailureText } from '@/hooks/useFailureText';
import { firstFileContent } from './templates';
import { defaultTemplateId, FALLBACK_TEMPLATE_ID, pickDefaultLanguage, PREFERRED_DEFAULTS } from './language-defaults';

export { defaultTemplateId, FALLBACK_TEMPLATE_ID, pickDefaultLanguage };

const DEFAULT_CODE = {
python: `# 킹세종 플레이그라운드에 오신 것을 환영합니다
Expand Down Expand Up @@ -50,12 +53,6 @@ func main() {
`,
} as const;

/** Template id used when a language does not name its own default template. */
export const FALLBACK_TEMPLATE_ID = 'hello_world';

/** Preferred default language ids, in order (new contract id first, then the legacy id). */
const PREFERRED_DEFAULTS = ['kingsejong', 'kingsejong_v0_3'];

/** Built-in starter code for a language id ("python_3_12" and "python" share the same code). */
export function defaultCodeFor(languageId: string): string {
for (const family of Object.keys(DEFAULT_CODE) as (keyof typeof DEFAULT_CODE)[]) {
Expand All @@ -64,19 +61,6 @@ export function defaultCodeFor(languageId: string): string {
return '// Start coding...';
}

export function pickDefaultLanguage(langs: readonly Language[]): Language | undefined {
for (const id of PREFERRED_DEFAULTS) {
const found = langs.find((l) => l.id === id);
if (found) return found;
}
return langs.find((l) => l.id.startsWith('kingsejong')) ?? langs[0];
}

/** The template that seeds a new editor for this language. */
export function defaultTemplateId(language: Pick<Language, 'defaultTemplateId'> | undefined): string {
return language?.defaultTemplateId || FALLBACK_TEMPLATE_ID;
}

/** Starter code from the server template, or the built-in sample when that fails. */
async function starterCode(api: ApiClients, language: Language): Promise<string> {
try {
Expand Down Expand Up @@ -106,20 +90,37 @@ interface UseLanguagesReturn {
retrying: boolean;
}

export function useLanguages(): UseLanguagesReturn {
/** Selection and starter code from server-rendered data (see lib/rpc/initial.ts). */
function initialState(initial: InitialLanguages | null | undefined) {
if (!initial) return null;
const language = pickDefaultLanguage(initial.languages);
if (!language) return null;
const starter = initial.starter?.languageId === language.id ? firstFileContent(initial.starter.files, initial.starter.entryFile) : '';
return { languages: initial.languages, selected: language.id, code: starter || defaultCodeFor(language.id) };
}

/**
* @param initial Languages rendered on the server. When given, the first render
* already has them and no request is made until retry().
*/
export function useLanguages(initial?: InitialLanguages | null): UseLanguagesReturn {
const api = useRpc();
const t = useTranslations('errors');
const failureText = useFailureText();
const [languages, setLanguages] = useState<Language[]>([]);
const [selectedLanguage, setSelectedLanguage] = useState<string>('');
const [code, setCode] = useState<string>('');
const [loading, setLoading] = useState<boolean>(true);
// Read once: later renders keep their own state.
const [seed] = useState(() => initialState(initial));
const [languages, setLanguages] = useState<Language[]>(seed?.languages ?? []);
const [selectedLanguage, setSelectedLanguage] = useState<string>(seed?.selected ?? '');
const [code, setCode] = useState<string>(seed?.code ?? '');
const [loading, setLoading] = useState<boolean>(!seed);
const [error, setError] = useState<string | null>(null);
const [errorKind, setErrorKind] = useState<RpcFailureKind | null>(null);
const [attempt, setAttempt] = useState(0);
const [retrying, setRetrying] = useState(false);

useEffect(() => {
// Server-rendered data covers the first load; retry() (attempt > 0) fetches again.
if (seed && attempt === 0) return;
let cancelled = false;
(async () => {
try {
Expand Down Expand Up @@ -151,7 +152,7 @@ export function useLanguages(): UseLanguagesReturn {
return () => {
cancelled = true;
};
}, [api, attempt, t, failureText]);
}, [api, attempt, t, failureText, seed]);

const changeLanguage = useCallback(
(languageId: string) => {
Expand Down
123 changes: 123 additions & 0 deletions src/lib/rpc/__tests__/server.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
import { Code, ConnectError, createRouterTransport } from '@connectrpc/connect';
import { LanguageService } from '@kingsejong-lang/playground-proto';
import { decodeInitialLanguages } from '../initial';
import { CACHE_TTL_MS, FAILURE_TTL_MS, fetchInitialLanguages, loadInitialLanguages, resetInitialLanguagesCache, serverApiBaseUrl } from '../server';

const LANGS = [
{ id: 'python', displayName: 'Python', limits: { maxMemoryBytes: 256n * 1024n * 1024n } },
{ id: 'kingsejong', displayName: '킹세종', defaultTemplateId: 'hello_world' },
];
const choose = () => ({ languageId: 'kingsejong', templateId: 'hello_world' });

function transport(overrides: Record<string, (...a: never[]) => unknown> = {}) {
const calls = { listLanguages: 0, getTemplate: 0 };
const t = createRouterTransport(({ service }) =>
service(LanguageService, {
listLanguages: () => {
calls.listLanguages++;
return { languages: LANGS };
},
getTemplate: () => {
calls.getTemplate++;
return { template: { entryFile: 'main.ksj', files: { files: [{ path: 'main.ksj', content: '출력(1)' }] } } };
},
...overrides,
} as never)
);
return { t, calls };
}

beforeEach(() => resetInitialLanguagesCache());
afterEach(() => {
vi.useRealTimers();
vi.unstubAllEnvs();
});

describe('fetchInitialLanguages', () => {
it('returns the list (64-bit fields intact) and the starter template', async () => {
const { t } = transport();
const payload = await fetchInitialLanguages(t, choose);
const decoded = decodeInitialLanguages(payload)!;
expect(decoded.languages.map((l) => l.id)).toEqual(['python', 'kingsejong']);
expect(decoded.languages[0].limits?.maxMemoryBytes).toBe(268435456n);
expect(decoded.starter).toEqual({ languageId: 'kingsejong', entryFile: 'main.ksj', files: [{ path: 'main.ksj', content: '출력(1)' }] });
});

it('still returns the list when the template fails', async () => {
const { t } = transport({
getTemplate: () => {
throw new ConnectError('gone', Code.NotFound);
},
});
const payload = await fetchInitialLanguages(t, choose);
expect(payload.starter).toBeUndefined();
expect(decodeInitialLanguages(payload)?.languages).toHaveLength(2);
});

it('gives up after the time budget', async () => {
const { t } = transport({ listLanguages: () => new Promise(() => {}) });
await expect(fetchInitialLanguages(t, choose, 20)).rejects.toThrow();
});
});

describe('loadInitialLanguages', () => {
it('caches a success for a minute', async () => {
vi.useFakeTimers({ toFake: ['Date'] });
const { t, calls } = transport();
const first = await loadInitialLanguages(choose, { transport: t });
expect(await loadInitialLanguages(choose, { transport: t })).toBe(first);
expect(calls.listLanguages).toBe(1);
vi.setSystemTime(Date.now() + CACHE_TTL_MS + 1);
await loadInitialLanguages(choose, { transport: t });
expect(calls.listLanguages).toBe(2);
});

it('returns null on failure and retries only after a short pause', async () => {
vi.useFakeTimers({ toFake: ['Date'] });
let fail = true;
const { t } = transport({
listLanguages: () => {
if (fail) throw new ConnectError('down', Code.Unavailable);
return { languages: LANGS };
},
});
expect(await loadInitialLanguages(choose, { transport: t })).toBeNull();
fail = false;
expect(await loadInitialLanguages(choose, { transport: t })).toBeNull();
vi.setSystemTime(Date.now() + FAILURE_TTL_MS + 1);
expect(await loadInitialLanguages(choose, { transport: t })).not.toBeNull();
});

it('shares one request between concurrent page renders', async () => {
const { t, calls } = transport();
await Promise.all([loadInitialLanguages(choose, { transport: t }), loadInitialLanguages(choose, { transport: t })]);
expect(calls.listLanguages).toBe(1);
});
});

describe('serverApiBaseUrl', () => {
it('prefers the internal URL, then the public one', () => {
vi.stubEnv('PLAYGROUND_API_INTERNAL_URL', '');
vi.stubEnv('NEXT_PUBLIC_API_URL', 'https://api.example');
expect(serverApiBaseUrl()).toBe('https://api.example');
vi.stubEnv('PLAYGROUND_API_INTERNAL_URL', 'http://gateway:8080');
expect(serverApiBaseUrl()).toBe('http://gateway:8080');
});
});

describe('decodeInitialLanguages', () => {
it('ignores missing, unreadable or empty payloads', () => {
expect(decodeInitialLanguages(null)).toBeNull();
expect(decodeInitialLanguages({ languages: '!!not base64' })).toBeNull();
expect(decodeInitialLanguages({ languages: '' })).toBeNull();
});
});

describe('development fake backend', () => {
it('skips the server request so the fake data is used', async () => {
vi.stubEnv('NEXT_PUBLIC_RPC_FAKE', '1');
const { t, calls } = transport();
expect(await loadInitialLanguages(choose, { transport: t })).toBeNull();
expect(calls.listLanguages).toBe(0);
});
});
1 change: 1 addition & 0 deletions src/lib/rpc/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ export {
type MetricsView,
type RunRequestInit,
} from './run-stream';
export { decodeInitialLanguages, type InitialLanguages, type InitialLanguagesPayload, type InitialStarter } from './initial';
58 changes: 58 additions & 0 deletions src/lib/rpc/initial.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/**
* Language data rendered on the server and handed to the client page, so the
* first paint does not wait for ListLanguages and GetTemplate in the browser.
*
* The server encodes the ListLanguages response as base64 protobuf (it holds
* 64-bit integers, which plain JSON props cannot carry); the client decodes it.
* Safe to import from client code.
*
* Usage (client):
* const initial = decodeInitialLanguages(props.initialLanguages);
* const { languages } = useLanguages(initial);
*/
import { fromBinary } from '@bufbuild/protobuf';
import { ListLanguagesResponseSchema, type Language } from '@kingsejong-lang/playground-proto';

/** Serializable props from the server page. */
export interface InitialLanguagesPayload {
/** ListLanguagesResponse, binary protobuf, base64. */
languages: string;
/** Default template of the starter language, when it loaded in time. */
starter?: InitialStarter;
}

export interface InitialStarter {
languageId: string;
files: { path: string; content: string }[];
entryFile: string;
}

export interface InitialLanguages {
languages: Language[];
starter?: InitialStarter;
}

export function encodeBase64(bytes: Uint8Array): string {
let s = '';
for (const b of bytes) s += String.fromCharCode(b);
return btoa(s);
}

function decodeBase64(text: string): Uint8Array {
const s = atob(text);
const bytes = new Uint8Array(s.length);
for (let i = 0; i < s.length; i++) bytes[i] = s.charCodeAt(i);
return bytes;
}

/** Decodes the server payload; null when absent or unreadable (the client then fetches). */
export function decodeInitialLanguages(payload: InitialLanguagesPayload | null | undefined): InitialLanguages | null {
if (!payload) return null;
try {
const { languages } = fromBinary(ListLanguagesResponseSchema, decodeBase64(payload.languages));
if (languages.length === 0) return null;
return { languages, starter: payload.starter };
} catch {
return null;
}
}
Loading
Loading