subx-core 1.0.0

Core subtitle processing library for SubX: matching, format conversion, synchronization, and AI service integrations.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
use serde_json::json;
use std::time::Duration;
use wiremock::matchers::{header, method, path, query_param};
use wiremock::{Mock, MockServer, ResponseTemplate};

/// Helper for setting up a Wiremock mock Azure OpenAI server in integration tests.
#[allow(dead_code)]
pub struct MockAzureOpenAITestHelper {
    mock_server: MockServer,
    deployment_id: String,
    api_version: String,
}

#[allow(dead_code)]
impl MockAzureOpenAITestHelper {
    /// Start a new mock Azure OpenAI server instance.
    pub async fn new() -> Self {
        let mock_server = MockServer::start().await;
        Self {
            mock_server,
            deployment_id: "test-deployment".to_string(),
            api_version: "2025-04-01-preview".to_string(),
        }
    }

    /// Start a new mock Azure OpenAI server with custom deployment ID and API version.
    pub async fn new_with_deployment(deployment_id: &str, api_version: &str) -> Self {
        let mock_server = MockServer::start().await;
        Self {
            mock_server,
            deployment_id: deployment_id.to_string(),
            api_version: api_version.to_string(),
        }
    }

    /// Return the base URL of the mock server.
    pub fn base_url(&self) -> String {
        self.mock_server.uri()
    }

    /// Get the deployment ID used by this helper.
    pub fn deployment_id(&self) -> &str {
        &self.deployment_id
    }

    /// Get the API version used by this helper.
    pub fn api_version(&self) -> &str {
        &self.api_version
    }

