Soft Deletion of Script by Suyash-d · Pull Request #330 · metadew/iesi

Suyash-d · 2021-05-03T13:47:46Z

Is your feature request related to a problem? Please describe.
Instead of physical deleting a script from the repository when the DELETE /api/scripts endpoint is called, the script should be marked as 'inactive'. This way scripts can be re-enabled should the script be deleted by accident.

When retrieving scripts using the GET /api/scripts, GET /api/scripts/<name> and GET /api/scripts/<name>/<version> endpoints, only active scripts should be considered.

Starting documentation:

Tasks

define logical deletion strategy
add column to scripts table to denote logical deletion flag
adapt ScriptConfiguration to handle logical delete for DELETE action
adapt ScriptDtoRepository to handle logical deletion of scripts during FETCH actions
adapt unique constraint on script table (should primary key of Script/ScriptVersion be adapted?)

Approach

Every script version has a field 'deleted_at'. If a script version is active, the field 'deleted_at' has the value 'NA'. When a script version is soft deleted, the 'deleted_at' field will be set to the current timestamp. All script versions having a 'deleted_at' field different than 'NA' are inactive.
Every script has a field 'deleted_at'. If a script has any active script versions, the 'deleted_at' field is set to 'NA'. Should all script versions be soft deleted, then the 'delete_at' field of the script is set to the current timestamp.

Verification
The following should be working:

Scenario 1: Delete an existing script
1. perform GET /api/scripts
2. perform DELETE /api/scripts/<name>/<version> for 1 specific script
3. perform GET /api/scripts and verify it does not contain the <name> and <version>
4. perform GET /api/scripts/<name>/<version> and returns a 404
Scenario 2: Recreate a deleted script
1. perform GET /api/scripts
2. perform DELETE /api/scripts/<name>/<version> for 1 specific script
3. perform GET /api/scripts and verify it does not contain the <name> and <version>
4. perform GET /api/scripts/<name>/<version> and returns a 404
5. perform POST /api/scripts using the <name> and <version> previously removed
6. perform GET /api/scripts and verify it does contain the <name> and <version>
7. perform GET /api/scripts/<name>/<version> and returns a 200
Scenario 3: Delete a recreated script
1. perform GET /api/scripts
2. perform DELETE /api/scripts/<name>/<version> for 1 specific script
3. perform GET /api/scripts and verify it does not contain the <name> and <version>
4. perform GET /api/scripts/<name>/<version> and returns a 404
5. perform POST /api/scripts using the <name> and <version> previously removed
6. perform GET /api/scripts and verify it does contain the <name> and <version>
7. perform GET /api/scripts/<name>/<version> and returns a 200
8. perform DELETE /api/scripts/<name>/<version>
9. perform GET /api/scripts and verify it does not contain the <name> and <version>
10. perform GET /api/scripts/<name>/<version> and returns a 404
Scenario 4: reinstate a deleted script
1. perform GET /api/scripts
2. perform DELETE /api/scripts/<name>/<version> for 1 specific script
3. perform GET /api/scripts and verify it does not contain the <name> and <version>
4. perform GET /api/scripts/<name>/<version> and returns a 404
5. set 'deleted_at' column of script:<name>-<version> in DB to NA
6. perform GET /api/scripts and verify it does contain the <name> and <version>
7. perform GET /api/scripts/<name>/<version> and returns a 200

Test them by creating a new IESI sandbox from scratch, load the dummy data and verify the scenario's above using Postman

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptConfiguration.java

...va/io/metadew/iesi/server/rest/configuration/security/jwt/ScriptsControllerSecurityTest.java

...ices/src/test/java/io/metadew/iesi/server/rest/executionrequest/ExecutionRequestBuilder.java

BerrevoetsRobbe · 2021-05-04T07:39:42Z

The following functionalities need to be discussed:

does 'deleted_at' become part of the primary key of a Script and ScriptVersion?
add functionality to restore an 'inactive' script
keep the hard delete logic
create tests related to the soft delete of a tests

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptConfiguration.java

BerrevoetsRobbe · 2021-05-13T09:32:59Z

