aiiinotate 0.2.13 → 0.2.15

package/config/.env.template

@@ -8,12 +8,14 @@ MONGODB_PORT=27017
 MONGODB_DB=aiiinotate
 
 # HTTP port for the app
-APP_PORT=4000
-# URL for the app, inclding port
-APP_HOST=http://127.0.0.1
+AIIINOTATE_PORT=4000
+# URL for the app
+AIIINOTATE_HOST=127.0.0.1
+# HTTP scheme: HTTP or HTTPS. should be HTTP in dev and in docker
+AIIINOTATE_SCHEME=http
 
 # IGNORE
-APP_BASE_URL="$APP_HOST:$APP_PORT"
+AIIINOTATE_BASE_URL="$AIIINOTATE_SCHEME://$AIIINOTATE_HOST:$AIIINOTATE_PORT"
 # IGNORE
 MONGODB_CONNSTRING="mongodb://$MONGODB_HOST:$MONGODB_PORT/$MONGODB_DB"
 # IGNORE

package/docker/README.md

@@ -58,5 +58,5 @@ sudo docker exec -it docker-web-1 npm list -g --depth=0
 CURL the Web container
 
 ```bash
-sudo docker exec -it docker-web-1 curl http://0.0.0.0:4444   # change 4444 by your $APP_PORT
+sudo docker exec -it docker-web-1 curl http://0.0.0.0:4444   # change 4444 by your $AIIINOTATE_PORT
 ```

package/docker/docker-compose.yaml

@@ -19,11 +19,12 @@ services:
       context: ..
       dockerfile: docker/Dockerfile
       args:
-        PORT: ${APP_PORT}
+        PORT: ${AIIINOTATE_PORT}
+    # NOTE: be careful to point to docker/.env, not to config/.env, otherwise you will have very, very annoying errors.
     env_file:
-      - ../config/.env
+      - ../docker/.env
     ports:
-      - "${APP_PORT}:${APP_PORT}"
+      - "${AIIINOTATE_PORT}:${AIIINOTATE_PORT}"
     depends_on:
       - mongo
     networks:

package/docker/docker.sh

@@ -45,7 +45,7 @@ env_to_docker() {
     # NOTE that the MongoDB host in Docker MUST BE the name of the Mongo docker service (defined in docker-compose)
     cp "$ENV_CONFIG" "$ENV_DOCKER";
     sed_repl s~^MONGODB_HOST=.*$~MONGODB_HOST=mongo~ "$ENV_DOCKER";
-    sed_repl s~^APP_HOST=.*~APP_HOST=0.0.0.0~ "$ENV_DOCKER";
+    sed_repl s~^AIIINOTATE_HOST=.*~AIIINOTATE_HOST=0.0.0.0~ "$ENV_DOCKER";
 }
 env_to_docker;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aiiinotate",
-  "version": "0.2.13",
+  "version": "0.2.15",
   "description": "a fast IIIF-compliant annotation server",
   "main": "./cli/index.js",
   "type": "module",

package/src/app.js

