sap-archive / xsk Goto Github PK

Compatible environment for SAP HANA Extended Application Services (XS) based applications outside of SAP HANA instance running in a container deployed on Kubernetes

License: Apache License 2.0

Dockerfile 0.17% HTML 2.09% Java 91.73% JavaScript 4.54% Shell 0.07% ANTLR 1.33% Mustache 0.06% Smarty 0.01% XSLT 0.01%

xsk's Introduction

Important Notice

This public repository is read-only and no longer maintained.

Project "XSK"

Description

Compatible environment for SAP HANA Extended Application Services (XS) based applications. It is deployed outside of SAP HANA instance as a Docker a container on Kubernetes. Hence, some of the features can work against any other JDBC compliant RDBMS such as PostgreSQL. The compatibility stack is an extension of the Eclipse Dirigible cloud development platform.

Note: the project is not yet ready to be used productively

Background

In the SAP Cloud Platform Neo environment XS classic programming model (XSC) is supported via the HANA 1.x database. The XSC engine resides in the HANA system itself. It can scale up, but cannot scale out. It is based on the multi-threaded JavaScript runtime Mozilla Spydermonkey (Firefox's engine). It supports synchronous programming model. It can serve backend services in JavaScript, HTML5 and other static content. It supports OData v2.0 compatible services defined in an *.xsodata descriptors. It supports automatic tables, views, calculationviews materialisation based on proprietary formats.

XSK approach is to provide a custom Eclipse Dirigible stack coming with XSC engine type. This engine is based on the standard Dirigible's JavaScript engine with several enhancements such as predefined XSC API pre-loaded ($.* APIs), execution based on *.xsjs instead of *.js only, imports based on *.xsjslib instead of *.js.

There are corresponding APIs in Dirigible playing the same role as the ones in XSC (e.g. request, response, connection, etc.). A thin XSC bridge is provided for full compatibility.

The programming model is synchronous in multi-threaded environment (based on GraalJS). The descriptors for the table, views and calculationviews currently exists with the same life-cycle management, only the format is different. OData via descriptor approach is also available as part of the stack as well.

XSK stack is based on Java (JVM), so all the available plugins and/or new frameworks from Apache, Eclipse, and other open source providers can be easily integrated as well.

XSK stack can run within the HANA box, also in the virtual HANA system or outside in e.g. Kubernetes cluster, Kyma, Cloud Foundry, Open Stack.

Requirements

Maven 3.6.2 or later
Access to SAP BTP account
Access to SAP HANA Cloud instance

Download and Installation

git clone https://github.com/SAP/xsk
cd xsk
mvn clean install

FAQ

How long will XSK be supported by SAP?

XSK is an open source project with community support as of now. Everyone can join and make a PR.
Should future developments be based on XSK?

Yes, you can use XSK for future development.
What about the tooling? Do we get state of the art tooling for maintaining and enhancing XSK?

XSK tooling is based on Eclipse Dirigible and in the near future it will be possible to maintain XSK projects with any modern IDE like VSCode, Eclipse Theia, etc.
What about the ops aspects - will XSK be smoothly integrated into a state-of-the-art lifecycle and ops management (be it SAP-based or non-SAP based like GitHub Actions?

Yes, the XSK itself uses GitHub actions for CI/CD
Will there be limitations that will not be mitigated?

You can get the up-to-date list of covered features as well as the limitations

Cheat Sheet

Visit the cheat sheet here.

Readiness

Visit the readiness page here.

How to obtain support

All the bug reports as well as the feature requests have to be registered as issues.

Contributing

If you want to contribute, please check the Contribution Guidelines

xsk's People

Contributors

Stargazers

Watchers

xsk's Issues

[Parsers] hdbsequence

hdbsequence parser

https://help.sap.com/viewer/cc2b23beaa3344aebffa2f6e717df049/2.0.03/en-US/a1e95af655ee4e00bd9183518d1fa5c5.html

New:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.02/en-US/b295c2e0a5d547f8b1717ad7dd52cc90.html

[Parsers] hdbsynonym

hdbsynonym parser

https://help.sap.com/viewer/cc2b23beaa3344aebffa2f6e717df049/2.0.03/en-US/5278b5979128444cb6fffe0f8c2bf1e3.html

New:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.02/en-US/aad1653a9b95422089fec53f48c2899e.html

[Engines] Refactor hdb related services

All services (java beans) related to the hdb engine should be extracted to a Guice module, thus improving the code quality.

[Samples] CalculationView to be consumable from SAC

Create a sample app to demonstrate how to create a CalculationView of category "CUBE", which can be consumed by SAP Analytics Cloud.

[API] $.import

$.import API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.html

[Parsers] hdbcalculationview

hdbcalculationview parser

https://help.sap.com/viewer/c2cc2e43458d4abda6788049c58143dc/2020_04_QRC/en-US/3db2a35e714e4f6e9711fb62997d0c5c.html

[Samples] Create README.md for each sample

Create README.md for each sample under the samples folder, with step-by-step description in order to run the sample.

[Parsers] hdbtablefunction

hdbtablefunction parser

https://help.sap.com/viewer/b3d0daf2a98e49ada00bf31b7ca7a42e/2.0.04/en-US/18a94543fe3f41f1b29e7c439f255b95.html

[Engines] hdbti When file is removed, data related to it should be deleted from DB

For more information check out the artifact reference.

https://help.sap.com/viewer/b3d0daf2a98e49ada00bf31b7ca7a42e/2.0.03/en-US/5450fefd5a7549888883def4836cd41c.html

[Security] Add environment variable to enable/disable xsaccess and xsprivileges processing

Add environment variable to enable/disable xsaccess and xsprivileges processing.
This can be useful during the app migration process to have separation of concerns.

Missing docker image in docker hub

Step "Pulling images" in the README file: The command docker pull dirigiblelabs/xsk-server does not work, because the image specified is missing in the docker hub, we should add it.

[API] $.request

$.request API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.web.WebRequest.html

[API] $.util.codec

$.util.codec API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.util.codec.html

[Parsers] hdbtable

hdbtable parser

https://help.sap.com/viewer/cc2b23beaa3344aebffa2f6e717df049/2.0.03/en-US/89cbf999e6004be3a5324b8f9ef0c53f.html

New:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.02/en-US/453d48e28f6747799546236b4b432e58.html

[Security] Handling empty description in xsprivilege files

Handling empty description in xsprivilege files. Currently at the database level it requires a description:

SAP DBTech JDBC: [287]: cannot insert NULL or update to NULL: Not nullable "DESCRIPTION" column

[Engines] Refactor xssecurestore core service

Refactor xssecurestore processor to comply to the persistence rules e.g. xsjob

[Sample] Sample hdi-ext does not work

Sample hdi-ext does not work

for hdbtable it should be used the old format

depends on: #43

[Parsers] hdbview

hdbview parser

https://help.sap.com/viewer/cc2b23beaa3344aebffa2f6e717df049/2.0.03/en-US/78dcb8e2f4f14b53b0d333bcd24f8721.html

New:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.02/en-US/2bf9a6f2db824fbd84315196a9c318d5.html

[Parsers] hdbschema

hdbschema parser

https://help.sap.com/viewer/cc2b23beaa3344aebffa2f6e717df049/2.0.02/en-US/8a825cbbe16a45a08987d9940d9f9f0f.html

[Parsers] xshttpdest

xshttpdest parser

https://help.sap.com/viewer/400066065a1b46cf91df0ab436404ddc/2.0.03/en-US/6efe500d91ee462c85cce7609646e17a.html

[Parsers] hdbti (+csv)

hdbti (+csv) parser

https://help.sap.com/viewer/b3d0daf2a98e49ada00bf31b7ca7a42e/2.0.03/en-US/5450fefd5a7549888883def4836cd41c.html

[Parsers] Incorrect handling of the length property in hdbtable files

Incorrect handling of the length property in hdbtable files:

table.schemaName = "TEST";
table.tableType = COLUMNSTORE;
table.columns = [
	{ name = "PROVIDER_ID";				sqlType = NVARCHAR;	length = 32;	nullable = false; }
];
table.primaryKey.pkcolumns = ["PROVIDER_ID"];

is materialised as NVARCHAR(1)

[CI/CD] Release to DockerHub GitHub Action

Create a GitHub action, so that when a new branch/tag (vX.Y.Z e.g. v1.0.0) is created, it triggers a "release" procedure to Docker Hub with the corresponding version (tag).

Depends on: #5

[API] $.net.http

$.net.http API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.net.http.html

[Parsers] Enhance the hdbtable parser to distinguish between old and new format

Enhance the hdbtable parsers to distinguish between old and new format

Old:

table.schemaName = "MYSCHEMA";
table.tableType = COLUMNSTORE;
table.columns = [
	{name = "Col1"; sqlType = VARCHAR; nullable = false; length = 20; comment = "dummy comment";},
	{name = "Col2"; sqlType = INTEGER; nullable = false;},
	{name = "Col3"; sqlType = NVARCHAR; nullable = true; length = 20; defaultValue = "Defaultvalue";},
	{name = "Col4"; sqlType = DECIMAL; nullable = false; precision = 2; scale = 3;}];
table.indexes =  [
	{name = "MYINDEX1"; unique = true; indexColumns = ["Col2"];},
	{name = "MYINDEX2"; unique = true; indexColumns = ["Col1", "Col4"];}];
table.primaryKey.pkcolumns = ["Col1", "Col2"];

New:

COLUMN TABLE "com.sap.hana.example::CUSTOMERS" ( 
   "ID" INTEGER, "NAME" NVARCHAR(256),
   "ACTIVE" TINYINT,
   "COUNTRY" NVARCHAR(256),
   PRIMARY KEY ("ID") )

Old:
https://help.sap.com/viewer/cc2b23beaa3344aebffa2f6e717df049/2.0.03/en-US/89cbf999e6004be3a5324b8f9ef0c53f.html

New:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.02/en-US/453d48e28f6747799546236b4b432e58.html

[Parsers] hdi

hdi parser

[Parsers] Enhance the hdbview parser to distinguish between old and new format

Enhance the hdbview parsers to distinguish between old and new form

Old:

schema="MYSCHEMA";
query="SELECT T1.\"Column2\" FROM \"MYSCHEMA\".\"acme.com.test.views::MY_VIEW1\" AS T1 LEFT JOIN \"MYSCHEMA\".\"acme.com.test.views::MY_VIEW2\" AS T2 ON T1.\"Column1\" = T2.\"Column1\"";
depends_on=["acme.com.test.views::MY_VIEW1", "acme.com.test.views::MY_VIEW2"];

New:

VIEW "com.sap.hana.example::ACTIVE_CUSTOMERS" 
AS SELECT ID, NAME
FROM "com.sap.hana.example::CUSTOMERS" 
WHERE ACTIVE = '1'

Old:
https://help.sap.com/viewer/cc2b23beaa3344aebffa2f6e717df049/2.0.03/en-US/78dcb8e2f4f14b53b0d333bcd24f8721.html

New:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.02/en-US/2bf9a6f2db824fbd84315196a9c318d5.html

[API] $.hdb

$.hdb API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.hdb.html

[API] $.session

$.session API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.Session.html

[API] $.util

$.util API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.util.html

[Parsers] xsaccess

xsaccess parser

https://help.sap.com/viewer/400066065a1b46cf91df0ab436404ddc/1.0.12/en-US/5fe3b123826d4503aa66eb955a002821.html

[CI/CD] Release to GitHub GitHub Action

Create a GitHub action, so that when a new branch/tag (vX.Y.Z e.g. v1.0.0) is created, it triggers a "release" procedure to GitHub with the corresponding version (tag) and uploads the corresponding binary file(s) (e.g. ROOT.war).

Depends on: #5

[Parsers] xssecurestore

xssecurestore parser

https://help.sap.com/viewer/0991e2320f5940d988ed32b995d28a44/1.4/en-US/cad0ff3df0fb4ec5b769e4b63e00f73f.html

[API] $.web

$.web API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.web.html

[Parsers] hdbdd

hdbdd parser

https://help.sap.com/viewer/52715f71adba4aaeb480d946c742d1f6/2.0.03/en-US/e8c150fde4614804831c63a67224ffa8.html
https://help.sap.com/viewer/52715f71adba4aaeb480d946c742d1f6/2.0.03/en-US/adb056accefa46828b5cc806e11aa6ed.html
https://help.sap.com/viewer/52715f71adba4aaeb480d946c742d1f6/2.0.03/en-US/cf394efd3fb4400f9c09d10315028515.html
https://help.sap.com/viewer/52715f71adba4aaeb480d946c742d1f6/2.0.03/en-US/78746b112d794f459978eb55b20a8a6f.html
https://help.sap.com/viewer/52715f71adba4aaeb480d946c742d1f6/2.0.03/en-US/ad036c56b5e545ae8b31ece0ab95379f.html

[Parsers] xsjob

xsjob parser

https://help.sap.com/viewer/6b94445c94ae495c83a19646e7c3fd56/2.0.02/en-US/6c83a8cd49ac459e88cb0fbb94ee3f38.html

[Parsers] calculationview

calculationview parser

https://help.sap.com/viewer/fc5ace7a367c434190a8047881f92ed8/2.0.04/en-US/050f14f7a6d94d2da905b0a4072ba546.html

[Synchronizers] Apply State and Log for Synchronizers

Apply State and Log for Synchronizers

eclipse/dirigible#688

[CI/CD] Zip samples folders during build

Zip samples folders during build and push them as source artefacts to be ready to use for import

[Parsers] hdbprocedure

hdbprocedure parser

https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.02/en-US/93de88bf2c8242179647e40f958c24e5.html

Add tests
Update documentation

[API] $.response

$.response API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.web.WebResponse.html

[Synchronizers] Apply dependencies between Synchronizers

Apply dependencies between Synchronizers

eclipse/dirigible#689

[API] $.db

$.db API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.db.html

[Parsers] xsodata - antlr4 - Service, Entity

xsodata parser

https://help.sap.com/viewer/b3d0daf2a98e49ada00bf31b7ca7a42e/2.0.03/en-US/502dbde2cbeb4f27b0e9b9887b0097b7.html

Samples:
HANA v1:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/1.0.12/en-US/02e91608eb174dcea6d544aad6ea2e12.html
HANA v2:
https://help.sap.com/viewer/4505d0bdaf4948449b7f7379d24d0f0d/2.0.05/en-US/34c4b422010c45a795362d8ac6a32638.html?q=hints

[Epic][API] $.security

$.security API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.security.html

[CI/CD] Build GitHub Action

Setup CI/CD GitHub action to build the project and to deploy to DockerHub the latest image version:

[API] $.trace

$.trace API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.trace.html

[API] $.net

$.net API

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.net.html

[Editors] hdbcalculationvew form based editor to be contributed to the Web IDE

hdbcalculationvew form based editor to be contributed to the Web IDE. This is needed due to the non-human readable format used (XML). The editor should have all the needed features to inspect and modify the hdbcalculationview artefact.

[CalculationView] [Parsers] Migrate to hdbcalculationview

calculationview to hdbcalculationview migration task to be implemented as action in the Web IDE. Due to the differences of the format and handling of the old and new calculation views, there is a need of a pre-processing before the artefact hdbcalculationview be added to the HDI container along with the corresponding synonyms.