Hello everyone,

when I was trying to use the library in Node.js 14.16.1, I have found out that somewhere deep in the library, the shared object is used. This doesn't allow me to send simultaneous requests properly. It seems that the state is shared by subsequent requests, and when the async request is processed by node, my web service always gets the same payload. Here is an example:

const Service = require("@sap_oss/odata-library").Service;
const SERVICE_URL = "https://services.odata.org/V4/OData/OData.svc/";

(async () => {
    const sample = new Service(SERVICE_URL);
    await sample.init;

    console.log(`${SERVICE_URL} initialized successfully`);

    const results = await Promise.all([
        sample.Products.select(["ID", "Name"]).get(0),
        sample.Products.select(["ID", "Name"]).get(1)
    ]);

    console.log(`Results ¯\\_(ツ)_/¯ ${JSON.stringify(results)}`);
})();

Here is my result:

Results ¯\_(ツ)_/¯ [[{"ID":0,"Name":"Bread"}],[{"ID":0,"Name":"Bread"}]]

Honestly, I have expected two different Products.

When I debugged your code, I have found out that the issue is caused by the library design. Somewhere in QueryableResource.js, the object defaultRequest is shared.

I can use await, it will make my code sequential, this is not what I want. Or, I can initialize a service asynchronously per each task/request, but this is also clumsy, because every init call reads $metadata.

None of the provided examples demonstrate my case, that is why I had to improvise. I hope this bug report will be helpful for other users, if they have similar issues.

p.s. it was difficult to find, why my code didn't work.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-3
Explanation: Is it registered in REUSE? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

The count() method doesn't return valid response (the number). The speculation is - it doesn't properly handle returned content type (text/plain) and tries to parse it as json.

Use following code to reproduce the issue:

const Service = require("@sap_oss/odata-library").Service;

const logger = {
    "trace": console.log,
     "debug": console.log,
     "info": console.log,
     "warn": console.warn,
     "error": console.error
};

let service = new Service({
    url: "https://services.odata.org/V2/OData/OData.svc/",
    strict: false, // ignore non critical errors, e.g. orphaned annotations
    logger: logger
});

service.init.then(()=> {
    return service.Products.count();
}).then((result) => {
    console.log(`EntitySet contains ${result} entities.`);
}).catch(err =>  console.error(err.message))

Exception is thrown, but expected is value 9 (try to copy the request url to your browser):

Request:
  GET https://services.odata.org//V2/OData/OData.svc/Products/$count
  Request Payload: Empty
Request headers : {
  "User-Agent": "node-superagent/3.8.3"
}
Response Status Code : 200
Response Headers : {
  "cache-control": "no-cache",
  "content-length": "120",
  "content-type": "text/plain;charset=utf-8",
  "content-encoding": "gzip",
  "vary": "Accept-Encoding",
  "server": "Microsoft-IIS/10.0",
  "dataserviceversion": "2.0;",
  "x-aspnet-version": "4.0.30319",
  "x-powered-by": "ASP.NET",
  "date": "Fri, 05 Mar 2021 16:42:43 GMT",
  "connection": "close"
}
Cookies : ""
Response : {}
Backend returns invalid count value.

Use case: using odata-libary as verification of metadata (saved file) or for example any kind of postprocessing (e.g. tree visualization).

See: https://github.com/SAP/python-pyodata/blob/master/docs/usage/initialization.rst#get-the-service-with-local-metadata

I have an OData service that is made available via SAP CPI and uses OAuth (Bearer token). Not sure how to access this API because it seems like you cannot pass custom headers to the Service constructors. Enabling OAuth would just require passing the header param Authorization with a value of Bearer <your_token>.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

Sending wrong value to database through Batch returns:
Error: 400 - Invalid response inside Batch.
instead of
Bad Request message.

We had interesting bug in pyodata - see SAP/python-pyodata#186. Should be relevant to both odata V2 and V4.

Looks to me that in odata-library is the same problem, didn't find any special case for base16 encoding in URL if Edm.Binary is used as a key.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

My S/4 Hana version is 1809. The system is protected by SAML2.0 . How to use this odata-library to authenticate users?

SELECT statement on parametrized entity set (sap extension) validates columns against ...Parameters entity type. This entity type contains only parameters and Results/Set navigation property that provides data for the parametrized entity set query. SELECT statement should be validated against the Results/Set entity type.

A user created with "Maintain Communication User" can access an odata service with basic authentication but cannot login through SAML.
This odata service tries SAML, and then basic authentication.

For a communication user SAML login fails. The login page is returned with the error message and this service keeps retrying SAML login indefinitely.

To make this service work with communication users, the code should switch to and try basic authentication, if login credentials don't work for SAML, i.e. after a few retries with SAML login.

SideEffects annotation can define property as PropertyPath. The PropertyPath can contains path to path to property which exists in the NavigationProperty where property of navigation property is divided by "/".

Parsing of metadata currently failed for the situation.

