{"id":21450920,"url":"https://github.com/soontao/cds-feature-toggle","last_synced_at":"2025-10-03T16:47:43.715Z","repository":{"id":38424551,"uuid":"456845019","full_name":"Soontao/cds-feature-toggle","owner":"Soontao","description":"support feature toggle pattern for CAP CDS","archived":false,"fork":false,"pushed_at":"2024-11-19T18:01:37.000Z","size":1900,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-19T19:19:03.456Z","etag":null,"topics":["cap","cds","feature-toggle"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Soontao.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-08T08:27:56.000Z","updated_at":"2024-11-19T18:01:41.000Z","dependencies_parsed_at":"2024-01-26T06:24:12.465Z","dependency_job_id":"2dab5547-e1b7-4a1d-bcf5-844cddc331a8","html_url":"https://github.com/Soontao/cds-feature-toggle","commit_stats":null,"previous_names":[],"tags_count":8,"template":true,"template_full_name":"Soontao/ts-project-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soontao%2Fcds-feature-toggle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soontao%2Fcds-feature-toggle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soontao%2Fcds-feature-toggle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soontao%2Fcds-feature-toggle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Soontao","download_url":"https://codeload.github.com/Soontao/cds-feature-toggle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225998797,"owners_count":17557473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cap","cds","feature-toggle"],"created_at":"2024-11-23T04:17:05.760Z","updated_at":"2025-10-03T16:47:38.663Z","avatar_url":"https://github.com/Soontao.png","language":"TypeScript","readme":"# cds feature toggle\n\n\u003e support feature toggle pattern for SAP CAP cds\n\n[![node-test](https://github.com/Soontao/cds-feature-toggle/actions/workflows/nodejs.yml/badge.svg)](https://github.com/Soontao/cds-feature-toggle/actions/workflows/nodejs.yml)\n[![npm](https://img.shields.io/npm/v/cds-feature-toggle)](https://www.npmjs.com/package/cds-feature-toggle)\n[![codecov](https://codecov.io/gh/Soontao/cds-feature-toggle/branch/main/graph/badge.svg?token=36cAQGIQWC)](https://codecov.io/gh/Soontao/cds-feature-toggle)\n[![license](https://img.shields.io/npm/l/cds-feature-toggle)](./LICENSE)\n\n## Quick Overview\n\n\n```groovy\n// all event/entity/action/function require 'class-service' feature\n@cds.features.required : ['class-service'] \nservice ClassService {\n\n  // annotate the entity built-in events\n  @cds.features : [\n    {\n      on       : 'DELETE',\n      required : 'feat-student-delete' // generally, maybe we dis-allowed user to delete entry\n    }\n    // other event will skip feature check\n  ]\n  entity Students               as projection on training.Student;\n\n  // or simply require feature for all events/action/function under the entity\n  @cds.features.required: 'feat-teacher-management'\n  entity Teachers  as projection on training.Teacher;\n\n  // enabled by default\n  // if 'metricV2' or 'metricV3' is enabled, \n  // will prefer to trigger the redirect action\n  @cds.features.redirect.target : [metricV2]\n  action metric() returns MetricResponse;\n\n  // enabled when request context has the feature 'feature-metrics-v2'\n  @cds.features.required         : 'feature-metrics-v2'\n  action metricV2() returns MetricResponse;\n\n\n}\n```\n\n## Setup\n\n\u003e you need to enable the `cds-feature-toggle` by `cds-hyper-app-service` extension config\n\n```bash\nnpm i -S cds-hyper-app-service cds-feature-toggle\n```\n\n```js\n{\n  \"cds\": {\n    \"requires\": {\n      \"app-service\": {\n        \"impl\": \"cds-hyper-app-service\",\n        \"exts\": [\n          \"builtIn\",\n          {\n            \"impl\": \"cds-feature-toggle\",\n            \"providers\": [\n              {\n                \"impl\": \"CDSRequestProvider\",\n                \"header\": \"x-cds-features\"\n              }\n            ]\n          }\n        ]\n      }\n    }\n  }\n}\n```\n\n## Providers\n\n`cds-feature-toggle` provided a very simple provider which named `CDSRequestProvider`, it will extract http header `x-cds-features` as feature labels.\n\n\n```ts\nexport class CDSRequestProvider implements FeatureProvider {\n  #headerName = HEADER_X_CDS_FEATURES_NAME;\n  /**\n   * extract http header as (enabled) feature list for current request\n   * \n   * @param options.featureHeaderName default is `x-cds-features`\n   */\n  constructor(options: { featureHeaderName?: string }) {\n    if (typeof options?.featureHeaderName === \"string\") {\n      this.#headerName = options?.featureHeaderName;\n    }\n  }\n  public getFeatures(context: DetermineContext) {\n    // TODO: add signature verify\n    return Promise.resolve(context?.request?.get?.(this.#headerName)?.split(\",\") ?? []);\n  }\n}\n```\n\nyou can easily implement a feature provider by yourself, read feature from `redis` or `database`, it depends on you. \n\n## TODO\n\n- [x] support redirect for bounded `action`/`function`\n- [x] support `@cds.features.required` on full entity \n- [x] built-in provider interface\n  - [x] cds request header provider\n  - [x] dummy provider for test\n- [ ] support `cds-nats` KV\n\n## Limitation\n\n* the default no handler behavior for `action`/`function` will be little difference\n\n## [CHANGELOG](./CHANGELOG.md)\n\n## [LICENSE](./LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoontao%2Fcds-feature-toggle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoontao%2Fcds-feature-toggle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoontao%2Fcds-feature-toggle/lists"}