@jrpool/kilotest 46.1.0 → 47.0.1

package/web/tutorial/index.js

@@ -1,63 +0,0 @@
-/*
-  index.js
-  Serves the tutorial and saves tutorial comments.
-*/
-
-// IMPORTS
-
-const {sendAlert} = require('../../alerts');
-const {getJSON, getNowStamp} = require('../../util');
-const fs = require('fs/promises');
-const path = require('path');
-
-// CONSTANTS
-
-const commentsPath = path.join(__dirname, 'comments.json');
-
-// FUNCTIONS
-
-// Strips HTML tags and control characters, trims, and limits to 500 characters.
-const sanitize = str => str
-  .replace(/<[^>]*>/g, '')
-  .replace(/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]/g, '')
-  .trim()
-  .slice(0, 500);
-
-// Returns the tutorial page.
-exports.answer = async () => {
-  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
-  return {
-    status: 'ok',
-    answerPage
-  };
-};
-// Sanitizes and saves a tutorial comment to comments.json.
-exports.handleComment = async content => {
-  if (!content || typeof content !== 'string') {
-    return {status: 'error', message: 'No content provided'};
-  }
-  const sanitized = sanitize(content);
-  if (!sanitized) {
-    return {status: 'error', message: 'Comment is empty after sanitization'};
-  }
-  let comments = [];
-  try {
-    // Get the existing comments.
-    const existing = await fs.readFile(commentsPath, 'utf8');
-    comments = JSON.parse(existing);
-  }
-  // If there are none:
-  catch {
-    // Initialize a comments array.
-  }
-  // Add the comment to the existing ones.
-  comments.push({
-    timeStamp: getNowStamp(),
-    content: sanitized
-  });
-  // Save the revised comments.
-  await fs.writeFile(commentsPath, getJSON(comments));
-  // Send an alert to the manager.
-  await sendAlert('New tutorial comment received', 'A new tutorial comment has been received.');
-  return {status: 'ok'};
-};

package/web/tutorial/tutorial.test.js

@@ -1,97 +0,0 @@
-/*
-  tutorial.test.js
-  Unit tests for web/tutorial/index.js, covering the answer and handleComment exports.
-*/
-
-// IMPORTS
-
-const {test, before, after} = require('node:test');
-const assert = require('node:assert/strict');
-const fs = require('node:fs/promises');
-const path = require('node:path');
-const {answer, handleComment} = require('./index');
-
-// CONSTANTS
-
-const commentsPath = path.join(__dirname, 'comments.json');
-
-// SETUP AND TEARDOWN
-
-let originalComments;
-
-before(async () => {
-  originalComments = await fs.readFile(commentsPath, 'utf8').catch(() => null);
-});
-
-after(async () => {
-  if (originalComments !== null) {
-    await fs.writeFile(commentsPath, originalComments);
-  }
-  else {
-    await fs.unlink(commentsPath).catch(() => {});
-  }
-});
-
-// TESTS
-
-test('answer returns the tutorial page with status ok', async () => {
-  const result = await answer();
-  assert.equal(result.status, 'ok');
-  assert.ok(result.answerPage);
-  assert.ok(result.answerPage.length > 0);
-});
-
-test('handleComment returns an error for empty content', async () => {
-  const result = await handleComment('');
-  assert.equal(result.status, 'error');
-  assert.equal(result.message, 'No content provided');
-});
-
-test('handleComment returns an error for non-string content', async () => {
-  const result = await handleComment(null);
-  assert.equal(result.status, 'error');
-  assert.equal(result.message, 'No content provided');
-});
-
-test('handleComment returns an error for content that is empty after sanitization', async () => {
-  const result = await handleComment('<script></script>');
-  assert.equal(result.status, 'error');
-  assert.equal(result.message, 'Comment is empty after sanitization');
-});
-
-test('handleComment saves a sanitized comment and returns ok', {timeout: 500}, async () => {
-  // Replace comments with an empty array for a clean test.
-  await fs.writeFile(commentsPath, '[]\n');
-  const result = await handleComment('This is a <b>test</b> comment.');
-  assert.equal(result.status, 'ok');
-  const comments = JSON.parse(await fs.readFile(commentsPath, 'utf8'));
-  assert.equal(comments.length, 1);
-  assert.equal(comments[0].content, 'This is a test comment.');
-  assert.ok(comments[0].timeStamp);
-});
-
-test('handleComment strips HTML tags and control characters', {timeout: 500}, async () => {
-  await fs.writeFile(commentsPath, '[]\n');
-  const result = await handleComment('<img src=x onerror=alert(1)>\x00\x07Hello');
-  assert.equal(result.status, 'ok');
-  const comments = JSON.parse(await fs.readFile(commentsPath, 'utf8'));
-  assert.equal(comments[0].content, 'Hello');
-});
-
-test('handleComment truncates content to 500 characters', {timeout: 500}, async () => {
-  await fs.writeFile(commentsPath, '[]\n');
-  const longComment = 'x'.repeat(600);
-  const result = await handleComment(longComment);
-  assert.equal(result.status, 'ok');
-  const comments = JSON.parse(await fs.readFile(commentsPath, 'utf8'));
-  assert.equal(comments[0].content.length, 500);
-});
-
-test('handleComment creates comments.json when it does not exist', {timeout: 500}, async () => {
-  await fs.unlink(commentsPath).catch(() => {});
-  const result = await handleComment('Test comment for missing file');
-  assert.equal(result.status, 'ok');
-  const comments = JSON.parse(await fs.readFile(commentsPath, 'utf8'));
-  assert.equal(comments.length, 1);
-  assert.equal(comments[0].content, 'Test comment for missing file');
-});