update ScriptKey to contain the deletedAt field. Created the following constructors:

    public ScriptKey(String scriptId, long scriptVersion) {
        this.scriptId = scriptId;
        this.scriptVersion = scriptVersion;
        this.deletedAt = "NA";
    }

    public ScriptKey(String scriptId, long scriptVersion, String deletedAt) {
        this.scriptId = scriptId;
        this.scriptVersion = scriptVersion;
        this.deletedAt = deletedAt;
    }

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptConfiguration.java

.../src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptVersionConfiguration.java

BerrevoetsRobbe · 2021-05-13T09:43:04Z

remove core/java/iesi-rest-without-microservices/null

core/java/iesi-core/src/test/resources/application-metadata.yml

BerrevoetsRobbe · 2021-06-08T13:56:21Z

@Suyash-d could you verify the scenarios added to the description?
I have a problem with Scenario 2

core/java/iesi-core/src/main/java/io/metadew/iesi/metadata/definition/script/ScriptVersion.java

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/action/ActionConfiguration.java

.../src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptVersionConfiguration.java

…thub.com/metadew/iesi into feature/34993e6/Soft-deletion-of-scripts

This reverts commit f9f23d8

...rc/main/java/io/metadew/iesi/metadata/configuration/action/ActionParameterConfiguration.java

...re/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptLabelConfiguration.java

BerrevoetsRobbe · 2021-06-28T09:01:11Z

...rc/main/java/io/metadew/iesi/metadata/configuration/script/ScriptParameterConfiguration.java

                " and SCRIPT_VRS_NB = " + SQLTools.getStringForSQL(scriptParameterKey.getScriptKey().getScriptVersion()) +
-                " and SCRIPT_PAR_NM = " + SQLTools.getStringForSQL(scriptParameterKey.getParameterName()) + ";";
+                " and SCRIPT_PAR_NM = " + SQLTools.getStringForSQL(scriptParameterKey.getParameterName()) +
+                " and DELETED_AT = 'NA' ;";


...rc/main/java/io/metadew/iesi/metadata/configuration/script/ScriptParameterConfiguration.java

BerrevoetsRobbe · 2021-06-28T09:02:24Z

...rc/main/java/io/metadew/iesi/metadata/configuration/script/ScriptParameterConfiguration.java

                + " where SCRIPT_ID = " + SQLTools.getStringForSQL(scriptKey.getScriptId()) +
-                " and SCRIPT_VRS_NB = " + SQLTools.getStringForSQL(scriptKey.getScriptVersion()) + ";";
+                " and SCRIPT_VRS_NB = " + SQLTools.getStringForSQL(scriptKey.getScriptVersion()) +
+                " and DELETED_AT = 'NA' ;";


BerrevoetsRobbe · 2021-06-28T09:02:54Z

.../src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptVersionConfiguration.java

-        String queryScriptVersion = "select SCRIPT_ID, SCRIPT_VRS_NB, SCRIPT_VRS_DSC, LAST_MODIFIED_BY, LAST_MODIFIED_AT from " + getMetadataRepository().getTableNameByLabel("ScriptVersions")
-                + " where SCRIPT_ID = " + SQLTools.getStringForSQL(scriptVersionKey.getScriptKey().getScriptId()) +
+        String queryScriptVersion = "select SCRIPT_ID, SCRIPT_VRS_NB, SCRIPT_VRS_DSC, DELETED_AT, LAST_MODIFIED_BY, LAST_MODIFIED_AT from " + getMetadataRepository().getTableNameByLabel("ScriptVersions")
+                + " where DELETED_AT = 'NA' and SCRIPT_ID = " + SQLTools.getStringForSQL(scriptVersionKey.getScriptKey().getScriptId()) +


.../src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptVersionConfiguration.java

BerrevoetsRobbe

part 1

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/action/ActionConfiguration.java

...rc/main/java/io/metadew/iesi/metadata/configuration/action/ActionParameterConfiguration.java

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptConfiguration.java

BerrevoetsRobbe

part 2

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptConfiguration.java

...re/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptLabelConfiguration.java

Suyash-d added 6 commits April 28, 2021 16:43

Initial Commit

b2dba0b

Initial Commit IESI_CORE

6cf38d2

Soft Delete changes except test cases

db9430d

Existing Test case fixed

