DefStream 0.1.12__tar.gz → 0.1.13__tar.gz

defstream-0.1.13/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,61 @@
+name: 버그/오류 제보
+description: 예상과 다르게 동작하거나 오류가 발생하는 문제를 제보합니다.
+title: "[버그] "
+body:
+  - type: markdown
+    attributes:
+      value: >
+        재현 가능한 버그를 제보해 주세요. 로그나 설정을 첨부할 때 토큰, 비밀번호,
+        개인정보 등 민감한 정보는 반드시 삭제해 주세요.
+  - type: input
+    id: version
+    attributes:
+      label: 버전
+      description: 사용 중인 버전 또는 커밋을 입력해 주세요.
+      placeholder: 예) 0.1.12
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: 기대한 동작
+      description: 어떤 결과를 기대했는지 설명해 주세요.
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: 실제 동작
+      description: 실제로 발생한 결과를 설명해 주세요. 오류가 표시되면 메시지도 포함해 주세요.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: 재현 방법
+      description: 문제를 재현하는 단계나 최소 코드 예제를 작성해 주세요.
+      placeholder: |
+        1. 다음 설정으로 Worker를 시작합니다.
+        2. 특정 메시지를 전달합니다.
+        3. 오류가 발생합니다.
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: 실행 환경
+      description: Python 버전, 운영체제, 브로커 및 관련 어댑터 버전을 입력해 주세요.
+      placeholder: |
+        - Python:
+        - 운영체제:
+        - 브로커:
+        - 어댑터:
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: 추가 정보
+      description: 관련 로그나 스크린샷 등 문제 파악에 도움이 되는 정보를 적어 주세요.
+    validations:
+      required: false

defstream-0.1.13/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

defstream-0.1.13/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: 기능 제안
+description: DefStream에 추가하거나 개선할 기능을 제안합니다.
+title: "[기능 제안] "
+body:
+  - type: markdown
+    attributes:
+      value: >
+        해결하려는 문제와 제안하는 사용 경험을 중심으로 작성해 주세요.
+  - type: textarea
+    id: problem
+    attributes:
+      label: 해결하려는 문제
+      description: 현재 어떤 불편이나 제약이 있는지 설명해 주세요.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: 제안하는 해결 방법
+      description: 원하는 기능과 기대하는 동작을 설명해 주세요.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: 고려한 대안
+      description: 고려한 다른 방법이나 우회 방법이 있다면 적어 주세요.
+    validations:
+      required: false
+  - type: textarea
+    id: additional
+    attributes:
+      label: 추가 정보
+      description: 예제, 참고 자료 등 제안의 맥락을 이해하는 데 도움이 되는 정보를 적어 주세요.
+    validations:
+      required: false

defstream-0.1.13/.github/PULL_REQUEST_TEMPLATE/hotfix.md

@@ -0,0 +1,34 @@
+## 핫픽스 요약
+
+<!-- 긴급 수정이 필요한 이유와 해결 내용을 요약해 주세요. -->
+
+## 관련 이슈와 영향 범위
+
+- 관련 이슈:
+- 영향을 받는 버전:
+- 영향받는 사용자·기능:
+- 심각도 및 긴급 배포가 필요한 이유:
+
+## 원인과 수정 내용
+
+<!-- 문제의 원인, 수정 방법, 변경 범위를 작성해 주세요. -->
+
+## 회귀 방지 및 검증
+
+<!-- 재현 테스트와 실행한 검증 결과를 작성해 주세요. 실행하지 못한 검증은 사유를 적어 주세요. -->
+
+- [ ] 문제를 재현하는 회귀 테스트를 추가하거나 기존 테스트로 수정 동작을 확인했습니다.
+- [ ] 관련 테스트를 실행했습니다.
+- [ ] 호환성 및 영향 범위를 확인했습니다.
+
+## 배포·복구 계획
+
+- 배포 시 주의사항:
+- 롤백 또는 복구 방법:
+- 후속 수정이 필요한 경우 관련 이슈:
+
+## 제출 전 확인
+
+- [ ] 수정 범위가 긴급 문제 해결에 필요한 변경으로 한정되어 있습니다.
+- [ ] 오류 로그와 변경 내용을 민감 정보 없이 확인했습니다.
+- [ ] 검증하지 않은 항목을 완료한 것으로 표시하지 않았습니다.