    /// Mock a successful chat completion response for Azure OpenAI endpoint.
    pub async fn mock_chat_completion_success(&self, response_content: &str) {
        let response_body = json!({
            "choices": [
                {
                    "message": { "content": response_content },
                    "finish_reason": "stop"
                }
            ],
            "usage": { "prompt_tokens": 100, "completion_tokens": 50, "total_tokens": 150 },
            "model": "gpt-test"
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .and(header("content-type", "application/json"))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .mount(&self.mock_server)
            .await;
    }

    /// Mock a successful chat completion with api-key authentication.
    pub async fn mock_chat_completion_success_with_api_key(
        &self,
        response_content: &str,
        expected_api_key: &str,
    ) {
        let response_body = json!({
            "choices": [
                {
                    "message": { "content": response_content },
                    "finish_reason": "stop"
                }
            ],
            "usage": { "prompt_tokens": 100, "completion_tokens": 50, "total_tokens": 150 },
            "model": "gpt-test"
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .and(header("api-key", expected_api_key))
            .and(header("content-type", "application/json"))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .mount(&self.mock_server)
            .await;
    }

    /// Mock a successful chat completion with Bearer token authentication.
    pub async fn mock_chat_completion_success_with_bearer_token(
        &self,
        response_content: &str,
        expected_token: &str,
    ) {
        let response_body = json!({
            "choices": [
                {
                    "message": { "content": response_content },
                    "finish_reason": "stop"
                }
            ],
            "usage": { "prompt_tokens": 100, "completion_tokens": 50, "total_tokens": 150 },
            "model": "gpt-test"
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .and(header("authorization", expected_token))
            .and(header("content-type", "application/json"))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .mount(&self.mock_server)
            .await;
    }

    /// Mock a successful chat completion with dynamic file IDs for cache testing.
    pub async fn mock_chat_completion_with_dynamic_ids(&self, video_id: &str, subtitle_id: &str) {
        use crate::test_support::responses::MatchResponseGenerator;

        let response_content =
            MatchResponseGenerator::successful_match_with_ids(video_id, subtitle_id);
        let response_body = json!({
            "choices": [
                { "message": { "content": response_content }, "finish_reason": "stop" }
            ],
            "usage": { "prompt_tokens": 100, "completion_tokens": 50, "total_tokens": 150 },
            "model": "gpt-test"
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .and(header("content-type", "application/json"))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .mount(&self.mock_server)
            .await;
    }

    /// Mock a chat completion response with exact expected number of calls.
    pub async fn mock_chat_completion_with_expectation(
        &self,
        response_content: &str,
        expected_calls: usize,
    ) {
        let response_body = json!({
            "choices": [
                { "message": { "content": response_content }, "finish_reason": "stop" }
            ],
            "usage": { "prompt_tokens": 100, "completion_tokens": 50, "total_tokens": 150 },
            "model": "gpt-test"
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .and(header("content-type", "application/json"))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .expect(expected_calls as u64)
            .mount(&self.mock_server)
            .await;
    }

    /// Verify that all expectations registered on the mock server have been met.
    pub async fn verify_expectations(&self) {
        // Retrieve received requests to trigger expectation verification on server drop.
        let _ = self.mock_server.received_requests().await;
    }

    /// Setup an error response with given status code and error message.
    pub async fn setup_error_response(&self, status: u16, error_message: &str) {
        let response_body = json!({
            "error": { "message": error_message }
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .respond_with(ResponseTemplate::new(status).set_body_json(response_body))
            .mount(&self.mock_server)
            .await;
    }

    /// Setup a delayed chat completion response to simulate network latency.
    pub async fn setup_delayed_response(&self, delay_ms: u64, response_content: &str) {
        let response_body = json!({
            "choices": [
                { "message": { "content": response_content }, "finish_reason": "stop" }
            ],
            "usage": { "prompt_tokens": 100, "completion_tokens": 50, "total_tokens": 150 },
            "model": "gpt-test"
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .respond_with(
                ResponseTemplate::new(200)
                    .set_delay(Duration::from_millis(delay_ms))
                    .set_body_json(response_body),
            )
            .mount(&self.mock_server)
            .await;
    }

    /// Setup multiple retryable error responses followed by success.
    pub async fn setup_retry_scenario(&self, error_count: usize, final_response_content: &str) {
        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        // Set up error responses that will be consumed first
        for _ in 0..error_count {
            Mock::given(method("POST"))
                .and(path(&path_pattern))
                .and(query_param("api-version", &self.api_version))
                .respond_with(ResponseTemplate::new(500).set_body_json(json!({
                    "error": { "message": "Internal server error" }
                })))
                .expect(1)
                .mount(&self.mock_server)
                .await;
        }

        // Set up the final success response
        let response_body = json!({
            "choices": [
                { "message": { "content": final_response_content }, "finish_reason": "stop" }
            ],
            "usage": { "prompt_tokens": 100, "completion_tokens": 50, "total_tokens": 150 },
            "model": "gpt-test"
        });

        Mock::given(method("POST"))
            .and(path(&path_pattern))
            .and(query_param("api-version", &self.api_version))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .expect(1)
            .mount(&self.mock_server)
            .await;
    }

    /// Mock timeout error followed by success for retry testing
    pub async fn mock_chat_completion_timeout_then_success(&self) {
        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        // First call times out (simulate with very long delay)
        Mock::given(method("POST"))
            .and(path(&path_pattern))
            .and(query_param("api-version", &self.api_version))
            .respond_with(ResponseTemplate::new(200).set_delay(Duration::from_secs(30)))
            .expect(1)
            .mount(&self.mock_server)
            .await;

        // Second call succeeds
        let response_body = json!({
            "choices": [{
                "message": {
                    "content": "1"
                },
                "finish_reason": "stop"
            }],
            "usage": {
                "prompt_tokens": 100,
                "completion_tokens": 50,
                "total_tokens": 150
            },
            "model": "gpt-test"
        });

        Mock::given(method("POST"))
            .and(path(&path_pattern))
            .and(query_param("api-version", &self.api_version))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .expect(1)
            .mount(&self.mock_server)
            .await;
    }

    /// Mock connection error followed by success for retry testing  
    pub async fn mock_chat_completion_connection_error_then_success(&self) {
        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        // First call returns connection error (502 Bad Gateway)
        Mock::given(method("POST"))
            .and(path(&path_pattern))
            .and(query_param("api-version", &self.api_version))
            .respond_with(
                ResponseTemplate::new(502)
                    .set_body_json(json!({"error": {"message": "Bad Gateway"}})),
            )
            .expect(1)
            .mount(&self.mock_server)
            .await;

        // Second call succeeds
        let response_body = json!({
            "choices": [{
                "message": {
                    "content": "1"
                },
                "finish_reason": "stop"
            }],
            "usage": {
                "prompt_tokens": 100,
                "completion_tokens": 50,
                "total_tokens": 150
            },
            "model": "gpt-test"
        });

        Mock::given(method("POST"))
            .and(path(&path_pattern))
            .and(query_param("api-version", &self.api_version))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .expect(1)
            .mount(&self.mock_server)
            .await;
    }

    /// Mock chat completion with Bearer token authentication
    pub async fn mock_chat_completion_with_bearer_auth(&self, response_content: &str) {
        let response_body = json!({
            "choices": [{
                "message": {
                    "content": response_content
                },
                "finish_reason": "stop"
            }],
            "usage": {
                "prompt_tokens": 100,
                "completion_tokens": 50,
                "total_tokens": 150
            },
            "model": "gpt-test"
        });

        let path_pattern = format!(
            "/openai/deployments/{}/chat/completions",
            self.deployment_id
        );

        Mock::given(method("POST"))
            .and(path(path_pattern))
            .and(query_param("api-version", &self.api_version))
            .and(header("content-type", "application/json"))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
            .mount(&self.mock_server)
            .await;
    }
}