Spring Cleaning → removing obsolete stuff, and moved non-app things to ./etc (#810)

* Remove obsolete stuff, and moved non-app things to ./etc * remove test * Update package-lock --------- Co-authored-by: Christian Georgi <christian.georgi@sap.com>
2025-03-12 10:37:47 +01:00
parent c1dbe94c64
commit bbaaefae5b
30 changed files with 33 additions and 259 deletions
--- a/etc/data-viewer/app/viewer/app.js
+++ b/etc/data-viewer/app/viewer/app.js
@@ -0,0 +1,119 @@
+/* global Vue axios */ //> from vue.html
+const GET = (url) => axios.get('/odata/v4/-data'+url)
+const storageGet = (key, def) => localStorage.getItem('data-viewer:'+key) || def
+const storageSet = (key, val) => localStorage.setItem('data-viewer:'+key, val)
+const columnKeysFirst = (c1, c2) => {
+  if (c1.isKey  && !c2.isKey) return -1
+  if (!c1.isKey && c2.isKey) return 1
+  if (c1.isKey && c2.isKey) return c1.name.localeCompare(c2.name)
+  return 0 // retain natural order of normal columns
+}
+
+const vue = Vue.createApp ({
+
+  data() { return {
+    error: undefined,
+    dataSource: storageGet('data-source', 'db'),
+    skip: storageGet('skip', 0),
+    top: storageGet('top', 20),
+    entity: storageGet('entity') ? JSON.parse(storageGet('entity')) : undefined,
+    entities: [],
+    columns: [],
+    data: [],
+    rowDetails: {},
+    rowKey: storageGet('rowKey')
+  }},
+
+  watch: {
+    dataSource: (v) => { storageSet('data-source', v);  vue.fetchEntities() },
+    skip: (v) => { storageSet('skip', v); if (vue.entity)  vue.fetchData() },
+    top:  (v) => { storageSet('top',  v); if (vue.entity)  vue.fetchData() },
+  },
+
+  methods: {
+
+    async fetchEntities () {
+      let url = `/Entities`
+      if (vue.dataSource === 'db')  url += `?dataSource=db`
+      const {data} = await GET(url)
+      vue.entities = data.value
+      vue.entities.forEach(entity => entity.columns.sort(columnKeysFirst))
+      const entity = vue.entity && vue.entities.find(e => e.name === vue.entity.name)
+      if (entity) { // restore selection from previous fetch
+        vue.columns = entity.columns
+        await vue.fetchData(entity)
+      } else {
+        vue.entity = undefined
+        vue.columns = []
+        vue.data = []
+        vue.rowDetails = {}
+      }
+    },
+
+    async inspectEntity (eve) {
+      const entity = vue.entity = vue.entities [eve.currentTarget.rowIndex-1]
+      storageSet('entity', JSON.stringify(entity))
+      vue.columns = vue.entities.find(e => e.name === entity.name).columns
+      return await this.fetchData()
+    },
+
+    async fetchData () {
+      let url = `/Data?entity=${vue.entity.name}&$skip=${vue.skip}&$top=${vue.top}`
+      if (vue.dataSource === 'db')  url += `&dataSource=db`
+
+      try {
+        const {data} = await GET(url)
+        // sort data along column order
+        const columnIndexes = {}
+        vue.columns.forEach((col, i) => columnIndexes[col.name] = i)
+        vue.data = data.value.map(d => d.record
+          .sort((r1, r2) => columnIndexes[r1.column] - columnIndexes[r2.column])
+          .map(r => r.data)
+        )
+        const row = vue.data.find(data => vue._makeRowKey(data) === vue.rowKey)
+        if (row)  vue._setRowDetails(row)
+        else vue.rowDetails = {}
+        vue.error = undefined
+      } catch (err) {
+        vue.data = []
+        vue.rowDetails = {}
+        if (err.response?.data?.error) {
+          vue.error = err.response.data.error
+        } else {
+          vue.error = { code:err.code, message:err.message }
+        }
+      }
+
+    },
+
+    inspectRow (eve) {
+      vue.rowDetails = {}
+      const selectedRow = eve.currentTarget.rowIndex-1
+      vue.rowKey = vue._makeRowKey(vue.data[selectedRow])
+      storageSet('rowKey', vue.rowKey)
+      vue._setRowDetails(vue.data[selectedRow])
+    },
+
+    _setRowDetails(row) {
+      vue.rowDetails = {}
+      row.forEach((line, colIndex) => {
+        vue.rowDetails[vue.columns[colIndex].name] = line
+      })
+    },
+
+    _makeRowKey(row) {
+      // to identify a row, build a key string out of all key columns' values
+      return row
+        .filter((_, colIndex) => vue.columns[colIndex] && vue.columns[colIndex].isKey)
+        .reduce(((prev, next) => prev += next), '')
+    },
+
+    isActiveRow(row) {
+      return vue._makeRowKey(row) === vue.rowKey
+    }
+
+  }
+})
+.mount('#app')
+
+vue.fetchEntities()
--- a/etc/data-viewer/app/viewer/index.html
+++ b/etc/data-viewer/app/viewer/index.html
@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <title>Data Browser</title>
+  <link rel="stylesheet" href="https://unpkg.com/primitive-ui/dist/css/main.css">
+  <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/vue@3/dist/vue.global.prod.js"></script>
+  <script src="app.js" defer></script>
+
+  <style>
+    th { position: sticky; top:0; z-index: 2; background-color: white; }
+    .noscroll { overflow: hidden; }
+    .hovering tr:hover td { background: #ebeefc; cursor: pointer; }
+    .highlight { background: #ebeefc !important; }
+    .rating-stars { color:teal }
+    .succeeded { color:teal }
+    .failed { color:red }
+    .condensed { max-width: 100px; text-overflow: ellipsis; white-space: nowrap; }
+    .key { font-weight: bold }
+    .not-key { font-weight: lighter;}
+    .with-sidebar { display: flex; flex-wrap: wrap; gap: 1rem; }
+    .sidebar    { flex-basis: 20rem; flex-grow: 1; }
+    .sidebar-main { height: 100vh; overflow-y: scroll; }
+    .not-sidebar  { flex-basis: 0; flex-grow: 999; min-inline-size: 50%; align-items: stretch;}
+    .not-sidebar-main { max-height: 40vh; overflow-y: scroll; }
+    .not-sidebar-sub {  max-height: 40vh; overflow-y: scroll; }
+    .horizontal label { display: inline; }
+    .horizontal input { width: initial; display: inline; }
+    .error { color: red; }
+  </style>
+</head>
+
+<body class="noscroll">
+<div id='app' class="full-container">
+
+  <h1>Data Browser &ndash; {{ entity ? entity.name : '' }}</h1>
+
+  <div class="with-sidebar">
+    <div class="sidebar">
+      <div class="horizontal" style="padding: 0.75rem 0;">
+        <label>Datasource:</label>
+        <input type="radio" id="dataSource-db" value="db" v-model="dataSource">
+        <label for="dataSource-db">Database</label>
+        <input type="radio" id="dataSource-srv" value="service" v-model="dataSource">
+        <label for="dataSource-srv">Service</label>
+      </div>
+      <div class="sidebar-main">
+        <table id='entities' class="hovering">
+          <thead>
+            <th>Entity Name</th>
+          </thead>
+          <tr v-for="e in entities" :key="e.name" @click="inspectEntity" :class="{'highlight': (entity && e.name === entity.name)}">
+            <td>{{ e.name }}</td>
+          </tr>
+        </table>
+      </div>
+    </div>
+
+    <div class="not-sidebar">
+      <div class="horizontal">
+        <label for="skip">Skip:</label>
+        <input id="skip" v-model.lazy="skip" title="No. of entries to skip" type="number" min="0">
+        <label for="top">Top:</label>
+        <input id="top" v-model.lazy="top" title="No. of entries to read" type="number" min="0">
+      </div>
+      <div v-if="data" class="not-sidebar-main">
+        <table id='data' class="hovering striped-table condensed">
+          <thead>
+            <th v-for="col in columns" :title="col.type" :class="[col.isKey ? 'key' : 'not-key']">{{ col.name }} </th>
+          </thead>
+          <tr v-for="row in data" @click="inspectRow" :class="{'highlight': isActiveRow(row)}">
+            <td v-for="d in row" :title="d">{{ d }}</td>
+          </tr>
+        </table>
+      </div>
+      <div v-if="error" class="not-sidebar-main error">
+        Error: {{ error.code ? error.code + ' &ndash; ' + error.message : error.message }}
+      </div>
+      <p></p>
+      <div v-if="rowDetails"  class="not-sidebar-sub">
+        <table id='rowDetails'>
+          <tr v-for="(key, value) in rowDetails" >
+            <td class="key">{{ value }}</td>
+            <td>{{ key }}</td>
+          </tr>
+        </table>
+      </div>
+    </div>
+  </div>
+
+</div>
+</body>
+
+</html>
--- a/etc/data-viewer/index.cds
+++ b/etc/data-viewer/index.cds
@@ -0,0 +1 @@
+using from './srv/data-service';
--- a/etc/data-viewer/package.json
+++ b/etc/data-viewer/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "@capire/data-viewer",
+  "version": "0.1.0",
+  "description": "A generic browser for data",
+  "dependencies": {
+    "@sap/cds": ">=5.0.4"
+  },
+  "files": [
+    "app",
+    "srv",
+    "index.cds"
+  ]
+}
--- a/etc/data-viewer/srv/data-service.cds
+++ b/etc/data-viewer/srv/data-service.cds
@@ -0,0 +1,30 @@
+/**
+ * Exposes data + entity metadata
+ */
+@requires:'authenticated-user'
+@odata service DataService @( path:'-data' ) {
+
+  /**
+   * Metadata like name and columns/elements
+   */
+  entity Entities @cds.persistence.skip {
+    key name : String;
+    columns: Composition of many {
+      name :  String;
+      type :  String;
+      isKey:  Boolean;
+    }
+  }
+
+  /**
+   * The actual data, organized by column name
+   */
+  entity Data @cds.persistence.skip {
+    key ID   : String;   // to be OData-compliant
+    record   : array of {
+      column : String;
+      data   : String;
+    }
+  }
+
+}
--- a/etc/data-viewer/srv/data-service.js
+++ b/etc/data-viewer/srv/data-service.js
@@ -0,0 +1,63 @@
+const cds = require('@sap/cds')
+const log = cds.log('data')
+
+class DataService extends cds.ApplicationService { init(){
+
+  this.on ('READ', 'Entities', req => {
+    const { dataSource } = req.req.query
+    const srvPrefixes = cds.db.model.all('service').map(srv => srv.name+'.')
+    const dataSourceFilter = dataSource === 'db'
+      ? e => e['@cds.persistence.skip'] !== true // for DB, excl. entities w/o persistence
+      : e => !!srvPrefixes.find(srvName => e.name.startsWith(srvName)) // only entities reachable from a service
+
+    return cds.db.model.all('entity')
+      .filter (e => req.data && req.data.name ? e.name === req.data.name : true)  // honor name filter from request, if any
+      .filter (e => !e.name.startsWith('DRAFT.'))  // exclude synthetic stuff
+      .filter (e => !e.name.startsWith('DataService.'))  // exclude this service
+      .filter (dataSourceFilter)
+      .sort((e1, e2) => e1.name.localeCompare(e2.name))
+      .map(e => {
+        const columns = Object.entries(e.elements)
+          .filter(([,el]) => !(el instanceof cds.Association)) // exclude assocs+compositions
+          .map(([name, el]) => { return { name, type: el.type, isKey:!!el.key }})
+        return { name: e.name, columns }
+      })
+    })
+
+  this.on ('READ', 'Data', async req => {
+    const { entity: entityName, dataSource: dataSourceName } = req.req.query
+    if (!entityName)  return req.reject(400, `Must provide 'entity' query`)
+    const entity = cds.db.model.definitions[entityName]
+    if (!entity)  return req.reject(404, 'No such entity: ' + entityName)
+
+    const query = SELECT.from(entity)
+    query.SELECT.limit = req.query.SELECT.limit  // forward $skip / $top
+
+    const dataSource = findDataSource(dataSourceName, entityName)
+    let res = await dataSource.run(query)
+    if (!Array.isArray(res))  res = [res] // singleton result
+    return res.map((line) => {
+      const record = Object.entries(line).map(([column, data]) => ({ column, data }))
+      return {
+        record,
+        ID: cds.utils.uuid() // just to be OData-compliant
+      }
+    })
+  })
+
+  return super.init()
+}}
+
+module.exports = { DataService }
+
+/** @returns {cds.Service} */
+function findDataSource(dataSourceName, entityName) {
+  for (let srv of Object.values(cds.services)) { // all connected services
+    if (!srv.name)  continue // FIXME intermediate/pending in cds.services ?
+    if (dataSourceName === srv.name || entityName.startsWith(srv.name+'.')) {
+      log._debug && log.debug(`using ${srv.name} as data source`)
+      return srv
+    }
+  }
+  return cds.services.db // fallback
+}
--- a/etc/loggers/app/loggers.html
+++ b/etc/loggers/app/loggers.html
@@ -0,0 +1,76 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <title> cds.log </title>
+  <link rel="stylesheet" href="https://unpkg.com/primitive-ui/dist/css/main.css">
+  <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/vue@3/dist/vue.global.prod.js"></script>
+  <style>
+    select { border-color: transparent; padding: 4px 12px; margin: 0px; }
+    button { padding: 2px 11px; margin: 0px 4px; font: 90% italic; }
+  </style>
+</head>
+
+<body class="small-container" , style="margin-top: 70px;">
+  <div id='app'>
+    <h1> Log Levels </h1>
+    <input type="text" placeholder="Search by ID or Log Level..." @input="fetch">
+    <table id='loggers'>
+      <thead>
+        <th> Module ID </th>
+        <th> Log Level </th>
+      </thead>
+      <tr v-for="each in list">
+        <td>{{ each.id }}</td>
+        <td><select v-bind:id="each.id" v-model="each.level" @change="set">
+            <option>SILENT</option>
+            <option>ERROR</option>
+            <option>WARN</option>
+            <option>INFO</option>
+            <option>DEBUG</option>
+            <option>TRACE</option>
+          </select>
+        </td>
+      </tr>
+    </table>
+    <h4>Log Format:</h4>
+    [ <button class="round-button" :class={'muted-button':!format.timestamp} @click="toggle_format" id="timestamp">Timestamp </button>
+    | <button class="round-button" :class={'muted-button':!format.level} @click="toggle_format" id="level">Log Level </button>
+    | <button class="round-button" :class={'muted-button':!format.tenant} @click="toggle_format" id="tenant">Tenant </button>
+    | <button class="round-button" :class={'muted-button':!format.reqid} @click="toggle_format" id="reqid">Request ID </button>
+    | <button class="round-button" :class={'muted-button':!format.id} @click="toggle_format" id="module">Logger ID </button>
+    ] - <i>log message ...</i>
+  </div>
+</body>
+
+<script>
+  axios.defaults.headers['Content-Type'] = 'application/json'
+  axios.defaults.baseURL = '/log'
+  const loggers = Vue.createApp({ el: '#app',
+  data() {
+      return {
+        format: { timestamp:false, level:false, tenant:false, reqid:false, id:true, },
+        list: [],
+      }
+    },
+    methods: {
+      async fetch (eve) {
+        this.list = (await axios.get (`/Loggers${
+          eve && eve.target.value ? `?$search=${eve.target.value}` : ''
+        }`)).data
+      },
+      async set (eve) {
+        const { id, value:level } = eve.target
+        await axios.put (`/Logger/${id}`, {id,level})
+      },
+      async toggle_format (eve) {
+        this.format[eve.target.id] = !this.format[eve.target.id]
+        await axios.post (`/format`, this.format)
+      },
+    },
+  }).mount('#app')
+  loggers.fetch() // initially fill list of loggers
+</script>
+
+</html>
--- a/etc/loggers/package.json
+++ b/etc/loggers/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "@capire/loggers",
+  "version": "1.0.0",
+  "description": "Simple sample on how to dynamically set cds.log levels and formats.",
+  "files": [
+    "app",
+    "srv"
+  ],
+  "dependencies": {
+    "@sap/cds": ">=5.9",
+    "express": "^4.17.1"
+  },
+  "scripts": {
+    "start": "cds-serve",
+    "watch": "cds watch"
+  }
+}
--- a/etc/loggers/readme.md
+++ b/etc/loggers/readme.md
@@ -0,0 +1,11 @@
+# Dynamically Set `cds.log` Levels and Formats
+
+### Run 
+
+```sh
+cds watch
+```
+
+### Test
+
+Either using the UI through http://localhost:4004/loggers.html, or try the requests in `test/requests.http`
--- a/etc/loggers/srv/dummy.cds
+++ b/etc/loggers/srv/dummy.cds
@@ -0,0 +1,3 @@
+service Sue {
+  entity Dummy { key ID: UUID; title: String; }
+}
--- a/etc/loggers/srv/loggers.cds
+++ b/etc/loggers/srv/loggers.cds
@@ -0,0 +1,20 @@
+@rest service LogService {
+
+  @readonly entity Loggers : Logger {};
+  entity Logger {
+    key id : String;
+    level  : String;
+  }
+
+  action format (
+    timestamp : Boolean,
+    level     : Boolean,
+    tenant    : Boolean,
+    reqid     : Boolean,
+    id        : Boolean,
+  );
+
+  action debug (logger : String) returns Logger;
+  action reset (logger : String) returns Logger;
+
+}
--- a/etc/loggers/srv/loggers.js
+++ b/etc/loggers/srv/loggers.js
@@ -0,0 +1,56 @@
+const cds = require ('@sap/cds')
+const LOG = cds.log('cds.log')
+
+module.exports = class LogService extends cds.Service {
+  init(){
+
+    this.on('GET','Loggers', (req)=>{
+      let loggers = Object.values(cds.log.loggers).map (_logger)
+      let {$search} = req._.req.query
+      if ($search) {
+        const re = RegExp($search,'i')
+        loggers = loggers.filter (l => re.test(l.id) || re.test(l.level))
+      }
+      return loggers.sort ((a,b) => a.id < b.id ? -1 : 1)
+    })
+
+    this.on('PUT','Logger', (req)=>{
+      const {id} = req.params[0] || req.data
+      if (!id) return req.reject('No logger id specified in request')
+      return _logger (cds.log (id, req.data))
+    })
+
+    this.on('debug', (req)=>{
+      const {logger:id} = req.params[0] || req.data
+      if (!id) return req.reject('No logger id specified in request')
+      return _logger (cds.log (id, {level:'debug'}))
+    })
+
+    this.on('reset', (req)=>{
+      const {logger:id} = req.params[0] || req.data
+      if (!id) return req.reject('No logger id specified in request')
+      return _logger (cds.log (id, {level:'info'}))
+    })
+
+    this.on('format', (req)=>{
+      const $ = req.data; LOG.info('format:',$)
+      // Set format for new loggers constructed subsequently
+      cds.log.format = (id, level, ...args) => {
+        const fmt = []
+        if ($.timestamp) fmt.push ('|', (new Date).toISOString())
+        if ($.level) fmt.push ('|', _levels[level].padEnd(5))
+        if ($.tenant) fmt.push ('|', cds.context && cds.context.tenant)
+        if ($.reqid) fmt.push ('|', cds.context && cds.context.id)
+        if ($.id) fmt.push ('|', id)
+        fmt[0] = '[', fmt.push ('] -', ...args)
+        return fmt
+      }
+      // Apply this format to all existing loggers
+      Object.values(cds.log.loggers).forEach (l => l.setFormat (cds.log.format))
+    })
+  }
+
+}
+
+const _logger = ({id,level}) => ({id, level:_levels[level] })
+const _levels = [ 'SILENT', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE' ]
--- a/etc/loggers/test/requests.http
+++ b/etc/loggers/test/requests.http
@@ -0,0 +1,18 @@
+http://localhost:4004/loggers.html
+@body: = Content-Type: application/json\n\n
+
+###
+GET http://localhost:4004/log/Loggers
+
+###
+PUT http://localhost:4004/log/Logger/sqlite
+{{body:}} { "level": "debug" }
+
+###
+POST http://localhost:4004/log/debug(logger='sqlite')
+
+###
+POST http://localhost:4004/log/reset(logger='sqlite')
+
+### Dummy request to see sqlite debug output
+GET http://localhost:4004/sue/Dummy