ce1c0dc

DB Changes

6b34916

Existing Test case fixed

a0f2d87

Suyash-d added the enhancement New feature or request label May 3, 2021

Suyash-d added this to the v0.7.0 milestone May 3, 2021

Suyash-d self-assigned this May 3, 2021

Added mkys.p12 file

ef41b37

BerrevoetsRobbe requested changes May 4, 2021

View reviewed changes

Suyash-d added 8 commits May 4, 2021 17:24

Requested review changes merged

5316bd7

Review changes

a4cfdb8

Initial changes added to restore deleted script

01473ea

Chages added to restore service

26e7cad

Test Cases added for Soft Delete & Restore Delete

648e298

Build Fix

39b3019

Build Fix

09c85ba

Build Fix

9ba7eda

BerrevoetsRobbe reviewed May 13, 2021

View reviewed changes

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptConfiguration.java Show resolved Hide resolved

BerrevoetsRobbe reviewed May 13, 2021

View reviewed changes

...si-core/src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptConfiguration.java Outdated Show resolved Hide resolved

BerrevoetsRobbe reviewed May 13, 2021

View reviewed changes

.../src/main/java/io/metadew/iesi/metadata/configuration/script/ScriptVersionConfiguration.java Outdated Show resolved Hide resolved

Test cases modified

09db002

BerrevoetsRobbe reviewed Jun 8, 2021

View reviewed changes

core/java/iesi-core/src/test/resources/application-metadata.yml Show resolved Hide resolved

DB changes added in core/conf/application-metadata.yml

1021d9c

Fixed Scenario of Soft Deleted Script

3e2851b

Suyash-d and others added 3 commits June 22, 2021 18:22

Fix Action and Action Param

093d792

Merge branch 'develop' into feature/34993e6/Soft-deletion-of-scripts

058ace0

build fix

531b377

BerrevoetsRobbe requested changes Jun 23, 2021

View reviewed changes

Suyash-d and others added 7 commits June 24, 2021 11:53

Removed Unused Deleted_At

9ab014d

refracted DeletedAt

15afd86

Merge branch 'develop' into feature/34993e6/Soft-deletion-of-scripts

6c440eb

Update SOFT_DELETION_ALTER_STATEMENT.sql

37d0ca2

Build Fix

9e0feb2

Merge branch 'feature/34993e6/Soft-deletion-of-scripts' of https://gi…

a8688c5

…thub.com/metadew/iesi into feature/34993e6/Soft-deletion-of-scripts

Revert "Initial Commit"

7fddcbc

This reverts commit f9f23d8

BerrevoetsRobbe requested changes Jun 28, 2021

View reviewed changes

Suyash-d added 5 commits June 28, 2021 18:41

Addition changes resolved\

ed432d1

Code fix

c741dc8

Hard deleted added for Action and Action Param

d228481

Soft deletion final commit

559ce91

Include Inactive added

f41867d

BerrevoetsRobbe requested changes Jul 2, 2021

View reviewed changes

Suyash-d and others added 11 commits July 2, 2021 18:29

Requested Changes added

6272ed0

Soft Deletion of Script

993e2ff

build fix

ef9282a

IncludeInactive fixed

139a5ac

Build Fix

9b740d2

wi^p

f3d8f90

wip

e084df3

wip

85728d3

wip

c7bd64a

handle already exist deleted scripts

54f7d2c

fetch correct deleted at

2447079

Comments

Conversation

Suyash-d commented May 3, 2021 • edited by BerrevoetsRobbe Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BerrevoetsRobbe commented May 4, 2021

Uh oh!

Uh oh!

BerrevoetsRobbe commented May 13, 2021

Uh oh!

Uh oh!

Uh oh!

BerrevoetsRobbe commented May 13, 2021

Uh oh!

Uh oh!

BerrevoetsRobbe commented Jun 8, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BerrevoetsRobbe Jun 28, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BerrevoetsRobbe Jun 28, 2021

Choose a reason for hiding this comment

Uh oh!

BerrevoetsRobbe Jun 28, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BerrevoetsRobbe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BerrevoetsRobbe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Suyash-d commented May 3, 2021 •

edited by BerrevoetsRobbe

Loading