WIP

build/mirrorUnpkg.js

@@ -1,4 +1,4 @@
-const fs = require('fs')
+import { writeFile } from 'node:fs/promises'
 
 const files = [
   'swagger-ui.css',
@@ -10,6 +10,6 @@ Promise.all(
   files.map(f =>
     fetch('https://unpkg.com/swagger-ui-dist@4.5.0/' + f)
       .then(res => res.text())
-      .then(text => fs.promises.writeFile('www_root/' + f, text))
+      .then(text => writeFile('www_root/' + f, text))
   )
 )

build/openAPIDoc.js

@@ -1,14 +1,15 @@
-const fs = require('fs')
-const swaggerJsdoc = require('swagger-jsdoc')
-const norchVersion = require('../package.json').version
+import { readFileSync, writeFileSync } from 'node:fs'
+import swaggerJsdoc from 'swagger-jsdoc'
+
+const version = JSON.parse(readFileSync('./package.json', 'utf8')).version
 
 const swaggerDefinition = {
   openapi: '3.0.1',
   info: {
     title: 'Norch',
     description:
       'This is the API documentation for `norch@' +
-      norchVersion +
+      version +
       '`. You can use this page to get familiar with what Norch can do. If you want to try out the API calls on a server other than `localhost`, fill out the server variable below in the input box labeled `URL`',
     contact: {
       email: 'fergus@norch.io'
@@ -17,7 +18,7 @@ const swaggerDefinition = {
     //   name: 'MIT',
     //   url: 'https://github.com/fergiemcdowall/search-index/blob/master/LICENSE'
     // },
-    version: norchVersion
+    version
   },
   externalDocs: {
     description: 'Find out more about Swagger',
@@ -281,8 +282,8 @@ const swaggerDefinition = {
   }
 }
 
-fs.writeFileSync(
-  'www_root/openapi-norch-' + norchVersion + '.json',
+writeFileSync(
+  'www_root/openapi-norch-' + version + '.json',
   JSON.stringify(
     swaggerJsdoc({
       swaggerDefinition,

package.json

@@ -42,7 +42,7 @@
   },
   "scripts": {
     "build-openapi-docs": "node build/mirrorUnpkg.js && node build/openAPIDoc.js && npm run lint",
-    "lint": "standard --fix src build",
+    "lint": "standard --fix src build test",
     "test": "export SANDBOX=test/sandbox && rm -rf $SANDBOX && mkdir $SANDBOX && date && tape test/*-test.js && npm run lint",
     "test-cli": "./bin/norch -p 9090 -i test/sandbox/norch-cli & sleep 5s && bats test/test.bats && kill $!",
     "start": "./bin/norch"

src/API.js

@@ -76,6 +76,8 @@ export class API {
       .DELETE(...this.params(req, 'ID'))
       .then(idxRes => this.sendJSONResponse(idxRes, res))
 
+  // TODO: DELETE_RAW?
+
   /**
    * @openapi
    * /DICTIONARY:
@@ -137,6 +139,8 @@ export class API {
       .DOCUMENTS(...this.params(req, 'ID'))
       .then(b => this.sendJSONResponse(b, res))
 
+  // TODO: DOCUMENT_VECTORS?
+
   /**
    * @openapi
    * /EXPORT:
@@ -514,17 +518,27 @@ export class API {
     ]).then(([LAST_UPDATED, CREATED, DOCUMENT_COUNT]) =>
       this.sendJSONResponse(
         {
-          IS_ALIVE: true,
+          READY: true,
           DOCUMENT_COUNT,
-          // Update these lines when https://github.com/fergiemcdowall/search-index/issues/600
-          // is rolled out
           CREATED: new Date(CREATED),
           LAST_UPDATED: new Date(LAST_UPDATED)
         },
         res
       )
     )
 
+  /**
+   * @openapi
+   * /READY:
+   *   get:
+   *     tags: [READ]
+   *     summary: Is index ready?
+   *     description: |
+   *       Returns `{ READY: true }` when index is ready
+   *     responses:
+   *       200:
+   *         description: Index is ready
+   */
   READY = (req, res) =>
     this.ready
       ? this.sendJSONResponse({ READY: true }, res)

src/Norch.js

@@ -10,7 +10,7 @@ import { resolve, dirname } from 'path'
 import figlet from 'figlet'
 
 export class Norch {
-  constructor(ops = {}) {
+  constructor (ops = {}) {
     const defaultConfigFile = JSON.parse(
       readFileSync('./src/defaultConfig.json', 'utf8')
     )

test/general-test.js

@@ -55,13 +55,15 @@ test('start a norch', async t => {
   await fetch('http://localhost:3030/STATUS')
     .then(res => res.json())
     .then(json =>
-      t.isEquivalent(
-        ['IS_ALIVE', 'DOCUMENT_COUNT', 'CREATED', 'LAST_UPDATED'],
-        Object.keys(json)
-      )
+      t.isEquivalent(Object.keys(json), [
+        'READY',
+        'DOCUMENT_COUNT',
+        'CREATED',
+        'LAST_UPDATED'
+      ])
     )
-    .catch(t.error)
 
+    .catch(t.error)
   await fetch('http://localhost:3030/PUT', {
     method: 'POST',
     body: JSON.stringify([

test/run-from-node-test.js

@@ -23,7 +23,7 @@ test('start a norch', async t => {
     .then(res => res.json())
     .then(json =>
       t.isEquivalent(
-        ['IS_ALIVE', 'DOCUMENT_COUNT', 'CREATED', 'LAST_UPDATED'],
+        ['READY', 'DOCUMENT_COUNT', 'CREATED', 'LAST_UPDATED'],
         Object.keys(json)
       )
     )

www_root/openapi-norch-1.0.0.json

@@ -659,7 +659,7 @@
         },
         "responses": {
           "200": {
-            "description": "Successfully imported"
+            "description": "Successfully written"
           }
         }
       }
@@ -774,6 +774,20 @@
           }
         }
       }
+    },
+    "/READY": {
+      "get": {
+        "tags": [
+          "READ"
+        ],
+        "summary": "Is index ready?",
+        "description": "Returns `{ READY: true }` when index is ready\n",
+        "responses": {
+          "200": {
+            "description": "Index is ready"
+          }
+        }
+      }
     }
   }
 }