chore: improve logging (#28)

.github/test-logging.js

@@ -0,0 +1,31 @@
+const http = require('http');
+const fs = require('fs');
+const process = require('process');
+
+const options = {
+    hostname: 'localhost',
+    port: 9090,
+    path: '/',
+    method: 'POST',
+};
+
+
+const req = http.request(options, res => {
+    const buf = fs.readFileSync('log.txt').toString();
+    const expect = `POST / "Hello World"\n`
+    if (expect !== buf) {
+        console.error(`expected ${expect}, but got ${buf}`);
+        process.exit(1);
+        return;
+    }
+})
+
+req.on('error', error => {
+    console.error(error);
+    process.exit(1);
+    return;
+});
+
+req.write('Hello World');
+
+req.end();

.github/workflows/push.yml

@@ -26,11 +26,8 @@ jobs:
             {
               "md": "text/markdown"
             }
-          log: "log.txt"
       -
-        run: |
-          node .github/test-default.js
-          cat log.txt
+        run: node .github/test-default.js
 
   test-index-files:
     strategy:
@@ -52,11 +49,8 @@ jobs:
           no-cache: true
           index-files: |
             ["PULL_REQUEST_TEMPLATE.md"]
-          log: "log.txt"
       -
-        run: |
-          node .github/test-index-files.js
-          cat log.txt
+        run: node .github/test-index-files.js
 
   test-allowed-methods:
     strategy:
@@ -78,23 +72,8 @@ jobs:
           no-cache: true
           allowed-methods: |
             ["POST"]
-          log: "log.txt"
       -
-        run: |
-          node .github/test-allowed-methods.js
-          cat log.txt
-
-  # draft your next release notes as pull requests are merged into "master"
-  # the configuration is at /.github/release-drafter.yml.
-  update_release_draft:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: release-drafter/release-drafter@v5
-        if: github.ref == 'refs/heads/master'
-        with:
-          config-name: release-drafter.yml
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: node .github/test-allowed-methods.js
   test-logging:
     strategy:
       matrix:
@@ -115,10 +94,20 @@ jobs:
           no-cache: true
           allowed-methods: |
             ["GET", "POST"]
-          log: "log.txt"
+          log: log.txt
+          logTime: false
       -
-        run: |
-          curl -vvvv http://localhost:9090/
-          curl --header "Content-Type: application/json" --request POST --data '[{"msg":"hello"},{"msg":"World"}]' http://localhost:9090/
-      - name: Show log
-        run: cat log.txt
+        run: node .github/test-logging.js
+
+
+  # draft your next release notes as pull requests are merged into "master"
+  # the configuration is at /.github/release-drafter.yml.
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        if: github.ref == 'refs/heads/master'
+        with:
+          config-name: release-drafter.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -38,7 +38,10 @@ Default:
 }
 ```
 ### `log`
-Create a log file with the given name (default is `off`) (*optional*)
+Create a log file with the given name (default is ``, which means no logging) (*optional*)
+
+### `logTime`
+Include the time of access in the log file (default is `true`) (*optional*)
 
 ## Example
 ```yaml
@@ -73,6 +76,7 @@ steps:
           "xml": "text/xml"
         }
       log: "log.txt"
+      logTime: "false"
   -
     run: |
       curl -vvvv http://localhost:8080/index.html

action.yml

@@ -49,7 +49,11 @@ inputs:
   log:
     description: 'Create a log file with given name'
     required: false
-    default: 'off'
+    default: ''
+  logTime:
+    description: 'Whether to include the time of access in the log file or not'
+    required: false
+    default: true
 runs:
   using: 'node16'
   main: 'main.js'

main.js

@@ -33,7 +33,8 @@ let config = {
     indexFiles: null,
     allowedMethods: null,
     contentTypes: null,
-    log: null
+    log: null,
+    logTime: null
 };
 
 config.root = core.getInput('directory');
@@ -96,6 +97,13 @@ if (config.allowedMethods === null || config.allowedMethods.length == 0) {
 
 config.log = core.getInput("log");
 
+config.logTime = core.getInput('logTime');
+if (config.logTime === null || config.logTime.length == 0) {
+    config.logTime = true;
+} else {
+    config.logTime = config.logTime === 'true';
+}
+
 const cp = require('child_process');
 const child = cp.fork(__filename, ['serve'], { detached: true, silent: true });
 child.on('error', (err) => {