<Annotation Term="Common.SideEffects" Qualifier="ProfitCenterCocdAssignment">
  <Record>
    <PropertyValue Property="SourceProperties">
      <Collection>
        <PropertyPath>ControllingAreaForEdit</PropertyPath>
      </Collection>
    </PropertyValue>
    <PropertyValue Property="TargetProperties">
      <Collection>
        <PropertyPath>to_CompanyCodeAssignment/ControllingArea</PropertyPath>
        <PropertyPath>to_CompanyCodeAssignment/CompanyCode</PropertyPath>
        <PropertyPath>to_CompanyCodeAssignment/CompanyCodeName</PropertyPath>
        <PropertyPath>to_CompanyCodeAssignment/PrftCtrIsAssignedToCompCode</PropertyPath>
      </Collection>
    </PropertyValue>
    <PropertyValue Property="EffectTypes" EnumMember="ValueChange ValidationMessage"/>
  </Record>
</Annotation>

Hello Colleagues,

We are using Vyper for ODATA automation. For automating the script, in some payloads we use PATCH request. Could it be possible to support PATCH request.

Regards,
Dinesh

Authrize odata requests via cookie passed to odata-library service constructor

When run POST/DELETE/POST sequence the headers are set for POST => POST instead of POST => DELETE => POST

Use node-fetch to send HTTP requests instead of superagent. It is risky change, but it solves superagent workarounds.

• create support for CSRF tokens
• reimplement authorizations
• reimplement parsers

Does this project support OData V2 or also V4?

Some implementations could support EntityType which is not fully defined only in the EntityType and some part of EntityType is defined in "parent" EntityType. See EntityType Event and its basetype in https://services.odata.org/TripPinRESTierService/$metadata

Hello,

When creating batch requests with multiple change-sets there seems to be no way to specify Content-ID
( http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_MultipartBatchRequestBody )

Is this supported?

Thanks,
Pavan

If server does not support SAML authentication and returns on request to SAML authorization "Unauthorized" HTTP response. odata-library recognize it as fatal error, but authentication process can continue by basic authentication.

Requested by Dinesh Bhandarkar

service.entitySet.count() does not support $filter.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-1
Explanation: Does README mention REUSE? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

Streams are currently supported from Navigation properties like

http://localhost/sap/opu/odata/sap/SERVICE_PATH/EntitySet(key='value')/GetDocument/$value

but streams could by supported by direct entity path

http://localhost/sap/opu/odata/sap/SERVICE_PATH/EntitySet(key='value')/$value

Implement the second case

This line has an error that cost me 2 hours of debugging. Are you sure that trailing slash is required there? Because it gives me for the URL https://xs.hana.com/dev/service/service.xsodata/ this one: https://xs.hana.com//dev/service/service.xsodata/

Please correct this line.

