Pause and resume

[rycont]

YaksokSession의 pause, resume 이벤트를 사용하여 코드의 실행을 잠시 멈추거나 재개할 수 있습니다. executionDelay 기능과 함께 사용하기 좋습니다. 자세한 내용은 [문서](/docs/library/7. pause-and-resume.md)를 참고하세요.

import { YaksokSession } from '@dalbit-yaksok/core'

const session = new YaksokSession({
        events: {
            pause() {
                console.log('[PAUSED]')
                pausedTime = new Date().getTime() - startTime
            },
            resume() {
                console.log('[RESUMED]')
                resumeTime = new Date().getTime() - startTime
            },
        },
    })

session.addModule(
    'main',
    `
"A" 보여주기
"B" 보여주기
"C" 보여주기
"D" 보여주기
"E" 보여주기
"F" 보여주기
`,
    {
        executionDelay: 1000,
    },
)

session.runModule('main')
await new Promise((resolve) => setTimeout(resolve, 2000))
session.pause()
console.log('Paused. Resuming in 2 seconds...')
await new Promise((resolve) => setTimeout(resolve, 2000))
session.resume()
console.log('Resumed. Running again...')

[gemini-code-assist]

Summary of Changes

Hello @rycont, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces the highly anticipated ability to pause and resume the execution of code within a YaksokSession. This new functionality provides granular control over the session's lifecycle, making it particularly useful for scenarios requiring interactive or step-by-step code processing, especially when combined with existing features like executionDelay.

Highlights

• Core Functionality: Introduced pause() and resume() methods to the YaksokSession class, allowing for explicit control over the execution flow of code within a session.
• Execution Control Mechanism: Implemented a pausing mechanism within the Executable node (core/node/base.ts) that checks the session's paused state and asynchronously waits for a resume event before continuing execution.
• Event System Integration: Added pause and resume as new event types to the SessionConfig's Events interface, enabling external listeners to subscribe to and react to these session state changes. The events configuration property is now Partial<Events>.
• Event Unsubscription: Enhanced the PubSub utility's sub method to return an unsubscribe function, allowing for cleaner management and removal of event listeners, which is utilized by the new pausing mechanism.
• New Test Case: A new dedicated test file (test/pause-and-resume.test.ts) has been added to thoroughly validate the new pause and resume functionality, including assertions on execution timing and output.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces pause and resume functionality for Yaksok sessions using a pub/sub mechanism. A critical issue was identified where execution could hang indefinitely if a session component is missing, along with medium-severity issues related to code clarity and redundancy.

[gemini-code-assist]

If scope.codeFile?.session?.pubsub is undefined, the .sub() method will not be called, and unsubscribe will be undefined. The new Promise will never resolve, causing the await to block indefinitely. To fix this, ensure pubsub is available before creating the promise.

Suggested change

	if (scope.codeFile?.session?.paused) {
	await new Promise((resolve) => {
	const unsubscribe = scope.codeFile?.session?.pubsub.sub(
	'resume',
	() => {
	resolve(undefined)
	unsubscribe!()
	},
	)
	})
	}
	if (scope.codeFile?.session?.pubsub) {
	await new Promise<void>((resolve) => {
	const unsubscribe = scope.codeFile?.session?.pubsub!.sub(
	'resume',
	() => {
	resolve(undefined)
	unsubscribe()
	},
	)
	})
	}

[gemini-code-assist]

Using Object.entries provides a more type-safe and readable approach than a for...in loop with type assertions. This avoids the need for non-null assertions.

        for (const [event, listener] of Object.entries(resolvedConfig.events)) {
            if (listener) {
                this.pubsub.sub(event as keyof Events, listener);
            }
        }

[gemini-code-assist]

The optional chaining operator (?.) is redundant since this.runningPromise is already checked for truthiness in the if condition.

            return this.runningPromise.then()