Compare commits

...
90 Commits
Author SHA1 Message Date
hermes a6a111db8a test(viya): scope stagedata abort assertions to the submitted load
Build / Build-and-ng-test (pull_request) Successful in 6m4s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m41s
Build / Build-and-test-development (pull_request) Successful in 25m35s
The abort checks matched any non-success load in the time window, so a parallel session's aborted/IN PROGRESS load could satisfy them even if the tested load completed. Key them on this test's unique submitted message (reason_txt), which is preserved because a hook-aborted load finishes before mpe_loadfail can overwrite it.
2026-09-14 13:25:32 +01:00
allan ca19dbaefb Merge pull request 'chore(hooks): add gitleaks secret scan to pre-commit' (#317) from chore/gitleaks-precommit into fix/viya-test-suite-and-refreshcatalog-json
Build / Build-and-ng-test (pull_request) Successful in 5m26s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m28s
Build / Build-and-test-development (pull_request) Successful in 25m39s
Reviewed-on: #317
2026-09-14 12:15:38 +00:00
hermes 8418e0cb1d docs(contributing): document one-time git hook activation
Build / Build-and-ng-test (pull_request) Successful in 5m21s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m1s
Build / Build-and-test-development (pull_request) Successful in 24m44s
2026-09-14 12:44:10 +01:00
hermes d301fc2b4d fix(deps): bump @sasjs/cli to 4.20.3
Clears the moderate adm-zip advisory (GHSA-vwc7-r8mq-g2x9) from the sas npm audit gate - @sasjs/cli 4.20.3 replaces adm-zip with yauzl/yazl.
2026-09-14 12:43:58 +01:00
dc fbcde41321 fix(hooks): require the repo-pinned gitleaks, drop the fallbacks
Build / Build-and-ng-test (pull_request) Failing after 1m46s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Successful in 21m12s
A soft skip (and the system-gitleaks fallback) let a clone without
node_modules commit with no secrets scan at all, so the hook would
never force the install. The hook now hard-blocks with a hint to run
'npm i' until the @nogoo9/gitleaks binary is present in
node_modules/.bin.

Verified with the binary present (scan runs and passes) and absent
(blocked, exit 1).
2026-09-10 23:06:34 +00:00
dc 53838036e6 fix(hooks): make the pre-commit size check actually run
Build / Build-and-ng-test (pull_request) Failing after 1m47s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Successful in 20m51s
The size check sat after the prettier block, whose branches both exit,
so it was unreachable - and it had three further defects: the exit 1
lived inside a ( ... ) subshell so it could never block the commit,
the 2**20 arithmetic errors under /bin/sh (dash) leaving size_limit
unset, and it measured HEAD^..HEAD (the previous commit) rather than
the content being committed, which does not exist yet in pre-commit.

Rewrite it to sum the sizes of the new blobs the commit would
introduce (git diff --cached --raw, new blob ids -> cat-file
--batch-check), keep the 2MB threshold and the documented --no-verify
escape hatch, and move it before the prettier check so it always runs.

Verified with a staged 3MB blob (blocked, exit 1), a small staged
change (passes through to prettier), and a mode-only change (no new
blob, passes).
2026-09-10 23:03:43 +00:00
dc b3b9755aa7 chore(hooks): add gitleaks secret scan to pre-commit
Build / Build-and-ng-test (pull_request) Failing after 1m45s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Successful in 20m14s
Run 'gitleaks protect --staged' before prettier in the pre-commit hook.
The gitleaks binary comes from the @nogoo9/gitleaks devDependency,
which ships official binaries as platform optionalDependencies - no
postinstall scripts, so it installs under ignore-scripts=true.
Falls back to a system gitleaks, and soft-skips with a hint to run
'npm i' on a fresh clone rather than blocking the commit.
2026-09-10 22:36:44 +00:00
hermes 82a45b80b4 chore(viya): run tests on the reusable compute context, harden chunk deploy
Build / Build-and-ng-test (pull_request) Successful in 5m20s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m59s
Build / Build-and-test-development (pull_request) Successful in 24m27s
The test jobs on the nextviya estate run as a batch identity that is
not authorised to create sessions in the SAS Job Execution compute
context - child service submissions via mx_execute all failed with
403.  Default the test context to Compute Reusable (matching the
target contextName) in the shared test init programs.

Also give the chunk deploy helper a retry loop for the per-chunk
sasjs run timeouts - estate cold-starts can exceed a single 300s
window.
2026-09-08 20:52:19 +01:00
hermes a8194d73e7 test(viya): align stagedata test payloads with the adapter contract
The web editor submits date/datetime/time cells as formatted strings
and always provides the format-catalog buskey, so the staged CSVs
round-trip through the ANYDT* informats in mpe_loader.  Some tests
built jsdata with raw numeric values or without FMTROW, causing the
staged loads to fail on Viya.

- getstagetable.test: send some_date/some_datetime/some_time as
  formatted strings (as postdata.test.1 already does), and assert on
  flags captured from the first read - the JSON libname can only be
  read once, so re-reading stagetable returns -1 observations
- postdata.test.2: add fmtrow to the staged format catalog rows (the
  TYPE FMTNAME FMTROW buskey)
- stagedata.test.3: assert the #211 hook aborts through MPE_LOADS - a
  hook-aborted child never returns a webout, and the load stays IN
  PROGRESS because mpe_loadfail cannot run after the abort.  The WIDEBOY
  RLS rule is inserted in the prep section so the (possibly pooled)
  child session reads it from the shared filesystem
2026-09-08 20:52:19 +01:00
hermes 1dccf61f62 fix(admin): return refreshcatalog output as webout JSON
The service wrote a raw HTML line straight to the _webout fileref
after the load completed.  On Viya, API-submitted jobs (eg via
mx_execute) do not always have that fileref connected to a job result,
so the output was lost and job-result consumers aborted.  Return a
proper sasparams table through %webout() instead - the same pattern as
the other admin services - and update the test to assert on the
webout sasparams message.
2026-09-08 20:52:19 +01:00
hermes 09f31ce6da fix(deps): bump @sasjs/core to 5.2.7
Brings in the mv_jobflow JSON-escape fix (prevents jobExecution 400s
for job arguments containing quotes or CR/LF) and the graceful
handling of canceled jobs in mv_getjoblog / mv_getjobresult (a
canceled child no longer aborts the calling program when its log or
result is unavailable).  Verified against a live Viya 2026.07 estate:
the full SAS test suite passes with these macros sourced from core.
2026-09-08 20:52:19 +01:00
semantic-release-bot 90c937c32a chore(release): 7.14.0 [skip ci]
# [7.14.0](https://git.datacontroller.io/dc/dc/compare/v7.13.0...v7.14.0) (2026-09-04)

### Features

* **system:** show session timezone on system information screen ([966dc07](966dc072e0))
2026-09-04 14:31:37 +00:00
allan d9bd46e97b Merge pull request 'feat(system): show session timezone on system information screen' (#315) from fix/system-timezone-info into main
Release / Build-production-and-ng-test (push) Successful in 6m47s
Release / Build-and-test-development (push) Successful in 25m59s
Release / release (push) Successful in 10m45s
Reviewed-on: #315
2026-09-04 13:52:54 +00:00
allan 55c38805d7 Merge branch 'main' into fix/system-timezone-info
Build / Build-and-ng-test (pull_request) Successful in 5m37s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m58s
Build / Build-and-test-development (pull_request) Successful in 25m13s
2026-09-04 12:19:50 +00:00
hermes 966dc072e0 feat(system): show session timezone on system information screen
Build / Build-and-ng-test (pull_request) Successful in 5m41s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m13s
Build / Build-and-test-development (pull_request) Successful in 25m42s
Add TIMEZONE, SYSTIMEZONEIDENT and SYSTIMEZONEOFFSET to the startupservice
globvars and display them in the Environment Details block, so the session
clock used to stamp submission timestamps is directly visible to admins.
2026-09-04 12:15:01 +00:00
semantic-release-bot 81c725d10b chore(release): 7.13.0 [skip ci]
# [7.13.0](https://git.datacontroller.io/dc/dc/compare/v7.12.0...v7.13.0) (2026-09-03)

### Bug Fixes

*  dynamic js mocks ([3b9344c](3b9344cb60))
* adding formula types ([c07a01a](c07a01a38d))
* address hermes review feedback (formula quoting, cell revert, addRow guard) ([36963aa](36963aa746))
* agent skills and nextviya deploys ([f7db871](f7db8719f5))
* bump core for mp_validate fix ([5a44b28](5a44b2804f))
* CAS support for REPLACE type plus docs ([ea05f07](ea05f07180))
* clarify debug comment is permanent, extend ComputeContextDetails with Viya response fields ([72484ae](72484ae844))
* core major bump plus autofix of viya context on deploy ([6527c10](6527c10f26))
* **core:** bump to v5 (breaking change) ([59e9e96](59e9e96f5a))
* **cypress:** correct mock data, test expectations, and abort modal ([13c10be](13c10be30f))
* **cypress:** make licensing combined-key tests order-independent ([4db8d62](4db8d62dca))
* **deploy:** Viya deploy checks, startup diagnostics, and chunked deploy script ([917925f](917925f553)), closes [#303](#303) [#200](#200) [#125](#125)
* **deps:** align @angular/* packages to the same lockstep version ([24e6297](24e6297187))
* **deps:** override nanoid to 3.3.18 in sas/ ([d57ae03](d57ae03fc4))
* **deps:** pin @handsontable/angular-wrapper to 18.0.0 ([2d7df66](2d7df66fc2))
* **deps:** pin babel-loader to resolve an unresolvable peer conflict ([3bf3bf0](3bf3bf0dde))
* **deps:** regenerate lockfile with Node 24 and pin handsontable to 18.0.0 ([7da29bd](7da29bdb11))
* **deps:** regenerate lockfile with strict peer-dep resolution to fix npm ci in CI ([efd2e18](efd2e18c7b))
* **deps:** regenerate package-lock.json to resolve npm ci sync errors ([a501903](a501903e6d))
* **deps:** resolve npm audit findings and align @angular/* to the same lockstep version ([b9e4b27](b9e4b2733f))
* **deps:** resolve npm audit findings via direct lockfile patch, not regeneration ([4d1bfa6](4d1bfa6343))
* **deps:** resolve npm audit vulnerabilities in production dependencies ([257f69c](257f69ccc6))
* **deps:** scope the brace-expansion override to its actual vulnerable chain ([f9d061c](f9d061c489))
* dynamic getdynamiccolvals.js ([d59ef44](d59ef44226))
* **editor:** clear sort before reading cells to preserve on cancel ([4137ebd](4137ebdf6b))
* **editor:** escape formula-looking values in uploaded Excel data ([e69df3d](e69df3deb2))
* **editor:** fix formula $-substitution corruption and sorted-grid row/formula desync ([e139c37](e139c37fbf))
* **editor:** let the column info dropdown's text be selected and copied ([1e516f4](1e516f4012))
* **editor:** re-mark a reverted cell as auto-escaped so "Apply as formula" works again ([12091c4](12091c4044))
* **editor:** resolve a primary key's live formula to its computed value, not the raw formula text ([d72e19a](d72e19a308))
* **editor:** resolve computed value for a live formula in numeric columns too ([2cc8489](2cc8489892))
* **editor:** restore multi-column sort with one call, not a loop ([8fafeb7](8fafeb7923))
* **editor:** size table-header buttons and title to content, not fixed grid thirds ([d0a7561](d0a7561f1a))
* **editor:** stop dc.row_status from being submitted to the backend ([dc0f6a7](dc0f6a7baa))
* **editor:** stop turning missing columns into undefined, and fix column lookup for sparse rows ([a104f78](a104f78645))
* **editor:** submit a live formula's computed value, not its raw text ([b7d3106](b7d31066ae))
* ensure cleanup of casuser temp table in error condition ([c4123e5](c4123e5c96))
* ensuring formats arrive from backend in getstagetable.sas ([daacb49](daacb49c8a))
* escape regex metacharacters in context name before prxchange ([9023eb2](9023eb2a39))
* failing test ([f213d24](f213d24f09))
* fixed npm vuln ([26b55b1](26b55b1bde))
* **formulas:** avoid EDIT_STATUS colliding with a real column of that name ([acb97f4](acb97f4bfb))
* hardening following PR review feedback ([1f4aa6f](1f4aa6fcea))
* history mock ([0082828](0082828543))
* **licensing:** bridge async proceed() through cy.then and replace Response.arrayBuffer with manual stream reader ([8e51fde](8e51fde524))
* **mocks:** add fixture staged data and MPE_SUBMIT row for stage.cy.ts ([6e2548d](6e2548d78c))
* **mocks:** add LIBRARYNAME to startupservice, fix viewbox column order ([c0af86e](c0af86ef29))
* **mocks:** limit stage fixture to 1 row, fix column order ([f25ecd8](f25ecd8828))
* **mocks:** look up PK_FIELDS from MPE_TABLES in viewdata, fallback for MPE_AUDIT ([94d2a79](94d2a7970e))
* **mocks:** remove MPE_VALIDATIONS and MPE_ALERTS from DC996664 libref ([4f7b845](4f7b845390))
* **mocks:** remove shadowed saveTableData in rejection.js ([fed0396](fed0396737))
* **mocks:** remove SOME_SHORTNUM HARDREGEX from MPE_VALIDATIONS ([34bd660](34bd6607c5))
* **mocks:** rename saveTableData in postdata.js to avoid shadowing ([e4b04b1](e4b04b1d44))
* **mocks:** SAS datetime format in getchangeinfo, login in stage.cy.ts ([c180934](c180934167))
* more mock improvements ([a80927c](a80927cbb6))
* mp_execute dep ([023c29f](023c29f00f))
* pin fast-uri to 3.1.7 to close high-severity SSRF/host-confusion advisories ([f4325b2](f4325b2056)), closes [hi#severity](https://git.datacontroller.io/hi/issues/severity)
* spy for startup ([69b4155](69b41559f7))
* **stage:** submit data via editor flow, use dynamic date assertion ([490d013](490d0137b9))
* **startup:** show the real startupservice response text on a malformed reply ([9a1b7d0](9a1b7d0f52))
* tests and realistic getcolvals.js ([5d03164](5d03164b6a))
* **tests:** new libref ([c0bc87d](c0bc87d331))
* unnecessary getsubmits call removed ([cc2ff87](cc2ff873fa))
* using utility macro for webout ([3595bb9](3595bb9499))

### Features

* **editor:** color row-header status cells and switch modified symbol to ± ([e15f2c2](e15f2c2a34))
* **editor:** generalize cell revert to any overwritten value, not just formulas ([07d586d](07d586da52))
* **editor:** scope live formulas to character columns, not just HARDFORMULA/SOFTFORMULA ones ([92d0d91](92d0d91440))
* **editor:** translate column names to cell references on formula paste ([1031ea7](1031ea7ed7))
* **formulas:** flag formula-overwritten cells with revert, harden dc.row_status against SAS name collisions ([a8237b2](a8237b2881))
* **formulas:** live DC.ROW_STATUS, insert-row formula fixes, UserService singleton fix ([4a8c39b](4a8c39b4c0))
* **formulas:** wire HyperFormula into HARDFORMULA/SOFTFORMULA rules ([cbea04c](cbea04c8e1))
* functional JS mocks ([ee52bb8](ee52bb8967))
* **licensing:** support combined-key paste, object-format features, and a live key preview ([20ba633](20ba633087))
* **licensing:** warn and block applying a licence key generated for the wrong protocol ([41680e2](41680e2ecc))
* **stage:** add Formatted/Unformatted toggle to the staging page ([74c38e1](74c38e1641))
* updated configurator for Viya deploy ([df2027d](df2027dab6))
* **viewboxes:** add drag-to-resize on all four edges and corners ([e5a5bf2](e5a5bf2144))
2026-09-03 14:48:53 +00:00
allan 34ff2ac8d0 Merge pull request 'Version 7.13 Release' (#294) from version7-13 into main
Release / Build-production-and-ng-test (push) Successful in 4m46s
Release / Build-and-test-development (push) Successful in 24m7s
Release / release (push) Successful in 8m58s
Reviewed-on: #294
2026-09-03 14:16:02 +00:00
allan 1ad27d55f1 Merge pull request 'fix(editor): restore multi-column sort with one call, not a loop' (#312) from version7-13-fix into version7-13
Build / Build-and-ng-test (pull_request) Successful in 6m12s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m40s
Build / Build-and-test-development (pull_request) Successful in 24m57s
Reviewed-on: #312
2026-09-03 10:12:21 +00:00
YuryShkoda 8fafeb7923 fix(editor): restore multi-column sort with one call, not a loop
Build / Build-and-ng-test (pull_request) Successful in 5m23s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m1s
Build / Build-and-test-development (pull_request) Successful in 25m4s
multiColumnSorting's sort() replaces the entire sort state on every call rather than accumulating, so the restore loop after updateSettings()/editTable()/cancelEdit() silently dropped every sorted column but the last. Pass the captured configs as a single array instead. Adds a Karma integration test proving the loop
loses columns, and a Cypress test verifying cancelEdit() keeps a real shift-click multi-column sort intact end-to-end.
2026-09-03 12:46:31 +03:00
allan f797b1130a Merge pull request 'fix(editor): fix formula $-substitution corruption and sorted-grid row/formula desync' (#311) from version7-13-fix into version7-13
Build / Build-and-ng-test (pull_request) Successful in 5m30s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m1s
Build / Build-and-test-development (pull_request) Successful in 24m32s
Reviewed-on: #311
2026-09-03 09:21:56 +00:00
YuryShkoda 4137ebdf6b fix(editor): clear sort before reading cells to preserve on cancel
Build / Build-and-ng-test (pull_request) Successful in 5m16s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m2s
Build / Build-and-test-development (pull_request) Successful in 24m42s
cancelEdit()'s getFormulaCellsToPreserveOnCancel callbacks passed a
physical rowIndex straight into visual-row-expecting Handsontable APIs
(getCommentAtCell, getDataAtRowProp) while the grid could still be
sorted, since clearSort() only ran later, right before updateSettings().
On a sorted grid this read the wrong row's comment/value, corrupting
which formula cells got preserved across cancel. Move clearSort() (via
getCurrentSortConfigs()) ahead of those callbacks instead.
2026-09-03 11:47:24 +03:00
YuryShkoda 3380150d1c refactor(editor): harden pasteListener cleanup and document handsontable version pin
Build / Build-and-ng-test (pull_request) Successful in 5m58s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m39s
Build / Build-and-test-development (pull_request) Successful in 25m27s
2026-09-03 10:59:19 +03:00
YuryShkoda 2d7df66fc2 fix(deps): pin @handsontable/angular-wrapper to 18.0.0
Build / Build-and-ng-test (pull_request) Successful in 5m24s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m35s
Build / Build-and-test-development (pull_request) Successful in 25m4s
18.1.0 has a malformed license field (points at a logo SVG instead of a real identifier), failing the license checker's --onlyAllow gate.
2026-09-03 10:40:56 +03:00
YuryShkoda efd2e18c7b fix(deps): regenerate lockfile with strict peer-dep resolution to fix npm ci in CI
Build / Build-and-ng-test (pull_request) Failing after 1m51s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Failing after 2m0s
2026-09-03 10:19:38 +03:00
YuryShkoda 7da29bdb11 fix(deps): regenerate lockfile with Node 24 and pin handsontable to 18.0.0
Lighthouse Checks / lighthouse (pull_request) Failing after 1m3s
Build / Build-and-ng-test (pull_request) Failing after 45s
Build / Build-and-test-development (pull_request) Skipped
2026-09-03 09:37:48 +03:00
YuryShkoda 8f12fe74a6 chore: regenerated client/package-lock.json
Build / Build-and-ng-test (pull_request) Failing after 54s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Failing after 1m12s
2026-09-03 09:14:02 +03:00
YuryShkoda f4325b2056 fix: pin fast-uri to 3.1.7 to close high-severity SSRF/host-confusion advisories
Build / Build-and-ng-test (pull_request) Failing after 53s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Failing after 1m5s
2026-09-03 09:10:02 +03:00
YuryShkoda cc68c218d8 refactor(editor): document updateSettingsSortSafe's exceptions and dedupe sort-config normalization
Build / Build-and-ng-test (pull_request) Failing after 2m7s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Successful in 21m46s
2026-09-03 08:57:35 +03:00
allan d3b881fa85 Merge branch 'version7-13' into version7-13-fix
Build / Build-and-ng-test (pull_request) Successful in 5m55s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m23s
Build / Build-and-test-development (pull_request) Successful in 25m15s
2026-09-02 14:39:26 +00:00
YuryShkoda e139c37fbf fix(editor): fix formula $-substitution corruption and sorted-grid row/formula desync
Build / Build-and-ng-test (pull_request) Successful in 5m23s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m6s
Build / Build-and-test-development (pull_request) Successful in 25m7s
String.replace interpreted $&/$`/$'/$<digit> specially in DC.ORIG_VALUE/DC.USER_NAME substitutions, corrupting formulas whose cell data happened to contain a literal $. Separately, afterChange indexed dataSource with Handsontable's visual row instead of translating to physical (as beforeChange already does), desyncing EDIT_STATUS/overwritten-comment writes on a sorted grid. Investigating that surfaced a third, unrelated Handsontable bug: updateSettings() corrupts formula cell references whenever a sort is active, regardless of what it changes - fixed by clearing the sort around every updateSettings() call.
2026-09-02 17:19:58 +03:00
Unknown c4123e5c96 fix: ensure cleanup of casuser temp table in error condition
Build / Build-and-ng-test (pull_request) Successful in 5m26s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m58s
Build / Build-and-test-development (pull_request) Successful in 24m16s
2026-09-02 14:07:16 +01:00
hermes 1ed31f2a49 chore: docs
Build / Build-and-ng-test (pull_request) Successful in 5m27s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m52s
Build / Build-and-test-development (pull_request) Successful in 24m31s
2026-08-31 08:54:05 +01:00
allan 25434b35b9 Merge pull request 'fix(editor): submit a live formula's computed value, not its raw text' (#310) from process-formula into version7-13
Build / Build-and-ng-test (pull_request) Successful in 5m11s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m34s
Build / Build-and-test-development (pull_request) Successful in 24m12s
Reviewed-on: #310
2026-08-30 22:00:06 +00:00
hermes 490d0137b9 fix(stage): submit data via editor flow, use dynamic date assertion
Build / Build-and-ng-test (pull_request) Successful in 5m14s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m30s
Build / Build-and-test-development (pull_request) Successful in 24m11s
Rewrite stage.cy.ts to follow the same pattern as excel.cy.ts:
open MPE_X_TEST, attach regular_excel.xlsx, submit to create staged
data, then test the formatted/unformatted toggle on the stage page.

The date assertion is now dynamic: reads the raw SOME_DATE value
from the unformatted view and computes the expected SAS date9.
formatted value, rather than hardcoding 12FEB1960.

Remove the fixture stageSubmission code from makedata.js — staged
data is created at runtime by stagedata.js, not by makedata.
2026-08-30 22:29:40 +01:00
hermes f25ecd8828 fix(mocks): limit stage fixture to 1 row, fix column order
Build / Build-and-ng-test (pull_request) Successful in 5m12s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m49s
Build / Build-and-test-development (pull_request) Successful in 24m6s
The stage.cy.ts fixture had 7 rows of MPE_X_TEST data with wide string
values, causing Handsontable to auto-size columns wider so only 4 of
10 fit in the 1280px viewport. The test checks .ht_clone_top headers
which only render visible columns.

Limited to 1 row (matching the original sas9 mock) and moved
_____DELETE__THIS__RECORD_____ to the end of the column order.
2026-08-30 20:20:15 +01:00
hermes c180934167 fix(mocks): SAS datetime format in getchangeinfo, login in stage.cy.ts
getchangeinfo.js: use SAS datetime19. format (DDMMMYYYY:HH:MM:SS)
for SUBMITTED_ON_DTTM and REVIEWED_ON_DTTM, matching the real SAS
output. Use SUBMIT_STATUS_CD field name (not REVIEW_STATUS_ID)
to match the MPE_SUBMIT column name and getchangeinfo.sas output.

stage.cy.ts: add login step in beforeEach (the beforeAll logs out
after uploading the license, so each test needs to re-login).
Use loginAndUpdateValidKey(true) to force license upload.
2026-08-30 20:10:52 +01:00
hermes 6e2548d78c fix(mocks): add fixture staged data and MPE_SUBMIT row for stage.cy.ts
Build / Build-and-ng-test (pull_request) Successful in 5m44s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m25s
Build / Build-and-test-development (pull_request) Failing after 25m9s
stage.cy.ts navigates directly to /stage/DC20221007T122326121_612316_7259
and expects a hot table with MPE_X_TEST data. The mock had no fixture
staged.json or MPE_SUBMIT row for this table ID, so getstagetable
returned 0 rows and getchangeinfo returned empty jsparams.

Added a fixture staged.json with MPE_X_TEST rows (SOME_DATE=42) and
a matching MPE_SUBMIT row (SUBMITTED status) in makedata.js.
2026-08-30 19:25:42 +01:00
hermes 94d2a7970e fix(mocks): look up PK_FIELDS from MPE_TABLES in viewdata, fallback for MPE_AUDIT
Build / Build-and-ng-test (pull_request) Successful in 5m52s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m54s
Build / Build-and-test-development (pull_request) Failing after 25m39s
viewdata.js hardcoded PK_FIELDS as empty, so the viewbox grid treated
all columns as non-PK. removeAllColumns() could delete every column
including the ones the tests expect to be protected.

Now reads MPE_TABLES buskey (mirrors mp_getpk) and falls back to
LOAD_REF LIBREF DSN KEY_HASH TGTVAR_NM for MPE_AUDIT (which has a
known index-based PK in real SAS but isn't registered in MPE_TABLES).

All 12 viewbox.cy.ts tests now pass.
2026-08-30 19:18:36 +01:00
hermes c0af86ef29 fix(mocks): add LIBRARYNAME to startupservice, fix viewbox column order
Build / Build-and-ng-test (pull_request) Successful in 5m19s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m27s
Build / Build-and-test-development (pull_request) Failing after 27m3s
startupservice.js only returned LIBREF in saslibs, but the dc-tree
component renders LIBRARYNAME — without it the nav tree node text was
empty, so libraryToOpenIncludes could not match. Added LIBRARYNAME,
LIBRARYID, and ENGINE to match the viewlibs service format.

Changed libraryToOpenIncludes_SASJS from 'dc' to 'dc_jslib' to avoid
matching multiple libraries (DC_JSLIB and DC996664 both contain 'dc').

viewdata.js: removed alphabetical .sort() on cols (SAS preserves
physical column order via mp_getcols); added empty row with correct
SAS missing values ('.' for numeric, '' for character) when a table
has no data, so the viewbox grid can derive column headers.
2026-08-30 18:52:54 +01:00
hermes 34bd6607c5 fix(mocks): remove SOME_SHORTNUM HARDREGEX from MPE_VALIDATIONS
Build / Build-and-ng-test (pull_request) Successful in 5m51s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m6s
Build / Build-and-test-development (pull_request) Failing after 31m25s
The Excel fixture files (7th_tab, extra_column, duplicate_column,
duplicate_row, regular_xls, regular_with_delete, password, leading
whitespace) contain SOME_SHORTNUM values of 0, 1, and 2. The
HARDREGEX /^(?![0-2](\.\d+)?$).*/ blocks those values, aborting
the upload before it reaches the submit/approve flow. Removing the
rule allows all 23 excel.cy.ts tests and both liveness.cy.ts tests
to pass.
2026-08-30 10:30:32 +01:00
hermes e4b04b1d44 fix(mocks): rename saveTableData in postdata.js to avoid shadowing
Same shadowing issue as rejection.js: postdata.js defined its own
saveTableData(tableName, tableData, tableLibref) which was shadowed
by dcMockUtils.saveTableData(dataDir, tableName, tableData) from the
eval. Renamed to saveTableToLib to eliminate the collision.
2026-08-30 02:39:57 +01:00
hermes fed0396737 fix(mocks): remove shadowed saveTableData in rejection.js
rejection.js defined its own local saveTableData(tableName, tableData)
with 2 args, but dcMockUtils.js (loaded via eval) also defines
saveTableData(dataDir, tableName, tableData) with 3 args. The
dcMockUtils version was shadowing the local one, causing
saveTableData('MPE_SUBMIT', submitData) to pass the table name as
dataDir and the data object as tableName, crashing with
'TypeError: tableName.toLowerCase is not a function'.

Removed the local saveTableData and updated calls to use the
dcMockUtils 3-arg signature: saveTableData(dataDir, tableName, data).
2026-08-30 02:38:13 +01:00
hermes 4f7b845390 fix(mocks): remove MPE_VALIDATIONS and MPE_ALERTS from DC996664 libref
Build / Build-and-ng-test (pull_request) Successful in 5m20s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m59s
Build / Build-and-test-development (pull_request) Failing after 8h28m57s
The multi-load fixture sheets for DC996664.MPE_VALIDATIONS had data
misaligned with the schema, corrupting the shared submit state. The
tests only need MPE_X_TEST and MPE_TABLES, so only register those two.
2026-08-30 01:18:07 +01:00
hermes 13c10be30f fix(cypress): correct mock data, test expectations, and abort modal
Build / Build-and-ng-test (pull_request) Successful in 5m20s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m39s
Build / Build-and-test-development (pull_request) Failing after 34m1s
- editor.cy.ts: assert DC.USER_NAME is non-empty instead of hardcoded
  'sasdemo' (CI runs as a different OS user)
- editor.cy.ts: use =SOME_BESTNUM * 0 + 1936 for a deterministic formula
  result regardless of the column's actual value
- excel.cy.ts: expect computed value '2' instead of formula text '=1+1'
  (no XL_RULE=FORMULA configured on that column)
- excel-multi-load.cy.ts: use DC996664 libref to match the actual fixture
  sheet names
- makedata.js: add labels to DC_JSLIB.MPE_X_TEST schema (SOME_CHAR,
  SOME_DATE, SOME_DATETIME, SOME_TIME) for the viewer-labels tests
- makedata.js: register DC996664 libref with MPE_X_TEST/MPE_TABLES/
  MPE_VALIDATIONS/MPE_ALERTS and copy table files for multi-load fixtures
- makedata.js: change SOME_SHORTNUM HARDREGEX from [1-5] to [0-2]
- loadfile.js: exclude VAR_TXFROM/VAR_TXTO/VAR_PROCESSED columns from the
  missing-cols check for TXTEMPORAL tables (computed at load time)
- InfoModal.ts: add _PROGRAM to AbortDetails
- info-modal.component.html: display _PROGRAM in the abort modal
- 4 call sites: pass abortRes._PROGRAM when building AbortDetails
2026-08-29 23:53:13 +01:00
hermes 8e51fde524 fix(licensing): bridge async proceed() through cy.then and replace Response.arrayBuffer with manual stream reader
Build / Build-and-ng-test (pull_request) Successful in 5m9s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m31s
Build / Build-and-test-development (pull_request) Failing after 33m53s
- licensing.cy.ts: call proceed() unconditionally via cy.then() instead of conditionally chaining .then() after cy.wait(), so the command queue stays open across the async gap and enqueued commands always run
- combinedLicenceKey.ts: replace new Response(stream).arrayBuffer() with an explicit streamToArrayBuffer helper for broader browser support
- remove debug-license.cy.ts, an untracked throwaway repro for the promise-handling question
2026-08-29 20:13:22 +01:00
YuryShkoda 4db8d62dca fix(cypress): make licensing combined-key tests order-independent
Build / Build-and-ng-test (pull_request) Successful in 5m16s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m48s
Build / Build-and-test-development (pull_request) Failing after 33m43s
- Tests 7-10 only acted when already on the licensing page, silently
  no-oping otherwise; now they navigate to licensing/update explicitly
  when needed, chained via .then() to avoid Cypress conflating a raw
  async function's promise with the preceding cy.visit()/cy.wait()
- Replace Response(readable).arrayBuffer() with a direct
  ReadableStream reader loop in generateCombinedKey - the Response-based
  read never settled under Cypress, likely due to its fetch/Response
  patching for network interception
2026-08-29 14:06:11 +01:00
hermes 5d03164b6a fix: tests and realistic getcolvals.js
Build / Build-and-ng-test (pull_request) Successful in 5m49s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m56s
Build / Build-and-test-development (pull_request) Failing after 33m48s
2026-08-29 13:14:18 +01:00
hermes c0bc87d331 fix(tests): new libref
Build / Build-and-ng-test (pull_request) Successful in 5m27s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m39s
Build / Build-and-test-development (pull_request) Failing after 33m47s
2026-08-29 00:17:13 +01:00
hermes d59ef44226 fix: dynamic getdynamiccolvals.js
Build / Build-and-ng-test (pull_request) Successful in 5m22s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m27s
Build / Build-and-test-development (pull_request) Failing after 33m37s
2026-08-28 23:40:44 +01:00
hermes f213d24f09 fix: failing test
Build / Build-and-ng-test (pull_request) Successful in 5m24s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m25s
Build / Build-and-test-development (pull_request) Failing after 33m33s
2026-08-28 21:29:15 +01:00
YuryShkoda 20ba633087 feat(licensing): support combined-key paste, object-format features, and a live key preview
- Accept a single pasted/uploaded combined licence key (base64+gzip of
  licence+activation key), auto-detected in either paste mode, alongside
  the legacy two-field format
- Warn and block applying a key generated for the wrong protocol before
  it ever reaches the backend
- Decode both the legacy positional features string and a new named
  features object, so already-issued keys keep working unchanged
- Show a live "Key Details" preview (validity, users, site IDs, enabled
  features) as a key is typed, pasted, or uploaded
- Fix cypress test setup broken by the paste-format default change, and
  an unreliable FileReader-based base64 conversion in the test helpers
2026-08-28 20:01:45 +01:00
hermes a80927cbb6 fix: more mock improvements
Build / Build-and-ng-test (pull_request) Successful in 5m19s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m34s
Build / Build-and-test-development (pull_request) Failing after 33m31s
2026-08-28 16:25:29 +01:00
hermes cc2ff873fa fix: unnecessary getsubmits call removed
Build / Build-and-ng-test (pull_request) Successful in 5m19s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m40s
Build / Build-and-test-development (pull_request) Failing after 33m35s
2026-08-28 14:02:52 +01:00
YuryShkoda a104f78645 fix(editor): stop turning missing columns into undefined, and fix column lookup for sparse rows
Build / Build-and-ng-test (pull_request) Successful in 5m36s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m58s
Build / Build-and-test-development (pull_request) Failing after 33m41s
Writing back an unescaped cell's value unconditionally materialized a column the backend never populated as an explicit `undefined`, which the SASjs adapter rejects at submit time. dynamicCellValidation's column-name lookup (Object.keys(row)[column]) only worked by coincidence when every row had a full key set - fixed to use hot.colToProp instead.
2026-08-28 12:42:02 +03:00
hermes 3b9344cb60 fix: dynamic js mocks
Build / Build-and-ng-test (pull_request) Successful in 5m16s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m35s
Build / Build-and-test-development (pull_request) Failing after 33m28s
2026-08-28 00:35:31 +01:00
hermes 0082828543 fix: history mock
Build / Build-and-ng-test (pull_request) Successful in 5m16s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m32s
Build / Build-and-test-development (pull_request) Failing after 33m38s
2026-08-27 22:41:47 +01:00
hermes 3595bb9499 fix: using utility macro for webout
Build / Build-and-ng-test (pull_request) Successful in 5m52s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m26s
Build / Build-and-test-development (pull_request) Failing after 33m42s
2026-08-27 17:53:41 +01:00
hermes ee52bb8967 feat: functional JS mocks
Build / Build-and-ng-test (pull_request) Successful in 5m28s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m25s
Build / Build-and-test-development (pull_request) Failing after 33m34s
2026-08-27 17:21:01 +01:00
hermes 18a16fcb06 chore: lint fix
Build / Build-and-ng-test (pull_request) Successful in 5m53s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m3s
Build / Build-and-test-development (pull_request) Failing after 33m36s
2026-08-27 12:42:08 +01:00
YuryShkoda d72e19a308 fix(editor): resolve a primary key's live formula to its computed value, not the raw formula text
Build / Build-and-ng-test (pull_request) Successful in 5m12s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m40s
Build / Build-and-test-development (pull_request) Successful in 27m13s
2026-08-26 19:08:57 +03:00
YuryShkoda 2cc8489892 fix(editor): resolve computed value for a live formula in numeric columns too
Build / Build-and-ng-test (pull_request) Successful in 5m46s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m55s
Build / Build-and-test-development (pull_request) Successful in 26m47s
saveTable() only resolved a live formula's computed value for character columns - coerceNumericRow (beforePaste/beforeAutofill) deliberately leaves a non-numeric, formula-looking value alone rather than forcing it to NaN, so a numeric column can hold a live formula too. Its raw `=...` text was reaching the backend, which a numeric SAS field can't parse.
2026-08-26 10:52:47 +03:00
allan 1b1937bad8 Merge branch 'version7-13' into process-formula
Build / Build-and-ng-test (pull_request) Successful in 6m0s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m29s
Build / Build-and-test-development (pull_request) Successful in 27m4s
2026-08-25 15:43:39 +00:00
YuryShkoda b7d31066ae fix(editor): submit a live formula's computed value, not its raw text
Build / Build-and-ng-test (pull_request) Successful in 5m47s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m27s
Build / Build-and-test-development (pull_request) Successful in 27m6s
saveTable() only resolved computed values for HARDFORMULA/SOFTFORMULA
columns - a formula typed, pasted, or "Apply as formula"'d into any
other character column still had its raw `=...` text submitted,
since HyperFormula recomputes the display without ever mutating the
underlying dataSource string.
2026-08-25 18:15:58 +03:00
hermes 1f4aa6fcea fix: hardening following PR review feedback
Build / Build-and-ng-test (pull_request) Successful in 5m44s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m52s
Build / Build-and-test-development (pull_request) Successful in 26m20s
2026-08-24 15:11:46 +01:00
allan a7bb13c3ae Merge pull request 'feat(editor): translate column names to cell references on formula paste' (#308) from process-formula into version7-13
Build / Build-and-ng-test (pull_request) Successful in 5m15s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m31s
Build / Build-and-test-development (pull_request) Successful in 26m27s
Reviewed-on: #308
2026-08-21 17:14:45 +00:00
hermes 69b41559f7 fix: spy for startup
Build / Build-and-ng-test (pull_request) Successful in 5m18s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m27s
Build / Build-and-test-development (pull_request) Successful in 26m24s
2026-08-21 17:31:00 +01:00
hermes 917925f553 fix(deploy): Viya deploy checks, startup diagnostics, and chunked deploy script
Build / Build-and-ng-test (pull_request) Failing after 2m43s
Build / Build-and-test-development (pull_request) Skipped
Lighthouse Checks / lighthouse (pull_request) Successful in 21m6s
- Add StartupCheckService to show deploy check progress on loading screen
  with step-by-step status (appLoc check, Viya deploy, startup service)
- Add console logging throughout checkViyaDeploy and viyaMakedataSuccessfull
  to diagnose deploy flow issues
- Fix missing return after resolve(false) in viyaMakedataSuccessfull when
  folderId is undefined, which caused fall-through to getFolderMembers
  with an undefined ID
- Fix Viya Folders API pagination: getFolderMembers now requests limit=500
  so all members are returned (admin folder has 32 members, default page
  size was hiding makedata)
- Fix error handler in viyaMakedataSuccessfull to resolve(false) instead of
  reject() so the app falls back to setup screen on API errors
- Fix licence key whitespace: SAS makedata initialises keys as a single
  space which is truthy in JS; trim keys before checking so empty keys
  correctly fall back to free tier instead of triggering decryption errors
- Always set _debug=131 on makedata URLs (automatic and manual deploy)
  so full debug output is available for the one-time setup service
- Add makedata completion polling after runMakedataInNewWindow so the app
  auto-reloads when the makedata job self-deletes, instead of hanging
- Fix loading screen slider position from absolute to relative so it does
  not obscure the startup check steps
- Add chunk_deploy.py to sasjs/utils for chunked Viya deploys, splitting
  viya.sas by service and web file boundaries with correct %let path=
  tracking per chunk

Closes #303, #200, #125
2026-08-21 16:00:59 +01:00
YuryShkoda 12091c4044 fix(editor): re-mark a reverted cell as auto-escaped so "Apply as formula" works again
Build / Build-and-ng-test (pull_request) Successful in 5m19s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m37s
Build / Build-and-test-development (pull_request) Successful in 26m33s
dataSourceRaw is now escaped the same way dataSource is, so Revert
restores the escaped text a user actually saw instead of the raw
backend string (which would otherwise evaluate live again).
beforeChange re-marks a cell revert_cells restores to its escaped
form, distinguishing that from a user typing a literal leading `'`
themselves via the write's source tag.
2026-08-21 14:31:22 +03:00
YuryShkoda e69df3deb2 fix(editor): escape formula-looking values in uploaded Excel data
Build / Build-and-ng-test (pull_request) Successful in 5m47s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m15s
Build / Build-and-test-development (pull_request) Successful in 26m20s
Uploaded file content is bulk external data, not user-typed input, so
a `=`-led value in a character column must be escaped the same way a
fresh backend load is - otherwise it silently evaluates as a live
formula now that formulas are enabled for every table.
2026-08-21 09:59:55 +03:00
YuryShkoda d0d17995d3 chore: merge branch 'process-formula' of https://git.datacontroller.io/dc/dc into process-formula
Build / Build-and-ng-test (pull_request) Successful in 5m18s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m47s
Build / Build-and-test-development (pull_request) Failing after 26m20s
2026-08-20 18:50:05 +03:00
YuryShkoda 92d0d91440 feat(editor): scope live formulas to character columns, not just HARDFORMULA/SOFTFORMULA ones
Only backend-sourced `=`-led values are auto-escaped now; anything the
user types or pastes into a character column evaluates as a real
formula, and "Apply as formula" lets a user promote an auto-escaped
cell explicitly. Formulas are enabled on every table instead of only
ones with formula rules.
2026-08-20 18:44:47 +03:00
hermes 9dab3d50ef chore: sample record in mpe_x_test
Build / Build-and-ng-test (pull_request) Successful in 5m29s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m51s
Build / Build-and-test-development (pull_request) Successful in 25m32s
2026-08-20 12:07:50 +01:00
hermes f7db8719f5 fix: agent skills and nextviya deploys
Build / Build-and-ng-test (pull_request) Successful in 5m8s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m24s
Build / Build-and-test-development (pull_request) Successful in 25m20s
2026-08-19 17:17:30 +01:00
Yury 772a359da7 Merge branch 'version7-13' into process-formula
Build / Build-and-ng-test (pull_request) Successful in 5m40s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m30s
Build / Build-and-test-development (pull_request) Successful in 26m26s
2026-08-19 09:54:07 +00:00
YuryShkoda 1031ea7ed7 feat(editor): translate column names to cell references on formula paste
Build / Build-and-ng-test (pull_request) Successful in 5m48s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m28s
Build / Build-and-test-development (pull_request) Successful in 26m35s
- Paste a formula using column names (e.g. "=A_COL * B_COL") into any
  cell and have it translated to that row's cell references
  ("=B4 * C4") so HyperFormula can evaluate it - covers both a
  grid-level paste and pasting directly into an open cell editor
- Only applies on tables that already have formulas enabled (an
  existing HARDFORMULA/SOFTFORMULA column); otherwise the pasted text
  is left untouched rather than becoming inert translated text
- New substituteColumnReferences() reuses parseFormulaRule's
  boundary-matching helpers but deliberately skips DC.* variable
  substitution, which only makes sense for admin-defined rule values
2026-08-19 12:48:32 +03:00
4gl 2dfeb02faf chore: packages / deploy
Build / Build-and-ng-test (pull_request) Successful in 5m43s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m48s
Build / Build-and-test-development (pull_request) Successful in 26m22s
2026-08-19 10:45:57 +01:00
Yury 9deccd072d Merge pull request 'fix: core major bump plus autofix of viya context on deploy' (#306) from sasfixes into version7-13
Build / Build-and-ng-test (pull_request) Successful in 5m39s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m13s
Build / Build-and-test-development (pull_request) Successful in 26m26s
Reviewed-on: #306
2026-08-19 09:40:20 +00:00
hermes 9023eb2a39 fix: escape regex metacharacters in context name before prxchange
Build / Build-and-ng-test (pull_request) Successful in 5m30s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m5s
Build / Build-and-test-development (pull_request) Successful in 25m28s
symget('_contextname') is concatenated directly into the PRX replacement
string in makedata.sas. A context name containing \ or $ would be
interpreted as a backreference or variable interpolation in the Perl
regex replacement. Escape both characters with a leading backslash in a
data step before embedding the value in the prxchange call.
2026-08-18 14:46:34 +01:00
hermes 72484ae844 fix: clarify debug comment is permanent, extend ComputeContextDetails with Viya response fields
Build / Build-and-ng-test (pull_request) Successful in 5m30s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m2s
Build / Build-and-test-development (pull_request) Successful in 26m15s
- sasjs-configurator: rewrite _debug=131 comment to make explicit that
  debug is ALWAYS enabled for the makedata service (runs once during
  deployment, debug output always wanted for diagnostics). Remove the
  commented-out debug-off line that caused reviewer confusion.
- viya-compute-context-details.model: extend Attributes with
  allowXCMD, sessionInactiveTimeout (number), and make all attribute
  fields optional. Add Environment interface with autoExecLines string
  array. Add environment? to ComputeContextDetails (optional, not all
  contexts expose it).
- automatic.component: rewrite extractRunAs to use
  attributes.runServerAs directly per the actual Viya API response
  shape. Remove all any casts and the non-existent runAsUserId /
  environment.runAsUserId field probes.
2026-08-18 14:45:04 +01:00
hermes 003550b965 chore: reference configurator improvements for Viya deploy
Build / Build-and-ng-test (pull_request) Canceled after 0s
Build / Build-and-test-development (pull_request) Canceled after 0s
Lighthouse Checks / lighthouse (pull_request) Canceled after 0s
fixes #303
2026-08-18 12:44:57 +01:00
hermes 45226e19d6 chore: address PR #306 review feedback
- Add explanatory comments for deliberately enabled debug mode in configurator
- Fix deploy-field-description font-size from 0.55rem to 0.85rem (was unreadably small)
2026-08-18 12:44:54 +01:00
4gl df2027dab6 feat: updated configurator for Viya deploy
Build / Build-and-ng-test (pull_request) Successful in 5m34s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m2s
Build / Build-and-test-development (pull_request) Successful in 24m52s
2026-08-18 12:21:29 +01:00
4gl 6527c10f26 fix: core major bump plus autofix of viya context on deploy
Build / Build-and-ng-test (pull_request) Successful in 5m8s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m36s
Build / Build-and-test-development (pull_request) Successful in 25m4s
2026-08-17 15:46:52 +01:00
allan bf54a589f5 Merge pull request 'fix: address hermes review feedback (formula quoting, cell revert, addRow guard)' (#305) from pr-feedback into version7-13
Build / Build-and-ng-test (pull_request) Successful in 5m11s
Lighthouse Checks / lighthouse (pull_request) Successful in 22m1s
Build / Build-and-test-development (pull_request) Successful in 25m9s
Reviewed-on: #305
2026-08-17 12:43:26 +00:00
YuryShkoda 36963aa746 fix: address hermes review feedback (formula quoting, cell revert, addRow guard)
Build / Build-and-ng-test (pull_request) Successful in 5m41s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m42s
Build / Build-and-test-development (pull_request) Successful in 24m59s
- Escape embedded double quotes in DC.USER_NAME/DC.ORIG_VALUE formula
  literals, preventing malformed HyperFormula expressions
- Extract cell-revert numeric parsing into resolveRevertedCellValue,
  falling back to the raw text instead of writing NaN
- Guard addRow() against an empty dataSource before indexing into it
- Document the cross-repo assumption behind licence protocol-mismatch
  detection
2026-08-17 13:11:25 +03:00
allan 9b2e0df2b0 Merge pull request 'fix(core): bump to v5 (breaking change)' (#304) from corebump into version7-13
Build / Build-and-ng-test (pull_request) Successful in 5m6s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m22s
Build / Build-and-test-development (pull_request) Successful in 24m38s
Reviewed-on: #304
2026-08-14 11:05:18 +00:00
4gl 023c29f00f fix: mp_execute dep
Build / Build-and-ng-test (pull_request) Successful in 5m6s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m24s
Build / Build-and-test-development (pull_request) Successful in 25m2s
2026-08-14 10:34:59 +01:00
4gl 59e9e96f5a fix(core): bump to v5 (breaking change)
Build / Build-and-ng-test (pull_request) Successful in 5m12s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m15s
Build / Build-and-test-development (pull_request) Successful in 24m56s
2026-08-14 08:53:28 +01:00
4gl 067c08765b chore: adding additional mp_abort per per review
Build / Build-and-ng-test (pull_request) Successful in 5m43s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m38s
Build / Build-and-test-development (pull_request) Successful in 24m54s
2026-08-14 08:19:10 +01:00
4gl 9cd976495b chore(tidy up): remove trailing space and deprecated logic
Build / Build-and-ng-test (pull_request) Successful in 5m2s
Lighthouse Checks / lighthouse (pull_request) Successful in 21m22s
Build / Build-and-test-development (pull_request) Successful in 24m50s
2026-08-12 21:39:28 +01:00
196 changed files with 15180 additions and 17451 deletions

No files matched your search

-73
View File
@@ -1,73 +0,0 @@
---
name: sas
description: >
Use this skill whenever writing, modifying, or debugging SAS code in this repository — SAS
macros, sasjs services, hooks, or test files (*.sas). Triggers include: SAS macro compilation
errors, parameter parsing issues, writing sasjs tests with mp_assert / mp_assertdsobs /
mp_assertscope, macro-quoting questions (%str, %nrstr, %superq), %mp_abort usage, or unexpected
behaviour when passing free-text values (descriptions, messages) to macros. Also covers repo
conventions such as running `sasjs lint` after touching .sas files and the maximum line length
rule.
---
# SAS Development
Conventions and pitfalls for SAS code in this repository (macros in `sas/sasjs/macros/`, services
in `sas/sasjs/services/`, tests alongside them as `*.test.sas`).
## Always `%str()` free-text macro parameters
A comma inside a macro parameter value is parsed as a **parameter delimiter**. Free-text
parameters such as `desc=` (in `%mp_assert`, `%mp_assertdsobs`, `%mp_assertscope`) and `msg=` (in
`%mp_abort`) must be wrapped in `%str()` — even when they currently contain no comma, so later
edits cannot silently break the call.
Wrong — the text after the comma becomes an unexpected positional parameter and the compilation
fails (or worse, is misparsed):
```sas
%mp_assert(iftrue=(&oldrows=0),
desc=Test 2 - all staged records loaded, delete flags ignored,
outds=work.test_results
)
```
Right:
```sas
%mp_assert(iftrue=(&oldrows=0),
desc=%str(Test 2 - all staged records loaded, delete flags ignored),
outds=work.test_results
)
```
The same applies to any macro parameter that carries user-facing text: `%mp_abort(msg=%str(...))`,
`etlsource=` values containing punctuation (use `%superq()` when passing macro variables that may
contain special characters), etc.
Related quoting rules of thumb:
- `%str()` masks commas, parentheses, semicolons and quotes at compile time — sufficient for
static text like `desc=`.
- Use `%nrstr()` if the text must also mask `%` and `&` (rare in descriptions).
- Use `%superq(var)` when forwarding a macro **variable** whose value may contain special
characters (e.g. `etlsource=` in `mpe_targetloader.sas`).
## Tests must be idempotent
A test file must pass when run repeatedly (including after a run that failed partway). Conventions:
- Start the file with `%let syscc=0;` — many macros (e.g. `%mp_lockanytable(LOCK)`) abort on entry if `&syscc>0`, and any `WARNING` in a previous test bumps `syscc` to 4.
- Clean up **all** persistent state, not just the obvious one: `MPE_TABLES` registrations, `MPE_LOCKANYTABLE` lock records (a run dying between LOCK and UNLOCK leaves a stale `LOCKED` row), physical tables in `dctest` (`proc datasets ... delete`), and global macro variables created via `select ... into:` (`%symdel`).
- Make prep defensive: delete-then-insert config records (handles leftovers from an aborted run), and recreate physical tables rather than assuming they are absent.
## Repo conventions for .sas files
- Run `npx sasjs lint` from the `sas/` directory after creating or modifying any `.sas` file; the
files you touched must have zero warnings (pre-existing warnings in other files can be ignored).
- Maximum line length is 80 characters (lint-enforced) — this is why long `msg=%str(...)` values
sometimes need shortening.
- Test files are named `<thing>.test.sas` (or `<thing>.test.N.sas`) and run via
`npm run 4gl && sasjs test -t 4gl` from `sas/` — see `.agent/docs/testing.md`.
- `sas/sasjsbuild/` is generated build output — never hand-edit it; edit sources under
`sas/sasjs/` only.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
+82
View File
@@ -0,0 +1,82 @@
---
name: dc-sas
description: >
Use this skill alongside the sasjs/skills collection (sas, sasjs-core, sasjs-cli) when working on
Data Controller SAS code. Covers the repo-specific SAS knowledge that is NOT in those skills —
DC test-state conventions (MPE control tables, dctest, %let syscc) and the chunked-deploy
strategy for the huge generated build script (sasjsbuild/viya.sas). For general SAS language,
@sasjs/core macro, and @sasjs/cli guidance, rely on the sas, sasjs-core and sasjs-cli skills.
---
# SAS Development in Data Controller
The sas, sasjs-core and sasjs-cli skills cover general SAS language and SASjs conventions (macro
quoting, `%mp_assert*` testing style, `sasjs lint`, `sasjs run`, `sasjsbuild/` being generated
output). These notes only cover the parts specific to Data Controller.
## Tests must be idempotent
A test file must pass when run repeatedly (including after a run that failed partway).
- Clean up **all** persistent DC state, not just the obvious one: `MPE_TABLES` registrations,
`MPE_LOCKANYTABLE` lock records (a run dying between LOCK and UNLOCK leaves a stale `LOCKED`
row), physical tables in `dctest` (`proc datasets ... delete`), and global macro variables
created via `select ... into:` (`%symdel`).
## Chunked deploy to Viya
The full DC build script (`sasjsbuild/viya.sas`) is very large (11+ MB / 300k+ lines). The Viya
compute API can hang or fail when submitting a file this size in a single request.
**Chunked deploy.** Split the build script at `%let path=<folder>` boundaries — these are clean
section breaks between service/test folders (always preceded by blank lines, never inside a data
step). Each sub-chunk must be prepended with the shared header (the first ~3827 lines containing
macro definitions, `appLoc` setup, and logging options:
`options ps=max nonotes nosgen nomprint nomlogic nosource2 nosource noquotelenmax;`
Logging is already suppressed in the header — no extra action needed. Keep each chunk under ~1.5
MB. The `tests/macros`, `tests/services`, and streaming-app tail sections are the largest and may
need further sub-splitting at `%let service=` boundaries.
When splitting mid-folder (between services in the same folder), the sub-chunk that starts
mid-folder must re-assert `%let path=<folder>;` before its first `%let service=` line — otherwise
`&path` is unresolved and the `%mv_createwebservice(path=&appLoc/&path, ...)` call will abort with
a recursive reference error.
Deploy each chunk in order with `sasjs run <chunk>.sas -t <target>`. After all chunks are
deployed, run `sasjs request services/admin/makedata -d deploy/makeDataViya.json -t <target>` to
create the database.
**Non-fatal errors.** `ERROR: Unauthorized` on `/dataSources/providers/Compute/` lines in the
log are expected for non-admin Viya users — they come from the Data Sources API during
lineage/catalog refresh and do not affect the deploy.
## Repo conventions for .sas files
- Test files are named `<thing>.test.sas` (or `<thing>.test.N.sas`) and run via
`npm run 4gl && sasjs test -t 4gl` from `sas/` — see `.agents/docs/testing.md`.
- `sas/sasjsbuild/` is generated build output — never hand-edit it; edit sources under
`sas/sasjs/` only.
## Temp and scratch files stay out of the repo
Transient artifacts from manual test runs against sasjs-server — captured `_webout` JSON
responses (e.g. `*_out.json`), request/response logs (e.g. `*.log`), and iteration snapshots
(`vd_out2.json`, `stage_check2.json`, etc.) — must not be left in the working tree. They
clutter `git status`, are never referenced by source or tests, and easily leak local
filesystem paths (the sasjs-server session dir, `/home/.../sasjs_root/sessions/.../`) into
committed history.
Write them to a gitignored tmp location instead. The repo already provides two:
- `tmp/` (gitignored at repo root) — general scratch space.
- `sas/tmp/` (gitignored via the root `tmp/` rule) — for SAS-side artifacts.
If a helper script dumps captured output for comparison during a debug session, point it at
`tmp/` (or `sas/tmp/` for SAS-local paths) rather than alongside the tracked mocks in
`sas/mocks/`. The tracked mock fixtures live under `sas/mocks/sas9/` and
`sas/mocks/sasjs/services/`; loose `*_out.json` / `*.log` files at the `sas/mocks/` root are
not mocks, they are leftover captures — remove them with `git clean -fd sas/mocks/` or
write to `tmp/` in the first place.
File renamed without changes.
File renamed without changes.
File renamed without changes.
+63
View File
@@ -0,0 +1,63 @@
---
name: sas
description: Expert guidance for the SAS programming language — DATA step, PROC SQL, macro language, formats, ODS, and common procedures. Pure SAS syntax only, no SASjs-framework content. Use when writing, reviewing, or debugging .sas programs, or answering SAS language questions.
---
# SAS Language
Write idiomatic, production-quality SAS code. This skill covers the SAS language itself, independent of any framework.
## Scope
- DATA step programming (SET/MERGE/BY, RETAIN, arrays, DO loops, hash objects, first./last. processing)
- PROC SQL (joins, subqueries, views, pass-through with CONNECT TO)
- Macro language (%macro/%mend, macro variables, %local/%global, conditional %IF logic, quoting functions %STR/%NRSTR/%BQUOTE, CALL SYMPUTX)
- Common PROCs: SORT, MEANS/SUMMARY, FREQ, TRANSPOSE, REPORT, PRINT, CONTENTS, DATASETS, FORMAT, IMPORT/EXPORT
- Formats and informats (user-defined via PROC FORMAT, picture formats)
- ODS output (HTML, PDF, RTF, Excel, OUTPUT destination)
- File I/O: LIBNAME, FILENAME, INFILE/INPUT, FILE/PUT
## Non-negotiable: no WARNINGs
Generated SAS code must run cleanly — **zero WARNINGs (and zero ERRORs) in the log**. Treat every `WARNING:` as a defect: uninitialized variables, implicit type conversions, truncation notes that should be warnings, "no observations", unresolved macro references, etc. If a warning is truly unavoidable, suppress it deliberately (e.g. an explicit option) and comment why. Likewise avoid superfluous NOTEs where reasonable.
## Style rules
These follow the @sasjs/core coding standards — apply them to all SAS code:
- One statement per line; indentation = 2 spaces, no tabs, no trailing whitespace
- Lines no longer than 80 characters; unix (LF) line endings; UTF-8
- Avoid non-ASCII / special characters entirely — maximum compatibility across SAS installations and encodings
- Always end steps with `run;`; for `proc sql` (and CAS-connected procs) `quit;` is essential to avoid `WARNING: You cannot disconnect or terminate session ...` on Viya
- All dataset references must be 2-level (`work.blah`, not `blah`) — protects against `DATASTMTCHK=ALLKEYWORDS` and an active `USER` library
- Explicit `length` / `attrib` for character variables rather than relying on defaults (avoids implicit length=8 truncation)
- Use literal suffixes for clarity (`'01JAN2020'd`, `'12:30't`)
- Prefer `proc sort` with `nodupkey` over manual dedup logic
- Macros:
- Define with parentheses, even with no parameters: `%macro x();` not `%macro x;`
- Closing `%mend;` must repeat the macro name
- Macro calls are not terminated with a semicolon: `%my_macro()` not `%my_macro();`
- Mandatory parameters positional; optional parameters keyword (`var=`) style
- Macro names lowercase, verb-noun convention
- Macro variables without trailing dot (`&var` not `&var.`) unless needed to prevent incorrect resolution
- Macro variable NAMES are case-insensitive: `&Foo`, `&FOO`, and `&foo` all resolve to the same symbol (same for `%symexist`/`%superq`/`symget` arguments, which take a NAME not a value). Don't chase case mismatches as a bug — it's never the cause.
- ALL macro variables must be `%local` unless deliberately global (globals should use an application prefix to avoid collisions); use `call symputx` (not `symput`) in DATA steps
- Comment with `/* */` inside macros (asterisk comments are compiled into the macro)
- Guard macro logic with `%length(&var)=0` checks rather than `&var=` (empty comparisons are unsafe)
- Avoid naming collisions: use `%sysfunc`-/`&syslast`-based work tables (e.g. `data &output; set &syslast; run;`) rather than hard-coded names
- No open (non-macro) conditional code: wrap platform-branching or conditionally-executed blocks (e.g. `%if %mf_getplatform()=VIYA %then %do; ... %end;`) in a `%macro ... %mend` and invoke the macro. Open `%if` at program level fails in some execution contexts (job/scheduler/test harnesses) and hides scope leaks.
## Portability awareness
- Note when code differs between SAS 9.4 and Viya (e.g. CAS actions vs procs, `proc casutil` for sashdat loading, no X command on locked-down servers)
- Avoid hard-coded physical paths and engine-specific options unless asked
- No open macro code with if/else logic: wrap branching blocks in `%macro ... %mend` and call them — open `%if`/`%else` does not behave as expected in all SAS environments.
## Common pitfalls to flag when reviewing
- Unintended many-to-many MERGEs
- Automatic variable `_ERROR_` / implicit RETAIN surprises
- Macro timing issues: referencing `&macrovar` before it exists, `%if` evaluating data-step variables (use `if`/`symget` instead)
- Automatic macro variables (`&syscc`, `&syswarningtext`, `&syserrortext`, `&sysdate`, `&sysuserid`, etc.) are READ-ONLY — attempting to overwrite them (e.g. `%let syswarningtext=;` or `call symput('syscc',...)`) raises `ERROR: Unable to assign value to a macro variable that is read only` (or similar). Never try to "clear" them.
- Truncation from implicit length=8 on first assignment
- `proc sql` cartesian product warnings
+68
View File
@@ -0,0 +1,68 @@
---
name: sasjs-adapter
description: Frontend/Node integration with SAS backends using @sasjs/adapter — configuring the SASjs class, authentication (SAS 9, Viya, SASjs server), requests with input/output tables, file upload, and session management. Use when writing TypeScript/JavaScript that calls SAS services or jobs.
---
# @sasjs/adapter
`@sasjs/adapter` is the TypeScript library for calling SAS services/jobs from browsers or Node, with a unified API across three server types: `SAS9`, `SASVIYA`, `SASJS`.
## Basic setup
```ts
import SASjs from '@sasjs/adapter'
const sasjs = new SASjs({
serverUrl: 'https://sas.example.com',
serverType: 'SASVIYA', // SAS9 | SASVIYA | SASJS
appLoc: '/Public/app/myapp', // root folder of deployed services
contextName: 'SAS Job Execution compute context', // Viya only
debug: false
})
```
## Executing a request
```ts
const response = await sasjs.request('services/common/getdata', {
mytable: [{ col1: 'value', col2: 42 }] // input tables as JS arrays of objects
})
// response.result contains output tables sent back from SAS (_webout JSON)
```
- Input tables become SAS datasets via the `sasjs_tables` mechanism (work tables named after the JS keys).
- The SAS service must write JSON to `_webout` — conventionally with the `mp_jsonout` macro from @sasjs/core, wrapped in `proc stp`-style begin/end macros.
- Responses follow the `SASjsRequest`/`SASjsResponse` types; check `response.result` for tables and `response.log` where available.
## Authentication
- **SAS 9**: `sasjs.logIn(username, password)` (form-based against the stored process server). Session cookie is managed automatically.
- **Viya**: OAuth client/secret (client credentials grant) or authorization code flow; tokens are refreshed automatically. Configure via CLI (`sasjs add cred`) for Node usage.
- **SASJS server**: token-based auth against the sasjs/server API.
## Key classes / modules
- `SASjs` — main facade: `request()`, `logIn()/logOut()`, `uploadFile()`, `executeScript()`
- `SessionManager` — Viya compute session lifecycle
- `ContextManager` — Viya compute context selection
- `SASViyaApiClient` / `SAS9ApiClient` / `SASjsApiClient` — low-level per-platform clients (rarely needed directly)
- `file/` utilities — file upload to SAS (binary content handling)
## Tips
- Set `debug: true` to surface the SAS log in responses while developing.
- Always handle `response.status` / error responses — SAS-side errors (e.g. from `%mp_abort`) come back in the JSON, not necessarily as HTTP errors.
- For large payloads prefer CSV upload or streamed files over JSON input tables.
- Keep `appLoc` consistent with the `appLoc` in `sasjsconfig.json` used to deploy.
## Important: request() inputs are ALWAYS tables
Every key in the `data` object of `sasjs.request(path, data)` is serialized via the `sasjs_tables` CSV mechanism and arrives in SAS as a **work dataset named after the key** — even scalar values. You cannot pass ad-hoc macro variables this way; services must read inputs from the work table (e.g. `data _null_; set work.config; call symputx('rootdir', rootdir); run;`). Output column names in `response.result.<table>` come back UPPERCASE (SAS dataset semantics).
## Using the adapter without a bundler (zero-build / strict CSP frontends)
The package root `index.js` is a UMD bundle exposing a global `SASjs`. Pattern (from the minimal seed app):
1. `"prepare": "cp node_modules/@sasjs/adapter/index.js src/sasjs.js"` in package.json (runs on `npm i`).
2. `<script src="sasjs.js"></script>` before your app script.
3. Configure via a hidden custom element: `<sasjs serverType="SASJS" appLoc="/Public/app/myapp" debug="false"></sasjs>` and read attributes with `document.querySelector('sasjs')`. When the app is streamed by SAS itself, omit `serverUrl` — same-origin requests just work (CSP `default-src 'self'` safe).
+115
View File
@@ -0,0 +1,115 @@
---
name: sasjs-cli
description: Using the SASjs CLI (@sasjs/cli) to create, compile, build, deploy, run, and test SASjs projects against SAS 9, Viya, and SASjs server targets. Use for any `sasjs <command>` usage, CI/CD pipelines, target/auth config, sasjsconfig.json, service packs, or frontend streaming builds.
---
# @sasjs/cli
The SASjs CLI (`npm i -g @sasjs/cli`, invoked as `sasjs`) automates compiling, building, and deploying SAS projects. All commands support `-t <target>` to select a target from `sasjsconfig.json`.
## Targets and auth
- A **target** = `{ name, serverUrl, serverType, appLoc }`. `serverType` is one of `SAS9`, `SASVIYA`, `SASJS`.
- Credentials: `sasjs add cred` (or `.env` file). Viya uses client/secret **or** `sasjs auth login` (user/pass, no client/secret needed — see below); SAS 9 uses user/pass; SASJS server uses an access token.
- `sasjs context` manages Viya compute contexts; `sasjs add target` adds a new target.
## Core workflow
```
sasjs create myapp # scaffold a new app (templates available)
sasjs compile # gather macros/services/jobs into per-file build outputs (sasjsbuild/)
sasjs build # produce deployable artefacts: JSON + .sas per target
sasjs deploy # deploy compiled/built artefacts to the target server
sasjs cbd # compile + build + deploy in one step (-t viya etc.)
```
## Command reference
| Command | Purpose |
|---|---|
| `sasjs create / init` | Scaffold new app or add SASjs to existing repo |
| `sasjs compile` | Resolve dependencies (`<h4> SAS Macros </h4>` etc.) into `sasjsbuild/` |
| `sasjs build` | Create build JSON / service pack per target |
| `sasjs deploy` / `cbd` | Deploy to server (servicepack or direct) |
| `sasjs run <file.sas>` | Execute an arbitrary SAS file on the server, return log |
| `sasjs request <path>` | Execute a deployed service/job with input data (`-d`) |
| `sasjs job execute` | Run a deployed job |
| `sasjs flow execute` | Run a sequence of jobs with dependencies (CSV-defined flows) |
| `sasjs servicepack deploy` | Deploy from a JSON service pack |
| `sasjs web` | Build the frontend and stream it into the SAS web root (streamConfig) |
| `sasjs db` | Build database DDL/data load scripts from `sasjs/db` |
| `sasjs doc` | Generate doxygen documentation + lineage |
| `sasjs folder create/delete/move` | Manage folders in SAS metadata / SAS Drive |
| `sasjs fs` | File-system operations against the server (sync folders) |
| `sasjs test` | Execute tests defined in `sasjs/tests` with init/term programs |
| `sasjs lint` | Lint `.sas` files per `.sasjslint` config |
| `sasjs version` | Print/set version info |
## Conventions
- Test coverage is generated only from a `sasjs compile` (or `sasjs c`). It accepts a target (`-t <target>`), but nothing is deployed to that target — compilation and coverage are fully local/offline, so no server needs to be available or reachable. Missing macro dependencies (e.g. `mp_ds2csv.sas`) mean `@sasjs/core` isn't installed — run `npm i` first.
- Dependencies are declared in doxygen headers: `<h4> SAS Macros </h4>`, `<h4> SAS Files </h4>`, `<h4> SAS Folders </h4>`, and `@li item` entries — the CLI builds the dependency tree from these.
- `sasjs compile` output goes to the `sasjsbuild/` folder (git-ignore it); `sasjsresults/` holds test/run outputs.
- CI/CD: `sasjs cbd -t viya` is the standard deploy step; combine with `sasjs servicepack deploy` for artefact-based releases.
- Exit codes are non-zero on failure — safe for pipelines.
## Gotchas
- Run `npm i` before `sasjs cb` — macro dependency resolution needs `node_modules/@sasjs/core` present, and `@sasjs/core` (and `@sasjs/adapter` if used) must be listed in `package.json`.
- Credentials files are per-target: `.env.<targetname>` (e.g. `.env.server`) with `CLIENT`, `ACCESS_TOKEN`, `REFRESH_TOKEN`. Never commit them — gitignore `.env*`.
## Viya auth without a client/secret (`sasjs auth login`)
`sasjs auth login -t <target>` authenticates with a regular SAS username/password via the OAuth2 password grant against the built-in, secret-less `sas.cli` public client. No admin-registered OAuth client is needed — the fastest way to get `sasjs run`/`deploy` working on dev/demo estates. The password is never stored; the minted ACCESS_TOKEN/REFRESH_TOKEN pair is persisted to `.env.<target>` (local) or `~/.sasjsrc` (global) and verified via `/identities/users/@currentUser` (`Logged in as <id> (<name>)`). Bare `sasjs auth` is still an alias for `sasjs add cred`.
- Token expiry: the CLI silently refreshes via the stored refresh token (works with and without a client/secret), and re-persists the rotated pair — Viya refresh tokens are **single-use/rotating**, so this persistence is what keeps later invocations working. If refresh fails, re-run `sasjs auth login`.
- Some estates give `sas.cli` a short access-token TTL (e.g. 1h); a refresh on most invocations is normal.
- Opaque (non-JWT) tokens are treated as usable — the server is the authority on expiry.
- Limitations: local/LDAP accounts only (no SSO/SAML/MFA estates); password grant must be enabled for `sas.cli` (default on Viya 3.5+/4); ROPC is deprecated in OAuth 2.1 — use a registered client/secret for CI/production.
- `sasjs run` 403 on session creation = the account isn't authorised for the configured compute context — set `contextName: "SAS Studio compute context"` on the target. First run on a cold estate can take many minutes (compute pod spin-up) and may appear to hang.
- Self-signed estates: use `--insecure` on `auth login`, or configure `httpsAgentOptions` on the target.
## Viya streaming apps (streamConfig.streamWeb)
With `streamWeb: true`, `sasjs web`/`cbd -t viya` deploys the frontend **into SAS Files Service**: a streaming job at `<appLoc>/services/<streamServiceName>.html` serves `index.html`, and assets land in `<appLoc>/services/web/...`. At build time every asset/script/css URL in the HTML is rewritten to `/SASJobExecution?_FILE=<appLoc>/services/web/...` and the adapter config element (`<sasjs apploc=...>`) is stamped with the target `appLoc`.
**Consequence: the app only works when served from the exact `appLoc` it was deployed against.** If the streaming HTML is placed anywhere else (e.g. manually uploaded to a user home folder like `/Users/<id>/myapp/...`), all rewritten `/Public/app/...` asset links 404 and the adapter calls the wrong service paths — the page renders with no CSS/JS and no backend. Fix by redeploying. The original build (`sasjs cb`) has the apploc from the sasjsconfig.json - when the app is deployed as a SAS program, the supplied `%let apploc = ` (runtime value) is swapped with the `compiled_apploc` (build time value) to allow apps to be dynamically deployed to a given apploc at deploy time.
### Verifying a Viya deployment headlessly (no browser)
1. Get a token (password grant works out of the box with the built-in `sas.ec` client, empty secret):
`curl -X POST <server>/SASLogon/oauth/token -u 'sas.ec:' -d 'grant_type=password&username=U&password=P'`
2. Fetch the app: `GET /SASJobExecution/?_FILE=<appLoc>/services/<name>.html` with `Authorization: Bearer` → expect `200` and the full `index.html`. `401` = auth, anything else = not deployed there.
3. Fetch each asset the HTML references. Response tells you what's wrong:
- `200` with file content → asset deployed correctly.
- `202` + a tiny plain-text body (e.g. `Parameter Error\nFile error`) → **file does not exist at that Drive path** (classic appLoc-mismatch symptom). Note `_FILE` responses can be async: add `&_action=wait` to get content synchronously.
- Services: `POST /SASJobExecution/?_program=<appLoc>/services/<svc>&_action=wait` → `Parameter Error / Unable to get job definition` means the service was never deployed as a JES job (files on Drive alone are not enough — only `sasjs deploy`/`cbd`/`servicepack deploy` registers them).
### Talking to SAS — ALWAYS use the adapter or the CLI
When executing a SAS service or job for any purpose (debugging, reproduction, CI), **always go through the `@sasjs/adapter` or `sasjs` CLI** — never hand-roll curl against `SASJobExecution`. The adapter and CLI handle the things that are trivial to get wrong by hand: the input-data CSV format (space-separated `name:$format.` headers, CRLF, double-quoted special values, `%nrstr(...)` wrapping), the execution-mode routing (`_executionTasks=true` reads `sasjs<N>data` as **macro variables**, not file uploads), the `_debug`/`>>weboutBEGIN<<`/`>>weboutEND<<` wrapper parsing, the token refresh, and the `_contextname` URL param. A hand-built comma-separated CSV will read as blanks, silently skip guarded macro blocks, and send you down a rabbit hole of phantom bugs.
- Build input data as a JSON file: `{ "<table>": [{ "<col>": "<val>", ... }] }`, e.g. `{ "config": [{ "rootdir": "/export/...", "runastask": "true", "usecomputeapi": "null", "contextname": "Compute Reusable" }] }`.
- Run: `sasjs request '<appLoc>/services/common/<svc>' -t viya -d data.json -l <path>.log -o <path>.json`. The CLI hardcodes `debug: true`, so the `-l` flag always captures the full MPRINT/NOTE/`&syscc` log; `-o` saves the parsed webout. **Always pass `-l`** — reproducing a bug without the log means re-running the whole thing.
- The Viya Folders/JES REST APIs ARE fine to hit directly with curl (token + `Authorization: Bearer`) for folder/file/member management and for `GET /SASJobExecution/?_FILE=...` asset checks — just not for *executing your own services with input data*.
#### Adapter execution-context and input-data facts
- The adapter automatically appends `_contextname=<value>` as a **URL parameter** to every Viya JES request (you do NOT need to pass it yourself). BUT JES request params are **NOT auto-promoted to SAS macro variables** — `%symexist(_contextname)` is false inside the service. If the service needs the chosen context name (e.g. to stamp it into the streamed HTML), pass it in the **input data table** (a `contextname` column) and read it with `call symputx` — that is the reliable channel.
- The target's `contextName` in `sasjsconfig.json` decides which compute context the service runs under (and thus the `runAs` identity). The adapter's URL `_contextname` param is the same value. To reproduce a service under a batch/reusable context via `sasjs request`, set the target's `contextName` to that reusable context (e.g. `Compute Reusable`, runAs=sasbatch) — otherwise it runs as your own identity and write-test steps to batch-owned folders fail with `User does not have appropriate authorization level`.
- Adapter CSV format (so you can read the `NOTE: The infile ... is:` RULE in the log correctly): row 1 is the header with `name:$informat.` pairs **space-separated**; data rows are **comma-separated** (CRLF), with values double-quoted only if they contain a special char (`,`, `"`, tab, newline). The sasjs/core webout reader reads it back with `dsd` + `firstobs=2` + an `input <name>:$informat.;` statement derived from the header.
- `_executionTasks=true` (runAsTask) changes how input data arrives: as `sasjs<N>data` **macro variables** (chunked into `sasjs<N>data0..N`), NOT as `_WEBIN_FILE` uploads. The core webout `mv_webout` macro handles both, but it branches on `_EXECUTIONTASKS` — be aware when reading logs.
### Redeploying cleanly on Viya (the 409 Conflict problem)
Re-running `sasjs cbd`/`sasjs run viya.sas` against an **existing** appLoc often fails mid-deploy with `409 Conflict` (and an `mp_abort` → `abort cancel`): `mv_createfile` DELETEs the old file id then tries to recreate it, but when an intermediate **folder** already exists (e.g. `<appLoc>/services/web/js`) the recreate step conflicts and the whole deploy aborts — leaving a half-deployed app (services present, some assets missing). The `?recursive=true` folder DELETE also returns `409 You cannot delete the folder because it is not empty`, and individual member/folder DELETEs can return `403` even as the owner, so you cannot easily tear the tree down by hand.
The reliable workaround is to **move the top appLoc folder out of the way** and redeploy to the original path — the deploy creates a fresh folder tree with no conflicts, and the old folder is retained as a backup. This is far faster and more reliable than fighting per-member deletes, and is the recommended pre-deploy step for any non-CI redeploy on Viya. Two ways to move it:
- **Rename in place** (simplest): `PATCH /folders/folders/{id}` with `{"name":"<old>.bak.<ts>","version":2}` — frees the original name, keeps the old folder as a sibling backup.
- **MOVE into a backup parent** (tidier — keeps all backups in one place): create (once) a backup parent folder e.g. `/Users/<id>/macrodash-backups`, then `POST /folders/folders/{backupParentId}/members/{appLocFolderId}?action=move` moves the whole tree (with contents) into it, freeing the original path for the fresh deploy.
(On sasjs/server just `sasjs fs delete` the appLoc first — Drive there supports clean recursive deletes.)
JES applies its own CSP header when streaming (includes `unsafe-inline`/`unsafe-eval`); a strict CSP meta tag in the app's HTML still applies and is the one that matters for the app code.
+99
View File
@@ -0,0 +1,99 @@
---
name: sasjs-core
description: Standards and conventions for the @sasjs/core SAS macro library (mf_*, mp_*, mm*, ms_*, mv_* macros). Use when writing or editing SAS macros in a sasjs/core-style repo, picking an existing macro over reinventing one, or the sasjs/core build, lint, doxygen, and testing conventions.
---
# @sasjs/core — SAS Macro Library
@sasjs/core is an MIT-licensed library of production-quality SAS macros for SAS application development, portable across SAS 9 (meta), Viya, and SASjs server.
## Coding standards (mandatory)
- One macro per file; filename must match the macro name (lowercase, no spaces)
- Macro definitions must use parentheses: `%macro x();` not `%macro x;`
- Macro *calls* are NOT terminated with a semicolon: `%my_macro()` not `%my_macro();`
- All macro variables must be declared `%local` to prevent scope leakage
- Always use `mf_getuniquefileref` when assigning filerefs, and `mf_getuniquelibref` when assigning librefs (never hardcode or hand-roll unique references)
- 2-space indentation, no tabs, no trailing spaces, no invisible characters, max line length 300 (hard lint limit) but keep lines to 80 chars max where possible
- Every file must have a Doxygen header:
```sas
/**
@file
@brief One-line description of the macro
<h4> SAS Macros </h4>
@li mf_othermacro.sas
@param [in] paramname Description
@param [out] outparam Description
<h4> Related Macros </h4>
@li mp_related.sas
@version 9.4
@author Your Name
**/
```
## Folder / prefix conventions
| Folder | Prefix | Platform |
|---|---|---|
| `base/` | `mf_` (function-style), `mp_` (procedure-style) | All platforms |
| `meta/` | `mm_` | SAS 9 metadata |
| `metax/` | `mmx_` | SAS 9 metadata (OS command dependent) |
| `viya/` | `mv_` | Viya |
| `server/` | `ms_` | SASjs server |
| `xplatform/` | `mx_` | Runtime platform detection |
| `fcmp/`, `lua/`, `ddl/` | — | PROC FCMP functions, LUA wrappers, DDL |
Use `mf_` macros when the macro returns a value usable in an expression; use `mp_` for procedural macros that generate code/statements.
**Cross-suite rule:** `mp_` macros must never reference `mx_` macros. Platform dispatching (SAS 9 / Viya / SASjs server) belongs in the `mx_` suite, which delegates to `ms_`/`mv_`/PROC STP per platform. If an `mp_` macro seems to need platform-specific behaviour, the macro itself belongs in `xplatform/` as an `mx_` macro instead.
## Reuse before writing
Before writing a new macro, check the library for an existing one — common utilities already exist, e.g. `mp_abort` (the deprecated `mf_abort` is retained for backwards compatibility — don't use it in new code), `mf_existds`, `mf_existvar`, `mf_existfileref`, `mf_getuser`, `mp_jsonout` (SAS datasets → JSON for `_webout`), `mp_ds2ddl`, `mp_hashdataset`. Platform-specific variants exist under `meta/`, `viya/`, `server/` and are selected at compile time by the CLI.
## Aborting safely
Never invoke `%mp_abort` from inside an `%if/%else` block — as a procedural macro, the macro processor can continue executing statements after it before the abort takes effect. Use the `iftrue=` condition parameter instead:
```sas
%mp_abort(iftrue= (&syscc ne 0)
,mac=&_program
,msg=%str(Something went wrong)
)
```
When `%mp_abort` is called from within a `%include` block, SAS cannot exit cleanly (e.g. to `_webout`). Call `%mp_abort(mode=INCLUDE)` after the include (OUTSIDE any macro wrapper) — it checks `work.mp_abort_errds` for an abort status:
```sas
%mp_abort(mode=INCLUDE)
```
Note: `%include`s inside macros should be performed with `%mp_include()` so the `_SYSINCLUDEFILEDEVICE` indicator is set and the abort dataset (`work.mp_abort_errds`) is passed back to the calling program.
## Testing macros (mandatory conventions)
- **Always apply `%mp_assertscope` around the macro under test** to catch scope leakage (macro variables must stay `%local`):
```sas
%mp_assertscope(SNAPSHOT)
%mx_foo(args)
%mp_assertscope(COMPARE,
desc=Test 1: mx_foo does not leak scope,
outds=work.test_results
)
```
- Assertions go to `work.test_results` via `%mp_assert(iftrue=(...), desc=..., outds=work.test_results)`.
## Lint and build
- Run `sasjs lint` after every change; do not consider work done until it passes
- NEVER bump the version in `package.json` (semantic-release handles it)
- Do NOT edit generated files by hand: `all.sas`, `mc_*.sas`, the `lua/` wrappers, and `sasjsbuild/` outputs are produced by the CI build
- Markdown files: never hard-wrap; one paragraph per line
+103
View File
@@ -0,0 +1,103 @@
---
name: sasjs-framework
description: Building full SASjs applications — project structure, sasjsconfig.json, services/jobs/macros folders, multi-target (SAS 9 / Viya / SASjs server) configuration, streaming frontends, mocks and tests. Use when creating or modifying a SASjs app, editing sasjsconfig.json, or writing backend services returning JSON to a web frontend.
---
# SASjs Framework — Building SASjs Applications
A SASjs app = a web frontend (any framework: Angular, React, vanilla) + SAS backend code organised in a standard layout, compiled and deployed by `@sasjs/cli` to SAS 9, Viya, or SASjs server. Frontend talks to SAS via `@sasjs/adapter`; backend services return JSON via `_webout`.
## Standard project layout
```
sasjs/
sasjsconfig.json # project + target configuration
macros/ # project-specific macros (macroFolders)
services/ # web services called from the frontend
jobs/ # jobs (scheduled / flow / long-running)
programs/ # plain programs (initProgram, termProgram, utilities)
db/ # DDL + static data per library (sasjs db)
tests/ # tests run by `sasjs test`
mocks/ # mock responses for offline frontend dev (syncFolder)
doxy/ # extra doxygen content for `sasjs doc`
```
## sasjsconfig.json
Root config holds defaults; each entry in `targets[]` can override them. Key sections:
- `macroFolders`, `binaryFolders` — where the CLI finds macros/binaries
- `serviceConfig.serviceFolders` — service source folders; `initProgram` runs before every service (set up libnames, options)
- `jobConfig.jobFolders` — job source folders
- `programFolders` — programs compiled/deployed with the app
- `streamConfig` — `streamWeb: true` streams the built frontend into SAS so it is served by the platform itself (no separate web server needed); `webSourcePath` points at the frontend build output
- `syncFolder` — folder synced to the server (e.g. mocks)
- `testConfig` — init/term programs for `sasjs test`
- `targets[]` — per-environment overrides: `serverUrl`, `serverType` (`SAS9`/`SASVIYA`/`SASJS`), `appLoc` (deploy root, e.g. `/Public/app/myapp`), target-specific macroFolders (e.g. `targets/viya/macros_viya` for platform shims), `httpsAgentOptions`, `deployConfig`
The full JSON schema is bundled at `sasjsconfig-schema.json` next to this file — validate config changes against it. Reference it with `"$schema": "https://cli.sasjs.io/sasjsconfig-schema.json"`.
## Streamed frontend files on Viya (mime types)
When `streamWeb: true`, the CLI uploads the frontend (`index.html`, renamed per `streamServiceName`, plus css/js) to the Viya Files service using the `%mv_createfile` macro. That macro creates the file in a very particular way to ensure it streams correctly:
- POSTs to `/files/files` with the content type derived from the extension (`%mf_mimetype`)
- sets `typeDefName=file_html` (via `%mv_getViyaFileExtParms`) so the file is recognised as HTML
- sends `Content-Disposition` **without** `attachment` for HTML/SVG so it renders in the browser
**Never update a streamed frontend file in place** with a `filename filesrvc` fileref + data step rewrite — the Files service then treats it as a generic blob and the mime type is lost, so the app no longer streams (browser downloads it or shows raw text). To modify a streamed file at runtime (eg patching the compute `contextname` in the html), read it (a `filesrvc` fileref is fine for *reading*), write the modified content to a temp fileref, and **re-create the file with `%mv_createfile(path=..., name=..., inref=...)`** (it deletes the old file and re-POSTs with the correct mime type).
## Service contract (frontend ↔ SAS)
1. Adapter POSTs to `services/<folder>/<name>` with input tables (arrays of objects) → work datasets named after the JS keys.
2. Service SAS code runs after `initProgram`; it reads inputs, does work, and writes output JSON to `_webout`.
3. Conventional pattern using @sasjs/core macros:
```sas
/**
@file
@brief Example service returning data
<h4> SAS Macros </h4>
@li mp_jsonout.sas
@li mp_abort.sas
**/
/* validation / logic here */
%mp_jsonout(OPEN)
%mp_jsonout(OBJ,results,dslabel=results)
%mp_jsonout(CLOSE)
```
4. On error, abort cleanly with `%mp_abort(...)` (`mf_abort` is deprecated) so the adapter receives a structured error in the JSON, not a half-written response. Do **not** call `%mp_abort` inside an `%if/%else` block — the macro processor may keep executing beyond the abort. Use the conditional `iftrue=` parameter instead, e.g.:
```sas
%mp_abort(iftrue= (%mf_existds(work.results)=0)
,mac=&_program
,msg=%str(No results found)
)
```
If the abort happens inside a `%include` block, SAS cannot exit to `_webout` cleanly — after the include, call `%mp_abort(mode=INCLUDE)` (outside any macro wrapper), which checks `work.mp_abort_errds` for an abort status.
## Multi-target discipline
- Keep backend code platform-neutral in shared folders; put platform-specific shims in `targets/<name>/macros_*` folders and register them only on that target.
- Platform capability macros exist in @sasjs/core (`mm_*` metadata, `mv_*` Viya, `ms_*` server) — don't branch on server type by hand.
## Quality gates (follow the conventions of mature apps like Data Controller)
- Run `sasjs lint` after touching any `.sas` file; fix all warnings in files you touched.
- The linter enforces 2-space indentation everywhere, including continuation lines inside `/* ... */` block comments — never align comment text with 3+ spaces.
- Add tests and run `sasjs test` for backend logic changes. When testing macros, always wrap the macro under test with `%mp_assertscope(SNAPSHOT)` / `%mp_assertscope(COMPARE, ...)` to catch macro-variable scope leakage, and wrap any platform-branching code in `%macro` wrappers (no open conditional macro code in test programs).
- Provide mocks in `sasjs/mocks` so the frontend can be developed without a live SAS server.
- Never auto-commit or bump versions; releases are pipeline-driven (conventional commits).
- Markdown files: no hard wrapping — one paragraph per line.
- Apps must work offline/on-prem: no external CDN assets in the frontend bundle.
## Reference implementations
Look at existing apps for patterns: folder layouts, `sasjsconfig.json` multi-target setups, service structure, streaming builds, and test/mock conventions, eg:
* https://git.datacontroller.io/dc/dc
* https://github.com/sasjs/react-seed-app
* https://github.com/sasjs/macro-dash
@@ -0,0 +1,966 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/sasjs/utils/blob/main/src/types/sasjsconfig-schema.json",
"type": "object",
"title": "SASjs Config File",
"description": "The SASjs Config file provides the settings and structure for your SASjs project. ",
"default": {},
"examples": [
{
"macroFolders": ["macros"],
"programFolders": ["programs"],
"binaryFolders": ["binaries"],
"defaultTarget": "viya",
"targets": [
{
"name": "viya",
"serverType": "SASVIYA",
"serverUrl": "https://sas.sasjs.com",
"appLoc": "/Public/app",
"contextName": "SAS Job Execution compute context",
"deployConfig": {
"deployServicePack": true,
"deployScripts": ["sasjsbuild/myviyadeploy.sas"]
},
"serviceConfig": {
"serviceFolders": ["targets/viya/services/admin"],
"initProgram": "build/serviceinit.sas",
"termProgram": "build/serviceinit.sas",
"macroVars": {
"name": "viyavalue",
"extravar": "this too"
}
},
"jobConfig": {
"jobFolders": [],
"initProgram": "",
"termProgram": "",
"macroVars": {}
},
"streamConfig": {
"assetPaths": [],
"streamWeb": false,
"streamWebFolder": "webv",
"webSourcePath": "dist"
},
"testConfig": {
"initProgram": "sasjs/tests/testinit.sas",
"termProgram": "sasjs/tests/testterm.sas",
"macroVars": {
"testVar": "testValue"
},
"testSetUp": "sasjs/tests/testsetup.sas",
"testTearDown": "sasjs/tests/testteardown.sas"
},
"macroFolders": ["targets/viya/macros"],
"programFolders": [],
"binaryFolders": ["binaries"]
},
{
"name": "sas9",
"serverType": "SAS9",
"serverUrl": "https://sas.sasjs.com:7980",
"appLoc": "/User Folders/&sysuserid/My Folder",
"serverName": "Foundation",
"repositoryName": "SASApp",
"buildConfig": {
"buildOutputFileName": "mysas9deploy.sas",
"initProgram": "",
"termProgram": "",
"macroVars": {}
},
"deployConfig": {
"deployScripts": ["build/deploysas9.sh"],
"deployServicePack": false
},
"serviceConfig": {
"serviceFolders": ["targets/sas9/services/admin"],
"initProgram": "",
"termProgram": "build/servicetermother.sas",
"macroVars": {}
},
"streamConfig": {
"assetPaths": [],
"streamWeb": false,
"streamWebFolder": "web9",
"webSourcePath": "dist"
},
"testConfig": {
"initProgram": "sasjs/tests/testinit.sas",
"termProgram": "sasjs/tests/testterm.sas",
"macroVars": {
"testVar": "testValue"
},
"testSetUp": "sasjs/tests/testsetup.sas",
"testTearDown": "sasjs/tests/testteardown.sas"
},
"macroFolders": ["targets/sas9/macros"],
"programFolders": [],
"binaryFolders": ["binaries"]
}
]
}
],
"properties": {
"binaryFolders": {
"$id": "#/properties/binaryFolders",
"type": "array",
"title": "The binaryFolders array",
"description": "These local folders are searched for Binary Files when running sasjs compile. Folders are relative to the sasjs/sasjsconfig.json file.",
"examples": [["binaries", "../../more_binaries"]]
},
"sasjsBuildFolder": {
"$id": "#/properties/sasjsBuildFolder",
"type": "string",
"title": "sasjsBuildFolder",
"description": "The name of the folder containing the compiled output. The `sasjs build` command will take all of the subfolders here as inputs to create the build pack. By default this will be named `sasjsbuild`. In global, the default is `~/.sasjsbuild`.",
"default": "sasjsbuild",
"examples": ["sasjsbuild", ".sasjsbuild"]
},
"sasjsResultsFolder": {
"$id": "#/properties/sasjsResultsFolder",
"type": "string",
"title": "sasjsResultsFolder",
"description": "The name of the folder containing the output (eg logs, ODS output) from `sasjs run`. By default this will be named `sasjsresults`. In global, the default is `~/.sasjsresults`.",
"default": "sasjsresults",
"examples": ["sasjsresults", ".sasjsresults"]
},
"defaultTarget": {
"$id": "#/properties/defaultTarget",
"type": "string",
"title": "Default Target",
"description": "If a target is not specified, this target is used by default. The default target must exist in the (local) targets array.",
"default": "viya",
"examples": ["viya"]
},
"docConfig": {
"$id": "#/properties/docConfig",
"type": "object",
"title": "The docConfig schema",
"description": "SASjs uses doxygen to auto-generate HTML documentation using the headers in your SAS programs, macros, services & jobs. For more info, see [https://cli.sasjs.io/doc](https://cli.sasjs.io/doc). Some properties are taken from package.json (such as the project Name).",
"default": {
"dataControllerUrl": "https://mysasserver.com/web/datacontroller/#",
"enableLineage": true,
"doxyContent": {
"readMe": "../../README.md"
}
},
"examples": [
{
"displayMacroCore": true,
"outDirectory": "/some/output/directory",
"dataControllerUrl": "https://mysasserver.com/web/datacontroller/#",
"enableLineage": true,
"doxyContent": {
"readMe": "../../my/custom/homepage.md",
"path": "my/custom/doxy/folder"
}
}
],
"properties": {
"displayMacroCore": {
"$id": "#/properties/docConfig/properties/displayMacroCore",
"type": "boolean",
"title": "The displayMacroCore docConfig option",
"description": "The CLI will autocompile macro dependencies that exist in the SASjs Macro Core library. These will also show in the documentation under 'node_modules'. If you'd prefer not to show these in the rendered docs, set this value to false.",
"default": true,
"examples": [true]
},
"outDirectory": {
"$id": "#/properties/docConfig/properties/outDirectory",
"type": "string",
"title": "The outDirectory docConfig option",
"description": "The location to which the generated HTML SAS documentation is written. If missing, or left blank, the files will be written to the `sasjsbuild/doc` directory (default behaviour).",
"default": "sasjsbuild/doc",
"examples": ["/my/preferred/docs/directory"]
},
"dataControllerUrl": {
"$id": "#/properties/docConfig/properties/dataControllerUrl",
"type": "string",
"title": "The dataControllerUrl docConfig option",
"description": "Provide the full URL to Data Controller so that `sasjs doc` can link the lineage diagram directly to the table viewer in [Data Controller](https://datacontroller.io).\nIf left blank, or undefined, no links will be generated.",
"default": "",
"examples": ["https://yourserver.co.uk/dcviya/#"]
},
"enableLineage": {
"$id": "#/properties/docConfig/properties/enableLineage",
"type": "boolean",
"title": "Enable Lineage",
"description": "If true, sasjs doc will generate and display Data Lineage from Jobs and Services.",
"default": true
},
"doxyContent": {
"$id": "#/properties/docConfig/properties/doxyContent",
"type": "object",
"title": "doxyContent",
"description": "Configuration of the Doxyfile variables",
"default": {},
"examples": [
{
"favIcon": "favicon.ico",
"footer": "new_footer.html",
"header": "new_header.html",
"layout": "DoxygenLayout.xml",
"logo": "logo.png",
"readMe": "../../README.md",
"stylesheet": "new_stylesheet.css",
"path": "sasjs/doxy"
}
],
"properties": {
"favIcon": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/favIcon",
"type": "string",
"title": "Doxygen favicon",
"description": "The favicon used in the doxygen documentation",
"default": "favicon.ico"
},
"footer": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/footer",
"type": "string",
"title": "Doxygen footer",
"description": "The footer HTML file used in the doxygen documentation",
"default": "new_footer.html"
},
"header": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/header",
"type": "string",
"title": "Doxygen header",
"description": "The header HTML file used in the doxygen documentation",
"default": "new_header.html"
},
"layout": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/layout",
"type": "string",
"title": "Doxygen Layout XML File",
"description": "The layout XML file used to build the doxygen documentation",
"default": "DoxygenLayout.xml"
},
"logo": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/logo",
"type": "string",
"title": "Doxygen Logo",
"description": "The logo file used by doxygen",
"default": "logo.png"
},
"readMe": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/readMe",
"type": "string",
"title": "Doxygen Homepage",
"description": "The file used to generate the doxygen homepage (defaults to the readme.md)",
"default": "../../README.md"
},
"stylesheet": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/stylesheet",
"type": "string",
"title": "Doxygen CSS",
"description": "The CSS file used to extend Doxygen",
"default": "new_stylesheet.css"
},
"path": {
"$id": "#/properties/docConfig/properties/doxyContent/properties/path",
"type": "string",
"title": "Doxygen Path",
"description": "The path to the Doxygen configuration files (relative to sasjs/sasjsconfig.json)",
"default": "sasjs/doxy"
}
}
}
}
},
"httpsAgentOptions": {
"$id": "#/properties/httpsAgentOptions",
"type": "object",
"title": "httpsAgentOptions",
"description": "Configure https agent by setting all supported attribute such as `key`, `cert`, `ca`, `rejectUnauthorized` and `requestCert`",
"examples": [
{
"allowInsecureRequests": false,
"caPath": "path/to/caFile",
"keyPath": "path/to/keyFile",
"certPath": "path/to/certFile",
"requestCert": false,
"rejectUnauthorized": true
}
],
"properties": {
"allowInsecureRequests": {
"$id": "#/properties/httpsAgentOptions/properties/allowInsecureRequests",
"type": "boolean",
"title": "allowInsecureRequests",
"description": "If you are having certificate errors connecting to SAS, that cannot be properly resolved, try setting this value to true. This option only has an effect if rejectUnauthorized is not present.",
"default": false,
"examples": [true, false]
},
"caPath": {
"$id": "#/properties/httpsAgentOptions/properties/caPath",
"type": "string",
"title": "caPath",
"description": "Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.",
"examples": ["path/to/caFile"]
},
"keyFile": {
"$id": "#/properties/httpsAgentOptions/properties/keyFile",
"type": "string",
"title": "keyFile",
"description": "Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.",
"examples": ["path/to/keyFile"]
},
"certFile": {
"$id": "#/properties/httpsAgentOptions/properties/certFile",
"type": "string",
"title": "certFile",
"description": "Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.",
"examples": ["path/to/certFile"]
},
"requestCert": {
"$id": "#/properties/httpsAgentOptions/properties/requestCert",
"type": "boolean",
"title": "requestCert",
"description": "If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.",
"default": false,
"examples": [true, false]
},
"rejectUnauthorized": {
"$id": "#/properties/httpsAgentOptions/properties/rejectUnauthorized",
"type": "boolean",
"title": "rejectUnauthorized",
"description": "If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.",
"default": true,
"examples": [true, false]
}
}
},
"buildConfig": {
"$id": "#/properties/buildConfig",
"type": "object",
"title": "buildConfig",
"description": "Dictates which files get compiled into the build program (.sas), used to deploy services into SAS 9 or Viya environments (without a client/secret). You may use this config to include build specific macros, programs or macro variables - which is run a single time, on deployment - for things like database creation, or exporting a SAS 9 SPK after service creation.",
"examples": [
{
"initProgram": "build/buildinit.sas",
"termProgram": "build/buildterm.sas",
"macroVars": {
"name": "value",
"numvar": "42"
},
"buildOutputFileName": "buildpack.sas"
}
],
"properties": {
"buildOutputFileName": {
"$id": "#/properties/buildConfig/properties/buildOutputFileName",
"type": "string",
"title": "buildOutputFileName",
"description": "The name of the generated .sas program, which can be used to deploy the app using only SAS Studio. By default, this will be the name of the target.",
"examples": ["viya.sas", "sas9.sas"]
},
"initProgram": {
"$id": "#/properties/buildConfig/properties/initProgram",
"type": "string",
"title": "The buildConfig initProgram",
"description": "The path to a .sas program that will be inserted at the start of the build .sas program (created when running `sasjs build`).",
"default": "sasjs/buildinit.sas"
},
"termProgram": {
"$id": "#/properties/buildConfig/properties/termProgram",
"type": "string",
"title": "The buildConfig termProgram",
"description": "The path to a .sas program that will be inserted at the end of the build .sas program (created when running `sasjs build`).",
"default": "sasjs/buildterm.sas"
},
"macroVars": {
"$id": "#/properties/buildConfig/properties/macroVars",
"type": "object",
"title": "The buildConfig macro variables",
"description": "A series of name value pairs that will be turned into SAS macro variables in the build .sas program (generated when running `sasjs build`). The example provided will generate sas code as follows:\n```\n%let name=value;\n%let numvar=42;\n```",
"default": {},
"examples": [
{
"name": "value",
"numvar": "42"
}
]
}
}
},
"deployConfig": {
"$id": "#/properties/deployConfig",
"type": "object",
"title": "The deployConfig schema",
"description": "The deployConfig object enables settings that relate to the deployment of a SAS app - be that Viya, or SAS 9, or a pure Base environment.",
"default": {},
"examples": [
{
"deployScripts": ["build/deployscript.sh"]
},
{
"deployScripts": ["build/deployscript.sh"],
"deployServicePack": true
}
],
"properties": {
"deployScripts": {
"$id": "#/properties/deployConfig/properties/deployScripts",
"type": "array",
"title": "The deployConfig deployScripts array",
"description": "These scripts are executed when running `sasjs deploy`. If the file is a .sas file, it is executed on the SAS server (Viya only). Otherwise it is executed locally. These scripts are run AFTER the deployment of the servicepack, if `deployServicePack:true` (Viya only).",
"default": [],
"examples": [["build/deployscript.sh", "build/myprogram.sas"]]
},
"deployServicePack": {
"$id": "#/properties/deployConfig/properties/deployServicePack",
"type": "boolean",
"title": "The deployConfig deployServicePack flag",
"description": "If set to `true` the json pack produced by `sasjs build` will be auto-deployed to the `appLoc` of the specified target (creating all jobs and services in the SAS folder tree). Currently only Viya is supported for this flag.",
"default": false
}
}
},
"serviceConfig": {
"$id": "#/properties/serviceConfig",
"type": "object",
"title": "The serviceConfig schema",
"description": "The serviceConfig object defines how SASjs web services are compiled. Web services differ from jobs in that they include some fixed pre-code (eg the macros to stream out the result json).",
"default": {},
"examples": [
{
"serviceFolders": ["services/common", "services/admin"],
"initProgram": "build/serviceinit.sas",
"termProgram": "build/serviceterm.sas",
"macroVars": {
"mac1": "value",
"mac2": "42"
}
}
],
"required": [],
"properties": {
"serviceFolders": {
"$id": "#/properties/serviceConfig/properties/serviceFolders",
"type": "array",
"title": "The serviceConfig serviceFolders array",
"description": "When running `sasjs compile`, all programs in the folders defined in this array are compiled and placed into same-named folders under `sasjsbuild/services`. They will be compiled as services (so, with the service pre-code). Folders can be absolute, or relative to the `sasjs` folder.",
"default": [],
"examples": [["services/common", "services/admin"]]
},
"initProgram": {
"$id": "#/properties/serviceConfig/properties/initProgram",
"type": "string",
"title": "The serviceConfig initProgram",
"description": "The serviceConfig `initProgram` is a .sas file that is inserted at the start of every SAS service (after compiled macros and any `macroVars`, and before the service itself). ",
"default": "",
"examples": ["build/serviceinit.sas"]
},
"termProgram": {
"$id": "#/properties/serviceConfig/properties/termProgram",
"type": "string",
"title": "The serviceConfig termProgram",
"description": "The serviceConfig termProgram is inserted at the end of every service as part of `sasjs compile`.",
"default": "",
"examples": ["build/serviceterm.sas"]
},
"macroVars": {
"$id": "#/properties/serviceConfig/properties/macroVars",
"type": "object",
"title": "The `serviceConfig` macroVars",
"description": "This object allows `sasjs compile` to insert specific macro variables at the start of every service. In this case, the code generated would be:\n```\n%let mac1=value;\n%let mac2=42;\n```",
"default": {},
"examples": [
{
"mac1": "value",
"mac2": "42"
}
]
}
}
},
"jobConfig": {
"$id": "#/properties/jobConfig",
"type": "object",
"title": "The jobConfig schema",
"description": "The jobConfig object defines how SASjs Jobs are compiled. ",
"default": {},
"examples": [
{
"jobFolders": ["jobs/extract", "jobs/load"],
"initProgram": "jobs/jobinit.sas",
"termProgram": "jobs/jobterm.sas",
"macroVars": {
"mac1": "value",
"mac2": "42"
}
}
],
"properties": {
"jobFolders": {
"$id": "#/properties/jobConfig/properties/jobFolders",
"type": "array",
"title": "The jobConfig jobFolders array",
"description": "When running `sasjs compile`, all programs in the local folders defined in this array are compiled and placed into same-named folders under `sasjsbuild/jobs`. Folders can be absolute, or relative to the local project `/sasjs` folder.",
"default": [],
"examples": [["jobs/extract", "jobs/transform", "jobs/load"]]
},
"initProgram": {
"$id": "#/properties/jobConfig/properties/initProgram",
"type": "string",
"title": "The jobConfig initProgram",
"description": "The jobConfig `initProgram` is a local .sas file that is inserted at the start of every SAS Job (after compiled macros and any `macroVars`, and before the Job itself). ",
"default": "",
"examples": ["jobs/jobinit.sas"]
},
"termProgram": {
"$id": "#/properties/jobConfig/properties/termProgram",
"type": "string",
"title": "The jobConfig termProgram",
"description": "The jobConfig termProgram is inserted at the end of every Job as part of `sasjs compile`.",
"default": "",
"examples": ["jobs/jobterm.sas"]
},
"macroVars": {
"$id": "#/properties/jobConfig/properties/macroVars",
"type": "object",
"title": "The `jobConfig` macroVars",
"description": "This object allows `sasjs compile` to insert specific macro variables at the start of every Job. In this case, the code generated would be:\n```\n%let mac1=value;\n%let mac2=42;\n```",
"default": {},
"examples": [
{
"mac1": "value",
"mac2": "42"
}
]
}
}
},
"streamConfig": {
"$id": "#/properties/streamConfig",
"type": "object",
"title": "streamConfig",
"description": "SASjs allows a local web app to be compiled such that all html, css, javascript, and other assets such as png or mp4 are converted into web services and streamed directly from SAS.\n\nThis approach is convenient as it bypasses the need to deploy to a web server. ",
"default": {},
"examples": [
{
"assetPaths": [],
"streamWeb": false,
"streamWebFolder": "webv",
"webSourcePath": "dist",
"streamLogo": "logo.png"
}
],
"required": ["streamWeb"],
"properties": {
"assetPaths": {
"$id": "#/properties/streamConfig/properties/assetPaths",
"type": "array",
"title": "The streamConfig assetPaths array",
"description": "An array of local folders. All assets placed in these folders are converted into web services - example file types could be png, svg, mp3, mp4, excel - anything really.",
"default": [],
"examples": [["/myassets"]]
},
"streamLogo": {
"$id": "#/properties/streamConfig/properties/streamLogo",
"type": "string",
"title": "Icon shown in AppStream (sasjs/server)",
"description": "Provide the location of a square image, under the webSourcePath. Used as the display icon on the appStream page.",
"default": "logo.png",
"examples": ["logo.png", "favicon.ico"]
},
"streamWeb": {
"$id": "#/properties/streamConfig/properties/streamWeb",
"type": "boolean",
"title": "The streamConfig streamWeb flag",
"description": "When set to `true`, frontend files saved in the `webSourcePath` will be converted to streaming services in the `streamWebFolder` in SAS.",
"default": false,
"examples": [true]
},
"streamWebFolder": {
"$id": "#/properties/streamConfig/properties/streamWebFolder",
"type": "string",
"title": "The streamConfig streamWebFolder",
"description": "This is the target SAS folder (relative to the appLoc) where the compiled web assets will be created.",
"default": "webv"
},
"webSourcePath": {
"$id": "#/properties/streamConfig/properties/webSourcePath",
"type": "string",
"title": "The webSourcePath schema",
"description": "Active when `streamConfig` is `true`. Is the source (or build, or dist) LOCAL folder, relative to the `sasjs` folder, which contains the frontend to be deployed. All assets (PNG, JS, CSS, HTML etc) are taken from here and converted to streaming services in `streamWebFolder`. In Viya and SAS 9, any relative URLS will be modified such that the links still work and the assets still load.",
"default": "dist",
"examples": ["dist", "build"]
},
"streamServiceName": {
"$id": "#/properties/streamConfig/properties/streamServiceName",
"type": "string",
"title": "streamServiceName Schema",
"description": "The name of the service containing the `index.html` for a streaming web app. Defaults to `clickme` and is always deployed under the appLoc/services SAS Folder.",
"default": "clickme.sas"
}
}
},
"testConfig": {
"$id": "#/properties/testConfig",
"type": "object",
"title": "testConfig",
"description": "Create tests for Macros, Services & Jobs by simply adding a '.test.sas' extension. ",
"default": {
"initProgram": "sasjs/tests/testinit.sas",
"termProgram": "sasjs/tests/testterm.sas",
"macroVars": {
"testVar": "testValue"
},
"testSetUp": "sasjs/tests/testsetup.sas",
"testTearDown": "sasjs/tests/testteardown.sas"
},
"properties": {
"initProgram": {
"$id": "#/properties/testConfig/properties/initProgram",
"type": "string",
"title": "The jobConfig initProgram",
"description": "The testConfig `initProgram` is a local .sas file that is inserted at the start of every Test (after compiled macros and any `macroVars`, and before the Test itself). ",
"default": "",
"examples": ["sasjs/tests/testinit.sas"]
},
"termProgram": {
"$id": "#/properties/testConfig/properties/termProgram",
"type": "string",
"title": "The jobConfig termProgram",
"description": "The testConfig termProgram is inserted at the end of every Test as part of `sasjs compile`.",
"default": "",
"examples": ["jobs/jobterm.sas"]
},
"macroVars": {
"$id": "#/properties/testConfig/properties/macroVars",
"type": "object",
"title": "The `jobConfig` macroVars",
"description": "This object allows `sasjs compile` to insert specific macro variables at the start of every Test. In this case, the code generated would be:\n```\n%let mac1=value;\n%let mac2=42;\n```",
"default": {},
"examples": [
{
"mac1": "value",
"mac2": "42"
}
]
},
"testSetUp": {
"$id": "#/properties/testConfig/properties/testsetup",
"type": "string",
"title": "The jobConfig testSetUp",
"description": "This program is the first to execute as part of 'sasjs test'. It does not contain the testInit, testTerm or macroVariables. It IS compiled.",
"default": "sasjs/tests/testsetup.sas",
"examples": ["sasjs/tests/testsetup.sas"]
},
"testTearDown": {
"$id": "#/properties/testConfig/properties/testTearDown",
"type": "string",
"title": "The jobConfig testTearDown",
"description": "The last program to execute as part of 'sasjs test'.",
"default": "sasjs/tests/testteardown.sas",
"examples": ["sasjs/tests/testteardown.sas"]
}
}
},
"macroFolders": {
"$id": "#/properties/macroFolders",
"type": "array",
"title": "The macroFolders array",
"description": "These local folders are searched for SAS Macros when running `sasjs compile`. Folders are relative to the `sasjs/sasjsconfig.json` file.",
"default": [],
"examples": [["macros", "../../more_macros"]]
},
"programFolders": {
"$id": "#/properties/programFolders",
"type": "array",
"title": "The programFolders array",
"description": "These local folders are searched for SAS Programs when running `sasjs compile`. Folders are relative to the `sasjs/sasjsconfig.json` file.",
"default": [],
"examples": [["programs", "../../more_programs"]]
},
"syncFolder": {
"$id": "#/properties/syncFolder",
"type": "string",
"title": "Sync Folder",
"description": "The contents of this folder are simply copied to the sasjsbuild directory AFTER the rest of the project is compiled. Useful for synchronising random / generic content with SAS logical folders.",
"default": "sasjs/static_files"
},
"syncDirectories": {
"$id": "#/properties/syncDirectories",
"type": "array",
"title": "syncDirectories",
"description": "Maps the local filesystem to remote (SAS) physical directories.",
"examples": [
[
{
"local": "C:\\temp\\local\\fs1",
"remote": "/opt/data/fs1"
},
{
"local": "C:\\temp\\elsewhere",
"remote": "/opt/somewhere"
}
]
]
},
"targets": {
"$id": "#/properties/targets",
"type": "array",
"title": "The targets array",
"description": "A target is an alias for a deployment location, and includes at a minimum, the `serverUrl`, `serverType` and `appLoc`. This array allows multiple targets to be defined (eg dev / test / prod). Any properties defined here will override same-named properties in the sasjsconfig root.",
"default": [],
"examples": [
[
{
"name": "sas9target",
"serverType": "SAS9",
"serverUrl": "https://mysas9server",
"appLoc": "/Shared Folders/myApp"
}
],
[
{
"name": "viya",
"serverType": "SASVIYA",
"serverUrl": "https://sas.sasjs.com",
"appLoc": "/Public/app",
"contextName": "SAS Job Execution compute context",
"buildConfig": {
"buildOutputFileName": "myviyadeploy.sas",
"initProgram": "build/buildinitviya.sas",
"termProgram": "targets/viya/viyabuildterm.sas",
"macroVars": {
"name": "viyavalue",
"extravar": "this too"
}
},
"deployConfig": {
"deployServicePack": true,
"deployScripts": ["sasjsbuild/myviyadeploy.sas"]
},
"serviceConfig": {
"serviceFolders": ["targets/viya/services/admin"],
"initProgram": "build/serviceinit.sas",
"termProgram": "build/serviceinit.sas",
"macroVars": {
"name": "viyavalue",
"extravar": "this too"
}
},
"streamConfig": {
"assetPaths": [],
"streamWeb": false,
"streamWebFolder": "webv",
"webSourcePath": "dist"
},
"testConfig": {
"initProgram": "sasjs/tests/testinit.sas",
"termProgram": "sasjs/tests/testterm.sas",
"macroVars": {
"testVar": "testValue"
},
"testSetUp": "sasjs/tests/testsetup.sas",
"testTearDown": "sasjs/tests/testteardown.sas"
},
"macroFolders": ["targets/viya/macros"]
},
{
"name": "sas9",
"serverType": "SAS9",
"serverUrl": "https://sas.sasjs.com:7980",
"appLoc": "/User Folders/&sysuserid/My Folder",
"serverName": "Foundation",
"repositoryName": "SASApp",
"buildConfig": {
"buildOutputFileName": "mysas9deploy.sas",
"initProgram": "",
"termProgram": "",
"macroVars": {}
},
"deployConfig": {
"deployScripts": ["build/deploysas9.sh"],
"deployServicePack": false
},
"serviceConfig": {
"serviceFolders": ["targets/sas9/services/admin"],
"initProgram": "",
"termProgram": "build/servicetermother.sas",
"macroVars": {}
},
"streamConfig": {
"assetPaths": [],
"streamWeb": false,
"streamWebFolder": "web9",
"webSourcePath": "dist"
},
"testConfig": {
"initProgram": "sasjs/tests/testinit.sas",
"termProgram": "sasjs/tests/testterm.sas",
"macroVars": {
"testVar": "testValue"
},
"testSetUp": "sasjs/tests/testsetup.sas",
"testTearDown": "sasjs/tests/testteardown.sas"
},
"macroFolders": ["targets/sas9/macros"],
"programFolders": []
}
]
],
"items": {
"$id": "#/properties/targets/items",
"anyOf": [
{
"$id": "#/properties/targets/items/anyOf/0",
"type": "object",
"title": "SASjs Targets",
"description": "A target provides the configuration specific to a particular deployment, eg DEV / TEST, or SAS9 / SASVIYA.",
"default": {},
"examples": [
{
"name": "viya",
"serverType": "SASVIYA",
"serverUrl": "https://sas.sasjs.com",
"appLoc": "/Public/app",
"contextName": "SAS Job Execution compute context",
"buildConfig": {
"buildOutputFileName": "myviyadeploy.sas",
"initProgram": "build/buildinitviya.sas",
"termProgram": "targets/viya/viyabuildterm.sas",
"macroVars": {
"name": "viyavalue",
"extravar": "this too"
}
},
"deployConfig": {
"deployServicePack": true,
"deployScripts": ["sasjsbuild/myviyadeploy.sas"]
},
"serviceConfig": {
"serviceFolders": ["targets/viya/services/admin"],
"initProgram": "build/serviceinit.sas",
"termProgram": "build/serviceinit.sas",
"macroVars": {
"name": "viyavalue",
"extravar": "this too"
}
},
"jobConfig": {
"jobFolders": [],
"initProgram": "",
"termProgram": "",
"macroVars": {}
},
"streamConfig": {
"assetPaths": [],
"streamWeb": false,
"streamWebFolder": "webv",
"webSourcePath": "dist"
},
"testConfig": {
"initProgram": "sasjs/tests/testinit.sas",
"termProgram": "sasjs/tests/testterm.sas",
"macroVars": {
"testVar": "testValue"
},
"testSetUp": "sasjs/tests/testsetup.sas",
"testTearDown": "sasjs/tests/testteardown.sas"
},
"macroFolders": ["targets/viya/macros"],
"programFolders": []
}
],
"required": ["name", "serverType", "appLoc"],
"properties": {
"name": {
"$id": "#/properties/targets/items/anyOf/0/properties/name",
"type": "string",
"title": "Target name property",
"description": "A target name can only contain alphanumeric characters and dashes. It cannot contain spaces. It is used as the alias when referencing the target using the `-t` attribute in many of the SASjs commands.",
"default": "",
"examples": ["viya"]
},
"serverType": {
"$id": "#/properties/targets/items/anyOf/0/properties/serverType",
"type": "string",
"title": "The Target serverType",
"description": "The serverType can be either SAS9, SASVIYA or SASJS.",
"default": "",
"examples": ["SASVIYA"]
},
"appLoc": {
"$id": "#/properties/targets/items/anyOf/0/properties/appLoc",
"type": "string",
"title": "The Target appLoc",
"description": "The appLoc provides the root SAS folder location under which all jobs and services are deployed and executed. The SAS folder could be metadata in SAS 9, or SAS Drive in Viya. ",
"default": "",
"examples": ["/Public/app"]
},
"binaryFolders": {
"$ref": "#/properties/binaryFolders"
},
"buildConfig": {
"$ref": "#/properties/buildConfig"
},
"contextName": {
"$id": "#/properties/targets/items/anyOf/0/properties/contextName",
"type": "string",
"title": "The Target contextName",
"description": "The name of the compute context used to execute SAS code. The context determines the way in which the SAS session is spawned (eg user credentials, autoexec code, system options etc).\nContexts can be created / modified / deleted using the `sasjs context` command.",
"default": "SAS Job Execution compute context",
"examples": ["SAS Job Execution compute context"]
},
"deployConfig": {
"$ref": "#/properties/deployConfig"
},
"httpsAgentOptions": {
"$ref": "#/properties/httpsAgentOptions"
},
"serverUrl": {
"$id": "#/properties/targets/items/anyOf/0/properties/serverUrl",
"type": "string",
"title": "The Target serverUrl",
"description": "The serverUrl is the location to which the app is deployed, and against which any server based operations are performed. If SAS is served from a particular port, that port should also be included here.",
"default": "",
"examples": [
"https://sas.sasjs.com",
"https://sas.sasjs.com:8080"
]
},
"serviceConfig": {
"$ref": "#/properties/serviceConfig"
},
"jobConfig": {
"$ref": "#/properties/jobConfig"
},
"docConfig": {
"$ref": "#/properties/docConfig"
},
"streamConfig": {
"$ref": "#/properties/streamConfig"
},
"syncDirectories": {
"$ref": "#/properties/syncDirectories"
},
"syncFolder": {
"$ref": "#/properties/syncFolder"
},
"testConfig": {
"$ref": "#/properties/testConfig"
},
"macroFolders": {
"$ref": "#/properties/macroFolders"
},
"programFolders": {
"$ref": "#/properties/programFolders"
},
"sasjsBuildFolder": {
"$ref": "#properties/sasjsBuildFolder"
},
"sasjsResultsFolder": {
"$ref": "#properties/sasjsResultsFolder"
}
}
}
]
}
}
}
}
+83
View File
@@ -0,0 +1,83 @@
---
name: sasjs-server
description: Installing, configuring, and running @sasjs/server — the open-source NodeJS wrapper around the SAS binary that provides a REST API, filesystem (SASjs Drive), Stored Program execution, and web app streaming. Covers desktop vs server modes, runtimes (SAS/JS/Python/R), env vars, auth (tokens, LDAP), and mock servers. Use when deploying, troubleshooting, or developing against sasjs/server.
---
# @sasjs/server
SASjs Server is an open-source NodeJS wrapper for calling the SAS binary executable. It runs on a real SAS server or a local desktop and provides:
- A filesystem (SASjs Drive) for storing SAS programs and content
- Execution of Stored Programs from a URL (equivalent to SAS 9 Stored Processes / Viya Jobs)
- Web app streaming (serve frontend apps straight from SAS content)
- A REST API with Swagger docs
- Portability: apps built for SASjs Server deploy unchanged to SAS 9 / Viya via @sasjs/cli
## Modes
- **Desktop mode** (`MODE=desktop`, default): single-user, no authentication, no database. CORS enabled by default.
- **Server mode** (`MODE=server`): multi-user with authentication, requires a database (`DB_CONNECT`, `DB_TYPE=mongodb|cosmos_mongodb`). CORS disabled by default — configure `WHITELIST` if enabling.
## Installation
Download the relevant zip from GitHub releases and run the packaged executable (`api-linux`, etc.):
```bash
curl -L https://github.com/sasjs/server/releases/latest/download/linux.zip > linux.zip
unzip linux.zip && ./api-linux
```
On first run it prompts (unless set as env vars) for the SAS executable path and the filesystem location for Stored Programs/temp files. Docker is also supported (`DockerfileApi`, docker-compose files in the repo).
## Configuration via environment variables
Set in `/etc/environment`, exported, prepended to the command, or in a `.env` file alongside the executable. Key variables:
| Variable | Purpose |
|---|---|
| `MODE` | `desktop` (default) or `server` |
| `SAS_PATH` | Path to `sas.exe` / `sas.sh` |
| `RUN_TIMES` | Comma-separated runtime priority, e.g. `sas,js,py` — options: `sas`, `js`, `py`, `r`. Each needs its path: `SAS_PATH`, `NODE_PATH`, `PYTHON_PATH`, `R_PATH` |
| `SASJS_ROOT` | Working directory: SAS WORK, staged files, drive, config |
| `DRIVE_LOCATION` | Location for files, sasjs packages, `appStreamConfig.json` |
| `PROTOCOL` / `PORT` | `http` (default) or `https` (needs `PRIVATE_KEY`, `CERT_CHAIN`, optional `CA_ROOT`); default port 5000 |
| `SAS_OPTIONS` / `SASV9_OPTIONS` | Extra SAS system options auto-applied to sessions (Windows vs Unix), e.g. `-NOXCMD` |
| `DB_CONNECT` / `DB_TYPE` | MongoDB connection string / type — required for server mode |
| `AUTH_PROVIDERS` + `LDAP_*` | LDAP auth: `LDAP_URL`, `LDAP_BIND_DN`, `LDAP_BIND_PASSWORD`, `LDAP_USERS_BASE_DN`, `LDAP_GROUPS_BASE_DN` |
| `CORS` / `WHITELIST` | CORS is only applied when `CORS=enable`, and only origins in `WHITELIST` (space-separated) receive `Access-Control-Allow-Origin` — an empty whitelist means NO cross-origin calls work |
| `MOCK_SERVERTYPE` / `STATIC_MOCK_LOCATION` | Emulate `sas9`/`sasviya` API responses for frontend testing against a sasjs server (static canned files only — no logic) |
## Developing against the API
- Server type for @sasjs/adapter / CLI targets is `SASJS` (`serverType: 'SASJS'`); auth is token-based.
- The REST API is self-documented via Swagger on the running instance.
- Server-side execution uses `ms_*` macros from @sasjs/core (e.g. `ms_createfile`, `ms_adduser2group`) — services/jobs deployed by the CLI work as on other platforms.
- Repo layout (for contributors): `api/` (Express/TypeScript backend: controllers, routes, middlewares, model), `web/` (frontend), `restClient/` (REST examples), `mongo-seed/` (server-mode DB seed).
## Mock services with the JS runtime (no SAS required)
With `RUN_TIMES=js` (and `NODE_PATH` set), any `.js` file on SASjs Drive is an executable Stored Program — this is how react-seed-app / Data Controller provide **mock backends** for frontend development. Desktop mode (`MODE=desktop`) has no auth, which makes local mocking trivial.
Writing a JS stored program (docs: https://server.sasjs.io/storedprograms/#js-programs):
- The runtime template predeclares `const fs = require('fs')`, `_program`, `weboutPath`, `_SASJS_TOKENFILE`, `_SASJS_WEBOUT_HEADERS`, `_SASJS_USERNAME` / `_SASJS_USERID` / `_SASJS_DISPLAYNAME`, `_METAPERSON`, `_METAUSER`, `SASJSPROCESSMODE`. **Do NOT redeclare `fs`** — `const fs = require('fs')` in your program crashes it with `Identifier 'fs' has already been declared`.
- Output: assign a JSON **string** to `_webout` (e.g. `_webout = JSON.stringify({...})`); it is written back only if non-empty. `console.log()` output is returned in the response `log` (like a SAS log). Custom response headers can be written as lines to the `_SASJS_WEBOUT_HEADERS` file.
- Mimic real services by including the standard SASjs automatic fields in the JSON: `_PROGRAM` (from `_program`), `SYSDATE` / `SYSTIME` (format `DDMMMYY` / `HH:mm`), `_METAUSER`, `SASJSPROCESSMODE`.
- URL/body parameters arrive as `const <name> = \`<value>\`` strings.
- Input tables (the `sasjs_tables` mechanism) arrive **either** as an inline CSV const **or** — when the adapter sends multipart — as an uploaded `<name>.csv` file in the session folder, referenced by generated module-scope consts (handle BOTH):
- `_WEBIN_FILE_COUNT` (always created), `_WEBIN_NAME<n>` (table/field name), `_WEBIN_FILENAME<n>` (original filename), `_WEBIN_FILEREF<n>` (file **contents**, a Buffer from `fs.readFileSync` — call `.toString('utf8')`)
- these consts are **not on `globalThis`** — look them up with `typeof` guards or direct `eval()` in module scope (server-side JS, no CSP)
- adapter CSV quirks: header row is **space-separated** `name:format.` entries (e.g. `rootdir:$char256.`) — strip the `:format` suffix; lines end CRLF; values containing special characters are wrapped in double quotes with `""` escaping
- Adapter response shape: `sasjs.request()` resolves with the webout JSON **already unwrapped** — output tables are arrays of row objects directly on the response (`res.mytable[0].COL`). A table named `result` is perfectly fine (`res.result` is then that array); do NOT add your own `res.result`-unwrapping layer, it breaks exactly that case.
- Third-party npm packages are NOT resolvable at runtime — bundle the service first (e.g. `npx webpack --mode none --target node --entry <file> --output-path sasjsbuild/... --output-filename <name>.js`), then `sasjs build` / `sasjs deploy`.
Deploying mocks:
- `sasjs fs sync` does NOT work on a JS-only server (it generates and executes SAS code to hash remote files). Upload files directly via the Drive API instead: `DELETE` then `POST /SASjsApi/drive/file?_filePath=<appLoc>/services/<folder>/<name>.js` (multipart `file` field). In desktop mode no auth headers are needed; in server mode read the `Authorization` header line from `_SASJS_TOKENFILE`.
- Mocks can be stateful with the predeclared `fs`. Prefer real locations over `/tmp`: the SASjs Drive root is derivable from `weboutPath` (`<root>/sessions/<id>/webout.txt` → `path.resolve(weboutPath, '..', '..', '..', 'drive')`), and a mock `configure`-style service can treat a configured folder as a real local path (the server IS local). `require('path')` and other core modules work (only `fs` is predeclared).
- A JS program can even call the server's own REST API (`http://127.0.0.1:$PORT/SASjsApi/...`) — e.g. to rewrite a streamed `index.html` on the Drive (`GET` + `PATCH /SASjsApi/drive/file`).
Gotchas:
- The packaged binaries (`api-linux` etc.) reject some globally-exported `NODE_OPTIONS` (e.g. `--network-family-autoselection`) — start with `NODE_OPTIONS="" ./api-linux`.
- AppStream URLs redirect to a trailing slash (`/AppStream/MyApp` → 301 → `/AppStream/MyApp/`) — test/automation scripts should use the trailing-slash URL directly.
+36 -11
View File
@@ -3,6 +3,42 @@
# Using `--silent` helps for showing any errs in the first line of the response # Using `--silent` helps for showing any errs in the first line of the response
# The first line is picked up by the VS Code GIT UI popup when rc is not 0 # The first line is picked up by the VS Code GIT UI popup when rc is not 0
# Scan staged changes for secrets before anything else runs.
# The binary is pinned by the @nogoo9/gitleaks devDependency and lands
# in node_modules/.bin after npm i. Commits are blocked until it is
# installed so no clone silently skips the secrets scan.
gitleaks_bin=node_modules/.bin/gitleaks
if [ ! -x "$gitleaks_bin" ]; then
echo "❌ gitleaks not found - run 'npm i' to install it"
exit 1
fi
if ! "$gitleaks_bin" protect --staged --redact; then
echo "❌ gitleaks detected a potential secret in your staged changes"
echo "Remove the secret, or add a .gitleaksignore entry if it is a false positive"
exit 1
fi
## Avoid large commits
# https://www.backblaze.com/blog/how-many-bytes-are-in-a-megabyte-really/
size_limit=$((2 * 1024 * 1024)) # 2MB
# Sum the sizes of the blobs this commit would introduce: the staged
# added/copied/modified/renamed/typechanged entries in the index.
# https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt---batch-check
# Renames are treated as add+delete (--no-renames) and pure mode changes
# (same blob, different permissions) add no new blob, so both are safe.
commit_size=$(git diff --cached --raw --no-renames --diff-filter=ACMRT |
awk '$3 != $4 { print $4 }' |
git cat-file --batch-check='%(objectsize)' |
awk '{ s += $1 } END { print s + 0 }')
if [ "$commit_size" -ge "$size_limit" ]; then
echo "Commit size is too large: $commit_size > $size_limit"
echo "Force commit using --no-verify"
exit 1
fi
if npm run --silent lint:check:silent ; then if npm run --silent lint:check:silent ; then
exit 0 exit 0
else else
@@ -10,14 +46,3 @@ else
echo "❌ Prettier check failed! We ran lint:fix for you. Please add & commit again." echo "❌ Prettier check failed! We ran lint:fix for you. Please add & commit again."
exit 1 exit 1
fi fi
## Avoid large commits
# https://www.backblaze.com/blog/how-many-bytes-are-in-a-megabyte-really/
size_limit=$((2 * 2**20)) # 2mbs
# https://git-scm.com/docs/git-rev-list#Documentation/git-rev-list.txt---disk-usage
commit_size=$(git rev-list --disk-usage HEAD^..HEAD)
test "$commit_size" -lt "$size_limit" || (
echo "Commit size is too large: $commit_size > $size_limit"
echo "Force commit using --no-verify"
exit 1
)
+10 -2
View File
@@ -125,8 +125,16 @@ jobs:
cd ./sas/mocks/sasjs cd ./sas/mocks/sasjs
npm install -g @sasjs/cli npm install -g @sasjs/cli
npm install -g replace-in-files-cli npm install -g replace-in-files-cli
# Remove any previous deployment (drive folder delete API) so the
# deploy and makedata start from a clean appLoc
curl -sS -X DELETE "http://localhost:5000/SASjsApi/drive/folder/?_folderPath=/Public/app/dc"
sasjs cbd -t server-ci sasjs cbd -t server-ci
# sasjs request services/admin/makedata -t server-ci -d ./deploy/makeData4GL.json -c ./deploy/requestConfig.json -o ./output.json # Seed the DC database (mock data files on the drive).
# makedata replies with HTML (it is normally called as a URL redirect),
# which the CLI reports as "invalid Json string" - ignore that.
# NOTE: -d paths resolve from the sasjs project root (sas/mocks),
# not the cwd (sas/mocks/sasjs).
sasjs request services/admin/makedata -t server-ci -d deploy/makedata.json -o ./makedata_out.json || true
- name: Prepare and run frontend and cypress - name: Prepare and run frontend and cypress
timeout-minutes: 35 timeout-minutes: 35
@@ -139,7 +147,7 @@ jobs:
npm run postinstall npm run postinstall
# Prepare index.html to SASJS local # Prepare index.html to SASJS local
replace-in-files --regex='serverUrl=".*?"' --replacement='serverUrl="http://localhost:5000"' ./src/index.html replace-in-files --regex='serverUrl=".*?"' --replacement='serverUrl="http://localhost:5000"' ./src/index.html
replace-in-files --regex='appLoc=".*?"' --replacement='appLoc="/Public/app/devtest"' ./src/index.html replace-in-files --regex='appLoc=".*?"' --replacement='appLoc="/Public/app/dc"' ./src/index.html
replace-in-files --regex='serverType=".*?"' --replacement='serverType="SASJS"' ./src/index.html replace-in-files --regex='serverType=".*?"' --replacement='serverType="SASJS"' ./src/index.html
replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts
cat ./cypress.config.ts cat ./cypress.config.ts
+10 -2
View File
@@ -125,8 +125,16 @@ jobs:
cd ./sas/mocks/sasjs cd ./sas/mocks/sasjs
npm install -g @sasjs/cli npm install -g @sasjs/cli
npm install -g replace-in-files-cli npm install -g replace-in-files-cli
# Remove any previous deployment (drive folder delete API) so the
# deploy and makedata start from a clean appLoc
curl -sS -X DELETE "http://localhost:5000/SASjsApi/drive/folder/?_folderPath=/Public/app/dc"
sasjs cbd -t server-ci sasjs cbd -t server-ci
# sasjs request services/admin/makedata -t server-ci -d ./deploy/makeData4GL.json -c ./deploy/requestConfig.json -o ./output.json # Seed the DC database (mock data files on the drive).
# makedata replies with HTML (it is normally called as a URL redirect),
# which the CLI reports as "invalid Json string" - ignore that.
# NOTE: -d paths resolve from the sasjs project root (sas/mocks),
# not the cwd (sas/mocks/sasjs).
sasjs request services/admin/makedata -t server-ci -d deploy/makedata.json -o ./makedata_out.json || true
- name: Prepare and run frontend and cypress - name: Prepare and run frontend and cypress
run: | run: |
@@ -138,7 +146,7 @@ jobs:
npm run postinstall npm run postinstall
# Prepare index.html to SASJS local # Prepare index.html to SASJS local
replace-in-files --regex='serverUrl=".*?"' --replacement='serverUrl="http://localhost:5000"' ./src/index.html replace-in-files --regex='serverUrl=".*?"' --replacement='serverUrl="http://localhost:5000"' ./src/index.html
replace-in-files --regex='appLoc=".*?"' --replacement='appLoc="/Public/app/devtest"' ./src/index.html replace-in-files --regex='appLoc=".*?"' --replacement='appLoc="/Public/app/dc"' ./src/index.html
replace-in-files --regex='serverType=".*?"' --replacement='serverType="SASJS"' ./src/index.html replace-in-files --regex='serverType=".*?"' --replacement='serverType="SASJS"' ./src/index.html
replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts
cat ./cypress.config.ts cat ./cypress.config.ts
+3 -1
View File
@@ -22,4 +22,6 @@ sasjsresults
.sasjsrc .sasjsrc
client/.npmrc client/.npmrc
*~ *~
.lighthouseci .lighthouseci
audit.log
tmp/
+6 -4
View File
@@ -7,7 +7,7 @@ Read **`CONTEXT.md`** at the repo root first - it is the domain glossary and ori
Data Controller spans three sibling repos (usually checked out side by side): Data Controller spans three sibling repos (usually checked out side by side):
- **`dc`** (this repo) - the product source (Angular client + SAS backend). - **`dc`** (this repo) - the product source (Angular client + SAS backend).
- **`docs.datacontroller.io`** - the user-facing product documentation (MkDocs). User-facing behaviour is documented there; the `.agent/docs/` deep-dives here link out to it. - **`docs.datacontroller.io`** - the user-facing product documentation (MkDocs). User-facing behaviour is documented there; the `.agents/docs/` deep-dives here link out to it.
- **`datacontroller.io`** - the marketing site, blog and feed (Gatsby). - **`datacontroller.io`** - the marketing site, blog and feed (Gatsby).
## Git ## Git
@@ -16,7 +16,7 @@ Do NOT auto-commit. Never run `git commit` (or `git push`) unless the user expli
## CHANGELOG and versioning ## CHANGELOG and versioning
Do NOT edit `CHANGELOG.md` by hand, and do NOT bump the `version` in `package.json`. The release pipeline (semantic-release, in `.gitea/workflows/release.yaml`) generates both automatically from Conventional Commit messages on every push to `main`. Manual entries collide with the pipeline's release commit and are overwritten anyway. Control the changelog through your commit messages instead. See `.agent/docs/releases-and-changelog.md`. Do NOT edit `CHANGELOG.md` by hand, and do NOT bump the `version` in `package.json`. The release pipeline (semantic-release, in `.gitea/workflows/release.yaml`) generates both automatically from Conventional Commit messages on every push to `main`. Manual entries collide with the pipeline's release commit and are overwritten anyway. Control the changelog through your commit messages instead. See `.agents/docs/releases-and-changelog.md`.
## Markdown files ## Markdown files
@@ -37,9 +37,11 @@ Never consider a change complete until the relevant linters pass on the files yo
Data Controller must run entirely locally (offline / on-prem, no internet access). The built product must never fetch assets from remote servers — no external fonts, images, scripts, stylesheets, CDN links, or remote URLs in meta tags (e.g. `og:image`, `og:url`, `itemprop="image"`). All assets must be bundled and served locally. Data Controller must run entirely locally (offline / on-prem, no internet access). The built product must never fetch assets from remote servers — no external fonts, images, scripts, stylesheets, CDN links, or remote URLs in meta tags (e.g. `og:image`, `og:url`, `itemprop="image"`). All assets must be bundled and served locally.
## The .agent folder ## The .agents folder
Agent-related content lives in `.agent/`: technical/agent-facing documentation goes in `.agent/docs/` (not `docs/`), and skills in `.agent/skills/`. When writing explanatory or technical docs about the codebase, put them in `.agent/docs/`. Agent-related content lives in `.agents/`: technical/agent-facing documentation goes in `.agents/docs/` (not `docs/`), and skills in `.agents/skills/`. When writing explanatory or technical docs about the codebase, put them in `.agents/docs/`.
Skills installed via `npx skills add` are tracked in `skills-lock.json` and live under `.agents/skills/`. Repo-local custom skills (e.g. `dc-sas` for Data Controller SAS development, `handsontable`, `hyperformula`) are kept here too. Avoid editing npx-managed skill files directly — use `npx skills update` instead.
## Code comments and test names ## Code comments and test names
+94
View File
@@ -1,3 +1,97 @@
# [7.14.0](https://git.datacontroller.io/dc/dc/compare/v7.13.0...v7.14.0) (2026-09-04)
### Features
* **system:** show session timezone on system information screen ([966dc07](https://git.datacontroller.io/dc/dc/commit/966dc072e0cb8bb44bd93a7682c3d7335428d688))
# [7.13.0](https://git.datacontroller.io/dc/dc/compare/v7.12.0...v7.13.0) (2026-09-03)
### Bug Fixes
* dynamic js mocks ([3b9344c](https://git.datacontroller.io/dc/dc/commit/3b9344cb602b609774737dcbb6df6756a2a08edb))
* adding formula types ([c07a01a](https://git.datacontroller.io/dc/dc/commit/c07a01a38da6a6e4edaf014ef2fd4d2691b29698))
* address hermes review feedback (formula quoting, cell revert, addRow guard) ([36963aa](https://git.datacontroller.io/dc/dc/commit/36963aa74627b861aee9ec91428a8dbee0946dfc))
* agent skills and nextviya deploys ([f7db871](https://git.datacontroller.io/dc/dc/commit/f7db8719f5fe860605f4e6da81bad925d7412599))
* bump core for mp_validate fix ([5a44b28](https://git.datacontroller.io/dc/dc/commit/5a44b2804feddbd616ece1d721865e02bfbedda8))
* CAS support for REPLACE type plus docs ([ea05f07](https://git.datacontroller.io/dc/dc/commit/ea05f0718047a0ac54cffc58938b6d06f5a112e2))
* clarify debug comment is permanent, extend ComputeContextDetails with Viya response fields ([72484ae](https://git.datacontroller.io/dc/dc/commit/72484ae8441715813983faa221be348cf421b735))
* core major bump plus autofix of viya context on deploy ([6527c10](https://git.datacontroller.io/dc/dc/commit/6527c10f262249187c27723d983edd32c3848d72))
* **core:** bump to v5 (breaking change) ([59e9e96](https://git.datacontroller.io/dc/dc/commit/59e9e96f5a6a6c9c0560cbb8387982611a0c8ca4))
* **cypress:** correct mock data, test expectations, and abort modal ([13c10be](https://git.datacontroller.io/dc/dc/commit/13c10be30faae736d27b584e0507eaab702d2d32))
* **cypress:** make licensing combined-key tests order-independent ([4db8d62](https://git.datacontroller.io/dc/dc/commit/4db8d62dca9257764438b00ef034103a0703111a))
* **deploy:** Viya deploy checks, startup diagnostics, and chunked deploy script ([917925f](https://git.datacontroller.io/dc/dc/commit/917925f55393aca919c2a7c7cd7dbecadbc24ace)), closes [#303](https://git.datacontroller.io/dc/dc/issues/303) [#200](https://git.datacontroller.io/dc/dc/issues/200) [#125](https://git.datacontroller.io/dc/dc/issues/125)
* **deps:** align @angular/* packages to the same lockstep version ([24e6297](https://git.datacontroller.io/dc/dc/commit/24e62971879e61eef0fc3ea9f07796b92231dbe3))
* **deps:** override nanoid to 3.3.18 in sas/ ([d57ae03](https://git.datacontroller.io/dc/dc/commit/d57ae03fc44770f41de5dbe0389d33cd11fc0971))
* **deps:** pin @handsontable/angular-wrapper to 18.0.0 ([2d7df66](https://git.datacontroller.io/dc/dc/commit/2d7df66fc28ffe07e859920c052b9818ed58647f))
* **deps:** pin babel-loader to resolve an unresolvable peer conflict ([3bf3bf0](https://git.datacontroller.io/dc/dc/commit/3bf3bf0dde943246380528d5af7c46ad1f518c79))
* **deps:** regenerate lockfile with Node 24 and pin handsontable to 18.0.0 ([7da29bd](https://git.datacontroller.io/dc/dc/commit/7da29bdb1180a9f50055380c1df3649283e9cdf6))
* **deps:** regenerate lockfile with strict peer-dep resolution to fix npm ci in CI ([efd2e18](https://git.datacontroller.io/dc/dc/commit/efd2e18c7b09f80655528a2f6985034f5a41dcf3))
* **deps:** regenerate package-lock.json to resolve npm ci sync errors ([a501903](https://git.datacontroller.io/dc/dc/commit/a501903e6d4276f1b4eba8f8ae0feccafcfbcf86))
* **deps:** resolve npm audit findings and align @angular/* to the same lockstep version ([b9e4b27](https://git.datacontroller.io/dc/dc/commit/b9e4b2733fa01e2b8060dab54277000a2c6252b8))
* **deps:** resolve npm audit findings via direct lockfile patch, not regeneration ([4d1bfa6](https://git.datacontroller.io/dc/dc/commit/4d1bfa6343342a167bdc315204866a18bcbca8ed))
* **deps:** resolve npm audit vulnerabilities in production dependencies ([257f69c](https://git.datacontroller.io/dc/dc/commit/257f69ccc6dd070daf8c73f597a08d01e8ea6888))
* **deps:** scope the brace-expansion override to its actual vulnerable chain ([f9d061c](https://git.datacontroller.io/dc/dc/commit/f9d061c48901d9ef131303940f0c2e2948b12fdf))
* dynamic getdynamiccolvals.js ([d59ef44](https://git.datacontroller.io/dc/dc/commit/d59ef442266bd4823f5cad3f7f4985e3df9afb48))
* **editor:** clear sort before reading cells to preserve on cancel ([4137ebd](https://git.datacontroller.io/dc/dc/commit/4137ebdf6b6563eeac4f805708c3b4ffcd099fb1))
* **editor:** escape formula-looking values in uploaded Excel data ([e69df3d](https://git.datacontroller.io/dc/dc/commit/e69df3deb22d80b1371b63a5ae1c6a44538b00bc))
* **editor:** fix formula $-substitution corruption and sorted-grid row/formula desync ([e139c37](https://git.datacontroller.io/dc/dc/commit/e139c37fbfe46123cce2cbfcf7e919bc68e19a2f))
* **editor:** let the column info dropdown's text be selected and copied ([1e516f4](https://git.datacontroller.io/dc/dc/commit/1e516f4012947c3f42dec1f3a46fa364c39bfe3e))
* **editor:** re-mark a reverted cell as auto-escaped so "Apply as formula" works again ([12091c4](https://git.datacontroller.io/dc/dc/commit/12091c4044b0982c36b7d6011b51625bfb6b8cb5))
* **editor:** resolve a primary key's live formula to its computed value, not the raw formula text ([d72e19a](https://git.datacontroller.io/dc/dc/commit/d72e19a3086ef578a1304fe032e1088c6ef60cf7))
* **editor:** resolve computed value for a live formula in numeric columns too ([2cc8489](https://git.datacontroller.io/dc/dc/commit/2cc8489892638aaf97fd5999ebc6086ffd674a76))
* **editor:** restore multi-column sort with one call, not a loop ([8fafeb7](https://git.datacontroller.io/dc/dc/commit/8fafeb7923bc7dae178c4fed0898195d5b5825a6))
* **editor:** size table-header buttons and title to content, not fixed grid thirds ([d0a7561](https://git.datacontroller.io/dc/dc/commit/d0a7561f1aeb67b214e6a473cc6235509daa80bb))
* **editor:** stop dc.row_status from being submitted to the backend ([dc0f6a7](https://git.datacontroller.io/dc/dc/commit/dc0f6a7baa128e0b75d7341ac7c03dcd4b1ffee5))
* **editor:** stop turning missing columns into undefined, and fix column lookup for sparse rows ([a104f78](https://git.datacontroller.io/dc/dc/commit/a104f78645bc7777fee672956d3f028ff52ed9ba))
* **editor:** submit a live formula's computed value, not its raw text ([b7d3106](https://git.datacontroller.io/dc/dc/commit/b7d31066ae5272856ea442d0f76d2f0752015dbb))
* ensure cleanup of casuser temp table in error condition ([c4123e5](https://git.datacontroller.io/dc/dc/commit/c4123e5c965ba3f78ec8cf32f915f263d218ca56))
* ensuring formats arrive from backend in getstagetable.sas ([daacb49](https://git.datacontroller.io/dc/dc/commit/daacb49c8a2c6a266dd842a8b7ccdebaa992a1d7))
* escape regex metacharacters in context name before prxchange ([9023eb2](https://git.datacontroller.io/dc/dc/commit/9023eb2a393ee8441bab5b9c5ff4f53b500e0e91))
* failing test ([f213d24](https://git.datacontroller.io/dc/dc/commit/f213d24f096d814d286bfdac5a28748e97e7293f))
* fixed npm vuln ([26b55b1](https://git.datacontroller.io/dc/dc/commit/26b55b1bde5e28afde2d4f9889cb452985410c1d))
* **formulas:** avoid EDIT_STATUS colliding with a real column of that name ([acb97f4](https://git.datacontroller.io/dc/dc/commit/acb97f4bfb1c7d6a0b38dd33207170f6ec2bbd1d))
* hardening following PR review feedback ([1f4aa6f](https://git.datacontroller.io/dc/dc/commit/1f4aa6fceafc4b51ecc5a19f4789cf5bd018a5d3))
* history mock ([0082828](https://git.datacontroller.io/dc/dc/commit/00828285435a412e3e5dccb045b053c1096e8876))
* **licensing:** bridge async proceed() through cy.then and replace Response.arrayBuffer with manual stream reader ([8e51fde](https://git.datacontroller.io/dc/dc/commit/8e51fde524e799652fbd1f0b0763d667cb3a4845))
* **mocks:** add fixture staged data and MPE_SUBMIT row for stage.cy.ts ([6e2548d](https://git.datacontroller.io/dc/dc/commit/6e2548d78c613d684fc8d874ba11b30fc9b4e32e))
* **mocks:** add LIBRARYNAME to startupservice, fix viewbox column order ([c0af86e](https://git.datacontroller.io/dc/dc/commit/c0af86ef297334ee531e979754d4d289ed3900ea))
* **mocks:** limit stage fixture to 1 row, fix column order ([f25ecd8](https://git.datacontroller.io/dc/dc/commit/f25ecd88283433770f56167774617f0e2089c6ef))
* **mocks:** look up PK_FIELDS from MPE_TABLES in viewdata, fallback for MPE_AUDIT ([94d2a79](https://git.datacontroller.io/dc/dc/commit/94d2a7970e49845b235c71523418e4a5d2a70396))
* **mocks:** remove MPE_VALIDATIONS and MPE_ALERTS from DC996664 libref ([4f7b845](https://git.datacontroller.io/dc/dc/commit/4f7b845390d50db50114afa7fa851ddf3e853ed7))
* **mocks:** remove shadowed saveTableData in rejection.js ([fed0396](https://git.datacontroller.io/dc/dc/commit/fed039673777659594feb9a92a5d9c2dca2cc544))
* **mocks:** remove SOME_SHORTNUM HARDREGEX from MPE_VALIDATIONS ([34bd660](https://git.datacontroller.io/dc/dc/commit/34bd6607c547c3d40c1129395a28e4cbf0fa1475))
* **mocks:** rename saveTableData in postdata.js to avoid shadowing ([e4b04b1](https://git.datacontroller.io/dc/dc/commit/e4b04b1d447640542c122dce93d65219719cb094))
* **mocks:** SAS datetime format in getchangeinfo, login in stage.cy.ts ([c180934](https://git.datacontroller.io/dc/dc/commit/c1809341672ad51baa603f104176fdc302e4c0c1))
* more mock improvements ([a80927c](https://git.datacontroller.io/dc/dc/commit/a80927cbb6c8a5ce26a1d251dc10cae4bae1eedd))
* mp_execute dep ([023c29f](https://git.datacontroller.io/dc/dc/commit/023c29f00f74f964825e0ee01768baf44aead332))
* pin fast-uri to 3.1.7 to close high-severity SSRF/host-confusion advisories ([f4325b2](https://git.datacontroller.io/dc/dc/commit/f4325b205699bf02158c232ffd8c279489778512)), closes [hi#severity](https://git.datacontroller.io/hi/issues/severity)
* spy for startup ([69b4155](https://git.datacontroller.io/dc/dc/commit/69b41559f7aa66a537b685e26e00c44f1f2568c4))
* **stage:** submit data via editor flow, use dynamic date assertion ([490d013](https://git.datacontroller.io/dc/dc/commit/490d0137b921c150b431083b847d471aa379bc42))
* **startup:** show the real startupservice response text on a malformed reply ([9a1b7d0](https://git.datacontroller.io/dc/dc/commit/9a1b7d0f52eebe6bea229dedbcb8f5c19bc96141))
* tests and realistic getcolvals.js ([5d03164](https://git.datacontroller.io/dc/dc/commit/5d03164b6a3245b47f1278fe962c537f72a8f473))
* **tests:** new libref ([c0bc87d](https://git.datacontroller.io/dc/dc/commit/c0bc87d331b081d787b4ed3d04c639c139d0fa1b))
* unnecessary getsubmits call removed ([cc2ff87](https://git.datacontroller.io/dc/dc/commit/cc2ff873fae58f41332dcbe725a49f0815b219b3))
* using utility macro for webout ([3595bb9](https://git.datacontroller.io/dc/dc/commit/3595bb94993aa054235cce3f41b9d83711907c46))
### Features
* **editor:** color row-header status cells and switch modified symbol to ± ([e15f2c2](https://git.datacontroller.io/dc/dc/commit/e15f2c2a3488f43ed4e5814fdc22527961cc5c22))
* **editor:** generalize cell revert to any overwritten value, not just formulas ([07d586d](https://git.datacontroller.io/dc/dc/commit/07d586da5235a2d94b2b689c774c40851b9a57e2))
* **editor:** scope live formulas to character columns, not just HARDFORMULA/SOFTFORMULA ones ([92d0d91](https://git.datacontroller.io/dc/dc/commit/92d0d91440ff6d58d10f1af291386a1813cb07d4))
* **editor:** translate column names to cell references on formula paste ([1031ea7](https://git.datacontroller.io/dc/dc/commit/1031ea7ed7b1a74ecc77bf155f6d329feeaf4b13))
* **formulas:** flag formula-overwritten cells with revert, harden dc.row_status against SAS name collisions ([a8237b2](https://git.datacontroller.io/dc/dc/commit/a8237b2881b85854bb52c85ca2f17e3368f91f4a))
* **formulas:** live DC.ROW_STATUS, insert-row formula fixes, UserService singleton fix ([4a8c39b](https://git.datacontroller.io/dc/dc/commit/4a8c39b4c0d6e0edb3493ac3d26d86788ebfdf90))
* **formulas:** wire HyperFormula into HARDFORMULA/SOFTFORMULA rules ([cbea04c](https://git.datacontroller.io/dc/dc/commit/cbea04c8e129d7d28a626215aae3b67735a036d5))
* functional JS mocks ([ee52bb8](https://git.datacontroller.io/dc/dc/commit/ee52bb8967e5bcdcfd17500678295e6bffbe2cf0))
* **licensing:** support combined-key paste, object-format features, and a live key preview ([20ba633](https://git.datacontroller.io/dc/dc/commit/20ba63308717dbde929dbe5974b76f160343de29))
* **licensing:** warn and block applying a licence key generated for the wrong protocol ([41680e2](https://git.datacontroller.io/dc/dc/commit/41680e2eccad82584bf9fd71a1efd1fd2d8f1a39))
* **stage:** add Formatted/Unformatted toggle to the staging page ([74c38e1](https://git.datacontroller.io/dc/dc/commit/74c38e16416dcd8be20faa66d9f282a6438522b5))
* updated configurator for Viya deploy ([df2027d](https://git.datacontroller.io/dc/dc/commit/df2027dab6ae51fb9cabf21e35d1fa5d6e1f7957))
* **viewboxes:** add drag-to-resize on all four edges and corners ([e5a5bf2](https://git.datacontroller.io/dc/dc/commit/e5a5bf2144d7f35c62368924c7e59f55eeb246ad))
# [7.12.0](https://git.datacontroller.io/dc/dc/compare/v7.11.0...v7.12.0) (2026-07-28) # [7.12.0](https://git.datacontroller.io/dc/dc/compare/v7.11.0...v7.12.0) (2026-07-28)
+9 -9
View File
@@ -6,9 +6,9 @@ This file is the shared glossary and orientation for the repo. When your output
## Repository layout ## Repository layout
- `client/` - the Angular frontend (TypeScript). Uses [Handsontable](.agent/skills/handsontable/SKILL.md) for the editable grid and [HyperFormula](.agent/skills/hyperformula/SKILL.md) for Excel-formula support. Lint with `npm run lint:check` from `client/`. - `client/` - the Angular frontend (TypeScript). Uses [Handsontable](.agents/skills/handsontable/SKILL.md) for the editable grid and [HyperFormula](.agents/skills/hyperformula/SKILL.md) for Excel-formula support. Lint with `npm run lint:check` from `client/`.
- `sas/` - the SAS backend. Services, macros, hooks and tests live under `sas/sasjs/**`; `sas/sasjsbuild/` is generated output (never hand-edit). Lint `.sas` files with `sasjs lint` from `sas/`. - `sas/` - the SAS backend. Services, macros, hooks and tests live under `sas/sasjs/**`; `sas/sasjsbuild/` is generated output (never hand-edit). Lint `.sas` files with `sasjs lint` from `sas/`.
- `.agent/docs/` - technical deep-dives (see below). `.agent/skills/` - task skills (handsontable, hyperformula, sas). - `.agents/docs/` - technical deep-dives (see below). `.agents/skills/` - task skills (handsontable, hyperformula, dc-sas for Data Controller SAS development, plus npx-installed sasjs/ sas skills).
## Roles ## Roles
@@ -32,10 +32,10 @@ Admins are listed in `&mpeadmins`; admin membership bypasses Row Level Security.
## Load types ## Load types
Set per table in `MPE_TABLES.LOADTYPE`. Determines the loader and how history is kept (see [.agent/docs/bitemporal-dataloader.md](.agent/docs/bitemporal-dataloader.md)): Set per table in `MPE_TABLES.LOADTYPE`. Determines the loader and how history is kept (see [.agents/docs/bitemporal-dataloader.md](.agents/docs/bitemporal-dataloader.md)):
- **UPDATE** - no history; changed records deleted and re-appended (via `%bitemporal_dataloader`). - **UPDATE** - no history; changed records deleted and re-appended (via `%bitemporal_dataloader`).
- **REPLACE** - no history; whole table wiped and reloaded. Implemented inline in `%mpe_targetloader`, deliberately *not* via `%bitemporal_dataloader` (see [.agent/docs/replace-load-type.md](.agent/docs/replace-load-type.md)). - **REPLACE** - no history; whole table wiped and reloaded. Implemented inline in `%mpe_targetloader`, deliberately *not* via `%bitemporal_dataloader` (see [.agents/docs/replace-load-type.md](.agents/docs/replace-load-type.md)).
- **TXTEMPORAL** - SCD2-style history on technical (transaction) time. - **TXTEMPORAL** - SCD2-style history on technical (transaction) time.
- **BITEMPORAL** - full two-dimensional history (business time + technical time). - **BITEMPORAL** - full two-dimensional history (business time + technical time).
- **FORMAT_CAT** - format-catalog load (via `%mp_loadformat`). - **FORMAT_CAT** - format-catalog load (via `%mp_loadformat`).
@@ -64,11 +64,11 @@ Selectbox seed values for these tables are defined in `sas/sasjs/macros/mpe_make
- **HARDREGEX** - submission-blocking regex; failing cells are painted red and cannot be submitted. - **HARDREGEX** - submission-blocking regex; failing cells are painted red and cannot be submitted.
- **SOFTREGEX** - display-only warning regex; failing cells are painted yellow but submission is allowed. - **SOFTREGEX** - display-only warning regex; failing cells are painted yellow but submission is allowed.
Regex rule values are authored in SAS PRX form `/pattern/flags` and limited to 128 chars. See [.agent/docs/regex-validations.md](.agent/docs/regex-validations.md). Regex rule values are authored in SAS PRX form `/pattern/flags` and limited to 128 chars. See [.agents/docs/regex-validations.md](.agents/docs/regex-validations.md).
## Security ## Security
- **Row Level Security (RLS)** - server-side `WHERE`-clause generation via `%mpe_filtermaster` / `%mp_filtergenerate`; no data leaves SAS without passing the filter. Works on any engine because it's expressed as a standard SAS `WHERE`. On write, the *inverse* filter is applied to reject out-of-scope rows. See [.agent/docs/row-level-security.md](.agent/docs/row-level-security.md). - **Row Level Security (RLS)** - server-side `WHERE`-clause generation via `%mpe_filtermaster` / `%mp_filtergenerate`; no data leaves SAS without passing the filter. Works on any engine because it's expressed as a standard SAS `WHERE`. On write, the *inverse* filter is applied to reject out-of-scope rows. See [.agents/docs/row-level-security.md](.agents/docs/row-level-security.md).
- **Column Level Security (CLS)** - restricts visibility/editability at column level. - **Column Level Security (CLS)** - restricts visibility/editability at column level.
## Key macros / services ## Key macros / services
@@ -79,7 +79,7 @@ Regex rule values are authored in SAS PRX form `/pattern/flags` and limited to 1
## Testing ## Testing
Backend tests run with the sasjs CLI from `sas/`. `npm run 4gl` compiles+deploys+seeds then `sasjs test -t 4gl` runs tests. Assertions use `%mp_assert()`. See [.agent/docs/testing.md](.agent/docs/testing.md). Backend tests run with the sasjs CLI from `sas/`. `npm run 4gl` compiles+deploys+seeds then `sasjs test -t 4gl` runs tests. Assertions use `%mp_assert()`. See [.agents/docs/testing.md](.agents/docs/testing.md).
## Conventions ## Conventions
@@ -88,6 +88,6 @@ Backend tests run with the sasjs CLI from `sas/`. `npm run 4gl` compiles+deploys
- No external assets - everything must be bundled and served locally. - No external assets - everything must be bundled and served locally.
- Comments and test names must be self-contained (no "original bug", "this PR", etc.); the only exception is a literal issue-tracker link. - Comments and test names must be self-contained (no "original bug", "this PR", etc.); the only exception is a literal issue-tracker link.
- Do not auto-commit or push. - Do not auto-commit or push.
- Never edit `CHANGELOG.md` or bump `package.json` version by hand - the release pipeline generates both from Conventional Commit messages. See [.agent/docs/releases-and-changelog.md](.agent/docs/releases-and-changelog.md). - Never edit `CHANGELOG.md` or bump `package.json` version by hand - the release pipeline generates both from Conventional Commit messages. See [.agents/docs/releases-and-changelog.md](.agents/docs/releases-and-changelog.md).
See `AGENTS.md` for the full set of enforced rules (git, linting, no-wrap, no-external-assets, `.agent/` layout). See `AGENTS.md` for the full set of enforced rules (git, linting, no-wrap, no-external-assets, `.agents/` layout).
+80
View File
@@ -4,6 +4,21 @@
## Workflow guidelines ## Workflow guidelines
[Wiki Page](https://git.datacontroller.io/dc/dc/wiki/Git-Workflow) [Wiki Page](https://git.datacontroller.io/dc/dc/wiki/Git-Workflow)
## Git hooks
The repo ships its own git hooks in [`.git-hooks/`](./.git-hooks):
- `pre-commit` - scans staged changes for secrets with gitleaks, blocks commits that would add more than 2MB of new blobs, and runs the prettier check (auto-fixing on failure)
- `commit-msg` - verifies the commit message follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) standard
The repo `.npmrc` sets `ignore-scripts=true`, so the `prepare` and `postinstall` lifecycle scripts that would normally set `core.hooksPath` during `npm i` never run. After cloning (or if your commits are not being checked), activate the hooks with a one-time command, run from the repo root:
```bash
git config core.hooksPath ./.git-hooks
```
The pre-commit hook requires the gitleaks binary provided by the root `@nogoo9/gitleaks` devDependency, so make sure `npm i` has run in the repo root before your first commit.
## Dependencies that requires licences ## Dependencies that requires licences
[SheetJS Pro Version](https://www.npmjs.com/package/sheetjs) [SheetJS Pro Version](https://www.npmjs.com/package/sheetjs)
@@ -54,6 +69,71 @@ cd client
npm start npm start
``` ```
## Mocked backend (frontend development without SAS)
Data Controller ships a full set of JS mock services under `sas/mocks/sasjs/` that mimic the SAS backend using [SASjs Server](https://server.sasjs.io) in JS-only mode. This lets you run the entire frontend (editor grid, approvals, viewer, admin, Excel maps, etc.) without a SAS licence or SAS server. The Cypress E2E tests and Lighthouse CI both run against this setup.
### Prerequisites
- Node.js (same version used for the frontend build)
- The frontend dependencies installed (`cd client && npm ci` after decrypting sheet-crypto as described above)
### 1. Start SASjs Server
Download the latest Linux (or macOS/Windows) binary from [SASjs Server releases](https://github.com/sasjs/server/releases), unzip it, and create a `.env` file alongside the executable:
```
RUN_TIMES=js
NODE_PATH=node
CORS=enable
WHITELIST=http://localhost:4200
```
`RUN_TIMES=js` means the server executes `.js` files as Stored Programs (no SAS binary needed). `CORS=enable` plus `WHITELIST` allows the Angular dev server on port 4200 to call the mock services on port 5000. Start the server:
```
./api-linux # or api-macos / api-win.exe depending on your platform
```
The server runs in desktop mode (no auth) on `http://localhost:5000` by default.
### 2. Deploy the mock services and streaming frontend
From `sas/mocks/sasjs/`:
```
npm ci
sasjs cbd -t server-ci
```
This compiles, builds, and deploys the JS mock services plus the Angular frontend (as a streaming app) to the SASjs Server. The `server-ci` target in `sas/mocks/sasjs/sasjsconfig.json` points to `http://localhost:5000` with appLoc `/Public/app/dc` and stream service name `clickme`.
After deploy, the streamed app is available at: `http://localhost:5000/AppStream/clickme/`
### 3. Run the Angular dev server (optional, for hot reload)
For frontend development with live reload, point `client/src/index.html` at the local SASjs Server and start the dev server:
```
cd client
# Edit src/index.html: set serverUrl="http://localhost:5000", appLoc="/Public/app/dc", serverType="SASJS"
npm start
```
The app will be at `http://localhost:4200`. It calls the JS mock services on port 5000 via the SASjs adapter (CORS is enabled by the `.env` above).
### How the mocks work
Each `.js` file in `sas/mocks/sasjs/services/` corresponds to a real SAS service (e.g. `public/startupservice.js` mimics `services/public/startupservice.sas`). The JS runtime predeclares `fs` and `_webout`; the mock assigns a JSON string to `_webout` that matches the structure the real SAS service would return. Some mocks are stateful: they persist data to a `mock-storage/` folder on the SASjs Drive (e.g. `licence.json`, `users.json`, `filter.txt`) using the predeclared `fs` module.
The mock data includes sample tables (`DC996664.MPE_X_TEST`, `MPE_X_NEW`, `MPE_X_FORMULA_TEST`, etc.) with realistic columns, validation rules (HARDREGEX, SOFTREGEX, HARDSELECT, READONLY, HIDDEN, ROUND, NUMBER_FORMAT), and dropdown values. This is sufficient to exercise the full editor grid, approval workflow, viewer, and admin screens.
There is also a SAS 9 mock variant under `sas/mocks/sas9/` (target `sas9-mocks`) that mimics SAS 9 stored processes with the same JS approach but a different appLoc (`/User Folders/sasdemo/`).
### Re-deploying after changes
After changing mock services, re-run `sasjs cbd -t server-ci` from `sas/mocks/sasjs/`. After changing the frontend, rebuild (`cd client && npm run build`) then re-deploy so the streaming app picks up the new `client/dist/`. If you are using `ng serve` (step 3), only the mock services need re-deploying; the frontend hot-reloads automatically.
## GUI Elements ## GUI Elements
For documentation on the Clarity Design System, including a list of components and example usage, see [our website](https://vmware.github.io/clarity). For documentation on the Clarity Design System, including a list of components and example usage, see [our website](https://vmware.github.io/clarity).
+2 -1
View File
@@ -9,6 +9,7 @@ export default defineConfig({
html: true, html: true,
json: false json: false
}, },
viewportHeight: 900, viewportHeight: 900,
viewportWidth: 1600, viewportWidth: 1600,
@@ -24,7 +25,7 @@ export default defineConfig({
serverType: 'SASJS', serverType: 'SASJS',
libraryToOpenIncludes_SASVIYA: 'viya', libraryToOpenIncludes_SASVIYA: 'viya',
libraryToOpenIncludes_SAS9: 'dc', libraryToOpenIncludes_SAS9: 'dc',
libraryToOpenIncludes_SASJS: 'dc', libraryToOpenIncludes_SASJS: 'dc_jslib',
debug: false, debug: false,
screenshotOnRunFailure: false, screenshotOnRunFailure: false,
longerCommandTimeout: 50000, longerCommandTimeout: 50000,
+680 -38
View File
@@ -197,7 +197,7 @@ context('editor tests: ', function () {
// RULE_DEMO_COLS in the getdata.js mock) — MPE_X_TEST stays clean to // RULE_DEMO_COLS in the getdata.js mock) — MPE_X_TEST stays clean to
// match the excel fixtures. // match the excel fixtures.
it('7 | Blocks submission of a value that fails HARDREGEX', (done) => { it('7 | Blocks submission of a value that fails HARDREGEX', (done) => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_new') openTableFromTree('testdata', 'mpe_x_new')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -236,7 +236,7 @@ context('editor tests: ', function () {
}) })
it('8 | Warns (but still submits) a value that fails SOFTREGEX', (done) => { it('8 | Warns (but still submits) a value that fails SOFTREGEX', (done) => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_new') openTableFromTree('testdata', 'mpe_x_new')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -280,7 +280,7 @@ context('editor tests: ', function () {
// A_COL=2, B_COL=10: HARDFORMULA (A_COL * B_COL) computes to 20, // A_COL=2, B_COL=10: HARDFORMULA (A_COL * B_COL) computes to 20,
// SOFTFORMULA (A_COL + B_COL) computes to 12. // SOFTFORMULA (A_COL + B_COL) computes to 12.
it('9 | HARDFORMULA shows the computed value and blocks direct edits', () => { it('9 | HARDFORMULA shows the computed value and blocks direct edits', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -305,7 +305,7 @@ context('editor tests: ', function () {
}) })
it('10 | SOFTFORMULA shows the computed default but accepts an override', () => { it('10 | SOFTFORMULA shows the computed default but accepts an override', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -328,7 +328,7 @@ context('editor tests: ', function () {
}) })
it('11 | Info dropdown shows the applied formula as √x=<formula>', () => { it('11 | Info dropdown shows the applied formula as √x=<formula>', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -349,7 +349,7 @@ context('editor tests: ', function () {
}) })
it('12 | Info dropdown shows the applied HARDREGEX/SOFTREGEX pattern', () => { it('12 | Info dropdown shows the applied HARDREGEX/SOFTREGEX pattern', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_new') openTableFromTree('testdata', 'mpe_x_new')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -376,7 +376,7 @@ context('editor tests: ', function () {
}) })
it('13 | Info dropdown shows only the applied HARDREGEX pattern when a column has both', () => { it('13 | Info dropdown shows only the applied HARDREGEX pattern when a column has both', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_new') openTableFromTree('testdata', 'mpe_x_new')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -396,7 +396,7 @@ context('editor tests: ', function () {
}) })
it('14 | REGEX_BOTH_COL: a HARDREGEX failure blocks submission and sets its own tooltip, not yellow', (done) => { it('14 | REGEX_BOTH_COL: a HARDREGEX failure blocks submission and sets its own tooltip, not yellow', (done) => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_new') openTableFromTree('testdata', 'mpe_x_new')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -435,7 +435,7 @@ context('editor tests: ', function () {
}) })
it('15 | REGEX_BOTH_COL: SOFTREGEX is ignored entirely when HARDREGEX is present', (done) => { it('15 | REGEX_BOTH_COL: SOFTREGEX is ignored entirely when HARDREGEX is present', (done) => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_new') openTableFromTree('testdata', 'mpe_x_new')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -469,7 +469,7 @@ context('editor tests: ', function () {
}) })
it("16 | Insert Row above keeps existing rows' formulas aligned with their own shifted data", () => { it("16 | Insert Row above keeps existing rows' formulas aligned with their own shifted data", () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -499,7 +499,7 @@ context('editor tests: ', function () {
}) })
it("17 | Insert Row below keeps existing rows' formulas aligned with their own shifted data", () => { it("17 | Insert Row below keeps existing rows' formulas aligned with their own shifted data", () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -526,7 +526,7 @@ context('editor tests: ', function () {
}) })
it('18 | Insert Row seeds formulas that live-recalculate once A_COL/B_COL are filled in', () => { it('18 | Insert Row seeds formulas that live-recalculate once A_COL/B_COL are filled in', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -562,7 +562,7 @@ context('editor tests: ', function () {
}) })
it('19 | Row header shows blank for unchanged, ± for a modified row', () => { it('19 | Row header shows blank for unchanged, ± for a modified row', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -587,7 +587,7 @@ context('editor tests: ', function () {
}) })
it('20 | Row header shows - for a delete-marked row and + for a newly inserted row', () => { it('20 | Row header shows - for a delete-marked row and + for a newly inserted row', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -614,7 +614,7 @@ context('editor tests: ', function () {
}) })
it('21 | Inserting a row does not falsely mark unrelated rows as modified or revert an existing override', () => { it('21 | Inserting a row does not falsely mark unrelated rows as modified or revert an existing override', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -644,7 +644,7 @@ context('editor tests: ', function () {
}) })
it("22 | DC.ROW_STATUS resolves to a live cell reference, reacting to this row's own edit status", () => { it("22 | DC.ROW_STATUS resolves to a live cell reference, reacting to this row's own edit status", () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -673,19 +673,19 @@ context('editor tests: ', function () {
}) })
it('23 | DC.USER_NAME resolves to the current logged-in user', () => { it('23 | DC.USER_NAME resolves to the current logged-in user', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout timeout: longerCommandTimeout
}).then(() => { }).then(() => {
getCellByHeaderAndRow(0, 'USER_NAME_COL').should('have.text', 'sasdemo') getCellByHeaderAndRow(0, 'USER_NAME_COL').should('not.be.empty')
}) })
}) })
}) })
it("24 | DC.ORIG_VALUE echoes this row's pre-edit value, and is blank for a newly-inserted row", () => { it("24 | DC.ORIG_VALUE echoes this row's pre-edit value, and is blank for a newly-inserted row", () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -703,7 +703,7 @@ context('editor tests: ', function () {
}) })
it('25 | Row header symbols stay aligned with their own row after sorting by another column', () => { it('25 | Row header symbols stay aligned with their own row after sorting by another column', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -752,7 +752,7 @@ context('editor tests: ', function () {
// doesn't recompute the "changed from" text, it just flips which // doesn't recompute the "changed from" text, it just flips which
// already-computed branch IF() reveals. // already-computed branch IF() reveals.
it("26 | Combining DC.ROW_STATUS/DC.USER_NAME/DC.ORIG_VALUE in one formula reveals the frozen 'changed from' text once the row is edited", () => { it("26 | Combining DC.ROW_STATUS/DC.USER_NAME/DC.ORIG_VALUE in one formula reveals the frozen 'changed from' text once the row is edited", () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -769,10 +769,11 @@ context('editor tests: ', function () {
cy.focused().clear().type('999{enter}') cy.focused().clear().type('999{enter}')
}) })
getCellByHeaderAndRow(0, 'CHANGE_SUMMARY_COL').should( getCellByHeaderAndRow(0, 'CHANGE_SUMMARY_COL')
'have.text', .invoke('text')
'sasdemo changed from orig-1' .should((text) => {
) expect(text).to.match(/^.+ changed from orig-1$/)
})
}) })
}) })
}) })
@@ -785,7 +786,7 @@ context('editor tests: ', function () {
// and proves the live-recalculated value - not a stale one - is what // and proves the live-recalculated value - not a stale one - is what
// gets sent. // gets sent.
it('27 | Submits the computed formula value, not the raw formula string', () => { it('27 | Submits the computed formula value, not the raw formula string', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -835,7 +836,7 @@ context('editor tests: ', function () {
// other row's formula columns are seeded blank, so only this row is // other row's formula columns are seeded blank, so only this row is
// affected. // affected.
it('28 | A formula overwriting real pre-existing data marks the row modified, adds a comment, and can be reverted', () => { it('28 | A formula overwriting real pre-existing data marks the row modified, adds a comment, and can be reverted', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
// Already true on the very first render, before Edit is ever clicked - // Already true on the very first render, before Edit is ever clicked -
// dataSourceUnchanged is seeded with the formula overlay at load time // dataSourceUnchanged is seeded with the formula overlay at load time
@@ -893,7 +894,7 @@ context('editor tests: ', function () {
// "Revert") must keep showing the live computed value and the modified // "Revert") must keep showing the live computed value and the modified
// marker, both in the cancelled edit session and back in read-only view. // marker, both in the cancelled edit session and back in read-only view.
it('29 | Cancelling an edit session after a formula silently overwrote real data keeps the computed value and modified marker, not the stale raw one', () => { it('29 | Cancelling an edit session after a formula silently overwrote real data keeps the computed value and modified marker, not the stale raw one', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -919,7 +920,7 @@ context('editor tests: ', function () {
// getStableFormulaBaseCols, which excludes any DC.*-referencing formula // getStableFormulaBaseCols, which excludes any DC.*-referencing formula
// rule from the "did a formula overwrite real data" comparison entirely. // rule from the "did a formula overwrite real data" comparison entirely.
it('30 | DC.*-referencing formula columns never get a "changed value" comment, even when their own raw seed differs from the computed result', () => { it('30 | DC.*-referencing formula columns never get a "changed value" comment, even when their own raw seed differs from the computed result', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -937,7 +938,7 @@ context('editor tests: ', function () {
}) })
it('31 | Reverting a formula value then cancelling keeps it plain, and it stays plain on the next edit session', () => { it('31 | Reverting a formula value then cancelling keeps it plain, and it stays plain on the next edit session', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -986,7 +987,7 @@ context('editor tests: ', function () {
// actually sent, not only formula columns - A_COL is a plain numeric // actually sent, not only formula columns - A_COL is a plain numeric
// column with no HARDFORMULA/SOFTFORMULA rule of its own. // column with no HARDFORMULA/SOFTFORMULA rule of its own.
it('32 | Editing a plain (non-formula) cell marks it overwritten, and Revert restores it', () => { it('32 | Editing a plain (non-formula) cell marks it overwritten, and Revert restores it', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1015,7 +1016,7 @@ context('editor tests: ', function () {
}) })
it('33 | Selecting a range containing one overwritten cell shows Revert and only reverts that cell', () => { it('33 | Selecting a range containing one overwritten cell shows Revert and only reverts that cell', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1053,7 +1054,7 @@ context('editor tests: ', function () {
}) })
it('34 | Selecting a range with no overwritten cells does not show Revert', () => { it('34 | Selecting a range with no overwritten cells does not show Revert', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1074,7 +1075,7 @@ context('editor tests: ', function () {
}) })
it('35 | A selection spanning a newly-inserted row and an existing overwritten cell only reverts the existing row', () => { it('35 | A selection spanning a newly-inserted row and an existing overwritten cell only reverts the existing row', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1117,7 +1118,7 @@ context('editor tests: ', function () {
// already show their raw-vs-computed mismatch on load, with no manual // already show their raw-vs-computed mismatch on load, with no manual
// edit needed. // edit needed.
it('36 | Selecting a block spanning multiple pre-loaded overwritten cells across different rows and columns reverts only the actually-overwritten ones', () => { it('36 | Selecting a block spanning multiple pre-loaded overwritten cells across different rows and columns reverts only the actually-overwritten ones', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1175,7 +1176,7 @@ context('editor tests: ', function () {
}) })
it('37 | Selecting an entire column reverts every pre-loaded overwritten cell in it, leaving other columns and out-of-range rows untouched', () => { it('37 | Selecting an entire column reverts every pre-loaded overwritten cell in it, leaving other columns and out-of-range rows untouched', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1229,7 +1230,7 @@ context('editor tests: ', function () {
// proves the general revert path still works via a plain live edit on a // proves the general revert path still works via a plain live edit on a
// column that's a string, not a number. // column that's a string, not a number.
it('38 | Editing a plain character column with no DQ rule at all marks it overwritten, and Revert restores it', () => { it('38 | Editing a plain character column with no DQ rule at all marks it overwritten, and Revert restores it', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1265,7 +1266,7 @@ context('editor tests: ', function () {
// the dropdown were still closing, `.htDropdownMenu` would no longer // the dropdown were still closing, `.htDropdownMenu` would no longer
// exist and the `.should()` below would time out. // exist and the `.should()` below would time out.
it('39 | Left-click or right-click inside the info dropdown does not close it', () => { it('39 | Left-click or right-click inside the info dropdown does not close it', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_formula_test') openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => { clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', { cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
@@ -1291,6 +1292,613 @@ context('editor tests: ', function () {
}) })
}) })
}) })
// Row 1 (0-indexed): A_COL=2, B_COL=10 - see the HARDFORMULA/SOFTFORMULA
// tests' own comment above. FORMULA_SOFT_COL is a character column (see
// character-column-formula-plan.md), so it's formula-capable for pasted
// input; unlike FORMULA_HARD_COL it also accepts a user override (test 10).
it("40 | Pasting a formula with column names translates them to this row's cell references and evaluates it, on a formula-designated column", () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
getCellByHeaderAndRow(1, 'FORMULA_SOFT_COL').click()
pasteTextIntoFocusedCell('=A_COL * B_COL')
getCellByHeaderAndRow(1, 'FORMULA_SOFT_COL').should('have.text', '20')
})
})
})
// mpe_x_test has zero HARDFORMULA/SOFTFORMULA rules, but formulas are on
// for every table, not just ones that declare a formula rule - so
// paste-translation still works here too. Uses SOME_BESTNUM * 0 + 1936
// so the result is deterministic regardless of the column's actual value.
it('41 | Pasting a formula with column names on a table with zero formula rules still translates and evaluates it', () => {
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
// force: true - same overlay-clone-layer reason as sortByColumn's
// own comment below; SOME_CHAR's header sort icon covers the cell.
getCellByHeaderAndRow(1, 'SOME_CHAR').click({ force: true })
pasteTextIntoFocusedCell('=SOME_BESTNUM * 0 + 1936')
getCellByHeaderAndRow(1, 'SOME_CHAR').should('have.text', '1936')
})
})
})
it('42 | Pasting a formula referencing a column name inside a quoted string leaves the quoted text untouched', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
getCellByHeaderAndRow(1, 'FORMULA_SOFT_COL').click()
// A_COL needs a leading/trailing blank to be recognised as a
// column-name token (see substituteColumnReferences' own "no
// surrounding blanks" test) - matches the space-after-paren
// convention already used by this fixture's own CHANGE_SUMMARY_COL
// rule value ('=IF( DC.ROW_STATUS ="U",...)').
pasteTextIntoFocusedCell(
'=IF( A_COL > 0, "A_COL is positive", "negative")'
)
getCellByHeaderAndRow(1, 'FORMULA_SOFT_COL').should(
'have.text',
'A_COL is positive'
)
})
})
})
it('43 | Pasting a formula directly into an open cell editor (double-click, then paste) also translates and evaluates it', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
getCellByHeaderAndRow(1, 'FORMULA_SOFT_COL')
.dblclick({ force: true })
.then(() => {
pasteTextIntoFocusedCell('=A_COL * B_COL')
cy.focused().type('{enter}')
getCellByHeaderAndRow(1, 'FORMULA_SOFT_COL').should(
'have.text',
'20'
)
})
})
})
})
// PLAIN_TEXT_COL has no DQ rule at all - not HARDFORMULA/SOFTFORMULA-
// designated, and not referenced by any formula either. Only
// backend-sourced `=`-led values are ever auto-escaped - anything the
// user pastes or types is left exactly as entered, which genuinely
// evaluates as a live formula since formulas are on for every column.
it('44 | Pasting a formula-looking value into any character column evaluates it as a real formula - user input is never auto-escaped', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
getCellByHeaderAndRow(1, 'PLAIN_TEXT_COL').click()
pasteTextIntoFocusedCell('=100 * 100')
getCellByHeaderAndRow(1, 'PLAIN_TEXT_COL').should('have.text', '10000')
})
})
})
it('44b | Typing a formula-looking value directly into a character column evaluates it as a real formula too', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
getCellByHeaderAndRow(2, 'PLAIN_TEXT_COL')
.dblclick({ force: true })
.then(() => {
cy.focused().clear().type('=100 * 100{enter}')
})
getCellByHeaderAndRow(2, 'PLAIN_TEXT_COL').should('have.text', '10000')
})
})
})
// Rows 5/6/7 (0-indexed 4/5/6) come straight from the mock backend, never
// touched by a user - see getdata.js's own comment. Rows 5-6 are a
// `=`-led value that must be auto-escaped to literal text on load (not
// evaluated - only a *user's* input evaluates live, per test 44 above);
// row 7 is already apostrophe-escaped straight from the backend, which
// the app must never mistake for its own marker.
it('46 | A formula-looking value seeded from the backend into a character column is escaped to literal text on load; a genuinely-literal backend value is left untouched', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
// Row 5 (PK=5): references a column name (B_COL) - never
// translated (that only happens for a pasted value), so this is
// purely proving the escape, not evaluation.
getCellByHeaderAndRow(4, 'PLAIN_TEXT_COL').should(
'have.text',
'=100 + B_COL'
)
// Row 6 (PK=6): a bare arithmetic expression.
getCellByHeaderAndRow(5, 'PLAIN_TEXT_COL').should(
'have.text',
'=100 + 200'
)
// Row 7 (PK=7): already apostrophe-escaped in the backend data
// itself - Handsontable's own formulas-plugin display logic strips
// exactly one leading `'` for display regardless of who put it
// there, so this also reads as literal text with no leading `'`
// visible - the difference from rows 5-6 only shows up in what
// gets submitted (test 45) and in "Apply as formula" (test 47).
getCellByHeaderAndRow(6, 'PLAIN_TEXT_COL').should(
'have.text',
'=genuine literal'
)
})
})
})
// Proves requirements 2/5/6 together: an untouched auto-escaped cell
// (row 5) submits with the marker stripped back off; a genuinely-literal
// backend value (row 7) - never marked, since it never started with `=`
// in the first place - submits completely unchanged, leading `'` and all.
it('45 | Submits an untouched auto-escaped cell unmarked, and a genuinely-literal backend value completely unchanged', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
cy.intercept('POST', '**/SASjsApi/stp/execute*', (req) => {
const bodyText = JSON.stringify(req.body || '')
if (bodyText.includes('stagedata')) {
expect(bodyText).to.include('"PLAIN_TEXT_COL":"=100 + 200"')
expect(bodyText).not.to.include("'=100 + 200")
expect(bodyText).to.include('"PLAIN_TEXT_COL":"\'=genuine literal"')
}
req.continue()
}).as('stpExecute')
// PLAIN_TEXT_COL itself is never touched by hand on either row -
// editing each row's own A_COL instead marks both rows submittable
// (row 6 = PK 6, "=100 + 200"; row 7 = PK 7, the genuine literal)
// without disturbing PLAIN_TEXT_COL's auto-escaped/untouched state.
getCellByHeaderAndRow(5, 'A_COL')
.dblclick({ force: true })
.then(() => {
cy.focused().clear().type('60{enter}')
})
getCellByHeaderAndRow(6, 'A_COL')
.dblclick({ force: true })
.then(() => {
cy.focused().clear().type('70{enter}')
})
submitTable()
cy.get('#submitBtn', { timeout: longerCommandTimeout })
.should('exist')
.should('not.be.disabled')
cy.get('#formFields_8').type('round-trip submission test')
submitTableMessage()
})
})
})
// Requirement 7: "Apply as formula" only ever appears for / acts on a
// cell the app itself auto-escaped.
it('47 | "Apply as formula" is hidden when the selection has no auto-escaped cell', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
// Row 7 (PK=7) is genuinely-literal, never auto-escaped.
getCellByHeaderAndRow(6, 'PLAIN_TEXT_COL').click({ force: true })
getCellByHeaderAndRow(6, 'PLAIN_TEXT_COL').rightclick({ force: true })
cy.get('.htContextMenu').should(($menu) => {
expect($menu.text()).not.to.include('Apply as formula')
})
})
})
})
it('48 | "Apply as formula" appears when the selection has an auto-escaped cell, and only strips the auto-inserted marker from it', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
// Select rows 6-7 (PK 6-7) of PLAIN_TEXT_COL - row 6 auto-escaped
// (bare expression, no column-name translation needed), row 7
// genuinely literal from the backend.
getCellByHeaderAndRow(5, 'PLAIN_TEXT_COL').click({ force: true })
getCellByHeaderAndRow(6, 'PLAIN_TEXT_COL').click({
force: true,
shiftKey: true
})
getCellByHeaderAndRow(5, 'PLAIN_TEXT_COL').rightclick({ force: true })
cy.get('.htContextMenu').contains('Apply as formula').click()
// Row 6: marker stripped, now a real live formula.
getCellByHeaderAndRow(5, 'PLAIN_TEXT_COL').should('have.text', '300')
// Row 7: never marked, left completely untouched.
getCellByHeaderAndRow(6, 'PLAIN_TEXT_COL').should(
'have.text',
'=genuine literal'
)
})
})
})
// A user-typed formula in any character column (not just HARDFORMULA/
// SOFTFORMULA ones) is never auto-escaped and evaluates live (test 44b)
// - submission must send that computed value, not the raw formula text,
// the same way it already does for HARDFORMULA/SOFTFORMULA columns
// (test 27).
it('49 | Submits the computed value for a user-typed formula in a non-formula-rule column, not the raw formula text', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
cy.intercept('POST', '**/SASjsApi/stp/execute*', (req) => {
const bodyText = JSON.stringify(req.body || '')
if (bodyText.includes('stagedata')) {
expect(bodyText).to.include('"PLAIN_TEXT_COL":2')
expect(bodyText).not.to.match(/"PLAIN_TEXT_COL":"?=1\+1/)
}
req.continue()
}).as('stpExecute')
getCellByHeaderAndRow(1, 'PLAIN_TEXT_COL')
.dblclick({ force: true })
.then(() => {
cy.focused().clear().type('=1+1{enter}')
})
getCellByHeaderAndRow(1, 'PLAIN_TEXT_COL').should('have.text', '2')
submitTable()
cy.get('#submitBtn', { timeout: longerCommandTimeout })
.should('exist')
.should('not.be.disabled')
cy.get('#formFields_8').type('computed formula value submission test')
submitTableMessage()
})
})
})
// B_COL is `type: numeric` (DDTYPE N) - coerceNumericRow (beforePaste)
// deliberately leaves a non-numeric, formula-looking pasted value alone
// rather than forcing it to NaN, so a live formula can end up in a
// numeric column too, not just a character one. Submission must resolve
// its computed value the same way (test 49) - the raw `=2+2` text would
// otherwise reach the backend, which a numeric SAS field can't parse.
it('50 | Submits the computed value for a live formula pasted into a numeric column, not the raw formula text', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
cy.intercept('POST', '**/SASjsApi/stp/execute*', (req) => {
const bodyText = JSON.stringify(req.body || '')
if (bodyText.includes('stagedata')) {
expect(bodyText).to.include('"B_COL":4')
expect(bodyText).not.to.match(/"B_COL":"?=2\+2/)
}
req.continue()
}).as('stpExecute')
getCellByHeaderAndRow(1, 'B_COL').click()
pasteTextIntoFocusedCell('=2+2')
getCellByHeaderAndRow(1, 'B_COL').should('have.text', '4')
submitTable()
cy.get('#submitBtn', { timeout: longerCommandTimeout })
.should('exist')
.should('not.be.disabled')
cy.get('#formFields_8').type(
'numeric column computed formula value submission test'
)
submitTableMessage()
})
})
})
// A primary key identifies its own row for the rest of the edit session
// (dataModified/classifyRow match rows by PK) - a live, still-
// recalculating formula left sitting in a PK cell would let that
// identity drift between when it's entered and when submission finally
// resolves it, silently dropping the row from what's submitted. So
// unlike B_COL above, a formula pasted into PRIMARY_KEY_FIELD resolves
// to its computed value immediately, the moment the paste completes,
// rather than staying live until submit. Row 4 (PK=5): pasting
// `=999+1` evaluates to 1000, a value clearly different from both the
// original and every other row's PK, so a passing assertion here can't
// be a coincidence (nor a PK collision with another seeded row).
it('51 | Resolves a formula pasted into the primary key column to its computed value immediately', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
cy.intercept('POST', '**/SASjsApi/stp/execute*', (req) => {
const bodyText = JSON.stringify(req.body || '')
if (bodyText.includes('stagedata')) {
expect(bodyText).to.include('"PRIMARY_KEY_FIELD":1000')
}
req.continue()
}).as('stpExecute')
getCellByHeaderAndRow(4, 'PRIMARY_KEY_FIELD').should('have.text', '5')
getCellByHeaderAndRow(4, 'PRIMARY_KEY_FIELD').click()
pasteTextIntoFocusedCell('=999+1')
getCellByHeaderAndRow(4, 'PRIMARY_KEY_FIELD').should(
'have.text',
'1000'
)
submitTable()
cy.get('#submitBtn', { timeout: longerCommandTimeout })
.should('exist')
.should('not.be.disabled')
cy.get('#formFields_8').type(
'primary key computed formula value submission test'
)
submitTableMessage()
})
})
})
// Nothing gates a HARDFORMULA/SOFTFORMULA rule's BASE_COL by column type
// or PK-ness - MPE_X_FORMULA_PK_TEST's composite PK is itself made up of
// a HARDFORMULA numeric column and a SOFTFORMULA character column. Left
// unresolved, that reproduces the same PK-identity bug test 51 fixes -
// just triggered by the rule seeding instead of a user edit, and present
// on every row from the very first render rather than only an edited
// one. resolvePkFormulaSeedValues (editor.component.ts) freezes both PK
// cells to their computed values once, right after the initial table
// load, so they display correctly immediately and the row still submits
// - editing A_COL afterward (which the PK formulas reference) must NOT
// retroactively recompute either PK cell, proving they're frozen rather
// than still-live.
it('52 | A primary key made of HARDFORMULA/SOFTFORMULA columns freezes to its computed value at load and still submits correctly', () => {
openTableFromTree('testdata', 'mpe_x_formula_pk_test')
// Row 0: A_COL=2, B_COL=3 -> PK_HARDFORMULA_COL=6, PK_SOFTFORMULA_COL="PK-2".
getCellByHeaderAndRow(0, 'PK_HARDFORMULA_COL').should('have.text', '6')
getCellByHeaderAndRow(0, 'PK_SOFTFORMULA_COL').should('have.text', 'PK-2')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
cy.intercept('POST', '**/SASjsApi/stp/execute*', (req) => {
const bodyText = JSON.stringify(req.body || '')
if (bodyText.includes('stagedata')) {
// The row must not be silently dropped from what's submitted
// - both frozen PK values and the actually-edited column must
// be present.
expect(bodyText).to.include('"PK_HARDFORMULA_COL":6')
expect(bodyText).to.include('"PK_SOFTFORMULA_COL":"PK-2"')
expect(bodyText).to.include('"A_COL":9')
}
req.continue()
}).as('stpExecute')
getCellByHeaderAndRow(0, 'A_COL')
.dblclick({ force: true })
.then(() => {
cy.focused().clear().type('9{enter}')
})
// Frozen, not live - A_COL changing from 2 to 9 would recompute
// PK_HARDFORMULA_COL to 27 if it were still a live formula.
getCellByHeaderAndRow(0, 'PK_HARDFORMULA_COL').should('have.text', '6')
submitTable()
cy.get('#submitBtn', { timeout: longerCommandTimeout })
.should('exist')
.should('not.be.disabled')
cy.get('#formFields_8').type(
'formula-driven composite primary key submission test'
)
submitTableMessage()
})
})
})
// afterChange delivers Handsontable's own VISUAL row - the EDIT_STATUS/
// overwritten-comment sync hook must translate that to physical before
// touching dataSource (classifyRow, PK-matching), and the two methods it
// calls must translate back to visual for their own Handsontable/
// comments-plugin writes. ROW_STATUS_COL (=DC.ROW_STATUS) makes the
// EDIT_STATUS write directly observable, so sorting first (breaking
// visual/physical alignment) and editing the row that moved proves the
// fix end-to-end, not just that an unsorted grid still works.
it('53 | Editing a row after sorting updates DC.ROW_STATUS on that same row, not whatever row now visually sits in its old position', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
sortByColumn('PLAIN_TEXT_COL')
cy.get('.ht_clone_top .htCore thead tr th').then(($ths) => {
const pkColIndex = [...$ths].findIndex(
(th) => th.innerText.trim() === 'PRIMARY_KEY_FIELD'
)
const statusColIndex = [...$ths].findIndex(
(th) => th.innerText.trim() === 'ROW_STATUS_COL'
)
cy.get('.ht_master tbody tr').then((rows: any) => {
const visualRow = [...rows].findIndex(
(row: any) => row.childNodes[pkColIndex].innerText.trim() === '1'
)
// Rows 7-10 (their own pre-existing FORMULA_HARD_COL/
// FORMULA_SOFT_COL data, silently overwritten by the DQ rule -
// see test 28) already read 'M' from the very first render, so
// asserting a specific OTHER row is 'U' would be a coincidence
// of seed data, not a proof of anything. Snapshot every other
// row's own status instead, and assert none of them changed -
// that's what actually distinguishes "the edit landed on the
// right row" from "it landed on whatever moved into that
// visual slot".
const beforeStatuses = [...rows].map((row: any, i: number) =>
i === visualRow
? null
: row.childNodes[statusColIndex].innerText.trim()
)
getCellByHeaderAndRow(visualRow, 'ROW_STATUS_COL').should(
'have.text',
'U'
)
getCellByHeaderAndRow(visualRow, 'A_COL')
.dblclick({ force: true })
.then(() => {
cy.focused().clear().type('999{enter}')
})
// The edited row (PK=1) shows 'M' at its own visual position...
getCellByHeaderAndRow(visualRow, 'ROW_STATUS_COL').should(
'have.text',
'M'
)
// ...and every other row's status is exactly what it was
// before - none of them got the write meant for row PK=1.
cy.get('.ht_master tbody tr').should((rows2: any) => {
;[...rows2].forEach((row: any, i: number) => {
if (i === visualRow) return
const status = row.childNodes[statusColIndex].innerText.trim()
expect(status, `row ${i} status unchanged`).to.equal(
beforeStatuses[i]
)
})
})
})
})
})
})
})
// multiColumnSorting's own sort() replaces its entire sort state on every
// call rather than accumulating (see its own JSDoc) - restoring a
// captured multi-column sort with a loop of single-column sort() calls
// therefore silently drops every column but the last one restored. This
// hits cancelEdit() specifically once a user has shift-clicked a second
// header to sort by two columns, then clicks Cancel: the underlying bug
// is already covered directly against the Handsontable plugin in
// sortedGridRowSync.integration.spec.ts, but only a real shift-click
// through the actual grid proves editor.component.ts's own cancelEdit()
// restores it correctly end-to-end.
it('54 | Cancelling an edit after sorting by two columns keeps both columns sorted, not just the last one clicked', () => {
openTableFromTree('testdata', 'mpe_x_formula_test')
clickOnEdit(() => {
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).then(() => {
sortByColumn('A_COL')
sortByColumnAdditional('B_COL')
cy.get('.ht_clone_top .htCore thead tr th').then(($ths) => {
const pkColIndex = [...$ths].findIndex(
(th) => th.innerText.trim() === 'PRIMARY_KEY_FIELD'
)
cy.get('.ht_master tbody tr').then((rows: any) => {
const beforeCancelPkOrder = [...rows].map((row: any) =>
row.childNodes[pkColIndex].innerText.trim()
)
cy.get('.btn.btn-sm.btn-icon.btn-outline-danger', {
timeout: longerCommandTimeout
}).click()
// cancelEdit() re-renders read-only with the same dataSource,
// still ordered by the restored sort - the row order itself is
// the only observable signal that both columns' sort survived.
cy.get('.ht_master tbody tr').should((rows2: any) => {
const afterCancelPkOrder = [...rows2].map((row: any) =>
row.childNodes[pkColIndex].innerText.trim()
)
expect(afterCancelPkOrder).to.deep.equal(beforeCancelPkOrder)
})
})
})
})
})
})
}) })
// Handsontable virtualizes columns — with 18 columns on MPE_X_NEW, only // Handsontable virtualizes columns — with 18 columns on MPE_X_NEW, only
@@ -1320,6 +1928,19 @@ const sortByColumn = (headerText: string) => {
.click({ force: true }) .click({ force: true })
} }
// Shift-clicks a column header's sort indicator to ADD it to whatever sort
// is already active, rather than replacing it - Handsontable's own
// multiColumnSorting UI convention for building a multi-column sort (a
// plain click, sortByColumn above, always starts a fresh single-column
// sort instead).
const sortByColumnAdditional = (headerText: string) => {
cy.get('.ht_clone_top .htCore thead tr th')
.filter((_, th) => Cypress.$(th).text().includes(headerText))
.last()
.find('.columnSorting')
.click({ force: true, shiftKey: true })
}
// Opens a column header's dropdown menu to reach its `info` item, which // Opens a column header's dropdown menu to reach its `info` item, which
// has a custom renderer showing NAME/LABEL/TYPE/LENGTH/FORMAT and, when the // has a custom renderer showing NAME/LABEL/TYPE/LENGTH/FORMAT and, when the
// column has a HARDREGEX/SOFTREGEX rule, the applied pattern. Clicking the // column has a HARDREGEX/SOFTREGEX rule, the applied pattern. Clicking the
@@ -1352,6 +1973,27 @@ const openColumnDropdown = (headerText: string) => {
// re-renders virtualized columns asynchronously after a scroll event, on // re-renders virtualized columns asynchronously after a scroll event, on
// its own schedule outside Cypress's command queue, so scrollTo() settling // its own schedule outside Cypress's command queue, so scrollTo() settling
// does not mean the target column has been rendered yet. // does not mean the target column has been rendered yet.
// Simulates a real clipboard paste into whichever element currently has
// DOM focus (Handsontable moves focus to its own internal textarea once a
// cell is selected/clicked) - Cypress has no built-in clipboard simulation,
// and Handsontable's CopyPaste plugin only listens for a native 'paste'
// DOM event with clipboardData, so a synthetic ClipboardEvent is
// dispatched directly rather than trying to drive the OS clipboard.
const pasteTextIntoFocusedCell = (text: string) => {
cy.focused().then(($el) => {
const dataTransfer = new DataTransfer()
dataTransfer.setData('text/plain', text)
const pasteEvent = new ClipboardEvent('paste', {
clipboardData: dataTransfer,
bubbles: true,
cancelable: true
})
$el[0].dispatchEvent(pasteEvent)
})
}
const getCellByHeaderAndRow = (rowIndex: number, headerText: string) => { const getCellByHeaderAndRow = (rowIndex: number, headerText: string) => {
return cy return cy
.get('.ht_clone_top .htCore thead tr th') .get('.ht_clone_top .htCore thead tr th')
+1 -1
View File
@@ -546,7 +546,7 @@ const checkResultOfFormulaUpload = (callback?: any) => {
.find('tbody') .find('tbody')
.then((data) => { .then((data) => {
const cell: any = data[0].children[0].children[5] const cell: any = data[0].children[0].children[5]
expect(cell.innerText).to.equal('=1+1') expect(cell.innerText).to.equal('2')
if (callback) callback() if (callback) callback()
}) })
} }
+24 -35
View File
@@ -25,7 +25,7 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_CHAR', 'this is dummy data', 'value', () => { setFilterWithValue('SOME_CHAR', 'this is dummy data', 'value', () => {
checkInfoBarIncludes( checkInfoBarIncludes(
`AND,AND,0,SOME_CHAR,=,"'this is dummy data'"`, `(( SOME_CHAR = 'this is dummy data' ))`,
(includes: boolean) => { (includes: boolean) => {
if (includes) done() if (includes) done()
} }
@@ -39,7 +39,7 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_NUM', '42', 'value', () => { setFilterWithValue('SOME_NUM', '42', 'value', () => {
checkInfoBarIncludes(`AND,AND,0,SOME_NUM,=,42`, (includes: boolean) => { checkInfoBarIncludes(`(( SOME_NUM = 42 ))`, (includes: boolean) => {
if (includes) done() if (includes) done()
}) })
}) })
@@ -51,12 +51,9 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_TIME', '00:00:42', 'time', () => { setFilterWithValue('SOME_TIME', '00:00:42', 'time', () => {
checkInfoBarIncludes( checkInfoBarIncludes(`(( SOME_TIME = 42 ))`, (includes: boolean) => {
`AND,AND,0,SOME_TIME,=,42`, if (includes) done()
(includes: boolean) => { })
if (includes) done()
}
)
}) })
}) })
}) })
@@ -66,12 +63,9 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_TIME', '42', 'value', () => { setFilterWithValue('SOME_TIME', '42', 'value', () => {
checkInfoBarIncludes( checkInfoBarIncludes(`(( SOME_TIME = 42 ))`, (includes: boolean) => {
`AND,AND,0,SOME_TIME,=,42`, if (includes) done()
(includes: boolean) => { })
if (includes) done()
}
)
}) })
}, false) }, false)
}) })
@@ -81,12 +75,9 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_DATE', '12/02/1960', 'date', () => { setFilterWithValue('SOME_DATE', '12/02/1960', 'date', () => {
checkInfoBarIncludes( checkInfoBarIncludes(`(( SOME_DATE = 42 ))`, (includes: boolean) => {
`AND,AND,0,SOME_DATE,=,42`, if (includes) done()
(includes: boolean) => { })
if (includes) done()
}
)
}) })
}) })
}) })
@@ -96,12 +87,9 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_DATE', '42', 'value', () => { setFilterWithValue('SOME_DATE', '42', 'value', () => {
checkInfoBarIncludes( checkInfoBarIncludes(`(( SOME_DATE = 42 ))`, (includes: boolean) => {
`AND,AND,0,SOME_DATE,=,42`, if (includes) done()
(includes: boolean) => { })
if (includes) done()
}
)
}) })
}, false) }, false)
}) })
@@ -116,7 +104,7 @@ context('filtering tests: ', function () {
'datetime', 'datetime',
() => { () => {
checkInfoBarIncludes( checkInfoBarIncludes(
`AND,AND,0,SOME_DATETIME,=,42`, `(( SOME_DATETIME = 42 ))`,
(includes: boolean) => { (includes: boolean) => {
if (includes) done() if (includes) done()
} }
@@ -132,7 +120,7 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_DATETIME', '42', 'value', () => { setFilterWithValue('SOME_DATETIME', '42', 'value', () => {
checkInfoBarIncludes( checkInfoBarIncludes(
`AND,AND,0,SOME_DATETIME,=,42`, `(( SOME_DATETIME = 42 ))`,
(includes: boolean) => { (includes: boolean) => {
if (includes) done() if (includes) done()
} }
@@ -146,12 +134,9 @@ context('filtering tests: ', function () {
openFilterPopup(() => { openFilterPopup(() => {
setFilterWithValue('SOME_DATE', '', 'in', () => { setFilterWithValue('SOME_DATE', '', 'in', () => {
checkInfoBarIncludes( checkInfoBarIncludes(`(( SOME_DATE IN (42) ))`, (includes: boolean) => {
`AND,AND,0,SOME_DATE,IN,(0)`, if (includes) done()
(includes: boolean) => { })
if (includes) done()
}
)
}) })
}) })
}) })
@@ -311,7 +296,11 @@ const setFilterWithValue = (
}) })
}) })
break // The IN clause is submitted by the modal footer button above; the
// trailing tab/click sequence below is for the plain value fields and
// must not run here (focus is gone once the modal closes and the
// editor reloads with the stored filter).
return
} }
case 'between': { case 'between': {
cy.focused().tab() cy.focused().tab()
+344 -1
View File
@@ -249,6 +249,10 @@ context('licensing tests: ', function () {
cy.get('button').contains('Paste licence').click() cy.get('button').contains('Paste licence').click()
// Defaults to the combined single-field form - switch to the legacy
// two-field layout, since this test targets that path specifically.
cy.get('button').contains('Paste as two separate keys instead').click()
// HTTP-format keys are generated as the exact same string for both // HTTP-format keys are generated as the exact same string for both
// fields (see detectLicenceKeyProtocolMismatch's own doc comment) - // fields (see detectLicenceKeyProtocolMismatch's own doc comment) -
// any non-empty matching pair triggers the warning, no real key needed. // any non-empty matching pair triggers the warning, no real key needed.
@@ -273,6 +277,261 @@ context('licensing tests: ', function () {
}) })
}) })
it('7 | Combined single-string key (default paste format) activates successfully', (done) => {
let keyData = {
valid_until: moment().add(1, 'year').format('YYYY-MM-DD'),
users_allowed: 4,
hot_license_key: '',
demo: false,
site_id: site_id
}
generateKeys(keyData, (keysGen: any) => {
cy.wait(2000)
// Navigate there explicitly rather than only acting when already on
// the licensing page - earlier tests may have left the app on it (a
// bad key) or already activated (a good one), and this test should
// pass either way rather than silently no-op when it's the latter.
isLicensingPage((result: boolean) => {
const proceed = () =>
generateCombinedKey(keysGen.licenseKey, keysGen.activationKey).then(
(combinedKey) => {
inputCombinedKeyPage(combinedKey)
cy.wait(2000)
acceptTermsIfPresented((termsResult: boolean) => {
if (termsResult) {
cy.wait(10000)
}
visitPage('home')
cy.get('.nav-tree clr-tree > clr-tree-node', {
timeout: longerCommandTimeout
}).then(() => {
done()
})
})
}
)
if (!result) {
visitPage('licensing/update')
cy.wait(2000)
}
// proceed() generates the combined key asynchronously, then
// enqueues the actual page commands only once its promise
// resolves. Bridged through cy.then() so the command chain stays
// open across that async gap: a bare proceed() call returns a
// promise that nothing awaits, and once the surrounding queue
// has drained, commands enqueued from that promise's continuation
// are never run.
cy.then(() => proceed())
})
})
})
it('8 | Pasting a combined key into the legacy licence-key field alone still auto-detects and activates', (done) => {
let keyData = {
valid_until: moment().add(1, 'year').format('YYYY-MM-DD'),
users_allowed: 4,
hot_license_key: '',
demo: false,
site_id: site_id
}
generateKeys(keyData, (keysGen: any) => {
cy.wait(2000)
// Navigate there explicitly rather than only acting when already on
// the licensing page - see test 7's own comment for why.
isLicensingPage((result: boolean) => {
const proceed = () =>
generateCombinedKey(keysGen.licenseKey, keysGen.activationKey).then(
(combinedKey) => {
cy.get('button').contains('Paste licence').click()
cy.get('button')
.contains('Paste as two separate keys instead')
.click()
// Only the licence-key field gets the combined string - the
// activation-key field is left empty, proving the split
// populates both fields from this one paste.
cy.get('.license-key-form textarea', {
timeout: longerCommandTimeout
})
.invoke('val', combinedKey)
.trigger('input')
.trigger('mouseleave')
cy.get('.activation-key-form textarea', {
timeout: longerCommandTimeout
}).should(($textarea) => {
expect($textarea.val()).to.equal(keysGen.activationKey)
})
cy.get('button.apply-keys').click()
cy.wait(2000)
acceptTermsIfPresented((termsResult: boolean) => {
if (termsResult) {
cy.wait(10000)
}
visitPage('home')
cy.get('.nav-tree clr-tree > clr-tree-node', {
timeout: longerCommandTimeout
}).then(() => {
done()
})
})
}
)
// See test 7's own comment for why proceed() is bridged through
// cy.then() rather than called as a plain statement.
if (!result) {
visitPage('licensing/update')
cy.wait(2000)
}
cy.then(() => proceed())
})
})
})
it('9 | Uploading a single-line combined-format file activates successfully', (done) => {
let keyData = {
valid_until: moment().add(1, 'year').format('YYYY-MM-DD'),
users_allowed: 4,
hot_license_key: '',
demo: false,
site_id: site_id
}
generateKeys(keyData, (keysGen: any) => {
cy.wait(2000)
// Navigate there explicitly rather than only acting when already on
// the licensing page - see test 7's own comment for why.
isLicensingPage((result: boolean) => {
const proceed = () =>
generateCombinedKey(keysGen.licenseKey, keysGen.activationKey).then(
(combinedKey) => {
cy.get('input[type="file"]').attachFile({
fileContent: new Blob([combinedKey], { type: 'text/plain' }),
fileName: 'datacontroller-licence-combined.txt',
mimeType: 'text/plain'
})
cy.get('button.apply-keys', {
timeout: longerCommandTimeout
}).click()
cy.wait(2000)
acceptTermsIfPresented((termsResult: boolean) => {
if (termsResult) {
cy.wait(10000)
}
visitPage('home')
cy.get('.nav-tree clr-tree > clr-tree-node', {
timeout: longerCommandTimeout
}).then(() => {
done()
})
})
}
)
// See test 7's own comment for why proceed() is bridged through
// cy.then() rather than called as a plain statement.
if (!result) {
visitPage('licensing/update')
cy.wait(2000)
}
cy.then(() => proceed())
})
})
})
it('10 | Key details preview shows for a validly-pasted key and disappears once the key input is cleared', (done) => {
let keyData = {
valid_until: moment().add(1, 'year').format('YYYY-MM-DD'),
users_allowed: 4,
hot_license_key: '',
demo: false,
site_id: site_id,
// Kept to just the two enabled toggles (relying on
// decodeLicenceFeatures' fallback for the rest) to keep the
// encrypted payload well under this suite's RSA-OAEP plaintext
// ceiling - see generateKeys' modulusLength below.
features: { vb: true, fu: true }
}
generateKeys(keyData, (keysGen: any) => {
cy.wait(2000)
// Navigate there explicitly rather than only acting when already on
// the licensing page - see test 7's own comment for why.
isLicensingPage((result: boolean) => {
const proceed = () =>
generateCombinedKey(keysGen.licenseKey, keysGen.activationKey).then(
(combinedKey) => {
cy.get('button').contains('Paste licence').click()
cy.get('.combined-key-form textarea', {
timeout: longerCommandTimeout
})
.invoke('val', combinedKey)
.trigger('input')
.trigger('mouseleave')
cy.get('.key-details')
.should('contain', 'Valid until:')
.and('contain', 'Allowed users:')
.and('contain', '4')
.and('contain', 'Site ID(s) in this key:')
.and('contain', 'Enabled features:')
.and('contain', 'Viewbox')
.and('contain', 'File Upload')
.invoke('text')
.then((text) => {
expect(text).to.not.contain('Edit Record')
expect(text).to.not.contain('Add Record')
})
cy.get('.combined-key-form textarea')
.invoke('val', '')
.trigger('input')
.trigger('mouseleave')
cy.get('.key-details')
.should('not.exist')
.then(() => {
done()
})
}
)
// See test 7's own comment for why this is chained via .then()
// rather than called as the next plain statement.
if (!result) {
visitPage('licensing/update')
cy.wait(2000).then(() => proceed())
} else {
proceed()
}
})
})
})
if (testLicenceUserLimits) { if (testLicenceUserLimits) {
it('4 | User try to register when limit is reached', (done) => { it('4 | User try to register when limit is reached', (done) => {
let keyData = { let keyData = {
@@ -446,7 +705,7 @@ const verifyLicensingPage = (text: string, callback: any) => {
cy.wait(1000) cy.wait(1000)
isLicensingPage((result: boolean) => { isLicensingPage((result: boolean) => {
if (result) { if (result) {
cy.get('p.key-error') cy.get('.key-error')
.should('contain', text) .should('contain', text)
.then((treeNodes: any) => { .then((treeNodes: any) => {
callback(true) callback(true)
@@ -470,6 +729,10 @@ const verifyLicensingWarning = (text: string, callback: any) => {
const inputLicenseKeyPage = (licenseKey: string, activationKey: string) => { const inputLicenseKeyPage = (licenseKey: string, activationKey: string) => {
cy.get('button').contains('Paste licence').click() cy.get('button').contains('Paste licence').click()
// Defaults to the combined single-field form - this helper exercises the
// two-part path specifically, so switch to it first.
cy.get('button').contains('Paste as two separate keys instead').click()
cy.get('.license-key-form textarea', { timeout: longerCommandTimeout }) cy.get('.license-key-form textarea', { timeout: longerCommandTimeout })
.invoke('val', licenseKey) .invoke('val', licenseKey)
.trigger('input') .trigger('input')
@@ -481,6 +744,30 @@ const inputLicenseKeyPage = (licenseKey: string, activationKey: string) => {
cy.get('button.apply-keys').click() cy.get('button.apply-keys').click()
} }
const inputCombinedKeyPage = (combinedKey: string) => {
cy.get('button').contains('Paste licence').click()
// Combined is the default paste format - no toggle click needed here,
// unlike inputLicenseKeyPage's legacy two-field path.
cy.get('.combined-key-form textarea', { timeout: longerCommandTimeout })
.invoke('val', combinedKey)
.trigger('input')
.trigger('mouseleave')
.should('not.be.undefined')
// mouseleave's handler (onCombinedKeyInput) does async work - gzip
// decompress the split, then decrypt for the key-details preview -
// before licenceKeyValue/activationKeyValue are ready to submit.
// Wait for that preview to land rather than racing "Apply licence
// keys" against the still-in-flight promise.
cy.get('.key-details', { timeout: longerCommandTimeout }).should(
'contain',
'Valid until:'
)
cy.get('button.apply-keys').click()
}
const updateUsersTable = (options: any, callback?: any) => { const updateUsersTable = (options: any, callback?: any) => {
visitPage('home') visitPage('home')
openTableFromTree(libraryToOpenIncludes, 'mpe_users') openTableFromTree(libraryToOpenIncludes, 'mpe_users')
@@ -625,6 +912,62 @@ const generateKeys = async (licenseData: any, resultCallback?: any) => {
}) })
} }
// Mirrors dckey's own encodeCombinedKey()/gzipCompress() (main.js) and
// DC's own splitCombinedLicenceKey() decode side, so this stays a genuine
// end-to-end check of the real format rather than a fixture the app
// happens to accept.
const COMBINED_KEY_PREFIX = 'DCKEY1:'
// Reads a ReadableStream directly via its own reader, rather than through
// `new Response(readable).arrayBuffer()` - Cypress patches fetch/Response
// globally for its network-interception features, which appears to hang
// a Response built locally around a stream that never touches the network
// (writer.write()/close() resolve fine; only the Response-based read never
// settles).
const streamToArrayBuffer = async (
readable: ReadableStream<Uint8Array>
): Promise<ArrayBuffer> => {
const reader = readable.getReader()
const chunks: Uint8Array[] = []
let totalLength = 0
while (true) {
const { done, value } = await reader.read()
if (done) break
chunks.push(value)
totalLength += value.length
}
const result = new Uint8Array(totalLength)
let offset = 0
for (const chunk of chunks) {
result.set(chunk, offset)
offset += chunk.length
}
return result.buffer
}
const generateCombinedKey = async (
licenseKey: string,
activationKey: string
): Promise<string> => {
const payloadBytes = new TextEncoder().encode(
`${licenseKey} ${activationKey}`
)
const compressionStream = new CompressionStream('gzip')
const writer = compressionStream.writable.getWriter()
const [, compressedBuffer] = await Promise.all([
writer.write(payloadBytes).then(() => writer.close()),
streamToArrayBuffer(compressionStream.readable)
])
const compressedBase64 = await arrayBufferToBase64(compressedBuffer)
return COMBINED_KEY_PREFIX + compressedBase64
}
const editTableField = (edits: EditConfigTableCells[], callback?: any) => { const editTableField = (edits: EditConfigTableCells[], callback?: any) => {
cy.get('td').then((tdNodes: any) => { cy.get('td').then((tdNodes: any) => {
for (let edit of edits) { for (let edit of edits) {
+120 -14
View File
@@ -1,37 +1,81 @@
const username = Cypress.env('username')
const password = Cypress.env('password')
const hostUrl = Cypress.env('hosturl') const hostUrl = Cypress.env('hosturl')
const appLocation = Cypress.env('appLocation') const appLocation = Cypress.env('appLocation')
const longerCommandTimeout = Cypress.env('longerCommandTimeout') const longerCommandTimeout = Cypress.env('longerCommandTimeout')
const serverType = Cypress.env('serverType')
const libraryToOpenIncludes = Cypress.env(`libraryToOpenIncludes_${serverType}`)
const fixturePath = 'excels/'
context('stage tests: ', function () { context('stage tests: ', function () {
this.beforeAll(() => { this.beforeAll(() => {
cy.visit(`${hostUrl}/SASLogon/logout`) cy.visit(`${hostUrl}/SASLogon/logout`)
cy.loginAndUpdateValidKey() cy.loginAndUpdateValidKey(true)
}) })
this.beforeEach(() => { this.beforeEach(() => {
cy.visit(hostUrl + appLocation) cy.visit(hostUrl + appLocation)
visitPage('stage/DC20221007T122326121_612316_7259') visitPage('home')
}) })
// getstagetable's mock ignores the table_id param entirely, so any id in
// the URL resolves to the same fixture row - no need to submit a real
// table first just to reach this page.
it('1 | Formatted/Unformatted toggle switches between fmt_stagetable and stagetable, defaulting to formatted', () => { it('1 | Formatted/Unformatted toggle switches between fmt_stagetable and stagetable, defaulting to formatted', () => {
cy.get('.app-loading', { timeout: longerCommandTimeout }).should( openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
'not.exist'
)
getCellByHeaderAndRow(0, 'SOME_DATE').should('have.text', '12FEB1960') attachExcelFile('regular_excel.xlsx', () => {
submitExcel()
cy.get('.formatted-values-toggle').click() // The app navigates to /stage/{tableId}.
cy.url({ timeout: longerCommandTimeout }).should('include', '/stage/')
getCellByHeaderAndRow(0, 'SOME_DATE').should('have.text', '42') cy.get('.app-loading', { timeout: longerCommandTimeout }).should(
'not.exist'
)
// Toggling back reverts to the formatted view. // Toggle to unformatted first to read the raw SOME_DATE value.
cy.get('.formatted-values-toggle').click() cy.get('.formatted-values-toggle').click()
getCellByHeaderAndRow(0, 'SOME_DATE').should('have.text', '12FEB1960') getCellByHeaderAndRow(0, 'SOME_DATE')
.invoke('text')
.then((rawText) => {
const rawDate = parseInt(rawText, 10)
// Toggle back to formatted view.
cy.get('.formatted-values-toggle').click()
// Compute the expected SAS date9. format from the raw value.
const sasEpoch = new Date(Date.UTC(1960, 0, 1))
const formatted = new Date(sasEpoch.getTime() + rawDate * 86400000)
const months = [
'JAN',
'FEB',
'MAR',
'APR',
'MAY',
'JUN',
'JUL',
'AUG',
'SEP',
'OCT',
'NOV',
'DEC'
]
const expected =
String(formatted.getUTCDate()).padStart(2, '0') +
months[formatted.getUTCMonth()] +
formatted.getUTCFullYear()
getCellByHeaderAndRow(0, 'SOME_DATE').should('have.text', expected)
// Toggle to unformatted again to verify round-trip.
cy.get('.formatted-values-toggle').click()
getCellByHeaderAndRow(0, 'SOME_DATE').should(
'have.text',
String(rawDate)
)
})
})
}) })
}) })
@@ -39,6 +83,68 @@ const visitPage = (url: string) => {
cy.visit(`${hostUrl}${appLocation}/#/${url}`) cy.visit(`${hostUrl}${appLocation}/#/${url}`)
} }
const openTableFromTree = (libNameIncludes: string, tablename: string) => {
cy.get('.app-loading', { timeout: longerCommandTimeout })
.should('not.exist')
.then(() => {
cy.get('.nav-tree clr-tree > clr-tree-node', {
timeout: longerCommandTimeout
}).then((treeNodes: any) => {
let viyaLib
for (let node of treeNodes) {
if (node.innerText.toLowerCase().includes(libNameIncludes)) {
viyaLib = node
break
}
}
cy.get(viyaLib).within(() => {
cy.get('.clr-tree-node-content-container > button').click()
cy.get('.clr-treenode-link').then((innerNodes: any) => {
for (let innerNode of innerNodes) {
if (innerNode.innerText.toLowerCase().includes(tablename)) {
innerNode.click()
break
}
}
})
})
})
})
}
const attachExcelFile = (excelFilename: string, callback?: any) => {
cy.get('.buttonBar button:last-child')
.should('exist')
.click()
.then(() => {
cy.get('input[type="file"]#file-upload')
.attachFile(`/${fixturePath}/${excelFilename}`)
.then(() => {
cy.get('.clr-abort-modal .modal-title').then((modalTitle) => {
if (!modalTitle[0].innerHTML.includes('Abort Message')) {
cy.get('.modal-footer .btn.btn-primary').then((modalBtn) => {
modalBtn.click()
if (callback) callback()
})
} else {
if (callback) callback()
}
})
})
})
}
const submitExcel = (callback?: any) => {
cy.get('.buttonBar button.preview-submit', { timeout: longerCommandTimeout })
.click()
.then(() => {
if (callback) callback()
})
}
// Locates a body cell by its column's header text rather than a hardcoded // Locates a body cell by its column's header text rather than a hardcoded
// childNodes index - same helper as editor.cy.ts's own. // childNodes index - same helper as editor.cy.ts's own.
const getCellByHeaderAndRow = (rowIndex: number, headerText: string) => { const getCellByHeaderAndRow = (rowIndex: number, headerText: string) => {
@@ -0,0 +1,73 @@
// Marks this file as an ES module (rather than a global script) so its
// top-level consts don't collide, under the TS type-checker, with the same
// names declared in other spec files — see e.g. stage.cy.ts, which gets
// this for free via a real import.
export {}
const hostUrl = Cypress.env('hosturl')
const appLocation = Cypress.env('appLocation')
const longerCommandTimeout = Cypress.env('longerCommandTimeout')
context('submitted-details tests: ', function () {
this.beforeAll(() => {
cy.loginAndUpdateValidKey(true)
})
it('1 | clicking an open submit loads its diffs with a single postdata request', () => {
// Count every STP request the app makes during the test.
// The STP URL is `stp/execute/?_program=...` - glob segments don't match
// past `execute/` with a single `*`, so keep the glob within the path.
cy.intercept('POST', '**/SASjsApi/stp/**').as('stpExecute')
cy.visit(`${hostUrl}${appLocation}/#/review/submitted`)
cy.get('.app-loading', { timeout: longerCommandTimeout }).should(
'not.exist'
)
// the SUBMIT queue list must be rendered with at least one row
cy.get('app-submitter clr-datagrid clr-dg-row', {
timeout: longerCommandTimeout
})
.should('exist')
.and('have.length.greaterThan', 0)
// route-based flow: clicking a row navigates to /review/submitted/:tableId
// and triggers exactly one SHOW_DIFFS (auditors/postdata) request
cy.get('app-submitter clr-datagrid clr-dg-row')
.first()
.click()
.then(() => {
cy.url().should('include', '/review/submitted/')
})
// wait for the diff table to render (the response was applied)
cy.get('app-approve-details .card', { timeout: longerCommandTimeout })
.should('exist')
.should('be.visible')
// give any (incorrect) duplicate request time to surface
cy.wait(3000)
cy.get('@stpExecute.all').then((allRequests: any) => {
// the adapter posts multipart form data, so match on the _program
// query param rather than the request body
const postdataRequests = allRequests.filter((req: any) =>
JSON.stringify(req.request.query || {}).includes('auditors/postdata')
)
expect(
postdataRequests.length,
'exactly one auditors/postdata SHOW_DIFFS request'
).to.equal(1)
// the submit queue was already fetched to render the list - opening a
// row must not fetch it again
const getsubmitsRequests = allRequests.filter((req: any) =>
JSON.stringify(req.request.query || {}).includes('editors/getsubmits')
)
expect(
getsubmitsRequests.length,
'no editors/getsubmits request after opening a submit'
).to.equal(1)
})
})
})
Binary file not shown.
+6
View File
@@ -183,6 +183,12 @@ const isLicensingPage = (callback: any) => {
const inputLicenseKeyPage = (licenseKey: string, activationKey: string) => { const inputLicenseKeyPage = (licenseKey: string, activationKey: string) => {
cy.get('button').contains('Paste licence').click() cy.get('button').contains('Paste licence').click()
// Combined single-string paste is the default format now - switch to
// the legacy two-field layout, since this helper fills licenseKey and
// activationKey as two separate values.
cy.get('button').contains('Paste as two separate keys instead').click()
cy.get('.license-key-form textarea', { timeout: longerCommandTimeout }) cy.get('.license-key-form textarea', { timeout: longerCommandTimeout })
.invoke('val', licenseKey) .invoke('val', licenseKey)
.trigger('input') .trigger('input')
+21 -23
View File
@@ -1,32 +1,30 @@
import * as base64Converter from 'base64-arraybuffer'
export const base64ToArrayBuffer = (base64: string) => { export const base64ToArrayBuffer = (base64: string) => {
return new Promise(async (resolve, reject) => { return new Promise(async (resolve, reject) => {
const dataUrl = "data:application/octet-binary;base64," + base64; const dataUrl = 'data:application/octet-binary;base64,' + base64
fetch(dataUrl) fetch(dataUrl)
.then(res => res.arrayBuffer()) .then((res) => res.arrayBuffer())
.then(buffer => { .then((buffer) => {
resolve(new Uint8Array(buffer)) resolve(new Uint8Array(buffer))
}).catch((err) => { })
.catch((err) => {
reject(err) reject(err)
}) })
}) })
} }
export const arrayBufferToBase64 = (arrayBuffer: any) => { // Blob + FileReader.readAsDataURL (a natural alternative here) is
return new Promise((resolve, reject) => { // unreliable in the Cypress runner's iframe - onload/onerror can simply
const blob = new Blob([arrayBuffer]) // never fire, leaving the promise permanently unsettled (a silent hang,
// surfacing only as Mocha's "done() was never invoked" 30s later with no
const reader = new FileReader(); // clue why). base64-arraybuffer's encode() is synchronous and
// dependency-free - no browser API involved, so this class of hang isn't
reader.onload = async function(event){ // possible - and it's the same library the app itself uses for this exact
if (event.target) { // conversion.
var base64: any = event.target.result export const arrayBufferToBase64 = (
base64 = base64.substring(37, base64.length) arrayBuffer: ArrayBuffer
): Promise<string> => {
resolve(base64) return Promise.resolve(base64Converter.encode(arrayBuffer))
} }
};
reader.readAsDataURL(blob);
})
}
+1772 -1431
View File
File diff suppressed because it is too large. Load diff
+5 -4
View File
@@ -54,9 +54,9 @@
"@clr/angular": "file:libraries/clr-angular-17.9.0.tgz", "@clr/angular": "file:libraries/clr-angular-17.9.0.tgz",
"@clr/icons": "^13.0.2", "@clr/icons": "^13.0.2",
"@clr/ui": "file:libraries/clr-ui-17.9.0.tgz", "@clr/ui": "file:libraries/clr-ui-17.9.0.tgz",
"@handsontable/angular-wrapper": "^18.0.0", "@handsontable/angular-wrapper": "18.0.0",
"@sasjs/adapter": "^4.17.3", "@sasjs/adapter": "^4.18.0",
"@sasjs/utils": "^3.5.9", "@sasjs/utils": "^3.6.0",
"@sheet/crypto": "file:libraries/sheet-crypto.tgz", "@sheet/crypto": "file:libraries/sheet-crypto.tgz",
"@types/d3-graphviz": "^2.6.7", "@types/d3-graphviz": "^2.6.7",
"@types/text-encoding": "0.0.35", "@types/text-encoding": "0.0.35",
@@ -69,7 +69,7 @@
"d3-graphviz": "^5.0.2", "d3-graphviz": "^5.0.2",
"exceljs": "^4.4.0", "exceljs": "^4.4.0",
"fs-extra": "^7.0.1", "fs-extra": "^7.0.1",
"handsontable": "^18.0.0", "handsontable": "18.0.0",
"https-browserify": "1.0.0", "https-browserify": "1.0.0",
"hyperformula": "^2.5.0", "hyperformula": "^2.5.0",
"iconv-lite": "^0.5.0", "iconv-lite": "^0.5.0",
@@ -148,6 +148,7 @@
"ajv": "8.18.0", "ajv": "8.18.0",
"uuid": "11.1.1", "uuid": "11.1.1",
"lighthouse": "13.4.0", "lighthouse": "13.4.0",
"fast-uri": "3.1.7",
"readdir-glob": { "readdir-glob": {
"brace-expansion": "^5.0.9" "brace-expansion": "^5.0.9"
}, },
+51 -19
View File
@@ -130,25 +130,18 @@
</div> </div>
} }
<div class="logo d-flex clr-align-items-center"> <div class="logo d-flex clr-align-items-center">
@if (!router.url.includes('deploy')) { <a href="#" [routerLink]="['/']" class="nav-link">
<a href="#" [routerLink]="['/']" class="nav-link"> <img
<img class="without-text d-block d-md-none"
class="without-text d-block d-md-none" src="images/dc-logo.svg"
src="images/dc-logo.svg" alt="datacontroller logo without text"
alt="datacontroller logo without text" />
/> <img
<img class="with-text d-none d-md-block"
class="with-text d-none d-md-block" src="images/datacontroller.svg"
src="images/datacontroller.svg" alt="datacontroller logo"
alt="datacontroller logo" />
/> </a>
</a>
}
@if (router.url.includes('deploy')) {
<a>
<span class="clr-icon header-logo ml-10"></span>
</a>
}
</div> </div>
@if ( @if (
!router.url.includes('deploy') && !router.url.includes('licensing') !router.url.includes('deploy') && !router.url.includes('licensing')
@@ -318,6 +311,45 @@
<div class="subline dec"></div> <div class="subline dec"></div>
</div> </div>
} }
@if (startupSteps.length > 0) {
<div class="startup-checks">
@for (step of startupSteps; track step.label) {
<div
class="startup-check"
[class.startup-check--error]="step.status === 'error'"
[class.startup-check--done]="step.status === 'done'"
>
@switch (step.status) {
@case ('pending') {
<clr-icon
shape="circle"
class="is-solid startup-check__icon--pending"
></clr-icon>
}
@case ('in_progress') {
<clr-spinner clrSmall></clr-spinner>
}
@case ('done') {
<clr-icon
shape="check-circle"
class="is-solid startup-check__icon--done"
></clr-icon>
}
@case ('error') {
<clr-icon
shape="exclamation-circle"
class="is-solid startup-check__icon--error"
></clr-icon>
}
}
<span class="startup-check__label">{{ step.label }}</span>
@if (step.detail) {
<span class="startup-check__detail">{{ step.detail }}</span>
}
</div>
}
</div>
}
</div> </div>
} }
<!-- /App Loading Page --> <!-- /App Loading Page -->
+10
View File
@@ -19,6 +19,10 @@ import { InfoModal } from './models/InfoModal'
import { DcAdapterSettings } from './models/DcAdapterSettings' import { DcAdapterSettings } from './models/DcAdapterSettings'
import { AppStoreService } from './services/app-store.service' import { AppStoreService } from './services/app-store.service'
import { LicenceService } from './services/licence.service' import { LicenceService } from './services/licence.service'
import {
StartupCheckService,
StartupStep
} from './services/startup-check.service'
import '@cds/core/icon/register.js' import '@cds/core/icon/register.js'
import { import {
ClarityIcons, ClarityIcons,
@@ -64,6 +68,7 @@ export class AppComponent {
public requestsModal: boolean = false public requestsModal: boolean = false
public showRegistration: boolean = true public showRegistration: boolean = true
public startupDataLoaded: boolean = false public startupDataLoaded: boolean = false
public startupSteps: StartupStep[] = []
public demoLimitNotice: { open: boolean; featureName: string } = { public demoLimitNotice: { open: boolean; featureName: string } = {
open: false, open: false,
featureName: '' featureName: ''
@@ -81,11 +86,16 @@ export class AppComponent {
private location: Location, private location: Location,
private eventService: EventService, private eventService: EventService,
private appStoreService: AppStoreService, private appStoreService: AppStoreService,
private startupCheckService: StartupCheckService,
private cdr: ChangeDetectorRef, private cdr: ChangeDetectorRef,
private elementRef: ElementRef private elementRef: ElementRef
) { ) {
this.parseDcAdapterSettings() this.parseDcAdapterSettings()
this.startupCheckService.steps$.subscribe((steps) => {
this.startupSteps = steps
})
/** /**
* Prints app info in the console such as: * Prints app info in the console such as:
* - Adapter versions * - Adapter versions
@@ -77,69 +77,173 @@
} }
<h4 class="text-center my-15">Viya Deploy</h4> <h4 class="text-center my-15">Viya Deploy</h4>
<p class="deploy-intro">
Configure and deploy Data Controller to your Viya environment. Deployment
creates the backend SAS services and the control library used by the
application.
</p>
<hr /> <hr />
<label for="dcloc" class="mt-20 clr-control-label">App Loc</label>
<div class="mb-10 clr-control-container"> <div class="deploy-field">
<div class="clr-input-wrapper"> <label class="clr-control-label">App Loc</label>
<p class="mt-0">{{ appLoc }}</p> <p class="deploy-field-description">
The SAS drive folder in which the Data Controller frontend and services are
deployed. Derived from your deployment configuration &mdash; it cannot be
changed here.
</p>
<div class="clr-control-container">
<div class="clr-input-wrapper">
<p class="m-0">{{ appLoc }}</p>
</div>
</div> </div>
</div> </div>
<label for="dcloc" class="mt-20 clr-control-label">DC Loc</label> <div class="deploy-field">
<div class="mb-10 clr-control-container dc-loc-input-wrapper"> <label for="dcloc" class="clr-control-label">DC Loc</label>
<div class="clr-input-wrapper small-mt"> <p class="deploy-field-description">
<input clrInput name="dcloc" [(ngModel)]="dcPath" /> A physical directory on the compute server to which the deployment user can
write. Data Controller stores its control tables, staging area and audit
history here.
</p>
<div class="clr-control-container dc-loc-input-wrapper">
<div class="clr-input-wrapper small-mt">
<input clrInput name="dcloc" [(ngModel)]="dcPath" />
</div>
</div> </div>
</div> </div>
<label for="dcloc" class="mt-20 clr-control-label">SAS Admin group</label> <div class="deploy-field">
<div class="mb-10 clr-control-container"> <label for="adminGroup" class="clr-control-label">SAS Admin group</label>
<div class="clr-input-wrapper small-mt"> <p class="deploy-field-description">
@if (!adminGroupsLoading) { The group you select becomes the Data Controller Admin Group &mdash;
<select clrSelect name="options" [(ngModel)]="selectedAdminGroup"> everyone in it will have unrestricted access to Data Controller. By default
@for (adminGroup of adminGroups; track adminGroup) { the list is filtered to the groups your identity
<option [value]="adminGroup.id"> @if (currentUserInfo?.id) {
{{ adminGroup.name }} (<strong>{{ currentUserInfo?.id }}</strong
</option> >)
}
is a member of. Toggle below to list every group on the Viya server.
</p>
<clr-toggle-container class="mt-0">
<clr-toggle-wrapper>
<input
id="show-all-groups-toggle"
type="checkbox"
[(ngModel)]="showAllGroups"
(ngModelChange)="onShowAllGroupsChange()"
clrToggle
/>
<label for="show-all-groups-toggle">Show all groups</label>
</clr-toggle-wrapper>
</clr-toggle-container>
<div class="clr-control-container">
<div class="clr-input-wrapper small-mt">
@if (!adminGroupsLoading) {
<select clrSelect name="adminGroup" [(ngModel)]="selectedAdminGroup">
@for (adminGroup of adminGroups; track adminGroup) {
<option [value]="adminGroup.id">
{{ adminGroup.name }}
</option>
}
</select>
}
@if (adminGroupsLoading) {
<clr-spinner clrInline class="spinner-sm"></clr-spinner>
}
</div>
</div>
</div>
@if (!showAllContexts) {
<div class="deploy-field">
<label for="batchId" class="clr-control-label">Batch ID</label>
<p class="deploy-field-description">
The batch identity (<code>runServerAs</code>) under which Data Controller
jobs will execute. It is used to filter the Compute Context dropdown below
to only the contexts running as this identity.
</p>
<div class="clr-control-container">
<div class="clr-input-wrapper small-mt">
@if (!computeContextsLoading) {
<select
clrSelect
name="batchId"
[(ngModel)]="selectedBatchId"
(ngModelChange)="onBatchIdChange()"
>
@for (batchId of batchIds; track batchId) {
<option [value]="batchId">
{{ batchId }}
</option>
}
</select>
} }
</select> @if (computeContextsLoading) {
} <clr-spinner clrInline class="spinner-sm"></clr-spinner>
@if (adminGroupsLoading) {
<clr-spinner clrInline class="spinner-sm"></clr-spinner>
}
</div>
</div>
<label for="computeContext" class="mt-20 clr-control-label"
>Compute Context</label
>
<div class="mb-10 clr-control-container">
<div class="clr-input-wrapper small-mt">
@if (!computeContextsLoading) {
<select
clrSelect
name="options"
(ngModelChange)="onComputeContextChange($event)"
[(ngModel)]="selectedComputeContext"
>
@for (computeContext of computeContexts; track computeContext) {
<option [value]="computeContext.id">
{{ computeContext.name }}
</option>
} }
</select> </div>
} </div>
@if (computeContextsLoading) { </div>
<clr-spinner clrInline class="spinner-sm"></clr-spinner> }
}
<div class="deploy-field">
<label for="computeContext" class="clr-control-label">Compute Context</label>
<p class="deploy-field-description">
The compute context used to run the Data Controller services (including the
<code>makedata</code> deployment job). Only reusable contexts matching the
selected Batch ID are shown, unless the toggle below is enabled.
</p>
<clr-toggle-container class="mt-0">
<clr-toggle-wrapper>
<input
id="show-all-contexts-toggle"
type="checkbox"
[(ngModel)]="showAllContexts"
(ngModelChange)="onShowAllContextsChange()"
clrToggle
/>
<label for="show-all-contexts-toggle">Show all compute contexts</label>
</clr-toggle-wrapper>
</clr-toggle-container>
<div class="clr-control-container">
<div class="clr-input-wrapper small-mt">
@if (!computeContextsLoading) {
<select
clrSelect
name="computeContext"
(ngModelChange)="onComputeContextChange($event)"
[(ngModel)]="selectedComputeContext"
>
@for (
computeContext of getFilteredComputeContexts();
track computeContext
) {
<option [value]="computeContext.id">
{{ computeContext.name }}
</option>
}
</select>
}
@if (computeContextsLoading) {
<clr-spinner clrInline class="spinner-sm"></clr-spinner>
}
</div>
</div> </div>
</div> </div>
@if (runningAsUser) { @if (runningAsUser) {
<label for="dcloc" class="mt-20 clr-control-label">Running as user:</label> <div class="deploy-field">
<div class="mb-10 clr-control-container"> <label class="clr-control-label">Running as user</label>
<div class="clr-input-wrapper"> <p class="deploy-field-description">
<p class="mt-0">{{ runningAsUser }}</p> The identity under which Data Controller jobs will run with the selected
compute context. This user must be able to write to the DC Loc above.
</p>
<div class="clr-control-container">
<div class="clr-input-wrapper">
<p class="m-0">
<strong>{{ runningAsUser }}</strong>
</p>
</div>
</div> </div>
</div> </div>
} }
@@ -25,6 +25,13 @@ import {
Item as ComputeContextItem Item as ComputeContextItem
} from 'src/app/viya-api-explorer/models/viya-compute-contexts.model' } from 'src/app/viya-api-explorer/models/viya-compute-contexts.model'
export interface ComputeContextInfo {
id: string
name: string
runAs: string | null
reusable: boolean
}
@Component({ @Component({
selector: 'app-automatic-deploy', selector: 'app-automatic-deploy',
templateUrl: './automatic.component.html', templateUrl: './automatic.component.html',
@@ -60,6 +67,21 @@ export class AutomaticComponent implements OnInit {
public currentUserInfoLoading: boolean = false public currentUserInfoLoading: boolean = false
public computeContextsLoading: boolean = false public computeContextsLoading: boolean = false
public adminGroups: { id: string; name: string }[] = [] public adminGroups: { id: string; name: string }[] = []
/** Compute contexts enriched with their batch identity and reusability */
public computeContextInfos: ComputeContextInfo[] = []
/** Distinct batch identities (runServerAs) across reusable contexts */
public batchIds: string[] = []
public selectedBatchId: string = ''
/**
* When enabled, any compute context can be chosen (the batch id dropdown
* is hidden and no reusability / batch id filtering is applied)
*/
public showAllContexts: boolean = false
/** All groups on the Viya server */
public allAdminGroups: { id: string; name: string }[] = []
/** Groups the current user is a member of */
public memberAdminGroups: { id: string; name: string }[] = []
public showAllGroups: boolean = false
public runningAsUser: string | undefined public runningAsUser: string | undefined
public currentUserInfo: ViyaApiCurrentUser | null = null public currentUserInfo: ViyaApiCurrentUser | null = null
public computeContexts: ComputeContextItem[] = [] public computeContexts: ComputeContextItem[] = []
@@ -104,9 +126,9 @@ export class AutomaticComponent implements OnInit {
} }
public async loadData() { public async loadData() {
await this.getCurrentUser()
await this.getAdminGroups() await this.getAdminGroups()
await this.getComputeContexts() await this.getComputeContexts()
await this.getCurrentUser()
setTimeout(() => { setTimeout(() => {
if (this.selectedComputeContext) { if (this.selectedComputeContext) {
@@ -120,20 +142,13 @@ export class AutomaticComponent implements OnInit {
this.computeContextsLoading = true this.computeContextsLoading = true
this.sasViyaService.getComputeContexts().subscribe( this.sasViyaService.getComputeContexts().subscribe(
(res: ViyaComputeContexts) => { async (res: ViyaComputeContexts) => {
this.computeContextsLoading = false
const defaultContext = res.items.find(
(item: ComputeContextItem) =>
item.name === 'SAS Job Execution compute context'
)
if (defaultContext) {
this.selectedComputeContext = defaultContext.id
}
this.computeContexts = res.items this.computeContexts = res.items
await this.getComputeContextDetails()
this.computeContextsLoading = false
resolve() resolve()
}, },
(err) => { (err) => {
@@ -143,6 +158,137 @@ export class AutomaticComponent implements OnInit {
}) })
} }
/**
* The `/compute/contexts` list view is minimal, so each context is fetched
* in full (in parallel) to pick up its batch identity (runServerAs) and
* whether it reuses server processes. Only reusable contexts with a batch
* identity feed the batch id dropdown.
*/
public async getComputeContextDetails() {
const infos = await Promise.all(
this.computeContexts.map(
(context: ComputeContextItem) =>
new Promise<ComputeContextInfo>((resolveInfo) => {
this.sasViyaService.getComputeContextById(context.id).subscribe(
(details: ComputeContextDetails) => {
resolveInfo({
id: context.id,
name: context.name,
runAs: this.extractRunAs(details),
reusable: details.attributes?.reuseServerProcesses === 'true'
})
},
(err: any) => {
this.loggerService.error(
`Error while getting compute context ${context.name}`,
err
)
resolveInfo({
id: context.id,
name: context.name,
runAs: null,
reusable: false
})
}
)
})
)
)
this.computeContextInfos = infos
this.batchIds = [
...new Set(
infos
.filter((info) => info.reusable && info.runAs)
.map((info) => info.runAs as string)
)
]
if (this.batchIds.length) {
this.selectedBatchId = this.batchIds[0]
}
const filteredContexts = this.getFilteredComputeContexts()
const defaultContext =
filteredContexts.find(
(info: ComputeContextInfo) =>
info.name === 'SAS Job Execution compute context'
) || filteredContexts[0]
if (defaultContext) {
this.selectedComputeContext = defaultContext.id
}
}
/**
* Pulls the runAs (batch) identity out of a compute context. The batch user
* is exposed as `attributes.runServerAs` in the Viya compute context API
* response. Not all contexts expose one.
*/
public extractRunAs(details: ComputeContextDetails): string | null {
return details.attributes?.runServerAs || null
}
/**
* The contexts offered in the dropdown. By default only reusable contexts
* (`reuseServerProcesses`) matching the selected batch id are shown. When
* the `showAllContexts` toggle is on, all contexts are shown.
*/
public getFilteredComputeContexts(): ComputeContextInfo[] {
if (this.showAllContexts) {
return this.computeContextInfos
}
return this.computeContextInfos.filter(
(info: ComputeContextInfo) =>
info.reusable && info.runAs === this.selectedBatchId
)
}
/**
* Changing the batch id re-filters the compute context dropdown and makes
* sure the currently selected context exists in the displayed list.
*/
public onBatchIdChange() {
this.ensureSelectedComputeContext()
}
/**
* Toggles the compute context dropdown between contexts matching the
* selected batch id and all contexts on the Viya server.
*/
public onShowAllContextsChange() {
this.ensureSelectedComputeContext()
}
private ensureSelectedComputeContext() {
const filteredContexts = this.getFilteredComputeContexts()
const selectedContextExists = filteredContexts.some(
(info: ComputeContextInfo) => info.id === this.selectedComputeContext
)
if (!selectedContextExists) {
this.selectedComputeContext = filteredContexts.length
? filteredContexts[0].id
: ''
}
this.updateRunningAsUser()
}
private updateRunningAsUser() {
const selectedContext = this.computeContextInfos.find(
(info: ComputeContextInfo) => info.id === this.selectedComputeContext
)
this.runningAsUser =
selectedContext?.runAs || this.currentUserInfo?.id || 'unknown'
}
public async getCurrentUser() { public async getCurrentUser() {
return new Promise<void>((resolve, reject) => { return new Promise<void>((resolve, reject) => {
this.currentUserInfoLoading = true this.currentUserInfoLoading = true
@@ -170,16 +316,21 @@ export class AutomaticComponent implements OnInit {
this.adminGroupsLoading = true this.adminGroupsLoading = true
;(this.sasViyaService ;(this.sasViyaService
.getAdminGroups() .getAdminGroups()
.subscribe((res: ViyaApiIdentities) => { .subscribe(async (res: ViyaApiIdentities) => {
this.adminGroupsLoading = false
// Map admin groups with only needed fields // Map admin groups with only needed fields
this.adminGroups = res.items.map((item: Item) => { this.allAdminGroups = res.items.map((item: Item) => {
return { return {
id: item.id, id: item.id,
name: item.name name: item.name
} }
}) })
await this.getMemberAdminGroups()
this.applyAdminGroupFilter()
this.adminGroupsLoading = false
resolve() resolve()
}), }),
(err: any) => { (err: any) => {
@@ -192,16 +343,72 @@ export class AutomaticComponent implements OnInit {
}) })
} }
public async onComputeContextChange(computeContextId: string) { /**
this.sasViyaService * Fetches the groups the current user is a member of, from the Viya
.getComputeContextById(computeContextId) * identities API. If the memberships cannot be fetched, the member list
.subscribe((res: ComputeContextDetails) => { * falls back to all groups.
if (res.attributes && res.attributes.runServerAs) { */
this.runningAsUser = res.attributes.runServerAs public async getMemberAdminGroups() {
} else { return new Promise<void>((resolve) => {
this.runningAsUser = this.currentUserInfo?.id || 'unknown' this.sasViyaService.getCurrentUserGroupMemberships().subscribe(
(res: ViyaApiIdentities) => {
const memberIds = res.items.map((item: Item) => item.id)
this.memberAdminGroups = this.allAdminGroups.filter(
(group: { id: string; name: string }) =>
memberIds.includes(group.id)
)
resolve()
},
(err: any) => {
this.loggerService.error(
'Error while getting user group memberships',
err
)
this.memberAdminGroups = this.allAdminGroups
resolve()
} }
}) )
})
}
/**
* Toggles the SAS Admin group dropdown between the groups the current user
* is a member of and all groups on the Viya server.
*/
public onShowAllGroupsChange() {
this.applyAdminGroupFilter()
}
/**
* Applies the member/all groups filter to the dropdown and makes sure the
* currently selected group exists in the displayed list.
*/
private applyAdminGroupFilter() {
this.adminGroups =
this.showAllGroups || !this.memberAdminGroups.length
? this.allAdminGroups
: this.memberAdminGroups
const selectedGroupExists = this.adminGroups.some(
(group: { id: string; name: string }) =>
group.id === this.selectedAdminGroup
)
if (!selectedGroupExists && this.adminGroups.length) {
this.selectedAdminGroup = this.adminGroups[0].id
}
}
public async onComputeContextChange(computeContextId: string) {
// The explicit (ngModelChange) handler runs before the [(ngModel)]
// assignment updates the field, so synchronise the selected context id
// here before deriving the running user. Otherwise the displayed user
// lags behind the dropdown by one change.
this.selectedComputeContext = computeContextId
this.updateRunningAsUser()
} }
public getComputeContextName(id: string): string | undefined { public getComputeContextName(id: string): string | undefined {
@@ -341,7 +548,8 @@ export class AutomaticComponent implements OnInit {
this.eventService.showAbortModal('makedata', abortMsg, { this.eventService.showAbortModal('makedata', abortMsg, {
SYSWARNINGTEXT: abortRes.SYSWARNINGTEXT, SYSWARNINGTEXT: abortRes.SYSWARNINGTEXT,
SYSERRORTEXT: abortRes.SYSERRORTEXT, SYSERRORTEXT: abortRes.SYSERRORTEXT,
MAC: macMsg MAC: macMsg,
_PROGRAM: abortRes._PROGRAM
}) })
} }
@@ -373,7 +581,9 @@ export class AutomaticComponent implements OnInit {
let contextname = `&_contextname=${params.contextName}` let contextname = `&_contextname=${params.contextName}`
let admin = `&admin=${params.admin}` let admin = `&admin=${params.admin}`
let dcPath = `&dcpath=${params.dcPath}` let dcPath = `&dcpath=${params.dcPath}`
let debug = this.sasService.getDebugUrlParam() // Debug is ALWAYS enabled for makedata — it runs only once during
// deployment and the full log is needed to diagnose any issues.
let debug = '&_debug=131'
let programUrl = let programUrl =
serverUrl + serverUrl +
@@ -387,6 +597,53 @@ export class AutomaticComponent implements OnInit {
debug debug
window.open(programUrl) window.open(programUrl)
// Poll for makedata completion. The makedata service self-deletes
// when it finishes successfully, so we check if it's still present
// in the admin folder. When it's gone, reload the app fresh.
this.pollMakedataCompletion()
}
private makedataPollInterval: any = null
private pollMakedataCompletion() {
if (this.makedataPollInterval) {
clearInterval(this.makedataPollInterval)
}
let attempts = 0
const maxAttempts = 120 // 10 minutes at 5s intervals
this.makedataPollInterval = setInterval(async () => {
attempts++
console.log(
`pollMakedataCompletion: checking if makedata is gone (attempt ${attempts}/${maxAttempts})`
)
try {
const makedataGone = await this.sasService.viyaMakedataSuccessfull()
if (makedataGone) {
console.log(
'pollMakedataCompletion: makedata job is gone, reloading app'
)
clearInterval(this.makedataPollInterval)
this.makedataPollInterval = null
// Reload the app fresh from the SASJobExecution URL
window.location.href = window.location.href.split('#')[0]
}
} catch (err) {
console.error('pollMakedataCompletion: error checking', err)
}
if (attempts >= maxAttempts) {
console.warn(
'pollMakedataCompletion: timed out after 10 minutes, stopping poll'
)
clearInterval(this.makedataPollInterval)
this.makedataPollInterval = null
}
}, 5000)
} }
/** /**
@@ -428,9 +685,12 @@ export class AutomaticComponent implements OnInit {
return return
} }
/* Use a function replacement so $ in computeContextName is treated as a
literal character. In a string replacement, $ has special meaning
($&, $1, $` etc.); a function return value is used verbatim. */
const updatedContent = indexHtmlContent.replace( const updatedContent = indexHtmlContent.replace(
/contextname="[^"]*"/g, /contextname="[^"]*"/g,
`contextname="${computeContextName}"` () => `contextname="${computeContextName}"`
) )
await this.sasService await this.sasService
@@ -242,6 +242,9 @@ export class ManualComponent implements OnInit {
*/ */
public createDatabase(newTab: boolean = true) { public createDatabase(newTab: boolean = true) {
if (newTab) { if (newTab) {
// Debug is ALWAYS enabled for makedata — it runs only once during
// deployment and the full log is needed to diagnose any issues.
const _debug = '&_debug=131'
let url = let url =
this.sasService.getSasjsConfig().serverUrl + this.sasService.getSasjsConfig().serverUrl +
'/SASJobExecution/?_program=' + '/SASJobExecution/?_program=' +
@@ -252,7 +255,7 @@ export class ManualComponent implements OnInit {
this.selectedAdminGroup + this.selectedAdminGroup +
'&DCPATH=' + '&DCPATH=' +
this.dcPath + this.dcPath +
this.sasService.getDebugUrlParam() _debug
window.open(url, '_blank') window.open(url, '_blank')
@@ -120,8 +120,10 @@ export class SasjsConfiguratorComponent implements OnInit {
* Creating database * Creating database
*/ */
makeData() { makeData() {
// const _debug = "&_debug=131"; //debug on // Debug is ALWAYS enabled for this service. The makedata service runs only once
const _debug = ' ' //debug off // during deployment configuration, so full debug output (131) is always wanted
// to help diagnose any issues. This is NOT temporary — do not remove or gate it.
const _debug = '&_debug=131'
let executor = this.sasService.getExecutionPath() let executor = this.sasService.getExecutionPath()
const root = this.sasJsConfig.appLoc const root = this.sasJsConfig.appLoc
+570 -53
View File
@@ -46,9 +46,11 @@ import { preventMenuItemAutoClose } from './utils/preventMenuItemAutoClose'
import { findOverwrittenCells } from '../shared/dc-validator/utils/findOverwrittenCells' import { findOverwrittenCells } from '../shared/dc-validator/utils/findOverwrittenCells'
import { getFormulaCellsToPreserveOnCancel } from '../shared/dc-validator/utils/getFormulaCellsToPreserveOnCancel' import { getFormulaCellsToPreserveOnCancel } from '../shared/dc-validator/utils/getFormulaCellsToPreserveOnCancel'
import { getRevertableCols } from '../shared/dc-validator/utils/getRevertableCols' import { getRevertableCols } from '../shared/dc-validator/utils/getRevertableCols'
import { resolveRevertedCellValue } from '../shared/dc-validator/utils/resolveRevertedCellValue'
import { getStableFormulaBaseCols } from '../shared/dc-validator/utils/getStableFormulaBaseCols' import { getStableFormulaBaseCols } from '../shared/dc-validator/utils/getStableFormulaBaseCols'
import { syncOverwrittenCellComment } from '../shared/dc-validator/utils/syncOverwrittenCellComment' import { syncOverwrittenCellComment } from '../shared/dc-validator/utils/syncOverwrittenCellComment'
import { parseFormulaRule } from '../shared/dc-validator/utils/parseFormulaRule' import { parseFormulaRule } from '../shared/dc-validator/utils/parseFormulaRule'
import { substituteColumnReferences } from '../shared/dc-validator/utils/substituteColumnReferences'
import { DcValidator } from '../shared/dc-validator/dc-validator' import { DcValidator } from '../shared/dc-validator/dc-validator'
import { Col } from '../shared/dc-validator/models/col.model' import { Col } from '../shared/dc-validator/models/col.model'
import { DcValidation } from '../shared/dc-validator/models/dc-validation.model' import { DcValidation } from '../shared/dc-validator/models/dc-validation.model'
@@ -57,6 +59,17 @@ import { getHotDataSchema } from '../shared/dc-validator/utils/getHotDataSchema'
import { excelRound } from '../shared/dc-validator/utils/excelRound' import { excelRound } from '../shared/dc-validator/utils/excelRound'
import { isEmpty } from '../shared/dc-validator/utils/isEmpty' import { isEmpty } from '../shared/dc-validator/utils/isEmpty'
import { hasFormulaRules } from '../shared/dc-validator/utils/hasFormulaRules' import { hasFormulaRules } from '../shared/dc-validator/utils/hasFormulaRules'
import { getFormulaColumnNames } from '../shared/dc-validator/utils/getFormulaColumnNames'
import { isCharacterColumn } from '../shared/dc-validator/utils/isCharacterColumn'
import { escapeCharacterColumnValue } from '../shared/dc-validator/utils/escapeCharacterColumnValue'
import { unescapeFormula } from '../shared/dc-validator/utils/unescapeFormula'
import {
AutoEscapedCellMap,
getRowKey,
markAutoEscaped,
isAutoEscaped,
clearAutoEscaped
} from '../shared/dc-validator/utils/autoEscapedCellTracker'
import { HyperFormula } from 'hyperformula' import { HyperFormula } from 'hyperformula'
import { parseLabelsParam } from '../shared/utils/parse-labels-param' import { parseLabelsParam } from '../shared/utils/parse-labels-param'
import { getDisplayColHeaders } from '../shared/utils/display-col-headers' import { getDisplayColHeaders } from '../shared/utils/display-col-headers'
@@ -73,6 +86,7 @@ import { parseTableColumns } from './utils/grid.utils'
import { classifyRow } from './utils/classifyRow' import { classifyRow } from './utils/classifyRow'
import { withoutEditStatus } from './utils/withoutEditStatus' import { withoutEditStatus } from './utils/withoutEditStatus'
import { getEditStatusSymbol } from './utils/getEditStatusSymbol' import { getEditStatusSymbol } from './utils/getEditStatusSymbol'
import { normalizeSortConfig } from './utils/normalizeSortConfig'
import { EDIT_STATUS_COLUMN_NAME } from '../shared/dc-validator/utils/editStatusColumnRule' import { EDIT_STATUS_COLUMN_NAME } from '../shared/dc-validator/utils/editStatusColumnRule'
import { import {
errorRenderer, errorRenderer,
@@ -156,6 +170,12 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
licenseKey: this.hotTable.licenseKey, licenseKey: this.hotTable.licenseKey,
readOnly: this.hotTable.readOnly, readOnly: this.hotTable.readOnly,
copyPaste: this.hotTable.copyPaste, copyPaste: this.hotTable.copyPaste,
// Must carry the current formulas config through - this rebuilds
// hotTableSettings (and re-applies it via the [settings] binding)
// whenever hot_license_key emits, which can happen after a table has
// already loaded and turned formulas on; omitting the key here would
// let that rebuild silently drop it again.
formulas: this.hotTable.formulas,
contextMenu: true, contextMenu: true,
className: 'htDark', className: 'htDark',
theme: 'ht-theme-classic' theme: 'ht-theme-classic'
@@ -170,6 +190,11 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
height: 'calc(100vh - 160px)', height: 'calc(100vh - 160px)',
licenseKey: undefined, licenseKey: undefined,
readOnly: true, readOnly: true,
// Every table gets the formulas engine, regardless of whether it
// declares any HARDFORMULA/SOFTFORMULA rules - set here (not only
// inside initSetup) so it's already present in hotTableSettings for
// the very first [settings] binding, before any table has loaded.
formulas: { engine: HyperFormula, licenseKey: 'gpl-v3' },
copyPaste: { copyPaste: {
copyColumnHeaders: true, copyColumnHeaders: true,
copyColumnHeadersOnly: true copyColumnHeadersOnly: true
@@ -262,12 +287,71 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
hot.setDataAtRowProp( hot.setDataAtRowProp(
row, row,
prop, prop,
isNumericCol ? Number(rawValueText) : rawValueText resolveRevertedCellValue(rawValueText, isNumericCol),
'revert'
) )
commentsPlugin.removeCommentAtCell(row, col) commentsPlugin.removeCommentAtCell(row, col)
} }
} }
}, },
// Only ever shown when the selection contains at least one cell
// this app itself auto-escaped (see character-column-formula-
// plan.md) - a genuinely literal leading `'` the backend sent, or
// one the user typed themselves, is never in autoEscapedCells and
// so never makes this item appear or gets touched by it.
apply_as_formula: {
name: 'Apply as formula',
hidden: (): boolean => {
const hot = this.hotInstance
if (hot.getSettings().readOnly) return true
const ranges: CellRange[] | undefined = hot.getSelectedRange()
if (!ranges || ranges.length === 0) return true
const cells = expandCellRanges(
ranges,
hot.countRows(),
hot.countCols()
)
return !cells.some(({ row, col }) => {
const dataRow = this.dataSource[hot.toPhysicalRow(row)]
if (!dataRow) return false
const colName = hot.colToProp(col) as string
return isAutoEscaped(
this.autoEscapedCells,
getRowKey(dataRow, this.headerPks),
colName
)
})
},
callback: (key: string, selection: any[]) => {
const hot = this.hotInstance
const cells = expandCellRanges(
selection.map((sel) => ({ from: sel.start, to: sel.end })),
hot.countRows(),
hot.countCols()
)
for (const { row, col } of cells) {
const dataRow = this.dataSource[hot.toPhysicalRow(row)]
if (!dataRow) continue
const colName = hot.colToProp(col) as string
const rowKey = getRowKey(dataRow, this.headerPks)
if (!isAutoEscaped(this.autoEscapedCells, rowKey, colName))
continue
hot.setDataAtRowProp(
row,
colName,
unescapeFormula(hot.getDataAtRowProp(row, colName))
)
clearAutoEscaped(this.autoEscapedCells, rowKey, colName)
}
}
},
row_above: { row_above: {
name: 'Insert Row above', name: 'Insert Row above',
hidden: () => this.hotTable.readOnly === true, hidden: () => this.hotTable.readOnly === true,
@@ -492,6 +576,12 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
dataSourceRaw!: any[] dataSourceRaw!: any[]
dataSourceBeforeSubmit!: any[] dataSourceBeforeSubmit!: any[]
dataModified!: any[] dataModified!: any[]
// Cells the app itself auto-escaped (see escapeCharacterColumnValue) -
// PK-keyed, not a property on the row objects, so it can never leak into
// the submit payload and survives insert/delete/sort. Reset on every
// fresh load, same lifecycle as dataSourceRaw/dataSourceUnchanged. See
// character-column-formula-plan.md.
private autoEscapedCells: AutoEscapedCellMap = new Map()
public filePasswordSubject: Subject<string | undefined> = new Subject() public filePasswordSubject: Subject<string | undefined> = new Subject()
public fileUnlockError = false public fileUnlockError = false
@@ -560,6 +650,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
private ariaObserver: MutationObserver | undefined private ariaObserver: MutationObserver | undefined
private ariaCheckInterval: any | undefined private ariaCheckInterval: any | undefined
private gridResizeObserver: ResizeObserver | undefined private gridResizeObserver: ResizeObserver | undefined
private pasteListener: ((event: ClipboardEvent) => void) | undefined
constructor( constructor(
private licenceService: LicenceService, private licenceService: LicenceService,
@@ -805,7 +896,8 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.eventService.showAbortModal('', abortMsg, { this.eventService.showAbortModal('', abortMsg, {
SYSWARNINGTEXT: abortRes.SYSWARNINGTEXT, SYSWARNINGTEXT: abortRes.SYSWARNINGTEXT,
SYSERRORTEXT: abortRes.SYSERRORTEXT, SYSERRORTEXT: abortRes.SYSERRORTEXT,
MAC: macMsg MAC: macMsg,
_PROGRAM: abortRes._PROGRAM
}) })
} }
}, },
@@ -855,6 +947,36 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
previewDatasource.push(itemObject) previewDatasource.push(itemObject)
}) })
// An uploaded file is bulk, external data - not something the user
// typed/pasted cell-by-cell - so a `=`-led value in a character column
// must be escaped to inert text, the same way a fresh backend load is
// (see initSetup's own escape loop). Formulas are enabled for every
// table, so without this a spreadsheet cell that merely looks like a
// formula (an inventory code, a serial number) would silently start
// evaluating as a live one.
const formulaBaseCols = getFormulaColumnNames(
this.dcValidator?.getDqDetails() ?? []
)
this.autoEscapedCells = new Map()
for (const row of previewDatasource) {
const rowKey = getRowKey(row, this.headerPks)
for (const colName of this.headerColumns) {
if (formulaBaseCols.includes(colName)) continue
if (!isCharacterColumn(this.cols, colName)) continue
const { value, wasEscaped } = escapeCharacterColumnValue(row[colName])
// A row whose backend source never had this column at all (a
// sparse row) must stay that way - writing back unconditionally
// would materialize a new own property set to undefined, which
// the SASjs adapter rejects at submit time even though nothing
// about this cell ever changed.
if (!wasEscaped) continue
row[colName] = value
markAutoEscaped(this.autoEscapedCells, rowKey, colName)
}
}
this.dataSourceUnchanged = this.helperService.deepClone(this.dataSource) this.dataSourceUnchanged = this.helperService.deepClone(this.dataSource)
this.dataSource = previewDatasource this.dataSource = previewDatasource
@@ -864,7 +986,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.excelUploadState = 'Validating-HOT' this.excelUploadState = 'Validating-HOT'
hot.updateSettings( this.updateSettingsSortSafe(
{ {
data: this.dataSource, data: this.dataSource,
maxRows: Infinity maxRows: Infinity
@@ -889,7 +1011,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
* @param discardData wheter to discard data parsed from the file or to keep it in the table after dropping a attached excel file * @param discardData wheter to discard data parsed from the file or to keep it in the table after dropping a attached excel file
*/ */
public discardPendingExcel(discardData?: boolean) { public discardPendingExcel(discardData?: boolean) {
this.hotInstance.updateSettings({ this.updateSettingsSortSafe({
maxRows: this.licenceState.value.editor_rows_allowed maxRows: this.licenceState.value.editor_rows_allowed
}) })
@@ -1083,13 +1205,49 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
if (!hot) return [] if (!hot) return []
try { try {
const plugin = hot.getPlugin('multiColumnSorting') const plugin = hot.getPlugin('multiColumnSorting')
const cfg = plugin?.getSortConfig() return normalizeSortConfig(plugin?.getSortConfig())
return Array.isArray(cfg) ? cfg : cfg ? [cfg] : []
} catch { } catch {
return [] return []
} }
} }
/**
* Wraps hot.updateSettings() to work around a genuine Handsontable
* multiColumnSorting + formulas plugin bug: calling updateSettings() -
* with ANY settings, even a bare {} - while a sort is active corrupts
* formula cell references, rendering '#REF!' instead of their computed
* value (reproduced directly: a bare {} settings object alone is enough
* to trigger it, independent of what it actually changes). Clearing the
* sort first and restoring it immediately afterward avoids the
* corruption entirely. Not needed for the very first updateSettings()
* call at initial table load, since nothing can be sorted yet then.
*
* editTable()/cancelEdit() deliberately do NOT call this wrapper - they
* manage their own clear/restore inline, because their restore point is
* later in the method (after other logic like syncOverwrittenComments()),
* not immediately after their own updateSettings() call the way this
* wrapper restores it. Don't "simplify" those two to use this instead
* without preserving that later restore point.
*/
private updateSettingsSortSafe(
settings: Handsontable.GridSettings,
render?: boolean
): void {
const hot = this.hotInstance
const columnSorting = hot.getPlugin('multiColumnSorting')
const sortConfigs = this.getCurrentSortConfigs()
if (sortConfigs.length > 0) columnSorting.clearSort()
hot.updateSettings(settings, render)
// sort() replaces the entire sort state on every call rather than
// accumulating (see its own JSDoc) - restoring a multi-column sort
// needs one call with the whole array, not a loop of single-column
// calls, or every column but the last silently loses its sort.
if (sortConfigs.length > 0) columnSorting.sort(sortConfigs)
}
editTable(previewEdit?: boolean, newRow?: boolean) { editTable(previewEdit?: boolean, newRow?: boolean) {
this.toggleHotPlugin('contextMenu', true) this.toggleHotPlugin('contextMenu', true)
@@ -1119,6 +1277,13 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.hotTable.readOnly = false this.hotTable.readOnly = false
this.hotTable.data = this.dataSource this.hotTable.data = this.dataSource
// Handsontable's multiColumnSorting + formulas integration corrupts
// formula cell references (renders '#REF!') if updateSettings() runs
// while a sort is still active, even for an unrelated setting -
// clear it first and restore the captured sortConfigs afterward
// (below), rather than leaving the sort applied across the call.
if (sortConfigs.length > 0) columnSorting.clearSort()
hot.updateSettings( hot.updateSettings(
{ {
readOnly: this.hotTable.readOnly readOnly: this.hotTable.readOnly
@@ -1139,9 +1304,11 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
// same as cancelEdit() does for the read-only return path. // same as cancelEdit() does for the read-only return path.
this.syncOverwrittenComments() this.syncOverwrittenComments()
for (const sortConfig of sortConfigs) { // sort() replaces the entire sort state on every call rather than
columnSorting.sort(sortConfig) // accumulating (see its own JSDoc) - a multi-column sort needs one
} // call with the whole array, not a loop of single-column calls, or
// every column but the last silently loses its sort.
if (sortConfigs.length > 0) columnSorting.sort(sortConfigs)
this.reSetCellValidationValues() this.reSetCellValidationValues()
@@ -1184,10 +1351,16 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
const hot = this.hotInstance const hot = this.hotInstance
const columnSorting = hot.getPlugin('multiColumnSorting') const columnSorting = hot.getPlugin('multiColumnSorting')
const columnSortConfig = columnSorting.getSortConfig() const sortConfigs = this.getCurrentSortConfigs()
const sortConfigs = Array.isArray(columnSortConfig)
? columnSortConfig // Cleared here, before anything below reads a row by index - both the
: [columnSortConfig] // getFormulaCellsToPreserveOnCancel callbacks just below (physical
// rowIndex passed straight to visual-row-expecting Handsontable APIs)
// and the later updateSettings() call (see editTable()'s own comment -
// corrupts formula cell references while a sort is active) need the
// grid unsorted. Restored below, after the re-render, from the
// sortConfigs captured here.
if (sortConfigs.length > 0) columnSorting.clearSort()
if (this.dataSourceUnchanged) { if (this.dataSourceUnchanged) {
// dataSourceUnchanged deliberately holds the RAW pre-formula value for // dataSourceUnchanged deliberately holds the RAW pre-formula value for
@@ -1223,6 +1396,10 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.hotTable.data = this.dataSource this.hotTable.data = this.dataSource
this.hotTable.readOnly = true this.hotTable.readOnly = true
// Sort was already cleared above (before the getFormulaCellsToPreserveOnCancel
// callbacks); still cleared here going into updateSettings() - see
// editTable()'s own comment: it corrupts formula cell references
// ('#REF!') while a sort is active. Restored below via sortConfigs.
hot.updateSettings( hot.updateSettings(
{ {
readOnly: this.hotTable.readOnly, readOnly: this.hotTable.readOnly,
@@ -1242,9 +1419,11 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.modifedRowsIndexes = [] this.modifedRowsIndexes = []
hot.validateCells() hot.validateCells()
// this.editRecordListeners(); // this.editRecordListeners();
for (const sortConfig of sortConfigs) { // sort() replaces the entire sort state on every call rather than
columnSorting.sort(sortConfig) // accumulating (see its own JSDoc) - a multi-column sort needs one
} // call with the whole array, not a loop of single-column calls, or
// every column but the last silently loses its sort.
if (sortConfigs.length > 0) columnSorting.sort(sortConfigs)
this.checkRowLimit() this.checkRowLimit()
@@ -1449,7 +1628,14 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
// about the new row and HARDFORMULA/SOFTFORMULA columns silently // about the new row and HARDFORMULA/SOFTFORMULA columns silently
// fall out of sync with the grid's own data. // fall out of sync with the grid's own data.
hot.alter('insert_row_below', newIndex - 1, 1) hot.alter('insert_row_below', newIndex - 1, 1)
this.dataSource[newIndex].noLinkOption = true
// alter() is expected to splice synchronously into dataSource, but
// this guards against relying on that if the data binding ever
// becomes async.
if (this.dataSource[newIndex]) {
this.dataSource[newIndex].noLinkOption = true
}
this.seedFormulaValuesForRow(newIndex) this.seedFormulaValuesForRow(newIndex)
this.updateEditStatusForRow(newIndex) this.updateEditStatusForRow(newIndex)
@@ -1600,6 +1786,13 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
* call after a row insert/delete/sort has moved things around). No-op if * call after a row insert/delete/sort has moved things around). No-op if
* the row has no PK match in dataSourceRaw (a newly-inserted row) - see * the row has no PK match in dataSourceRaw (a newly-inserted row) - see
* findOverwrittenCells for why that's never revertable. * findOverwrittenCells for why that's never revertable.
*
* rowIndex is physical (matches dataSource's own order, same contract as
* syncOverwrittenComments()'s own dataSource.forEach caller below) -
* getDataAtRowProp and the comments plugin's own cell API all document a
* VISUAL row instead, so it's translated via hot.toVisualRow() for every
* Handsontable/plugin call, while dataSource itself stays indexed by the
* physical rowIndex throughout.
*/ */
private syncOverwrittenCommentForCell(rowIndex: number, prop: string): void { private syncOverwrittenCommentForCell(rowIndex: number, prop: string): void {
const hot = this.hotInstance const hot = this.hotInstance
@@ -1611,11 +1804,14 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
) )
if (!rawRow) return if (!rawRow) return
const visualRow = hot.toVisualRow(rowIndex)
if (visualRow === null) return
const colIndex = hot.propToCol(prop) as number const colIndex = hot.propToCol(prop) as number
const commentsPlugin = hot.getPlugin('comments') const commentsPlugin = hot.getPlugin('comments')
const currentValue = hot.getDataAtRowProp(rowIndex, prop) const currentValue = hot.getDataAtRowProp(visualRow, prop)
const hasCommentAlready = !!commentsPlugin.getCommentAtCell( const hasCommentAlready = !!commentsPlugin.getCommentAtCell(
rowIndex, visualRow,
colIndex colIndex
) )
@@ -1627,12 +1823,12 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
if (action === 'set') { if (action === 'set') {
commentsPlugin.setCommentAtCell( commentsPlugin.setCommentAtCell(
rowIndex, visualRow,
colIndex, colIndex,
`${EditorComponent.ORIGINAL_VALUE_COMMENT_PREFIX}${rawRow[prop]}` `${EditorComponent.ORIGINAL_VALUE_COMMENT_PREFIX}${rawRow[prop]}`
) )
} else if (action === 'remove') { } else if (action === 'remove') {
commentsPlugin.removeCommentAtCell(rowIndex, colIndex) commentsPlugin.removeCommentAtCell(visualRow, colIndex)
} }
} }
@@ -1727,6 +1923,53 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
} }
} }
/**
* A primary key identifies its own row for the rest of the edit session
* (getRowKey, dataModified, classifyRow all match rows by comparing PK
* values) - a HARDFORMULA/SOFTFORMULA rule on a PK column gets seeded by
* applyFormulaRules as a live `=...` formula string exactly like any
* other formula column, but a PK can never be allowed to keep
* recalculating for the rest of the session the way a normal formula
* column does: saveTable's own formulaRules loop only resolves a formula
* column's computed value once, at submit, so anything that changed a
* column the PK's formula depends on in between would silently shift the
* PK out from under dataModified/classifyRow's PK-matching - the same
* failure mode the afterChange hook below already prevents for a
* user-typed PK formula. So a PK-as-formula-column is frozen to its
* computed value once, right here at load. Both dataSource and
* dataSourceUnchanged get the same frozen value - overriding whatever
* overlayFormulaRawValuesOnUnchanged set for it, since a PK's identity
* role takes priority over the normal "did a formula overwrite real
* data" modified-detection every other formula column gets.
*/
private resolvePkFormulaSeedValues(): void {
const hot = this.hotInstance
const formulaBaseCols = getFormulaColumnNames(
this.dcValidator?.getDqDetails() ?? []
)
const pkFormulaCols = this.headerPks.filter((pk) =>
formulaBaseCols.includes(pk)
)
if (pkFormulaCols.length === 0) return
// Deferred for the same reason as this method's own caller
// (markOverwrittenCells) defers its setDataAtRowProp call above: right
// after the initial hot.updateSettings(), the Formulas plugin's
// hidden-column index mapping hasn't settled yet, and setDataAtRowProp
// throws ExpectedValueOfTypeError before it has.
setTimeout(() => {
this.dataSource.forEach((_row, rowIndex) => {
for (const pkCol of pkFormulaCols) {
const computed = hot.getDataAtRowProp(rowIndex, pkCol)
hot.setDataAtRowProp(rowIndex, pkCol, computed, 'resolvePkFormula')
const unchangedRow = this.dataSourceUnchanged?.[rowIndex]
if (unchangedRow) unchangedRow[pkCol] = computed
}
})
}, 0)
}
/** /**
* Recomputes this row's classification (M/A/D/U) and writes it into the * Recomputes this row's classification (M/A/D/U) and writes it into the
* EDIT_STATUS cell - the same classification the row-header symbol shows, * EDIT_STATUS cell - the same classification the row-header symbol shows,
@@ -1736,6 +1979,12 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
* HyperFormula is notified and dependents recalculate - the source string * HyperFormula is notified and dependents recalculate - the source string
* also lets the afterChange hook below recognise and ignore its own * also lets the afterChange hook below recognise and ignore its own
* writes, avoiding infinite recursion. * writes, avoiding infinite recursion.
*
* rowIndex is physical (matches dataSource's own order, same contract as
* addRow()/insertRowAtPosition()'s own callers) - setDataAtRowProp
* documents a VISUAL row instead, so it's translated via
* hot.toVisualRow() right before that one call, while dataSource itself
* stays indexed by the physical rowIndex.
*/ */
private updateEditStatusForRow(rowIndex: number): void { private updateEditStatusForRow(rowIndex: number): void {
const dataRow = this.dataSource[rowIndex] const dataRow = this.dataSource[rowIndex]
@@ -1747,8 +1996,11 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.headerPks this.headerPks
) )
const visualRow = this.hotInstance.toVisualRow(rowIndex)
if (visualRow === null) return
this.hotInstance.setDataAtRowProp( this.hotInstance.setDataAtRowProp(
rowIndex, visualRow,
EDIT_STATUS_COLUMN_NAME, EDIT_STATUS_COLUMN_NAME,
status, status,
'editStatus' 'editStatus'
@@ -1761,7 +2013,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.hotTable.data = this.dataSource this.hotTable.data = this.dataSource
const hot = this.hotInstance const hot = this.hotInstance
hot.updateSettings( this.updateSettingsSortSafe(
{ {
data: this.dataSource, data: this.dataSource,
colHeaders: getDisplayColHeaders( colHeaders: getDisplayColHeaders(
@@ -2227,7 +2479,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
} }
} }
hot.updateSettings( this.updateSettingsSortSafe(
{ {
data: this.dataSource, data: this.dataSource,
colHeaders: getDisplayColHeaders( colHeaders: getDisplayColHeaders(
@@ -2310,6 +2562,54 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
}) })
} }
// Two things every other column (HARDFORMULA/SOFTFORMULA ones are
// already fully handled above) still needs before submission:
//
// 1. Strip the escape marker this app added (see
// escapeCharacterColumnValue/character-column-formula-plan.md) from
// every cell the app itself marked, so it never reaches the
// backend. A cell the user has since edited, or one whose leading
// `'` was already genuine backend data, is never in
// autoEscapedCells and so is never touched here - it submits
// exactly as it currently reads. autoEscapedCells is only ever
// populated for character columns, so this is naturally a no-op
// for any other column.
// 2. Resolve the computed value of a genuine, currently-live formula
// (typed, pasted, or "Apply as formula"'d - never auto-escaped, so
// its raw dataSource string still starts with a bare `=`) the same
// way the HARDFORMULA/SOFTFORMULA loop above does - otherwise the
// raw formula text itself would reach the backend instead of what
// the grid actually displays. Not scoped to character columns -
// HyperFormula evaluates a `=`-led value the same way regardless
// of the column's own declared type, and coerceNumericRow
// (beforePaste/beforeAutofill) deliberately leaves a non-numeric,
// formula-looking paste alone rather than forcing it to NaN, so a
// numeric column can end up holding a live formula too.
//
// Runs regardless of whether this table has any HARDFORMULA/
// SOFTFORMULA rules - formulas (and both of the above) are enabled
// everywhere.
const formulaBaseCols = getFormulaColumnNames(
this.dcValidator?.getDqDetails() ?? []
)
data.forEach((row: any, physicalRowIndex: number) => {
const visualRowIndex = hot.toVisualRow(physicalRowIndex)
const rowKey = getRowKey(row, this.headerPks)
for (const colName of this.headerColumns) {
if (formulaBaseCols.includes(colName)) continue
if (isAutoEscaped(this.autoEscapedCells, rowKey, colName)) {
row[colName] = unescapeFormula(row[colName])
} else if (
typeof row[colName] === 'string' &&
row[colName].startsWith('=')
) {
row[colName] = hot.getDataAtRowProp(visualRowIndex, colName)
}
}
})
data = data.filter((dataRow: any) => { data = data.filter((dataRow: any) => {
const elModified = this.dataModified.find((row) => { const elModified = this.dataModified.find((row) => {
for (const pkCol of this.headerPks) { for (const pkCol of this.headerPks) {
@@ -2489,9 +2789,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
if (this.recordAction === 'ADD' && !confirmButtonClicked) { if (this.recordAction === 'ADD' && !confirmButtonClicked) {
this.dataSource = this.helperService.deepClone(this.prevDataSource) this.dataSource = this.helperService.deepClone(this.prevDataSource)
const hot = this.hotInstance this.updateSettingsSortSafe(
hot.updateSettings(
{ {
data: this.dataSource data: this.dataSource
}, },
@@ -2518,9 +2816,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.dataSource[closingRecordIndex] = this.currentEditRecord this.dataSource[closingRecordIndex] = this.currentEditRecord
this.hotTable.data[closingRecordIndex] = this.currentEditRecord this.hotTable.data[closingRecordIndex] = this.currentEditRecord
const hot = this.hotInstance this.updateSettingsSortSafe(
hot.updateSettings(
{ {
data: this.dataSource data: this.dataSource
}, },
@@ -2692,7 +2988,13 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
const cellData = hot.getDataAtCell(row, column) const cellData = hot.getDataAtCell(row, column)
const clickedRow = this.helperService.deepClone(this.dataSource[row]) const clickedRow = this.helperService.deepClone(this.dataSource[row])
const clickedColumnKey = Object.keys(clickedRow)[column] // hot.colToProp resolves the column's actual configured data key -
// Object.keys(clickedRow)[column] only worked by coincidence for a
// fully-populated row; a sparse row (one whose backend source never
// populated some earlier column) has fewer real keys than the grid has
// columns, so counting into its own key list drifts out of alignment
// (or runs out of bounds entirely) once column indexes past the gap.
const clickedColumnKey = hot.colToProp(column) as string
const skipRender = !!opts?.skipRender const skipRender = !!opts?.skipRender
const myEpoch = this.validationEpoch const myEpoch = this.validationEpoch
@@ -3287,7 +3589,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.useLabels this.useLabels
) )
this.hotInstance.updateSettings({ colHeaders }, false) this.updateSettingsSortSafe({ colHeaders }, false)
} }
ngOnDestroy() { ngOnDestroy() {
@@ -3311,6 +3613,16 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.gridResizeObserver = undefined this.gridResizeObserver = undefined
} }
// Remove the native paste listener (see its own registration comment -
// attached once on rootElement rather than per edit session)
if (this.pasteListener && this.hotInstance?.rootElement) {
this.hotInstance.rootElement.removeEventListener(
'paste',
this.pasteListener
)
this.pasteListener = undefined
}
// Cancel any pending debounced VA apply // Cancel any pending debounced VA apply
if (this.vaDebounceTimer) { if (this.vaDebounceTimer) {
clearTimeout(this.vaDebounceTimer) clearTimeout(this.vaDebounceTimer)
@@ -3336,7 +3648,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
requestAnimationFrame(() => { requestAnimationFrame(() => {
const hot = this.hotInstance const hot = this.hotInstance
if (!hot || hot.isDestroyed) return if (!hot || hot.isDestroyed) return
hot.updateSettings({ height: this.hotTable.height }, false) this.updateSettingsSortSafe({ height: this.hotTable.height }, false)
hot.render() hot.render()
}) })
}) })
@@ -3588,13 +3900,15 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
response.data.dqdata response.data.dqdata
) )
// Only turn on Handsontable's formulas plugin (HyperFormula engine) for // this.hotTable.formulas is set once, on the field itself, and applies
// tables that actually use HARDFORMULA/SOFTFORMULA - it's not free to // to every table regardless of whether it has any HARDFORMULA/
// run for every grid. gpl-v3: this app embeds HyperFormula under its // SOFTFORMULA rules.
// GPLv3 free-tier terms, not a purchased commercial key.
this.hotTable.formulas = hasFormulaRules(response.data.dqrules) // BASE_COL names of every HARDFORMULA/SOFTFORMULA rule - applyFormulaRules
? { engine: HyperFormula, licenseKey: 'gpl-v3' } // below legitimately writes a live `=...` formula string into these, so
: false // the escape loop further down must skip them (they're never
// backend-sourced text that merely looks like a formula).
const formulaBaseCols = getFormulaColumnNames(response.data.dqrules)
this.cellValidation = this.dcValidator.getRules() this.cellValidation = this.dcValidator.getRules()
@@ -3631,6 +3945,48 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
this.userService.user?.username ?? '' this.userService.user?.username ?? ''
) )
// Prevent a `=`-led value from the backend in any character column from
// being treated as a live formula - see character-column-formula-plan.md.
// Must run after applyFormulaRules above (which legitimately writes a
// live formula string into HARDFORMULA/SOFTFORMULA columns) and before
// dataSourceUnchanged is cloned below, so the "unchanged baseline"
// already reflects the escaped form rather than flagging these cells as
// modified. Only backend-sourced values are ever escaped here - a value
// the user later types or pastes is never touched (see beforeChange).
//
// Also escapes the matching dataSourceRaw cell (still index-aligned
// with dataSource here, before any sort/insert reorders things) for the
// same non-formula columns, so it stays in sync with what the user
// actually sees. dataSourceRaw drives the Revert feature - if it kept
// the true unescaped backend string instead, reverting a cell after
// "Apply as formula" would restore the raw `=...` text, which
// (formulas being enabled everywhere) evaluates live again instead of
// going back to the escaped text the user started from. Formula base
// columns are still skipped, so dataSourceRaw keeps meaning "value
// before the formula overwrote it" for them, same as before.
this.autoEscapedCells = new Map()
this.dataSource.forEach((row, rowIndex) => {
const rowKey = getRowKey(row, this.headerPks)
for (const colName of this.headerColumns) {
if (formulaBaseCols.includes(colName)) continue
if (!isCharacterColumn(this.cols, colName)) continue
const { value, wasEscaped } = escapeCharacterColumnValue(row[colName])
// A row whose backend source never had this column at all (a
// sparse row) must stay that way - writing back unconditionally
// would materialize a new own property set to undefined, which
// the SASjs adapter rejects at submit time even though nothing
// about this cell ever changed.
if (!wasEscaped) continue
row[colName] = value
if (this.dataSourceRaw[rowIndex]) {
this.dataSourceRaw[rowIndex][colName] = value
}
markAutoEscaped(this.autoEscapedCells, rowKey, colName)
}
})
// Seeded here too (not just editTable()) so a HARDFORMULA/SOFTFORMULA // Seeded here too (not just editTable()) so a HARDFORMULA/SOFTFORMULA
// rule that silently overwrote real pre-existing data (see // rule that silently overwrote real pre-existing data (see
// markOverwrittenCells) already shows the row as modified - both the // markOverwrittenCells) already shows the row as modified - both the
@@ -3769,7 +4125,22 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
}, },
rowHeaderWidth: 20, rowHeaderWidth: 20,
rowHeights: 24, rowHeights: 24,
maxRows: this.licenceState.value.editor_rows_allowed || Infinity, // Handsontable's own maxRows (a UI/licensing cap on how many NEW
// rows can be ADDED - see checkRowLimit/restrictAddRow) silently
// becomes HyperFormula's OWN sheet-size limit too (see
// getEngineSettingsOverrides in Handsontable's formulas plugin,
// which maps hotSettings.maxRows straight into the engine config).
// editor_rows_allowed can be smaller than a table's ALREADY-
// EXISTING row count, and formulas are on for every table - capping
// at editor_rows_allowed alone would make HyperFormula reject the
// sheet outright for any table bigger than that cap. Never let it
// go below what's actually loaded - the add-row restriction itself
// is still enforced separately, by checkRowLimit's own comparison
// against dataSource.length.
maxRows: Math.max(
this.dataSource.length,
this.licenceState.value.editor_rows_allowed || Infinity
),
invalidCellClassName: 'htInvalid', invalidCellClassName: 'htInvalid',
// Prevent automatic row creation // Prevent automatic row creation
autoWrapRow: false, autoWrapRow: false,
@@ -3925,6 +4296,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
// actually evaluated them against the data/formulas settings just // actually evaluated them against the data/formulas settings just
// applied. // applied.
this.markOverwrittenCells() this.markOverwrittenCells()
this.resolvePkFormulaSeedValues()
this.hotTable.hidden = false this.hotTable.hidden = false
// Keep the context menu enabled in view mode too so Copy/Export remain // Keep the context menu enabled in view mode too so Copy/Export remain
@@ -4002,24 +4374,56 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
// ROUND: round numeric values Excel-style before they are written. // ROUND: round numeric values Excel-style before they are written.
// Mutating `changes` in place (rather than setDataAtRowProp) avoids // Mutating `changes` in place (rather than setDataAtRowProp) avoids
// re-entrancy and uniformly covers edit, paste and autofill. // re-entrancy and uniformly covers edit, paste and autofill.
hot.addHook('beforeChange', (changes: any[]) => { hot.addHook('beforeChange', (changes: any[], source: any) => {
if (!changes) return if (!changes) return
for (const change of changes) { for (const change of changes) {
if (!change) continue if (!change) continue
const [, prop, , newValue] = change const [changeRow, prop, , newValue] = change
const colName = const colName =
typeof prop === 'string' typeof prop === 'string'
? prop ? prop
: (hot.colToProp(prop as number) as string) : (hot.colToProp(prop as number) as string)
const digits = this.dcValidator?.getRoundDigits(colName) const digits = this.dcValidator?.getRoundDigits(colName)
if (digits === undefined) continue if (digits !== undefined) {
const num = Number(newValue)
if (newValue !== null && newValue !== '' && !isNaN(num)) {
change[3] = excelRound(num, digits)
}
}
const num = Number(newValue) // A `=`-led value the user types or pastes is never auto-escaped
if (newValue !== null && newValue !== '' && !isNaN(num)) { // (see character-column-formula-plan.md) - it's left exactly as
change[3] = excelRound(num, digits) // entered, which genuinely evaluates as a live formula since
// formulas are enabled for every column. If this cell was
// previously auto-escaped from backend data, the user is now
// supplying their own content, so that marker no longer describes
// what's here - clear it so submit/"Apply as formula" leave this
// cell alone.
const row = this.dataSource[hot.toPhysicalRow(changeRow)]
if (!row) continue
const rowKey = getRowKey(row, this.headerPks)
// Revert (see the revert_cells context-menu item, which tags its
// own write with this source) restores dataSourceRaw's value
// verbatim - for a character column that's the same escaped form
// the initial-load pass would have produced, so it's correct to
// treat it the same way and re-mark it, letting "Apply as
// formula" and the submit-time strip work on it again. A value
// that merely happens to start with `'=` because the user typed
// it themselves never takes this path, since only revert_cells
// uses this source.
if (
source === 'revert' &&
typeof newValue === 'string' &&
newValue.startsWith("'=")
) {
markAutoEscaped(this.autoEscapedCells, rowKey, colName)
} else {
clearAutoEscaped(this.autoEscapedCells, rowKey, colName)
} }
} }
}) })
@@ -4072,9 +4476,18 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
for (const change of changes) { for (const change of changes) {
if (!change) continue if (!change) continue
const [row, prop] = change // changes gives the VISUAL row (Handsontable's own documented
// afterChange shape) - translate to physical before indexing
// dataSource, same as beforeChange's own hot.toPhysicalRow(changeRow)
// a few lines up. syncOverwrittenCommentForCell/updateEditStatusForRow
// both expect physical (they translate back to visual internally,
// only where a Handsontable API actually needs it).
const [visualRow, prop] = change
if (prop === EDIT_STATUS_COLUMN_NAME) continue if (prop === EDIT_STATUS_COLUMN_NAME) continue
const row = hot.toPhysicalRow(visualRow)
if (row === null) continue
changedRows.add(row) changedRows.add(row)
if (revertableCols.includes(prop)) { if (revertableCols.includes(prop)) {
@@ -4130,7 +4543,7 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
}, 50) }, 50)
}) })
hot.addHook('afterCreateRow', (source: any, change: any) => { hot.addHook('afterCreateRow', (source: any) => {
if (source > this.dataSource.length) { if (source > this.dataSource.length) {
// don't scroll if row is not added to the end (bottom) // don't scroll if row is not added to the end (bottom)
const wtHolder = document.querySelector('.wtHolder') const wtHolder = document.querySelector('.wtHolder')
@@ -4197,13 +4610,117 @@ export class EditorComponent implements OnInit, AfterViewInit, OnDestroy {
return value return value
}) })
hot.addHook('beforePaste', (data: any, cords: any) => { // A primary key identifies its own row for the rest of the edit session
const startCol = cords[0].startCol // (getRowKey, dataModified, classifyRow all match rows by comparing PK
for (let r = 0; r < data.length; r++) { // values) - if it's left holding a live formula, HyperFormula's
data[r] = coerceNumericRow(data[r], startCol) // recalculation can shift that identity out from under those matches
// between whenever the formula was entered and whenever saveTable()
// finally resolves it. Unlike any other column, resolve a PK's formula
// to its computed value immediately, right when it's entered (typed,
// pasted, autofilled, or "Apply as formula"'d), so the PK is never
// anything other than a stable, already-computed value going forward.
// Deferred via setTimeout, same as the NOTNULL default-population hook
// above, since writing back through setDataAtRowProp from inside
// afterChange itself would re-enter change processing immediately.
hot.addHook('afterChange', (changes: any[], source: any) => {
if (!changes || source === 'loadData' || source === 'resolvePkFormula')
return
for (const change of changes) {
if (!change) continue
const [row, prop, , newValue] = change
if (typeof newValue !== 'string' || !newValue.startsWith('=')) continue
const colName =
typeof prop === 'string'
? prop
: (hot.colToProp(prop as number) as string)
if (!this.headerPks.includes(colName)) continue
setTimeout(() => {
const computed = hot.getDataAtRowProp(row, colName)
hot.setDataAtRowProp(row, colName, computed, 'resolvePkFormula')
}, 0)
} }
}) })
hot.addHook('beforePaste', (data: any, cords: any) => {
const startCol = cords[0].startCol
const startRow = cords[0].startRow
for (let r = 0; r < data.length; r++) {
data[r] = coerceNumericRow(data[r], startCol)
// Translate column names in a pasted formula (e.g. "=PRICE * VOLUME")
// into this row's cell references ("=B4 * C4") - only meaningful on
// a character column, since that's what's formula-capable for user
// input (see character-column-formula-plan.md). Translating for a
// numeric column would be pointless and would leave a confusing
// half-translated string sitting there instead of the original,
// readable pasted text.
data[r] = data[r].map((value: any, index: number) => {
const colName = this.columnHeader[startCol + index]
if (!isCharacterColumn(this.cols, colName)) return value
return typeof value === 'string' && value.trim().startsWith('=')
? substituteColumnReferences(
value.trim(),
this.headerColumns,
startRow + r
)
: value
})
}
})
// Same column-name -> cell-reference translation as beforePaste above,
// but for pasting directly into an open cell editor (double-click,
// then Cmd+V/Ctrl+V or right-click > Paste) - Handsontable's CopyPaste
// plugin only intercepts a grid-level paste (cell selected but not
// being edited); pasting into the editor's own textarea is a native
// browser paste event the plugin never sees. Listens once on the root
// element (paste events bubble) rather than attaching a new listener
// per edit session, to avoid accumulating listeners across repeated
// edits.
//
// This whole registration only ever runs once per component instance
// in practice (initSetup's own retry-until-ready loop returns before
// reaching this point on every attempt except the one that succeeds,
// and table-switching navigates to a fresh component instance rather
// than reloading in place) - but removing any previous listener before
// replacing the reference costs nothing and keeps that guarantee from
// becoming a silent leak if this assumption ever changes.
if (this.pasteListener) {
hot.rootElement.removeEventListener('paste', this.pasteListener)
}
this.pasteListener = (event: ClipboardEvent) => {
const editor: any = hot.getActiveEditor()
if (!editor || editor.row === null || event.target !== editor.TEXTAREA)
return
// Only on a character column - see beforePaste's own comment above
// for why.
const colName = this.columnHeader[editor.col]
if (!isCharacterColumn(this.cols, colName)) return
const pastedText = event.clipboardData?.getData('text/plain') ?? ''
if (!pastedText.trim().startsWith('=')) return
event.preventDefault()
editor.TEXTAREA.value = substituteColumnReferences(
pastedText.trim(),
this.headerColumns,
editor.row
)
// A real paste's default action would fire this itself once the
// text landed - since preventDefault() above skips that, dispatch it
// manually so the editor's own input-tracking (autosize, its
// internal notion of the current value) picks up the change.
editor.TEXTAREA.dispatchEvent(new Event('input', { bubbles: true }))
}
hot.rootElement.addEventListener('paste', this.pasteListener)
hot.addHook( hot.addHook(
'beforeAutofill', 'beforeAutofill',
(selectionData: any[][], sourceRange: any) => { (selectionData: any[][], sourceRange: any) => {
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,20 @@
import { normalizeSortConfig } from './normalizeSortConfig'
describe('normalizeSortConfig', () => {
it('wraps a single config in an array', () => {
const cfg = { column: 0, sortOrder: 'asc' as const }
expect(normalizeSortConfig(cfg)).toEqual([cfg])
})
it('passes an array of configs through unchanged', () => {
const cfgs = [
{ column: 0, sortOrder: 'asc' as const },
{ column: 1, sortOrder: 'desc' as const }
]
expect(normalizeSortConfig(cfgs)).toEqual(cfgs)
})
it('returns an empty array for undefined (nothing currently sorted)', () => {
expect(normalizeSortConfig(undefined)).toEqual([])
})
})
@@ -0,0 +1,13 @@
/**
* multiColumnSorting's getSortConfig() returns a single config, an array of
* them, or undefined depending on how many columns are currently sorted -
* normalizes all three shapes into one array so callers never need three
* branches to handle it. `SortConfig` isn't part of Handsontable's public
* API surface in this version (only re-exported internally), and its own
* `.d.ts` shape isn't structurally assignable to `Record<string, unknown>`
* either (a specific interface isn't assignable to an index-signature type
* without one of its own), so `any` is the pragmatic choice here rather
* than fighting the type system for a type this file can't even name.
*/
export const normalizeSortConfig = (cfg: any): any[] =>
Array.isArray(cfg) ? cfg : cfg ? [cfg] : []
@@ -0,0 +1,540 @@
import Handsontable from 'handsontable'
import { HyperFormula } from 'hyperformula'
import { classifyRow } from './classifyRow'
import { normalizeSortConfig } from './normalizeSortConfig'
import { EDIT_STATUS_COLUMN_NAME } from '../../shared/dc-validator/utils/editStatusColumnRule'
import { parseFormulaRule } from '../../shared/dc-validator/utils/parseFormulaRule'
import { getFormulaCellsToPreserveOnCancel } from '../../shared/dc-validator/utils/getFormulaCellsToPreserveOnCancel'
/**
* afterChange delivers changes as [visualRow, prop, oldValue, newValue] -
* Handsontable's own documented behaviour. Once multiColumnSorting reorders
* the grid, visual row order no longer matches dataSource's physical order.
* editor.component.ts's afterChange hook (the one syncing EDIT_STATUS and
* the "overwritten" comment) passes that raw visual row straight into
* updateEditStatusForRow/syncOverwrittenCommentForCell, both of which index
* dataSource directly - the same [visualRow] shape the beforeChange hook a
* few lines up in the same file already translates via
* hot.toPhysicalRow(changeRow) before doing the same kind of dataSource
* access.
*
* Mirrors the row extraction only (not the full hook), against a real
* Handsontable + multiColumnSorting instance, since proving visual/physical
* divergence requires an actual sort to have happened.
*/
describe('afterChange must translate the changed row to physical before indexing dataSource, on a sorted grid', () => {
const setup = (): { hot: Handsontable; dataSource: any[] } => {
// Physical row 0: PK=1. Physical row 1: PK=2.
const dataSource = [
{ PRIMARY_KEY_FIELD: 1, SOME_CHAR: 'b' },
{ PRIMARY_KEY_FIELD: 2, SOME_CHAR: 'a' }
]
const hot = new Handsontable(document.createElement('div'), {
data: dataSource,
columns: [{ data: 'PRIMARY_KEY_FIELD' }, { data: 'SOME_CHAR' }],
multiColumnSorting: true,
licenseKey: 'non-commercial-and-evaluation'
})
hot.render()
// Ascending by SOME_CHAR flips the order: physical row 1 (SOME_CHAR
// 'a') becomes visual row 0; physical row 0 (SOME_CHAR 'b') becomes
// visual row 1.
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
sortPlugin.sort({ column: 1, sortOrder: 'asc' })
hot.render()
return { hot, dataSource }
}
it('demonstrates the failure mode: indexing dataSource with the raw visual row reads the wrong row', () => {
const { hot, dataSource } = setup()
// The user edits what they see as the FIRST row on screen - visual
// row 0, which after sorting is physical row 1 (PK=2).
const visualRow = 0
// Mirrors the current (buggy) afterChange hook: uses the visual row
// straight from `changes` to index dataSource.
const wronglyReadRow = dataSource[visualRow]
expect(wronglyReadRow.PRIMARY_KEY_FIELD).not.toEqual(2)
expect(wronglyReadRow.PRIMARY_KEY_FIELD).toEqual(1) // the OTHER row
// Mirrors the fix: translate visual -> physical first, matching
// beforeChange's own hot.toPhysicalRow(changeRow) pattern.
const physicalRow = hot.toPhysicalRow(visualRow)
const correctlyReadRow = dataSource[physicalRow as number]
expect(correctlyReadRow.PRIMARY_KEY_FIELD).toEqual(2)
hot.destroy()
})
})
/**
* updateEditStatusForRow/syncOverwrittenCommentForCell's own established
* contract (per their other existing callers - addRow/insertRowAtPosition,
* and syncOverwrittenComments()'s own `dataSource.forEach((_row, rowIndex)
* => ...)`) is a PHYSICAL row index, used to index dataSource. But both
* also call Handsontable APIs - hot.setDataAtRowProp/getDataAtRowProp
* (updateEditStatusForRow) and the comments plugin's setCommentAtCell/
* getCommentAtCell/removeCommentAtCell (syncOverwrittenCommentForCell) -
* which Handsontable's own JSDoc documents as expecting the VISUAL row.
* Passing the physical row straight through to those (the current code)
* only happens to work when visual and physical coincide - i.e. an
* unsorted grid. On a sorted one, translating the afterChange hook's own
* row (see the describe block above) is necessary but not sufficient -
* these two methods must also convert their own physical rowIndex
* parameter to visual before calling any Handsontable API, or the fix
* above just moves the bug rather than closing it.
*/
describe('updateEditStatusForRow resolves the correct visual cell on a sorted grid', () => {
const headerPks = ['PRIMARY_KEY_FIELD']
const setup = (): { hot: Handsontable; dataSource: any[] } => {
const dataSource = [
{
PRIMARY_KEY_FIELD: 1,
SOME_CHAR: 'b',
[EDIT_STATUS_COLUMN_NAME]: 'U'
},
{
PRIMARY_KEY_FIELD: 2,
SOME_CHAR: 'a',
[EDIT_STATUS_COLUMN_NAME]: 'U'
}
]
const hot = new Handsontable(document.createElement('div'), {
data: dataSource,
columns: [
{ data: 'PRIMARY_KEY_FIELD' },
{ data: 'SOME_CHAR' },
{ data: EDIT_STATUS_COLUMN_NAME }
],
multiColumnSorting: true,
licenseKey: 'non-commercial-and-evaluation'
})
hot.render()
// Ascending by SOME_CHAR: physical row 1 (PK=2) -> visual row 0;
// physical row 0 (PK=1) -> visual row 1.
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
sortPlugin.sort({ column: 1, sortOrder: 'asc' })
hot.render()
return { hot, dataSource }
}
// Mirrors the CURRENT updateEditStatusForRow - uses the (correct,
// physical) rowIndex directly for the Handsontable write too.
const updateEditStatusForRowBuggy = (
hot: Handsontable,
dataSource: any[],
dataSourceUnchanged: any[],
rowIndex: number
): void => {
const dataRow = dataSource[rowIndex]
if (!dataRow) return
const status = classifyRow(dataRow, dataSourceUnchanged, headerPks)
hot.setDataAtRowProp(
rowIndex,
EDIT_STATUS_COLUMN_NAME,
status,
'editStatus'
)
}
// Mirrors the fix - dataSource access stays physical; the Handsontable
// write is translated to visual first.
const updateEditStatusForRowFixed = (
hot: Handsontable,
dataSource: any[],
dataSourceUnchanged: any[],
rowIndex: number
): void => {
const dataRow = dataSource[rowIndex]
if (!dataRow) return
const status = classifyRow(dataRow, dataSourceUnchanged, headerPks)
const visualRow = hot.toVisualRow(rowIndex)
if (visualRow === null) return
hot.setDataAtRowProp(
visualRow,
EDIT_STATUS_COLUMN_NAME,
status,
'editStatus'
)
}
it('demonstrates the failure mode: the buggy version writes the status to the wrong cell', () => {
const { hot, dataSource } = setup()
// Physical row 1 (PK=2) is the one that actually changed vs its
// unchanged baseline (SOME_CHAR 'a' vs 'ORIGINAL') - classifyRow
// should mark it 'M'. It's currently displayed at visual row 0.
const dataSourceUnchanged = [
{
PRIMARY_KEY_FIELD: 1,
SOME_CHAR: 'b',
[EDIT_STATUS_COLUMN_NAME]: 'U'
},
{
PRIMARY_KEY_FIELD: 2,
SOME_CHAR: 'ORIGINAL',
[EDIT_STATUS_COLUMN_NAME]: 'U'
}
]
updateEditStatusForRowBuggy(hot, dataSource, dataSourceUnchanged, 1)
// Buggy: wrote 'M' to visual row 1 (PK=1's cell, unaffected), not
// visual row 0 (PK=2's actual current position).
expect(hot.getDataAtRowProp(1, EDIT_STATUS_COLUMN_NAME)).toEqual('M')
expect(hot.getDataAtRowProp(0, EDIT_STATUS_COLUMN_NAME)).toEqual('U')
hot.destroy()
})
it('writes the status to the correct (visually current) cell once fixed', () => {
const { hot, dataSource } = setup()
const dataSourceUnchanged = [
{
PRIMARY_KEY_FIELD: 1,
SOME_CHAR: 'b',
[EDIT_STATUS_COLUMN_NAME]: 'U'
},
{
PRIMARY_KEY_FIELD: 2,
SOME_CHAR: 'ORIGINAL',
[EDIT_STATUS_COLUMN_NAME]: 'U'
}
]
updateEditStatusForRowFixed(hot, dataSource, dataSourceUnchanged, 1)
expect(hot.getDataAtRowProp(0, EDIT_STATUS_COLUMN_NAME)).toEqual('M')
expect(hot.getDataAtRowProp(1, EDIT_STATUS_COLUMN_NAME)).toEqual('U')
hot.destroy()
})
})
/**
* Same physical/visual split as updateEditStatusForRow above, for the
* comments plugin's own row-indexed API (setCommentAtCell/
* getCommentAtCell/removeCommentAtCell all document a VISUAL row -
* propToCol, unlike the row side, already returns a visual column, so
* only the row needs translating).
*/
describe('syncOverwrittenCommentForCell resolves the correct visual cell on a sorted grid', () => {
const setup = (): { hot: Handsontable } => {
const dataSource = [
{ PRIMARY_KEY_FIELD: 1, SOME_CHAR: 'b' },
{ PRIMARY_KEY_FIELD: 2, SOME_CHAR: 'a' }
]
const hot = new Handsontable(document.createElement('div'), {
data: dataSource,
columns: [{ data: 'PRIMARY_KEY_FIELD' }, { data: 'SOME_CHAR' }],
multiColumnSorting: true,
comments: true,
licenseKey: 'non-commercial-and-evaluation'
})
hot.render()
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
sortPlugin.sort({ column: 1, sortOrder: 'asc' })
hot.render()
return { hot }
}
it('demonstrates the failure mode: setCommentAtCell(physicalRow, ...) lands on the wrong visual cell', () => {
const { hot } = setup()
const commentsPlugin: any = hot.getPlugin('comments')
// Mirrors the buggy call: the established-physical rowIndex (1) used
// directly against a Handsontable API that wants visual.
commentsPlugin.setCommentAtCell(1, 1, 'Original value: b')
// Landed on visual row 1 (PK=1's cell), not visual row 0 (PK=2's
// actual current position, physical row 1).
expect(commentsPlugin.getCommentAtCell(1, 1)).toEqual('Original value: b')
expect(commentsPlugin.getCommentAtCell(0, 1)).toBeUndefined()
hot.destroy()
})
it('lands on the correct visual cell once translated to visual first', () => {
const { hot } = setup()
const commentsPlugin: any = hot.getPlugin('comments')
const visualRow = hot.toVisualRow(1)
commentsPlugin.setCommentAtCell(visualRow, 1, 'Original value: a')
expect(commentsPlugin.getCommentAtCell(0, 1)).toEqual('Original value: a')
expect(commentsPlugin.getCommentAtCell(1, 1)).toBeUndefined()
hot.destroy()
})
})
/**
* A genuine Handsontable multiColumnSorting + formulas plugin bug (not
* specific to any of DC's own hooks): calling hot.updateSettings() - with
* ANY settings, even a bare {} - while a sort is active corrupts formula
* cell references, rendering '#REF!' instead of their computed value.
* Reproduced directly: a no-op {} settings object alone is enough to
* trigger it, independent of what it actually changes. editTable(),
* cancelEdit(), and every other place editor.component.ts calls
* updateSettings() after the grid could already be sorted (e.g. the user
* sorted while still read-only, then clicked Edit) hits this. The fix
* (updateSettingsSortSafe) clears the sort before the call and restores it
* immediately afterward.
*/
describe('updateSettings must not run while a sort is active - it corrupts formula cell references', () => {
const buildSortedGrid = (): Handsontable => {
const columnNames = [
'PRIMARY_KEY_FIELD',
'A_COL',
'B_COL',
'FORMULA_HARD_COL',
'PLAIN_TEXT_COL'
]
const data = Array.from({ length: 10 }, (_, i) => ({
PRIMARY_KEY_FIELD: i + 1,
A_COL: i + 1,
B_COL: 10,
FORMULA_HARD_COL: '',
PLAIN_TEXT_COL: `note-${i + 1}`
}))
data.forEach((row: any, i) => {
row.FORMULA_HARD_COL = parseFormulaRule('=A_COL * B_COL', {
columnNames,
rowIndex: i,
userName: 'test',
origValue: undefined
})
})
const hot = new Handsontable(document.createElement('div'), {
data,
columns: columnNames.map((c) => ({ data: c })),
formulas: { engine: HyperFormula, licenseKey: 'gpl-v3' },
multiColumnSorting: true,
licenseKey: 'non-commercial-and-evaluation'
})
hot.render()
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
sortPlugin.sort({
column: columnNames.indexOf('PLAIN_TEXT_COL'),
sortOrder: 'desc'
})
hot.render()
return hot
}
const formulaHardColValues = (hot: Handsontable): any[] =>
Array.from({ length: 10 }, (_, r) =>
hot.getDataAtRowProp(r, 'FORMULA_HARD_COL')
)
it('demonstrates the failure mode: updateSettings while sorted corrupts formula cells', () => {
const hot = buildSortedGrid()
hot.updateSettings({}, false)
hot.render()
expect(formulaHardColValues(hot)).toContain('#REF!')
hot.destroy()
})
it('clearing the sort before updateSettings and restoring it after avoids the corruption', () => {
const hot = buildSortedGrid()
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
const sortConfigs = normalizeSortConfig(sortPlugin.getSortConfig())
sortPlugin.clearSort()
hot.updateSettings({}, false)
hot.render()
if (sortConfigs.length > 0) sortPlugin.sort(sortConfigs)
hot.render()
expect(formulaHardColValues(hot)).not.toContain('#REF!')
hot.destroy()
})
})
/**
* multiColumnSorting's own JSDoc: "every call of `sort` function set an
* entirely new sort order. Previous sort configs aren't preserved." A loop
* calling sort() once per captured config - the shape editor.component.ts
* used before this fix, in updateSettingsSortSafe/editTable/cancelEdit's
* restore step - therefore doesn't accumulate a multi-column sort: each
* call replaces the last, so only the FINAL config in the array survives.
* Restoring a captured multi-column sort must pass the whole array to a
* single sort() call instead.
*/
describe('restoring a multi-column sort must apply as a single call, not a loop', () => {
const columnNames = ['PRIMARY_KEY_FIELD', 'GROUP_COL', 'VALUE_COL']
const buildGrid = (): Handsontable => {
const data = [
{ PRIMARY_KEY_FIELD: 1, GROUP_COL: 'B', VALUE_COL: 2 },
{ PRIMARY_KEY_FIELD: 2, GROUP_COL: 'A', VALUE_COL: 1 },
{ PRIMARY_KEY_FIELD: 3, GROUP_COL: 'A', VALUE_COL: 3 },
{ PRIMARY_KEY_FIELD: 4, GROUP_COL: 'B', VALUE_COL: 4 }
]
const hot = new Handsontable(document.createElement('div'), {
data,
columns: columnNames.map((c) => ({ data: c })),
multiColumnSorting: true,
licenseKey: 'non-commercial-and-evaluation'
})
hot.render()
return hot
}
// Sort by GROUP_COL asc, then VALUE_COL desc within each group.
const sortConfigs = [
{ column: 1, sortOrder: 'asc' },
{ column: 2, sortOrder: 'desc' }
]
const visiblePkOrder = (hot: Handsontable): number[] =>
Array.from(
{ length: 4 },
(_, r) => hot.getDataAtRowProp(r, 'PRIMARY_KEY_FIELD') as number
)
it('demonstrates the failure mode: looping sort() per column loses every column but the last', () => {
const hot = buildGrid()
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
for (const sc of sortConfigs) sortPlugin.sort(sc)
hot.render()
// GROUP_COL asc got wiped out by the second call - only VALUE_COL desc
// (the last config) survived, sorting the whole table by value alone.
expect(visiblePkOrder(hot)).toEqual([4, 3, 1, 2])
hot.destroy()
})
it('applying the full config array in one call restores the actual multi-column order', () => {
const hot = buildGrid()
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
sortPlugin.sort(sortConfigs)
hot.render()
// Group A first (value desc: 3, 1), then group B (value desc: 4, 2).
expect(visiblePkOrder(hot)).toEqual([3, 2, 4, 1])
hot.destroy()
})
})
/**
* getFormulaCellsToPreserveOnCancel's rowIndex parameter is established as
* PHYSICAL (it iterates 0..dataSource.length, matching dataSource's own
* order - see the file's own docblock). cancelEdit() passes that rowIndex
* straight into commentsPlugin.getCommentAtCell and hot.getDataAtRowProp,
* both of which - same as updateEditStatusForRow/syncOverwrittenCommentForCell
* above - document a VISUAL row. On a sorted grid this both checks and
* reads the wrong row's cell: a row that actually has a comment can go
* unflagged while a different row gets wrongly flagged, carrying that other
* row's live value onto its own prop - corrupting cancelEdit()'s restore
* rather than just skipping it. The fix is to clear the sort before this
* runs at all (cancelEdit() now does this - see its own comment), rather
* than translate physical->visual per call, since dataSourceUnchanged's
* restore right after also needs an unsorted physical dataSource to index
* into.
*/
describe('getFormulaCellsToPreserveOnCancel callbacks resolve the correct cell on a sorted grid', () => {
const formulaBaseCols = ['FORMULA_HARD_COL']
const setup = (): { hot: Handsontable } => {
const dataSource = [
{ PRIMARY_KEY_FIELD: 1, SOME_CHAR: 'b', FORMULA_HARD_COL: 10 },
{ PRIMARY_KEY_FIELD: 2, SOME_CHAR: 'a', FORMULA_HARD_COL: 20 }
]
const hot = new Handsontable(document.createElement('div'), {
data: dataSource,
columns: [
{ data: 'PRIMARY_KEY_FIELD' },
{ data: 'SOME_CHAR' },
{ data: 'FORMULA_HARD_COL' }
],
multiColumnSorting: true,
comments: true,
licenseKey: 'non-commercial-and-evaluation'
})
hot.render()
// Physical row 0 (PK=1) has the comment/live value that must be
// preserved. Ascending by SOME_CHAR flips it to visual row 1; physical
// row 1 (PK=2, no comment) becomes visual row 0.
const commentsPlugin: any = hot.getPlugin('comments')
commentsPlugin.setCommentAtCell(0, 2, 'Original value: 5')
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
sortPlugin.sort({ column: 1, sortOrder: 'asc' })
hot.render()
return { hot }
}
it('demonstrates the failure mode: physical rowIndex passed straight to visual-row APIs resolves the wrong cell', () => {
const { hot } = setup()
const commentsPlugin: any = hot.getPlugin('comments')
const toPreserve = getFormulaCellsToPreserveOnCancel(
2,
formulaBaseCols,
(rowIndex, baseCol) =>
!!commentsPlugin.getCommentAtCell(rowIndex, hot.propToCol(baseCol)),
(rowIndex, prop) => hot.getDataAtRowProp(rowIndex, prop)
)
// Physical row 0's comment lives at visual row 1 post-sort, but the
// buggy call checked physical rowIndex 0 straight as a visual row -
// landing on physical row 1's cell (no comment, value 20) instead.
// rowIndex 1 then wrongly reads AS visual row 1, which is physical row
// 0's actual commented cell (value 10) - so the wrong row (1, not 0)
// gets flagged, carrying the wrong row's value.
expect(toPreserve).toEqual([
{ rowIndex: 1, prop: 'FORMULA_HARD_COL', value: 10 }
])
hot.destroy()
})
it('resolves the correct cell once the sort is cleared before reading', () => {
const { hot } = setup()
const commentsPlugin: any = hot.getPlugin('comments')
const sortPlugin: any = hot.getPlugin('multiColumnSorting')
const sortConfigs = normalizeSortConfig(sortPlugin.getSortConfig())
sortPlugin.clearSort()
const toPreserve = getFormulaCellsToPreserveOnCancel(
2,
formulaBaseCols,
(rowIndex, baseCol) =>
!!commentsPlugin.getCommentAtCell(rowIndex, hot.propToCol(baseCol)),
(rowIndex, prop) => hot.getDataAtRowProp(rowIndex, prop)
)
expect(toPreserve).toEqual([
{ rowIndex: 0, prop: 'FORMULA_HARD_COL', value: 10 }
])
for (const sc of sortConfigs) sortPlugin.sort(sc)
hot.destroy()
})
})
+134 -51
View File
@@ -5,6 +5,11 @@
<div class="card-text"> <div class="card-text">
<ng-container *ngSwitchCase="'key'"> <ng-container *ngSwitchCase="'key'">
<p class="key-error" *ngIf="!keyError"> <p class="key-error" *ngIf="!keyError">
<clr-icon
class="is-error"
shape="exclamation-circle"
size="26"
></clr-icon>
Licence key is invalid. We can't provide you more details at the Licence key is invalid. We can't provide you more details at the
moment moment
</p> </p>
@@ -20,6 +25,11 @@
<ng-container *ngSwitchCase="'limit'"> <ng-container *ngSwitchCase="'limit'">
<p class="key-error"> <p class="key-error">
<clr-icon
class="is-error"
shape="exclamation-circle"
size="26"
></clr-icon>
The registered number of users reached the limit specified for your The registered number of users reached the limit specified for your
licence. Please contact licence. Please contact
<contact-link classes="color-green" /> <contact-link classes="color-green" />
@@ -34,9 +44,9 @@
</p> </p>
</ng-container> </ng-container>
<p><strong>Protocol:</strong> {{ protocol }}</p> <p class="m-0 mt-10"><strong>Protocol:</strong> {{ protocol }}</p>
<p> <p class="m-0">
<strong>SYSSITE:</strong> <strong>SYSSITE:</strong>
<span <span
*ngFor="let id of syssite.value; let i = index" *ngFor="let id of syssite.value; let i = index"
@@ -59,11 +69,6 @@
</a> </a>
</p> </p>
<p *ngIf="licenseKeyData && userCountLimitation" class="m-0">
<strong>Allowed users:</strong>
{{ licenseKeyData.users_allowed }}
</p>
<clr-tabs> <clr-tabs>
<clr-tab> <clr-tab>
<button clrTabLink>Upload licence</button> <button clrTabLink>Upload licence</button>
@@ -102,56 +107,102 @@
<clr-tab> <clr-tab>
<button clrTabLink>Paste licence</button> <button clrTabLink>Paste licence</button>
<clr-tab-content> <clr-tab-content>
<form class="clr-form license-key-form"> <ng-container *ngIf="keyFormat === 'combined'">
<p>Licence key:</p> <form class="clr-form combined-key-form">
<div class="clr-control-container"> <p>Licence key:</p>
<textarea <div class="clr-control-container">
[(ngModel)]="licenceKeyValue" <textarea
(mouseleave)="trimKeys()" [(ngModel)]="combinedKeyValue"
name="license-key-area" (mouseleave)="onCombinedKeyInput()"
placeholder="Paste licence key here" name="combined-key-area"
class="clr-textarea" placeholder="Paste licence key here"
></textarea> class="clr-textarea"
</div> ></textarea>
</form> </div>
</form>
<form class="clr-form activation-key-form"> <button
<p>Activation key:</p> type="button"
<div class="clr-control-container"> class="btn btn-sm btn-link p-0"
<textarea (click)="toggleKeyFormat()"
[(ngModel)]="activationKeyValue" >
(mouseleave)="trimKeys()" Paste as two separate keys instead
name="activation-key-area" </button>
placeholder="Paste activation key here" </ng-container>
class="clr-textarea"
></textarea> <ng-container *ngIf="keyFormat === 'legacy'">
</div> <form class="clr-form license-key-form">
</form> <p>Licence key:</p>
<div class="clr-control-container">
<textarea
[(ngModel)]="licenceKeyValue"
(mouseleave)="trimKeys()"
name="license-key-area"
placeholder="Paste licence key here"
class="clr-textarea"
></textarea>
</div>
</form>
<form class="clr-form activation-key-form">
<p>Activation key:</p>
<div class="clr-control-container">
<textarea
[(ngModel)]="activationKeyValue"
(mouseleave)="trimKeys()"
name="activation-key-area"
placeholder="Paste activation key here"
class="clr-textarea"
></textarea>
</div>
</form>
<button
type="button"
class="btn btn-sm btn-link p-0"
(click)="toggleKeyFormat()"
>
Paste as a single key instead
</button>
</ng-container>
</clr-tab-content> </clr-tab-content>
</clr-tab> </clr-tab>
</clr-tabs> </clr-tabs>
<p <!--
class="key-error protocol-mismatch-warning" licenseKeyData starts as whatever key is currently active (set once
*ngIf="protocolMismatch === 'requiresHttps'" in ngOnInit), then live-updates to preview a pasted-but-not-yet-
> applied key's own details instead - see refreshKeyPreview().
This key was generated for a secure (HTTPS) connection, but -->
DataController is currently running over HTTP - it will not activate <div *ngIf="licenseKeyData" class="key-details">
here. Access DataController via HTTPS, or contact <h6 cds-text="subsection" class="mt-15 mb-10">Key Details</h6>
<contact-link classes="color-green" />
for an HTTP-compatible key.
</p>
<p <p class="m-0">
class="key-error protocol-mismatch-warning" <strong>Valid until:</strong>
*ngIf="protocolMismatch === 'requiresHttp'" {{ licenseKeyData.valid_until }}
> <span *ngIf="licenseKeyData.demo">(demo/free tier key)</span>
This key was generated for an insecure (HTTP) connection, but this page </p>
is running in a secure browsing context (HTTPS, or localhost) - it will
not activate here. Contact <p class="m-0">
<contact-link classes="color-green" /> <strong>Allowed users:</strong>
for an HTTPS-compatible key. {{ licenseKeyData.users_allowed }}
</p> </p>
<p class="m-0">
<strong>Site ID(s) in this key:</strong>
{{
(licenseKeyData.site_id_multiple?.length
? licenseKeyData.site_id_multiple
: [licenseKeyData.site_id]
).join(', ')
}}
</p>
<p *ngIf="enabledFeatures.length" class="m-0">
<strong>Enabled features:</strong>
{{ enabledFeatures.join(', ') }}
</p>
</div>
</div> </div>
<div class="card-footer d-flex clr-align-items-center"> <div class="card-footer d-flex clr-align-items-center">
@@ -172,6 +223,38 @@
Continue with free tier Continue with free tier
</button> </button>
</div> </div>
<p
class="key-error protocol-mismatch-warning"
*ngIf="protocolMismatch === 'requiresHttps'"
>
<clr-icon
class="color-orange"
shape="exclamation-triangle"
size="26"
></clr-icon>
This key was generated for a secure (HTTPS) connection, but DataController
is currently running over HTTP - it will not activate here. Access
DataController via HTTPS, or contact
<contact-link classes="color-green" />
for an HTTP-compatible key.
</p>
<p
class="key-error protocol-mismatch-warning"
*ngIf="protocolMismatch === 'requiresHttp'"
>
<clr-icon
class="color-orange"
shape="exclamation-triangle"
size="26"
></clr-icon>
This key was generated for an insecure (HTTP) connection, but this page is
running in a secure browsing context (HTTPS, or localhost) - it will not
activate here. Contact
<contact-link classes="color-green" />
for an HTTPS-compatible key.
</p>
</div> </div>
</div> </div>
@@ -0,0 +1,7 @@
.key-error clr-icon {
// clr-icon defaults to vertical-align: middle, which sits it noticeably
// above the text baseline next to it - align its bottom edge with the
// text's instead.
vertical-align: bottom;
margin-right: 10px;
}
+127 -14
View File
@@ -1,4 +1,5 @@
import { Component, OnInit, ViewEncapsulation } from '@angular/core' import { Component, OnInit, ViewEncapsulation } from '@angular/core'
import { DomSanitizer, SafeHtml } from '@angular/platform-browser'
import { ActivatedRoute, Router } from '@angular/router' import { ActivatedRoute, Router } from '@angular/router'
import { AppService, LicenceService, SasService } from '../services' import { AppService, LicenceService, SasService } from '../services'
import { LicenseKeyData } from '../models/LicenseKeyData' import { LicenseKeyData } from '../models/LicenseKeyData'
@@ -7,6 +8,11 @@ import {
detectLicenceKeyProtocolMismatch, detectLicenceKeyProtocolMismatch,
LicenceKeyProtocolMismatch LicenceKeyProtocolMismatch
} from './utils/detectLicenceKeyProtocolMismatch' } from './utils/detectLicenceKeyProtocolMismatch'
import {
isCombinedLicenceKey,
splitCombinedLicenceKey
} from './utils/combinedLicenceKey'
import { getEnabledFeatureLabels } from './utils/getEnabledFeatureLabels'
enum LicenseActions { enum LicenseActions {
key = 'key', key = 'key',
@@ -25,12 +31,19 @@ enum LicenseActions {
export class LicensingComponent implements OnInit { export class LicensingComponent implements OnInit {
public action: LicenseActions | null = null public action: LicenseActions | null = null
public licenseErrors: { [key: string]: string } = { // Each message carries its own icon markup, rather than relying on a
missing: `Licence key is missing - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.`, // sibling element in the template - these render via [innerHTML], which
expired: `Licence key is expired - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.`, // replaces all of the host element's children, so a real <clr-icon>
invalid: `Licence key is invalid - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.`, // placed in the template around the binding would never survive.
missmatch: `Your SYSSITE (below) is not found in the licence key - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.` private readonly errorIcon = `<clr-icon class="is-error" shape="exclamation-circle" size="26"></clr-icon>`
}
// SafeHtml, built via bypassSecurityTrustHtml in the constructor (needs
// DomSanitizer, not yet available in a field initializer) - Angular's
// default [innerHTML] sanitizer strips unrecognised tags like <clr-icon>
// (a custom element, not on its standard-tags allowlist), even though it
// leaves the plain <a> in these same strings alone. Safe to bypass since
// this content is entirely hardcoded here, never derived from user input.
public licenseErrors: { [key: string]: SafeHtml }
public keyError: string | undefined public keyError: string | undefined
public errorDetails: string | undefined public errorDetails: string | undefined
@@ -38,6 +51,12 @@ export class LicensingComponent implements OnInit {
public licenceKeyValue: string = '' public licenceKeyValue: string = ''
public activationKeyValue: string = '' public activationKeyValue: string = ''
// Purely which INPUT LAYOUT is shown (one field vs two) - not a strict
// parsing gate. Recognising a combined key doesn't depend on this: see
// maybeSplitCombinedKey(), called from both layouts' own input handlers.
public keyFormat: 'combined' | 'legacy' = 'combined'
public combinedKeyValue: string = ''
public applyingKeys: boolean = false public applyingKeys: boolean = false
public protocol: string = public protocol: string =
location.protocol === 'https:' location.protocol === 'https:'
@@ -48,7 +67,6 @@ export class LicensingComponent implements OnInit {
public currentLicenceKey = this.licenceService.licenceKey public currentLicenceKey = this.licenceService.licenceKey
public currentActivationKey = this.licenceService.activationKey public currentActivationKey = this.licenceService.activationKey
public isAppFreeTier = this.licenceService.isAppFreeTier public isAppFreeTier = this.licenceService.isAppFreeTier
public userCountLimitation = this.licenceService.userCountLimitation
public licenseKeyData: LicenseKeyData | null = null public licenseKeyData: LicenseKeyData | null = null
@@ -64,8 +82,24 @@ export class LicensingComponent implements OnInit {
private router: Router, private router: Router,
private licenceService: LicenceService, private licenceService: LicenceService,
private sasService: SasService, private sasService: SasService,
private appService: AppService private appService: AppService,
) {} private sanitizer: DomSanitizer
) {
this.licenseErrors = {
missing: this.sanitizer.bypassSecurityTrustHtml(
`${this.errorIcon} Licence key is missing - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.`
),
expired: this.sanitizer.bypassSecurityTrustHtml(
`${this.errorIcon} Licence key is expired - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.`
),
invalid: this.sanitizer.bypassSecurityTrustHtml(
`${this.errorIcon} Licence key is invalid - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.`
),
missmatch: this.sanitizer.bypassSecurityTrustHtml(
`${this.errorIcon} Your SYSSITE (below) is not found in the licence key - please contact <a class="color-green" href="mailto: support@datacontroller.io">support@datacontroller.io</a> and enter valid keys below.`
)
}
}
ngOnInit(): void { ngOnInit(): void {
this.licenceKeyValue = this.currentLicenceKey || '' this.licenceKeyValue = this.currentLicenceKey || ''
@@ -93,9 +127,73 @@ export class LicensingComponent implements OnInit {
this.licenseKeyData = this.licenceService.getLicenseKeyData() this.licenseKeyData = this.licenceService.getLicenseKeyData()
} }
public trimKeys() { public async trimKeys() {
this.licenceKeyValue = this.licenceKeyValue.trim() this.licenceKeyValue = this.licenceKeyValue.trim()
this.activationKeyValue = this.activationKeyValue.trim() this.activationKeyValue = this.activationKeyValue.trim()
// Auto-detect regardless of keyFormat - a combined key pasted into the
// legacy "Licence key" field on its own still gets recognised and
// splits into both fields, rather than requiring the toggle to match.
await this.maybeSplitCombinedKey(this.licenceKeyValue)
await this.refreshKeyPreview()
}
public async onCombinedKeyInput() {
this.combinedKeyValue = this.combinedKeyValue.trim()
// The combined field is the sole source of truth for
// licenceKeyValue/activationKeyValue in this layout - if it's been
// cleared (or isn't a recognisable combined key), there's no key data
// to preview, so clear rather than leave a stale split from an earlier
// paste (which would otherwise keep decrypting to that old key).
const wasSplit = await this.maybeSplitCombinedKey(this.combinedKeyValue)
if (!wasSplit) {
this.licenceKeyValue = ''
this.activationKeyValue = ''
}
await this.refreshKeyPreview()
}
// Decrypts whatever's currently in licenceKeyValue/activationKeyValue
// purely to preview its details (valid_until, users_allowed, ...) before
// the user ever clicks Apply - decryptLicenseKey() has no side effects,
// so this is safe to call speculatively on every input change. Clears
// rather than leaves stale data on failure/incomplete input, since
// showing a previous key's details next to a since-changed paste would
// be actively misleading, not just uninformative.
private async refreshKeyPreview(): Promise<void> {
if (!this.licenceKeyValue || !this.activationKeyValue) {
this.licenseKeyData = null
return
}
try {
this.licenseKeyData = await this.licenceService.decryptLicenseKey(
this.licenceKeyValue,
this.activationKeyValue
)
} catch {
this.licenseKeyData = null
}
}
public toggleKeyFormat() {
this.keyFormat = this.keyFormat === 'combined' ? 'legacy' : 'combined'
}
// Shared by both input layouts' own handlers above - populates
// licenceKeyValue/activationKeyValue when value is recognisably a
// combined key, regardless of which field it was typed/pasted into.
private async maybeSplitCombinedKey(value: string): Promise<boolean> {
if (!isCombinedLicenceKey(value)) return false
const split = await splitCombinedLicenceKey(value)
if (!split) return false
this.licenceKeyValue = split.licenceKey
this.activationKeyValue = split.activationKey
return true
} }
public copySyssite(copyIconRef: any, copyTooltip: any, syssite: string[]) { public copySyssite(copyIconRef: any, copyTooltip: any, syssite: string[]) {
@@ -154,7 +252,7 @@ export class LicensingComponent implements OnInit {
const reader = new FileReader() const reader = new FileReader()
reader.onload = (evt) => { reader.onload = async (evt) => {
this.licenceFileError = 'Error reading file.' this.licenceFileError = 'Error reading file.'
if (!evt || !evt.target) return if (!evt || !evt.target) return
@@ -164,9 +262,20 @@ export class LicensingComponent implements OnInit {
this.licenceFileLoading = false this.licenceFileLoading = false
this.licenceFileError = undefined this.licenceFileError = undefined
const fileArr = evt.target.result.toString().split('\n')
this.activationKeyValue = fileArr[1] const fileArr = evt.target.result.toString().trim().split('\n')
this.licenceKeyValue = fileArr[0]
// A combined-key file is a single line - splits into both fields.
// Anything else keeps the existing 2-line legacy file behaviour.
if (
fileArr.length !== 1 ||
!(await this.maybeSplitCombinedKey(fileArr[0]))
) {
this.activationKeyValue = fileArr[1]
this.licenceKeyValue = fileArr[0]
}
await this.refreshKeyPreview()
} }
reader.readAsText(file) reader.readAsText(file)
@@ -205,4 +314,8 @@ export class LicensingComponent implements OnInit {
!!(window.crypto && window.crypto.subtle) !!(window.crypto && window.crypto.subtle)
) )
} }
get enabledFeatures(): string[] {
return getEnabledFeatureLabels(this.licenseKeyData?.features)
}
} }
@@ -0,0 +1,90 @@
import * as base64Converter from 'base64-arraybuffer'
import {
COMBINED_KEY_PREFIX,
isCombinedLicenceKey,
splitCombinedLicenceKey
} from './combinedLicenceKey'
// Mirrors dckey's own encodeCombinedKey() (main.js) exactly, so these tests
// build fixtures the same way a real generated key would be produced,
// rather than relying on a hardcoded string that could go stale if either
// side's algorithm ever changes.
const gzipCompress = async (bytes: Uint8Array): Promise<ArrayBuffer> => {
const compressionStream = new CompressionStream('gzip')
const writer = compressionStream.writable.getWriter()
writer.write(new Uint8Array(bytes))
writer.close()
return new Response(compressionStream.readable).arrayBuffer()
}
const encodeCombinedLicenceKeyFixture = async (
licenceKey: string,
activationKey: string
): Promise<string> => {
const payloadBytes = new TextEncoder().encode(
`${licenceKey} ${activationKey}`
)
const compressedBytes = await gzipCompress(payloadBytes)
return COMBINED_KEY_PREFIX + base64Converter.encode(compressedBytes)
}
describe('isCombinedLicenceKey', () => {
it('is true for prefixed text', () => {
expect(isCombinedLicenceKey('DCKEY1:abc123')).toBeTrue()
})
it('is false for a plain legacy key', () => {
expect(isCombinedLicenceKey('some-legacy-licence-key')).toBeFalse()
})
it('is false for an empty string', () => {
expect(isCombinedLicenceKey('')).toBeFalse()
})
it('is true even with leading/trailing whitespace around the prefix', () => {
expect(isCombinedLicenceKey(' DCKEY1:abc123 ')).toBeTrue()
})
})
describe('splitCombinedLicenceKey', () => {
it('round-trips a fixture built the same way dckey encodes one', async () => {
const combined = await encodeCombinedLicenceKeyFixture(
'licence-key-value',
'activation-key-value'
)
expect(await splitCombinedLicenceKey(combined)).toEqual({
licenceKey: 'licence-key-value',
activationKey: 'activation-key-value'
})
})
it('returns null for text without the prefix', async () => {
expect(
await splitCombinedLicenceKey('a-plain-legacy-licence-key')
).toBeNull()
})
it('rejects for prefixed text that is not valid compressed data', async () => {
await expectAsync(
splitCombinedLicenceKey('DCKEY1:not-valid-base64-gzip-data')
).toBeRejected()
})
it('splits on the first space only, not every space', async () => {
// Not a real-world value today (licence/activation keys are base64,
// which never contains a space) - guards the split logic itself rather
// than that assumption.
const combined = await encodeCombinedLicenceKeyFixture(
'licence key with spaces',
'activation-key-value'
)
expect(await splitCombinedLicenceKey(combined)).toEqual({
licenceKey: 'licence',
activationKey: 'key with spaces activation-key-value'
})
})
})
@@ -0,0 +1,83 @@
import * as base64Converter from 'base64-arraybuffer'
/**
* Format produced by dckey's own encodeCombinedKey() (main.js):
* "DCKEY1:" + base64(gzip(licenceKey + " " + activationKey)). The prefix is
* plain ASCII, not itself compressed/encoded - base64's alphabet never
* contains ":", so it can never collide with the start of a legacy licence
* key or activation key, making format detection unambiguous.
*/
export const COMBINED_KEY_PREFIX = 'DCKEY1:'
export const isCombinedLicenceKey = (text: string): boolean =>
text.trim().startsWith(COMBINED_KEY_PREFIX)
const streamToArrayBuffer = async (
readable: ReadableStream<Uint8Array>
): Promise<ArrayBuffer> => {
const reader = readable.getReader()
const chunks: Uint8Array[] = []
let totalLength = 0
while (true) {
const { done, value } = await reader.read()
if (done) break
chunks.push(value)
totalLength += value.length
}
const result = new Uint8Array(totalLength)
let offset = 0
for (const chunk of chunks) {
result.set(chunk, offset)
offset += chunk.length
}
return result.buffer
}
const gzipDecompress = async (bytes: ArrayBuffer): Promise<ArrayBuffer> => {
const decompressionStream = new DecompressionStream('gzip')
const writer = decompressionStream.writable.getWriter()
// Awaited (unlike a fire-and-forget write) so invalid gzip data rejects
// through this function's own returned promise, not as a separate
// unhandled rejection racing the readable side below.
const result = await Promise.all([
writer.write(new Uint8Array(bytes)).then(() => writer.close()),
streamToArrayBuffer(decompressionStream.readable)
])
return result[1]
}
/**
* Splits a combined licence key back into its two parts. Returns null (not
* a rejected promise) when text isn't a combined key at all, so callers can
* use it as a "try this, then fall back to the legacy two-field input" check
* without a try/catch for that common case - a prefixed-but-corrupted
* string still rejects, since that's a real error, not a format mismatch.
*/
export const splitCombinedLicenceKey = async (
text: string
): Promise<{ licenceKey: string; activationKey: string } | null> => {
const trimmed = text.trim()
if (!isCombinedLicenceKey(trimmed)) return null
const compressedBytes = base64Converter.decode(
trimmed.slice(COMBINED_KEY_PREFIX.length)
)
const decompressedBytes = await gzipDecompress(compressedBytes)
const payload = new TextDecoder().decode(decompressedBytes)
const separatorIndex = payload.indexOf(' ')
if (separatorIndex === -1) {
throw new Error('Invalid combined licence key: missing separator')
}
return {
licenceKey: payload.slice(0, separatorIndex),
activationKey: payload.slice(separatorIndex + 1)
}
}
@@ -11,6 +11,10 @@ export type LicenceKeyProtocolMismatch = 'requiresHttps' | 'requiresHttp' | null
* alone tells us which format a pasted key is, without needing to attempt * alone tells us which format a pasted key is, without needing to attempt
* decryption first. * decryption first.
* *
* This is a structural assumption about key-generation logic
* (a separate repo) - if that ever changes to generate distinct values for
* HTTP-format keys too, this detection would silently misclassify keys.
*
* isSecureContext must reflect whether this browsing context can actually * isSecureContext must reflect whether this browsing context can actually
* decrypt a secure-connection key (mirrors the check licence.service.ts's * decrypt a secure-connection key (mirrors the check licence.service.ts's
* own decryptLicenseKey() makes) - not simply `location.protocol === * own decryptLicenseKey() makes) - not simply `location.protocol ===
@@ -0,0 +1,73 @@
import { getEnabledFeatureLabels } from './getEnabledFeatureLabels'
describe('getEnabledFeatureLabels', () => {
it('returns an empty list when features is undefined', () => {
expect(getEnabledFeatureLabels(undefined)).toEqual([])
})
it('lists only the enabled toggle features from a new-format object', () => {
expect(
getEnabledFeatureLabels({
vra: null,
era: null,
sra: null,
hra: null,
srl: null,
till: null,
vb: true,
vbl: null,
ldl: null,
fu: false,
er: true,
ar: false
})
).toEqual(['Viewbox', 'Edit Record'])
})
it('lists all four when every toggle is enabled', () => {
expect(
getEnabledFeatureLabels({
vra: null,
era: null,
sra: null,
hra: null,
srl: null,
till: null,
vb: true,
vbl: null,
ldl: null,
fu: true,
er: true,
ar: true
})
).toEqual(['Viewbox', 'File Upload', 'Edit Record', 'Add Record'])
})
it('returns an empty list when every toggle is disabled', () => {
expect(
getEnabledFeatureLabels({
vra: null,
era: null,
sra: null,
hra: null,
srl: null,
till: null,
vb: false,
vbl: null,
ldl: null,
fu: false,
er: false,
ar: false
})
).toEqual([])
})
it('decodes a legacy positional string the same way', () => {
// viewbox=1 (position 6), fileUpload=0 (position 9), editRecord=1
// (position 10), addRecord=0 (position 11) - see LicenceFeaturesMap.
expect(getEnabledFeatureLabels('-,-,-,-,-,-,1,-,-,0,1,0')).toEqual([
'Viewbox',
'Edit Record'
])
})
})
@@ -0,0 +1,24 @@
import {
decodeLicenceFeatures,
LicenceFeaturesObject
} from '../../services/utils/decodeLicenceFeatures'
import { LicenceState } from '../../models/LicenceState'
const TOGGLE_FEATURE_LABELS: { key: keyof LicenceState; label: string }[] = [
{ key: 'viewbox', label: 'Viewbox' },
{ key: 'fileUpload', label: 'File Upload' },
{ key: 'editRecord', label: 'Edit Record' },
{ key: 'addRecord', label: 'Add Record' }
]
export const getEnabledFeatureLabels = (
features: string | LicenceFeaturesObject | undefined
): string[] => {
if (!features) return []
const decoded = decodeLicenceFeatures(features)
return TOGGLE_FEATURE_LABELS.filter(({ key }) => decoded[key]).map(
({ label }) => label
)
}
+1
View File
@@ -10,5 +10,6 @@ export class AbortDetails {
SYSWARNINGTEXT?: string SYSWARNINGTEXT?: string
SYSERRORTEXT?: string SYSERRORTEXT?: string
MAC?: string MAC?: string
_PROGRAM?: string
LOG?: string LOG?: string
} }
+5
View File
@@ -15,6 +15,11 @@ export interface LicenceState {
} }
/** /**
* Legacy-format decode table only - newly-issued keys use a named
* LicenceFeaturesObject instead (see decodeLicenceFeatures.ts). Kept
* unchanged and permanently, since every already-issued key still relies
* on these ordinal positions to decode.
*
* '-' means unset * '-' means unset
* '0' disabled * '0' disabled
* '1' enabled * '1' enabled
+3 -1
View File
@@ -1,3 +1,5 @@
import { LicenceFeaturesObject } from '../services/utils/decodeLicenceFeatures'
export interface LicenseKeyData { export interface LicenseKeyData {
valid_until: string valid_until: string
users_allowed: number users_allowed: number
@@ -5,5 +7,5 @@ export interface LicenseKeyData {
site_id_multiple: string[] site_id_multiple: string[]
demo: boolean demo: boolean
hot_license_key: string | undefined hot_license_key: string | undefined
features?: string features?: string | LicenceFeaturesObject
} }
@@ -217,7 +217,9 @@ export class ApproveDetailsComponent implements AfterViewInit, OnDestroy {
} }
public calcDiff() { public calcDiff() {
if (!this.response) return // params-only responses (e.g. already reviewed submissions) carry no diff
// tables - nothing to calculate, the details header still renders
if (!this.response || !this.response.cols) return
let news = this.response.new let news = this.response.new
let updates = this.response.updates let updates = this.response.updates
@@ -355,26 +357,6 @@ export class ApproveDetailsComponent implements AfterViewInit, OnDestroy {
this.submitArr.push(item) this.submitArr.push(item)
} }
} }
let diffs = {
ACTION: 'SHOW_DIFFS',
TABLE: this.tableId,
DIFFTIME: new Date().toUTCString()
}
// show diffs and changes info in a same call
this.sasStoreService
.showDiffs(diffs, 'SASControlTable', 'auditors/postdata')
.then((res: AuditorsPostdataSASResponse) => {
let param = res.params[0]
this.params = param
this.response = res
this.calcDiff()
this.callChangesInfo(this.tableId)
})
.catch((err: any) => err)
.finally(() => {
this.loadingTable = true
})
} }
) )
if (typeof this.router.snapshot.params['tableId'] === 'undefined') { if (typeof this.router.snapshot.params['tableId'] === 'undefined') {
@@ -68,6 +68,9 @@ export class SubmitterComponent implements OnInit, AfterViewInit {
} }
public goToDetails(table_id: any) { public goToDetails(table_id: any) {
// the details URL re-creates this component - carry the queue payload
// over so it is not fetched again on mount
this.sasStoreService.handoffSubmits(this.submitData)
this.router.navigateByUrl('/review/submitted/' + table_id) this.router.navigateByUrl('/review/submitted/' + table_id)
} }
@@ -83,14 +86,19 @@ export class SubmitterComponent implements OnInit, AfterViewInit {
this.itemsNum = 10 this.itemsNum = 10
try { try {
let res = await this.sasStoreService.getSubmitts() // navigating from the submit list to a details URL re-creates this
// component - take the queue payload carried over by that navigation
// instead of fetching it again
let fromsas: any = this.sasStoreService.takeSubmitsHandoff()
this.remained = res.fromsas.length if (!fromsas) {
fromsas = (await this.sasStoreService.getSubmitts()).fromsas
}
this.remained = fromsas.length
if (this.remained > 0) { if (this.remained > 0) {
this.submitter = res.fromsas[0].SUBMITTED_BY_NM this.submitter = fromsas[0].SUBMITTED_BY_NM
let submitterList: SubmitterData[] = res.fromsas.map(function ( let submitterList: SubmitterData[] = fromsas.map(function (item: any) {
item: any
) {
return { return {
tableId: item.TABLE_ID, tableId: item.TABLE_ID,
base: item.BASE_TABLE, base: item.BASE_TABLE,
@@ -100,7 +108,7 @@ export class SubmitterComponent implements OnInit, AfterViewInit {
} }
}) })
this.submitterList = submitterList this.submitterList = submitterList
this.submitData = res.fromsas this.submitData = fromsas
// Details page // Details page
if (typeof tableIdParam !== 'undefined') { if (typeof tableIdParam !== 'undefined') {
+7 -2
View File
@@ -38,6 +38,9 @@ const buildDeps = () => {
const appStoreService: any = { const appStoreService: any = {
getDcAdapterSettings: () => undefined getDcAdapterSettings: () => undefined
} }
const startupCheckService: any = {
updateStep: jasmine.createSpy('updateStep')
}
return { return {
licenceService, licenceService,
@@ -46,7 +49,8 @@ const buildDeps = () => {
loggerService, loggerService,
appSettingsService, appSettingsService,
router, router,
appStoreService appStoreService,
startupCheckService
} }
} }
@@ -58,7 +62,8 @@ const buildAppService = (deps: ReturnType<typeof buildDeps>) =>
deps.loggerService, deps.loggerService,
deps.appSettingsService, deps.appSettingsService,
deps.router, deps.router,
deps.appStoreService deps.appStoreService,
deps.startupCheckService
) )
// Minimal valid startupservice payload — just enough to pass startUpData()'s // Minimal valid startupservice payload — just enough to pass startUpData()'s
+22 -1
View File
@@ -11,6 +11,7 @@ import { AppSettingsService } from './app-settings.service'
import { AppThemes } from '../models/AppSettings' import { AppThemes } from '../models/AppSettings'
import { RequestWrapperResponse } from '../models/request-wrapper/RequestWrapperResponse' import { RequestWrapperResponse } from '../models/request-wrapper/RequestWrapperResponse'
import { AppStoreService } from './app-store.service' import { AppStoreService } from './app-store.service'
import { StartupCheckService } from './startup-check.service'
import { retryOnce, RetryOnceOptions } from '../shared/utils/retry-once' import { retryOnce, RetryOnceOptions } from '../shared/utils/retry-once'
import { getMalformedAdapterResponseMessage } from '../shared/utils/get-malformed-adapter-response-message' import { getMalformedAdapterResponseMessage } from '../shared/utils/get-malformed-adapter-response-message'
@@ -29,7 +30,8 @@ export class AppService {
private loggerService: LoggerService, private loggerService: LoggerService,
private appSettingsService: AppSettingsService, private appSettingsService: AppSettingsService,
private router: Router, private router: Router,
private appStoreService: AppStoreService private appStoreService: AppStoreService,
private startupCheckService: StartupCheckService
) { ) {
this.subscribe() this.subscribe()
@@ -100,6 +102,11 @@ export class AppService {
) )
if (malformedMessage) { if (malformedMessage) {
startupServiceError = true startupServiceError = true
console.error(
'startUpData: startupservice returned malformed response:',
malformedMessage
)
this.startupCheckService.updateStep(2, 'error', 'Malformed response')
this.eventService.showInfoModal('Error', malformedMessage) this.eventService.showInfoModal('Error', malformedMessage)
this.licenceService.isAppActivated.next(false) this.licenceService.isAppActivated.next(false)
@@ -121,6 +128,15 @@ export class AppService {
if (missingProps.length > 0) { if (missingProps.length > 0) {
startupServiceError = true startupServiceError = true
console.error(
'startUpData: startupservice missing properties:',
missingProps.join(', ')
)
this.startupCheckService.updateStep(
2,
'error',
`Missing: ${missingProps.join(', ')}`
)
this.eventService.showInfoModal( this.eventService.showInfoModal(
'Error', 'Error',
`${missingProps.join(', ')} are not present in the startupservice` `${missingProps.join(', ')} are not present in the startupservice`
@@ -144,6 +160,9 @@ export class AppService {
SYSHOSTINFOLONG: res.adapterResponse.SYSHOSTINFOLONG, SYSHOSTINFOLONG: res.adapterResponse.SYSHOSTINFOLONG,
SYSENCODING: res.adapterResponse.SYSENCODING, SYSENCODING: res.adapterResponse.SYSENCODING,
AUTOEXEC: res.adapterResponse.AUTOEXEC, AUTOEXEC: res.adapterResponse.AUTOEXEC,
TIMEZONE: res.adapterResponse.globvars[0].TIMEZONE,
SYSTIMEZONEIDENT: res.adapterResponse.globvars[0].SYSTIMEZONEIDENT,
SYSTIMEZONEOFFSET: res.adapterResponse.globvars[0].SYSTIMEZONEOFFSET,
ISADMIN: res.adapterResponse.globvars[0].ISADMIN, ISADMIN: res.adapterResponse.globvars[0].ISADMIN,
DC_ADMIN_GROUP: res.adapterResponse.globvars[0].DC_ADMIN_GROUP, DC_ADMIN_GROUP: res.adapterResponse.globvars[0].DC_ADMIN_GROUP,
APP_LOC: dcAdapterSettings?.appLoc APP_LOC: dcAdapterSettings?.appLoc
@@ -198,6 +217,8 @@ export class AppService {
}) })
.catch((err: any) => { .catch((err: any) => {
startupServiceError = true startupServiceError = true
console.error('startUpData: startupservice request failed:', err)
this.startupCheckService.updateStep(2, 'error', 'Request failed')
this.eventService.showInfoModal( this.eventService.showInfoModal(
'Error', 'Error',
'There is an issue with startupservice response' 'There is an issue with startupservice response'
+17 -60
View File
@@ -10,7 +10,8 @@ import { Globvar } from '../models/sas/public-startupservice.model'
import { freeTierConfig } from '../free-tier.config' import { freeTierConfig } from '../free-tier.config'
import { AppStoreService } from './app-store.service' import { AppStoreService } from './app-store.service'
import { HelperService } from './helper.service' import { HelperService } from './helper.service'
import { LicenceFeaturesMap, LicenceState } from '../models/LicenceState' import { LicenceState } from '../models/LicenceState'
import { decodeLicenceFeatures as decodeFeatures } from './utils/decodeLicenceFeatures'
import { LoggerService } from './logger.service' import { LoggerService } from './logger.service'
import { EventService } from './event.service' import { EventService } from './event.service'
@@ -117,6 +118,13 @@ export class LicenceService {
let variables = globvars[0] let variables = globvars[0]
// Trim whitespace — the SAS makedata service initialises licence keys
// as a single space, which is truthy in JS but not a valid key.
if (variables.LICENCE_KEY)
variables.LICENCE_KEY = variables.LICENCE_KEY.trim()
if (variables.ACTIVATION_KEY)
variables.ACTIVATION_KEY = variables.ACTIVATION_KEY.trim()
if ( if (
variables.LICENCE_KEY === undefined || variables.LICENCE_KEY === undefined ||
variables.ACTIVATION_KEY === undefined || variables.ACTIVATION_KEY === undefined ||
@@ -255,9 +263,9 @@ export class LicenceService {
} }
/** /**
* Decode and set features that are encoded in the key * Decode and set features that are encoded in the key - accepts either
* featureValue - used as number/Infinity for limit set * an already-issued key's legacy positional string or a newly-issued
* featureToggle - used as boolean, based on 1 or 0 encoded in the key * key's named object, see decodeLicenceFeatures for the format contract.
* @param licenseData from the licence key * @param licenseData from the licence key
*/ */
private decodeLicenceFeatures(licenseData: LicenseKeyData) { private decodeLicenceFeatures(licenseData: LicenseKeyData) {
@@ -270,72 +278,21 @@ export class LicenceService {
} }
} }
const featuresMap = licenseData.features.split(',')
this._licenceState = { this._licenceState = {
...this._licenceState, ...this._licenceState,
viewer_rows_allowed: this.parseFeatureValue( ...decodeFeatures(licenseData.features)
featuresMap[LicenceFeaturesMap.viewer_rows_allowed]
),
editor_rows_allowed: this.parseFeatureValue(
featuresMap[LicenceFeaturesMap.editor_rows_allowed]
),
stage_rows_allowed: this.parseFeatureValue(
featuresMap[LicenceFeaturesMap.stage_rows_allowed]
),
history_rows_allowed: this.parseFeatureValue(
featuresMap[LicenceFeaturesMap.history_rows_allowed]
),
submit_rows_limit: this.parseFeatureValue(
featuresMap[LicenceFeaturesMap.submit_rows_limit]
),
tables_in_library_limit: this.parseFeatureValue(
featuresMap[LicenceFeaturesMap.tables_in_library_limit]
),
viewbox_limit: this.parseFeatureValue(
featuresMap[LicenceFeaturesMap.viewbox_limit]
),
lineage_daily_limit: this.parseFeatureValue(
featuresMap[LicenceFeaturesMap.lineage_daily_limit]
),
viewbox: this.parseFeatureToggle(featuresMap[LicenceFeaturesMap.viewbox]),
fileUpload: this.parseFeatureToggle(
featuresMap[LicenceFeaturesMap.fileUpload]
),
editRecord: this.parseFeatureToggle(
featuresMap[LicenceFeaturesMap.editRecord]
),
addRecord: this.parseFeatureToggle(
featuresMap[LicenceFeaturesMap.addRecord]
)
} }
this.loggerService.log('Licence state:', this._licenceState) this.loggerService.log('Licence state:', this._licenceState)
} }
/**
* Converts licence key feature code value to the number or Infinity
* Used for limiting rows, submits etc.
* @param codeBit from licence key encoded features. Every bit is separated by comma(,) Eg. 5,10,15
* @returns number
*/
private parseFeatureValue(codeBit: string): number {
if (codeBit === '-') return Infinity
return parseInt(codeBit)
}
/**
* Converts licence key feature code value to the boolean. Depending on if it's 0 or 1
* @param codeBit from licence key encoded features. Every bit is separated by comma(,) Eg. 1,1,0
* @returns boolean to turn on or off the value
*/
private parseFeatureToggle(codeBit: string): boolean {
return !!parseInt(codeBit)
}
/** /**
* If decryption fails, key will be marked as invalid and app not activated. * If decryption fails, key will be marked as invalid and app not activated.
* Public (not just used internally by licensing()) since it's a pure
* decrypt with no side effects - also used to preview a pasted key's
* details before it's actually applied.
*/ */
private decryptLicenseKey( public decryptLicenseKey(
licenseKey: string, licenseKey: string,
activationKey: string activationKey: string
): Promise<LicenseKeyData> { ): Promise<LicenseKeyData> {
@@ -35,6 +35,13 @@ export class SasStoreService {
public setSubmit: Subject<any> = new Subject<any>() public setSubmit: Subject<any> = new Subject<any>()
public setSubmitList: Subject<any> = new Subject<any>() public setSubmitList: Subject<any> = new Subject<any>()
/**
* Submit queue payload carried across the navigation from the submit
* list to a details URL - the re-created list component renders it
* without fetching the queue again.
*/
private submitsHandoff: Array<any> | null = null
constructor( constructor(
private sasService: SasService, private sasService: SasService,
private helperService: HelperService, private helperService: HelperService,
@@ -155,6 +162,24 @@ export class SasStoreService {
.adapterResponse .adapterResponse
} }
/**
* Carries the fetched submit queue over to the details URL navigation,
* so the re-created submit list component does not fetch it again.
*/
public handoffSubmits(fromsas: Array<any> | undefined) {
this.submitsHandoff = fromsas || null
}
/**
* Returns the submit queue carried by the current navigation, if any,
* and clears it - it is only valid for the navigation that set it.
*/
public takeSubmitsHandoff(): Array<any> | null {
const fromsas = this.submitsHandoff
this.submitsHandoff = null
return fromsas
}
private libsPromise: Promise<any> | null = null private libsPromise: Promise<any> | null = null
/** /**
+19 -2
View File
@@ -150,9 +150,12 @@ export class SasViyaService {
) )
} }
getFolderMembers(folderId: string): Observable<ViyaApiFolderMembers> { getFolderMembers(
folderId: string,
limit: number = 500
): Observable<ViyaApiFolderMembers> {
return this.get<ViyaApiFolderMembers>( return this.get<ViyaApiFolderMembers>(
`${this.serverUrl}/folders/folders/${folderId}/members`, `${this.serverUrl}/folders/folders/${folderId}/members?limit=${limit}`,
{ {
withCredentials: true withCredentials: true
} }
@@ -168,6 +171,20 @@ export class SasViyaService {
) )
} }
/**
* @returns The groups the current user is a member of
*/
getCurrentUserGroupMemberships(
limit: number = 10000
): Observable<ViyaApiIdentities> {
return this.get<ViyaApiIdentities>(
`${this.serverUrl}/identities/users/@currentUser/memberships?limit=${limit}`,
{
withCredentials: true
}
)
}
getCurrentUser(): Observable<ViyaApiCurrentUser> { getCurrentUser(): Observable<ViyaApiCurrentUser> {
return this.get<ViyaApiCurrentUser>( return this.get<ViyaApiCurrentUser>(
`${this.serverUrl}/identities/users/@currentUser`, `${this.serverUrl}/identities/users/@currentUser`,
+87 -14
View File
@@ -3,6 +3,7 @@ import { Injectable, EventEmitter } from '@angular/core'
import SASjs, { UploadFile } from '@sasjs/adapter' import SASjs, { UploadFile } from '@sasjs/adapter'
import { BehaviorSubject } from 'rxjs' import { BehaviorSubject } from 'rxjs'
import { UserService } from '../shared/user.service' import { UserService } from '../shared/user.service'
import { StartupCheckService } from './startup-check.service'
import { Router } from '@angular/router' import { Router } from '@angular/router'
import { EventService } from './event.service' import { EventService } from './event.service'
@@ -43,6 +44,7 @@ export class SasService {
private sasjsService: SasjsService, private sasjsService: SasjsService,
private sasViyaService: SasViyaService, private sasViyaService: SasViyaService,
private loggerService: LoggerService, private loggerService: LoggerService,
private startupCheckService: StartupCheckService,
private router: Router private router: Router
) {} ) {}
@@ -195,7 +197,8 @@ export class SasService {
{ {
SYSWARNINGTEXT: abortRes.SYSWARNINGTEXT, SYSWARNINGTEXT: abortRes.SYSWARNINGTEXT,
SYSERRORTEXT: abortRes.SYSERRORTEXT, SYSERRORTEXT: abortRes.SYSERRORTEXT,
MAC: macMsg MAC: macMsg,
_PROGRAM: abortRes._PROGRAM
} }
) )
} }
@@ -355,7 +358,10 @@ export class SasService {
this.sasjsService.getFolderContentsFromDrive(configuratorFolder).subscribe( this.sasjsService.getFolderContentsFromDrive(configuratorFolder).subscribe(
(contents: SASjsApiDriveFolderContents) => { (contents: SASjsApiDriveFolderContents) => {
if (contents.files.includes('makedata.sas')) { if (
contents.files.includes('makedata.sas') ||
contents.files.includes('makedata.js')
) {
this.eventService.startupDataLoaded() this.eventService.startupDataLoaded()
this.router.navigateByUrl('/deploy') this.router.navigateByUrl('/deploy')
} else { } else {
@@ -417,7 +423,10 @@ export class SasService {
.getFolderContentsFromDrive(configuratorFolder) .getFolderContentsFromDrive(configuratorFolder)
.subscribe( .subscribe(
(contents: SASjsApiDriveFolderContents) => { (contents: SASjsApiDriveFolderContents) => {
if (!contents.files.includes('makedata.sas')) { if (
!contents.files.includes('makedata.sas') &&
!contents.files.includes('makedata.js')
) {
resolve(true) resolve(true)
} else { } else {
resolve(false) resolve(false)
@@ -437,6 +446,9 @@ export class SasService {
} }
public async checkViyaDeploy(path: string) { public async checkViyaDeploy(path: string) {
console.log('checkViyaDeploy: checking appLoc', path)
this.startupCheckService.updateStep(0, 'in_progress')
const getFolderExistsInAdapter = const getFolderExistsInAdapter =
typeof this.sasjsAdapter.getFolder !== 'undefined' typeof this.sasjsAdapter.getFolder !== 'undefined'
@@ -452,25 +464,58 @@ export class SasService {
appLocExists = await this.appLocCheckPreAxiosdAdapter(path) appLocExists = await this.appLocCheckPreAxiosdAdapter(path)
} }
console.log(
'checkViyaDeploy: appLoc exists?',
appLocExists,
'error?',
errorMessage
)
if (appLocExists) { if (appLocExists) {
this.startupCheckService.updateStep(0, 'done', path)
// Check if there is appLoc/services/admin/makedata.sas present // Check if there is appLoc/services/admin/makedata.sas present
// if yes, it needs to be run, so we redirect to /deploy // if yes, it needs to be run, so we redirect to /deploy
// if not, we load the startup service // if not, we load the startup service
this.startupCheckService.updateStep(1, 'in_progress')
this.viyaMakedataSuccessfull().then( this.viyaMakedataSuccessfull().then(
(success: boolean) => { (success: boolean) => {
console.log(
'checkViyaDeploy: makedata job already run?',
success,
success
? '-> loading startupservice'
: '-> redirecting to /deploy (setup screen)'
)
if (success) { if (success) {
this.startupCheckService.updateStep(1, 'done', 'makedata complete')
this.startupCheckService.updateStep(2, 'in_progress')
this.loadStartupServiceEmitter.emit() this.loadStartupServiceEmitter.emit()
} else { } else {
this.startupCheckService.updateStep(
1,
'done',
'makedata job found - setup needed'
)
this.eventService.startupDataLoaded() this.eventService.startupDataLoaded()
this.router.navigateByUrl('/deploy') this.router.navigateByUrl('/deploy')
} }
}, },
(error: any) => { (error: any) => {
console.error('Error while looking for the file: makedata.sas', error) console.error(
'checkViyaDeploy: error while looking for makedata job',
error
)
this.startupCheckService.updateStep(1, 'error', String(error))
} }
) )
} else { } else {
this.startupCheckService.updateStep(
0,
'error',
errorMessage || 'not found'
)
const errorMessageToShow = const errorMessageToShow =
(errorMessage || (errorMessage ||
'Viya services are not present on the current appLoc, or API not reachable. Check the ADAPTER configuration.') + 'Viya services are not present on the current appLoc, or API not reachable. Check the ADAPTER configuration.') +
@@ -480,43 +525,71 @@ export class SasService {
} }
} }
private async viyaMakedataSuccessfull(): Promise<boolean> { public async viyaMakedataSuccessfull(): Promise<boolean> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const sasjsConfig = this.getSasjsConfig() const sasjsConfig = this.getSasjsConfig()
const configuratorFolder = `${sasjsConfig.appLoc}/services/admin` const configuratorFolder = `${sasjsConfig.appLoc}/services/admin`
console.log(
'viyaMakedataSuccessfull: checking folder',
configuratorFolder
)
this.sasViyaService.getFolderByPath(configuratorFolder).subscribe( this.sasViyaService.getFolderByPath(configuratorFolder).subscribe(
(folderInfo: ViyaApiFolder) => { (folderInfo: ViyaApiFolder) => {
const folderId = folderInfo.id const folderId = folderInfo.id
if (!folderId) { if (!folderId) {
console.error( console.error(
`Folder ID is not present. ${configuratorFolder}`, `viyaMakedataSuccessfull: folder ID not present for ${configuratorFolder}`,
sasjsConfig sasjsConfig
) )
resolve(false) resolve(false)
return
} }
this.sasViyaService.getFolderMembers(folderId).subscribe( this.sasViyaService.getFolderMembers(folderId).subscribe(
(members: ViyaApiFolderMembers) => { (members: ViyaApiFolderMembers) => {
if ( const memberNames = members.items.map((item: any) => item.name)
!members.items.some((item: any) => item.name === 'makedata') const hasMakedata = members.items.some(
) { (item: any) => item.name === 'makedata'
// Makedata.sas is not present, which means it was run )
console.log(
'viyaMakedataSuccessfull: folder members:',
memberNames.join(', ') || '(none)'
)
console.log(
'viyaMakedataSuccessfull: makedata job present?',
hasMakedata,
hasMakedata
? '-> setup needed (redirect to /deploy)'
: '-> setup already done (load startupservice)'
)
if (!hasMakedata) {
resolve(true) resolve(true)
} else { } else {
// Makedata.sas is present, which means it was not run
resolve(false) resolve(false)
} }
}, },
(err: any) => { (err: any) => {
console.error('Error getting folder contents', err) console.error(
reject() 'viyaMakedataSuccessfull: error getting folder members for',
configuratorFolder,
err
)
// On error, assume setup is needed rather than skipping it
resolve(false)
} }
) )
}, },
(err: any) => { (err: any) => {
console.warn('Error getting folder info', err) console.warn(
'viyaMakedataSuccessfull: error getting folder info for',
configuratorFolder,
err
)
reject(err) reject(err)
} }
) )
@@ -0,0 +1,37 @@
import { Injectable } from '@angular/core'
import { BehaviorSubject } from 'rxjs'
export type StartupStepStatus = 'pending' | 'in_progress' | 'done' | 'error'
export interface StartupStep {
label: string
status: StartupStepStatus
detail?: string
}
@Injectable({ providedIn: 'root' })
export class StartupCheckService {
private steps: StartupStep[] = [
{ label: 'Checking app location', status: 'pending' },
{ label: 'Checking Viya deploy', status: 'pending' },
{ label: 'Loading startup service', status: 'pending' }
]
public steps$ = new BehaviorSubject<StartupStep[]>([...this.steps])
public updateStep(index: number, status: StartupStepStatus, detail?: string) {
if (index >= 0 && index < this.steps.length) {
this.steps[index] = {
...this.steps[index],
status,
detail: detail ?? this.steps[index].detail
}
this.steps$.next([...this.steps])
}
}
public setSteps(steps: StartupStep[]) {
this.steps = steps
this.steps$.next([...this.steps])
}
}
@@ -0,0 +1,79 @@
import { decodeLicenceFeatures } from './decodeLicenceFeatures'
describe('decodeLicenceFeatures', () => {
// Positional order per LicenceFeaturesMap: viewer_rows_allowed,
// editor_rows_allowed, stage_rows_allowed, history_rows_allowed,
// submit_rows_limit, tables_in_library_limit, viewbox, viewbox_limit,
// lineage_daily_limit, fileUpload, editRecord, addRecord.
const legacyFeaturesString = '10,15,20,-,5,35,1,3,7,1,0,1'
const newFeaturesObject = {
vra: 10,
era: 15,
sra: 20,
hra: null,
srl: 5,
till: 35,
vb: true,
vbl: 3,
ldl: 7,
fu: true,
er: false,
ar: true
}
const expectedDecodedState = {
viewer_rows_allowed: 10,
editor_rows_allowed: 15,
stage_rows_allowed: 20,
history_rows_allowed: Infinity,
submit_rows_limit: 5,
tables_in_library_limit: 35,
viewbox: true,
viewbox_limit: 3,
lineage_daily_limit: 7,
fileUpload: true,
editRecord: false,
addRecord: true
}
it('decodes a legacy positional string exactly as before', () => {
expect(decodeLicenceFeatures(legacyFeaturesString)).toEqual(
expectedDecodedState
)
})
it('decodes a new named object', () => {
expect(decodeLicenceFeatures(newFeaturesObject)).toEqual(
expectedDecodedState
)
})
it('produces an identical result for the same licence expressed in either format', () => {
expect(decodeLicenceFeatures(legacyFeaturesString)).toEqual(
decodeLicenceFeatures(newFeaturesObject)
)
})
it('maps "-" in a legacy limit position to Infinity', () => {
const result = decodeLicenceFeatures(legacyFeaturesString)
expect(result.history_rows_allowed).toBe(Infinity)
})
it('maps null in a new-format limit field to Infinity', () => {
const result = decodeLicenceFeatures(newFeaturesObject)
expect(result.history_rows_allowed).toBe(Infinity)
})
it('maps "1"/"0" in legacy toggle positions to true/false', () => {
const result = decodeLicenceFeatures(legacyFeaturesString)
expect(result.viewbox).toBe(true)
expect(result.editRecord).toBe(false)
})
it('passes new-format boolean toggle fields straight through', () => {
const result = decodeLicenceFeatures(newFeaturesObject)
expect(result.viewbox).toBe(true)
expect(result.editRecord).toBe(false)
})
})
@@ -0,0 +1,91 @@
import { LicenceFeaturesMap, LicenceState } from '../../models/LicenceState'
// Field names are abbreviated on the wire to keep the RSA-OAEP-encrypted
// payload small - see "Why abbreviated field names" in
// licence-features-object-plan.md for the full name each one stands for
// and why this is a fixed, append-only contract (same invariant as
// LicenceFeaturesMap's ordinals).
export type LicenceFeaturesObject = {
vra: number | null // viewer_rows_allowed
era: number | null // editor_rows_allowed
sra: number | null // stage_rows_allowed
hra: number | null // history_rows_allowed
srl: number | null // submit_rows_limit
till: number | null // tables_in_library_limit
vb: boolean // viewbox
vbl: number | null // viewbox_limit
ldl: number | null // lineage_daily_limit
fu: boolean // fileUpload
er: boolean // editRecord
ar: boolean // addRecord
}
// Accepts either an already-issued key's positional string
// ("-,-,-,-,-,-,1,-,-,1,1,1", decoded via LicenceFeaturesMap) or a
// newly-issued key's named object - see licence-features-object-plan.md
// for why these two shapes are how format versioning is done here (no
// separate version field: the shapes are already distinguishable).
export const decodeLicenceFeatures = (
features: string | LicenceFeaturesObject
): Partial<LicenceState> => {
if (typeof features === 'object') {
return decodeFeaturesObject(features)
}
return decodeFeaturesString(features)
}
const decodeFeaturesObject = (
features: LicenceFeaturesObject
): Partial<LicenceState> => ({
viewer_rows_allowed: features.vra ?? Infinity,
editor_rows_allowed: features.era ?? Infinity,
stage_rows_allowed: features.sra ?? Infinity,
history_rows_allowed: features.hra ?? Infinity,
submit_rows_limit: features.srl ?? Infinity,
tables_in_library_limit: features.till ?? Infinity,
viewbox: features.vb,
viewbox_limit: features.vbl ?? Infinity,
lineage_daily_limit: features.ldl ?? Infinity,
fileUpload: features.fu,
editRecord: features.er,
addRecord: features.ar
})
// Existing positional-string decode, moved here unchanged from
// LicenceService.decodeLicenceFeatures/parseFeatureValue/parseFeatureToggle.
const decodeFeaturesString = (features: string): Partial<LicenceState> => {
const featuresMap = features.split(',')
const parseValue = (codeBit: string) =>
codeBit === '-' ? Infinity : parseInt(codeBit)
const parseToggle = (codeBit: string) => !!parseInt(codeBit)
return {
viewer_rows_allowed: parseValue(
featuresMap[LicenceFeaturesMap.viewer_rows_allowed]
),
editor_rows_allowed: parseValue(
featuresMap[LicenceFeaturesMap.editor_rows_allowed]
),
stage_rows_allowed: parseValue(
featuresMap[LicenceFeaturesMap.stage_rows_allowed]
),
history_rows_allowed: parseValue(
featuresMap[LicenceFeaturesMap.history_rows_allowed]
),
submit_rows_limit: parseValue(
featuresMap[LicenceFeaturesMap.submit_rows_limit]
),
tables_in_library_limit: parseValue(
featuresMap[LicenceFeaturesMap.tables_in_library_limit]
),
viewbox_limit: parseValue(featuresMap[LicenceFeaturesMap.viewbox_limit]),
lineage_daily_limit: parseValue(
featuresMap[LicenceFeaturesMap.lineage_daily_limit]
),
viewbox: parseToggle(featuresMap[LicenceFeaturesMap.viewbox]),
fileUpload: parseToggle(featuresMap[LicenceFeaturesMap.fileUpload]),
editRecord: parseToggle(featuresMap[LicenceFeaturesMap.editRecord]),
addRecord: parseToggle(featuresMap[LicenceFeaturesMap.addRecord])
}
}
@@ -23,6 +23,7 @@
</p> </p>
<p><strong>SYSERRORTEXT:</strong> {{ data.details.SYSERRORTEXT }}</p> <p><strong>SYSERRORTEXT:</strong> {{ data.details.SYSERRORTEXT }}</p>
<p><strong>MAC:</strong> {{ data.details.MAC }}</p> <p><strong>MAC:</strong> {{ data.details.MAC }}</p>
<p><strong>_PROGRAM:</strong> {{ data.details._PROGRAM }}</p>
</div> </div>
} }
</div> </div>
@@ -0,0 +1,83 @@
import {
getRowKey,
markAutoEscaped,
isAutoEscaped,
clearAutoEscaped
} from './autoEscapedCellTracker'
describe('autoEscapedCellTracker', () => {
describe('getRowKey', () => {
it('derives the same key for two different row objects sharing the same PK values', () => {
const rowA = { PRIMARY_KEY_FIELD: 3, A_COL: 'x' }
const rowB = { PRIMARY_KEY_FIELD: 3, A_COL: 'y' }
expect(getRowKey(rowA, ['PRIMARY_KEY_FIELD'])).toEqual(
getRowKey(rowB, ['PRIMARY_KEY_FIELD'])
)
})
it('derives different keys for different PK values', () => {
const rowA = { PRIMARY_KEY_FIELD: 3 }
const rowB = { PRIMARY_KEY_FIELD: 4 }
expect(getRowKey(rowA, ['PRIMARY_KEY_FIELD'])).not.toEqual(
getRowKey(rowB, ['PRIMARY_KEY_FIELD'])
)
})
it('supports composite primary keys', () => {
const rowA = { LIBREF: 'DC1', DSN: 'A' }
const rowB = { LIBREF: 'DC1', DSN: 'B' }
expect(getRowKey(rowA, ['LIBREF', 'DSN'])).not.toEqual(
getRowKey(rowB, ['LIBREF', 'DSN'])
)
})
})
describe('markAutoEscaped / isAutoEscaped / clearAutoEscaped', () => {
it('is not auto-escaped before being marked', () => {
const map = new Map<string, Set<string>>()
expect(isAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')).toEqual(false)
})
it('is auto-escaped after being marked', () => {
const map = new Map<string, Set<string>>()
markAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')
expect(isAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')).toEqual(true)
})
it('is not auto-escaped after being cleared', () => {
const map = new Map<string, Set<string>>()
markAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')
clearAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')
expect(isAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')).toEqual(false)
})
it('clearing an unmarked cell is a no-op, not a throw', () => {
const map = new Map<string, Set<string>>()
expect(() =>
clearAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')
).not.toThrow()
})
it('tracks two columns on the same row independently', () => {
const map = new Map<string, Set<string>>()
markAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')
markAutoEscaped(map, 'row-1', 'OTHER_COL')
clearAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')
expect(isAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')).toEqual(false)
expect(isAutoEscaped(map, 'row-1', 'OTHER_COL')).toEqual(true)
})
it('tracks the same column on two different rows independently', () => {
const map = new Map<string, Set<string>>()
markAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')
expect(isAutoEscaped(map, 'row-1', 'PLAIN_TEXT_COL')).toEqual(true)
expect(isAutoEscaped(map, 'row-2', 'PLAIN_TEXT_COL')).toEqual(false)
})
})
})
@@ -0,0 +1,36 @@
/**
* Tracks which cells got a `'` the app itself inserted (see
* escapeCharacterColumnValue), so submission and the "Apply as formula"
* context-menu action only ever touch cells the app marked - never a
* genuine leading `'` that was already part of the data. Kept as a
* standalone Map (not a property on the row object) so it can never leak
* into the submit payload, and keyed by primary key rather than row index
* so it survives insert/delete/sort.
*/
export type AutoEscapedCellMap = Map<string, Set<string>>
export const getRowKey = (row: any, headerPks: string[]): string =>
headerPks.map((pk) => String(row[pk])).join(' ')
export const markAutoEscaped = (
map: AutoEscapedCellMap,
rowKey: string,
colName: string
): void => {
if (!map.has(rowKey)) map.set(rowKey, new Set())
map.get(rowKey)!.add(colName)
}
export const isAutoEscaped = (
map: AutoEscapedCellMap,
rowKey: string,
colName: string
): boolean => map.get(rowKey)?.has(colName) ?? false
export const clearAutoEscaped = (
map: AutoEscapedCellMap,
rowKey: string,
colName: string
): void => {
map.get(rowKey)?.delete(colName)
}
@@ -0,0 +1,46 @@
import { escapeCharacterColumnValue } from './escapeCharacterColumnValue'
describe('escapeCharacterColumnValue', () => {
it('escapes a =-led value', () => {
expect(escapeCharacterColumnValue('=SUM(1)')).toEqual({
value: "'=SUM(1)",
wasEscaped: true
})
})
it('escapes a =-led value referencing a column name', () => {
expect(escapeCharacterColumnValue('=100 + B_COL')).toEqual({
value: "'=100 + B_COL",
wasEscaped: true
})
})
it('leaves an already-escaped value unchanged (does not start with =)', () => {
expect(escapeCharacterColumnValue("'=already")).toEqual({
value: "'=already",
wasEscaped: false
})
})
it('leaves a plain string unchanged', () => {
expect(escapeCharacterColumnValue('note-1')).toEqual({
value: 'note-1',
wasEscaped: false
})
})
it('leaves a non-string value unchanged', () => {
expect(escapeCharacterColumnValue(123)).toEqual({
value: 123,
wasEscaped: false
})
expect(escapeCharacterColumnValue(null)).toEqual({
value: null,
wasEscaped: false
})
expect(escapeCharacterColumnValue(undefined)).toEqual({
value: undefined,
wasEscaped: false
})
})
})
@@ -0,0 +1,15 @@
/**
* Prepends `'` to a `=`-led value so Handsontable/HyperFormula treats it as
* inert text rather than a live formula - Handsontable's own escape
* convention, which it strips automatically when displaying the value.
* Caller decides eligibility (character column? not a formula base column?)
* before calling this - it only ever looks at the value itself.
*/
export const escapeCharacterColumnValue = (
value: unknown
): { value: unknown; wasEscaped: boolean } => {
if (typeof value !== 'string' || !value.startsWith('=')) {
return { value, wasEscaped: false }
}
return { value: `'${value}`, wasEscaped: true }
}
@@ -0,0 +1,51 @@
import { getFormulaColumnNames } from './getFormulaColumnNames'
import { DQRule } from '../models/dq-rules.model'
const rule = (overrides: Partial<DQRule> = {}): DQRule => ({
BASE_COL: 'SOME_COL',
RULE_TYPE: 'NOTNULL',
RULE_VALUE: '',
X: 0,
...overrides
})
describe('getFormulaColumnNames', () => {
it('returns the BASE_COL of every HARDFORMULA rule', () => {
expect(
getFormulaColumnNames([
rule({ BASE_COL: 'FORMULA_HARD_COL', RULE_TYPE: 'HARDFORMULA' })
])
).toEqual(['FORMULA_HARD_COL'])
})
it('returns the BASE_COL of every SOFTFORMULA rule', () => {
expect(
getFormulaColumnNames([
rule({ BASE_COL: 'FORMULA_SOFT_COL', RULE_TYPE: 'SOFTFORMULA' })
])
).toEqual(['FORMULA_SOFT_COL'])
})
it('excludes non-formula rule types', () => {
expect(
getFormulaColumnNames([
rule({ BASE_COL: 'PRIMARY_KEY_FIELD', RULE_TYPE: 'NOTNULL' }),
rule({ BASE_COL: 'READONLY_COL', RULE_TYPE: 'READONLY' })
])
).toEqual([])
})
it('returns [] for an empty rule set', () => {
expect(getFormulaColumnNames([])).toEqual([])
})
it('mixes formula and non-formula rules correctly', () => {
expect(
getFormulaColumnNames([
rule({ BASE_COL: 'PRIMARY_KEY_FIELD', RULE_TYPE: 'NOTNULL' }),
rule({ BASE_COL: 'FORMULA_HARD_COL', RULE_TYPE: 'HARDFORMULA' }),
rule({ BASE_COL: 'FORMULA_SOFT_COL', RULE_TYPE: 'SOFTFORMULA' })
])
).toEqual(['FORMULA_HARD_COL', 'FORMULA_SOFT_COL'])
})
})
@@ -0,0 +1,9 @@
import { DQRule } from '../models/dq-rules.model'
export const getFormulaColumnNames = (dqRules: DQRule[]): string[] =>
dqRules
.filter(
(rule) =>
rule.RULE_TYPE === 'HARDFORMULA' || rule.RULE_TYPE === 'SOFTFORMULA'
)
.map((rule) => rule.BASE_COL)
@@ -0,0 +1,21 @@
import { isCharacterColumn } from './isCharacterColumn'
import { Col } from '../models/col.model'
const col = (NAME: string, DDTYPE: string): Col => ({ NAME, DDTYPE }) as Col
describe('isCharacterColumn', () => {
it('returns true for a column whose DDTYPE is C', () => {
const cols = [col('PLAIN_TEXT_COL', 'C')]
expect(isCharacterColumn(cols, 'PLAIN_TEXT_COL')).toEqual(true)
})
it('returns false for a column whose DDTYPE is N', () => {
const cols = [col('A_COL', 'N')]
expect(isCharacterColumn(cols, 'A_COL')).toEqual(false)
})
it('returns false for a column not present in cols at all', () => {
const cols = [col('A_COL', 'N')]
expect(isCharacterColumn(cols, 'EDIT_STATUS')).toEqual(false)
})
})
@@ -0,0 +1,9 @@
import { Col } from '../models/col.model'
/**
* DDTYPE is the backend's own char/numeric classification per column ('C'
* or 'N') - distinct from Col.TYPE, which mergeColsRules derives separately
* from $sasdata.vars (values 'char'/'num', not 'C'/'N').
*/
export const isCharacterColumn = (cols: Col[], colName: string): boolean =>
cols.find((col) => col.NAME === colName)?.DDTYPE === 'C'
@@ -56,6 +56,21 @@ describe('parseFormulaRule', () => {
).toEqual('=\"sasinstaller\"') ).toEqual('=\"sasinstaller\"')
}) })
it('escapes embedded double quotes in DC.USER_NAME so the resulting literal stays valid', () => {
expect(
parseFormulaRule('=DC.USER_NAME', context({ userName: 'john"doe' }))
).toEqual('="john""doe"')
})
it('escapes embedded double quotes in DC.ORIG_VALUE so the resulting literal stays valid', () => {
expect(
parseFormulaRule(
'=DC.ORIG_VALUE',
context({ origValue: 'a "quoted" value' })
)
).toEqual('="a ""quoted"" value"')
})
it('does not substitute DC.USER_NAME/DC.ORIG_VALUE inside quoted strings either', () => { it('does not substitute DC.USER_NAME/DC.ORIG_VALUE inside quoted strings either', () => {
expect(parseFormulaRule('="DC.USER_NAME"', context())).toEqual( expect(parseFormulaRule('="DC.USER_NAME"', context())).toEqual(
'=\"DC.USER_NAME\"' '=\"DC.USER_NAME\"'
@@ -101,4 +116,33 @@ describe('parseFormulaRule', () => {
it('does not insert a leading = when the rule value does not have one, so HOT treats it as plain text rather than a formula', () => { it('does not insert a leading = when the rule value does not have one, so HOT treats it as plain text rather than a formula', () => {
expect(parseFormulaRule('PRICE * VOLUME', context())).toEqual('B1 * C1') expect(parseFormulaRule('PRICE * VOLUME', context())).toEqual('B1 * C1')
}) })
// String.prototype.replace interprets $&/$`/$'/$<digit> specially when
// the replacement is a string - DC.ORIG_VALUE/DC.USER_NAME substitute in
// arbitrary data (any character column's prior value, or a username),
// which can legitimately contain a literal '$'. These must round-trip
// untouched, not have HyperFormula's own pattern-matching corrupt them.
it('substitutes a DC.ORIG_VALUE containing a literal $& without corruption', () => {
expect(
parseFormulaRule('=DC.ORIG_VALUE', context({ origValue: 'a$&b' }))
).toEqual('="a$&b"')
})
it("substitutes a DC.ORIG_VALUE containing a literal $' without corruption", () => {
expect(
parseFormulaRule('=DC.ORIG_VALUE', context({ origValue: "a$'b" }))
).toEqual('="a$\'b"')
})
it('substitutes a DC.ORIG_VALUE containing a literal $` without corruption', () => {
expect(
parseFormulaRule('=DC.ORIG_VALUE', context({ origValue: 'a$`b' }))
).toEqual('="a$`b"')
})
it('substitutes a DC.USER_NAME containing a literal $1 without corruption', () => {
expect(
parseFormulaRule('=DC.USER_NAME', context({ userName: 'a$1b' }))
).toEqual('="a$1b"')
})
}) })
@@ -12,7 +12,7 @@ export interface FormulaVariableContext {
origValue: string | number | undefined origValue: string | number | undefined
} }
const escapeRegExpMetacharacters = (text: string): string => export const escapeRegExpMetacharacters = (text: string): string =>
text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
/** /**
@@ -22,7 +22,7 @@ const escapeRegExpMetacharacters = (text: string): string =>
* surrounding blanks) does not, without needing to know anything about * surrounding blanks) does not, without needing to know anything about
* function names. * function names.
*/ */
const substituteBoundedToken = ( export const substituteBoundedToken = (
text: string, text: string,
token: string, token: string,
replacement: string replacement: string
@@ -32,11 +32,15 @@ const substituteBoundedToken = (
'g' 'g'
) )
return text.replace(pattern, replacement) // A function replacement's return value is used verbatim - a string
// replacement would otherwise have String.replace interpret $&/$`/$'/
// $<digit> specially, and `replacement` here can be arbitrary data (a
// cell's prior value, a username) that may legitimately contain '$'.
return text.replace(pattern, () => replacement)
} }
const quoteLiteral = (value: string | number | undefined): string => const quoteLiteral = (value: string | number | undefined): string =>
`"${value ?? ''}"` `"${String(value ?? '').replace(/"/g, '""')}"`
export const parseFormulaRule = ( export const parseFormulaRule = (
ruleValue: string, ruleValue: string,
@@ -0,0 +1,15 @@
import { resolveRevertedCellValue } from './resolveRevertedCellValue'
describe('resolveRevertedCellValue', () => {
it('returns the raw text unchanged for a non-numeric column', () => {
expect(resolveRevertedCellValue('sasdemo', false)).toEqual('sasdemo')
})
it('converts a valid numeric string to a number for a numeric column', () => {
expect(resolveRevertedCellValue('42.5', true)).toEqual(42.5)
})
it("falls back to the raw text instead of NaN when a numeric column's stored value is not a valid number", () => {
expect(resolveRevertedCellValue('.S', true)).toEqual('.S')
})
})
@@ -0,0 +1,16 @@
// A numeric column's original value is stored as plain text in a
// Handsontable comment - if it isn't a valid number (e.g. a SAS special
// missing like ".S"), Number() returns NaN, which would silently corrupt
// the revert instead of restoring the original value. Falling back to the
// raw text keeps the revert visibly correct (the original text) rather
// than writing NaN into the cell.
export const resolveRevertedCellValue = (
rawValueText: string,
isNumericCol: boolean
): string | number => {
if (!isNumericCol) return rawValueText
const numericValue = Number(rawValueText)
return Number.isNaN(numericValue) ? rawValueText : numericValue
}
@@ -0,0 +1,75 @@
import { substituteColumnReferences } from './substituteColumnReferences'
describe('substituteColumnReferences', () => {
const columnNames = ['ITEM', 'PRICE', 'VOLUME', 'REVENUE']
it("substitutes column-name variables with this row's cell references (the issue's own example)", () => {
expect(
substituteColumnReferences(
'=SOME_NUM * SOME_BESTNUM',
['ID', 'SOME_NUM', 'SOME_BESTNUM'],
3
)
).toEqual('=B4 * C4')
})
it('uses the row-relative reference for a later row', () => {
expect(
substituteColumnReferences('=PRICE * VOLUME', columnNames, 1)
).toEqual('=B2 * C2')
})
it('requires a leading/trailing blank (or string edge) around a variable - no match without it', () => {
expect(substituteColumnReferences('=PRICE*VOLUME', columnNames, 0)).toEqual(
'=PRICE*VOLUME'
)
})
it('does not substitute a variable name matched inside a function call with no surrounding blanks', () => {
expect(substituteColumnReferences('=MATCH(PRICE)', columnNames, 0)).toEqual(
'=MATCH(PRICE)'
)
})
it('leaves variable occurrences inside quoted strings untouched', () => {
expect(
substituteColumnReferences('=ITEM & " string ITEM "', columnNames, 0)
).toEqual('=A1 & " string ITEM "')
})
it('does not insert a leading = when the input does not have one', () => {
expect(
substituteColumnReferences('PRICE * VOLUME', columnNames, 0)
).toEqual('B1 * C1')
})
it('does not perform any DC.* variable substitution - only column names', () => {
expect(substituteColumnReferences('=DC.USER_NAME', columnNames, 0)).toEqual(
'=DC.USER_NAME'
)
})
it('leaves a plain (non-formula) pasted value pass through unchanged aside from column tokens it happens to contain', () => {
expect(
substituteColumnReferences('just a note about PRICE', columnNames, 0)
).toEqual('just a note about B1')
})
// This function's own replacement values are always system-generated
// cell refs (e.g. "B1") that can never contain '$', so it can't trigger
// substituteBoundedToken's $-pattern corruption itself - but it shares
// that function with parseFormulaRule.ts (which can), so confirm a
// literal '$' elsewhere in the input still round-trips correctly
// through the shared (now function-replacement-based) substitution.
it('leaves a literal $ in the surrounding text untouched by an unrelated column substitution', () => {
expect(
substituteColumnReferences('PRICE + $5 fee', columnNames, 0)
).toEqual('B1 + $5 fee')
})
it('leaves a literal $ inside a quoted span untouched', () => {
expect(
substituteColumnReferences('PRICE & " costs $5 "', columnNames, 0)
).toEqual('B1 & " costs $5 "')
})
})
@@ -0,0 +1,42 @@
import Handsontable from 'handsontable'
import { substituteBoundedToken } from './parseFormulaRule'
/**
* Translates column names in a formula-like string into this row's cell
* references, e.g. "=PRICE * VOLUME" -> "=B4 * C4" for row index 3.
* Column-name substitution only - no DC.* variable support (that's
* specific to admin-defined rule values re-evaluated per row - see
* parseFormulaRule.ts, which this deliberately does not delegate to, to
* keep this scoped to exactly column names).
*/
export const substituteColumnReferences = (
formulaText: string,
columnNames: string[],
rowIndex: number
): string => {
const hasLeadingEquals = formulaText.startsWith('=')
const formulaBody = hasLeadingEquals ? formulaText.slice(1) : formulaText
const quotedSpanPattern = /"[^"]*"|'[^']*'/g
let result = ''
let lastIndex = 0
let match: RegExpExecArray | null
const substituteUnquotedSpan = (span: string): string => {
let substituted = span
columnNames.forEach((columnName, columnIndex) => {
const cellRef = `${Handsontable.helper.spreadsheetColumnLabel(columnIndex)}${rowIndex + 1}`
substituted = substituteBoundedToken(substituted, columnName, cellRef)
})
return substituted
}
while ((match = quotedSpanPattern.exec(formulaBody))) {
result += substituteUnquotedSpan(formulaBody.slice(lastIndex, match.index))
result += match[0]
lastIndex = match.index + match[0].length
}
result += substituteUnquotedSpan(formulaBody.slice(lastIndex))
return hasLeadingEquals ? `=${result}` : result
}
@@ -0,0 +1,21 @@
import { unescapeFormula } from './unescapeFormula'
describe('unescapeFormula', () => {
it('strips the leading escape marker from an escaped value', () => {
expect(unescapeFormula("'=100 * 100")).toEqual('=100 * 100')
})
it('leaves a value that merely starts with a leading quote (not followed by =) unchanged', () => {
expect(unescapeFormula("'hello")).toEqual("'hello")
})
it('leaves a plain value with no leading quote unchanged', () => {
expect(unescapeFormula('note-1')).toEqual('note-1')
})
it('leaves a non-string value unchanged', () => {
expect(unescapeFormula(42)).toEqual(42)
expect(unescapeFormula(null)).toEqual(null)
expect(unescapeFormula(true)).toEqual(true)
})
})
@@ -0,0 +1,12 @@
/**
* Inverse of escapeCharacterColumnValue - strips the leading `'` this app
* itself added to keep a backend `=`-led value out of HyperFormula's
* evaluation. Only ever called for a cell autoEscapedCellTracker confirms
* the app itself marked - see character-column-formula-plan.md.
*/
export const unescapeFormula = (value: unknown): unknown => {
if (typeof value !== 'string') return value
if (value.charAt(0) !== "'" || value.charAt(1) !== '=') return value
return value.slice(1)
}
@@ -10,6 +10,9 @@ export interface EnvironmentInfo {
SYSHOSTINFOLONG?: string SYSHOSTINFOLONG?: string
SYSENCODING?: string SYSENCODING?: string
AUTOEXEC?: string AUTOEXEC?: string
TIMEZONE?: string
SYSTIMEZONEIDENT?: string
SYSTIMEZONEOFFSET?: string
ISADMIN?: number ISADMIN?: number
DC_ADMIN_GROUP?: string DC_ADMIN_GROUP?: string
APP_LOC?: string APP_LOC?: string
@@ -51,6 +51,24 @@
<p cds-text="label" class="m-0"> <p cds-text="label" class="m-0">
AUTOEXEC: <span class="dark">{{ environmentInfo?.AUTOEXEC }}</span> AUTOEXEC: <span class="dark">{{ environmentInfo?.AUTOEXEC }}</span>
</p> </p>
<p cds-text="label" class="m-0">
TIMEZONE:
<span class="dark">{{
environmentInfo?.TIMEZONE || '(not set)'
}}</span>
</p>
<p cds-text="label" class="m-0">
SYSTIMEZONEIDENT:
<span class="dark">{{
environmentInfo?.SYSTIMEZONEIDENT || '(not set)'
}}</span>
</p>
<p cds-text="label" class="m-0">
SYSTIMEZONEOFFSET:
<span class="dark">{{
environmentInfo?.SYSTIMEZONEOFFSET || '0'
}}</span>
</p>
</div> </div>
<div class="d-flex clr-justify-content-lg-center"> <div class="d-flex clr-justify-content-lg-center">
Loaded 100 of 196 files, more files were not shown because too many files have changed in this diff. Show more