When the given URL contains an additional suffix (e.g. https://.../Some_Entity/$value, in this case the "/$value" suffix), I can make the call "service.Some_Entity.post()", however, it is not possible to add the desired "$value" property to the call.

FunctionImport GET call does not correctly parse response

service.GetCombinations({
Param : 1,
Param: 2
})

If FucntionImport is defined in metadata to call GET method. Does not correctly parse JSON data

OData-library now generates post requests with a redundant question mark. The question mark is used even though no URL parameter is used.

URL looks like this:

/sap/opu/odata/sap/FAC_CURRENCY_EXCHANGE_RATE_SRV/C_CurrencyExchangeRate?

The path is generated in QueryableResource.js L 178

Implement ODataV4 Actions to the library.

Request to list

service.MyEntity.top(1).get()

When MyEntity is marked by hasStream attribute in $metadata then odata-library is trying to request stream instead of list of entities.

Hello Colleagues,

Is it possible to trigger a batch (changeset) request using this library? My aim would be to create multiple entities in one request, but I don't find such information in the documentation.

Thanks,
Daniel

Try read the nested navigation property from TripIn service https://services.odata.org/TripPinRESTierService/

Code example

service.People.key({                               
    UserName: userName                         
})                          
    .Trips.key({                           
        TripId: result[0].TripId                            
    })                             
    .PlanItems.get();  

The error is raised

 TypeError: Cannot read property 'navigationPropertyBindings' of undefined

1:n navigation property can declare target property type as collection type (typical v4) or as complex/entity type (typical v2). Currently odata lib assumes CollectionType and it leads to following error for v2 1:n navigation properties (since recent changes):
TypeError: Cannot read properties of undefined (reading 'hasStream')
at NavigationProperty.determineRequestHeaders (.../@sap_oss/odata-library/lib/engine/QueryableResource.js:595:55)
at NavigationProperty._handleAgentCall (.../@sap_oss/odata-library/lib/engine/QueryableResource.js:580:10)
at NavigationProperty.executeGet (.../@sap_oss/odata-library/lib/engine/QueryableResource.js:349:14)
at RequestDefinition.get (.../@sap_oss/odata-library/lib/engine/RequestDefinition.js:103:27)
at NavigationProperty.get (.../@sap_oss/odata-library/lib/engine/QueryableResource.js:115:32)

Hi guys,

we currently facing an issue where we can't post against an entity when the payload contains a nested navigationProperty which points to an entity and not to an entitySet.

Due to authorization issue we need to have a seperate navigationProperty pointing to an entity.

Hey colleagues,

we received a feature request in UI5 Web Components for React (SAP/ui5-webcomponents-react#2054) which is asking for an oData v2 Client.
As our library is only taking care of the rendering part, it would be a great fit to use the odata-library for making the odata calls.
If I have understood it correctly, this library is currently only supporting node environments. Are there any plans to release a "web" version that runs on the clients? Maybe this would go hand in hand with #25 if you go for the fetch library anyways.

Thanks!

error:
odata service init failed Error: Property 'to_CompanyCodeAssignment/ControllingArea' not found in type C_ProfitCenterTPType.

Hello,

When I try to use POST with Deep Insert I encounter the below error.

entityTypeModelStart.navigationPropertyAssociationTo is not a function
at EntitySet.processNavigationPropertyItems (C:\Users<>\AppData\Roaming\npm\node_modules\qmate\node_modules@sap_oss\odata-library\lib\engine\QueryableResource.js:547:48)

Could you confirm if this is a supported feature currently?

Whilte creating service instance via let service = new Service({...}), the following typeError in /@sap_oss/odata-library/lib/agent/url.js:90 appears:

TypeError: URL is not a constructor

Already tried different auth params as mentioned in the docs.

In some cases, calling function import v2 leads to following error while parsing response:

Uncaught Error Error: rawResponse.headers.get is not a function
    at <anonymous> (.../@sap_oss/odata-library/lib/engine/FunctionImport.js:145:18)

Here is sample code to reproduce:

const Service = require('@sap_oss/odata-library').Service;

function edmToDate(str){
  return new Date(parseInt(str.replace('/Date(', '')));
}

const service = new Service({
  url: "...",
  auth: {
    username: "...",
    password: "...",
  },
  parameters: {
    "sap-client": "710",
    "sap-language": "EN",
  },
  strict: false, // ignore non critical errors, e.g. orphaned annotations
});


service.init.then(async () => {
  const PCID = Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 5).toUpperCase();
  let draft = await service.C_ProfitCenterTP.post();

  let draftKey = {
    ControllingArea: draft.ControllingArea,
    ProfitCenter: draft.ProfitCenter,
    ValidityEndDate: edmToDate(draft.ValidityEndDate),
    DraftUUID: draft.DraftUUID,
    IsActiveEntity: false
  }

  // set mandatory draft attributes
  await service.C_ProfitCenterTP
    .merge(draftKey,
      {
        ProfitCenterForEdit: `${PCID}PCNTR`,
        ProfitCenterName: `${PCID}Name`,
        ProfitCtrResponsiblePersonName: `${PCID}Person`,
        ProfitCenterStandardHierarchy: "YBH110",
        Segment: "1000_A"
      });

  //// Draft Preparation & Activation ////
  service.createBatch();

  // Draft Preparation
  service.createChangeSet();
  service.C_ProfitCenterTPPreparation(draftKey);
  service.commitChangeSet();

  // Draft Activation
  service.createChangeSet();
  service.C_ProfitCenterTPActivation(draftKey);
  service.commitChangeSet();

  let batchResp = await service.sendBatch();

  console.warn(batchResp);
});

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

Currently, OData-library logs only responses without error. When there is an error, the logger is not notified and it causes that network log is not very useful in case of error.

Agent.js L396

      this.headersToRequest(headers, requestMethod)
        .then((res) => {
          this.logResponse(res);
          resolve(res);
        })
        .catch((err) => {
          reject(Agent.formatResponseError(err));
        });

Success is logged, error only throws an error.

Can't create new entity via POST

service.entitySet.post({
  prop1 : "value",
  prop2 : "value",
  complexProp : {
    prop3: "value",
    prop4 : "value"
  }
})

Where complexProp property is defined in metadata as ComplexType

The EntityType for EntitySets could be defined in different Schema element of $metadata than EntitySet is defined. Example:

https://services.odata.org/V3/Northwind/Northwind.svc/$metadata

Hello odata-library maintainers,

I hope you are aware of the SAP Cloud SDK for JavaScript project. It does already provide funtionality for OData supporting V2 and V4. So my questions are:

• Is this project related or used in SAP Cloud SDK for JavaScript?
• If this project is not related why should I use it instead of the SAP Cloud SDK for JavaScript?

Best regards
Gregor

Use global header definition instead of local request object with local headers definition

https://github.com/SAP/odata-library/blob/master/lib/engine/FunctionImport.js#L134

Hello Norbert,

As we discussed via email, could you please check, if you can implement client certificate authentication?

Thanks,
Daniel

Getting Error: Internal Server Error - In the context of Data Services an unknown internal server error occurred after trying to call function import to edit Entity Set in OData v2.

"Format/FitToPage/ErrorRecoveryBehavior" -> Unknow model path format, "/lib/model/nw/CsdlSchema.js:61:11"

It'd be very useful if the library was set up to export types as described here https://www.typescriptlang.org/docs/handbook/declaration-files/dts-from-js.html

I'd like to use this in a typescript project, but at the moment I'm having some difficulty due to the lack of types

If batch response contains error Agent.prototype.batch tries to process the error as normal response.