@@ -45,7 +45,7 @@ const defaultConfig = {
 //     },
 //     servers: [
 //       {
-//         url: process.env.APP_BASE_URL,
+//         url: process.env.AIIINOTATE_BASE_URL,
 //         description: "Aiiinotate URL"
 //       }
 //     ],
@@ -67,7 +67,7 @@ const defaultConfig = {
 //   //     url: 'https://swagger.io',
 //   //     description: 'Find more info here'
 //   //   },
-//   //   host: process.env.APP_BASE_URL.replace(/^http(s)?\:\/\//g, ""),  // process.env.APP_BASE_URL,
+//   //   host: process.env.AIIINOTATE_BASE_URL.replace(/^http(s)?\:\/\//g, ""),  // process.env.AIIINOTATE_BASE_URL,
 //   //   schemes: [ "http", "https" ],
 //   //   consumes: ['application/json'],
 //   //   produces: ['application/json'],

package/src/data/annotations/routes.test.js

@@ -41,7 +41,7 @@ test("test annotation Routes", async (t) => {
 
   // NOTE: it is necessary to run the app because internally there are fetches to external data.
   try {
-    await fastify.listen({ port: process.env.APP_PORT, host: process.env.APP_HOST });
+    await fastify.listen({ port: process.env.AIIINOTATE_PORT, host: process.env.AIIINOTATE_HOST });
   } catch (err) {
     console.log("FASTIFY ERROR", err);
     throw err;
@@ -158,8 +158,8 @@ test("test annotation Routes", async (t) => {
         const
           annotationIdQuery =
             shouldExist
-              ? annotationId.replace(process.env.APP_BASE_URL, "")
-              : annotationId.replace(process.env.APP_BASE_URL, "") + "string_that_does_not_exist_in_the_db",
+              ? annotationId.replace(process.env.AIIINOTATE_BASE_URL, "")
+              : annotationId.replace(process.env.AIIINOTATE_BASE_URL, "") + "string_that_does_not_exist_in_the_db",
           r = await fastify.inject({
             method: "GET",
             url: annotationIdQuery

package/src/data/manifests/manifests2.js

@@ -289,7 +289,7 @@ class Manifests2 extends CollectionAbstract {
     return {
       ...IIIF_PRESENTATION_2_CONTEXT,
       "@type": "sc:Collection",
-      "@id": `${process.env.APP_BASE_URL}/manifests/2`,
+      "@id": `${process.env.AIIINOTATE_BASE_URL}/manifests/2`,
       label: "Collection of all manifests indexed in the annotation server",
       members: manifestIndex
     }

package/src/data/manifests/manifests2.test.js

@@ -27,7 +27,7 @@ test("test Manifests2 module", async (t) => {
 
   // NOTE: it is necessary to run the app because internally there are fetches to external data.
   try {
-    await fastify.listen({ port: process.env.APP_PORT, host: process.env.APP_HOST });
+    await fastify.listen({ port: process.env.AIIINOTATE_PORT, host: process.env.AIIINOTATE_HOST });
   } catch (err) {
     console.log("FASTIFY ERROR", err);
     throw err;

package/src/data/manifests/routes.test.js

@@ -30,7 +30,7 @@ test("test manifests Routes", async (t) => {
 
   // NOTE: it is necessary to run the app because internally there are fetches to external data.
   try {
-    await fastify.listen({ port: process.env.APP_PORT, host: process.env.APP_HOST });
+    await fastify.listen({ port: process.env.AIIINOTATE_PORT, host: process.env.AIIINOTATE_HOST });
   } catch (err) {
     console.log("FASTIFY ERROR", err);
     throw err;

package/src/data/routes.test.js

@@ -26,7 +26,7 @@ test("test common routes", async (t) => {
 
   // NOTE: it is necessary to run the app because internally there are fetches to external data.
   try {
-    await fastify.listen({ port: process.env.APP_PORT, host: process.env.APP_HOST });
+    await fastify.listen({ port: process.env.AIIINOTATE_PORT, host: process.env.AIIINOTATE_HOST });
   } catch (err) {
     console.log("FASTIFY ERROR", err);
     throw err;

package/src/data/utils/iiif2Utils.js

@@ -150,10 +150,10 @@ const makeAnnotationId = (annotation, manifestShortId) => {
  * @returns {string}
  */
 const annotationUri = (manifestShortId, canvasId) =>
-  `${process.env.APP_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/annotation/${canvasId}_${uuid4()}`;
+  `${process.env.AIIINOTATE_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/annotation/${canvasId}_${uuid4()}`;
 
 const manifestUri = (manifestShortId) =>
-  `${process.env.APP_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/manifest.json`;
+  `${process.env.AIIINOTATE_BASE_URL}/data/${IIIF_PRESENTATION_2}/${manifestShortId}/manifest.json`;
 
 /**
  * if `canvasUri` follows the recommended IIIF 2.1 recommended URI pattern, convert it to a JSON manifest URI.

package/src/data/utils/iiif2Utils.test.js

@@ -88,7 +88,7 @@ test("test 'iiif2Utils' functions", async (t) => {
     const escapeRegExp = (string) =>
       string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
 
-    const rgx = new RegExp(`^${escapeRegExp(process.env.APP_BASE_URL)}/data/2/[^(\\s|/)]+/annotation/[^\\.]+$`);
+    const rgx = new RegExp(`^${escapeRegExp(process.env.AIIINOTATE_BASE_URL)}/data/2/[^(\\s|/)]+/annotation/[^\\.]+$`);
     annotations2Valid.map((annotation) =>
       t.assert.strictEqual(rgx.test(makeAnnotationId(annotation)), true));
     annotations2Invalid.map((annotation) =>

package/src/data/utils/utils.js

@@ -135,7 +135,7 @@ const maybeToArray = (x, convertedFlag=false) =>
     : Array.isArray(x) ? x : [x];
 
 const pathToUrl = (path) =>
-  `${process.env.APP_BASE_URL}${path}`
+  `${process.env.AIIINOTATE_BASE_URL}${path}`
 
 /**
  * display a detailed and nested view of an object. to be used with console.log.

package/src/fileServer/utils.js

@@ -25,7 +25,7 @@ const readFileToObject = (fn) => {
  * @param {string} fn
  * @returns {string}
  */
-const toUrl = (fn) => `${process.env.APP_BASE_URL}/fileServer/${fn}`;
+const toUrl = (fn) => `${process.env.AIIINOTATE_BASE_URL}/fileServer/${fn}`;
 
 
 export {

package/src/schemas/schemasBase.js

@@ -4,7 +4,7 @@ import fastifyPlugin from "fastify-plugin"
 
 /** @param {"search"|"presentation"} slug */
 const makeSchemaUri = (slug) =>
-  `${process.env.APP_BASE_URL}/schemas/${slug}/version`;
+  `${process.env.AIIINOTATE_BASE_URL}/schemas/${slug}/version`;
 
 /**
  * @param {FastifyInstanceType} fastify

package/src/schemas/schemasPresentation2.js

@@ -55,7 +55,7 @@ const embeddedBodyTypeValues = [
 
 /** @param {string} slug */
 const makeSchemaUri = (slug) =>
-  `${process.env.APP_BASE_URL}/schemas/presentation/${IIIF_PRESENTATION_2}/${slug}`
+  `${process.env.AIIINOTATE_BASE_URL}/schemas/presentation/${IIIF_PRESENTATION_2}/${slug}`
 
 /**
  * @param {FastifyInstanceType} fastify

package/src/schemas/schemasPresentation3.js

@@ -6,7 +6,7 @@ import { IIIF_PRESENTATION_3, IIIF_PRESENTATION_3_CONTEXT } from "#utils/iiifUti
 
 /** @param {string} slug */
 const makeSchemaUri = (slug) =>
-  `${process.env.APP_BASE_URL}/schemas/presentation/${IIIF_PRESENTATION_3}/${slug}`
+  `${process.env.AIIINOTATE_BASE_URL}/schemas/presentation/${IIIF_PRESENTATION_3}/${slug}`
 
 /**
  * @param {FastifyInstanceType} fastify

package/src/schemas/schemasRoutes.js

@@ -9,7 +9,7 @@ import fastifyPlugin from "fastify-plugin";
 
 /** @param {string} slug */
 const makeSchemaUri = (slug) =>
-  `${process.env.APP_BASE_URL}/schemas/routes/${slug}`;
+  `${process.env.AIIINOTATE_BASE_URL}/schemas/routes/${slug}`;
 
 /**
  * @param {FastifyInstanceType} fastify

package/src/server.js

@@ -3,7 +3,6 @@
  */
 
 import build from "#src/app.js";
-import { visibleLog } from "#utils/utils.js";
 
 /**
  * @param {import("#types").RerveModeType} serveMode
@@ -14,13 +13,8 @@ async function server (serveMode) {
   }
 
   const fastify = await build(serveMode);
-
-  visibleLog([process.env.APP_HOST, process.env.APP_PORT], "PRE:");
-  process.env.APP_HOST = "0.0.0.0";
-  visibleLog([process.env.APP_HOST, process.env.APP_PORT], "POST:");
-
   try {
-    fastify.listen({ port: process.env.APP_PORT, host: process.env.APP_HOST });
+    fastify.listen({ port: process.env.AIIINOTATE_PORT, host: process.env.AIIINOTATE_HOST });
   } catch(err) {
     fastify.log.error(err);
     process.exit(1);