defstream-0.1.13/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+## 변경 내용
+
+<!-- 무엇을 왜 변경했는지 간단히 요약해 주세요. -->
+
+## 변경 유형
+
+- [ ] 버그 수정
+- [ ] 기능 추가
+- [ ] 호환성에 영향을 주는 변경
+- [ ] 문서 또는 예제 변경
+- [ ] 기타
+
+## 검증
+
+<!-- 실행한 테스트와 결과를 작성해 주세요. 테스트를 실행하지 않았다면 사유를 적어 주세요. -->
+
+- [ ] 관련 테스트를 실행했습니다.
+- [ ] 문서와 예제를 확인했습니다.
+
+## 확인 사항
+
+- [ ] 변경 범위가 요청 사항에 한정되어 있습니다.
+- [ ] 공개 API나 기존 동작에 영향을 주는 경우 변경 내용과 마이그레이션 방법을 설명했습니다.
+- [ ] 민감 정보나 불필요한 디버깅 코드를 포함하지 않았습니다.

{defstream-0.1.12 → defstream-0.1.13}/.gitignore

@@ -53,10 +53,8 @@ tmp/
 .git/
 
 # GitHub specific files
-.github/
-!/.github/
-/.github/*
-!/.github/workflows/
+.github/instructions
+.github/instructions/
 
 # GitLab specific files
 .gitlab/

{defstream-0.1.12 → defstream-0.1.13}/DefStream.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: DefStream
-Version: 0.1.12
+Version: 0.1.13
 Summary: Synchronous message processing with pluggable broker adapters
 Home-page: https://github.com/yong5eon/DefStream
 Author: Heo Yongseon

{defstream-0.1.12 → defstream-0.1.13}/DefStream.egg-info/SOURCES.txt

@@ -3,12 +3,21 @@ LICENSE
 README.en.md
 README.md
 setup.py
+.github/PULL_REQUEST_TEMPLATE.md
+.github/ISSUE_TEMPLATE/bug_report.yml
+.github/ISSUE_TEMPLATE/config.yml
+.github/ISSUE_TEMPLATE/feature_request.yml
+.github/PULL_REQUEST_TEMPLATE/hotfix.md
 .github/workflows/ci.yml
 DefStream.egg-info/PKG-INFO
 DefStream.egg-info/SOURCES.txt
 DefStream.egg-info/dependency_links.txt
 DefStream.egg-info/requires.txt
 DefStream.egg-info/top_level.txt
+issues/bug/16/IMPLEMENTS.md
+issues/bug/16/ISSUE.md
+issues/bug/16/README.md
+issues/bug/16/REQUIREMENTS.md
 issues/feature/1/IMPLEMENTS.md
 issues/feature/1/README.md
 issues/feature/1/REQUIREMENTS.md

{defstream-0.1.12 → defstream-0.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: DefStream
-Version: 0.1.12
+Version: 0.1.13
 Summary: Synchronous message processing with pluggable broker adapters
 Home-page: https://github.com/yong5eon/DefStream
 Author: Heo Yongseon

defstream-0.1.13/issues/bug/16/IMPLEMENTS.md

@@ -0,0 +1,32 @@
+# Inspector Console 사용자 지정 Task 이름 버그 수정 기록
+
+## 구현 개요
+
+[요구사항 명세서](./REQUIREMENTS.md)에 따라 Inspector Console이 작업 목록과
+동일한 작업 ID를 사용해 등록된 Task를 찾고, 잘못된 요청의 구체적인 원인을
+경고 로그에서 확인할 수 있도록 수정했다.
+
+## 주요 변경
+
+- `Console.execute()`의 Task 검색과 중복 검사를 모두 `task.__name__`에서
+  `task.name` 비교로 변경했다. 작업 이름을 사용자 지정한 경우에도
+  Specifications 문서와 Console UI가 전달하는 ID로 올바른 Task를 식별한다.
+- 잘못된 입력을 거부하는 경고 로그에 예외 종류와 예외 메시지를 함께 기록한다.
+- `test_inspector_console.py`에 사용자 지정 ID의 발행 성공, 중복 ID 거부,
+  미등록 ID의 오류 로그 내용을 확인하는 회귀 테스트를 추가했다.
+- RabbitMQ·Redis 실서버 테스트의 요청 ID도 실제 등록된 하위 Task의 `Live.name`을
+  사용하도록 했다. 클래스의 `__name__`(`Live`)와 Worker에 등록하는 유효 작업
+  이름은 같다고 가정할 수 없으며, 이전의 하드코딩은 요청을 400으로 거부하게 했다.
+
+## 검증
+
+DefStream 테스트 디렉터리에서 Python 3.12.10으로 다음 명령을 실행했다.
+
+```powershell
+$env:PYTHONIOENCODING = 'utf-8'
+..\..\.venv\Scripts\python.exe -m unittest test_inspector_console test_inspector_logging
+```
+
+Inspector Console 및 로깅 관련 테스트 28개가 통과했고, 선택 통합 테스트 2개는
+건너뛰었다. 변경된 두 Python 파일의 `compile()` 문법 검사와
+`git diff --check`도 통과했다. 브로커 실서버 통합 검증은 수행하지 않았다.

defstream-0.1.13/issues/bug/16/ISSUE.md

@@ -0,0 +1,19 @@
+# Inspector Console에서 사용자 지정 Task 이름으로 요청 시 큐 발행 전에 거부됨
+
+## 버전
+
+0.1.12
+
+## 내용
+
+Inspector Console이 Task 목록에 표시하는 이름과 실제 Task를 찾는 기준이 다릅니다.
+
+Specifications.document()은 task.name을 작업 ID로 사용합니다. Console UI는 이 ID를 선택해 요청을 보내지만, Console.execute()는 등록된 작업을 찾을 때 task.__name__과 요청의 task 값을 비교합니다.
+
+예를 들어 Orbis Split은 Split.name이 ETL.OBS.Split이고 Split.__name__은 Split입니다. 따라서 UI에서 선택한 작업 ID ETL.OBS.Split과 Console의 비교 값 Split이 일치하지 않아 Unknown registered task 오류가 발생합니다. 이 검사는 브로커에 연결하거나 메시지를 발행하기 전에 수행되므로 요청은 큐에 도달하지 않습니다.
+
+또한 Console 경고 로그에는 구체적인 오류 메시지 대신 예외 종류만 기록되어 원인을 파악하기 어렵습니다.
+
+기대 동작: Console이 Task 목록을 만들 때와 동일하게 task.name을 기준으로 작업을 찾아야 합니다. 중복 여부 검사도 같은 기준을 사용해야 합니다.
+
+실제 동작: Console이 task.__name__을 기준으로 작업을 찾아 사용자 지정 이름을 사용하는 Task를 거부합니다.

defstream-0.1.13/issues/bug/16/README.md

@@ -0,0 +1,12 @@
+# Inspector Console 사용자 지정 Task 이름 처리
+
+Inspector Console이 작업 목록에 표시한 ID로 Task를 찾도록 수정했습니다.
+따라서 `ETL.OBS.Split`처럼 클래스 이름과 다른 사용자 지정 Task 이름으로도
+요청을 보낼 수 있습니다. 동일한 작업 ID가 중복 등록된 경우에는 모호한 작업
+실행을 막기 위해 요청을 거부합니다.
+
+잘못된 요청은 기존처럼 거부되며, 경고 로그에 예외 종류와 구체적인 원인이 함께
+기록됩니다.
+
+세부 내용은 [요구사항 명세서](./REQUIREMENTS.md)와
+[구현 및 검증 기록](./IMPLEMENTS.md)을 참고하세요.

defstream-0.1.13/issues/bug/16/REQUIREMENTS.md

@@ -0,0 +1,25 @@
+# Inspector Console의 사용자 지정 Task 이름 처리 요구사항
+
+## 목적
+
+Inspector Console이 Task 목록에 표시한 작업 ID로 등록된 Task를 찾아 실행하도록 한다. Task에 사용자 지정 이름이 지정되어 있어도 요청이 잘못 거부되거나 큐 발행 전에 중단되지 않아야 한다.
+
+## 배경
+
+`Specifications.document()`은 `task.name`을 작업 ID로 사용하고, Console UI는 이 ID를 요청에 포함한다. 그러나 `Console.execute()`는 등록된 작업을 찾을 때 `task.__name__`과 요청의 작업 ID를 비교한다.
+
+예를 들어 `Split.name`이 `ETL.OBS.Split`이고 `Split.__name__`이 `Split`이면, 요청 ID `ETL.OBS.Split`과 비교 값이 달라 `Unknown registered task` 오류가 발생한다. 이 오류는 브로커 연결 및 메시지 발행 전에 발생하므로 요청이 큐에 도달하지 않는다.
+
+## 요구사항
+
+1. Console은 요청의 작업 ID와 등록된 Task의 `task.name`을 비교해 실행할 Task를 찾아야 한다.
+2. 중복 작업 ID 검사도 `task.name`을 기준으로 수행해야 한다. 같은 이름을 가진 등록 Task가 중복으로 허용되어서는 안 된다.
+3. 목록에 표시된 사용자 지정 작업 ID로 요청하면, 해당 Task를 찾지 못했다는 오류로 거부하지 않고 정상적인 실행 절차를 진행해야 한다.
+4. 요청 처리 중 오류가 발생하면 경고 로그에 예외 종류뿐 아니라 구체적인 오류 메시지도 기록해야 한다.
+
+## 완료 기준
+
+- `task.name`과 `task.__name__`이 다른 Task를 목록의 작업 ID로 요청해도 올바른 Task가 선택된다.
+- 중복 검사와 Task 검색이 모두 `task.name`을 기준으로 일관되게 동작한다.
+- 유효한 사용자 지정 작업 ID 요청은 큐 발행 단계까지 진행되며, 해당 요청이 `Unknown registered task` 오류로 중단되지 않는다.
+- 오류 로그에서 예외 종류와 구체적인 원인을 확인할 수 있다.

{defstream-0.1.12 → defstream-0.1.13}/src/Inspector/Extensions/Console.py

@@ -323,13 +323,13 @@ class Console(Extension):
 			)
 			task = next(
 				(
-					task for task in worker.tasks if task.__name__ == payload['task']
+					task for task in worker.tasks if task.name == payload['task']
 				),
 				None,
 			)
 			if task is None:
 				raise ValueError('Unknown registered task')
-			if sum(task.__name__ == payload['task'] for task in worker.tasks) != 1:
+			if sum(task.name == payload['task'] for task in worker.tasks) != 1:
 				raise ValueError('Ambiguous registered task name')
 		except (
 			ValueError,
@@ -337,8 +337,9 @@ class Console(Extension):
 			UnicodeDecodeError,
 		) as error:
 			self.logger.warning(
-				'Inspector Console rejected invalid input: error=%s',
+				'Inspector Console rejected invalid input: error=%s message=%s',
 				type(error).__name__,
+				error,
 			)
 			return json_response(
 				'400 Bad Request',

{defstream-0.1.12 → defstream-0.1.13}/test/test_inspector_console.py

@@ -57,6 +57,19 @@ class Task(
 		return a / b
 
 
+class NamedTask(
+	Run,
+	run_name='ETL.OBS.Split',
+	parameters={'queue': 'named-task'},
+):
+	def run(
+		self,
+		a,
+		b,
+	):
+		return a / b
+
+
 class Producer:
 	def __init__(self):
 		self.connected = 0
@@ -168,7 +181,7 @@ class ConsoleExtensionTests(TestCase):
 		mode='send',
 	):
 		return {
-			'task': 'Task',
+			'task': Task.name,
 			'mode': mode,
 			'body': {
 				'a': 6,
@@ -459,6 +472,47 @@ class ConsoleExtensionTests(TestCase):
 		self.worker.broker.connect.assert_not_called()
 		self.worker.broker.close.assert_not_called()
 
+	def test_custom_task_name_is_resolved_and_duplicate_names_are_rejected(self):
+		self.worker.add(NamedTask)
+		payload = self.payload()
+		payload['task'] = NamedTask.name
+		status, body, headers = self.fetch(
+			'POST',
+			payload,
+		)
+		self.assertEqual(status, 200)
+		self.assertEqual(loads(body)['result'], 'message-id')
+		self.assertEqual(self.producers[-1].sent[0][1], NamedTask.parameters)
+
+		self.worker.tasks.append(NamedTask)
+		with self.assertLogs(
+			'DefStream.Inspector.Extensions.Console',
+			level='WARNING',
+		) as logs:
+			status, body, headers = self.fetch(
+				'POST',
+				payload,
+			)
+		self.assertEqual(status, 400)
+		self.assertEqual(loads(body)['error'], 'Ambiguous registered task name')
+		self.assertIn('message=Ambiguous registered task name', logs.output[0])
+
+	def test_invalid_task_warning_includes_the_specific_error(self):
+		payload = self.payload()
+		payload['task'] = 'not-registered'
+		with self.assertLogs(
+			'DefStream.Inspector.Extensions.Console',
+			level='WARNING',
+		) as logs:
+			status, body, headers = self.fetch(
+				'POST',
+				payload,
+			)
+		self.assertEqual(status, 400)
+		self.assertIn('error=ValueError', logs.output[0])
+		self.assertIn('message=Unknown registered task', logs.output[0])
+		self.assertEqual(self.producers, [])
+
 	def test_unsupported_rpc_and_worker_not_running(self):
 		self.extension.broker = Producer
 		self.assertFalse(loads(self.fetch()[1])['rpc'])
@@ -768,7 +822,7 @@ class ConsoleExtensionTests(TestCase):
 					rpc,
 				)
 				payload = self.payload()
-				payload['task'] = 'Live'
+				payload['task'] = Live.name
 				self.assertEqual(
 					self.fetch(
 						'POST',